diff --git a/tools/cli/test/data/split/README.md b/tools/cli/test/data/split/README.md new file mode 100644 index 0000000000..7369683a68 --- /dev/null +++ b/tools/cli/test/data/split/README.md @@ -0,0 +1,22 @@ +### Updating test data + +To update the test data for a given branch, you can follow the steps below + +#### Step 1: Evergreen +- Go to evergreen and find the latest run +- Go to `OPENAPI_GENERATE_SPECS` task +- Go to the files link, then righ click and copy the link for any of the files +- Redact the file name from the link, so you have the task files link + +#### Step 2: Update the download_specs.sh script if neeeded +- Check what are the current versions in the environment you want to update +- You can check the available versions for a given env via this [link](https://cloud.mongodb.com/api/openapi/versions) + +#### Step 3: Run download_specs.sh script +- With the copied link, run the command `./tools/cli/test/data/split/download_specs.sh ` + +Example +```shell +./tools/cli/test/data/split/download_specs.sh https:///mms/e6ba3136dbd0be2a81dd4ed21b9e6c470edd4420/24_10_05_23_26_12 dev +``` + diff --git a/tools/cli/test/data/split/dev/README.md b/tools/cli/test/data/split/dev/README.md index bd97504875..9c1b13b0ab 100644 --- a/tools/cli/test/data/split/dev/README.md +++ b/tools/cli/test/data/split/dev/README.md @@ -1 +1 @@ -The last update for this folder was with commit SHA "09d9d18db2111c955a8e01702a27ca2763417782" in branch dev +The last update for this folder was with commit SHA "e6ba3136dbd0be2a81dd4ed21b9e6c470edd4420" in branch dev diff --git a/tools/cli/test/data/split/dev/openapi-api-registry.json b/tools/cli/test/data/split/dev/openapi-api-registry.json index b679855816..26255f6be8 100644 --- a/tools/cli/test/data/split/dev/openapi-api-registry.json +++ b/tools/cli/test/data/split/dev/openapi-api-registry.json @@ -1,223 +1,169 @@ { - "openapi": "3.0.1", - "info": { - "title": "API Registry Service API", - "description": "API Registry OpenAPI Specification.", - "version": "0.1.0" + "openapi" : "3.0.1", + "info" : { + "title" : "API Registry Service API", + "description" : "API Registry OpenAPI Specification.", + "version" : "0.1.0" }, - "servers": [ - { - "url": "http://localhost:50053", - "description": "localhost" - } - ], - "security": [ - { - "internalClient": [] - } - ], - "tags": [ - { - "name": "Internal", - "description": "Private resources." - }, - { - "name": "OpenAPI", - "description": "Returns information about the MongoDB Atlas Specification." - } - ], - "paths": { - "/api/atlas/v2/openapi/info": { - "get": { - "tags": ["OpenAPI"], - "summary": "Return general information about the MongoDB Atlas Administration API OpenAPI Specification.", - "description": "This resource returns general information about the MongoDB Atlas Administration API OpenAPI Specification.", - "operationId": "getOpenApiInfo", - "parameters": [ - { - "$ref": "openapi-mms.json#/components/parameters/pretty" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2024-05-30+json": { - "schema": { - "$ref": "#/components/schemas/OpenApiInfo" + "servers" : [ { + "url" : "http://localhost:50053", + "description" : "localhost" + } ], + "security" : [ { + "internalClient" : [ ] + } ], + "tags" : [ { + "name" : "Internal", + "description" : "Private resources." + }, { + "name" : "OpenAPI", + "description" : "Returns information about the MongoDB Atlas Specification." + } ], + "paths" : { + "/api/atlas/v2/openapi/info" : { + "get" : { + "tags" : [ "OpenAPI" ], + "summary" : "Return general information about the MongoDB Atlas Administration API OpenAPI Specification.", + "description" : "This resource returns general information about the MongoDB Atlas Administration API OpenAPI Specification.", + "operationId" : "getOpenApiInfo", + "parameters" : [ { + "$ref" : "openapi-mms.json#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/OpenApiInfo" }, - "x-xgen-version": "2024-05-30", - "x-sunset": "2025-05-30" + "x-xgen-version" : "2024-05-30", + "x-sunset" : "2025-05-30" }, - "application/vnd.atlas.2025-01-01+json": { - "schema": { - "$ref": "#/components/schemas/OpenApiInfo" + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OpenApiInfo" }, - "x-xgen-version": "2025-01-01" + "x-xgen-version" : "2025-01-01" } } }, - "401": { - "description": "Unauthorized.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - } + "401" : { + "$ref" : "openapi-mms.json#/components/responses/unauthorized" }, - "500": { - "$ref": "openapi-mms.json#/components/responses/internalServerError" + "500" : { + "$ref" : "openapi-mms.json#/components/responses/internalServerError" } }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-hidden-env": { - "envs": "qa,stage,prod" + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-hidden-env" : { + "envs" : "qa,stage,prod" }, - "x-xgen-owner-team": "apix" + "x-xgen-owner-team" : "apix" } }, - "/rest/unauth/version": { - "get": { - "tags": ["Internal"], - "summary": "Return the deployed gitSHA.", - "description": "This resource returns the deployed gitSHA for the service.", - "operationId": "getVersion", - "parameters": [ - { - "$ref": "openapi-mms.json#/components/parameters/pretty" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ServiceVersionView" + "/rest/unauth/version" : { + "get" : { + "tags" : [ "Internal" ], + "summary" : "Return the deployed gitSHA.", + "description" : "This resource returns the deployed gitSHA for the service.", + "operationId" : "getVersion", + "parameters" : [ { + "$ref" : "openapi-mms.json#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceVersionView" } } } }, - "500": { - "$ref": "openapi-mms.json#/components/responses/internalServerError" + "500" : { + "$ref" : "openapi-mms.json#/components/responses/internalServerError" } }, - "security": [ - { - "DigestAuth": [] - } - ] + "security" : [ { + "DigestAuth" : [ ] + } ] } } }, - "components": { - "schemas": { - "Info": { - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "Description of the MongoDB Atlas Administration API.", - "example": "The MongoDB Atlas Administration API allows developers to manage all components in MongoDB Atlas." + "components" : { + "schemas" : { + "Info" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "Description of the MongoDB Atlas Administration API.", + "example" : "The MongoDB Atlas Administration API allows developers to manage all components in MongoDB Atlas." }, - "license": { - "$ref": "#/components/schemas/License" + "license" : { + "$ref" : "#/components/schemas/License" }, - "termsOfService": { - "type": "string", - "description": "Terms of Service URL.", - "example": "https://www.mongodb.com/mongodb-management-service-terms-and-conditions" + "termsOfService" : { + "type" : "string", + "description" : "Terms of Service URL.", + "example" : "https://www.mongodb.com/mongodb-management-service-terms-and-conditions" }, - "title": { - "type": "string", - "description": "Title of the MongoDB Atlas Administration API.", - "example": "MongoDB Atlas Administration API." + "title" : { + "type" : "string", + "description" : "Title of the MongoDB Atlas Administration API.", + "example" : "MongoDB Atlas Administration API." }, - "version": { - "type": "string", - "description": "Version of the MongoDB Atlas Administration API.", - "example": "2.0" + "version" : { + "type" : "string", + "description" : "Version of the MongoDB Atlas Administration API.", + "example" : "2.0" } }, - "description": "Information about the MongoDB Atlas Administration API OpenAPI Specification." + "description" : "Information about the MongoDB Atlas Administration API OpenAPI Specification." }, - "License": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the license.", - "example": "CC BY-NC-SA 3.0 US" + "License" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "Name of the license.", + "example" : "CC BY-NC-SA 3.0 US" }, - "url": { - "type": "string", - "description": "URL of the license.", - "example": "https://creativecommons.org/licenses/by-nc-sa/3.0/us/" + "url" : { + "type" : "string", + "description" : "URL of the license.", + "example" : "https://creativecommons.org/licenses/by-nc-sa/3.0/us/" } }, - "description": "License information of the MongoDB Atlas Administration API." + "description" : "License information of the MongoDB Atlas Administration API." }, - "OpenApiInfo": { - "type": "object", - "properties": { - "info": { - "$ref": "#/components/schemas/Info" - } - } - }, - "ApiError": { - "type": "object", - "properties": { - "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", - "externalDocs": { - "url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status" - } - }, - "errorCode": { - "type": "string", - "description": "Application error code returned with this error." - }, - "parameters": { - "type": "array", - "description": "Parameters used to give more information about the error.", - "items": { - "type": "object" - } - }, - "reason": { - "type": "string", - "description": "Application error message returned with this error." + "OpenApiInfo" : { + "type" : "object", + "properties" : { + "info" : { + "$ref" : "#/components/schemas/Info" } } }, - "ServiceVersionView": { - "type": "object", - "properties": { - "gitsha": { - "type": "string", - "description": "The service deployed gitSha." + "ServiceVersionView" : { + "type" : "object", + "properties" : { + "gitsha" : { + "type" : "string", + "description" : "The service deployed gitSha." } } } }, - "securitySchemes": { - "DigestAuth": { - "type": "http", - "scheme": "digest" + "securitySchemes" : { + "DigestAuth" : { + "type" : "http", + "scheme" : "digest" } } } -} +} \ No newline at end of file diff --git a/tools/cli/test/data/split/dev/openapi-mms.json b/tools/cli/test/data/split/dev/openapi-mms.json index aaa6507f20..1c322f7bbf 100644 --- a/tools/cli/test/data/split/dev/openapi-mms.json +++ b/tools/cli/test/data/split/dev/openapi-mms.json @@ -1,63274 +1,58567 @@ { - "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.\n\nThe Atlas Administration API uses HTTP Digest Authentication to authenticate requests. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request. For example, to [return database access history](#tag/Access-Tracking/operation/listAccessLogsByClusterName) with [cURL](https://en.wikipedia.org/wiki/CURL), run the following command in the terminal:\n\n```\ncurl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true\"\n```\n\nTo learn more, see [Get Started with the Atlas Administration API](https://www.mongodb.com/docs/atlas/configure-api-access/). For support, see [MongoDB Support](https://www.mongodb.com/support/get-started).", - "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": "2.0", - "x-xgen-sha": "09d9d18db2111c955a8e01702a27ca2763417782" + "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.\n\nThe Atlas Administration API uses HTTP Digest Authentication to authenticate requests. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request. For example, to [return database access history](#tag/Access-Tracking/operation/listAccessLogsByClusterName) with [cURL](https://en.wikipedia.org/wiki/CURL), run the following command in the terminal:\n\n```\ncurl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true\"\n```\n\nTo learn more, see [Get Started with the Atlas Administration API](https://www.mongodb.com/docs/atlas/configure-api-access/). For support, see [MongoDB Support](https://www.mongodb.com/support/get-started).\n\nYou can also explore the various endpoints available through the Atlas Administration API in MongoDB's [Postman workspace](https://www.postman.com/mongodb-devrel/workspace/mongodb-atlas-administration-apis/).", + "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" : "2.0" }, - "servers": [ - { - "url": "https://cloud.mongodb.com" + "servers" : [ { + "url" : "https://cloud.mongodb.com" + } ], + "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" : "Collection Level Metrics", + "description" : "Returns, adds, and edits pinned namespaces for the specified cluster or process. Also returns collection level latency metric data." + }, { + "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" } - ], - "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": "Collection Level Metrics", - "description": "Returns, adds, and edits pinned namespaces for the specified cluster or process. Also returns collection level latency metric data." - }, - { - "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, adds, edits, and removes Atlas Data Lake Pipelines and associated runs." - }, - { - "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.\nMongoDB 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": "Network Peering", - "description": "Returns, adds, edits, and removes network peering containers and peering connections.\nWhen 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": "Push-Based Log Export", - "description": "You can continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket. Atlas exports logs every 5 minutes." - }, - { - "name": "Rolling Index", - "description": "Creates one index to a database deployment in a rolling manner. You can't create a rolling index on an `M0` free cluster or `M2/M5` shared cluster." - }, - { - "name": "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": "Streams", - "description": "Returns, adds, edits, and removes Streams Instances. This resource requires your project ID." - }, - { - "name": "Teams", - "description": "Returns, adds, edits, or removes teams." - }, - { - "name": "Test", - "description": "Atlas test endpoints." - }, - { - "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.\n\n**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/" - } + }, { + "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.\nMongoDB 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" : "Network Peering", + "description" : "Returns, adds, edits, and removes network peering containers and peering connections.\nWhen 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" : "Push-Based Log Export", + "description" : "You can continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket. Atlas exports logs every 5 minutes." + }, { + "name" : "Resource Policies", + "description" : "Configure and manage Atlas Resource Policies within your organization." + }, { + "name" : "Rolling Index", + "description" : "Creates one index to a database deployment in a rolling manner. You can't create a rolling index on an `M0` free cluster or `M2/M5` shared cluster." + }, { + "name" : "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" } - ], - "paths": { - "/api/atlas/v2/eventTypes": { - "get": { - "tags": ["Events"], - "summary": "List All Possible Event Types", - "description": "Returns a list of all event types, along with a description and additional metadata about each event.", - "operationId": "listEventTypes", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/includeCount" - }, - { - "$ref": "#/components/parameters/itemsPerPage" - }, - { - "$ref": "#/components/parameters/pageNum" - }, - { - "$ref": "#/components/parameters/pretty" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedEventTypeDetailsResponse" + }, { + "name" : "Service Accounts", + "description" : "Endpoints for managing Service Accounts and secrets. Service Accounts are used for programmatic access to the Atlas Admin API through the OAuth 2.0 Client Credentials flow. This feature is available as a Preview feature.", + "externalDocs" : { + "description" : "Get Started with the Atlas Administration API", + "url" : "https://www.mongodb.com/docs/atlas/configure-api-access/" + } + }, { + "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" : "Streams", + "description" : "Returns, adds, edits, and removes Streams Instances. This resource requires your project ID." + }, { + "name" : "Teams", + "description" : "Returns, adds, edits, or removes teams." + }, { + "name" : "Test", + "description" : "Atlas test endpoints." + }, { + "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.\n\n**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/v2/eventTypes" : { + "get" : { + "tags" : [ "Events" ], + "summary" : "List All Possible Event Types", + "description" : "Returns a list of all event types, along with a description and additional metadata about each event.", + "operationId" : "listEventTypes", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedEventTypeDetailsResponse" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "CAP" + } + }, + "/api/atlas/v2/groups/{groupId}/events" : { + "get" : { + "tags" : [ "Events" ], + "summary" : "Return All Events 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 API Key must have the Project Read Only role.\n\nThis 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", + "items" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } + }, { + "name" : "eventType", + "in" : "query", + "description" : "Category of incident recorded at this moment in time.\n\n**IMPORTANT**: The complete list of event type values changes frequently.", + "schema" : { + "type" : "array", + "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\n\n**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", + "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" + } + }, { + "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" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupPaginatedEventView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "CAP" + } + }, + "/api/atlas/v2/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 API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "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. Use the [/events](#tag/Events/operation/listProjectEvents) endpoint to retrieve all events to which the authenticated user has access.", + "required" : true, + "schema" : { + "maxLength" : 24, + "minLength" : 24, + "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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EventViewForNdsGroup" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "CAP" + } + }, + "/api/atlas/v2/orgs/{orgId}/events" : { + "get" : { + "tags" : [ "Events" ], + "summary" : "Return All Events from One Organization", + "description" : "Returns all events for the specified organization. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Organization Member role.\n\nThis 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.\n\n**IMPORTANT**: The complete list of event type values changes frequently.", + "schema" : { + "type" : "array", + "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", + "example" : "2021-11-17T23:15:00.060Z" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrgPaginatedEventView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "CAP" + } + }, + "/api/atlas/v2/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 API Key must have the Organization Member role.\n\nThis resource remains under revision and may change.", + "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. Use the [/events](#tag/Events/operation/listOrganizationEvents) endpoint to retrieve all events to which the authenticated user has access.", + "required" : true, + "schema" : { + "maxLength" : 24, + "minLength" : 24, + "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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EventViewForOrg" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "CAP" + } + }, + "/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts" : { + "get" : { + "tags" : [ "Alerts" ], + "summary" : "Return All Open Alerts for 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 API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "listAlertsByAlertConfigurationId", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "name" : "alertConfigId", + "in" : "path", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "required" : true, + "schema" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAlertView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "CAP" + } + }, + "/api/atlas/v2/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 API Key must have the Project Read Only role.\n\nThis 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. Use the [/alerts](#tag/Alerts/operation/listAlerts) endpoint to retrieve all alerts to which the authenticated user has access.", + "required" : true, + "schema" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AlertViewForNdsGroup" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "CAP" + }, + "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 API Key must have the Organization Owner or Project Owner role.\n\nThis 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. Use the [/alerts](#tag/Alerts/operation/listAlerts) endpoint to retrieve all alerts to which the authenticated user has access.", + "required" : true, + "schema" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "requestBody" : { + "description" : "Acknowledges or unacknowledges one alert.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AlertView" + } + }, + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/AcknowledgeAlert" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AlertViewForNdsGroup" + }, + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2025-05-30" + }, + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/AlertViewForNdsGroup" + }, + "x-xgen-version" : "2024-05-30" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "CAP" + } + }, + "/api/atlas/v2/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 API Key must have the Project Read Only role.\n\nThis 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 to return all alerts in all statuses.", + "schema" : { + "type" : "string", + "enum" : [ "OPEN", "TRACKING", "CLOSED" ] + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAlertView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "CAP" + } + }, + "/api/atlas/v2/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 API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "operationId" : "listAlertConfigurationsByAlertId", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "name" : "alertId", + "in" : "path", + "description" : "Unique 24-hexadecimal digit string that identifies the alert. Use the [/alerts](#tag/Alerts/operation/listAlerts) endpoint to retrieve all alerts to which the authenticated user has access.", + "required" : true, + "schema" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAlertConfigView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "CAP" + } + }, + "/api/atlas/v2/alertConfigs/matchers/fieldNames" : { + "get" : { + "tags" : [ "Alert Configurations" ], + "summary" : "Get 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/MatcherFieldView" + } }, - "x-xgen-version": "2023-01-01" + "x-xgen-version" : "2023-01-01" } } }, - "401": { - "$ref": "#/components/responses/unauthorized" + "401" : { + "$ref" : "#/components/responses/unauthorized" }, - "500": { - "$ref": "#/components/responses/internalServerError" + "500" : { + "$ref" : "#/components/responses/internalServerError" } }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "CAP" + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "CAP" } }, - "/api/atlas/v2/groups/{groupId}/events": { - "get": { - "tags": ["Events"], - "summary": "Return All Events 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 API Key must have the Project Read Only role.\n\nThis 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", - "items": { - "maxLength": 64, - "minLength": 1, - "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.\n\n**IMPORTANT**: The complete list of event type values changes frequently.", - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/EventTypeForNdsGroup" - } + "/api/atlas/v2/groups/{groupId}/alertConfigs" : { + "get" : { + "tags" : [ "Alert Configurations" ], + "summary" : "Return All Alert Configurations for 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 API Key must have the Project Read Only role.\n\nThis 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAlertConfigView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "CAP" + }, + "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 API Key must have the Organization Owner or Project Owner role.\n\nThis 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "CAP" + } + }, + "/api/atlas/v2/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 API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", + "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. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "required" : true, + "schema" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "CAP" + }, + "put" : { + "tags" : [ "Alert Configurations" ], + "summary" : "Update One Alert Configuration for 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 API Key must have the Organization Owner or Project Owner role.\n\n**NOTE**: To enable or disable the alert configuration, see [Toggle One State of One Alert Configuration in One Project](#tag/Alert-Configurations/operation/toggleAlertConfiguration).\n\nThis resource remains under revision and may change.", + "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. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "required" : true, + "schema" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8" + } + } ], + "requestBody" : { + "description" : "Updates one alert configuration in the specified project.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "CAP" + }, + "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 API Key must have the Organization Owner or Project Owner role.\n\nThis resource remains under revision and may change.", + "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. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "required" : true, + "schema" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8" + } + } ], + "responses" : { + "204" : { + "description" : "No Content", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "CAP" + }, + "patch" : { + "tags" : [ "Alert Configurations" ], + "summary" : "Toggle One 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 API Key must have the Organization Owner or Project Owner role.\n\n**NOTE**: This endpoint updates only the enabled/disabled state for the alert configuration. To update more than just this configuration, see [Update One Alert Configuration](#tag/Alert-Configurations/operation/updateAlertConfiguration).\n\nThis resource remains under revision and may change.", + "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. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", + "required" : true, + "schema" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8" + } + } ], + "requestBody" : { + "description" : "Enables or disables the specified alert configuration in the specified project.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AlertsToggle" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupAlertsConfig" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "CAP" + } + }, + "/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList" : { + "get" : { + "tags" : [ "Service Accounts" ], + "summary" : "Return All Access List entries for one Project Service Account", + "description" : "Returns all access list entries that you configured for the specified Service Account for the project. Available as a preview feature.", + "operationId" : "listProjectServiceAccountAccessList", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "name" : "clientId", + "in" : "path", + "description" : "The Client ID of the Service Account.", + "required" : true, + "schema" : { + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$", + "type" : "string", + "example" : "mdb_sa_id_667066535bc75b03c37b3038" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedServiceAccountIPAccessEntryView" + }, + "x-xgen-version" : "2024-08-05" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-hidden-env" : { + "envs" : "stage,prod" + }, + "x-xgen-owner-team" : "apix" + }, + "post" : { + "tags" : [ "Service Accounts" ], + "summary" : "Add Access List entries for one Project Service Account", + "description" : "Add Access List Entries for the specified Service Account for the project. Resources require all API requests to originate from IP addresses on the API access list. Available as a preview feature.", + "operationId" : "createProjectServiceAccountAccessList", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "name" : "clientId", + "in" : "path", + "description" : "The Client ID of the Service Account.", + "required" : true, + "schema" : { + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$", + "type" : "string", + "example" : "mdb_sa_id_667066535bc75b03c37b3038" + } + } ], + "requestBody" : { + "description" : "A list of access list entries to add to the access list of the specified Service Account for the project.", + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ServiceAccountIPAccessListEntry" + } + }, + "x-xgen-version" : "2024-08-05" } }, - { - "name": "excludedEventType", - "in": "query", - "description": "Category of event that you would like to exclude from query results, such as CLUSTER_CREATED\n\n**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", - "items": { - "$ref": "#/components/schemas/EventTypeForNdsGroup" + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedServiceAccountIPAccessEntryView" + }, + "x-xgen-version" : "2024-08-05" } } }, - { - "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 - } + "400" : { + "$ref" : "#/components/responses/badRequest" }, - { - "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" + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-hidden-env" : { + "envs" : "stage,prod" + }, + "x-xgen-owner-team" : "apix" + } + }, + "/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList/{ipAddress}" : { + "delete" : { + "tags" : [ "Service Accounts" ], + "summary" : "Remove One Access List entry from one Project Service Account", + "description" : "Removes the specified access list entry from the specified Service Account for the project. You can't remove the requesting IP address from the access list. Available as a preview feature.", + "operationId" : "deleteProjectServiceAccountAccessListEntry", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "name" : "clientId", + "in" : "path", + "description" : "The Client ID of the Service Account.", + "required" : true, + "schema" : { + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$", + "type" : "string", + "example" : "mdb_sa_id_667066535bc75b03c37b3038" + } + }, { + "name" : "ipAddress", + "in" : "path", + "description" : "One IP address or multiple IP addresses represented as one CIDR block. When specifying a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /.", + "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.", + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "x-xgen-version" : "2024-08-05" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-hidden-env" : { + "envs" : "stage,prod" + }, + "x-xgen-owner-team" : "apix" + } + }, + "/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}:invite" : { + "post" : { + "tags" : [ "Service Accounts" ], + "summary" : "Assign One Service Account to One Project", + "description" : "Assigns the specified Service Account to the specified Project. Available as a preview feature.", + "operationId" : "addProjectServiceAccount", + "parameters" : [ { + "name" : "clientId", + "in" : "path", + "description" : "The Client ID of the Service Account.", + "required" : true, + "schema" : { + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$", + "type" : "string", + "example" : "mdb_sa_id_667066535bc75b03c37b3038" + } + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "description" : "The Project permissions for the Service Account in the specified Project.", + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GroupServiceAccountRoleAssignment" + } + }, + "x-xgen-version" : "2024-08-05" } }, - { - "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" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/GroupPaginatedEventView" + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupServiceAccount" }, - "x-xgen-version": "2023-01-01" + "x-xgen-version" : "2024-08-05" } } }, - "400": { - "$ref": "#/components/responses/badRequest" + "401" : { + "$ref" : "#/components/responses/unauthorized" }, - "401": { - "$ref": "#/components/responses/unauthorized" + "404" : { + "$ref" : "#/components/responses/notFound" }, - "500": { - "$ref": "#/components/responses/internalServerError" + "500" : { + "$ref" : "#/components/responses/internalServerError" } }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "CAP" + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-hidden-env" : { + "envs" : "stage,prod" + }, + "x-xgen-owner-team" : "apix" } }, - "/api/atlas/v2/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 API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", - "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. Use the [/events](#tag/Events/operation/listProjectEvents) endpoint to retrieve all events to which the authenticated user has access.", - "required": true, - "schema": { - "maxLength": 24, - "minLength": 24, - "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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/EventViewForNdsGroup" + "/api/atlas/v2/groups/{groupId}/serviceAccounts" : { + "get" : { + "tags" : [ "Service Accounts" ], + "summary" : "List All Project Service Accounts", + "description" : "Returns all Service Accounts for the specified Project. Available as a preview feature.", + "operationId" : "listProjectServiceAccounts", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedGroupServiceAccounts" }, - "x-xgen-version": "2023-01-01" + "x-xgen-version" : "2024-08-05" } } }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" }, - "500": { - "$ref": "#/components/responses/internalServerError" + "500" : { + "$ref" : "#/components/responses/internalServerError" } }, - "security": [ - { - "DigestAuth": [] + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-hidden-env" : { + "envs" : "stage,prod" + }, + "x-xgen-owner-team" : "apix" + }, + "post" : { + "tags" : [ "Service Accounts" ], + "summary" : "Create and Assign one Service Account to one Project", + "description" : "Creates one Service Account for the specified Project. The Service Account will automatically be added as an Organization Member to the Organization that the specified Project is a part of. Available as a preview feature.", + "operationId" : "createProjectServiceAccount", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "description" : "Details of the new Service Account.", + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupServiceAccountRequest" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "required" : true + }, + "responses" : { + "201" : { + "description" : "Created", + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupServiceAccount" + }, + "x-xgen-version" : "2024-08-05" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-hidden-env" : { + "envs" : "stage,prod" + }, + "x-xgen-owner-team" : "apix" + } + }, + "/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}" : { + "get" : { + "tags" : [ "Service Accounts" ], + "summary" : "Get one Project Service Account", + "description" : "Returns one Service Account in the specified Project. Available as a preview feature.", + "operationId" : "getProjectServiceAccount", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "name" : "clientId", + "in" : "path", + "description" : "The Client ID of the Service Account.", + "required" : true, + "schema" : { + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$", + "type" : "string", + "example" : "mdb_sa_id_667066535bc75b03c37b3038" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupServiceAccount" + }, + "x-xgen-version" : "2024-08-05" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-hidden-env" : { + "envs" : "stage,prod" + }, + "x-xgen-owner-team" : "apix" + }, + "delete" : { + "tags" : [ "Service Accounts" ], + "summary" : "Unassign One Service Account from One Project", + "description" : "Removes the specified Service Account from the specified project. The Service Account will still be a part of the Organization it was created in, and the credentials will remain active until expired or manually revoked. Available as a preview feature.", + "operationId" : "deleteProjectServiceAccount", + "parameters" : [ { + "name" : "clientId", + "in" : "path", + "description" : "The Client ID of the Service Account.", + "required" : true, + "schema" : { + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$", + "type" : "string", + "example" : "mdb_sa_id_667066535bc75b03c37b3038" + } + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "description" : "This endpoint does not return a response body.", + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "x-xgen-version" : "2024-08-05" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-hidden-env" : { + "envs" : "stage,prod" + }, + "x-xgen-owner-team" : "apix" + }, + "patch" : { + "tags" : [ "Service Accounts" ], + "summary" : "Update one Project Service Account", + "description" : "Updates one Service Account in the specified Project. Available as a preview feature.", + "operationId" : "updateProjectServiceAccount", + "parameters" : [ { + "name" : "clientId", + "in" : "path", + "description" : "The Client ID of the Service Account.", + "required" : true, + "schema" : { + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$", + "type" : "string", + "example" : "mdb_sa_id_667066535bc75b03c37b3038" + } + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "description" : "The new details for the Service Account.", + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupServiceAccountUpdateRequest" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupServiceAccount" + }, + "x-xgen-version" : "2024-08-05" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-hidden-env" : { + "envs" : "stage,prod" + }, + "x-xgen-owner-team" : "apix" + } + }, + "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/secrets" : { + "post" : { + "tags" : [ "Service Accounts" ], + "summary" : "Create one Organization Service Account Secret", + "description" : "Create a secret for the specified Service Account. Available as a preview feature.", + "operationId" : "createServiceAccountSecret", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "name" : "clientId", + "in" : "path", + "description" : "The Client ID of the Service Account.", + "required" : true, + "schema" : { + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$", + "type" : "string", + "example" : "mdb_sa_id_667066535bc75b03c37b3038" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "description" : "Details for the new secret.", + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceAccountSecretRequest" + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "description" : "Created", + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceAccountSecret" + }, + "x-xgen-version" : "2024-08-05" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-hidden-env" : { + "envs" : "stage,prod" + }, + "x-xgen-owner-team" : "apix" + } + }, + "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/secrets/{secretId}" : { + "delete" : { + "tags" : [ "Service Accounts" ], + "summary" : "Delete a Organization Service Account Secret", + "description" : "Deletes the specified Service Account secret. Available as a preview feature.", + "operationId" : "deleteServiceAccountSecret", + "parameters" : [ { + "name" : "clientId", + "in" : "path", + "description" : "The Client ID of the Service Account.", + "required" : true, + "schema" : { + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$", + "type" : "string", + "example" : "mdb_sa_id_667066535bc75b03c37b3038" + } + }, { + "name" : "secretId", + "in" : "path", + "description" : "Unique 24-hexadecimal digit string that identifies the secret.", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "description" : "This endpoint does not return a response body.", + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "x-xgen-version" : "2024-08-05" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-hidden-env" : { + "envs" : "stage,prod" + }, + "x-xgen-owner-team" : "apix" + } + }, + "/api/atlas/v2/orgs/{orgId}/serviceAccounts" : { + "get" : { + "tags" : [ "Service Accounts" ], + "summary" : "List All Organization Service Accounts", + "description" : "Returns all Service Accounts for the specified Organization. Available as a preview feature.", + "operationId" : "listServiceAccounts", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedOrgServiceAccounts" + }, + "x-xgen-version" : "2024-08-05" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-hidden-env" : { + "envs" : "stage,prod" + }, + "x-xgen-owner-team" : "apix" + }, + "post" : { + "tags" : [ "Service Accounts" ], + "summary" : "Create one Organization Service Account", + "description" : "Creates one Service Account for the specified Organization. Available as a preview feature.", + "operationId" : "createServiceAccount", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "description" : "Details of the new Service Account.", + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrgServiceAccountRequest" + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "description" : "Created", + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrgServiceAccount" + }, + "x-xgen-version" : "2024-08-05" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-hidden-env" : { + "envs" : "stage,prod" + }, + "x-xgen-owner-team" : "apix" + } + }, + "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}" : { + "get" : { + "tags" : [ "Service Accounts" ], + "summary" : "Get one Organization Service Account", + "description" : "Returns the specified Service Account. Available as a preview feature.", + "operationId" : "getServiceAccount", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "name" : "clientId", + "in" : "path", + "description" : "The Client ID of the Service Account.", + "required" : true, + "schema" : { + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$", + "type" : "string", + "example" : "mdb_sa_id_667066535bc75b03c37b3038" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrgServiceAccount" + }, + "x-xgen-version" : "2024-08-05" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-hidden-env" : { + "envs" : "stage,prod" + }, + "x-xgen-owner-team" : "apix" + }, + "delete" : { + "tags" : [ "Service Accounts" ], + "summary" : "Delete one Organization Service Account", + "description" : "Deletes the specified Service Account. Available as a preview feature.", + "operationId" : "deleteServiceAccount", + "parameters" : [ { + "name" : "clientId", + "in" : "path", + "description" : "The Client ID of the Service Account.", + "required" : true, + "schema" : { + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$", + "type" : "string", + "example" : "mdb_sa_id_667066535bc75b03c37b3038" + } + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "description" : "This endpoint does not return a response body.", + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "x-xgen-version" : "2024-08-05" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-hidden-env" : { + "envs" : "stage,prod" + }, + "x-xgen-owner-team" : "apix" + }, + "patch" : { + "tags" : [ "Service Accounts" ], + "summary" : "Update one Organization Service Account", + "description" : "Updates the specified Service Account in the specified Organization. Available as a preview feature.", + "operationId" : "updateServiceAccount", + "parameters" : [ { + "name" : "clientId", + "in" : "path", + "description" : "The Client ID of the Service Account.", + "required" : true, + "schema" : { + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$", + "type" : "string", + "example" : "mdb_sa_id_667066535bc75b03c37b3038" + } + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "description" : "The new details for the Service Account.", + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrgServiceAccountUpdateRequest" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrgServiceAccount" + }, + "x-xgen-version" : "2024-08-05" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-hidden-env" : { + "envs" : "stage,prod" + }, + "x-xgen-owner-team" : "apix" + } + }, + "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/groups" : { + "get" : { + "tags" : [ "Service Accounts" ], + "summary" : "Return All Service Account Project assignments", + "description" : "Returns a list of all projects the specified Service Account is a part of. Available as a preview feature.", + "operationId" : "listServiceAccountProjects", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "name" : "clientId", + "in" : "path", + "description" : "The Client ID of the Service Account.", + "required" : true, + "schema" : { + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$", + "type" : "string", + "example" : "mdb_sa_id_667066535bc75b03c37b3038" + } + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedServiceAccountGroup" + }, + "x-xgen-version" : "2024-08-05" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" } - ], - "x-xgen-owner-team": "CAP" + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-hidden-env" : { + "envs" : "stage,prod" + }, + "x-xgen-owner-team" : "apix" } }, - "/api/atlas/v2/orgs/{orgId}/events": { - "get": { - "tags": ["Events"], - "summary": "Return All Events from One Organization", - "description": "Returns all events for the specified organization. Events identify significant database, billing, or security activities or status changes. To use this resource, the requesting API Key must have the Organization Member role.\n\nThis 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.\n\n**IMPORTANT**: The complete list of event type values changes frequently.", - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/EventTypeForOrg" + "/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage" : { + "post" : { + "tags" : [ "Invoices" ], + "summary" : "Create Cost Explorer query process", + "description" : "Creates a query process within the Cost Explorer for the given parameters. A token is returned that can be used to poll the status of the query and eventually retrieve the results.", + "operationId" : "createCostExplorerQueryProcess", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "description" : "Filter parameters for the Cost Explorer query.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CostExplorerFilterRequestBody" } } }, - { - "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", - "example": "2021-11-17T23:15:00.060Z" - } + "required" : true + }, + "responses" : { + "202" : { + "description" : "Accepted", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CostExplorerFilterResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Billing Platform" + } + }, + "/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}" : { + "get" : { + "tags" : [ "Invoices" ], + "summary" : "Return results from a given Cost Explorer query, or notify that the results are not ready yet.", + "description" : "Returns the usage details for a Cost Explorer query, if the query is finished and the data is ready to be viewed. If the data is not ready, a 'processing' response willindicate that another request should be sent later to view the data.", + "operationId" : "createCostExplorerQueryProcess_1", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "name" : "token", + "in" : "path", + "description" : "Unique 64 digit string that identifies the Cost Explorer query.", + "required" : true, + "schema" : { + "maxLength" : 64, + "minLength" : 64, + "type" : "string", + "example" : "4ABBE973862346D40F3AE859D4BE96E0F895764EB14EAB039E7B82F9D638C05C" } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/OrgPaginatedEventView" + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CostExplorerQueryResult" }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" + "x-xgen-version" : "2023-01-01" + }, + "application/vnd.atlas.2023-01-01+csv" : { + "schema" : { + "type" : "string" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "102" : { + "description" : "Processing" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Billing Platform" + } + }, + "/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/lineItems:search" : { + "get" : { + "tags" : [ "Invoices" ], + "summary" : "Query lineItems of the specified invoiceId", + "description" : "Query the lineItems of the specified invoice and return the result JSON. A unique 24-hexadecimal digit string identifies the invoice.", + "operationId" : "queryLineItemsFromSingleInvoice", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "requestBody" : { + "description" : "Filter parameters for the lineItems query. Send a request with an empty JSON body to retrieve all line items for a given invoiceID without applying any filters.", + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiPublicUsageDetailsQueryRequest" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedPublicApiUsageDetailsLineItemView" + }, + "x-xgen-version" : "2024-08-05" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" }, - "500": { - "$ref": "#/components/responses/internalServerError" + "500" : { + "$ref" : "#/components/responses/internalServerError" } }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "CAP" + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Billing" } }, - "/api/atlas/v2/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 API Key must have the Organization Member role.\n\nThis resource remains under revision and may change.", - "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. Use the [/events](#tag/Events/operation/listOrganizationEvents) endpoint to retrieve all events to which the authenticated user has access.", - "required": true, - "schema": { - "maxLength": 24, - "minLength": 24, - "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 - } + "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedOrgGroupView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Intel I" + } + }, + "/api/atlas/v2/example/info" : { + "get" : { + "tags" : [ "Test" ], + "summary" : "Example resource info for versioning of the Atlas API", + "description" : "Returns some text dummy data for test purposes.", + "operationId" : "versionedExample", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "name" : "additionalInfo", + "in" : "query", + "description" : "Show more info.", + "schema" : { + "type" : "string" } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/EventViewForOrg" + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ExampleResourceResponse20230201" + }, + "x-xgen-version" : "2023-02-01" + }, + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ExampleResourceResponse20230101" }, - "x-xgen-version": "2023-01-01" + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2025-06-01" } } }, - "401": { - "$ref": "#/components/responses/unauthorized" + "401" : { + "$ref" : "#/components/responses/unauthorized" }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" + "500" : { + "$ref" : "#/components/responses/internalServerError" } }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "CAP" + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-hidden-env" : { + "envs" : "dev,qa,stage,prod" + }, + "x-xgen-owner-team" : "apix" } }, - "/api/atlas/v2/groups/{groupId}/alertConfigs/{alertConfigId}/alerts": { - "get": { - "tags": ["Alerts"], - "summary": "Return All Open Alerts for 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 API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", - "operationId": "listAlertsByAlertConfigurationId", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" + "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedRoleMappingView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" }, - { - "$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. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", - "required": true, - "schema": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "example": "32b6e34b3d91647abb20e7b8" + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + }, + "post" : { + "tags" : [ "Federated Authentication" ], + "summary" : "Add One Role Mapping to One Organization", + "description" : "Adds one role mapping to the specified organization in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role.", + "operationId" : "createRoleMapping", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "requestBody" : { + "description" : "The role mapping that you want to create.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + } + }, + "/api/atlas/v2/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 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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + }, + "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 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" : { + "maxLength" : 24, + "minLength" : 24, + "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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuthFederationRoleMapping" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + }, + "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 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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "responses" : { + "204" : { + "description" : "No Content", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + } + }, + "/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs" : { + "get" : { + "tags" : [ "Federated Authentication" ], + "summary" : "Return All Connected Org Configs from One Federation", + "description" : "Returns all connected org configs in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected orgs.", + "operationId" : "listConnectedOrgConfigs", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedConnectedOrgConfigsView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + } + }, + "/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}" : { + "get" : { + "tags" : [ "Federated Authentication" ], + "summary" : "Return One Org Config Connected to One Federation", + "description" : "Returns the specified connected org config from the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in the connected org.", + "operationId" : "getConnectedOrgConfig", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "name" : "orgId", + "in" : "path", + "description" : "Unique 24-hexadecimal digit string that identifies the connected organization configuration to return.", + "required" : true, + "schema" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + }, + "delete" : { + "tags" : [ "Federated Authentication" ], + "summary" : "Remove One Org Config Connected to One Federation", + "description" : "Removes one connected organization configuration from the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. Note: This request fails if only one connected organization exists in the federation.", + "operationId" : "removeConnectedOrgConfig", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "name" : "orgId", + "in" : "path", + "description" : "Unique 24-hexadecimal digit string that identifies the connected organization configuration to remove.", + "required" : true, + "schema" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8" + } + } ], + "responses" : { + "204" : { + "description" : "This endpoint does not return a response body.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + }, + "patch" : { + "tags" : [ "Federated Authentication" ], + "summary" : "Update One Org Config Connected to One Federation", + "description" : "Updates one connected organization configuration from the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. \n\n**Note** If the organization configuration has no associated identity provider, you can't use this resource to update role mappings or post authorization role grants. \n\n**Note**: The domainRestrictionEnabled field defaults to false if not provided in the request. \n\n**Note**: If the identityProviderId field is not provided, you will disconnect the organization and the identity provider. \n\n**Note**: Currently connected data access identity providers missing from the dataAccessIdentityProviderIds field will be disconnected.", + "operationId" : "updateConnectedOrgConfig", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "name" : "orgId", + "in" : "path", + "description" : "Unique 24-hexadecimal digit string that identifies the connected organization configuration to update.", + "required" : true, + "schema" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8" + } + } ], + "requestBody" : { + "description" : "The connected organization configuration that you want to update.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + } + }, + "/api/atlas/v2/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 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", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + } + }, + "/api/atlas/v2/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 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", + "items" : { + "type" : "string", + "default" : "SAML", + "enum" : [ "SAML", "OIDC" ] + } + } + }, { + "name" : "idpType", + "in" : "query", + "description" : "The types of the target identity providers.", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "default" : "WORKFORCE", + "enum" : [ "WORKFORCE", "WORKLOAD" ] } } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedAlertView" + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedFederationIdentityProvider" }, - "x-xgen-version": "2023-01-01" + "x-xgen-version" : "2023-01-01" } } }, - "401": { - "$ref": "#/components/responses/unauthorized" + "400" : { + "$ref" : "#/components/responses/badRequest" }, - "404": { - "$ref": "#/components/responses/notFound" + "401" : { + "$ref" : "#/components/responses/unauthorized" }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "CAP" - } - }, - "/api/atlas/v2/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 API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", - "operationId": "getAlert", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" + "404" : { + "$ref" : "#/components/responses/notFound" }, - { - "$ref": "#/components/parameters/groupId" + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + }, + "post" : { + "tags" : [ "Federated Authentication" ], + "summary" : "Create One Identity Provider", + "description" : "Creates one identity provider within the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations.\n\n**Note**: This resource only supports the creation of OIDC identity providers.", + "operationId" : "createIdentityProvider", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "description" : "The identity provider that you want to create.", + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/FederationOidcIdentityProviderUpdate" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/FederationOidcIdentityProvider" + }, + "x-xgen-version" : "2023-11-15" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" }, - { - "$ref": "#/components/parameters/pretty" + "404" : { + "$ref" : "#/components/responses/notFound" }, - { - "name": "alertId", - "in": "path", - "description": "Unique 24-hexadecimal digit string that identifies the alert. Use the [/alerts](#tag/Alerts/operation/listAlerts) endpoint to retrieve all alerts to which the authenticated user has access.", - "required": true, - "schema": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } + "500" : { + "$ref" : "#/components/responses/internalServerError" } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/AlertViewForNdsGroup" + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + } + }, + "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml" : { + "get" : { + "tags" : [ "Federated Authentication" ], + "summary" : "Return the Metadata of One Identity Provider", + "description" : "Returns the metadata of one identity provider in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations.", + "operationId" : "getIdentityProviderMetadata", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "$ref" : "#/components/parameters/identityProviderId" + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "string" }, - "x-xgen-version": "2023-01-01" + "x-xgen-version" : "2023-01-01" } } }, - "401": { - "$ref": "#/components/responses/unauthorized" + "400" : { + "$ref" : "#/components/responses/badRequest" }, - "404": { - "$ref": "#/components/responses/notFound" + "401" : { + "$ref" : "#/components/responses/unauthorized" }, - "500": { - "$ref": "#/components/responses/internalServerError" + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" } }, - "security": [ - { - "DigestAuth": [] + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + } + }, + "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}" : { + "get" : { + "tags" : [ "Federated Authentication" ], + "summary" : "Return One Identity Provider by ID", + "description" : "Returns one identity provider in the specified federation by the identity provider's id. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations.", + "operationId" : "getIdentityProvider", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "name" : "identityProviderId", + "in" : "path", + "description" : "Unique string that identifies the identity provider to connect. If using an API version before 11-15-2023, use the legacy 20-hexadecimal digit id. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider. For all other versions, use the 24-hexadecimal digit id.", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8" } - ], - "x-xgen-owner-team": "CAP" - }, - "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 API Key must have the Organization Owner or Project Owner role.\n\nThis 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. Use the [/alerts](#tag/Alerts/operation/listAlerts) endpoint to retrieve all alerts to which the authenticated user has access.", - "required": true, - "schema": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/FederationSamlIdentityProvider" + }, + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2025-01-01" + }, + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/FederationIdentityProvider" + }, + "x-xgen-version" : "2023-11-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" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + }, + "delete" : { + "tags" : [ "Federated Authentication" ], + "summary" : "Delete One Identity Provider", + "description" : "Deletes one identity provider in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. \n\n**Note**: Requests to this resource will fail if the identity provider has any connected organizations. Before deleting an identity provider, disconnect all organizations and confirm that no organization in your account uses this identity provider. To learn more, see [Manage Organization Mapping for Federated Authentication](https://www.mongodb.com/docs/atlas/security/manage-org-mapping/).", + "operationId" : "deleteIdentityProvider", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "name" : "identityProviderId", + "in" : "path", + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider to connect.", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8" + } + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "204" : { + "description" : "No Response", + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "x-xgen-version" : "2023-11-15" + } } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + }, + "patch" : { + "tags" : [ "Federated Authentication" ], + "summary" : "Update One Identity Provider", + "description" : "Updates one identity provider in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations.\n\n**Note**: Changing authorization types and/or updating authorization claims can prevent current users and/or groups from accessing the database.", + "operationId" : "updateIdentityProvider", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "name" : "identityProviderId", + "in" : "path", + "description" : "Unique string that identifies the identity provider to connect. If using an API version before 11-15-2023, use the legacy 20-hexadecimal digit id. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider. For all other versions, use the 24-hexadecimal digit id.", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8" } - ], - "requestBody": { - "description": "Acknowledges or unacknowledges one alert.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/AlertView" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "description" : "The identity provider that you want to update.", + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/FederationIdentityProviderUpdate" } }, - "application/vnd.atlas.2024-05-30+json": { - "schema": { - "$ref": "#/components/schemas/AcknowledgeAlert" + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/FederationSamlIdentityProviderUpdate" } } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/AlertViewForNdsGroup" - }, - "x-xgen-version": "2023-01-01", - "x-sunset": "2025-05-30" - }, - "application/vnd.atlas.2024-05-30+json": { - "schema": { - "$ref": "#/components/schemas/AlertViewForNdsGroup" - }, - "x-xgen-version": "2024-05-30" + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/FederationSamlIdentityProvider" + }, + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2025-01-01" + }, + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/FederationIdentityProvider" + }, + "x-xgen-version" : "2023-11-15" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + } + }, + "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/jwks" : { + "delete" : { + "tags" : [ "Federated Authentication" ], + "summary" : "Revoke the JWKS from One OIDC Identity Provider", + "description" : "Revokes the JWKS tokens from the requested OIDC identity provider. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. \n\n**Note**: Revoking your JWKS tokens immediately refreshes your IdP public keys from all your Atlas clusters, invalidating previously signed access tokens and logging out all users. You may need to restart your MongoDB clients. All organizations connected to the identity provider will be affected. To learn more, see [Configure OIDC Authorization](https://www.mongodb.com/docs/atlas/security-oidc/#revoke-jwks).", + "operationId" : "revokeJwksFromIdentityProvider", + "parameters" : [ { + "$ref" : "#/components/parameters/federationSettingsId" + }, { + "name" : "identityProviderId", + "in" : "path", + "description" : "Unique 24-hexadecimal digit string that identifies the identity provider to connect.", + "required" : true, + "schema" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8" + } + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "204" : { + "description" : "No Response", + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "x-xgen-version" : "2023-11-15" } - } + } }, - "400": { - "$ref": "#/components/responses/badRequest" + "400" : { + "$ref" : "#/components/responses/badRequest" }, - "401": { - "$ref": "#/components/responses/unauthorized" + "403" : { + "$ref" : "#/components/responses/forbidden" }, - "404": { - "$ref": "#/components/responses/notFound" + "404" : { + "$ref" : "#/components/responses/notFound" }, - "500": { - "$ref": "#/components/responses/internalServerError" + "500" : { + "$ref" : "#/components/responses/internalServerError" } }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "CAP" + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" } }, - "/api/atlas/v2/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 API Key must have the Project Read Only role.\n\nThis 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 to return all alerts in all statuses.", - "schema": { - "type": "string", - "enum": ["OPEN", "TRACKING", "CLOSED"] - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedAlertView" + "/api/atlas/v2/groups/{groupId}/auditLog" : { + "get" : { + "tags" : [ "Auditing" ], + "summary" : "Return the 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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuditLog" }, - "x-xgen-version": "2023-01-01" + "x-xgen-version" : "2023-01-01" } } }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" + "404" : { + "$ref" : "#/components/responses/notFound" }, - "500": { - "$ref": "#/components/responses/internalServerError" + "500" : { + "$ref" : "#/components/responses/internalServerError" } }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "CAP" - } - }, - "/api/atlas/v2/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 API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", - "operationId": "listAlertConfigurationsByAlertId", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "$ref": "#/components/parameters/includeCount" + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + }, + "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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuditLog" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AuditLog" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" }, - { - "$ref": "#/components/parameters/itemsPerPage" + "404" : { + "$ref" : "#/components/responses/notFound" }, - { - "$ref": "#/components/parameters/pageNum" + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + } + }, + "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAtlasGroupView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" }, - { - "name": "alertId", - "in": "path", - "description": "Unique 24-hexadecimal digit string that identifies the alert. Use the [/alerts](#tag/Alerts/operation/listAlerts) endpoint to retrieve all alerts to which the authenticated user has access.", - "required": true, - "schema": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + }, + "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 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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedAlertConfigView" + } ], + "requestBody" : { + "description" : "Creates one project.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" }, - "x-xgen-version": "2023-01-01" - } + "x-xgen-version" : "2023-01-01" + } } }, - "401": { - "$ref": "#/components/responses/unauthorized" + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + } + }, + "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + }, + "x-xgen-version" : "2023-01-01" + } + } }, - "404": { - "$ref": "#/components/responses/notFound" + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" }, - "500": { - "$ref": "#/components/responses/internalServerError" + "500" : { + "$ref" : "#/components/responses/internalServerError" } }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "CAP" - } - }, - "/api/atlas/v2/alertConfigs/matchers/fieldNames": { - "get": { - "tags": ["Alert Configurations"], - "summary": "Get 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" + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + }, + "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 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.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "409" : { + "$ref" : "#/components/responses/conflict" }, - { - "$ref": "#/components/parameters/pretty" + "500" : { + "$ref" : "#/components/responses/internalServerError" } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/MatcherFieldView" + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + }, + "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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupUpdate" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + } + }, + "/api/atlas/v2/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 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.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| 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 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n| atlas.project.deployment.salesSoldM0s | Limit on the number of M0 clusters in this project if the org is sales-sold | 100 | 100 |\n", + "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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationLimit" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + }, + "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 API Key must have the Project Owner role.", + "operationId" : "deleteProjectLimit", + "parameters" : [ { + "name" : "limitName", + "in" : "path", + "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| 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 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n| atlas.project.deployment.salesSoldM0s | Limit on the number of M0 clusters in this project if the org is sales-sold | 100 | 100 |\n", + "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.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + }, + "patch" : { + "tags" : [ "Projects" ], + "summary" : "Set One Project Limit", + "description" : "Sets the specified project limit. To use this resource, the requesting API Key must have the Project Owner role.\n\n**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.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| 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 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n| atlas.project.deployment.salesSoldM0s | Limit on the number of M0 clusters in this project if the org is sales-sold | 100 | 100 |\n", + "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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationLimit" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationLimit" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + } + }, + "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataFederationLimit" } }, - "x-xgen-version": "2023-01-01" + "x-xgen-version" : "2023-01-01" } } }, - "401": { - "$ref": "#/components/responses/unauthorized" + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" }, - "500": { - "$ref": "#/components/responses/internalServerError" + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" } }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "CAP" + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" } }, - "/api/atlas/v2/groups/{groupId}/alertConfigs": { - "get": { - "tags": ["Alert Configurations"], - "summary": "Return All Alert Configurations for 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 API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", - "operationId": "listAlertConfigurations", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" + "/api/atlas/v2/groups/byName/{groupName}" : { + "get" : { + "tags" : [ "Projects" ], + "summary" : "Return One Project using Its 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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + }, + "x-xgen-version" : "2023-01-01" + } + } }, - { - "$ref": "#/components/parameters/groupId" + "401" : { + "$ref" : "#/components/responses/unauthorized" }, - { - "$ref": "#/components/parameters/includeCount" + "404" : { + "$ref" : "#/components/responses/notFound" }, - { - "$ref": "#/components/parameters/itemsPerPage" + "400" : { + "$ref" : "#/components/responses/badRequest" }, - { - "$ref": "#/components/parameters/pageNum" + "409" : { + "$ref" : "#/components/responses/conflict" }, - { - "$ref": "#/components/parameters/pretty" + "500" : { + "$ref" : "#/components/responses/internalServerError" } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedAlertConfigView" + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + } + }, + "/api/atlas/v2/groups/{groupId}/settings" : { + "get" : { + "tags" : [ "Projects" ], + "summary" : "Return One Project Settings", + "description" : "Returns details about the specified project's settings. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "getProjectSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupSettings" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + }, + "patch" : { + "tags" : [ "Projects" ], + "summary" : "Update One 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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupSettings" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupSettings" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + } + }, + "/api/atlas/v2/groups/{groupId}/users" : { + "get" : { + "tags" : [ "Projects" ], + "summary" : "Return All 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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAppUserView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + } + }, + "/api/atlas/v2/groups/{groupId}/ipAddresses" : { + "get" : { + "tags" : [ "Projects" ], + "summary" : "Return All IP Addresses for One Project", + "description" : "Returns all IP addresses for this project. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "returnAllIPAddresses", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupIPAddresses" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated IV" + } + }, + "/api/atlas/v2/groups/{groupId}/users/{userId}" : { + "delete" : { + "tags" : [ "Projects" ], + "summary" : "Remove One User from One Project", + "description" : "Removes the specified user from the specified project. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "removeProjectUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "This endpoint does not return a response body.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + } + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + } + }, + "/api/atlas/v2/groups/{groupId}/users/{userId}/roles" : { + "put" : { + "tags" : [ "Projects" ], + "summary" : "Update Project Roles for One MongoDB Cloud User", + "description" : "Updates the roles of the specified user in the specified project. To specify the user to update, provide the unique 24-hexadecimal digit string that identifies the user in the specified project. To use this resource, the requesting API Key must have the Group User Admin role.", + "operationId" : "updateProjectRoles", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "name" : "userId", + "in" : "path", + "description" : "Unique 24-hexadecimal digit string that identifies the user to modify.", + "required" : true, + "schema" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "description" : "Roles to update for the specified user.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateGroupRolesForUser" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateGroupRolesForUser" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + } + }, + "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ThirdPartyIntegration" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "CAP" + }, + "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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ThirdPartyIntegration" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedIntegrationView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "CAP" + }, + "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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ThirdPartyIntegration" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedIntegrationView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "CAP" + }, + "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 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.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "CAP" + } + }, + "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedIntegrationView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "CAP" + } + }, + "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/GroupInvitation" + } }, - "x-xgen-version": "2023-01-01" + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2024-11-04" } } }, - "401": { - "$ref": "#/components/responses/unauthorized" + "401" : { + "$ref" : "#/components/responses/unauthorized" }, - "500": { - "$ref": "#/components/responses/internalServerError" + "500" : { + "$ref" : "#/components/responses/internalServerError" } }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "CAP" + "deprecated" : true, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" }, - "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 API Key must have the Organization Owner or Project Owner role.\n\nThis resource remains under revision and may change.", - "operationId": "createAlertConfiguration", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" + "post" : { + "tags" : [ "Projects" ], + "summary" : "Invite One MongoDB Cloud User to Join 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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitationRequest" + } + } }, - { - "$ref": "#/components/parameters/pretty" + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitation" + }, + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2024-11-04" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" } - ], - "requestBody": { - "description": "Creates one alert configuration for the specified project.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/GroupAlertsConfig" + }, + "deprecated" : true, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + }, + "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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitationRequest" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitation" + }, + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2024-11-04" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "deprecated" : true, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + } + }, + "/api/atlas/v2/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 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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitation" + }, + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2024-11-04" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "deprecated" : true, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + }, + "delete" : { + "tags" : [ "Projects" ], + "summary" : "Cancel 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 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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "This endpoint does not return a response body.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2024-11-04" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "deprecated" : true, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + }, + "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 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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "requestBody" : { + "description" : "Updates the details of one pending invitation to the specified project.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitationUpdateRequest" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitation" + }, + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2024-11-04" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "deprecated" : true, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + } + }, + "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTeamRoleView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + }, + "post" : { + "tags" : [ "Teams" ], + "summary" : "Add One or More Teams 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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/TeamRole" + } } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/GroupAlertsConfig" + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTeamRoleView" }, - "x-xgen-version": "2023-01-01" + "x-xgen-version" : "2023-01-01" } } }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" }, - "500": { - "$ref": "#/components/responses/internalServerError" + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" } }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "CAP" + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" } }, - "/api/atlas/v2/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 API Key must have the Project Read Only role.\n\nThis resource remains under revision and may change.", - "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. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", - "required": true, - "schema": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "example": "32b6e34b3d91647abb20e7b8" - } + "/api/atlas/v2/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 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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/GroupAlertsConfig" - }, - "x-xgen-version": "2023-01-01" + } ], + "responses" : { + "204" : { + "description" : "This endpoint does not return a response body.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" } } }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" + "400" : { + "$ref" : "#/components/responses/badRequest" }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "CAP" - }, - "put": { - "tags": ["Alert Configurations"], - "summary": "Update One Alert Configuration for 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 API Key must have the Organization Owner or Project Owner role.\n\n**NOTE**: To enable or disable the alert configuration, see [Toggle One State of One Alert Configuration in One Project](#tag/Alert-Configurations/operation/toggleAlertConfiguration).\n\nThis resource remains under revision and may change.", - "operationId": "updateAlertConfiguration", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" + "401" : { + "$ref" : "#/components/responses/unauthorized" }, - { - "$ref": "#/components/parameters/groupId" + "403" : { + "$ref" : "#/components/responses/forbidden" }, - { - "$ref": "#/components/parameters/pretty" + "404" : { + "$ref" : "#/components/responses/notFound" }, - { - "name": "alertConfigId", - "in": "path", - "description": "Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", - "required": true, - "schema": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "example": "32b6e34b3d91647abb20e7b8" + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + }, + "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 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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "requestBody" : { + "description" : "The project roles assigned to the specified team.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamRole" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTeamRoleView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + } + }, + "/api/atlas/v2/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 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" : { + "maxLength" : 24, + "minLength" : 24, + "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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/UserAccessRoleAssignment" + } + } } + }, + "required" : true + }, + "responses" : { + "204" : { + "description" : "This endpoint does not return a response body.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + }, + "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 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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" } - ], - "requestBody": { - "description": "Updates one alert configuration in the specified project.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/GroupAlertsConfig" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "description" : "This endpoint does not return a response body.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + }, + "patch" : { + "tags" : [ "Programmatic API Keys" ], + "summary" : "Update Roles of One Organization API Key to 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" : { + "maxLength" : 24, + "minLength" : 24, + "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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateAtlasProjectApiKey" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + } + }, + "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiApiUserView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + }, + "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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateAtlasProjectApiKey" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/GroupAlertsConfig" + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" }, - "x-xgen-version": "2023-01-01" + "x-xgen-version" : "2023-01-01" } } }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" + "401" : { + "$ref" : "#/components/responses/unauthorized" }, - "500": { - "$ref": "#/components/responses/internalServerError" + "500" : { + "$ref" : "#/components/responses/internalServerError" } }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "CAP" - }, - "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 API Key must have the Organization Owner or Project Owner role.\n\nThis resource remains under revision and may change.", - "operationId": "deleteAlertConfiguration", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + } + }, + "/api/atlas/v2/groups/{groupId}/access" : { + "post" : { + "tags" : [ "Projects" ], + "summary" : "Add One MongoDB Cloud User to One Project", + "description" : "Adds one MongoDB Cloud user to the specified project. If the MongoDB Cloud user is not a member of the project's organization, then the user must accept their invitation to the organization to access information within the specified project. If the MongoDB Cloud User is already a member of the project's organization, then they will be added to the project immediately and an invitation will not be returned by this resource. To use this resource, the requesting API Key must have the Group User Admin role.", + "operationId" : "addUserToProject", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "description" : "Adds one MongoDB Cloud user to the specified project.", + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupInvitationRequest" + } + } }, - { - "$ref": "#/components/parameters/pretty" + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + }, + "x-xgen-version" : "2023-02-01" + } + } }, - { - "name": "alertConfigId", - "in": "path", - "description": "Unique 24-hexadecimal digit string that identifies the alert configuration. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", - "required": true, - "schema": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "example": "32b6e34b3d91647abb20e7b8" + "204" : { + "description" : "No Content", + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "x-xgen-version" : "2023-02-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + } + }, + "/api/atlas/v2/groups/{groupId}:migrate" : { + "post" : { + "tags" : [ "Projects" ], + "summary" : "Migrate One Project to Another Organization", + "description" : "Migrates a project from its current organization to another organization. All project users and their roles will be copied to the same project in the destination organization. You must include an organization API key with the Organization Owner role for the destination organization to verify access to the destination organization when you authenticate with Programmatic API Keys. Otherwise, the requesting user must have the Organization Owner role in both organizations. To use this resource, the requesting API Key must have the Organization Owner role.", + "operationId" : "migrateProjectToAnotherOrg", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "description" : "Migrates a project from its current organization to another organization.", + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupMigrationRequest" + } } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/Group" + }, + "x-xgen-version" : "2024-05-30" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + } + }, + "/api/atlas/v2/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 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": { - "204": { - "description": "No Content", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "x-xgen-version": "2023-01-01" + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + } + }, + "x-xgen-version" : "2023-01-01" } } }, - "401": { - "$ref": "#/components/responses/unauthorized" + "400" : { + "$ref" : "#/components/responses/badRequest" }, - "404": { - "$ref": "#/components/responses/notFound" + "401" : { + "$ref" : "#/components/responses/unauthorized" }, - "500": { - "$ref": "#/components/responses/internalServerError" + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" } }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "CAP" + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" }, - "patch": { - "tags": ["Alert Configurations"], - "summary": "Toggle One 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 API Key must have the Organization Owner or Project Owner role.\n\n**NOTE**: This endpoint updates only the enabled/disabled state for the alert configuration. To update more than just this configuration, see [Update One Alert Configuration](#tag/Alert-Configurations/operation/updateAlertConfiguration).\n\nThis resource remains under revision and may change.", - "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. Use the [/alertConfigs](#tag/Alert-Configurations/operation/listAlertConfigurations) endpoint to retrieve all alert configurations to which the authenticated user has access.", - "required": true, - "schema": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "example": "32b6e34b3d91647abb20e7b8" - } - } - ], - "requestBody": { - "description": "Enables or disables the specified alert configuration in the specified project.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/AlertsToggle" + "post" : { + "tags" : [ "Organizations" ], + "summary" : "Invite One MongoDB Cloud User to Join 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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitationRequest" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/GroupAlertsConfig" + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitation" }, - "x-xgen-version": "2023-01-01" + "x-xgen-version" : "2023-01-01" } } }, - "401": { - "$ref": "#/components/responses/unauthorized" + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" }, - "404": { - "$ref": "#/components/responses/notFound" + "404" : { + "$ref" : "#/components/responses/notFound" }, - "500": { - "$ref": "#/components/responses/internalServerError" + "500" : { + "$ref" : "#/components/responses/internalServerError" } }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "CAP" - } - }, - "/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}": { - "get": { - "tags": ["Groups"], - "summary": "Service Account Fetching", - "description": "Get project Service Account Details.", - "operationId": "getProjectServiceAccount", - "parameters": [ - { - "$ref": "#/components/parameters/groupId" - }, - { - "name": "serviceAccountId", - "in": "path", - "description": "Id of the service account.", - "required": true, - "schema": { - "type": "string" + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + }, + "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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitationRequest" + } } }, - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/pretty" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-10-01+json": { - "schema": { - "$ref": "#/components/schemas/GroupServiceAccount" + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + } + }, + "/api/atlas/v2/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 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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + }, + "delete" : { + "tags" : [ "Organizations" ], + "summary" : "Cancel 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 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.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + }, + "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 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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "requestBody" : { + "description" : "Updates the details of one pending invitation to the specified organization.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitationUpdateRequest" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationInvitation" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + } + }, + "/api/atlas/v2/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 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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasCheckpointView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "deprecated" : true, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Backup - Atlas" + } + }, + "/api/atlas/v2/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 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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasCheckpointView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "deprecated" : true, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Backup - Atlas" + } + }, + "/api/atlas/v2/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 API Key must have the Project Read Only 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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotExportBucket" + }, + "examples" : { + "AWS" : { + "description" : "AWS", + "value" : { + "_id" : "32b6e34b3d91647abb20e7b8", + "bucketName" : "export-bucket", + "cloudProvider" : "AWS", + "iamRoleId" : "668c5f0ed436263134491592", + "links" : [ { + "href" : "https://cloud.mongodb.com/api/atlas", + "rel" : "self" + } ] + } + }, + "Azure" : { + "description" : "Azure", + "value" : { + "_id" : "32b6e34b3d91647abb20e7b8", + "bucketName" : "export-container", + "cloudProvider" : "AZURE", + "roleId" : "668c5f0ed436263134491592", + "serviceUrl" : "https://examplestorageaccount.blob.core.windows.net", + "tenantId" : "4297fc77-1592-4de8-a6d5-a8c32401df87", + "links" : [ { + "href" : "https://cloud.mongodb.com/api/atlas", + "rel" : "self" + } ] + } + } + }, + "x-xgen-version" : "2024-05-30" + }, + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" + }, + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2026-05-30" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Backup - Atlas" + }, + "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 API Key must have the Project Owner 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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8" + } + } ], + "responses" : { + "204" : { + "description" : "This endpoint does not return a response body.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Backup - Atlas" + } + }, + "/api/atlas/v2/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 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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasDiskBackupExportJobView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Backup - Atlas" + }, + "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 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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } ], + "requestBody" : { + "description" : "Information about the Cloud Backup Snapshot Export Job to create.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupExportJobRequest" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupExportJob" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Backup - Atlas" + } + }, + "/api/atlas/v2/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 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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupExportJob" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Backup - Atlas" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}" : { + "get" : { + "tags" : [ "Cloud Backups" ], + "summary" : "Return One Restore Job of One Cluster", + "description" : "Returns one cloud backup restore job for one cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "getBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "name" : "clusterName", + "in" : "path", + "description" : "Human-readable label that identifies the cluster with the restore jobs you want to return.", + "required" : true, + "schema" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Backup - Atlas" + }, + "delete" : { + "tags" : [ "Cloud Backups" ], + "summary" : "Cancel One Restore Job of One Cluster", + "description" : "Cancels one cloud backup restore job of one cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "cancelBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "name" : "clusterName", + "in" : "path", + "description" : "Human-readable label that identifies the cluster.", + "required" : true, + "schema" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "This endpoint does not return a response body.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "405" : { + "$ref" : "#/components/responses/methodNotAllowed" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Backup - Atlas" + } + }, + "/api/atlas/v2/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 API Key must have the Project Owner role.", + "operationId" : "listBackupRestoreJobs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "name" : "clusterName", + "in" : "path", + "description" : "Human-readable label that identifies the cluster with the restore jobs you want to return.", + "required" : true, + "schema" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudBackupRestoreJobView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Backup - Atlas" + }, + "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.\n\n To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "createBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "name" : "clusterName", + "in" : "path", + "description" : "Human-readable label that identifies the cluster.", + "required" : true, + "schema" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } ], + "requestBody" : { + "description" : "Restores one snapshot of one cluster from the specified project.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotRestoreJob" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Backup - Atlas" + } + }, + "/api/atlas/v2/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 API Key must have the Project Read Only 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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupShardedClusterSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Backup - Atlas" + }, + "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 API Key must have the Project Owner 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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "This endpoint does not return a response body.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Backup - Atlas" + } + }, + "/api/atlas/v2/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 API Key must have the Project Read Only 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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupReplicaSet" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Backup - Atlas" + }, + "delete" : { + "tags" : [ "Cloud Backups" ], + "summary" : "Remove One Replica Set Cloud Backup", + "description" : "Removes the specified snapshot. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "deleteReplicaSetBackup", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "name" : "clusterName", + "in" : "path", + "description" : "Human-readable label that identifies the cluster.", + "required" : true, + "schema" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "This endpoint does not return a response body.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Backup - Atlas" + }, + "patch" : { + "tags" : [ "Cloud Backups" ], + "summary" : "Change Expiration Date for One Cloud Backup", + "description" : "Changes the expiration date for one cloud backup snapshot for one cluster in the specified project.", + "operationId" : "updateSnapshotRetention", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "name" : "clusterName", + "in" : "path", + "description" : "Human-readable label that identifies the cluster.", + "required" : true, + "schema" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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" : { + "maxLength" : 24, + "minLength" : 24, + "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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupSnapshotRetention" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupReplicaSet" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Backup - Atlas" + } + }, + "/api/atlas/v2/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 API Key must have the Project Read Only 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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudBackupShardedClusterSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Backup - Atlas" + } + }, + "/api/atlas/v2/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 API Key must have the Project Read Only role.", + "operationId" : "listReplicaSetBackups", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "name" : "clusterName", + "in" : "path", + "description" : "Human-readable label that identifies the cluster.", + "required" : true, + "schema" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudBackupReplicaSetView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Backup - Atlas" + }, + "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.\n\n To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "takeSnapshot", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "name" : "clusterName", + "in" : "path", + "description" : "Human-readable label that identifies the cluster.", + "required" : true, + "schema" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } ], + "requestBody" : { + "description" : "Takes one on-demand snapshot.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupOnDemandSnapshotRequest" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Backup - Atlas" + } + }, + "/api/atlas/v2/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 API Key must have the Project Read Only role.\n\n Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the [Cloud Backup documentation](https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule). If you use the `BATCH-ID` query parameter, you can retrieve all restore jobs in the specified batch. When creating a restore job for a sharded cluster, MongoDB Cloud creates a separate job for each shard, plus another for the config server. Each of those jobs are part of a batch. However, a batch can't include a restore job for a replica set.", + "operationId" : "listLegacyBackupRestoreJobs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedRestoreJobView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "deprecated" : true, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Backup - Atlas" + }, + "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 API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the [Cloud Backup documentation](https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule). This endpoint doesn't support creating checkpoint restore jobs for sharded clusters, or creating restore jobs for queryable backup snapshots. If you create an automated restore job by specifying `delivery.methodName` of `AUTOMATED_RESTORE` in your request body, MongoDB Cloud removes all existing data on the target cluster prior to the restore.", + "operationId" : "createLegacyBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "name" : "clusterName", + "in" : "path", + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "required" : true, + "schema" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupRestoreJob" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedRestoreJobView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "deprecated" : true, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Backup - Atlas" + } + }, + "/api/atlas/v2/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 API Key must have the Project Read Only role.\n\n Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the [Cloud Backup documentation](https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule).", + "operationId" : "getLegacyBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "name" : "clusterName", + "in" : "path", + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "required" : true, + "schema" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "deprecated" : true, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Backup - Atlas" + } + }, + "/api/atlas/v2/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 API Key must have the Project Owner role.", + "operationId" : "listServerlessBackupRestoreJobs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "name" : "clusterName", + "in" : "path", + "description" : "Human-readable label that identifies the serverless instance.", + "required" : true, + "schema" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasServerlessBackupRestoreJobView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Backup - Private Cloud" + }, + "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 API Key must have the Project Owner role.", + "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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Backup - Private Cloud" + } + }, + "/api/atlas/v2/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 API Key must have the Project Owner role.", + "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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Backup - Private Cloud" + } + }, + "/api/atlas/v2/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 API Key must have the Project Read Only role.", + "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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessBackupSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Backup - Private Cloud" + } + }, + "/api/atlas/v2/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 API Key must have the Project Read Only role.", + "operationId" : "listServerlessBackups", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "name" : "clusterName", + "in" : "path", + "description" : "Human-readable label that identifies the serverless instance.", + "required" : true, + "schema" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasServerlessBackupSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Backup - Private Cloud" + } + }, + "/api/atlas/v2/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 API Key must have the Project Read Only role.\n\n Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the [Cloud Backup documentation](https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule).", + "operationId" : "getLegacySnapshotSchedule", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "name" : "clusterName", + "in" : "path", + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "required" : true, + "schema" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasSnapshotScheduleView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "deprecated" : true, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Backup - Atlas" + }, + "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 API Key must have the Project Owner role.\n\n Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the [Cloud Backup documentation](https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule).", + "operationId" : "updateLegacySnapshotSchedule", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "name" : "clusterName", + "in" : "path", + "description" : "Human-readable label that identifies the cluster with the snapshot you want to return.", + "required" : true, + "schema" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasSnapshotScheduleView" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasSnapshotScheduleView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "deprecated" : true, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Backup - Atlas" + } + }, + "/api/atlas/v2/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 API Key must have the Project Read Only role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the [Cloud Backup documentation](https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule).", + "operationId" : "getLegacySnapshot", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "name" : "clusterName", + "in" : "path", + "description" : "Human-readable label that identifies the cluster.", + "required" : true, + "schema" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "deprecated" : true, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Backup - Atlas" + }, + "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 API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the [Cloud Backup documentation](https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule).", + "operationId" : "deleteLegacySnapshot", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "name" : "clusterName", + "in" : "path", + "description" : "Human-readable label that identifies the cluster.", + "required" : true, + "schema" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "This endpoint does not return a response body.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "deprecated" : true, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Backup - Atlas" + }, + "patch" : { + "tags" : [ "Legacy Backup" ], + "summary" : "Change One Legacy Backup Snapshot Expiration", + "description" : "Changes the expiration date for one legacy backup snapshot for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the [Cloud Backup documentation](https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule).", + "operationId" : "updateLegacySnapshotRetention", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "name" : "clusterName", + "in" : "path", + "description" : "Human-readable label that identifies the cluster.", + "required" : true, + "schema" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "requestBody" : { + "description" : "Changes One Legacy Backup Snapshot Expiration.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupSnapshot" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "deprecated" : true, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Backup - Atlas" + } + }, + "/api/atlas/v2/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 API Key must have the Project Read Only role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the [Cloud Backup documentation](https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule).", + "operationId" : "listLegacySnapshots", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "name" : "clusterName", + "in" : "path", + "description" : "Human-readable label that identifies the cluster.", + "required" : true, + "schema" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "deprecated" : true, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Backup - Atlas" + } + }, + "/api/atlas/v2/groups/{groupId}/backupCompliancePolicy" : { + "get" : { + "tags" : [ "Cloud Backups" ], + "summary" : "Return the Backup Compliance Policy settings", + "description" : "Returns the Backup Compliance Policy settings with the specified project. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "getDataProtectionSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-10-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataProtectionSettings20231001" + }, + "x-xgen-version" : "2023-10-01" + }, + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataProtectionSettings" + }, + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2026-10-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Backup - Atlas" + }, + "put" : { + "tags" : [ "Cloud Backups" ], + "summary" : "Update or enable the Backup Compliance Policy settings", + "description" : "Updates the Backup Compliance Policy settings for the specified project. To use this resource, the requesting API Key must have the Project Owner role.", + "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/vnd.atlas.2023-10-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataProtectionSettings20231001" + }, + "x-xgen-version" : "2023-10-01" + }, + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataProtectionSettings" + }, + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2024-10-01" + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-10-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataProtectionSettings20231001" + }, + "x-xgen-version" : "2023-10-01" + }, + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataProtectionSettings" + }, + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2025-10-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Backup - Atlas" + } + }, + "/api/atlas/v2/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 API Key must have the Project Read Only role.", + "operationId" : "listExportBuckets", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedBackupSnapshotExportBucketsView" + }, + "x-xgen-version" : "2024-05-30" + }, + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedBackupSnapshotExportBucketView" + }, + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2026-05-30" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Backup - Atlas" + }, + "post" : { + "tags" : [ "Cloud Backups" ], + "summary" : "Create One Snapshot Export Bucket", + "description" : "Creates a Snapshot Export Bucket for an AWS S3 Bucket or Azure Blob Storage Container. Once created, an snapshots can be exported to the Export Bucket and its referenced AWS S3 Bucket or Azure Blob Storage Container. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "createExportBucket", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "description" : "Specifies the role and AWS S3 Bucket or Azure Blob Storage Container that the Export Bucket should reference.", + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotExportBucket" + }, + "examples" : { + "AWS" : { + "description" : "AWS", + "value" : { + "bucketName" : "export-bucket", + "cloudProvider" : "AWS", + "iamRoleId" : "668c5f0ed436263134491592" + } + }, + "Azure" : { + "description" : "Azure", + "value" : { + "bucketName" : "export-container", + "cloudProvider" : "AZURE", + "roleId" : "668c5f0ed436263134491592", + "serviceUrl" : "https://examplestorageaccount.blob.core.windows.net", + "tenantId" : "4297fc77-1592-4de8-a6d5-a8c32401df87" + } + } + }, + "x-xgen-version" : "2024-05-30" + }, + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" + }, + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2025-05-30" + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotExportBucket" + }, + "examples" : { + "AWS" : { + "description" : "AWS", + "value" : { + "_id" : "32b6e34b3d91647abb20e7b8", + "bucketName" : "export-bucket", + "cloudProvider" : "AWS", + "iamRoleId" : "668c5f0ed436263134491592", + "links" : [ { + "href" : "https://cloud.mongodb.com/api/atlas", + "rel" : "self" + } ] + } + }, + "Azure" : { + "description" : "Azure", + "value" : { + "_id" : "32b6e34b3d91647abb20e7b8", + "bucketName" : "export-container", + "cloudProvider" : "AZURE", + "roleId" : "668c5f0ed436263134491592", + "serviceUrl" : "https://examplestorageaccount.blob.core.windows.net", + "tenantId" : "4297fc77-1592-4de8-a6d5-a8c32401df87", + "links" : [ { + "href" : "https://cloud.mongodb.com/api/atlas", + "rel" : "self" + } ] + } + } }, - "x-xgen-version": "2023-10-01" + "x-xgen-version" : "2024-05-30" + }, + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" + }, + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2026-05-30" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Backup - Atlas" + } + }, + "/api/atlas/v2/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 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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotSchedule20240805" + }, + "x-xgen-version" : "2024-08-05" + }, + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotSchedule" + }, + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2026-05-30" + } + } + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Backup - Atlas" + }, + "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 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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotSchedule20240805" + }, + "x-xgen-version" : "2024-08-05" + }, + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotSchedule" + }, + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2026-05-30" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Backup - Atlas" + }, + "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 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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } ], + "requestBody" : { + "description" : "Updates the cloud backup schedule for one cluster within the specified project.\n\n**Note**: In the request body, provide only the fields that you want to update.", + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotSchedule20240805" + } + }, + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotSchedule" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotSchedule20240805" + }, + "x-xgen-version" : "2024-08-05" + }, + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DiskBackupSnapshotSchedule" + }, + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2026-05-30" } } }, - "401": { - "$ref": "#/components/responses/unauthorized" + "400" : { + "$ref" : "#/components/responses/badRequest" }, - "404": { - "$ref": "#/components/responses/notFound" + "404" : { + "$ref" : "#/components/responses/notFound" }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] + "500" : { + "$ref" : "#/components/responses/internalServerError" } - ], - "x-xgen-hidden-env": { - "envs": "qa,stage,prod" }, - "x-xgen-owner-team": "apix" + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Backup - Atlas" + } + }, + "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRoles" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" }, - "post": { - "tags": ["Groups"], - "summary": "Assign One Service Account to One Project", - "description": "Assigns the specified organization Service Account to the specified project.", - "operationId": "addProjectServiceAccount", - "parameters": [ - { - "name": "serviceAccountId", - "in": "path", - "description": "Id of the service account.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/envelope" + "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 API Key must have the Project Owner role.", + "externalDocs" : { + "description" : "Set Up Access to Cloud Providers", + "url" : "https://www.mongodb.com/docs/atlas/security/cloud-provider-access/" + }, + "operationId" : "createCloudProviderAccessRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "description" : "Creates one role for the specified cloud provider.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRoleRequest" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + } + }, + "/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}" : { + "get" : { + "tags" : [ "Cloud Provider Access" ], + "summary" : "Return specified 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 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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + }, + "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 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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "requestBody" : { + "description" : "Grants access to the specified project for the specified access role.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRoleRequestUpdate" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + } + }, + "/api/atlas/v2/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 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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "No Content", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + } + }, + "/api/atlas/v2/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 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", + "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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasProviderRegionsView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + } + }, + "/api/atlas/v2/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 API Key to have the Project Owner role.\n\n**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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EncryptionAtRest" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + }, + "patch" : { + "tags" : [ "Encryption at Rest using Customer Key Management" ], + "summary" : "Update Configuration for Encryption at Rest using Customer-Managed Keys 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 API Key to have the Project Owner role. This feature isn't available for `M0` free clusters, `M2`, `M5`, or serverless clusters.\n\n 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:\n\nIf you have enabled Encryption at Rest using Customer Key Management (CMK), Atlas requires all of the parameters for the desired encryption provider.\n\n- To use AWS Key Management Service (KMS), MongoDB Cloud requires all the fields in the **awsKms** object.\n- To use Azure Key Vault, MongoDB Cloud requires all the fields in the **azureKeyVault** object.\n- To use Google Cloud Key Management Service (KMS), MongoDB Cloud requires all the fields in the **googleCloudKms** object.\n\nIf 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EncryptionAtRest" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EncryptionAtRest" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + } + }, + "/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}" : { + "get" : { + "tags" : [ "Encryption at Rest using Customer Key Management" ], + "summary" : "Return One Private Endpoint for Encryption at Rest Using Customer Key Management", + "description" : "Returns one private endpoint, identified by its ID, for encryption at rest using Customer Key Management.", + "operationId" : "getEncryptionAtRestPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "name" : "cloudProvider", + "in" : "path", + "description" : "Human-readable label that identifies the cloud provider of the private endpoint.", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "AZURE" ] + } + }, { + "name" : "endpointId", + "in" : "path", + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", + "required" : true, + "schema" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EARPrivateEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + }, + "delete" : { + "tags" : [ "Encryption at Rest using Customer Key Management" ], + "summary" : "Delete Private Endpoint for Encryption at Rest Using Customer Key Management", + "description" : "Deletes one private endpoint, identified by its ID, for encryption at rest using Customer Key Management.", + "operationId" : "requestEncryptionAtRestPrivateEndpointDeletion", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "name" : "cloudProvider", + "in" : "path", + "description" : "Human-readable label that identifies the cloud provider of the private endpoint to delete.", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "AZURE" ] + } + }, { + "name" : "endpointId", + "in" : "path", + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint to delete.", + "required" : true, + "schema" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "This endpoint does not return a response body.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + } + }, + "/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints" : { + "get" : { + "tags" : [ "Encryption at Rest using Customer Key Management" ], + "summary" : "Return Private Endpoints of a Cloud Provider for Encryption at Rest Using Customer Key Management for One Project", + "description" : "Returns the private endpoints of the specified cloud provider for encryption at rest using customer key management.", + "operationId" : "getEncryptionAtRestPrivateEndpointsForCloudProvider", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "name" : "cloudProvider", + "in" : "path", + "description" : "Human-readable label that identifies the cloud provider for the private endpoints to return.", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "AZURE" ] + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasEARPrivateEndpointView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + }, + "post" : { + "tags" : [ "Encryption at Rest using Customer Key Management" ], + "summary" : "Create One Private Endpoint in a Specified Region for Encryption at Rest Using Customer Key Management", + "description" : "Creates a private endpoint in the specified region for encryption at rest using customer key management.", + "operationId" : "createEncryptionAtRestPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "name" : "cloudProvider", + "in" : "path", + "description" : "Human-readable label that identifies the cloud provider for the private endpoint to create.", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "AZURE" ] + } + } ], + "requestBody" : { + "description" : "Creates a private endpoint in the specified region.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EARPrivateEndpoint" + } + } + }, + "required" : true + }, + "responses" : { + "202" : { + "description" : "Accepted", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EARPrivateEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore" : { + "post" : { + "tags" : [ "Shared-Tier Restore Jobs" ], + "summary" : "Create One Restore Job from One M2 or M5 Cluster", + "description" : "Restores the specified cluster. MongoDB Cloud limits which clusters can be the target clusters of a restore. The target cluster can't use encryption at rest, run a major release MongoDB version different than the snapshot, or receive client requests during restores. MongoDB Cloud deletes all existing data on the target cluster prior to the restore operation. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "createSharedClusterBackupRestoreJob", + "parameters" : [ { + "name" : "clusterName", + "in" : "path", + "description" : "Human-readable label that identifies the cluster.", + "required" : true, + "schema" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" }, - { - "$ref": "#/components/parameters/pretty" + "500" : { + "$ref" : "#/components/responses/internalServerError" } - ], - "requestBody": { - "description": "Service Account Roles to be assigned to the specified project.", - "content": { - "application/vnd.atlas.2023-10-01+json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GroupServiceAccountRoleAssignment" - } - }, - "x-xgen-version": "2023-10-01" - } - }, - "required": true }, - "responses": { - "204": { - "description": "This endpoint does not return a response body.", - "content": { - "application/vnd.atlas.2023-10-01+json": { - "schema": { - "$ref": "#/components/schemas/NoBody" + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + } + }, + "/api/atlas/v2/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 API Key must have the Project Owner role.", + "operationId" : "downloadSharedClusterBackup", + "parameters" : [ { + "name" : "clusterName", + "in" : "path", + "description" : "Human-readable label that identifies the cluster.", + "required" : true, + "schema" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + } + }, + "/api/atlas/v2/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. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "getSharedClusterBackupRestoreJob", + "parameters" : [ { + "name" : "clusterName", + "in" : "path", + "description" : "Human-readable label that identifies the cluster.", + "required" : true, + "schema" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantRestore" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + } + }, + "/api/atlas/v2/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 API Key must have the Project Read Only role.", + "operationId" : "listSharedClusterBackupRestoreJobs", + "parameters" : [ { + "name" : "clusterName", + "in" : "path", + "description" : "Human-readable label that identifies the cluster.", + "required" : true, + "schema" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTenantRestoreView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId}" : { + "get" : { + "tags" : [ "Shared-Tier Snapshots" ], + "summary" : "Return One Snapshot for One M2 or M5 Cluster", + "description" : "Returns details for one snapshot for the specified shared cluster. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "getSharedClusterBackup", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "name" : "clusterName", + "in" : "path", + "description" : "Human-readable label that identifies the cluster.", + "required" : true, + "schema" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupTenantSnapshot" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + } + }, + "/api/atlas/v2/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 API Key must have the Project Read Only role.", + "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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTenantSnapshotView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + } + }, + "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataLakeTenant" + } }, - "x-xgen-version": "2023-10-01" + "x-xgen-version" : "2023-01-01" } - }, - "x-xgen-version": "2023-10-01" - }, - "401": { - "$ref": "#/components/responses/unauthorized" + } }, - "404": { - "$ref": "#/components/responses/notFound" + "401" : { + "$ref" : "#/components/responses/unauthorized" }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] + "500" : { + "$ref" : "#/components/responses/internalServerError" } - ], - "x-xgen-hidden-env": { - "envs": "qa,stage,prod" }, - "x-xgen-owner-team": "apix" + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Online Archive II" }, - "delete": { - "tags": ["Groups"], - "summary": "Unassign One Service Account from One Project.", - "description": "Removes one Service Account from the specified project.", - "operationId": "deleteProjectServiceAccount", - "parameters": [ - { - "name": "serviceAccountId", - "in": "path", - "description": "Id of the service account.", - "required": true, - "schema": { - "type": "string" + "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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + }, + "x-xgen-version" : "2023-01-01" + } } }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/envelope" + "400" : { + "$ref" : "#/components/responses/badRequest" }, - { - "$ref": "#/components/parameters/pretty" + "500" : { + "$ref" : "#/components/responses/internalServerError" } - ], - "responses": { - "204": { - "description": "This endpoint does not return a response body.", - "content": { - "application/vnd.atlas.2023-10-01+json": { - "schema": { - "$ref": "#/components/schemas/NoBody" + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Online Archive II" + } + }, + "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Online Archive II" + }, + "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 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.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Online Archive II" + }, + "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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeTenant" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Online Archive II" + } + }, + "/api/atlas/v2/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 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.\n\n| Limit Name | Description | Default |\n| --- | --- | --- |\n| bytesProcessed.query | Limit on the number of bytes processed during a single data federation query | N/A |\n| bytesProcessed.daily | Limit on the number of bytes processed for the data federation instance for the current day | N/A |\n| bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A |\n| bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A |\n", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "bytesProcessed.query", "bytesProcessed.daily", "bytesProcessed.weekly", "bytesProcessed.monthly" ] + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationTenantQueryLimit" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Online Archive II" + }, + "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 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.\n\n| Limit Name | Description | Default |\n| --- | --- | --- |\n| bytesProcessed.query | Limit on the number of bytes processed during a single data federation query | N/A |\n| bytesProcessed.daily | Limit on the number of bytes processed for the data federation instance for the current day | N/A |\n| bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A |\n| bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A |\n", + "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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Online Archive II" + }, + "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 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.\n\n| Limit Name | Description | Default |\n| --- | --- | --- |\n| bytesProcessed.query | Limit on the number of bytes processed during a single data federation query | N/A |\n| bytesProcessed.daily | Limit on the number of bytes processed for the data federation instance for the current day | N/A |\n| bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A |\n| bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A |\n", + "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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationTenantQueryLimit" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataFederationTenantQueryLimit" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Online Archive II" + } + }, + "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataFederationTenantQueryLimit" + } }, - "x-xgen-version": "2023-10-01" + "x-xgen-version" : "2023-01-01" } - }, - "x-xgen-version": "2023-10-01" - }, - "401": { - "$ref": "#/components/responses/unauthorized" + } }, - "404": { - "$ref": "#/components/responses/notFound" + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Online Archive II" + } + }, + "/api/atlas/v2/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 API Key must have the Project Owner or Project Data Access Read Write roles. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: \"Accept: application/vnd.atlas.YYYY-MM-DD+gzip\".", + "operationId" : "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/vnd.atlas.2023-01-01+gzip" : { + "schema" : { + "type" : "string", + "description" : "Compressed archive labeled `queryLogs.gz` downloads", + "format" : "binary" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Online Archive II" + } + }, + "/api/atlas/v2/groups/{groupId}/pipelines" : { + "get" : { + "tags" : [ "Data Lake Pipelines" ], + "summary" : "Return All Data Lake Pipelines from One Project", + "description" : "Returns a list of Data Lake Pipelines. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "listPipelines", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + } + }, + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2025-09-09" + } + } }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" } - ], - "x-xgen-hidden-env": { - "envs": "qa,stage,prod" }, - "x-xgen-owner-team": "apix" + "deprecated" : true, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Online Archive II" }, - "patch": { - "tags": ["Groups"], - "summary": "Service Account Update in Project", - "description": "Update Service Account in Project.", - "operationId": "updateProjectServiceAccount", - "parameters": [ - { - "name": "serviceAccountId", - "in": "path", - "description": "Id of the service account.", - "required": true, - "schema": { - "type": "string" + "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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2025-09-09" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "deprecated" : true, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Online Archive II" + } + }, + "/api/atlas/v2/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 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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2025-09-09" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "deprecated" : true, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Online Archive II" + }, + "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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$", + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "This endpoint does not return a response body.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2025-09-09" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "deprecated" : true, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Online Archive II" + }, + "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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$", + "type" : "string" + } + } ], + "requestBody" : { + "description" : "Updates one Data Lake Pipeline.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2025-09-09" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "deprecated" : true, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Online Archive II" + } + }, + "/api/atlas/v2/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 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" : { + "maxLength" : 64, + "minLength" : 1, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/IngestionPipelineRun" + }, + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2025-09-09" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "deprecated" : true, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Online Archive II" + }, + "delete" : { + "tags" : [ "Data Lake Pipelines" ], + "summary" : "Delete 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" : { + "maxLength" : 64, + "minLength" : 1, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8" + } + } ], + "responses" : { + "202" : { + "description" : "Accepted", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/RequestAccepted" + }, + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2025-09-09" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "deprecated" : true, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Online Archive II" + } + }, + "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules" : { + "get" : { + "tags" : [ "Data Lake Pipelines" ], + "summary" : "Return Available 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 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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/DiskBackupApiPolicyItem" + } + }, + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2025-09-09" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "deprecated" : true, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Online Archive II" + } + }, + "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots" : { + "get" : { + "tags" : [ "Data Lake Pipelines" ], + "summary" : "Return Available 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 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", + "example" : "2022-01-01T00:00:00.000Z" + } + }, { + "name" : "pipelineName", + "in" : "path", + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "required" : true, + "schema" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedBackupSnapshotView" + }, + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2025-09-09" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "deprecated" : true, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Online Archive II" + } + }, + "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs" : { + "get" : { + "tags" : [ "Data Lake Pipelines" ], + "summary" : "Return All Data Lake Pipeline Runs from One Project", + "description" : "Returns a list of past Data Lake Pipeline runs. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "listPipelineRuns", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "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", + "example" : "2022-01-01T00:00:00.000Z" + } + }, { + "name" : "pipelineName", + "in" : "path", + "description" : "Human-readable label that identifies the Data Lake Pipeline.", + "required" : true, + "schema" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedPipelineRunView" + }, + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2025-09-09" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "deprecated" : true, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Online Archive II" + } + }, + "/api/atlas/v2/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 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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2025-09-09" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "deprecated" : true, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Online Archive II" + } + }, + "/api/atlas/v2/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 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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/DataLakeIngestionPipeline" + }, + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2025-09-09" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "deprecated" : true, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Online Archive II" + } + }, + "/api/atlas/v2/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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[^/\\\\ \"$]{1,64}$", + "type" : "string" + } + } ], + "requestBody" : { + "description" : "Triggers a single ingestion run of a snapshot.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TriggerIngestionPipelineRequest" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/IngestionPipelineRun" + }, + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2025-09-09" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "deprecated" : true, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Online Archive II" + } + }, + "/api/atlas/v2/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 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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } ], + "requestBody" : { + "description" : "Creates one Atlas Search index on the specified collection.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2025-06-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "deprecated" : true, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Search Web Platform" + } + }, + "/api/atlas/v2/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 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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2025-06-01" + } + } + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "deprecated" : true, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Search Web Platform" + }, + "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 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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "This endpoint does not return a response body.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2025-06-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "deprecated" : true, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Search Web Platform" + }, + "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 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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "requestBody" : { + "description" : "Details to update on the Atlas Search index.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2025-06-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "deprecated" : true, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Search Web Platform" + } + }, + "/api/atlas/v2/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 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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ClusterSearchIndex" + } + }, + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2025-06-01" + } + } + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "deprecated" : true, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Search Web Platform" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment" : { + "get" : { + "tags" : [ "Atlas Search" ], + "summary" : "Return Search Nodes", + "description" : "Return the Search Nodes for the specified cluster.", + "operationId" : "getAtlasSearchDeployment", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "name" : "clusterName", + "in" : "path", + "description" : "Label that identifies the cluster to return the Search Nodes for.", + "required" : true, + "schema" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentResponseView" + }, + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2026-03-01" + }, + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentResponseView" + }, + "x-xgen-version" : "2024-05-30" + } } }, - { - "$ref": "#/components/parameters/groupId" + "400" : { + "$ref" : "#/components/responses/badRequest" }, - { - "$ref": "#/components/parameters/envelope" + "404" : { + "$ref" : "#/components/responses/notFound" }, - { - "$ref": "#/components/parameters/pretty" - } - ], - "requestBody": { - "description": "Details to update service account in the specified Project.", - "content": { - "application/vnd.atlas.2023-10-01+json": { - "schema": { - "$ref": "#/components/schemas/GroupServiceAccountUpdateRequest" + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Search Web Platform" + }, + "post" : { + "tags" : [ "Atlas Search" ], + "summary" : "Create Search Nodes", + "description" : "Creates Search Nodes for the specified cluster.", + "operationId" : "createAtlasSearchDeployment", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "name" : "clusterName", + "in" : "path", + "description" : "Label that identifies the cluster to create Search Nodes for.", + "required" : true, + "schema" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } ], + "requestBody" : { + "description" : "Creates Search Nodes for the specified cluster.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentRequestView" + } + }, + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentRequestView" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentResponseView" + }, + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2026-03-01" + } + } + }, + "201" : { + "description" : "Created", + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentResponseView" + }, + "x-xgen-version" : "2024-05-30" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Search Web Platform" + }, + "delete" : { + "tags" : [ "Atlas Search" ], + "summary" : "Delete Search Nodes", + "description" : "Deletes the Search Nodes for the specified cluster.", + "operationId" : "deleteAtlasSearchDeployment", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "name" : "clusterName", + "in" : "path", + "description" : "Label that identifies the cluster to delete.", + "required" : true, + "schema" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2026-03-01" } } }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-10-01+json": { - "schema": { - "$ref": "#/components/schemas/GroupServiceAccount" + "204" : { + "description" : "This endpoint does not return a response body.", + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" }, - "x-xgen-version": "2023-10-01" + "x-xgen-version" : "2024-05-30" } } }, - "400": { - "$ref": "#/components/responses/badRequest" + "400" : { + "$ref" : "#/components/responses/badRequest" }, - "401": { - "$ref": "#/components/responses/unauthorized" + "404" : { + "$ref" : "#/components/responses/notFound" }, - "404": { - "$ref": "#/components/responses/notFound" + "409" : { + "$ref" : "#/components/responses/conflict" }, - "500": { - "$ref": "#/components/responses/internalServerError" + "500" : { + "$ref" : "#/components/responses/internalServerError" } }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-hidden-env": { - "envs": "qa,stage,prod" - }, - "x-xgen-owner-team": "apix" - } - }, - "/api/atlas/v2/groups/{groupId}/serviceAccounts": { - "get": { - "tags": ["Groups"], - "summary": "Return All project Service Accounts", - "description": "Returns list of Service Accounts for a project with service account details.", - "operationId": "listProjectServiceAccounts", - "parameters": [ - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/itemsPerPage" - }, - { - "$ref": "#/components/parameters/pageNum" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "$ref": "#/components/parameters/envelope" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-10-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedGroupServiceAccounts" + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Search Web Platform" + }, + "patch" : { + "tags" : [ "Atlas Search" ], + "summary" : "Update Search Nodes", + "description" : "Updates the Search Nodes for the specified cluster.", + "operationId" : "updateAtlasSearchDeployment", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "name" : "clusterName", + "in" : "path", + "description" : "Label that identifies the cluster to update the Search Nodes for.", + "required" : true, + "schema" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } ], + "requestBody" : { + "description" : "Updates the Search Nodes for the specified cluster.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentRequestView" + } + }, + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentRequestView" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentResponseView" + }, + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2026-03-01" + }, + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentResponseView" + }, + "x-xgen-version" : "2024-05-30" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Search Web Platform" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes" : { + "get" : { + "tags" : [ "Atlas Search" ], + "summary" : "Return All Atlas Search Indexes for One Cluster", + "description" : "Returns all Atlas Search indexes on the specified cluster. Atlas Search indexes contain the indexed fields and the analyzers used to create the indexes. To use this resource, the requesting 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" : "listAtlasSearchIndexesCluster", + "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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/SearchIndexResponse" + } }, - "x-xgen-version": "2023-10-01" + "x-xgen-version" : "2024-05-30" } } }, - "401": { - "$ref": "#/components/responses/unauthorized" + "400" : { + "$ref" : "#/components/responses/badRequest" }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-hidden-env": { - "envs": "qa,stage,prod" - }, - "x-xgen-owner-team": "apix" - }, - "post": { - "tags": ["Groups"], - "summary": "Create and Assign one Service Account to one project", - "description": "Creates and assigns the specified Service Account to the specified Project.", - "operationId": "createProjectServiceAccount", - "parameters": [ - { - "$ref": "#/components/parameters/groupId" + "404" : { + "$ref" : "#/components/responses/notFound" }, - { - "$ref": "#/components/parameters/envelope" + "500" : { + "$ref" : "#/components/responses/internalServerError" }, - { - "$ref": "#/components/parameters/pretty" + "503" : { + "description" : "Service Unavailable.", + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + } } - ], - "requestBody": { - "description": "Details to create service account and add to the specified project.", - "content": { - "application/vnd.atlas.2023-10-01+json": { - "schema": { - "$ref": "#/components/schemas/GroupServiceAccountRequest" - }, - "x-xgen-version": "2023-10-01" + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Search Web Platform" + }, + "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 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" : "createAtlasSearchIndex", + "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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } ], + "requestBody" : { + "description" : "Creates one Atlas Search index on the specified collection.", + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/SearchIndexCreateRequest" + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "description" : "Created", + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/SearchIndexResponse" + }, + "x-xgen-version" : "2024-05-30" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Search Web Platform" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}" : { + "get" : { + "tags" : [ "Atlas Search" ], + "summary" : "Return One Atlas Search Index by ID", + "description" : "Returns one Atlas Search index in the specified project. You identify this index using its unique ID. Atlas Search index contains the indexed fields and the analyzers used to create the index. To use this resource, the requesting API Key must have the Project Data Access Read Write role.", + "externalDocs" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "getAtlasSearchIndex", + "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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/SearchIndexResponse" + }, + "x-xgen-version" : "2024-05-30" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + }, + "503" : { + "description" : "Service Unavailable.", + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } } - }, - "required": true + } }, - "responses": { - "201": { - "description": "Created", - "content": { - "application/vnd.atlas.2023-10-01+json": { - "schema": { - "$ref": "#/components/schemas/GroupServiceAccount" + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Search Web Platform" + }, + "delete" : { + "tags" : [ "Atlas Search" ], + "summary" : "Remove One Atlas Search Index by Id", + "description" : "Removes one Atlas Search index that you identified with its unique ID. To use this resource, the requesting API key must have the Project Data Access Admin role. This deletion is eventually consistent.", + "externalDocs" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "deleteAtlasSearchIndex", + "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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "This endpoint does not return a response body.", + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2024-05-30" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Search Web Platform" + }, + "patch" : { + "tags" : [ "Atlas Search" ], + "summary" : "Update One Atlas Search Index By ID", + "description" : "Updates one Atlas Search index that you identified with its unique ID. Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. To use this resource, the requesting API Key must have the Project Data Access Admin role.", + "externalDocs" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "updateAtlasSearchIndex", + "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 you want to update.", + "required" : true, + "schema" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "requestBody" : { + "description" : "Details to update on the Atlas Search index.", + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/SearchIndexUpdateRequest" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/SearchIndexResponse" + }, + "x-xgen-version" : "2024-05-30" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Search Web Platform" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}" : { + "get" : { + "tags" : [ "Atlas Search" ], + "summary" : "Return One Atlas Search Index by Name", + "description" : "Returns one Atlas Search index in the specified project. You identify this index using its database, collection and name. Atlas Search index contains the indexed fields and the analyzers used to create the index. To use this resource, the requesting 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" : "getAtlasSearchIndexByName", + "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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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" : "Label that identifies the database that contains the collection with one or more Atlas Search indexes.", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "indexName", + "in" : "path", + "description" : "Name of the Atlas Search index to return.", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/SearchIndexResponse" + }, + "x-xgen-version" : "2024-05-30" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Search Web Platform" + }, + "delete" : { + "tags" : [ "Atlas Search" ], + "summary" : "Remove One Atlas Search Index by Name", + "description" : "Removes one Atlas Search index that you identified with its database, collection, and name. To use this resource, the requesting API key must have the Project Data Access Admin role. This deletion is eventually consistent.", + "externalDocs" : { + "description" : "Atlas Search Indexes", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "operationId" : "deleteAtlasSearchIndexByName", + "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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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" : "Label that identifies the database that contains the collection with one or more Atlas Search indexes.", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "indexName", + "in" : "path", + "description" : "Name of the Atlas Search index to delete.", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "This endpoint does not return a response body.", + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2024-05-30" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Search Web Platform" + }, + "patch" : { + "tags" : [ "Atlas Search" ], + "summary" : "Update One Atlas Search Index By Name", + "description" : "Updates one Atlas Search index that you identified with its database, collection name, and index name. Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. To use this resource, the requesting 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" : "updateAtlasSearchIndexByName", + "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 you want to update.", + "required" : true, + "schema" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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" : "Label that identifies the database that contains the collection with one or more Atlas Search indexes.", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "indexName", + "in" : "path", + "description" : "Name of the Atlas Search index to update.", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "description" : "Details to update the Atlas Search index with.", + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/SearchIndexUpdateRequest" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/SearchIndexResponse" + }, + "x-xgen-version" : "2024-05-30" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Search Web Platform" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/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 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" : "listAtlasSearchIndexes", + "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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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" : "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/vnd.atlas.2024-05-30+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/SearchIndexResponse" + } }, - "x-xgen-version": "2023-10-01" + "x-xgen-version" : "2024-05-30" } } }, - "400": { - "$ref": "#/components/responses/badRequest" + "400" : { + "$ref" : "#/components/responses/badRequest" }, - "401": { - "$ref": "#/components/responses/unauthorized" + "404" : { + "$ref" : "#/components/responses/notFound" }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] + "500" : { + "$ref" : "#/components/responses/internalServerError" + }, + "503" : { + "description" : "Service Unavailable.", + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + } } - ], - "x-xgen-hidden-env": { - "envs": "qa,stage,prod" }, - "x-xgen-owner-team": "apix" - } - }, - "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets": { - "post": { - "tags": ["Organizations"], - "summary": "Service Account Secret Creation", - "description": "Create Service Account secret.", - "operationId": "createServiceAccountSecret", - "parameters": [ - { - "$ref": "#/components/parameters/orgId" - }, - { - "name": "serviceAccountId", - "in": "path", - "description": "Id of the service account.", - "required": true, - "schema": { - "type": "string" + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Search Web Platform" + } + }, + "/api/atlas/v2/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 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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } ], + "requestBody" : { + "description" : "Rolling index to create on the specified cluster.", + "content" : { + "application/vnd.atlas.2023-01-01+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 + } + } + } + } + } + } } }, - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/pretty" - } - ], - "requestBody": { - "description": "Details to create secret in the specified service account.", - "content": { - "application/vnd.atlas.2023-10-01+json": { - "schema": { - "$ref": "#/components/schemas/ServiceAccountSecretRequest" + "required" : true + }, + "responses" : { + "202" : { + "description" : "Accepted", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Developer Tools" + } + }, + "/api/atlas/v2/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 Specified 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementsIndexes" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Intel I" + } + }, + "/api/atlas/v2/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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudSearchMetrics" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Intel I" + } + }, + "/api/atlas/v2/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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementsIndexes" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Intel I" + } + }, + "/api/atlas/v2/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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementsNonIndex" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Intel I" + } + }, + "/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}" : { + "get" : { + "tags" : [ "Access Tracking" ], + "summary" : "Return Database Access History for One Cluster using Its 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 API Key must have the Project Monitoring Admin role.", + "externalDocs" : { + "description" : "Database Access History", + "url" : "https://docs.atlas.mongodb.com/access-tracking/" + }, + "operationId" : "listAccessLogsByClusterName", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MongoDBAccessLogsList" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Intel II" + } + }, + "/api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}" : { + "get" : { + "tags" : [ "Access Tracking" ], + "summary" : "Return Database Access History for One Cluster using Its 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 API Key must have the Project Monitoring Admin role.", + "externalDocs" : { + "description" : "Database Access History", + "url" : "https://docs.atlas.mongodb.com/access-tracking/" + }, + "operationId" : "listAccessLogsByHostname", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MongoDBAccessLogsList" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Intel II" + } + }, + "/api/atlas/v2/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 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.\n\n- If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time.\n- 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).\n\n- If you don't specify the **duration** parameter, the endpoint returns data covering from the **since** value and the current time.\n- 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Namespaces" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Intel II" + } + }, + "/api/atlas/v2/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 API Key must have the Project Data Access Read Write role.", + "operationId" : "listSlowQueries", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "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.\n\n- If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time.\n- 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", + "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).\n\n- If you don't specify the **duration** parameter, the endpoint returns data covering from the **since** value and the current time.\n- 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PerformanceAdvisorSlowQueryList" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Intel II" + } + }, + "/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes" : { + "get" : { + "tags" : [ "Performance Advisor" ], + "summary" : "Return 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 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.\n\n- If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time.\n- 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", + "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).\n\n- If you don't specify the **duration** parameter, the endpoint returns data covering from the **since** value and the current time.\n- 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PerformanceAdvisorResponse" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Intel II" + } + }, + "/api/atlas/v2/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`, and serverless clusters have some [operational limits](https://www.mongodb.com/docs/atlas/reference/free-shared-limitations/#operational-limitations). The MongoDB Cloud process must be a `mongod`. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "listDatabases", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedDatabaseView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Intel I" + } + }, + "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedDiskPartitionView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Intel I" + } + }, + "/api/atlas/v2/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:\n- Throughput of I/O operations for the disk partition used for the MongoDB process\n- Percentage of time during which requests the partition issued and serviced\n- Latency per operation type of the disk partition used for the MongoDB process\n- Amount of free and used disk space on the disk partition used for the MongoDB process\n- Measurements for the host, such as CPU usage or number of I/O operations\n\nTo use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "getHostMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "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_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" ] + } + } + }, { + "$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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiMeasurementsGeneralView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Intel I" + } + }, + "/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}" : { + "get" : { + "tags" : [ "Monitoring and Logs" ], + "summary" : "Return One Database for a MongoDB Process", + "description" : "Returns one database running on the specified host for the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "getDatabase", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MesurementsDatabase" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Intel I" + } + }, + "/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements" : { + "get" : { + "tags" : [ "Monitoring and Logs" ], + "summary" : "Return Measurements of One Database for 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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiMeasurementsGeneralView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Intel I" + } + }, + "/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}" : { + "get" : { + "tags" : [ "Monitoring and Logs" ], + "summary" : "Return Measurements of 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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementDiskPartition" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Intel I" + } + }, + "/api/atlas/v2/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:\n- Throughput of I/O operations for the disk partition used for the MongoDB process\n- Percentage of time during which requests the partition issued and serviced\n- Latency per operation type of the disk partition used for the MongoDB process\n- Amount of free and used disk space on the disk partition used for the MongoDB process\n\nTo use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "getDiskMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "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" ] + } + } + }, { + "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/granularity" + }, { + "$ref" : "#/components/parameters/period" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiMeasurementsGeneralView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Intel I" + } + }, + "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedHostView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Intel I" + } + }, + "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiHostView_Atlas" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Intel I" + } + }, + "/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing" : { + "get" : { + "tags" : [ "Performance Advisor" ], + "summary" : "Return Serverless Auto Indexing Enabled", + "description" : "Get whether the Serverless Auto Indexing feature is enabled.", + "operationId" : "getServerlessAutoIndexing", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "name" : "clusterName", + "in" : "path", + "description" : "Human-readable label that identifies the cluster.", + "required" : true, + "schema" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "boolean" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Intel II" + }, + "post" : { + "tags" : [ "Performance Advisor" ], + "summary" : "Set Serverless Auto Indexing", + "description" : "Set whether the Serverless Auto Indexing feature is enabled.", + "operationId" : "setServerlessAutoIndexing", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "name" : "clusterName", + "in" : "path", + "description" : "Human-readable label that identifies the cluster.", + "required" : true, + "schema" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + }, { + "name" : "enable", + "in" : "query", + "description" : "Value that we want to set for the Serverless Auto Indexing toggle.", + "required" : true, + "schema" : { + "type" : "boolean" + } + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Intel II" + } + }, + "/api/atlas/v2/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 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.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Intel II" + } + }, + "/api/atlas/v2/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 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.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Intel II" + } + }, + "/api/atlas/v2/groups/{groupId}/managedSlowMs" : { + "get" : { + "tags" : [ "Performance Advisor" ], + "summary" : "Return Managed Slow MS enabled", + "description" : "Get whether the Managed Slow MS feature is enabled.", + "operationId" : "getManagedSlowMs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Intel II" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements" : { + "get" : { + "tags" : [ "Collection Level Metrics" ], + "summary" : "Return Cluster-Level Query Latency", + "description" : "Get a list of the Coll Stats Latency cluster-level measurements for the given namespace.", + "operationId" : "getCollStatsLatencyNamespaceClusterMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "name" : "clusterName", + "in" : "path", + "description" : "Human-readable label that identifies the cluster to retrieve metrics for.", + "required" : true, + "schema" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + }, { + "name" : "clusterView", + "in" : "path", + "description" : "Human-readable label that identifies the cluster topology to retrieve metrics for.", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "PRIMARY", "SECONDARY", "INDIVIDUAL_PROCESS" ] + } + }, { + "$ref" : "#/components/parameters/databaseName" + }, { + "$ref" : "#/components/parameters/collectionName" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "name" : "metrics", + "in" : "query", + "description" : "List that contains the metrics that you want to retrieve for the associated data series. If you don't set this parameter, this resource returns data series for all Coll Stats Latency metrics.", + "style" : "form", + "explode" : true, + "schema" : { + "uniqueItems" : true, + "type" : "array", + "items" : { + "type" : "string", + "description" : "Metric requested for the given cluster", + "enum" : [ "READS_OPS", "READS_LATENCY", "AVERAGE_READS_LATENCY", "READS_P50_VALUE", "READS_P95_VALUE", "READS_P99_VALUE", "WRITES_OPS", "WRITES_LATENCY", "AVERAGE_WRITES_LATENCY", "WRITES_P50_VALUE", "WRITES_P95_VALUE", "WRITES_P99_VALUE", "COMMANDS_OPS", "COMMANDS_LATENCY", "AVERAGE_COMMANDS_LATENCY", "COMMANDS_P50_VALUE", "COMMANDS_P95_VALUE", "COMMANDS_P99_VALUE", "TOTAL_OPS", "TOTAL_LATENCY", "AVERAGE_TOTAL_OPS_LATENCY", "TOTAL_OPS_P50_VALUE", "TOTAL_OPS_P95_VALUE", "TOTAL_OPS_P99_VALUE" ] + } + } + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + }, { + "$ref" : "#/components/parameters/period" + } ], + "responses" : { + "200" : { + "description" : "Succeeded", + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementsCollStatsLatencyCluster" + }, + "x-xgen-version" : "2023-11-15" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Intel I" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/collStats/namespaces" : { + "get" : { + "tags" : [ "Collection Level Metrics" ], + "summary" : "Return Ranked Namespaces from a Cluster", + "description" : "Return the subset of namespaces from the given cluster sorted by highest total execution time (descending) within the given time window.", + "operationId" : "getCollStatsLatencyNamespacesForCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "name" : "clusterName", + "in" : "path", + "description" : "Human-readable label that identifies the cluster to pin namespaces to.", + "required" : true, + "schema" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + }, { + "name" : "clusterView", + "in" : "path", + "description" : "Human-readable label that identifies the cluster topology to retrieve metrics for.", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "PRIMARY", "SECONDARY", "INDIVIDUAL_PROCESS" ] + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + }, { + "$ref" : "#/components/parameters/period" + } ], + "responses" : { + "200" : { + "description" : "Succeeded", + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/CollStatsRankedNamespacesView" + }, + "x-xgen-version" : "2023-11-15" + } + } + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Intel I" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned" : { + "get" : { + "tags" : [ "Collection Level Metrics" ], + "summary" : "Return Pinned Namespaces", + "description" : "Returns a list of given cluster's pinned namespaces, a set of namespaces manually selected by users to collect query latency metrics on.", + "operationId" : "getPinnedNamespaces", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "name" : "clusterName", + "in" : "path", + "description" : "Human-readable label that identifies the cluster to retrieve pinned namespaces for.", + "required" : true, + "schema" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/PinnedNamespaces" + }, + "x-xgen-version" : "2023-11-15" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Intel I" + }, + "put" : { + "tags" : [ "Collection Level Metrics" ], + "summary" : "Pin Namespaces", + "description" : "Pin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. This initializes a pinned namespaces list or replaces any existing pinned namespaces list for the Group and Cluster.", + "operationId" : "pinNamespacesPut", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "name" : "clusterName", + "in" : "path", + "description" : "Human-readable label that identifies the cluster to pin namespaces to.", + "required" : true, + "schema" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } ], + "requestBody" : { + "description" : "List of namespace strings (combination of database and collection name) to pin for query latency metric collection.", + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/NamespacesRequest" } } }, - "required": true + "required" : true }, - "responses": { - "201": { - "description": "Created", - "content": { - "application/vnd.atlas.2023-10-01+json": { - "schema": { - "$ref": "#/components/schemas/ServiceAccountSecret" + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/PinnedNamespaces" + }, + "x-xgen-version" : "2023-11-15" + } + } + }, + "201" : { + "description" : "Created", + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/PinnedNamespaces" }, - "x-xgen-version": "2023-10-01" + "x-xgen-version" : "2023-11-15" } } }, - "401": { - "$ref": "#/components/responses/unauthorized" + "400" : { + "$ref" : "#/components/responses/badRequest" }, - "400": { - "$ref": "#/components/responses/badRequest" + "403" : { + "$ref" : "#/components/responses/forbidden" }, - "500": { - "$ref": "#/components/responses/internalServerError" + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" } }, - "security": [ - { - "DigestAuth": [] + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Intel I" + }, + "patch" : { + "tags" : [ "Collection Level Metrics" ], + "summary" : "Add Pinned Namespaces", + "description" : "Add provided list of namespaces to existing pinned namespaces list for collection-level latency metrics collection for the given Group and Cluster", + "operationId" : "pinNamespacesPatch", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "name" : "clusterName", + "in" : "path", + "description" : "Human-readable label that identifies the cluster to pin namespaces to.", + "required" : true, + "schema" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" } - ], - "x-xgen-hidden-env": { - "envs": "qa,stage,prod" - }, - "x-xgen-owner-team": "apix" - } - }, - "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets/{secretId}": { - "delete": { - "tags": ["Organizations"], - "summary": "Service Account Secret Deletion.", - "description": "Delete Service Account Secret.", - "operationId": "deleteServiceAccountSecret", - "parameters": [ - { - "name": "serviceAccountId", - "in": "path", - "description": "Id of the service account.", - "required": true, - "schema": { - "type": "string" + } ], + "requestBody" : { + "description" : "List of namespace strings (combination of database and collection name) to pin for query latency metric collection.", + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/NamespacesRequest" + } } }, - { - "name": "secretId", - "in": "path", - "description": "Id of the secret.", - "required": true, - "schema": { - "type": "string" + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/PinnedNamespaces" + }, + "x-xgen-version" : "2023-11-15" + } } }, - { - "$ref": "#/components/parameters/orgId" - }, - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/pretty" - } - ], - "responses": { - "204": { - "description": "This endpoint does not return a response body.", - "content": { - "application/vnd.atlas.2023-10-01+json": { - "x-xgen-version": "2023-10-01" + "201" : { + "description" : "Created", + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/PinnedNamespaces" + }, + "x-xgen-version" : "2023-11-15" } } }, - "401": { - "$ref": "#/components/responses/unauthorized" + "400" : { + "$ref" : "#/components/responses/badRequest" }, - "404": { - "$ref": "#/components/responses/notFound" + "403" : { + "$ref" : "#/components/responses/forbidden" }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" } - ], - "x-xgen-hidden-env": { - "envs": "qa,stage,prod" }, - "x-xgen-owner-team": "apix" + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Intel I" } }, - "/api/atlas/v2/orgs/{orgId}/serviceAccounts": { - "get": { - "tags": ["Organizations"], - "summary": "Return All Service Accounts", - "description": "Returns list of Service Accounts with service account details.", - "operationId": "listServiceAccounts", - "parameters": [ - { - "$ref": "#/components/parameters/orgId" - }, - { - "$ref": "#/components/parameters/itemsPerPage" - }, - { - "$ref": "#/components/parameters/pageNum" + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/unpin" : { + "patch" : { + "tags" : [ "Collection Level Metrics" ], + "summary" : "Unpin namespaces", + "description" : "Unpin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster", + "operationId" : "unpinNamespaces", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "name" : "clusterName", + "in" : "path", + "description" : "Human-readable label that identifies the cluster to unpin namespaces from.", + "required" : true, + "schema" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } ], + "requestBody" : { + "description" : "List of namespace strings (combination of database and collection name) to pin for query latency metric collection.", + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/NamespacesRequest" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/PinnedNamespaces" + }, + "x-xgen-version" : "2023-11-15" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "$ref": "#/components/parameters/envelope" + "500" : { + "$ref" : "#/components/responses/internalServerError" } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-10-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedOrgServiceAccounts" + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Intel I" + } + }, + "/api/atlas/v2/groups/{groupId}/collStats/metrics" : { + "get" : { + "tags" : [ "Collection Level Metrics" ], + "summary" : "Return all metric names", + "description" : "Returns all available Coll Stats Latency metric names and their respective units for the specified project at the time of request.", + "operationId" : "getCollStatsLatencyNamespaceMetrics", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "200" : { + "description" : "Succeeded", + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-11-15" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Intel I" + } + }, + "/api/atlas/v2/groups/{groupId}/processes/{processId}/{databaseName}/{collectionName}/collStats/measurements" : { + "get" : { + "tags" : [ "Collection Level Metrics" ], + "summary" : "Return Host-Level Query Latency", + "description" : "Get a list of the Coll Stats Latency process-level measurements for the given namespace", + "operationId" : "getCollStatsLatencyNamespaceHostMeasurements", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/processId" + }, { + "$ref" : "#/components/parameters/databaseName" + }, { + "$ref" : "#/components/parameters/collectionName" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "name" : "metrics", + "in" : "query", + "description" : "List that contains the metrics that you want to retrieve for the associated data series. If you don't set this parameter, this resource returns data series for all Coll Stats Latency metrics.", + "schema" : { + "uniqueItems" : true, + "type" : "array", + "items" : { + "type" : "string", + "description" : "Metric requested for the given process", + "enum" : [ "READS_OPS", "READS_LATENCY", "AVERAGE_READS_LATENCY", "READS_P50_VALUE", "READS_P95_VALUE", "READS_P99_VALUE", "WRITES_OPS", "WRITES_LATENCY", "AVERAGE_WRITES_LATENCY", "WRITES_P50_VALUE", "WRITES_P95_VALUE", "WRITES_P99_VALUE", "COMMANDS_OPS", "COMMANDS_LATENCY", "AVERAGE_COMMANDS_LATENCY", "COMMANDS_P50_VALUE", "COMMANDS_P95_VALUE", "COMMANDS_P99_VALUE", "TOTAL_OPS", "TOTAL_LATENCY", "AVERAGE_TOTAL_OPS_LATENCY", "TOTAL_OPS_P50_VALUE", "TOTAL_OPS_P95_VALUE", "TOTAL_OPS_P99_VALUE" ] + } + } + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + }, { + "$ref" : "#/components/parameters/period" + } ], + "responses" : { + "200" : { + "description" : "Succeeded", + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/MeasurementsCollStatsLatencyHost" + }, + "x-xgen-version" : "2023-11-15" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Intel I" + } + }, + "/api/atlas/v2/groups/{groupId}/processes/{processId}/collStats/namespaces" : { + "get" : { + "tags" : [ "Collection Level Metrics" ], + "summary" : "Return Ranked Namespaces from a Host", + "description" : "Return the subset of namespaces from the given process ranked by highest total execution time (descending) within the given time window.", + "operationId" : "getCollStatsLatencyNamespacesForHost", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/processId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/start" + }, { + "$ref" : "#/components/parameters/end" + }, { + "$ref" : "#/components/parameters/period" + } ], + "responses" : { + "200" : { + "description" : "Succeeded", + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/CollStatsRankedNamespacesView" + }, + "x-xgen-version" : "2023-11-15" + } + } + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Intel I" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/suggestedIndexes" : { + "get" : { + "tags" : [ "Performance Advisor" ], + "summary" : "Return 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 API Key must have the Project Read Only role.", + "operationId" : "listSuggestedIndexes_1", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "name" : "clusterName", + "in" : "path", + "description" : "Human-readable label that identifies the cluster.", + "required" : true, + "schema" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + }, { + "name" : "processIds", + "in" : "query", + "description" : "ProcessIds from which to retrieve suggested indexes. A processId is a combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests. To include multiple processIds, pass the parameter multiple times delimited with an ampersand (`&`) between each processId.", + "style" : "form", + "schema" : { + "type" : "array", + "items" : { + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$", + "type" : "string" + } + } + }, { + "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", + "items" : { + "type" : "string" + } + } + }, { + "name" : "hostType", + "in" : "query", + "description" : "HostType determines the source of index advice from logs. If **hostType**=All, index advice from logs will come from all processes within a cluster and **processIds** will be ignored. If hostType=Null, index advice from logs will come from the subset of processes within this cluster specified using *processIds**.", + "schema" : { + "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).\n\n- If you don't specify the **until** parameter, the endpoint returns data covering from the **since** value and the current time.\n- If you specify neither the **since** nor the **until** parameters, the endpoint returns data from the previous 24 hours.", + "schema" : { + "minimum" : 1199145600000, + "type" : "integer", + "format" : "int64" + } + }, { + "name" : "until", + "in" : "query", + "description" : "Date and time up until which the query retrieves the suggested indexes. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).\n\n- If you specify the **until** parameter, you must specify the **since** parameter.\n- If you specify neither the **since** nor the **until** parameters, the endpoint returns data from the previous 24 hours.", + "schema" : { + "minimum" : 1199145600000, + "type" : "integer", + "format" : "int64" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PerformanceAdvisorResponse" + }, + "x-xgen-version" : "2025-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-hidden-env" : { + "envs" : "prod" + }, + "x-xgen-owner-team" : "Intel II" + } + }, + "/api/atlas/v2/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 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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedOnlineArchiveView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Online Archive II" + }, + "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 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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } ], + "requestBody" : { + "description" : "Creates one online archive.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchiveCreate" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-changelog" : { + "2023-08-02" : "If 'criteria':'DATE' is specified, then you must specify 'DATE' values in partition fields" + }, + "x-xgen-owner-team" : "Atlas Online Archive II" + } + }, + "/api/atlas/v2/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 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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Online Archive II" + }, + "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 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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "This endpoint does not return a response body.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Online Archive II" + }, + "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 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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } ], + "requestBody" : { + "description" : "Updates, pauses, or resumes one online archive.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BackupOnlineArchive" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Online Archive II" + } + }, + "/api/atlas/v2/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 API Key must have the Project Data Access Read Only or higher role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: \"Accept: application/vnd.atlas.YYYY-MM-DD+gzip\".", + "externalDocs" : { + "description" : "Online Archive", + "url" : "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" + }, + "operationId" : "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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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/vnd.atlas.2023-01-01+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" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Online Archive II" + } + }, + "/api/atlas/v2/unauth/controlPlaneIPAddresses" : { + "get" : { + "tags" : [ "Root" ], + "summary" : "Return All Control Plane IP Addresses", + "description" : "Returns all control plane IP addresses. Currently, inbound Atlas control plane IP addresses are not yet available. The inbound IP address list in your API response is empty. To manually retrieve a list of inbound Atlas control plane IP addresses, see [Required Inbound Access](https://www.mongodb.com/docs/atlas/setup-cluster-security/#std-label-atlas-required-inbound-access).", + "operationId" : "returnAllControlPlaneIPAddresses", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/ControlPlaneIPAddresses" + }, + "x-xgen-version" : "2023-11-15" + } + } + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "x-xgen-owner-team" : "Atlas Dedicated IV" + } + }, + "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AWSCustomDNSEnabledView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + }, + "patch" : { + "tags" : [ "AWS Clusters DNS" ], + "summary" : "Toggle 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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AWSCustomDNSEnabledView" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AWSCustomDNSEnabledView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + } + }, + "/api/atlas/v2/groups/{groupId}/mongoDBVersions" : { + "get" : { + "tags" : [ "Projects" ], + "summary" : "Return Available MongoDB LTS Versions for clusters in One Project", + "description" : "Returns the MongoDB Long Term Support Major Versions available to new clusters in this project.", + "operationId" : "getProjectLTSVersions", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "name" : "cloudProvider", + "in" : "query", + "description" : "Filter results to only one cloud provider.", + "schema" : { + "type" : "string", + "enum" : [ "AWS", "AZURE", "GCP", "TENANT" ] + } + }, { + "name" : "instanceSize", + "in" : "query", + "description" : "Filter results to only one instance size.", + "schema" : { + "type" : "string", + "example" : "M10" + } + }, { + "name" : "defaultStatus", + "in" : "query", + "description" : "Filter results to only the default values per tier. This value must be DEFAULT.", + "schema" : { + "type" : "string", + "enum" : [ "DEFAULT" ] + } + }, { + "name" : "itemsPerPage", + "in" : "query", + "description" : "Number of items that the response returns per page.", + "schema" : { + "minimum" : 1, + "type" : "integer", + "format" : "int64", + "example" : 100, + "default" : 100 + } + }, { + "$ref" : "#/components/parameters/pageNum" + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAvailableVersionView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + } + }, + "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudProviderContainerView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + }, + "post" : { + "tags" : [ "Network Peering" ], + "summary" : "Create One New 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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + } + }, + "/api/atlas/v2/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 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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + }, + "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 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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8" + } + } ], + "responses" : { + "204" : { + "description" : "This endpoint does not return a response body.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + }, + "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 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" : { + "maxLength" : 24, + "minLength" : 24, + "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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + } + }, + "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudProviderContainerView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + } + }, + "/api/atlas/v2/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 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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterStatus" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + } + }, + "/api/atlas/v2/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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterOutageSimulation" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + }, + "post" : { + "tags" : [ "Cluster Outage Simulation" ], + "summary" : "Start an 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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } ], + "requestBody" : { + "description" : "Describes the outage simulation.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterOutageSimulation" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterOutageSimulation" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + }, + "delete" : { + "tags" : [ "Cluster Outage Simulation" ], + "summary" : "End an 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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterOutageSimulation" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + } + }, + "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + } }, - "x-xgen-version": "2023-10-01" + "x-xgen-version" : "2023-01-01" } } }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "403": { - "$ref": "#/components/responses/forbidden" + "401" : { + "$ref" : "#/components/responses/unauthorized" }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] + "500" : { + "$ref" : "#/components/responses/internalServerError" } - ], - "x-xgen-hidden-env": { - "envs": "qa,stage,prod" }, - "x-xgen-owner-team": "apix" + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" }, - "post": { - "tags": ["Organizations"], - "summary": "Service Account Creation", - "description": "Create Service Account containing client id and client secrets.", - "operationId": "createServiceAccount", - "parameters": [ - { - "$ref": "#/components/parameters/orgId" - }, - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/pretty" - } - ], - "requestBody": { - "description": "Details to create service account in the specified organization.", - "content": { - "application/vnd.atlas.2023-10-01+json": { - "schema": { - "$ref": "#/components/schemas/OrgServiceAccountRequest" + "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 API Key must have the Project Owner 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCustomDBRole" } } }, - "required": true + "required" : true }, - "responses": { - "201": { - "description": "Created", - "content": { - "application/vnd.atlas.2023-10-01+json": { - "schema": { - "$ref": "#/components/schemas/OrgServiceAccount" - }, - "x-xgen-version": "2023-10-01" - } - } + "responses" : { + "202" : { + "description" : "Accepted", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" }, - "400": { - "$ref": "#/components/responses/badRequest" + "401" : { + "$ref" : "#/components/responses/unauthorized" }, - "401": { - "$ref": "#/components/responses/unauthorized" + "403" : { + "$ref" : "#/components/responses/forbidden" }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" } - ], - "x-xgen-hidden-env": { - "envs": "qa,stage,prod" }, - "x-xgen-owner-team": "apix" + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" } }, - "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}": { - "get": { - "tags": ["Organizations"], - "summary": "Service Account Fetching", - "description": "Get Service Account Details.", - "operationId": "getServiceAccount", - "parameters": [ - { - "$ref": "#/components/parameters/orgId" - }, - { - "name": "serviceAccountId", - "in": "path", - "description": "Id of the service account.", - "required": true, - "schema": { - "type": "string" + "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + }, + "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 API Key must have the Project Atlas 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", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + }, + "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 API Key must have the Project Owner 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateCustomDBRole" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserCustomDBRole" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + } + }, + "/api/atlas/v2/groups/{groupId}/databaseUsers" : { + "get" : { + "tags" : [ "Database Users" ], + "summary" : "Return All Database Users from One Project", + "description" : "Returns all database users that belong to the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "listDatabaseUsers", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasDatabaseUserView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + }, + "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](https://cloud.mongodb.com/support). To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles.", + "operationId" : "createDatabaseUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "description" : "Creates one database user in the specified project.", + "content" : { + "application/vnd.atlas.2023-01-01+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" + } + } + } } }, - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/pretty" + "required" : true + }, + "responses" : { + "201" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + } + }, + "/api/atlas/v2/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 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:\n\n| Authentication Method | Parameter Needed | Parameter Value | username Format |\n|---|---|---|---|\n| AWS IAM | awsIAMType | ROLE | ARN |\n| AWS IAM | awsIAMType | USER | ARN |\n| x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |\n| OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name |\n| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |\n", + "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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + }, + "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 API Key must have the Project Owner 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:\n\n| Authentication Method | Parameter Needed | Parameter Value | username Format |\n|---|---|---|---|\n| AWS IAM | awsIAMType | ROLE | ARN |\n| AWS IAM | awsIAMType | USER | ARN |\n| x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |\n| OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name |\n| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |\n", + "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.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + }, + "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 API Key must have the Project Owner or Project Charts Admin roles.", + "operationId" : "updateDatabaseUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "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:\n\n| Authentication Method | Parameter Needed | Parameter Value | username Format |\n|---|---|---|---|\n| AWS IAM | awsIAMType | ROLE | ARN |\n| AWS IAM | awsIAMType | USER | ARN |\n| x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |\n| OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name |\n| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |\n", + "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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudDatabaseUser" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + } + }, + "/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs" : { + "get" : { + "tags" : [ "X.509 Authentication" ], + "summary" : "Return All X.509 Certificates Assigned to One MongoDB 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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedUserCertView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-10-01+json": { - "schema": { - "$ref": "#/components/schemas/OrgServiceAccount" + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + }, + "post" : { + "tags" : [ "X.509 Authentication" ], + "summary" : "Create One X.509 Certificate for One MongoDB 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 API Key must have the Project Owner role.\n\nTo get MongoDB Cloud to generate a managed certificate for a database user, set `\"x509Type\" : \"MANAGED\"` on the desired MongoDB Database User.\n\nIf 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/vnd.atlas.2023-01-01+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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "string", + "description" : "PEM file that contains the user's X.509 certificate and private key." + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + } + }, + "/api/atlas/v2/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 API Key must have the Project Owner role.", + "operationId" : "deferMaintenanceWindow", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + } + }, + "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupMaintenanceWindow" }, - "x-xgen-version": "2023-10-01" + "x-xgen-version" : "2023-01-01" } } }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" + "404" : { + "$ref" : "#/components/responses/notFound" }, - "500": { - "$ref": "#/components/responses/internalServerError" + "500" : { + "$ref" : "#/components/responses/internalServerError" } }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-hidden-env": { - "envs": "qa,stage,prod" - }, - "x-xgen-owner-team": "apix" + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" }, - "delete": { - "tags": ["Organizations"], - "summary": "Service Account Deletion.", - "description": "Delete Service Account.", - "operationId": "deleteServiceAccount", - "parameters": [ - { - "name": "serviceAccountId", - "in": "path", - "description": "Id of the service account.", - "required": true, - "schema": { - "type": "string" + "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 API Key must have the Project Owner role. Urgent maintenance activities such as security patches can't wait for your chosen window. MongoDB Cloud starts those maintenance activities when needed. After you schedule maintenance for your cluster, you can't change your maintenance window until the current maintenance efforts complete. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or unexpected system issues could delay the start time. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "resetMaintenanceWindow", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "204" : { + "description" : "This endpoint does not return a response body.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } } }, - { - "$ref": "#/components/parameters/orgId" + "400" : { + "$ref" : "#/components/responses/badRequest" }, - { - "$ref": "#/components/parameters/envelope" + "404" : { + "$ref" : "#/components/responses/notFound" }, - { - "$ref": "#/components/parameters/pretty" - } - ], - "responses": { - "204": { - "description": "This endpoint does not return a response body.", - "content": { - "application/vnd.atlas.2023-10-01+json": { - "x-xgen-version": "2023-10-01" + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + }, + "patch" : { + "tags" : [ "Maintenance Windows" ], + "summary" : "Update 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. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "updateMaintenanceWindow", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "description" : "Updates the maintenance window for the specified project.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GroupMaintenanceWindow" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" } } }, - "401": { - "$ref": "#/components/responses/unauthorized" + "400" : { + "$ref" : "#/components/responses/badRequest" }, - "404": { - "$ref": "#/components/responses/notFound" + "404" : { + "$ref" : "#/components/responses/notFound" }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] + "500" : { + "$ref" : "#/components/responses/internalServerError" } - ], - "x-xgen-hidden-env": { - "envs": "qa,stage,prod" }, - "x-xgen-owner-team": "apix" - }, - "patch": { - "tags": ["Organizations"], - "summary": "Service Account Update", - "description": "Update Service Account.", - "operationId": "updateServiceAccount", - "parameters": [ - { - "name": "serviceAccountId", - "in": "path", - "description": "Id of the service account.", - "required": true, - "schema": { - "type": "string" + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + } + }, + "/api/atlas/v2/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 API Key must have the Project Owner role.", + "operationId" : "toggleMaintenanceAutoDefer", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } } }, - { - "$ref": "#/components/parameters/orgId" + "400" : { + "$ref" : "#/components/responses/badRequest" }, - { - "$ref": "#/components/parameters/envelope" + "404" : { + "$ref" : "#/components/responses/notFound" }, - { - "$ref": "#/components/parameters/pretty" + "500" : { + "$ref" : "#/components/responses/internalServerError" } - ], - "requestBody": { - "description": "Details to update service account in the specified organization.", - "content": { - "application/vnd.atlas.2023-10-01+json": { - "schema": { - "$ref": "#/components/schemas/OrgServiceAccountUpdateRequest" + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade" : { + "post" : { + "tags" : [ "Clusters" ], + "summary" : "Upgrade One Shared-tier Cluster", + "description" : "Upgrades a shared-tier cluster in the specified project. To use this resource, the requesting API key must have the Project Cluster Manager role. Each project supports up to 25 clusters.", + "operationId" : "upgradeSharedCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "description" : "Details of the shared-tier cluster upgrade in the specified project.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LegacyAtlasTenantClusterUpgradeRequest" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-10-01+json": { - "schema": { - "$ref": "#/components/schemas/OrgServiceAccount" + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LegacyAtlasCluster" }, - "x-xgen-version": "2023-10-01" + "x-xgen-version" : "2023-01-01" } } }, - "400": { - "$ref": "#/components/responses/badRequest" + "400" : { + "$ref" : "#/components/responses/badRequest" }, - "401": { - "$ref": "#/components/responses/unauthorized" + "401" : { + "$ref" : "#/components/responses/unauthorized" }, - "404": { - "$ref": "#/components/responses/notFound" + "402" : { + "$ref" : "#/components/responses/paymentRequired" }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" } - ], - "x-xgen-hidden-env": { - "envs": "qa,stage,prod" }, - "x-xgen-owner-team": "apix" + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas" } }, - "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/groups": { - "get": { - "tags": ["Organizations"], - "summary": "Return All Service Account projects", - "description": "Returns list of Service Account projects.", - "operationId": "listServiceAccountProjects", - "parameters": [ - { - "$ref": "#/components/parameters/orgId" - }, - { - "name": "serviceAccountId", - "in": "path", - "description": "Id of the service account.", - "required": true, - "schema": { - "type": "string" + "/api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless" : { + "post" : { + "tags" : [ "Clusters" ], + "summary" : "Upgrades One Shared-Tier Cluster to the Serverless Instance", + "description" : "Upgrades a shared-tier cluster to a serverless instance in the specified project. To use this resource, the requesting API key must have the Project Cluster Manager role.", + "operationId" : "upgradeSharedClusterToServerless", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "description" : "Details of the shared-tier cluster upgrade in the specified project.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + } } }, - { - "$ref": "#/components/parameters/itemsPerPage" - }, - { - "$ref": "#/components/parameters/pageNum" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "$ref": "#/components/parameters/envelope" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-10-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedServiceAccountGroup" - }, - "x-xgen-version": "2023-10-01" + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas" + } + }, + "/api/atlas/v2/groups/{groupId}/accessList" : { + "get" : { + "tags" : [ "Project IP Access List" ], + "summary" : "Return Project IP Access List", + "description" : "Returns all access list entries from the specified project's IP access list. Each entry in the project's IP access list contains either one IP address or one CIDR-notated block of IP addresses. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. To use this resource, the requesting API Key must have the Project Read Only or Project Charts Admin roles. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. The `/groups/{GROUP-ID}/accessList` endpoint manages the database IP access list. This endpoint is distinct from the `orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist` endpoint, which manages the access list for MongoDB Cloud organizations.", + "externalDocs" : { + "description" : "IP access list", + "url" : "https://docs.atlas.mongodb.com/security/ip-access-list/#std-label-access-list" + }, + "operationId" : "listProjectIpAccessLists", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedNetworkAccessView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas" + }, + "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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/NetworkPermissionEntry" + } } } }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } + "required" : true }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-hidden-env": { - "envs": "qa,stage,prod" + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedNetworkAccessView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } }, - "x-xgen-owner-team": "apix" + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas" } }, - "/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage": { - "post": { - "tags": ["Invoices"], - "summary": "Create Cost Explorer query process", - "description": "Creates a query process within the Cost Explorer for the given parameters. A token is returned that can be used to poll the status of the query and eventually retrieve the results.", - "operationId": "createCostExplorerQueryProcess", - "parameters": [ - { - "$ref": "#/components/parameters/orgId" - }, - { - "$ref": "#/components/parameters/envelope" + "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NetworkPermissionEntry" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas" + }, + "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 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:\n\n- how your application established the connection,\n- how MongoDB Cloud or the driver using the address behaves, and\n- 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.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas" + } + }, + "/api/atlas/v2/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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NetworkPermissionEntryStatus" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "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" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas" + } + }, + "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedContainerPeerView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + }, + "post" : { + "tags" : [ "Network Peering" ], + "summary" : "Create One New 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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + } + }, + "/api/atlas/v2/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 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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + }, + "delete" : { + "tags" : [ "Network Peering" ], + "summary" : "Remove One Existing 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 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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "responses" : { + "202" : { + "description" : "Accepted", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/RequestAccepted" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + }, + "patch" : { + "tags" : [ "Network Peering" ], + "summary" : "Update One New Network Peering Connection", + "description" : "Updates one specified network peering connection in the specified project. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "updatePeeringConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "name" : "peerId", + "in" : "path", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection that you want to update.", + "required" : true, + "schema" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" } - ], - "requestBody": { - "description": "Filter parameters for the Cost Explorer query.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/CostExplorerFilterRequestBody" + } ], + "requestBody" : { + "description" : "Modify one network peering connection.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + } + }, + "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderEndpointServiceRequest" } } }, - "required": true - }, - "responses": { - "202": { - "description": "Accepted", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/CostExplorerFilterResponseView" + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EndpointService" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + } + }, + "/api/atlas/v2/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 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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "requestBody" : { + "description" : "Creates one private endpoint for the specified cloud service provider.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateEndpointRequest" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateLinkEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + } + }, + "/api/atlas/v2/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 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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateLinkEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + }, + "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 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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "This endpoint does not return a response body.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + } + }, + "/api/atlas/v2/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 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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/EndpointService" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + }, + "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 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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "This endpoint does not return a response body.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + } + }, + "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/EndpointService" + } }, - "x-xgen-version": "2023-01-01" + "x-xgen-version" : "2023-01-01" } } }, - "401": { - "$ref": "#/components/responses/unauthorized" + "400" : { + "$ref" : "#/components/responses/badRequest" }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "500": { - "$ref": "#/components/responses/internalServerError" + "500" : { + "$ref" : "#/components/responses/internalServerError" } }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Billing Platform" + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" } }, - "/api/atlas/v2/orgs/{orgId}/billing/costExplorer/usage/{token}": { - "get": { - "tags": ["Invoices"], - "summary": "Return results from a given Cost Explorer query, or notify that the results are not ready yet.", - "description": "Returns the usage details for a Cost Explorer query, if the query is finished and the data is ready to be viewed. If the data is not ready, a 'processing' response willindicate that another request should be sent later to view the data.", - "operationId": "createCostExplorerQueryProcess_1", - "parameters": [ - { - "$ref": "#/components/parameters/orgId" - }, - { - "$ref": "#/components/parameters/envelope" - }, - { - "name": "token", - "in": "path", - "description": "Unique 64 digit string that identifies the Cost Explorer query.", - "required": true, - "schema": { - "maxLength": 64, - "minLength": 64, - "type": "string", - "example": "4ABBE973862346D40F3AE859D4BE96E0F895764EB14EAB039E7B82F9D638C05C" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/CostExplorerQueryResult" - }, - "x-xgen-version": "2023-01-01" - }, - "application/vnd.atlas.2023-01-01+csv": { - "schema": { - "type": "string" + "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProjectSettingItemView" }, - "x-xgen-version": "2023-01-01" + "x-xgen-version" : "2023-01-01" } } }, - "102": { - "description": "Processing" + "403" : { + "$ref" : "#/components/responses/forbidden" }, - "401": { - "$ref": "#/components/responses/unauthorized" + "404" : { + "$ref" : "#/components/responses/notFound" }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" + "500" : { + "$ref" : "#/components/responses/internalServerError" } }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Billing Platform" - } - }, - "/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/lineItems/:search": { - "get": { - "tags": ["Invoices"], - "summary": "Query lineItems of the specified invoiceId", - "description": "Query the lineItems of the specified invoice and return the result JSON. A unique 24-hexadecimal digit string identifies the invoice.", - "operationId": "queryLineItemsFromSingleInvoice", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/itemsPerPage" - }, - { - "$ref": "#/components/parameters/pageNum" - }, - { - "$ref": "#/components/parameters/orgId" - }, - { - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "requestBody": { - "description": "Filter parameters for the lineItems query. Send a request with an empty JSON body to retrieve all line items for a given invoiceID without applying any filters.", - "content": { - "application/vnd.atlas.2025-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ApiPublicUsageDetailsQueryRequest" + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + }, + "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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProjectSettingItemView" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2025-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedPublicApiUsageDetailsLineItemView" + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ProjectSettingItemView" }, - "x-xgen-version": "2025-01-01" + "x-xgen-version" : "2023-01-01" } } }, - "401": { - "$ref": "#/components/responses/unauthorized" + "404" : { + "$ref" : "#/components/responses/notFound" }, - "400": { - "$ref": "#/components/responses/badRequest" + "409" : { + "$ref" : "#/components/responses/conflict" }, - "500": { - "$ref": "#/components/responses/internalServerError" + "500" : { + "$ref" : "#/components/responses/internalServerError" } }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-hidden-env": { - "envs": "qa,stage,prod", - "x-xgen-owner-team": "Billing Platform" - } + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" } }, - "/api/atlas/v2/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 API Key can have any cluster-level role.", - "operationId": "listClustersForAllProjects", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" + "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateIPModeView" + }, + "x-xgen-version" : "2023-01-01" + } + } }, - { - "$ref": "#/components/parameters/includeCount" + "404" : { + "$ref" : "#/components/responses/notFound" }, - { - "$ref": "#/components/parameters/itemsPerPage" + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "deprecated" : true, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + }, + "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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateIPModeView" + } + } }, - { - "$ref": "#/components/parameters/pageNum" + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateIPModeView" + }, + "x-xgen-version" : "2023-01-01" + } + } }, - { - "$ref": "#/components/parameters/pretty" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedOrgGroupView" - }, - "x-xgen-version": "2023-01-01" + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "deprecated" : true, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + } + }, + "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedPrivateNetworkEndpointIdEntryView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Online Archive II" + }, + "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.\n\n `us-east-1` is `com.amazonaws.vpce.us-east-1.vpce-svc-00e311695874992b4`.\n\n `us-west-1` is `com.amazonaws.vpce.us-west-2.vpce-svc-09d86b19e59d1b4bb`.\n\n `eu-west-1` is `com.amazonaws.vpce.eu-west-1.vpce-svc-0824460b72e1a420e`.\n\n `eu-west-2` is `com.amazonaws.vpce.eu-west-2.vpce-svc-052f1840aa0c4f1f9`.\n\n `eu-central-1` is `com.amazonaws.vpce.eu-central-1.vpce-svc-0ac8ce91871138c0d`.\n\n `sa-east-1` is `com.amazonaws.vpce.sa-east-1.vpce-svc-0b56e75e8cdf50044`.\n\n `ap-southeast-2` is `com.amazonaws.vpce.ap-southeast-2.vpce-svc-036f1de74d761706e`.\n\n `ap-south-1` is `com.amazonaws.vpce.ap-south-1.vpce-svc-03eb8a541f96d356d`.\n\n To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles.", + "operationId" : "createDataFederationPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "description" : "Private endpoint for Federated Database Instances and Online Archives to add to the specified project.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateNetworkEndpointIdEntry" + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedPrivateNetworkEndpointIdEntryView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Online Archive II" + } + }, + "/api/atlas/v2/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 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" : { + "maxLength" : 22, + "minLength" : 22, + "pattern" : "^vpce-[0-9a-f]{17}$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PrivateNetworkEndpointIdEntry" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Online Archive II" + }, + "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 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" : { + "maxLength" : 22, + "minLength" : 22, + "pattern" : "^vpce-[0-9a-f]{17}$", + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "This endpoint does not return a response body.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Online Archive II" + } + }, + "/api/atlas/v2/groups/{groupId}/pushBasedLogExport" : { + "get" : { + "tags" : [ "Push-Based Log Export" ], + "summary" : "Get the push-based log export configuration for a project", + "description" : "Fetches the current project level settings for the push-based log export feature.", + "operationId" : "getPushBasedLogConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PushBasedLogExportProject" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + }, + "post" : { + "tags" : [ "Push-Based Log Export" ], + "summary" : "Enable the push-based log export feature for a project", + "description" : "Configures the project level settings for the push-based log export feature.", + "operationId" : "createPushBasedLogConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "description" : "The project configuration details. The S3 bucket name, IAM role ID, and prefix path fields are required.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreatePushBasedLogExportProjectRequest" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" } } }, - "401": { - "$ref": "#/components/responses/unauthorized" + "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" + "500" : { + "$ref" : "#/components/responses/internalServerError" } }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Intel I" - } - }, - "/api/atlas/v2/example/info": { - "get": { - "tags": ["Test"], - "summary": "Example resource info for versioning of the Atlas API", - "description": "Returns some text dummy data for test purposes.", - "operationId": "versionedExample", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "name": "additionalInfo", - "in": "query", - "description": "Show more info.", - "schema": { - "type": "string" + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + }, + "delete" : { + "tags" : [ "Push-Based Log Export" ], + "summary" : "Disable the push-based log export feature for a project", + "description" : "Disables the push-based log export feature by resetting the project level settings to its default configuration.", + "operationId" : "deletePushBasedLogConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-02-01+json": { - "schema": { - "$ref": "#/components/schemas/ExampleResourceResponse20230201" - }, - "x-xgen-version": "2023-02-01" - }, - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ExampleResourceResponse20230101" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + }, + "patch" : { + "tags" : [ "Push-Based Log Export" ], + "summary" : "Update the push-based log export feature for a project", + "description" : "Updates the project level settings for the push-based log export feature.", + "operationId" : "updatePushBasedLogConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "description" : "The project configuration details. The S3 bucket name, IAM role ID, and prefix path fields are the only fields that may be specified. Fields left unspecified will not be modified.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PushBasedLogExportProject" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + } + }, + "/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}" : { + "get" : { + "tags" : [ "LDAP Configuration" ], + "summary" : "Return the Status of One Verify LDAP Configuration Request", + "description" : "Returns the status of one request to verify one LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "getLDAPConfigurationStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "name" : "requestId", + "in" : "path", + "description" : "Unique string that identifies the request to verify an LDAP configuration.", + "required" : true, + "schema" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequest" }, - "x-xgen-version": "2023-01-01", - "x-sunset": "2025-06-01" + "x-xgen-version" : "2023-01-01" } } }, - "401": { - "$ref": "#/components/responses/unauthorized" + "404" : { + "$ref" : "#/components/responses/notFound" }, - "500": { - "$ref": "#/components/responses/internalServerError" - } + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + } + }, + "/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify" : { + "post" : { + "tags" : [ "LDAP Configuration" ], + "summary" : "Verify the LDAP Configuration in One Project", + "description" : "Verifies the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "verifyLDAPConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "description" : "The LDAP configuration for the specified project that you want to verify.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequestParams" + } + } + }, + "required" : true }, - "security": [ - { - "DigestAuth": [] + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequest" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + } + }, + "/api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping" : { + "delete" : { + "tags" : [ "LDAP Configuration" ], + "summary" : "Remove the Current 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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" } - ], - "x-xgen-hidden-env": { - "envs": "dev,qa,stage,prod" }, - "x-xgen-owner-team": "apix" - } - }, - "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedRoleMappingView" + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + } + }, + "/api/atlas/v2/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.\n\n 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" }, - "x-xgen-version": "2023-01-01" + "x-xgen-version" : "2023-01-01" } } }, - "400": { - "$ref": "#/components/responses/badRequest" + "404" : { + "$ref" : "#/components/responses/notFound" }, - "401": { - "$ref": "#/components/responses/unauthorized" + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + } + }, + "/api/atlas/v2/groups/{groupId}/userSecurity" : { + "get" : { + "tags" : [ "LDAP Configuration" ], + "summary" : "Return the Current LDAP or X.509 Configuration", + "description" : "Returns the current LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "getLDAPConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + }, + "patch" : { + "tags" : [ "LDAP Configuration" ], + "summary" : "Edit the LDAP or X.509 Configuration", + "description" : "Edits the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role.\n\nUpdating 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + } + } + }, + "required" : true + }, + "responses" : { + "202" : { + "description" : "Accepted", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}" : { + "get" : { + "tags" : [ "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 clusters with asymmetrically-sized shards. To use this resource, the requesting API Key must have the Project Read Only role. This feature is not available for serverless clusters.", + "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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LegacyAtlasCluster" + }, + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2025-06-01" + }, + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AdvancedClusterDescription" + }, + "x-xgen-version" : "2023-02-01", + "x-sunset" : "2026-03-01" + }, + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterDescription20240805" + }, + "x-xgen-version" : "2024-08-05" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + }, + "delete" : { + "tags" : [ "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 API Key must have the Project Owner role. This feature is not available for serverless clusters.", + "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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2025-06-01" + }, + "application/vnd.atlas.2023-02-01+json" : { + "x-xgen-version" : "2023-02-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" }, - "404": { - "$ref": "#/components/responses/notFound" + "409" : { + "$ref" : "#/components/responses/conflict" }, - "500": { - "$ref": "#/components/responses/internalServerError" + "500" : { + "$ref" : "#/components/responses/internalServerError" } }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" }, - "post": { - "tags": ["Federated Authentication"], - "summary": "Add One Role Mapping to One Organization", - "description": "Adds one role mapping to the specified organization in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role.", - "operationId": "createRoleMapping", - "parameters": [ - { - "$ref": "#/components/parameters/federationSettingsId" + "patch" : { + "tags" : [ "Clusters" ], + "summary" : "Modify One Cluster from 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 clusters with asymmetrically-sized shards. To update a cluster's termination protection, the requesting API Key must have the Project Owner role. For all other updates, the requesting API Key must have the Project Cluster Manager role. You can't modify a paused cluster (`paused : true`). You must call this endpoint to set `paused : false`. After this endpoint responds with `paused : false`, you can call it again with the changes you want to make to the cluster. This feature is not available for serverless clusters.", + "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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } ], + "requestBody" : { + "description" : "Cluster to update in the specified project.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LegacyAtlasCluster" + } + }, + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AdvancedClusterDescription" + } + }, + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterDescription20240805" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LegacyAtlasCluster" + }, + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2025-06-01" + }, + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AdvancedClusterDescription" + }, + "x-xgen-version" : "2023-02-01", + "x-sunset" : "2026-03-01" + }, + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterDescription20240805" + }, + "x-xgen-version" : "2024-08-05" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + } + }, + "/api/atlas/v2/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 and contain log data from the previous five minutes. If you poll the API for log files, we recommend polling every five minutes. For example, if the logs are updated at 4:00 UTC and then you poll the API, the API returns log data from the interval between 3:55 UTC and 4:00 UTC. This feature isn't available for `M0` free clusters, `M2`, `M5`, or serverless clusters. To use this resource, the requesting API Key must have the Project Data Access Read Only or higher role. 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/vnd.atlas.2023-02-01+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" + }, + "x-xgen-version" : "2023-02-01" + }, + "application/vnd.atlas.2023-01-01+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" + }, + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2025-06-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + } + }, + "/api/atlas/v2/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 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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2025-06-01" + }, + "application/vnd.atlas.2023-02-01+json" : { + "x-xgen-version" : "2023-02-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:pinFeatureCompatibilityVersion" : { + "post" : { + "tags" : [ "Clusters" ], + "summary" : "Pin FCV for One Cluster from One Project", + "description" : "Pins the FCV to the current MongoDB version.", + "operationId" : "pinFeatureCompatibilityVersion", + "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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } ], + "requestBody" : { + "description" : "Optional request params for tuning FCV pinning configuration.", + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/PinFCVView" + }, + "x-xgen-version" : "2024-05-30" + } + } + }, + "responses" : { + "204" : { + "description" : "This endpoint does not return a response body.", + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2024-05-30" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:unpinFeatureCompatibilityVersion" : { + "post" : { + "tags" : [ "Clusters" ], + "summary" : "Unpins FCV for One Cluster from One Project", + "description" : "Unpins the current fixed Feature Compatibility Version. This feature is not available for clusters on rapid release.", + "operationId" : "unpinFeatureCompatibilityVersion", + "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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "This endpoint does not return a response body.", + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2024-05-30" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" }, - { - "$ref": "#/components/parameters/envelope" + "402" : { + "$ref" : "#/components/responses/paymentRequired" }, - { - "$ref": "#/components/parameters/orgId" - } - ], - "requestBody": { - "description": "The role mapping that you want to create.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/AuthFederationRoleMapping" - } - } + "403" : { + "$ref" : "#/components/responses/forbidden" }, - "required": true + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/AuthFederationRoleMapping" + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping" : { + "post" : { + "tags" : [ "Global Clusters" ], + "summary" : "Add One Entry to One Custom Zone Mapping", + "description" : "Creates one custom zone mapping for the specified global cluster. A custom zone mapping matches one ISO 3166-2 location code to a zone in your global cluster. By default, MongoDB Cloud maps each location code to the closest geographical zone. To use this resource, the requesting API Key must have the Project Owner role.", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "createCustomZoneMapping", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "name" : "clusterName", + "in" : "path", + "description" : "Human-readable label that identifies this cluster.", + "required" : true, + "schema" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } ], + "requestBody" : { + "description" : "Custom zone mapping to add to the specified global cluster.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CustomZoneMappings" + } + }, + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CustomZoneMappings" + } + }, + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/CustomZoneMappings" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2025-06-01" + }, + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-02-01", + "x-sunset" : "2026-03-01" + }, + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding20240805" + }, + "x-xgen-version" : "2024-08-05" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + }, + "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 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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2025-06-01" + }, + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-02-01", + "x-sunset" : "2026-03-01" + }, + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding20240805" }, - "x-xgen-version": "2023-01-01" + "x-xgen-version" : "2024-08-05" } } }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" + "401" : { + "$ref" : "#/components/responses/unauthorized" }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" + "500" : { + "$ref" : "#/components/responses/internalServerError" } }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" } }, - "/api/atlas/v2/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 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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "example": "32b6e34b3d91647abb20e7b8" + "/api/atlas/v2/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 API Key must have the Project Data Access Admin role.", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "createManagedNamespace", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "name" : "clusterName", + "in" : "path", + "description" : "Human-readable label that identifies this cluster.", + "required" : true, + "schema" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } ], + "requestBody" : { + "description" : "Managed namespace to create within the specified global cluster.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ManagedNamespaces" + } + }, + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ManagedNamespaces" + } + }, + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/ManagedNamespaces" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2025-06-01" + }, + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-02-01", + "x-sunset" : "2026-03-01" + }, + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding20240805" + }, + "x-xgen-version" : "2024-08-05" + } } }, - { - "$ref": "#/components/parameters/envelope" + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "405" : { + "$ref" : "#/components/responses/methodNotAllowed" }, - { - "$ref": "#/components/parameters/orgId" + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + }, + "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 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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/AuthFederationRoleMapping" + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2025-06-01" + }, + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-02-01", + "x-sunset" : "2026-03-01" + }, + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding20240805" + }, + "x-xgen-version" : "2024-08-05" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + } + }, + "/api/atlas/v2/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 includes clusters with asymmetrically-sized shards. To use this resource, the requesting API Key must have the Project Read Only role. This feature is not available for serverless clusters.", + "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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedLegacyClusterView" + }, + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2025-06-01" + }, + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAdvancedClusterDescriptionView" + }, + "x-xgen-version" : "2023-02-01", + "x-sunset" : "2026-03-01" + }, + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedClusterDescription20240805" + }, + "x-xgen-version" : "2024-08-05" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + }, + "post" : { + "tags" : [ "Clusters" ], + "summary" : "Create One Cluster from 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 clusters with asymmetrically-sized shards. Each project supports up to 25 database deployments. To use this resource, the requesting API Key must have the Project Owner role. This feature is not available for serverless clusters.", + "operationId" : "createCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "description" : "Cluster to create in the specific project.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LegacyAtlasCluster" + } + }, + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AdvancedClusterDescription" + } + }, + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterDescription20240805" + }, + "examples" : { + "Cluster" : { + "description" : "Cluster", + "value" : { + "clusterType" : "SHARDED", + "name" : "myCluster", + "replicationSpecs" : [ { + "regionConfigs" : [ { + "analyticsAutoScaling" : { + "autoIndexing" : { + "enabled" : false + }, + "compute" : { + "enabled" : false + }, + "diskGB" : { + "enabled" : true + } + }, + "analyticsSpecs" : { + "instanceSize" : "M30", + "nodeCount" : 0, + "diskSizeGB" : 10.0 + }, + "autoScaling" : { + "autoIndexing" : { + "enabled" : false + }, + "compute" : { + "enabled" : false + }, + "diskGB" : { + "enabled" : true + } + }, + "electableSpecs" : { + "instanceSize" : "M30", + "nodeCount" : 3, + "diskSizeGB" : 10.0 + }, + "priority" : 7, + "providerName" : "AWS", + "readOnlySpecs" : { + "instanceSize" : "M30", + "nodeCount" : 0, + "diskSizeGB" : 10.0 + }, + "regionName" : "US_EAST_1" + } ], + "zoneName" : "Zone 1" + }, { + "regionConfigs" : [ { + "analyticsAutoScaling" : { + "autoIndexing" : { + "enabled" : false + }, + "compute" : { + "enabled" : false + }, + "diskGB" : { + "enabled" : true + } + }, + "analyticsSpecs" : { + "instanceSize" : "M10", + "nodeCount" : 0, + "diskSizeGB" : 10.0 + }, + "autoScaling" : { + "autoIndexing" : { + "enabled" : false + }, + "compute" : { + "enabled" : false + }, + "diskGB" : { + "enabled" : true + } + }, + "electableSpecs" : { + "instanceSize" : "M10", + "nodeCount" : 3, + "diskSizeGB" : 10.0 + }, + "priority" : 7, + "providerName" : "AWS", + "readOnlySpecs" : { + "instanceSize" : "M10", + "nodeCount" : 0, + "diskSizeGB" : 10.0 + }, + "regionName" : "US_EAST_1" + } ], + "zoneName" : "Zone 1" + } ] + } + } + }, + "x-xgen-version" : "2024-08-05" + } + }, + "required" : true + }, + "responses" : { + "201" : { + "description" : "Created", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LegacyAtlasCluster" + }, + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2025-06-01" + }, + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AdvancedClusterDescription" }, - "x-xgen-version": "2023-01-01" + "x-xgen-version" : "2023-02-01", + "x-sunset" : "2026-03-01" + }, + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterDescription20240805" + }, + "x-xgen-version" : "2024-08-05" } } }, - "400": { - "$ref": "#/components/responses/badRequest" + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" }, - "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" + "500" : { + "$ref" : "#/components/responses/internalServerError" } }, - "security": [ - { - "DigestAuth": [] + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites" : { + "get" : { + "tags" : [ "Global Clusters" ], + "summary" : "Return One Managed Namespace in One Global Cluster", + "description" : "Returns one managed namespace within the specified global cluster. A managed namespace identifies a collection using the database name, the dot separator, and the collection name. To use this resource, the requesting API Key must have the Project Read Only role.", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "getManagedNamespace", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "name" : "clusterName", + "in" : "path", + "description" : "Human-readable label that identifies this cluster.", + "required" : true, + "schema" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" } - ], - "x-xgen-owner-team": "IAM" - }, - "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 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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "example": "32b6e34b3d91647abb20e7b8" + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2025-06-01" + }, + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding" + }, + "x-xgen-version" : "2023-02-01", + "x-sunset" : "2026-03-01" + }, + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/GeoSharding20240805" + }, + "x-xgen-version" : "2024-08-05" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs" : { + "get" : { + "tags" : [ "Clusters" ], + "summary" : "Return One 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, or serverless clusters. To use this resource, the requesting API Key must have the Project Read Only role.", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "getClusterAdvancedConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "name" : "clusterName", + "in" : "path", + "description" : "Human-readable label that identifies the cluster.", + "required" : true, + "schema" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterDescriptionProcessArgs" + }, + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2026-03-01" + }, + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterDescriptionProcessArgs20240805" + }, + "x-xgen-version" : "2024-08-05" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + }, + "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 API Key must have the Project Cluster Manager role. This feature isn't available for `M0` free clusters, `M2` and `M5` shared-tier clusters, or serverless clusters.", + "externalDocs" : { + "description" : "Global Clusters", + "url" : "https://www.mongodb.com/docs/atlas/global-clusters/" + }, + "operationId" : "updateClusterAdvancedConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "name" : "clusterName", + "in" : "path", + "description" : "Human-readable label that identifies the cluster.", + "required" : true, + "schema" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterDescriptionProcessArgs" + }, + "x-xgen-version" : "2023-01-01" + }, + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterDescriptionProcessArgs20240805" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterDescriptionProcessArgs" + }, + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2026-03-01" + }, + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/ClusterDescriptionProcessArgs20240805" + }, + "x-xgen-version" : "2024-08-05" + } } }, - { - "$ref": "#/components/parameters/envelope" + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:grantMongoDBEmployeeAccess" : { + "post" : { + "tags" : [ "Clusters" ], + "summary" : "Grant MongoDB employee cluster access for one cluster.", + "description" : "Grants MongoDB employee cluster access for the given duration and at the specified level for one cluster.", + "operationId" : "grantMongoDBEmployeeAccess", + "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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } ], + "requestBody" : { + "description" : "Grant access level and expiration.", + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/EmployeeAccessGrantView" + }, + "x-xgen-version" : "2024-08-05" + } }, - { - "$ref": "#/components/parameters/orgId" - } - ], - "requestBody": { - "description": "The role mapping that you want to update.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/AuthFederationRoleMapping" + "required" : true + }, + "responses" : { + "204" : { + "description" : "This endpoint does not return a response body.", + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2024-08-05" } } }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/AuthFederationRoleMapping" + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + } + }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:revokeMongoDBEmployeeAccess" : { + "post" : { + "tags" : [ "Clusters" ], + "summary" : "Revoke granted MongoDB employee cluster access for one cluster.", + "description" : "Revokes a previously granted MongoDB employee cluster access.", + "operationId" : "revokeMongoDBEmployeeAccess", + "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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "This endpoint does not return a response body.", + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2024-08-05" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + } + }, + "/api/atlas/v2/orgs/{orgId}/resourcePolicies" : { + "get" : { + "tags" : [ "Resource Policies" ], + "summary" : "Return all Atlas Resource Policies", + "description" : "Return all Atlas Resource Policies for the org.", + "externalDocs" : { + "description" : "Atlas Resource Policies", + "url" : "https://docs.atlas.mongodb.com" + }, + "operationId" : "getAtlasResourcePolicies", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasResourcePolicyView" + } }, - "x-xgen-version": "2023-01-01" + "x-xgen-version" : "2024-08-05" } } }, - "400": { - "$ref": "#/components/responses/badRequest" + "400" : { + "$ref" : "#/components/responses/badRequest" }, - "401": { - "$ref": "#/components/responses/unauthorized" + "401" : { + "$ref" : "#/components/responses/unauthorized" }, - "404": { - "$ref": "#/components/responses/notFound" + "404" : { + "$ref" : "#/components/responses/notFound" }, - "500": { - "$ref": "#/components/responses/internalServerError" + "500" : { + "$ref" : "#/components/responses/internalServerError" } }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" }, - "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 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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "example": "32b6e34b3d91647abb20e7b8" + "post" : { + "tags" : [ "Resource Policies" ], + "summary" : "Create one Atlas Resource Policy", + "description" : "Create one Atlas Resource Policy for an org.", + "externalDocs" : { + "description" : "Atlas Resource Policies", + "url" : "https://docs.atlas.mongodb.com" + }, + "operationId" : "createAtlasResourcePolicy", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "requestBody" : { + "description" : "Atlas Resource Policy to create.", + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasResourcePolicyCreateView" + }, + "x-xgen-version" : "2024-08-05" } }, - { - "$ref": "#/components/parameters/envelope" + "required" : true + }, + "responses" : { + "201" : { + "description" : "Created", + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasResourcePolicyView" + }, + "x-xgen-version" : "2024-08-05" + } + } }, - { - "$ref": "#/components/parameters/orgId" - } - ], - "responses": { - "204": { - "description": "No Content", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "x-xgen-version": "2023-01-01" + "400" : { + "description" : "Bad request.", + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasInvalidResourcePolicyCreateErrorView" + }, + "x-xgen-version" : "2024-08-05" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + } + }, + "/api/atlas/v2/orgs/{orgId}/resourcePolicies/{resourcePolicyId}" : { + "get" : { + "tags" : [ "Resource Policies" ], + "summary" : "Return one Atlas Resource Policy", + "description" : "Return one Atlas Resource Policy for an org.", + "externalDocs" : { + "description" : "Atlas Resource Policies", + "url" : "https://docs.atlas.mongodb.com" + }, + "operationId" : "getAtlasResourcePolicy", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "name" : "resourcePolicyId", + "in" : "path", + "description" : "Unique 24-hexadecimal digit string that identifies an atlas resource policy.", + "required" : true, + "schema" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the atlas resource policy.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasResourcePolicyView" + }, + "x-xgen-version" : "2024-08-05" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + }, + "delete" : { + "tags" : [ "Resource Policies" ], + "summary" : "Delete one Atlas Resource Policy", + "description" : "Delete one Atlas Resource Policy for an org.", + "externalDocs" : { + "description" : "Atlas Resource Policies", + "url" : "https://docs.atlas.mongodb.com" + }, + "operationId" : "deleteAtlasResourcePolicy", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "name" : "resourcePolicyId", + "in" : "path", + "description" : "Unique 24-hexadecimal digit string that identifies an atlas resource policy.", + "required" : true, + "schema" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the atlas resource policy.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + } + } ], + "responses" : { + "200" : { + "description" : "This endpoint does not return a response body.", + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2024-08-05" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + }, + "patch" : { + "tags" : [ "Resource Policies" ], + "summary" : "Update one Atlas Resource Policy", + "description" : "Update one Atlas Resource Policy for an org.", + "externalDocs" : { + "description" : "Atlas Resource Policies", + "url" : "https://docs.atlas.mongodb.com" + }, + "operationId" : "updateAtlasResourcePolicy", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "name" : "resourcePolicyId", + "in" : "path", + "description" : "Unique 24-hexadecimal digit string that identifies an atlas resource policy.", + "required" : true, + "schema" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the atlas resource policy.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + } + } ], + "requestBody" : { + "description" : "Atlas Resource Policy to update.", + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasResourcePolicyEditView" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "Ok", + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasResourcePolicyView" + }, + "x-xgen-version" : "2024-08-05" + } + } + }, + "400" : { + "description" : "Bad request.", + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasInvalidResourcePolicyCreateErrorView" + }, + "x-xgen-version" : "2024-08-05" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" + } + }, + "/api/atlas/v2/orgs/{orgId}/nonCompliantResources" : { + "get" : { + "tags" : [ "Resource Policies" ], + "summary" : "Return all non-compliant resources", + "description" : "Return all non-compliant resources for an org.", + "externalDocs" : { + "description" : "Atlas Resource Policies", + "url" : "https://docs.atlas.mongodb.com" + }, + "operationId" : "getResourcesNonCompliant", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasNonCompliantResourceView" + } + }, + "x-xgen-version" : "2024-08-05" } } }, - "400": { - "$ref": "#/components/responses/badRequest" + "400" : { + "$ref" : "#/components/responses/badRequest" }, - "401": { - "$ref": "#/components/responses/unauthorized" + "401" : { + "$ref" : "#/components/responses/unauthorized" }, - "404": { - "$ref": "#/components/responses/notFound" + "404" : { + "$ref" : "#/components/responses/notFound" }, - "500": { - "$ref": "#/components/responses/internalServerError" + "500" : { + "$ref" : "#/components/responses/internalServerError" } }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" } }, - "/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs": { - "get": { - "tags": ["Federated Authentication"], - "summary": "Return All Connected Org Configs from One Federation", - "description": "Returns all connected org configs in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected orgs.", - "operationId": "listConnectedOrgConfigs", - "parameters": [ - { - "$ref": "#/components/parameters/federationSettingsId" - }, - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/itemsPerPage" + "/api/atlas/v2/orgs/{orgId}/resourcePolicies:validate" : { + "post" : { + "tags" : [ "Resource Policies" ], + "summary" : "Validate one Atlas Resource Policy", + "description" : "Validate one Atlas Resource Policy for an org.", + "externalDocs" : { + "description" : "Atlas Resource Policies", + "url" : "https://docs.atlas.mongodb.com" + }, + "operationId" : "validateAtlasResourcePolicy", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "requestBody" : { + "description" : "Atlas Resource Policy to create.", + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasResourcePolicyCreateView" + }, + "x-xgen-version" : "2024-08-05" + } }, - { - "$ref": "#/components/parameters/pageNum" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedConnectedOrgConfigsView" + "required" : true + }, + "responses" : { + "200" : { + "description" : "Ok", + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasResourcePolicyView" }, - "x-xgen-version": "2023-01-01" + "x-xgen-version" : "2024-08-05" } } }, - "400": { - "$ref": "#/components/responses/badRequest" + "400" : { + "description" : "Bad request.", + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasInvalidResourcePolicyCreateErrorView" + }, + "x-xgen-version" : "2024-08-05" + } + } }, - "401": { - "$ref": "#/components/responses/unauthorized" + "401" : { + "$ref" : "#/components/responses/unauthorized" }, - "404": { - "$ref": "#/components/responses/notFound" + "404" : { + "$ref" : "#/components/responses/notFound" }, - "500": { - "$ref": "#/components/responses/internalServerError" + "500" : { + "$ref" : "#/components/responses/internalServerError" } }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Dedicated" } }, - "/api/atlas/v2/federationSettings/{federationSettingsId}/connectedOrgConfigs/{orgId}": { - "get": { - "tags": ["Federated Authentication"], - "summary": "Return One Org Config Connected to One Federation", - "description": "Returns the specified connected org config from the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in the connected org.", - "operationId": "getConnectedOrgConfig", - "parameters": [ - { - "$ref": "#/components/parameters/federationSettingsId" - }, - { - "$ref": "#/components/parameters/envelope" - }, - { - "name": "orgId", - "in": "path", - "description": "Unique 24-hexadecimal digit string that identifies the connected organization configuration to return.", - "required": true, - "schema": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "example": "32b6e34b3d91647abb20e7b8" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ConnectedOrgConfig" + "/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}" : { + "get" : { + "tags" : [ "Clusters" ], + "summary" : "Check Status of Cluster Sample Dataset Request", + "description" : "Checks the progress of loading the sample dataset into one cluster. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "getSampleDatasetLoadStatus", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "name" : "sampleDatasetId", + "in" : "path", + "description" : "Unique 24-hexadecimal digit string that identifies the loaded sample dataset.", + "required" : true, + "schema" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/SampleDatasetStatus" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas" + } + }, + "/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}" : { + "post" : { + "tags" : [ "Clusters" ], + "summary" : "Load Sample Dataset Request into Cluster", + "description" : "Requests loading the MongoDB sample dataset into the specified cluster. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "loadSampleDataset", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "name" : "name", + "in" : "path", + "description" : "Human-readable label that identifies the cluster into which you load the sample dataset.", + "required" : true, + "schema" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } ], + "responses" : { + "201" : { + "description" : "Created", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/SampleDatasetStatus" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas" + } + }, + "/api/atlas/v2/groups/{groupId}/serverless" : { + "get" : { + "tags" : [ "Serverless Instances" ], + "summary" : "Return All Serverless Instances from One Project", + "description" : "Returns details for all serverless instances in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "listServerlessInstances", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedServerlessInstanceDescriptionView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Serverless II" + }, + "post" : { + "tags" : [ "Serverless Instances" ], + "summary" : "Create One Serverless Instance in One Project", + "description" : "Creates one serverless instance in the specified project. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "createServerlessInstance", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "description" : "Create One Serverless Instance in One Project.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescriptionCreate" + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "description" : "Created", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Serverless II" + } + }, + "/api/atlas/v2/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 API Key must have the Project Read Only role.", + "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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Serverless II" + }, + "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 API Key must have the Project Owner role.", + "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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } ], + "responses" : { + "202" : { + "description" : "Accepted", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/RequestAccepted" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Serverless II" + }, + "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 API Key must have the Project Owner role.", + "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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } ], + "requestBody" : { + "description" : "Update One Serverless Instance in One Project.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescriptionUpdate" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescription" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Serverless II" + } + }, + "/api/atlas/v2/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.", + "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" : { + "maxLength" : 64, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpoint" + } }, - "x-xgen-version": "2023-01-01" + "x-xgen-version" : "2023-01-01" } } }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - }, - "delete": { - "tags": ["Federated Authentication"], - "summary": "Remove One Org Config Connected to One Federation", - "description": "Removes one connected organization configuration from the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. Note: This request fails if only one connected organization exists in the federation.", - "operationId": "removeConnectedOrgConfig", - "parameters": [ - { - "$ref": "#/components/parameters/federationSettingsId" - }, - { - "$ref": "#/components/parameters/envelope" - }, - { - "name": "orgId", - "in": "path", - "description": "Unique 24-hexadecimal digit string that identifies the connected organization configuration to remove.", - "required": true, - "schema": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "example": "32b6e34b3d91647abb20e7b8" - } + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Serverless II" + }, + "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 API Key must have the Project Owner role.\n\n A new endpoint won't be immediately available after creation. Read the steps in the linked tutorial for detailed guidance.", + "externalDocs" : { + "description" : "Set Up a Private Endpoint for a Serverless Instance Tutorial", + "url" : "https://dochub.mongodb.org/core/serverless-private-endpoint" + }, + "operationId" : "createServerlessPrivateEndpoint", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "name" : "instanceName", + "in" : "path", + "description" : "Human-readable label that identifies the serverless instance for which the tenant endpoint will be created.", + "required" : true, + "schema" : { + "maxLength" : 64, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" } - ], - "responses": { - "204": { - "description": "This endpoint does not return a response body.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/NoBody" + } ], + "requestBody" : { + "description" : "Information about the Private Endpoint to create for the Serverless Instance.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantCreateRequest" + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "description" : "Created", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Serverless II" + } + }, + "/api/atlas/v2/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.", + "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" : { + "maxLength" : 64, + "pattern" : "^([a-zA-Z0-9][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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Serverless II" + }, + "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 API Key must have the Project Owner role.", + "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" : { + "maxLength" : 64, + "pattern" : "^([a-zA-Z0-9][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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "This endpoint does not return a response body.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Serverless II" + }, + "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 API Key must have the Project Owner role.", + "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" : { + "maxLength" : 64, + "pattern" : "^([a-zA-Z0-9][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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "requestBody" : { + "description" : "Object used for update.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServerlessTenantEndpoint" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Serverless II" + } + }, + "/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/restoreJobs" : { + "get" : { + "tags" : [ "Flex Restore Jobs" ], + "summary" : "Return All Restore Jobs for One Flex Cluster", + "description" : "Returns all restore jobs for one flex cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "listFlexBackupRestoreJobs", + "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" : "name", + "in" : "path", + "description" : "Human-readable label that identifies the flex cluster.", + "required" : true, + "schema" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasFlexBackupRestoreJob20250101View" + }, + "x-xgen-version" : "2025-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-hidden-env" : { + "envs" : "dev,qa,stage,prod" + }, + "x-xgen-owner-team" : "Atlas Serverless II" + }, + "post" : { + "tags" : [ "Flex Restore Jobs" ], + "summary" : "Restore One Snapshot of One Flex Cluster", + "description" : "Restores one snapshot of one flex cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "createFlexBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "name" : "name", + "in" : "path", + "description" : "Human-readable label that identifies the flex cluster whose snapshot you want to restore.", + "required" : true, + "schema" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } ], + "requestBody" : { + "description" : "Restores one snapshot of one flex cluster from the specified project.", + "content" : { + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/FlexBackupRestoreJobCreate20250101" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/FlexBackupRestoreJob20250101" + }, + "x-xgen-version" : "2025-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-hidden-env" : { + "envs" : "dev,qa,stage,prod" + }, + "x-xgen-owner-team" : "Atlas Serverless II" + } + }, + "/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/download" : { + "post" : { + "tags" : [ "Flex Snapshots" ], + "summary" : "Download One Flex Cluster Snapshot", + "description" : "Requests one snapshot for the specified flex cluster. This resource returns a `snapshotURL` that you can use to download the snapshot. This `snapshotURL` remains active for four hours after you make the request. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "downloadFlexBackup", + "parameters" : [ { + "name" : "name", + "in" : "path", + "description" : "Human-readable label that identifies the flex cluster.", + "required" : true, + "schema" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/FlexBackupSnapshotDownloadCreate20250101" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/FlexBackupRestoreJob20250101" }, - "x-xgen-version": "2023-01-01" + "x-xgen-version" : "2025-01-01" } } }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - }, - "patch": { - "tags": ["Federated Authentication"], - "summary": "Update One Org Config Connected to One Federation", - "description": "Updates one connected organization configuration from the specified federation. To use this resource, the requesting API Key must have the Organization Owner role. \n\n**Note** If the organization configuration has no associated identity provider, you can't use this resource to update role mappings or post authorization role grants. \n\n**Note**: The domainRestrictionEnabled field defaults to false if not provided in the request. \n\n**Note**: If the identityProviderId field is not provided, you will disconnect the organization and the identity provider. \n\n**Note**: Currently connected data access identity providers missing from the dataAccessIdentityProviderIds field will be disconnected.", - "operationId": "updateConnectedOrgConfig", - "parameters": [ - { - "$ref": "#/components/parameters/federationSettingsId" + "400" : { + "$ref" : "#/components/responses/badRequest" }, - { - "$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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "example": "32b6e34b3d91647abb20e7b8" - } + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-hidden-env" : { + "envs" : "dev,qa,stage,prod" + }, + "x-xgen-owner-team" : "Atlas Serverless II" + } + }, + "/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/restoreJobs/{restoreJobId}" : { + "get" : { + "tags" : [ "Flex Restore Jobs" ], + "summary" : "Return One Restore Job for One Flex Cluster", + "description" : "Returns one restore job for one flex cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "getFlexBackupRestoreJob", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "name" : "name", + "in" : "path", + "description" : "Human-readable label that identifies the flex cluster.", + "required" : true, + "schema" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/FlexBackupRestoreJob20250101" + }, + "x-xgen-version" : "2025-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-hidden-env" : { + "envs" : "dev,qa,stage,prod" + }, + "x-xgen-owner-team" : "Atlas Serverless II" + } + }, + "/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/snapshots/{snapshotId}" : { + "get" : { + "tags" : [ "Flex Snapshots" ], + "summary" : "Return One Snapshot of One Flex Cluster", + "description" : "Returns one snapshot of one flex cluster from the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "getFlexBackup", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "name" : "name", + "in" : "path", + "description" : "Human-readable label that identifies the flex cluster.", + "required" : true, + "schema" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/FlexBackupSnapshot20250101" + }, + "x-xgen-version" : "2025-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-hidden-env" : { + "envs" : "dev,qa,stage,prod" + }, + "x-xgen-owner-team" : "Atlas Serverless II" + } + }, + "/api/atlas/v2/groups/{groupId}/flexClusters/{name}/backup/snapshots" : { + "get" : { + "tags" : [ "Flex Snapshots" ], + "summary" : "Return All Snapshots of One Flex Cluster", + "description" : "Returns all snapshots of one flex cluster from the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "listFlexBackups", + "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" : "name", + "in" : "path", + "description" : "Human-readable label that identifies the flex cluster.", + "required" : true, + "schema" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAtlasFlexBackupSnapshot20240710View" + }, + "x-xgen-version" : "2025-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-hidden-env" : { + "envs" : "dev,qa,stage,prod" + }, + "x-xgen-owner-team" : "Atlas Serverless II" + } + }, + "/api/atlas/v2/groups/{groupId}/flexClusters" : { + "get" : { + "tags" : [ "Flex Clusters" ], + "summary" : "Return All Flex Clusters from One Project", + "description" : "Returns details for all flex clusters in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "listFlexClusters", + "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/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedFlexClusters20250101" + }, + "x-xgen-version" : "2025-01-01" + } + } + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-hidden-env" : { + "envs" : "qa,prod" + }, + "x-xgen-owner-team" : "Atlas Serverless II" + }, + "post" : { + "tags" : [ "Flex Clusters" ], + "summary" : "Create One Flex Cluster in One Project", + "description" : "Creates one flex cluster in the specified project. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "createFlexcluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "description" : "Create One Flex Cluster in One Project.", + "content" : { + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/FlexClusterDescriptionCreate20250101" + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "description" : "Created", + "content" : { + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/FlexClusterDescription20250101" + }, + "x-xgen-version" : "2025-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-hidden-env" : { + "envs" : "qa,prod" + }, + "x-xgen-owner-team" : "Atlas Serverless II" + } + }, + "/api/atlas/v2/groups/{groupId}/flexClusters/{name}" : { + "get" : { + "tags" : [ "Flex Clusters" ], + "summary" : "Return One Flex Cluster from One Project", + "description" : "Returns details for one flex cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "getFlexCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "name" : "name", + "in" : "path", + "description" : "Human-readable label that identifies the flex cluster.", + "required" : true, + "schema" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/FlexClusterDescription20250101" + }, + "x-xgen-version" : "2025-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-hidden-env" : { + "envs" : "qa,prod" + }, + "x-xgen-owner-team" : "Atlas Serverless II" + }, + "delete" : { + "tags" : [ "Flex Clusters" ], + "summary" : "Remove One Flex Cluster from One Project", + "description" : "Removes one flex cluster from the specified project. The flex cluster must have termination protection disabled in order to be deleted. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "deleteFlexCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "name" : "name", + "in" : "path", + "description" : "Human-readable label that identifies the flex cluster.", + "required" : true, + "schema" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "This endpoint does not return a response body.", + "content" : { + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2025-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-hidden-env" : { + "envs" : "qa,prod" + }, + "x-xgen-owner-team" : "Atlas Serverless II" + }, + "patch" : { + "tags" : [ "Flex Clusters" ], + "summary" : "Update One Flex Cluster in One Project", + "description" : "Updates one flex cluster in the specified project. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "updateFlexCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "name" : "name", + "in" : "path", + "description" : "Human-readable label that identifies the flex cluster.", + "required" : true, + "schema" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string" } - ], - "requestBody": { - "description": "The connected organization configuration that you want to update.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ConnectedOrgConfig" + } ], + "requestBody" : { + "description" : "Update One Flex Cluster in One Project.", + "content" : { + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/FlexClusterDescription20250101" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ConnectedOrgConfig" - }, - "x-xgen-version": "2023-01-01" + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/FlexClusterDescription20250101" + }, + "x-xgen-version" : "2025-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-hidden-env" : { + "envs" : "qa,prod" + }, + "x-xgen-owner-team" : "Atlas Serverless II" + } + }, + "/api/atlas/v2/groups/{groupId}/flexClusters:tenantUpgrade" : { + "post" : { + "tags" : [ "Flex Clusters" ], + "summary" : "Upgrade One Flex Cluster", + "description" : "Upgrades a flex cluster in the specified project. To use this resource, the requesting API key must have the Project Cluster Manager role.", + "operationId" : "upgradeFlexCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "description" : "Details of the flex cluster upgrade in the specified project.", + "content" : { + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/FlexClusterDescription20250101" } } }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/FlexClusterDescription20250101" + }, + "x-xgen-version" : "2025-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "409" : { + "$ref" : "#/components/responses/conflict" }, - "500": { - "$ref": "#/components/responses/internalServerError" + "500" : { + "$ref" : "#/components/responses/internalServerError" } }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-hidden-env" : { + "envs" : "qa,prod" + }, + "x-xgen-owner-team" : "Atlas Serverless II" } }, - "/api/atlas/v2/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 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", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "x-xgen-version": "2023-01-01" - } + "/api/atlas/v2/unauth/openapi/versions" : { + "get" : { + "tags" : [ "OpenAPI" ], + "summary" : "Provides a list of versions for a given environment.", + "description" : "API that provides a list of available versionsfor a given environment.", + "operationId" : "getApiVersions", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "name" : "env", + "in" : "query", + "description" : "The environment to get the versions from. If not provided, it returnsthe versions for the given MongoDB URL. (E.g. prod for cloud.mongodb.com)", + "schema" : { + "type" : "string", + "enum" : [ "dev", "qa", "prod", "stage" ] + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiVersions" + }, + "x-xgen-version" : "2024-08-05" + }, + "application/vnd.atlas.2024-08-05+yaml" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiVersions" + }, + "x-xgen-version" : "2024-08-05" + } } }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" + "500" : { + "$ref" : "#/components/responses/internalServerError" } }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" + "x-xgen-hidden-env" : { + "envs" : "qa,prod,stage" + } } }, - "/api/atlas/v2/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 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", - "items": { - "type": "string", - "default": "SAML", - "enum": ["SAML", "OIDC"] + "/api/atlas/v2/orgs" : { + "get" : { + "tags" : [ "Organizations" ], + "summary" : "Return All Organizations", + "description" : "Returns all organizations to which the requesting API Key has access. To use this resource, the requesting API Key must have the Organization Member role.", + "operationId" : "listOrganizations", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedOrganizationView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + }, + "post" : { + "tags" : [ "Organizations" ], + "summary" : "Create One Organization", + "description" : "Creates one organization in MongoDB Cloud and links it to the requesting API Key's organization. To use this resource, the requesting API Key must have the Organization Owner role. The requesting API Key's organization must be a paying organization. To learn more, see [Configure a Paying Organization](https://www.mongodb.com/docs/atlas/billing/#configure-a-paying-organization) in the MongoDB Atlas documentation.", + "operationId" : "createOrganization", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "description" : "Organization that you want to create.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateOrganizationRequest" } } }, - { - "name": "idpType", - "in": "query", - "description": "The types of the target identity providers.", - "schema": { - "type": "array", - "items": { - "type": "string", - "default": "WORKFORCE", - "enum": ["WORKFORCE", "WORKLOAD"] - } - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedFederationIdentityProvider" - }, - "x-xgen-version": "2023-01-01" + "required" : true + }, + "responses" : { + "201" : { + "description" : "Created", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateOrganizationResponse" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "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" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + } + }, + "/api/atlas/v2/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 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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiUserAccessListResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + }, + "post" : { + "tags" : [ "Programmatic API Keys" ], + "summary" : "Create Access List Entries 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 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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "requestBody" : { + "description" : "Access list entries to be created for the specified organization API key.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/UserAccessListRequest" + } } } }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } + "required" : true }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - }, - "post": { - "tags": ["Federated Authentication"], - "summary": "Create One Identity Provider", - "description": "Creates one identity provider within the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations.\n\n**Note**: This resource only supports the creation of OIDC identity providers.", - "operationId": "createIdentityProvider", - "parameters": [ - { - "$ref": "#/components/parameters/federationSettingsId" - }, - { - "$ref": "#/components/parameters/envelope" - } - ], - "requestBody": { - "description": "The identity provider that you want to create.", - "content": { - "application/vnd.atlas.2023-11-15+json": { - "schema": { - "$ref": "#/components/schemas/FederationOidcIdentityProviderUpdate" + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiUserAccessListResponseView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + } + }, + "/api/atlas/v2/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 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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserAccessListResponse" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + }, + "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 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" : { + "maxLength" : 24, + "minLength" : 24, + "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.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + } + }, + "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiApiUserView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + }, + "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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateAtlasOrganizationApiKey" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + } + }, + "/api/atlas/v2/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 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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + }, + "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 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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "This endpoint does not return a response body.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateAtlasOrganizationApiKey" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + } + }, + "/api/atlas/v2/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 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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAppUserView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + }, + "post" : { + "tags" : [ "Teams" ], + "summary" : "Assign MongoDB Cloud Users from 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 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" : { + "maxLength" : 24, + "minLength" : 24, + "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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AddUserToTeam" + } } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-11-15+json": { - "schema": { - "$ref": "#/components/schemas/FederationOidcIdentityProvider" + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiAppUserView" }, - "x-xgen-version": "2023-11-15" + "x-xgen-version" : "2023-01-01" } } }, - "400": { - "$ref": "#/components/responses/badRequest" + "400" : { + "$ref" : "#/components/responses/badRequest" }, - "401": { - "$ref": "#/components/responses/unauthorized" + "401" : { + "$ref" : "#/components/responses/unauthorized" }, - "403": { - "$ref": "#/components/responses/forbidden" + "404" : { + "$ref" : "#/components/responses/notFound" }, - "404": { - "$ref": "#/components/responses/notFound" + "409" : { + "$ref" : "#/components/responses/conflict" }, - "500": { - "$ref": "#/components/responses/internalServerError" + "500" : { + "$ref" : "#/components/responses/internalServerError" } }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" } }, - "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/metadata.xml": { - "get": { - "tags": ["Federated Authentication"], - "summary": "Return the Metadata of One Identity Provider", - "description": "Returns the metadata of one identity provider in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations.", - "operationId": "getIdentityProviderMetadata", - "parameters": [ - { - "$ref": "#/components/parameters/federationSettingsId" - }, - { - "$ref": "#/components/parameters/identityProviderId" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "type": "string" + "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTeamView" }, - "x-xgen-version": "2023-01-01" + "x-xgen-version" : "2023-01-01" } } }, - "400": { - "$ref": "#/components/responses/badRequest" + "400" : { + "$ref" : "#/components/responses/badRequest" }, - "401": { - "$ref": "#/components/responses/unauthorized" + "401" : { + "$ref" : "#/components/responses/unauthorized" }, - "404": { - "$ref": "#/components/responses/notFound" + "404" : { + "$ref" : "#/components/responses/notFound" }, - "500": { - "$ref": "#/components/responses/internalServerError" + "500" : { + "$ref" : "#/components/responses/internalServerError" } }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - } - }, - "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}": { - "get": { - "tags": ["Federated Authentication"], - "summary": "Return One Identity Provider by ID", - "description": "Returns one identity provider in the specified federation by the identity provider's id. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations.", - "operationId": "getIdentityProvider", - "parameters": [ - { - "$ref": "#/components/parameters/federationSettingsId" - }, - { - "name": "identityProviderId", - "in": "path", - "description": "Unique string that identifies the identity provider to connect. If using an API version before 11-15-2023, use the legacy 20-hexadecimal digit id. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider. For all other versions, use the 24-hexadecimal digit id.", - "required": true, - "schema": { - "type": "string", - "example": "32b6e34b3d91647abb20e7b8" + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + }, + "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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Team" + } } - }, - { - "$ref": "#/components/parameters/envelope" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/FederationSamlIdentityProvider" - }, - "x-xgen-version": "2023-01-01", - "x-sunset": "2025-01-01" - }, - "application/vnd.atlas.2023-11-15+json": { - "schema": { - "$ref": "#/components/schemas/FederationIdentityProvider" + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/Team" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + } + }, + "/api/atlas/v2/orgs/{orgId}/teams/{teamId}" : { + "get" : { + "tags" : [ "Teams" ], + "summary" : "Return One Team using its 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 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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamResponse" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + }, + "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 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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "This endpoint does not return a response body.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + }, + "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 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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "requestBody" : { + "description" : "Details to update on the specified team.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamUpdate" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamResponse" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + } + }, + "/api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}" : { + "get" : { + "tags" : [ "Teams" ], + "summary" : "Return One Team using its 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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamResponse" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + } + }, + "/api/atlas/v2/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 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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "This endpoint does not return a response body.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + } + }, + "/api/atlas/v2/orgs/{orgId}" : { + "get" : { + "tags" : [ "Organizations" ], + "summary" : "Return One Organization", + "description" : "Returns one organization to which the requesting API key has access. To use this resource, the requesting API Key must have the Organization Member role.", + "operationId" : "getOrganization", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AtlasOrganization" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + }, + "delete" : { + "tags" : [ "Organizations" ], + "summary" : "Remove One Organization", + "description" : "Removes one specified organization. MongoDB Cloud imposes the following limits on this resource:\n\n - Organizations with active projects cannot be removed.\n - All projects in the organization must be removed before you can remove the organization.\n To use this resource, the requesting API Key must have the Organization Owner role.", + "operationId" : "deleteOrganization", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "responses" : { + "204" : { + "description" : "This endpoint does not return a response body.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" }, - "x-xgen-version": "2023-11-15" + "x-xgen-version" : "2023-01-01" } } }, - "400": { - "$ref": "#/components/responses/badRequest" + "400" : { + "$ref" : "#/components/responses/badRequest" }, - "401": { - "$ref": "#/components/responses/unauthorized" + "401" : { + "$ref" : "#/components/responses/unauthorized" }, - "403": { - "$ref": "#/components/responses/forbidden" + "402" : { + "$ref" : "#/components/responses/paymentRequired" }, - "404": { - "$ref": "#/components/responses/notFound" + "403" : { + "$ref" : "#/components/responses/forbidden" }, - "500": { - "$ref": "#/components/responses/internalServerError" + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" } }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" }, - "delete": { - "tags": ["Federated Authentication"], - "summary": "Delete One Identity Provider", - "description": "Deletes one identity provider in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. \n\n**Note**: Requests to this resource will fail if the identity provider has any connected organizations. Before deleting an identity provider, disconnect all organizations and confirm that no organization in your account uses this identity provider. To learn more, see [Manage Organization Mapping for Federated Authentication](https://www.mongodb.com/docs/atlas/security/manage-org-mapping/).", - "operationId": "deleteIdentityProvider", - "parameters": [ - { - "$ref": "#/components/parameters/federationSettingsId" - }, - { - "name": "identityProviderId", - "in": "path", - "description": "Unique 24-hexadecimal digit string that identifies the identity provider to connect.", - "required": true, - "schema": { - "type": "string", - "example": "32b6e34b3d91647abb20e7b8" + "patch" : { + "tags" : [ "Organizations" ], + "summary" : "Rename One Organization", + "description" : "Renames one organization. To use this resource, the requesting API Key must have the Organization Owner role.", + "operationId" : "renameOrganization", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "description" : "Details to update on the specified organization.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AtlasOrganization" + } } }, - { - "$ref": "#/components/parameters/envelope" - } - ], - "responses": { - "204": { - "description": "No Response", - "content": { - "application/vnd.atlas.2023-11-15+json": { - "x-xgen-version": "2023-11-15" + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/AtlasOrganization" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + } + }, + "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrgFederationSettings" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + } + }, + "/api/atlas/v2/orgs/{orgId}/groups" : { + "get" : { + "tags" : [ "Organizations" ], + "summary" : "Return One or More Projects in One Organization", + "description" : "Returns multiple projects in the specified organization. Each organization can have multiple projects. Use projects to:\n\n- Isolate different environments, such as development, test, or production environments, from each other.\n- Associate different MongoDB Cloud users or teams with different environments, or give different permission to MongoDB Cloud users in different environments.\n- Maintain separate cluster security configurations.\n- Create different alert settings.\n\nTo use this resource, the requesting API Key must have the Organization Member role.", + "operationId" : "listOrganizationProjects", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAtlasGroupView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + } + }, + "/api/atlas/v2/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 API Key must have the Organization Owner role.", + "operationId" : "getOrganizationSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationSettings" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + }, + "patch" : { + "tags" : [ "Organizations" ], + "summary" : "Update Settings for One Organization", + "description" : "Updates the organization's settings. To use this resource, the requesting API Key must have the Organization Owner role.", + "operationId" : "updateOrganizationSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "description" : "Details to update on the specified organization's settings.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationSettings" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationSettings" + }, + "x-xgen-version" : "2023-01-01" } } }, - "400": { - "$ref": "#/components/responses/badRequest" + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" }, - "403": { - "$ref": "#/components/responses/forbidden" + "403" : { + "$ref" : "#/components/responses/forbidden" }, - "404": { - "$ref": "#/components/responses/notFound" + "404" : { + "$ref" : "#/components/responses/notFound" }, - "500": { - "$ref": "#/components/responses/internalServerError" + "500" : { + "$ref" : "#/components/responses/internalServerError" } }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - }, - "patch": { - "tags": ["Federated Authentication"], - "summary": "Update One Identity Provider", - "description": "Updates one identity provider in the specified federation. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations.\n\n**Note**: Changing authorization types and/or updating authorization claims can prevent current users and/or groups from accessing the database.", - "operationId": "updateIdentityProvider", - "parameters": [ - { - "$ref": "#/components/parameters/federationSettingsId" - }, - { - "name": "identityProviderId", - "in": "path", - "description": "Unique string that identifies the identity provider to connect. If using an API version before 11-15-2023, use the legacy 20-hexadecimal digit id. This id can be found within the Federation Management Console > Identity Providers tab by clicking the info icon in the IdP ID row of a configured identity provider. For all other versions, use the 24-hexadecimal digit id.", - "required": true, - "schema": { - "type": "string", - "example": "32b6e34b3d91647abb20e7b8" - } + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + } + }, + "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedAppUserView" + }, + "x-xgen-version" : "2023-01-01" + } + } }, - { - "$ref": "#/components/parameters/envelope" - } - ], - "requestBody": { - "description": "The identity provider that you want to update.", - "content": { - "application/vnd.atlas.2023-11-15+json": { - "schema": { - "$ref": "#/components/schemas/FederationIdentityProviderUpdate" - } - }, - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/FederationSamlIdentityProviderUpdate" + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + }, + "post" : { + "tags" : [ "MongoDB Cloud Users" ], + "summary" : "Create One MongoDB Cloud User in One Organization", + "description" : "Invites one new or existing MongoDB Cloud user to join the organization. The invitation to join the organization will be sent to the username provided and must be accepted within 30 days. To use this resource, the requesting API Key must have the Organization Owner role.\n\n**Note**: If the user does not have an existing MongoDB Cloud account, they will be prompted to finish setting up an account upon accepting the invitation. If the user already has an account, they will still receive an invitation to access the organization.", + "operationId" : "createOrganizationUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "description" : "Represents the MongoDB Cloud user to be created within the organization.", + "content" : { + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrgUserRequest" } } }, - "required": true + "required" : true }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/FederationSamlIdentityProvider" - }, - "x-xgen-version": "2023-01-01", - "x-sunset": "2025-01-01" - }, - "application/vnd.atlas.2023-11-15+json": { - "schema": { - "$ref": "#/components/schemas/FederationIdentityProvider" + "responses" : { + "201" : { + "description" : "Created", + "content" : { + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrgUserResponse" }, - "x-xgen-version": "2023-11-15" + "x-xgen-version" : "2025-01-01" } } }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "403": { - "$ref": "#/components/responses/forbidden" + "400" : { + "$ref" : "#/components/responses/badRequest" }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-hidden-env" : { + "envs" : "qa,stage,prod" + }, + "x-xgen-owner-team" : "IAM" + } + }, + "/api/atlas/v2/orgs/{orgId}/users/{userId}/roles" : { + "put" : { + "tags" : [ "Organizations" ], + "summary" : "Update Organization Roles for One MongoDB Cloud User", + "description" : "Updates the roles of the specified user in the specified organization. To specify the user to update, provide the unique 24-hexadecimal digit string that identifies the user in the specified organization. To use this resource, the requesting API Key must have the Organization User Admin role.", + "operationId" : "updateOrganizationRoles", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "name" : "userId", + "in" : "path", + "description" : "Unique 24-hexadecimal digit string that identifies the user to modify.", + "required" : true, + "schema" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "requestBody" : { + "description" : "Roles to update for the specified user.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateOrgRolesForUser" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateOrgRolesForUser" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + } + }, + "/api/atlas/v2/orgs/{orgId}/users/{userId}:addRole" : { + "post" : { + "tags" : [ "MongoDB Cloud Users" ], + "summary" : "Add One Organization Role to One MongoDB Cloud User", + "description" : "Adds one organization level role to the MongoDB Cloud user. You can add a role to an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting API Key must have the Organization Owner role.\n\n**Note**: This operation is atomic.\n\n**Note**: This resource cannot be used to add a role to users invited using the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint.", + "operationId" : "addOrganizationRole", + "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 pending or active user in the organization. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Organization resource and filter by username.", + "required" : true, + "schema" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + }, { + "name" : "role", + "in" : "query", + "description" : "Organization level role to assign to the MongoDB Cloud user.", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_READ_ONLY", "ORG_MEMBER" ] + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrgUserResponse" + }, + "x-xgen-version" : "2025-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-hidden-env" : { + "envs" : "qa,stage,prod" + }, + "x-xgen-owner-team" : "IAM" + } + }, + "/api/atlas/v2/orgs/{orgId}/users/{userId}" : { + "get" : { + "tags" : [ "MongoDB Cloud Users" ], + "summary" : "Return One MongoDB Cloud User in One Organization", + "description" : "Returns information about the specified MongoDB Cloud user within the context of the specified organization. To use this resource, the requesting API Key must have the Organization Read Only role.\n\n**Note**: This resource can only be used to fetch information about MongoDB Cloud human users. To return information about an API Key, use the [Return One Organization API Key](#tag/Programmatic-API-Keys/operation/getApiKey) endpoint.\n\n**Note**: This resource does not return information about pending users invited via the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint.", + "operationId" : "getOrganizationUser", + "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 pending or active user in the organization. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Organization resource and filter by username.", + "required" : true, + "schema" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrgUserResponse" + }, + "x-xgen-version" : "2025-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-hidden-env" : { + "envs" : "qa,stage,prod" + }, + "x-xgen-owner-team" : "IAM" + }, + "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 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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "This endpoint does not return a response body.", + "content" : { + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-hidden-env" : { + "envs" : "qa,stage,prod" + }, + "x-xgen-version" : "2025-01-01" + }, + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2026-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + }, + "patch" : { + "tags" : [ "MongoDB Cloud Users" ], + "summary" : "Update One MongoDB Cloud User in One Organization", + "description" : "Updates one MongoDB Cloud user in the specified organization. You can update an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting API Key must have the Organization Owner role.\n\n**Note**: Only include the fields you wish to update in the request body. Supplying a field with an empty value will reset that field on the user.\n\n**Note**: This resource cannot be used to update pending users invited via the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint.", + "operationId" : "updateOrganizationUser", + "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 pending or active user in the organization. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Organization resource and filter by username.", + "required" : true, + "schema" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "requestBody" : { + "description" : "Represents the roles and teams to assign the MongoDB Cloud user.", + "content" : { + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrgUserUpdateRequest" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrgUserResponse" + }, + "x-xgen-version" : "2025-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-hidden-env" : { + "envs" : "qa,stage,prod" + }, + "x-xgen-owner-team" : "IAM" + } + }, + "/api/atlas/v2/orgs/{orgId}/users/{userId}:removeRole" : { + "post" : { + "tags" : [ "MongoDB Cloud Users" ], + "summary" : "Remove One Organization Role from One MongoDB Cloud User", + "description" : "Removes one organization level role from the MongoDB Cloud user. You can remove a role from an active user or a user that has not yet accepted the invitation to join the organization. To replace a user's only role, add the new role before removing the old role. A user must have at least one role at all times. To use this resource, the requesting API Key must have the Organization Owner role.\n\n**Note**: This operation is atomic.\n\n**Note**: This resource cannot be used to remove a role from users invited using the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint.", + "operationId" : "removeOrganizationRole", + "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 pending or active user in the organization. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Organization resource and filter by username.", + "required" : true, + "schema" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + }, { + "name" : "role", + "in" : "query", + "description" : "Organization level role to remove from the MongoDB Cloud user.", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_READ_ONLY", "ORG_MEMBER" ] + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrgUserResponse" + }, + "x-xgen-version" : "2025-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-hidden-env" : { + "envs" : "qa,stage,prod" + }, + "x-xgen-owner-team" : "IAM" + } + }, + "/api/atlas/v2/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 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.\nTo 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", + "example" : true, + "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", + "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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiInvoiceMetadataView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Payments" + } + }, + "/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}" : { + "get" : { + "tags" : [ "Invoices" ], + "summary" : "Return One Organization Invoice", + "description" : "Returns one invoice that MongoDB issued to the specified organization. A unique 24-hexadecimal digit string identifies the invoice. You can choose to receive this invoice in JSON or CSV format. To use this resource, the requesting API Key must have the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can query for a linked invoice if you have the Organization Billing Admin or Organization Owner role.\nTo 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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/BillingInvoice" + }, + "x-xgen-version" : "2023-01-01" + }, + "application/vnd.atlas.2023-01-01+csv" : { + "schema" : { + "type" : "string" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Payments" + } + }, + "/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv" : { + "get" : { + "tags" : [ "Invoices" ], + "summary" : "Return One Organization Invoice as CSV", + "description" : "Returns one invoice that MongoDB issued to the specified organization in CSV format. A unique 24-hexadecimal digit string identifies the invoice. To use this resource, the requesting API Key have at least the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can query for a linked invoice if you have the Organization Billing Admin or Organization Owner Role.\n 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" : { + "application/vnd.atlas.2023-01-01+csv" : { + "schema" : { + "type" : "string" + }, + "example" : "Invoice Number,666acb8787ba43606905dcae,\nBilling Period,\"June 1, 2024 - July 1, 2024\",\nOrganization Name,Test 2,\nOrganization ID,666acb8787ba43606905dcac,\n\nDate,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\n", + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Payments" + } + }, + "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiInvoiceView" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Payments" + } + }, + "/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:accept" : { + "post" : { + "tags" : [ "Streams" ], + "summary" : "Requests the acceptance of an incoming VPC Peering connection.", + "description" : "Requests the acceptance of an incoming VPC Peering connection.", + "operationId" : "acceptVPCPeeringConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "name" : "id", + "in" : "path", + "description" : "The VPC Peering Connection id.", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "description" : "Challenge values for VPC Peering requester account ID, and requester VPC ID.", + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/VPCPeeringActionChallenge" + } + } + }, + "required" : true + }, + "responses" : { + "202" : { + "description" : "Accepted", + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-02-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Streams" + } + }, + "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections" : { + "get" : { + "tags" : [ "Streams" ], + "summary" : "Return All Connections Of The Stream Instances", + "description" : "Returns all connections of the stream instance for the specified project.To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role.", + "operationId" : "listStreamConnections", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "name" : "tenantName", + "in" : "path", + "description" : "Human-readable label that identifies the stream instance.", + "required" : true, + "schema" : { + "type" : "string" } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiStreamsConnectionView" + }, + "x-xgen-version" : "2023-02-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + }, + "x-xgen-owner-team" : "Atlas Streams" + }, + "post" : { + "tags" : [ "Streams" ], + "summary" : "Create One Connection", + "description" : "Creates one connection for a stream instance in the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Stream Processing Owner role.", + "operationId" : "createStreamConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "name" : "tenantName", + "in" : "path", + "description" : "Human-readable label that identifies the stream instance.", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "description" : "Details to create one connection for a streams instance in the specified project.", + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsConnection" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsConnection" + }, + "x-xgen-version" : "2023-02-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "409" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." }, - "security": [ - { - "DigestAuth": [] + "x-xgen-owner-team" : "Atlas Streams" + } + }, + "/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections" : { + "get" : { + "tags" : [ "Streams" ], + "summary" : "Return All Private Link", + "description" : "Returns all Private Link connections for the specified project.To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role.", + "operationId" : "listPrivateLinkConnections", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiStreamsPrivateLinkView" + }, + "x-xgen-version" : "2023-02-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-changelog" : { + "2024-10-02" : "The MongoDB Atlas Streams Processing Private Link API is now exposed as part of private preview, but is subject to change until GA." + }, + "x-xgen-owner-team" : "Atlas Streams" + }, + "post" : { + "tags" : [ "Streams" ], + "summary" : "Create One Private Link connection", + "description" : "Creates one Private Link in the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Stream Processing Owner role.", + "operationId" : "createPrivateLinkConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "description" : "Details to create one Private Link connection for a project. project.", + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsPrivateLinkConnection" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsPrivateLinkConnection" + }, + "x-xgen-version" : "2023-02-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "409" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" } - ], - "x-xgen-owner-team": "IAM" + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-changelog" : { + "2024-10-02" : "The MongoDB Atlas Streams Processing Private Link API is now exposed as part of private preview, but is subject to change until GA." + }, + "x-xgen-owner-team" : "Atlas Streams" } }, - "/api/atlas/v2/federationSettings/{federationSettingsId}/identityProviders/{identityProviderId}/jwks": { - "delete": { - "tags": ["Federated Authentication"], - "summary": "Revoke the JWKS from One OIDC Identity Provider", - "description": "Revokes the JWKS tokens from the requested OIDC identity provider. To use this resource, the requesting API Key must have the Organization Owner role in one of the connected organizations. \n\n**Note**: Revoking your JWKS tokens immediately refreshes your IdP public keys from all your Atlas clusters, invalidating previously signed access tokens and logging out all users. You may need to restart your MongoDB clients. All organizations connected to the identity provider will be affected. To learn more, see [Configure OIDC Authorization](https://www.mongodb.com/docs/atlas/security-oidc/#revoke-jwks).", - "operationId": "revokeJwksFromIdentityProvider", - "parameters": [ - { - "$ref": "#/components/parameters/federationSettingsId" - }, - { - "name": "identityProviderId", - "in": "path", - "description": "Unique 24-hexadecimal digit string that identifies the identity provider to connect.", - "required": true, - "schema": { - "type": "string", - "example": "32b6e34b3d91647abb20e7b8" + "/api/atlas/v2/groups/{groupId}/streams" : { + "get" : { + "tags" : [ "Streams" ], + "summary" : "Return All Project Stream Instances", + "description" : "Returns all stream instances for the specified project.", + "operationId" : "listStreamInstances", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiStreamsTenantView" + }, + "x-xgen-version" : "2023-02-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + }, + "x-xgen-owner-team" : "Atlas Streams" + }, + "post" : { + "tags" : [ "Streams" ], + "summary" : "Create One Stream Instance", + "description" : "Creates one stream instance in the specified project. To use this resource, the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role.", + "operationId" : "createStreamInstance", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "description" : "Details to create one streams instance in the specified project.", + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsTenant" + } } - }, - { - "$ref": "#/components/parameters/envelope" + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsTenant" + }, + "x-xgen-version" : "2023-02-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + }, + "x-xgen-owner-team" : "Atlas Streams" + } + }, + "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}" : { + "get" : { + "tags" : [ "Streams" ], + "summary" : "Return One Stream Connection", + "description" : "Returns the details of one stream connection within the specified stream instance. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "getStreamConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "name" : "tenantName", + "in" : "path", + "description" : "Human-readable label that identifies the stream instance to return.", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "connectionName", + "in" : "path", + "description" : "Human-readable label that identifies the stream connection to return.", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsConnection" + }, + "x-xgen-version" : "2023-02-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + }, + "x-xgen-owner-team" : "Atlas Streams" + }, + "delete" : { + "tags" : [ "Streams" ], + "summary" : "Delete One Stream Connection", + "description" : "Delete one connection of the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role.", + "operationId" : "deleteStreamConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "name" : "tenantName", + "in" : "path", + "description" : "Human-readable label that identifies the stream instance.", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "connectionName", + "in" : "path", + "description" : "Human-readable label that identifies the stream connection.", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "202" : { + "description" : "Accepted", + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-02-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + }, + "x-xgen-owner-team" : "Atlas Streams" + }, + "patch" : { + "tags" : [ "Streams" ], + "summary" : "Update One Stream Connection", + "description" : "Update one connection for the specified stream instance in the specified project. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role.", + "operationId" : "updateStreamConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "name" : "tenantName", + "in" : "path", + "description" : "Human-readable label that identifies the stream instance.", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "connectionName", + "in" : "path", + "description" : "Human-readable label that identifies the stream connection.", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "description" : "Details to update one connection for a streams instance in the specified project.", + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsConnection" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsConnection" + }, + "x-xgen-version" : "2023-02-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + }, + "x-xgen-owner-team" : "Atlas Streams" + } + }, + "/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections/{connectionId}" : { + "get" : { + "tags" : [ "Streams" ], + "summary" : "Return One PrivateLink Connection", + "description" : "Returns the details of one Private Link connection within the project. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "getPrivateLinkConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "name" : "connectionId", + "in" : "path", + "description" : "Unique ID that identifies the Private Link connection.", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsPrivateLinkConnection" + }, + "x-xgen-version" : "2023-02-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-changelog" : { + "2024-10-02" : "The MongoDB Atlas Streams Processing Private Link API is now exposed as part of private preview, but is subject to change until GA." + }, + "x-xgen-owner-team" : "Atlas Streams" + }, + "delete" : { + "tags" : [ "Streams" ], + "summary" : "Delete One Private Link connection", + "description" : "Deletes one Private Link in the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Stream Processing Owner role.", + "operationId" : "deletePrivateLinkConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "name" : "connectionId", + "in" : "path", + "description" : "Unique ID that identifies the Private Link connection.", + "required" : true, + "schema" : { + "type" : "string" } - ], - "responses": { - "204": { - "description": "No Response", - "content": { - "application/vnd.atlas.2023-11-15+json": { - "x-xgen-version": "2023-11-15" + } ], + "responses" : { + "202" : { + "description" : "Accepted", + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-02-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-changelog" : { + "2024-10-02" : "The MongoDB Atlas Streams Processing Private Link API is now exposed as part of private preview, but is subject to change until GA." + }, + "x-xgen-owner-team" : "Atlas Streams" + } + }, + "/api/atlas/v2/groups/{groupId}/streams/{tenantName}" : { + "get" : { + "tags" : [ "Streams" ], + "summary" : "Return One Stream Instance", + "description" : "Returns the details of one stream instance within the specified project. To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role.", + "operationId" : "getStreamInstance", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "name" : "tenantName", + "in" : "path", + "description" : "Human-readable label that identifies the stream instance to return.", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "includeConnections", + "in" : "query", + "description" : "Flag to indicate whether connections information should be included in the stream instance.", + "schema" : { + "type" : "boolean" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsTenant" + }, + "x-xgen-version" : "2023-02-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + }, + "x-xgen-owner-team" : "Atlas Streams" + }, + "delete" : { + "tags" : [ "Streams" ], + "summary" : "Delete One Stream Instance", + "description" : "Delete one stream instance in the specified project. To use this resource, the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role.", + "operationId" : "deleteStreamInstance", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "name" : "tenantName", + "in" : "path", + "description" : "Human-readable label that identifies the stream instance to delete.", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "202" : { + "description" : "Accepted", + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-02-01" + } + } + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + }, + "x-xgen-owner-team" : "Atlas Streams" + }, + "patch" : { + "tags" : [ "Streams" ], + "summary" : "Update One Stream Instance", + "description" : "Update one stream instance in the specified project. To use this resource, the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role.", + "operationId" : "updateStreamInstance", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "name" : "tenantName", + "in" : "path", + "description" : "Human-readable label that identifies the stream instance to update.", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "description" : "Details of the new data process region to update in the streams instance.", + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsDataProcessRegion" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsTenant" + }, + "x-xgen-version" : "2023-02-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + }, + "x-xgen-owner-team" : "Atlas Streams" + } + }, + "/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}" : { + "delete" : { + "tags" : [ "Streams" ], + "summary" : "Deletes an incoming VPC Peering connection.", + "description" : "Deletes an incoming VPC Peering connection.", + "operationId" : "deleteVPCPeeringConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "name" : "id", + "in" : "path", + "description" : "The VPC Peering Connection id.", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "202" : { + "description" : "Accepted", + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-02-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Streams" + } + }, + "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs" : { + "get" : { + "tags" : [ "Streams" ], + "summary" : "Download Audit Logs for One Atlas Stream Processing Instance", + "description" : "Downloads the audit logs for the specified Atlas Streams Processing instance. By default, logs cover periods of 30 days. To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: \"Accept: application/vnd.atlas.YYYY-MM-DD+gzip\".", + "operationId" : "downloadStreamTenantAuditLogs", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$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 stream instance.", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-02-01+gzip" : { + "schema" : { + "type" : "string", + "description" : "Compressed archive labeled `auditLogs.gz` downloads", + "format" : "binary" + }, + "x-xgen-version" : "2023-02-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Streams" + } + }, + "/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections" : { + "get" : { + "tags" : [ "Streams" ], + "summary" : "Return All VPC Peering Connections.", + "description" : "Returns a list of incoming VPC Peering Connections.", + "operationId" : "getVPCPeeringConnections", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "x-xgen-version" : "2023-02-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Streams" + } + }, + "/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:reject" : { + "post" : { + "tags" : [ "Streams" ], + "summary" : "Requests the rejection of an incoming VPC Peering connection.", + "description" : "Requests the rejection of an incoming VPC Peering connection.", + "operationId" : "rejectVPCPeeringConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "name" : "id", + "in" : "path", + "description" : "The VPC Peering Connection id.", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "202" : { + "description" : "Accepted", + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-02-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Streams" + } + }, + "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor" : { + "post" : { + "tags" : [ "Streams" ], + "summary" : "Create One Stream Processor", + "description" : "Create one Stream Processor within the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role.", + "operationId" : "createStreamProcessor", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "name" : "tenantName", + "in" : "path", + "description" : "Human-readable label that identifies the stream instance.", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "description" : "Details to create an Atlas Streams Processor.", + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsProcessor" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsProcessor" + }, + "x-xgen-version" : "2024-05-30" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "409" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Streams" + } + }, + "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}" : { + "get" : { + "tags" : [ "Streams" ], + "summary" : "Get One Stream Processor", + "description" : "Get one Stream Processor within the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role.", + "operationId" : "getStreamProcessor", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "name" : "tenantName", + "in" : "path", + "description" : "Human-readable label that identifies the stream instance.", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "processorName", + "in" : "path", + "description" : "Human-readable label that identifies the stream processor.", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsProcessorWithStats" + }, + "x-xgen-version" : "2024-05-30" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Streams" + }, + "delete" : { + "tags" : [ "Streams" ], + "summary" : "Delete One Stream Processor", + "description" : "Delete a Stream Processor within the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role.", + "operationId" : "deleteStreamProcessor", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "name" : "tenantName", + "in" : "path", + "description" : "Human-readable label that identifies the stream instance.", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "processorName", + "in" : "path", + "description" : "Human-readable label that identifies the stream processor.", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "This endpoint does not return a response body.", + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "x-xgen-version" : "2024-05-30" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Streams" + } + }, + "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processors" : { + "get" : { + "tags" : [ "Streams" ], + "summary" : "Return All Stream Processors In The Stream Instance.", + "description" : "Returns all Stream Processors within the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role.", + "operationId" : "listStreamProcessors", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "name" : "tenantName", + "in" : "path", + "description" : "Human-readable label that identifies the stream instance.", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiStreamsStreamProcessorWithStatsView" + }, + "x-xgen-version" : "2024-05-30" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Streams" + } + }, + "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:start" : { + "post" : { + "tags" : [ "Streams" ], + "summary" : "Start One Stream Processor", + "description" : "Start a Stream Processor within the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role.", + "operationId" : "startStreamProcessor", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "name" : "tenantName", + "in" : "path", + "description" : "Human-readable label that identifies the stream instance.", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "processorName", + "in" : "path", + "description" : "Human-readable label that identifies the stream processor.", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2024-05-30" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Streams" + } + }, + "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:stop" : { + "post" : { + "tags" : [ "Streams" ], + "summary" : "Stop One Stream Processor", + "description" : "Stop a Stream Processor within the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role.", + "operationId" : "stopStreamProcessor", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "name" : "tenantName", + "in" : "path", + "description" : "Human-readable label that identifies the stream instance.", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "processorName", + "in" : "path", + "description" : "Human-readable label that identifies the stream processor.", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2024-05-30" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Streams" + } + }, + "/api/atlas/v2/groups/{groupId}/streams:withSampleConnections" : { + "post" : { + "tags" : [ "Streams" ], + "summary" : "Create One Stream Instance With Sample Connections", + "description" : "Creates one stream instance in the specified project with sample connections. To use this resource the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role.", + "operationId" : "createStreamInstanceWithSampleConnections", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "description" : "Details to create one streams instance in the specified project.", + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantWithSampleConnections" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsTenant" + }, + "x-xgen-version" : "2024-08-05" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Streams" + } + }, + "/api/atlas/v2" : { + "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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/SystemStatus" + }, + "x-xgen-version" : "2023-01-01" } } }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/notFound" + "401" : { + "description" : "Unauthorized.", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiError" + } + } + } }, - "500": { - "$ref": "#/components/responses/internalServerError" + "500" : { + "$ref" : "#/components/responses/internalServerError" } }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "apix" } }, - "/api/atlas/v2/groups/{groupId}/auditLog": { - "get": { - "tags": ["Auditing"], - "summary": "Return the 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 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" + "/api/atlas/v2/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.\n\n 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.\n\n To use this resource, the requesting 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudAppUser" + } + } }, - { - "$ref": "#/components/parameters/pretty" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/AuditLog" + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudAppUser" }, - "x-xgen-version": "2023-01-01" + "x-xgen-version" : "2023-01-01" } } }, - "404": { - "$ref": "#/components/responses/notFound" + "401" : { + "$ref" : "#/components/responses/unauthorized" }, - "500": { - "$ref": "#/components/responses/internalServerError" + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" } }, - "security": [ - { - "DigestAuth": [] + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + } + }, + "/api/atlas/v2/users/{userId}" : { + "get" : { + "tags" : [ "MongoDB Cloud Users" ], + "summary" : "Return One MongoDB Cloud User using Its 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 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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string" } - ], - "x-xgen-owner-team": "IAM" - }, - "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 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" + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudAppUser" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" }, - { - "$ref": "#/components/parameters/groupId" + "404" : { + "$ref" : "#/components/responses/notFound" }, - { - "$ref": "#/components/parameters/pretty" + "500" : { + "$ref" : "#/components/responses/internalServerError" } - ], - "requestBody": { - "description": "Updated auditing configuration for the specified project.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/AuditLog" + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + } + }, + "/api/atlas/v2/users/byName/{userName}" : { + "get" : { + "tags" : [ "MongoDB Cloud Users" ], + "summary" : "Return One MongoDB Cloud User using Their 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 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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudAppUser" + }, + "x-xgen-version" : "2023-01-01" } } }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/AuditLog" + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "IAM" + } + }, + "/api/atlas/v2/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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TargetOrgRequest" + } + } + }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TargetOrg" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Migrations" + }, + "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.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-01-01" + } + } + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Migrations" + } + }, + "/api/atlas/v2/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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/LiveImportAvailableProject" + } }, - "x-xgen-version": "2023-01-01" + "x-xgen-version" : "2023-01-01" } } }, - "400": { - "$ref": "#/components/responses/badRequest" + "400" : { + "$ref" : "#/components/responses/badRequest" }, - "404": { - "$ref": "#/components/responses/notFound" + "404" : { + "$ref" : "#/components/responses/notFound" }, - "500": { - "$ref": "#/components/responses/internalServerError" + "500" : { + "$ref" : "#/components/responses/internalServerError" } }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Migrations" } }, - "/api/atlas/v2/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 API Key must have the Organization Read Only role or higher.", - "operationId": "listProjects", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" + "/api/atlas/v2/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/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveMigrationResponse" + }, + "x-xgen-version" : "2023-01-01" + } + } }, - { - "$ref": "#/components/parameters/includeCount" + "401" : { + "$ref" : "#/components/responses/unauthorized" }, - { - "$ref": "#/components/parameters/itemsPerPage" + "403" : { + "$ref" : "#/components/responses/forbidden" }, - { - "$ref": "#/components/parameters/pageNum" + "404" : { + "$ref" : "#/components/responses/notFound" }, - { - "$ref": "#/components/parameters/pretty" + "500" : { + "$ref" : "#/components/responses/internalServerError" } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedAtlasGroupView" - }, - "x-xgen-version": "2023-01-01" + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Migrations" + } + }, + "/api/atlas/v2/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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "example" : "507f1f77bcf86cd799439011" + } + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveImportValidation" + }, + "x-xgen-version" : "2023-01-01" } } }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "400": { - "$ref": "#/components/responses/badRequest" + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Migrations" + } + }, + "/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover" : { + "put" : { + "tags" : [ "Cloud Migration Service" ], + "summary" : "Cut Over the 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" : { + "description" : "Accepted.", + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + } }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - }, - "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 API Key must have the Read Write role.", - "operationId": "createProject", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" + "400" : { + "$ref" : "#/components/responses/badRequest" }, - { - "$ref": "#/components/parameters/pretty" + "401" : { + "$ref" : "#/components/responses/unauthorized" }, - { - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "requestBody": { - "description": "Creates one project.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/Group" - } + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Migrations" + } + }, + "/api/atlas/v2/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.\n\n Please make sure to [validate](#tag/Cloud-Migration-Service/operation/validateMigration) your migration before initiating it.\n\n 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.\n\n **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/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveMigrationRequest20240530" + }, + "x-xgen-version" : "2024-05-30" + }, + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveMigrationRequest" + }, + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2025-05-30" } }, - "required": true + "required" : true }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/Group" + "responses" : { + "201" : { + "description" : "Created", + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveMigrationResponse" + }, + "x-xgen-version" : "2024-05-30" + }, + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveMigrationResponse" }, - "x-xgen-version": "2023-01-01" + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2025-05-30" } } }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" + "400" : { + "$ref" : "#/components/responses/badRequest" }, - "403": { - "$ref": "#/components/responses/forbidden" + "401" : { + "$ref" : "#/components/responses/unauthorized" }, - "404": { - "$ref": "#/components/responses/notFound" + "403" : { + "$ref" : "#/components/responses/forbidden" }, - "409": { - "$ref": "#/components/responses/conflict" + "404" : { + "$ref" : "#/components/responses/notFound" }, - "500": { - "$ref": "#/components/responses/internalServerError" + "500" : { + "$ref" : "#/components/responses/internalServerError" } }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Migrations" } }, - "/api/atlas/v2/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 API Key must have the Project Read Only role.", - "operationId": "getProject", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" + "/api/atlas/v2/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/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveMigrationRequest20240530" + }, + "x-xgen-version" : "2024-05-30" + }, + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveMigrationRequest" + }, + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2025-05-30" + } }, - { - "$ref": "#/components/parameters/pretty" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/Group" + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveImportValidation" }, - "x-xgen-version": "2023-01-01" + "x-xgen-version" : "2024-05-30" + }, + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LiveImportValidation" + }, + "x-xgen-version" : "2023-01-01", + "x-sunset" : "2025-05-30" } } }, - "404": { - "$ref": "#/components/responses/notFound" + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "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" + "500" : { + "$ref" : "#/components/responses/internalServerError" } }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" + "security" : [ { + "DigestAuth" : [ ] + } ], + "x-xgen-owner-team" : "Atlas Migrations" + } + } + }, + "components" : { + "schemas" : { + "RequestAccepted" : { + "type" : "object", + "description" : "Accepted" + }, + "ObjectCreated" : { + "type" : "object", + "description" : "Created" + }, + "NoBody" : { + "type" : "object", + "description" : "Endpoint does not return a response body." }, - "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 API Key must have the Project Owner role.", - "operationId": "deleteProject", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/pretty" + "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." + }, + "EventTypeDetails" : { + "title" : "Event type details", + "type" : "object", + "properties" : { + "alertable" : { + "type" : "boolean", + "description" : "Whether or not this event type can be configured as an alert via the API.", + "readOnly" : true + }, + "description" : { + "type" : "string", + "description" : "Description of the event type.", + "readOnly" : true + }, + "eventType" : { + "type" : "string", + "description" : "Enum representation of the event type.", + "readOnly" : true + } + }, + "description" : "A singular type of event" + }, + "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" + } + } + }, + "PaginatedEventTypeDetailsResponse" : { + "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/EventTypeDetails" + } + }, + "totalCount" : { + "minimum" : 0, + "type" : "integer", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "format" : "int32", + "readOnly" : true + } + } + }, + "AlertAudit" : { + "title" : "Alert Audits", + "required" : [ "created", "eventTypeName", "id" ], + "type" : "object", + "properties" : { + "alertId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "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 + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AlertAuditTypeView" + }, + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "default" : false + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "format" : "email", + "readOnly" : true + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "example" : "test.user@mongodb.com" + } + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "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 + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AlertConfigAuditTypeView" + }, + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "default" : false + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "format" : "email", + "readOnly" : true + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "example" : "test.user@mongodb.com" + } + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "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 + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ApiUserEventTypeViewForNdsGroup" + }, + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "default" : false + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "format" : "email", + "readOnly" : true, + "example" : "test.user@mongodb.com" + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "example" : "test.user@mongodb.com" + } + }, + "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 + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AppServiceEventTypeView" + }, + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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." + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "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 + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AutomationConfigEventTypeView" + }, + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "default" : false + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "format" : "email", + "readOnly" : true, + "example" : "test.user@mongodb.com" + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "example" : "test.user@mongodb.com" + } + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "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 + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/BillingEventTypeViewForNdsGroup" + }, + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "invoiceId" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "default" : false + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "format" : "email", + "readOnly" : true, + "example" : "test.user@mongodb.com" + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "example" : "test.user@mongodb.com" + } + }, + "description" : "Billing event identifies different activities related to billing, payment or financial status change of an organization." + }, + "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 + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ClusterEventTypeViewForNdsGroup" + }, + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "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 + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "default" : false + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "format" : "email", + "readOnly" : true, + "example" : "test.user@mongodb.com" + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "example" : "test.user@mongodb.com" + } + }, + "description" : "Data Explorer accessed event tracks different data operations via Data Explorer interactions." + }, + "DataMetricEventView" : { + "required" : [ "created", "eventTypeName", "id" ], + "type" : "object", + "properties" : { + "apiKeyId" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "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 + }, + "currentValue" : { + "$ref" : "#/components/schemas/DataMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "default" : false + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "format" : "email", + "readOnly" : true, + "example" : "test.user@mongodb.com" + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "example" : "test.user@mongodb.com" + } + } + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "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 + }, + "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_AGGREGATE", "CLUSTER_CONNECTION_CREATE_COLLECTION", "CLUSTER_CONNECTION_SAMPLE_COLLECTION_FIELD_NAMES" ] + }, { + "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_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" ] + }, { + "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" ] + }, { + "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" : "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" ] + }, { + "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", "AGENT_VERSION_FIXED", "AGENT_VERSION_UNFIXED", "FIXED_VERSION_UPDATED", "FIXED_AGENT_VERSION_UPDATED", "CLUSTER_FCV_DOWNGRADED", "CLUSTER_BINARY_VERSION_DOWNGRADED", "CLUSTER_BINARY_VERSION_UPGRADED" ] + } ] + }, + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "default" : false + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "format" : "email", + "readOnly" : true, + "example" : "test.user@mongodb.com" + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "example" : "test.user@mongodb.com" + } + }, + "description" : "Other events which don't have extra details beside of basic one." + }, + "EventViewForNdsGroup" : { + "type" : "object", + "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/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" + } ] + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "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 + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/FTSIndexAuditTypeView" + }, + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "default" : false + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "format" : "email", + "readOnly" : true + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "example" : "test.user@mongodb.com" + } + }, + "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 + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroup" + }, + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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`.", + "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_ENOUGH_DISK_SPACE", "HOST_NOT_ENOUGH_DISK_SPACE" ] + }, + "HostEventViewForNdsGroup" : { + "title" : "Host Events", + "required" : [ "created", "eventTypeName", "id" ], + "type" : "object", + "properties" : { + "apiKeyId" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "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 + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroup" + }, + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "default" : false + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "format" : "email", + "readOnly" : true, + "example" : "test.user@mongodb.com" + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "example" : "test.user@mongodb.com" + } + }, + "description" : "Host event identifies different activities about mongod host." + }, + "HostMetricEvent" : { + "title" : "Host Metric Events", + "required" : [ "created", "eventTypeName", "id" ], + "type" : "object", + "properties" : { + "apiKeyId" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "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 + }, + "currentValue" : { + "$ref" : "#/components/schemas/HostMetricValue" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "default" : false + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "format" : "email", + "readOnly" : true, + "example" : "test.user@mongodb.com" + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "example" : "test.user@mongodb.com" + } + }, + "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_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_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, + "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 + }, + "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_SSL_ROTATED", "CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER", "CLUSTER_INSTANCE_SSL_REVOKED", "RELOAD_SSL_ON_PROCESSES", "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", "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", "MOVE_SKIPPED", "PROXY_RESTARTED", "PROXY_PANICKED", "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", "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", "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", "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", "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", "CLUSTER_FORCE_RECONFIG_REQUESTED", "PROJECT_BYPASSED_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" ] + }, + "NDSAuditViewForNdsGroup" : { + "title" : "NDS Audits", + "required" : [ "created", "eventTypeName", "id" ], + "type" : "object", + "properties" : { + "apiKeyId" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "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 + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "default" : false + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "format" : "email", + "readOnly" : true + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "example" : "test.user@mongodb.com" + }, + "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" ] + }, + "NDSAutoScalingAuditViewForNdsGroup" : { + "title" : "NDS Auto Scaling Audits", + "required" : [ "created", "eventTypeName", "id" ], + "type" : "object", + "properties" : { + "apiKeyId" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "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 + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSAutoScalingAuditTypeViewForNdsGroup" + }, + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "default" : false + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "format" : "email", + "readOnly" : true + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "example" : "test.user@mongodb.com" + } + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "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 + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/NDSServerlessInstanceAuditTypeView" + }, + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "default" : false + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "format" : "email", + "readOnly" : true + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "example" : "test.user@mongodb.com" + } + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "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 + }, + "endpointId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "default" : false + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "format" : "email", + "readOnly" : true + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "example" : "test.user@mongodb.com" + } + }, + "description" : "NDS tenant endpoint audit indicates when atlas auto-scaling cluster tier up or down." + }, + "NumberMetricEventView" : { + "required" : [ "created", "eventTypeName", "id" ], + "type" : "object", + "properties" : { + "apiKeyId" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "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 + }, + "currentValue" : { + "$ref" : "#/components/schemas/NumberMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "default" : false + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "format" : "email", + "readOnly" : true, + "example" : "test.user@mongodb.com" + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "example" : "test.user@mongodb.com" + } + } + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "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 + }, + "currentValue" : { + "$ref" : "#/components/schemas/RawMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "default" : false + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "format" : "email", + "readOnly" : true, + "example" : "test.user@mongodb.com" + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "example" : "test.user@mongodb.com" + } + } + }, + "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" ] + }, + "ResourceEventTypeView" : { + "title" : "Resource Event Types", + "type" : "string", + "description" : "Unique identifier of event type.", + "example" : "TAGS_MODIFIED", + "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ] + }, + "ResourceEventViewForNdsGroup" : { + "title" : "Resource Events", + "required" : [ "created", "eventTypeName", "id", "resourceType" ], + "type" : "object", + "properties" : { + "apiKeyId" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "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 + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ResourceEventTypeView" + }, + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "default" : false + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "format" : "email", + "readOnly" : true, + "example" : "test.user@mongodb.com" + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "example" : "test.user@mongodb.com" + } + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "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 + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/SearchDeploymentAuditTypeView" + }, + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "default" : false + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "format" : "email", + "readOnly" : true + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "example" : "test.user@mongodb.com" + } + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "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 + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ServiceAccountEventTypeViewForNdsGroup" + }, + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "default" : false + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "format" : "email", + "readOnly" : true, + "example" : "test.user@mongodb.com" + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "example" : "test.user@mongodb.com" + } + }, + "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" ] + }, + "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 + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/StreamProcessorEventTypeViewForNdsGroup" + }, + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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 + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/StreamsEventTypeViewForNdsGroup" + }, + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "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 + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/TeamEventTypeViewForNdsGroup" + }, + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "default" : false + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "format" : "email", + "readOnly" : true, + "example" : "test.user@mongodb.com" + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "example" : "test.user@mongodb.com" + } + }, + "description" : "Team event identifies different activities around organization teams." + }, + "TimeMetricEventView" : { + "required" : [ "created", "eventTypeName", "id" ], + "type" : "object", + "properties" : { + "apiKeyId" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "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 + }, + "currentValue" : { + "$ref" : "#/components/schemas/TimeMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" + }, + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "default" : false + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "format" : "email", + "readOnly" : true, + "example" : "test.user@mongodb.com" + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "example" : "test.user@mongodb.com" + } + } + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "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 + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/UserEventTypeViewForNdsGroup" + }, + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "default" : false + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "format" : "email", + "readOnly" : true, + "example" : "test.user@mongodb.com" + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "example" : "test.user@mongodb.com" + } + }, + "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" + }, + "alertConfigId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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 + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "readOnly" : true, + "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 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_AGGREGATE", "CLUSTER_CONNECTION_CREATE_COLLECTION", "CLUSTER_CONNECTION_SAMPLE_COLLECTION_FIELD_NAMES" ] + }, { + "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_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" : "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" ] + }, { + "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" ] + }, { + "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_ENOUGH_DISK_SPACE", "HOST_NOT_ENOUGH_DISK_SPACE" ] + }, { + "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_SSL_ROTATED", "CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER", "CLUSTER_INSTANCE_SSL_REVOKED", "RELOAD_SSL_ON_PROCESSES", "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", "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", "MOVE_SKIPPED", "PROXY_RESTARTED", "PROXY_PANICKED", "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", "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", "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", "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", "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", "CLUSTER_FORCE_RECONFIG_REQUESTED", "PROJECT_BYPASSED_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" ] + }, { + "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" ] + }, { + "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" ] + }, { + "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" : "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" ] + }, { + "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", "AGENT_VERSION_FIXED", "AGENT_VERSION_UNFIXED", "FIXED_VERSION_UPDATED", "FIXED_AGENT_VERSION_UPDATED", "CLUSTER_FCV_DOWNGRADED", "CLUSTER_BINARY_VERSION_DOWNGRADED", "CLUSTER_BINARY_VERSION_UPGRADED" ] + }, { + "title" : "Resource Event Types", + "type" : "string", + "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ] + } ] + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "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 + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ApiUserEventTypeViewForOrg" + }, + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "default" : false + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "format" : "email", + "readOnly" : true, + "example" : "test.user@mongodb.com" + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "example" : "test.user@mongodb.com" + } + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "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 + }, + "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" ] + }, + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "default" : false + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "format" : "email", + "readOnly" : true + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the resource policy.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "userId" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "example" : "test.user@mongodb.com" + } + }, + "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", "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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "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 + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/BillingEventTypeViewForOrg" + }, + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "invoiceId" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "default" : false + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "format" : "email", + "readOnly" : true, + "example" : "test.user@mongodb.com" + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "example" : "test.user@mongodb.com" + } + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "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 + }, + "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" ] + }, { + "title" : "Support Event Types", + "type" : "string", + "enum" : [ "SUPPORT_EMAILS_SENT_SUCCESSFULLY", "SUPPORT_EMAILS_SENT_FAILURE" ] + } ] + }, + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "default" : false + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "format" : "email", + "readOnly" : true, + "example" : "test.user@mongodb.com" + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "example" : "test.user@mongodb.com" + } + }, + "description" : "Other events which don't have extra details beside of basic one." + }, + "EventViewForOrg" : { + "type" : "object", + "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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "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 + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "default" : false + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "format" : "email", + "readOnly" : true + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "example" : "test.user@mongodb.com" + }, + "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", "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" ] + }, + "OrgEventViewForOrg" : { + "title" : "Org Events", + "required" : [ "created", "eventTypeName", "id" ], + "type" : "object", + "properties" : { + "apiKeyId" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "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 + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/OrgEventTypeViewForOrg" + }, + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "invoiceId" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "default" : false + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "format" : "email", + "readOnly" : true, + "example" : "test.user@mongodb.com" + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "example" : "test.user@mongodb.com" + } + }, + "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`.", + "format" : "int32", + "readOnly" : true + } + } + }, + "ResourceEventTypeViewForOrg" : { + "title" : "Resource Event Types", + "type" : "string", + "description" : "Unique identifier of event type.", + "example" : "GROUP_TAGS_MODIFIED", + "enum" : [ "GROUP_TAGS_MODIFIED" ] + }, + "ResourceEventViewForOrg" : { + "title" : "Resource Events", + "required" : [ "created", "eventTypeName", "id", "resourceType" ], + "type" : "object", + "properties" : { + "apiKeyId" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "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 + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ResourceEventTypeViewForOrg" + }, + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "default" : false + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "format" : "email", + "readOnly" : true, + "example" : "test.user@mongodb.com" + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "example" : "test.user@mongodb.com" + } + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "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 + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ServiceAccountEventTypeViewForOrg" + }, + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "default" : false + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "format" : "email", + "readOnly" : true, + "example" : "test.user@mongodb.com" + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "example" : "test.user@mongodb.com" + } + }, + "description" : "Service Account event identifies different activities around user api keys." + }, + "TeamEvent" : { + "title" : "Team Events", + "required" : [ "created", "eventTypeName", "id" ], + "type" : "object", + "properties" : { + "apiKeyId" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "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 + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/TeamEventTypeView" + }, + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "default" : false + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "format" : "email", + "readOnly" : true, + "example" : "test.user@mongodb.com" + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "example" : "test.user@mongodb.com" + } + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "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 + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/UserEventTypeViewForOrg" + }, + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "default" : false + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "format" : "email", + "readOnly" : true, + "example" : "test.user@mongodb.com" + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "example" : "test.user@mongodb.com" + } + }, + "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", "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", "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" ] + }, { + "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" ] + }, { + "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" : [ "GROUP_TAGS_MODIFIED" ] + }, { + "title" : "Atlas Resource Policy Audit Types", + "type" : "string", + "enum" : [ "RESOURCE_POLICY_CREATED", "RESOURCE_POLICY_MODIFIED", "RESOURCE_POLICY_DELETED" ] + } ] + }, + "AlertViewForNdsGroup" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/AppServiceAlertView" + }, { + "$ref" : "#/components/schemas/ClusterAlertView" + }, { + "$ref" : "#/components/schemas/HostAlertViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/HostMetricAlert" + }, { + "$ref" : "#/components/schemas/ReplicaSetAlertViewForNdsGroup" + }, { + "$ref" : "#/components/schemas/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.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value.", + "format" : "date-time" + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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 + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/AppServiceEventTypeViewAlertable" + }, + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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 + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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 + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "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 + } + }, + "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" ] + }, + "ClusterAlertView" : { + "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.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value.", + "format" : "date-time" + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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 + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ClusterEventTypeViewAlertable" + }, + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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 + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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 + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "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 + } + }, + "description" : "Cluster alert notifies different activities and conditions about cluster of mongod hosts." + }, + "ClusterEventTypeViewAlertable" : { + "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.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value.", + "format" : "date-time" + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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 + }, + "currentValue" : { + "$ref" : "#/components/schemas/DataMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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 + }, + "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`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**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" + }, + "orgId" : { + "maxLength" : 24, + "minLength" : 24, + "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 + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "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 + } + } + }, + "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.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value.", + "format" : "date-time" + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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 + }, + "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_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" ] + }, { + "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" ] + }, { + "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" : "User Event Types", + "type" : "string", + "enum" : [ "JOINED_GROUP", "REMOVED_FROM_GROUP", "USER_ROLES_CHANGED_AUDIT" ] + }, { + "title" : "Resource Event Types", + "type" : "string", + "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ] + }, { + "title" : "Stream Processor Event Types", + "type" : "string", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ] + }, { + "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" ] + } ] + }, + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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 + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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 + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "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 + } + }, + "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.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value.", + "format" : "date-time" + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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 + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroupAlertable" + }, + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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 + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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 + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "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 + } + }, + "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_NOT_ENOUGH_DISK_SPACE" ] + }, + "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.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value.", + "format" : "date-time" + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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 + }, + "currentValue" : { + "$ref" : "#/components/schemas/HostMetricValue" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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 + }, + "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`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**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" + }, + "orgId" : { + "maxLength" : 24, + "minLength" : 24, + "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 + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "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 + } + }, + "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_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_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.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value.", + "format" : "date-time" + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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 + }, + "currentValue" : { + "$ref" : "#/components/schemas/NumberMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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 + }, + "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`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**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" + }, + "orgId" : { + "maxLength" : 24, + "minLength" : 24, + "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 + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "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 + } + } + }, + "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`.", + "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.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value.", + "format" : "date-time" + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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 + }, + "currentValue" : { + "$ref" : "#/components/schemas/RawMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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 + }, + "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`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**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" + }, + "orgId" : { + "maxLength" : 24, + "minLength" : 24, + "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 + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "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 + } + } + }, + "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.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value.", + "format" : "date-time" + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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 + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertable" + }, + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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 + }, + "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, + "items" : { + "maxLength" : 32, + "minLength" : 8, + "pattern" : "^([a-f0-9]{8,32})$", + "type" : "string", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + } + }, + "orgId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 64, + "minLength" : 1, + "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 + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "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 + } + }, + "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" ] + }, + "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.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value.", + "format" : "date-time" + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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 + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroupAlertable" + }, + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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 + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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 + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "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 + } + }, + "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.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value.", + "format" : "date-time" + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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 + }, + "currentValue" : { + "$ref" : "#/components/schemas/TimeMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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 + }, + "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`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**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" + }, + "orgId" : { + "maxLength" : 24, + "minLength" : 24, + "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 + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "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 + } + } + }, + "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.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value.", + "format" : "date-time" + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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 + }, + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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 + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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 + }, + "status" : { + "type" : "string", + "description" : "State of this alert at the time you requested its details.", + "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 + } + }, + "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." + }, + "AcknowledgeAlert" : { + "title" : "Acknowledge Alert", + "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.", + "format" : "date-time" + }, + "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." + }, + "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" + } + }, + "unacknowledgeAlert" : { + "type" : "boolean", + "description" : "Flag that indicates to unacknowledge a previously acknowledged alert. By default this value is set to false. If set to true, it will override the acknowledgedUntil parameter." + } + }, + "description" : "Acknowledging an alert prevents successive notifications. Specify the acknowledgeUntil date and optional comment or unacknowledgeAlert boolean." + }, + "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.", + "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.", + "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 + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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.", + "items" : { + "$ref" : "#/components/schemas/AppServiceMetricMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "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 + } + }, + "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 + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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.", + "items" : { + "$ref" : "#/components/schemas/AppServiceMetricMatcher" + } + }, + "metricThreshold" : { + "$ref" : "#/components/schemas/AppServiceMetricThreshold" + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "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 + } + }, + "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.", + "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" + } + } + }, + "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 + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/GreaterThanRawThreshold" + }, + "updated" : { + "type" : "string", + "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 + } + }, + "description" : "Billing threshold alert configuration allows to select thresholds for bills and invoices which trigger alerts and how users are notified." + }, + "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 + }, + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project.", + "default" : false + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ClusterEventTypeViewAlertable" + }, + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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.", + "items" : { + "$ref" : "#/components/schemas/ClusterMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "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 + } + }, + "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" ] + }, + "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 + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "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 + } + }, + "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." + }, + "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\"`.\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" : "****************************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\"`.\n\nTo learn more about Datadog's regions, see Datadog Sites.", + "default" : "US", + "enum" : [ "US", "EU", "US3", "US5", "AP1" ] + }, + "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.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "format" : "int32" + }, + "notifierId" : { + "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." + }, + "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 + }, + "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_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" : "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" ] + }, { + "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" ] + }, { + "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", "GROUP_TAGS_MODIFIED" ] + }, { + "title" : "Stream Processor Event Types", + "type" : "string", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ] + }, { + "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" ] + } ] + }, + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "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 + } + }, + "description" : "Other alerts which don't have extra details beside of basic one." + }, + "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:\n\n- specific MongoDB Cloud users (`\"notifications.[n].typeName\" : \"USER\"`)\n- MongoDB Cloud users with specific project roles (`\"notifications.[n].typeName\" : \"GROUP\"`)\n- MongoDB Cloud users with specific organization roles (`\"notifications.[n].typeName\" : \"ORG\"`)\n- MongoDB Cloud teams (`\"notifications.[n].typeName\" : \"TEAM\"`)\n\nTo 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.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "format" : "int32" + }, + "notifierId" : { + "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 + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "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 + } + }, + "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" ] + }, + "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 + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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.", + "items" : { + "$ref" : "#/components/schemas/ReplicaSetMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/GreaterThanRawThreshold" + }, + "updated" : { + "type" : "string", + "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 + } + } + }, + "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", + "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/StreamProcessorAlertConfigViewForNdsGroup" + } ] + }, + "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:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "intervalMin" : { + "minimum" : 5, + "type" : "integer", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "format" : "int32" + }, + "notifierId" : { + "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](https://dochub.mongodb.org/core/atlas-org-roles) or [project roles](https://dochub.mongodb.org/core/atlas-proj-roles) that receive the configured alert. The resource requires this parameter 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.", + "items" : { + "type" : "string", + "description" : "One organization or project role that receive the configured alert.", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_WRITE", "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "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:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "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.\n\nPagerDuty, 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.\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" : "************************************1234" + }, + "notifierId" : { + "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 + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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.", + "items" : { + "$ref" : "#/components/schemas/HostMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "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 + } + }, + "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 + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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.", + "items" : { + "$ref" : "#/components/schemas/HostMatcher" + } + }, + "metricThreshold" : { + "$ref" : "#/components/schemas/HostMetricThreshold" + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "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 + } + }, + "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.", + "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/RawMetricThresholdView", + "ASSERT_WARNING" : "#/components/schemas/RawMetricThresholdView", + "ASSERT_MSG" : "#/components/schemas/RawMetricThresholdView", + "ASSERT_USER" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_CMD" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_QUERY" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_DELETE" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_INSERT" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_REPL_CMD" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_REPL_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_REPL_DELETE" : "#/components/schemas/RawMetricThresholdView", + "OPCOUNTER_REPL_INSERT" : "#/components/schemas/RawMetricThresholdView", + "FTS_MEMORY_RESIDENT" : "#/components/schemas/DataMetricThresholdView", + "FTS_MEMORY_VIRTUAL" : "#/components/schemas/DataMetricThresholdView", + "FTS_MEMORY_MAPPED" : "#/components/schemas/DataMetricThresholdView", + "FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricThresholdView", + "NORMALIZED_FTS_PROCESS_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "NORMALIZED_FTS_PROCESS_CPU_KERNEL" : "#/components/schemas/RawMetricThresholdView", + "SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricThresholdView", + "MEMORY_RESIDENT" : "#/components/schemas/DataMetricThresholdView", + "MEMORY_VIRTUAL" : "#/components/schemas/DataMetricThresholdView", + "MEMORY_MAPPED" : "#/components/schemas/DataMetricThresholdView", + "COMPUTED_MEMORY" : "#/components/schemas/DataMetricThresholdView", + "INDEX_COUNTERS_BTREE_ACCESSES" : "#/components/schemas/RawMetricThresholdView", + "INDEX_COUNTERS_BTREE_HITS" : "#/components/schemas/RawMetricThresholdView", + "INDEX_COUNTERS_BTREE_MISSES" : "#/components/schemas/RawMetricThresholdView", + "INDEX_COUNTERS_BTREE_MISS_RATIO" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_LOCK_PERCENTAGE" : "#/components/schemas/RawMetricThresholdView", + "BACKGROUND_FLUSH_AVG" : "#/components/schemas/TimeMetricThresholdView", + "CONNECTIONS" : "#/components/schemas/RawMetricThresholdView", + "CONNECTIONS_MAX" : "#/components/schemas/RawMetricThresholdView", + "CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_ACCESSES_NOT_IN_MEMORY" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_LOCK_CURRENT_QUEUE_READERS" : "#/components/schemas/RawMetricThresholdView", + "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS" : "#/components/schemas/RawMetricThresholdView", + "CURSORS_TOTAL_OPEN" : "#/components/schemas/RawMetricThresholdView", + "CURSORS_TOTAL_TIMED_OUT" : "#/components/schemas/RawMetricThresholdView", + "CURSORS_TOTAL_CLIENT_CURSORS_SIZE" : "#/components/schemas/RawMetricThresholdView", + "NETWORK_BYTES_IN" : "#/components/schemas/DataMetricThresholdView", + "NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricThresholdView", + "NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "OPLOG_MASTER_TIME" : "#/components/schemas/TimeMetricThresholdView", + "OPLOG_MASTER_TIME_ESTIMATED_TTL" : "#/components/schemas/TimeMetricThresholdView", + "OPLOG_SLAVE_LAG_MASTER_TIME" : "#/components/schemas/TimeMetricThresholdView", + "OPLOG_MASTER_LAG_TIME_DIFF" : "#/components/schemas/TimeMetricThresholdView", + "OPLOG_RATE_GB_PER_HOUR" : "#/components/schemas/DataMetricThresholdView", + "EXTRA_INFO_PAGE_FAULTS" : "#/components/schemas/RawMetricThresholdView", + "DB_STORAGE_TOTAL" : "#/components/schemas/DataMetricThresholdView", + "DB_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricThresholdView", + "DB_DATA_SIZE_TOTAL_WO_SYSTEM" : "#/components/schemas/DataMetricThresholdView", + "DB_INDEX_SIZE_TOTAL" : "#/components/schemas/DataMetricThresholdView", + "JOURNALING_COMMITS_IN_WRITE_LOCK" : "#/components/schemas/RawMetricThresholdView", + "JOURNALING_MB" : "#/components/schemas/DataMetricThresholdView", + "JOURNALING_WRITE_DATA_FILES_MB" : "#/components/schemas/DataMetricThresholdView", + "TICKETS_AVAILABLE_READS" : "#/components/schemas/RawMetricThresholdView", + "TICKETS_AVAILABLE_WRITES" : "#/components/schemas/RawMetricThresholdView", + "CACHE_USAGE_DIRTY" : "#/components/schemas/DataMetricThresholdView", + "CACHE_USAGE_USED" : "#/components/schemas/DataMetricThresholdView", + "CACHE_BYTES_READ_INTO" : "#/components/schemas/DataMetricThresholdView", + "CACHE_BYTES_WRITTEN_FROM" : "#/components/schemas/DataMetricThresholdView", + "NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricThresholdView", + "DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricThresholdView", + "DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "FTS_DISK_UTILIZATION" : "#/components/schemas/DataMetricThresholdView", + "MUNIN_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_NICE" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_SYSTEM" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_IOWAIT" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_IRQ" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_SOFTIRQ" : "#/components/schemas/RawMetricThresholdView", + "MUNIN_CPU_STEAL" : "#/components/schemas/RawMetricThresholdView", + "DOCUMENT_RETURNED" : "#/components/schemas/RawMetricThresholdView", + "DOCUMENT_INSERTED" : "#/components/schemas/RawMetricThresholdView", + "DOCUMENT_UPDATED" : "#/components/schemas/RawMetricThresholdView", + "DOCUMENT_DELETED" : "#/components/schemas/RawMetricThresholdView", + "OPERATIONS_SCAN_AND_ORDER" : "#/components/schemas/RawMetricThresholdView", + "QUERY_EXECUTOR_SCANNED" : "#/components/schemas/RawMetricThresholdView", + "QUERY_EXECUTOR_SCANNED_OBJECTS" : "#/components/schemas/RawMetricThresholdView", + "OPERATION_THROTTLING_REJECTED_OPERATIONS" : "#/components/schemas/RawMetricThresholdView", + "OPERATIONS_QUERIES_KILLED" : "#/components/schemas/RawMetricThresholdView", + "QUERY_TARGETING_SCANNED_PER_RETURNED" : "#/components/schemas/RawMetricThresholdView", + "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED" : "#/components/schemas/RawMetricThresholdView", + "AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "LOGICAL_SIZE" : "#/components/schemas/DataMetricThresholdView", + "RESTARTS_IN_LAST_HOUR" : "#/components/schemas/RawMetricThresholdView", + "SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricThresholdView", + "SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricThresholdView", + "SWAP_USAGE_USED" : "#/components/schemas/DataMetricThresholdView", + "SWAP_USAGE_FREE" : "#/components/schemas/DataMetricThresholdView", + "SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricThresholdView", + "SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricThresholdView", + "MAX_NORMALIZED_SYSTEM_CPU_USER" : "#/components/schemas/RawMetricThresholdView", + "MAX_NORMALIZED_SYSTEM_CPU_STEAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_SPACE_USED_DATA" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_SPACE_USED_INDEX" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_SPACE_USED_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_READ_IOPS_DATA" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_READ_IOPS_INDEX" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_READ_IOPS_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_IOPS_DATA" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_IOPS_INDEX" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_IOPS_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_READ_LATENCY_DATA" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_READ_LATENCY_INDEX" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_READ_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_LATENCY_DATA" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_LATENCY_INDEX" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_WRITE_LATENCY_JOURNAL" : "#/components/schemas/TimeMetricThresholdView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_DATA" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_INDEX" : "#/components/schemas/RawMetricThresholdView", + "MAX_DISK_PARTITION_QUEUE_DEPTH_JOURNAL" : "#/components/schemas/RawMetricThresholdView", + "MAX_SYSTEM_MEMORY_PERCENT_USED" : "#/components/schemas/RawMetricThresholdView", + "MAX_SYSTEM_MEMORY_USED" : "#/components/schemas/DataMetricThresholdView", + "MAX_SYSTEM_MEMORY_AVAILABLE" : "#/components/schemas/DataMetricThresholdView", + "MAX_SWAP_USAGE_USED" : "#/components/schemas/DataMetricThresholdView", + "MAX_SWAP_USAGE_FREE" : "#/components/schemas/DataMetricThresholdView", + "MAX_SYSTEM_NETWORK_IN" : "#/components/schemas/DataMetricThresholdView", + "MAX_SYSTEM_NETWORK_OUT" : "#/components/schemas/DataMetricThresholdView", + "SEARCH_INDEX_SIZE" : "#/components/schemas/DataMetricThresholdView", + "SEARCH_NUMBER_OF_FIELDS_IN_INDEX" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_REPLICATION_LAG" : "#/components/schemas/TimeMetricThresholdView", + "SEARCH_MAX_NUMBER_OF_LUCENE_DOCS" : "#/components/schemas/NumberMetricThresholdView", + "SEARCH_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_NUMBER_OF_QUERIES_TOTAL" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_NUMBER_OF_QUERIES_ERROR" : "#/components/schemas/RawMetricThresholdView", + "SEARCH_NUMBER_OF_QUERIES_SUCCESS" : "#/components/schemas/RawMetricThresholdView", + "FTS_JVM_MAX_MEMORY" : "#/components/schemas/DataMetricThresholdView", + "FTS_JVM_CURRENT_MEMORY" : "#/components/schemas/DataMetricThresholdView" + } + } + }, + "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 + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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.", + "items" : { + "$ref" : "#/components/schemas/ReplicaSetMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "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 + } + } + }, + "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" ] + }, + "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.\n\nPagerDuty, 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.\n\n**NOTE**: When you view or edit the alert for a Microsoft Teams notification, the URL appears partially redacted.", + "example" : "https://webhook.com/****" + }, + "notifierId" : { + "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." + }, + "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 + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "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 + } + }, + "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" ] + }, + "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" + } + } + }, + "Operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "<", ">" ] + }, + "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.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "format" : "int32" + }, + "notifierId" : { + "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.\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" : "********************************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:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "intervalMin" : { + "minimum" : 5, + "type" : "integer", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "format" : "int32" + }, + "notifierId" : { + "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](https://dochub.mongodb.org/core/atlas-org-roles) or [project roles](https://dochub.mongodb.org/core/atlas-proj-roles) that receive the configured alert. The resource requires this parameter 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.", + "items" : { + "type" : "string", + "description" : "One organization or project role that receive the configured alert.", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_WRITE", "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "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:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "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.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "format" : "int32" + }, + "notifierId" : { + "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.\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" : "****************************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`.", + "format" : "int32", + "readOnly" : true + } + } + }, + "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 + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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.", + "items" : { + "$ref" : "#/components/schemas/ReplicaSetMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "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 + } + }, + "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" ] + }, + "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 + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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.", + "items" : { + "$ref" : "#/components/schemas/ReplicaSetMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "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 + } + }, + "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" + } + } + }, + "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.\n\nPagerDuty, 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" : { + "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." + }, + "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 + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "metricThreshold" : { + "$ref" : "#/components/schemas/ServerlessMetricThreshold" + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "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 + } + }, + "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.", + "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/RawMetricThresholdView", + "SERVERLESS_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_BYTES_IN" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_CMD" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_QUERY" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_TOTAL_READ_UNITS" : "#/components/schemas/RPUMetricThresholdView", + "SERVERLESS_TOTAL_WRITE_UNITS" : "#/components/schemas/RPUMetricThresholdView", + "SERVERLESS_AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView" + } + } + }, + "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" ] + }, + "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.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "format" : "int32" + }, + "notifierId" : { + "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 + }, + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project.", + "default" : false + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/StreamProcessorEventTypeViewAlertable" + }, + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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.", + "items" : { + "$ref" : "#/components/schemas/StreamsMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "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 + } + }, + "description" : "Host metric alert configuration allows to select which Atlas streams processors trigger alerts and how users are notified." + }, + "StreamProcessorEventTypeViewAlertable" : { + "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" ] + }, + "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" ] + }, + "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:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "intervalMin" : { + "minimum" : 5, + "type" : "integer", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "format" : "int32" + }, + "notifierId" : { + "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:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "teamId" : { + "maxLength" : 24, + "minLength" : 24, + "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." + }, + "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:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "intervalMin" : { + "minimum" : 5, + "type" : "integer", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "format" : "int32" + }, + "notifierId" : { + "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:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "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.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "format" : "int32" + }, + "notifierId" : { + "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.\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" : "********************************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.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "format" : "int32" + }, + "notifierId" : { + "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.\n\nAtlas returns this value if you set `\"notifications.[n].typeName\" :\"WEBHOOK\"` and either:\n* You set `notification.[n].webhookSecret` to a non-empty string\n* You set a default webhookSecret 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)\n\n**NOTE**: When you view or edit the alert for a webhook notification, the secret appears completely redacted.", + "example" : "******" + }, + "webhookUrl" : { + "type" : "string", + "description" : "Target URL for a webhook-based alert.\n\nAtlas returns this value if you set `\"notifications.[n].typeName\" :\"WEBHOOK\"` and either:\n* You set `notification.[n].webhookURL` to a non-empty string\n* 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)\n\n**NOTE**: When you view or edit the alert for a Webhook URL notification, the URL appears partially redacted.", + "example" : "https://webhook.com/****" + } + }, + "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 + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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.", + "items" : { + "$ref" : "#/components/schemas/AlertMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationBase" + } + }, + "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 + } + }, + "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.", + "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.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "format" : "int32" + }, + "notifierId" : { + "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:\n\n- specific MongoDB Cloud users (`\"notifications.[n].typeName\" : \"USER\"`)\n- MongoDB Cloud users with specific project roles (`\"notifications.[n].typeName\" : \"GROUP\"`)\n- MongoDB Cloud users with specific organization roles (`\"notifications.[n].typeName\" : \"ORG\"`)\n- MongoDB Cloud teams (`\"notifications.[n].typeName\" : \"TEAM\"`)\n\nTo 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.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "format" : "int32" + }, + "notifierId" : { + "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." + }, + "PaginatedServiceAccountIPAccessEntryView" : { + "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/ServiceAccountIPAccessListEntry" + } + }, + "totalCount" : { + "minimum" : 0, + "type" : "integer", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "format" : "int32", + "readOnly" : true + } + } + }, + "ServiceAccountIPAccessListEntry" : { + "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 in the access list for the Service Account. This parameter requires the range to be expressed in Classless Inter-Domain Routing (CIDR) notation of Internet Protocol version 4 or version 6 addresses. You can set a value for this parameter or **ipAddress**, but not for both in the same request.", + "example" : "203.0.113.0/24" + }, + "createdAt" : { + "type" : "string", + "description" : "Date MongoDB Cloud added the entry was added to the Access List.", + "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 Service Account. This parameter requires the address to be expressed as one Internet Protocol version 4 or version 6 address. You can set a value for this parameter or **cidrBlock**, but not for both in the same request.", + "example" : "203.0.113.10" + }, + "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 makes at least one request.", + "readOnly" : true + }, + "lastUsedAt" : { + "type" : "string", + "description" : "Date when MongoDB Cloud received the most recent request that originated from this Internet Protocol version 4 or version 6 address. The resource returns this parameter when at least one request originates from this IP address. MongoDB Cloud updates this parameter each time a client accesses the permitted resource, with a delay of up to 5 minutes.", + "format" : "date-time", + "readOnly" : true + }, + "requestCount" : { + "type" : "integer", + "description" : "The number of requests that has originated from this network address.", + "format" : "int32", + "readOnly" : true + } + } + }, + "GroupServiceAccount" : { + "type" : "object", + "properties" : { + "clientId" : { + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$", + "type" : "string", + "description" : "The Client ID of the Service Account." + }, + "createdAt" : { + "type" : "string", + "description" : "The date that the Service Account was created on.", + "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 Project roles associated with the Service Account.", + "items" : { + "type" : "string", + "description" : "Project roles available for Service Accounts.", + "enum" : [ "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" ] + } + }, + "secrets" : { + "uniqueItems" : true, + "type" : "array", + "description" : "A list of secrets associated with the specified Service Account.", + "items" : { + "$ref" : "#/components/schemas/ServiceAccountSecret" + } + } + } + }, + "ServiceAccountSecret" : { + "required" : [ "createdAt", "expiresAt", "id" ], + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "description" : "The date that the secret was created on.", + "format" : "date-time", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "description" : "The date for the expiration of the secret.", + "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.", + "format" : "date-time", + "readOnly" : true + }, + "maskedSecretValue" : { + "type" : "string", + "description" : "The masked Service Account secret.", + "readOnly" : true, + "example" : "mdb_ic_sk_...12ce" + }, + "secret" : { + "pattern" : "^mdb_sa_sk_[0-9a-zA-Z_-]{40}$", + "type" : "string", + "description" : "The secret for the Service Account. It will be returned only the first time after creation.", + "readOnly" : true + } + } + }, + "GroupServiceAccountRoleAssignment" : { + "required" : [ "roles" ], + "type" : "object", + "properties" : { + "roles" : { + "uniqueItems" : true, + "type" : "array", + "description" : "The Project permissions for the Service Account in the specified Project.", + "items" : { + "type" : "string", + "description" : "Project roles available for Service Accounts.", + "enum" : [ "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" ] + } + } + } + }, + "GroupServiceAccountRequest" : { + "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" : { + "type" : "array", + "description" : "A list of project-level roles for the Service Account.", + "items" : { + "type" : "string", + "description" : "Project roles available for Service Accounts.", + "enum" : [ "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" ] + } + }, + "secretExpiresAfterHours" : { + "type" : "integer", + "description" : "The expiration time of the new Service Account secret. The expiration is provided in hours.", + "format" : "int32" + } + } + }, + "PaginatedGroupServiceAccounts" : { + "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/GroupServiceAccount" + } + }, + "totalCount" : { + "minimum" : 0, + "type" : "integer", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "format" : "int32", + "readOnly" : true + } + }, + "description" : "A list of Project Service Accounts." + }, + "GroupServiceAccountUpdateRequest" : { + "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" : { + "type" : "array", + "description" : "A list of Project roles associated with the Service Account.", + "items" : { + "type" : "string", + "description" : "Project roles available for Service Accounts.", + "enum" : [ "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" ] + } + } + } + }, + "ServiceAccountSecretRequest" : { + "required" : [ "secretExpiresAfterHours" ], + "type" : "object", + "properties" : { + "secretExpiresAfterHours" : { + "type" : "integer", + "description" : "The expiration time of the new Service Account secret. The expiration is provided in hours.", + "format" : "int32" + } + } + }, + "OrgServiceAccount" : { + "type" : "object", + "properties" : { + "clientId" : { + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$", + "type" : "string", + "description" : "The Client ID of the Service Account." + }, + "createdAt" : { + "type" : "string", + "description" : "The date that the Service Account was created on.", + "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.", + "items" : { + "type" : "string", + "description" : "Organization roles available for Service Accounts.", + "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] + } + }, + "secrets" : { + "uniqueItems" : true, + "type" : "array", + "description" : "A list of secrets associated with the specified Service Account.", + "items" : { + "$ref" : "#/components/schemas/ServiceAccountSecret" + } + } + } + }, + "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" : { + "type" : "array", + "description" : "A list of organization-level roles for the Service Account.", + "items" : { + "type" : "string", + "description" : "Organization roles available for Service Accounts.", + "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] + } + }, + "secretExpiresAfterHours" : { + "type" : "integer", + "description" : "The expiration time of the new Service Account secret. The expiration is provided in hours.", + "format" : "int32" + } + } + }, + "PaginatedServiceAccountGroup" : { + "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/ServiceAccountGroup" + } + }, + "totalCount" : { + "minimum" : 0, + "type" : "integer", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "format" : "int32", + "readOnly" : true + } + }, + "description" : "A list of projects associated with the Service Account." + }, + "ServiceAccountGroup" : { + "type" : "object", + "properties" : { + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies your project. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + } + } + }, + "PaginatedOrgServiceAccounts" : { + "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/OrgServiceAccount" + } + }, + "totalCount" : { + "minimum" : 0, + "type" : "integer", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "format" : "int32", + "readOnly" : true + } + }, + "description" : "A list of Organization Service Accounts." + }, + "OrgServiceAccountUpdateRequest" : { + "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" : { + "type" : "array", + "description" : "A list of organization-level roles for the Service Account.", + "items" : { + "type" : "string", + "description" : "Organization roles available for Service Accounts.", + "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] + } + } + } + }, + "CostExplorerFilterResponseView" : { + "type" : "object", + "properties" : { + "token" : { + "maxLength" : 64, + "minLength" : 64, + "type" : "string", + "description" : "The token used to identify the created Cost Explorer query.", + "example" : "d9ab638a801efe182f98ae3e18ea4bb47b9fda808a28a8c7de205bb0e94f7d71" + } + }, + "description" : "Response object to give information about created query." + }, + "CostExplorerFilterRequestBody" : { + "required" : [ "endDate", "startDate" ], + "type" : "object", + "properties" : { + "clusters" : { + "type" : "array", + "description" : "The list of projects to be included in the Cost Explorer Query.", + "example" : [ "5feeac500000000000000000", "61cfdfd00000000000000000" ], + "items" : { + "type" : "string" + } + }, + "endDate" : { + "type" : "string", + "description" : "The exclusive ending date for the Cost Explorer query. The date must be the start of a month.", + "format" : "date", + "example" : "2022-02-01" + }, + "groupBy" : { + "type" : "string", + "description" : "The dimension to group the returned usage results by. At least one filter value needs to be provided for a dimension to be used.", + "enum" : [ "organizations", "projects", "clusters", "services" ] + }, + "includePartialMatches" : { + "type" : "boolean", + "description" : "Flag to control whether usage that matches the filter criteria, but does not have values for all filter criteria is included in response. Default is false, which excludes the partially matching data." + }, + "organizations" : { + "type" : "array", + "description" : "The list of organizations to be included in the Cost Explorer Query.", + "example" : [ "5feeac500000000000000000", "61cfdfd00000000000000000" ], + "items" : { + "type" : "string" + } + }, + "projects" : { + "type" : "array", + "description" : "The list of projects to be included in the Cost Explorer Query.", + "example" : [ "5feeac500000000000000000", "61cfdfd00000000000000000" ], + "items" : { + "type" : "string" + } + }, + "services" : { + "type" : "array", + "description" : "The list of projects to be included in the Cost Explorer Query.", + "example" : [ "Data Transfer", "Atlas Data Federation" ], + "items" : { + "type" : "string", + "enum" : [ "Atlas", "Clusters", "Storage", "Serverless Instances", "Backup", "Data Transfer", "BI Connector", "Premium Features", "Atlas Data Federation", "Atlas Stream Processing", "App Services", "Charts", "Cloud Manager", "Cloud Manager Standard/Premium", "Legacy Backup", "Flex Consulting", "Support", "Credits" ] + } + }, + "startDate" : { + "type" : "string", + "description" : "The inclusive starting date for the Cost Explorer query. The date must be the start of a month.", + "format" : "date", + "example" : "2022-02-01" + } + }, + "description" : "Request body for a cost explorer query." + }, + "CostExplorerQueryResult" : { + "type" : "object" + }, + "PaginatedPublicApiUsageDetailsLineItemView" : { + "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/PublicApiUsageDetailsLineItemView" + } + }, + "totalCount" : { + "minimum" : 0, + "type" : "integer", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "format" : "int32", + "readOnly" : true + } + } + }, + "PublicApiUsageDetailsLineItemView" : { + "type" : "object", + "properties" : { + "billDate" : { + "type" : "string", + "description" : "Billing date of the line item.", + "format" : "date-time" + }, + "clusterName" : { + "type" : "string", + "description" : "Cluster associated with the line item." + }, + "description" : { + "type" : "string", + "description" : "Description of the line item, which can include SKU name and other identifying information." + }, + "groupId" : { + "type" : "string", + "description" : "Group id associated with the line item." + }, + "quantity" : { + "type" : "number", + "description" : "Quantity of line item in units associated with SKU.", + "format" : "double", + "readOnly" : true + }, + "totalPriceCents" : { + "type" : "integer", + "description" : "Price * quantity in applicable units, expressed as an integral number of cents.", + "format" : "int64" + }, + "unitPriceDollars" : { + "type" : "number", + "description" : "Price in units associated with the SKU for the line item.", + "format" : "double" + }, + "usageDate" : { + "type" : "string", + "description" : "Usage date of the line item.", + "format" : "date-time" + } + } + }, + "ApiPublicUsageDetailsQueryRequest" : { + "type" : "object", + "properties" : { + "filters" : { + "$ref" : "#/components/schemas/UsageDetailsFilterRequest" + }, + "sortField" : { + "type" : "string", + "description" : "Specify the field used to specify how to sort query results. Default to bill date.", + "enum" : [ "USAGE_DATES", "BILL_DATES", "TOTAL_PRICE_CENTS" ] + }, + "sortOrder" : { + "type" : "string", + "description" : "Specify the sort order (ascending / descending) used to specify how to sort query results. Defaults to descending.", + "enum" : [ "ASCENDING", "DESCENDING" ] + } + }, + "description" : "Request body for an Invoice Usage Details query with filtering, pagination, and sort." + }, + "UsageDetailsFilterRequest" : { + "type" : "object", + "properties" : { + "billEndDate" : { + "type" : "string", + "description" : "The inclusive billing start date for usage details filter.", + "format" : "date", + "example" : "2023-02-01" + }, + "billStartDate" : { + "type" : "string", + "description" : "The inclusive billing start date for usage details filter.", + "format" : "date", + "example" : "2023-02-01" + }, + "clusterIds" : { + "uniqueItems" : true, + "type" : "array", + "description" : "The list of unique cluster ids to be included in the Usage Details filter.", + "example" : [ "650d11400000000000000000", "650dd6200000000000000000" ], + "items" : { + "type" : "string" + } + }, + "groupIds" : { + "uniqueItems" : true, + "type" : "array", + "description" : "The list of groups to be included in the Usage Details filter.", + "example" : [ "650d11400000000000000000", "650dd6200000000000000000" ], + "items" : { + "type" : "string" + } + }, + "includeZeroCentLineItems" : { + "type" : "boolean", + "description" : "Whether zero cent line items should be included." + }, + "skuServices" : { + "uniqueItems" : true, + "type" : "array", + "description" : "The list of projects to be included in the Cost Explorer Query.", + "example" : [ "Atlas", "Clusters", "Storage" ], + "items" : { + "type" : "string", + "enum" : [ "Atlas", "Clusters", "Storage", "Serverless Instances", "Backup", "Data Transfer", "BI Connector", "Premium Features", "Atlas Data Federation", "Atlas Stream Processing", "App Services", "Charts", "Cloud Manager", "Cloud Manager Standard/Premium", "Legacy Backup", "Flex Consulting", "Support", "Credits" ] + } + }, + "usageEndDate" : { + "type" : "string", + "description" : "The inclusive billing start date for usage details filter.", + "format" : "date", + "example" : "2023-02-01" + }, + "usageStartDate" : { + "type" : "string", + "description" : "The inclusive usage start date for usage details filter.", + "format" : "date", + "example" : "2023-02-01" + } + }, + "description" : "Request body which contains various fields to filter line items as part of certain Invoice Usage Details queries." + }, + "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, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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, + "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, + "items" : { + "$ref" : "#/components/schemas/CloudCluster" + } + }, + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "readOnly" : true + }, + "groupName" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", + "type" : "string", + "description" : "Human-readable label that identifies the project." + }, + "orgId" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization that contains the project.", + "readOnly" : true + }, + "orgName" : { + "maxLength" : 64, + "minLength" : 1, + "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, + "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`.", + "format" : "int32", + "readOnly" : true + } + } + }, + "ExampleResourceResponse20230201" : { + "required" : [ "description" ], + "type" : "object", + "properties" : { + "additionalInfo" : { + "type" : "string", + "description" : "Dummy additional field added to the response." + }, + "data" : { + "type" : "array", + "description" : "Array that contains the dummy metadata.", + "items" : { + "type" : "string", + "description" : "Dummy data added as response." + } + }, + "description" : { + "type" : "string", + "description" : "Dummy description added as response." + }, + "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" + } + } + } + }, + "ExampleResourceResponse20230101" : { + "required" : [ "data" ], + "type" : "object", + "properties" : { + "data" : { + "type" : "string", + "description" : "Dummy data added as response." + }, + "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" + } + } + } + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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.", + "items" : { + "$ref" : "#/components/schemas/RoleAssignment" + } + } + }, + "description" : "Mapping settings that link one IdP and MongoDB Cloud." + }, + "RoleAssignment" : { + "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. Each element within **roleAssignments** can have a value for **groupId** or **orgId**, but not both.", + "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. 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.\n\nOrganization Roles\n\n* ORG_OWNER\n* ORG_MEMBER\n* ORG_GROUP_CREATOR\n* ORG_BILLING_ADMIN\n* ORG_READ_ONLY\n\nProject Roles\n\n* GROUP_CLUSTER_MANAGER\n* GROUP_DATA_ACCESS_ADMIN\n* GROUP_DATA_ACCESS_READ_ONLY\n* GROUP_DATA_ACCESS_READ_WRITE\n* GROUP_OWNER\n* GROUP_READ_ONLY\n* GROUP_SEARCH_INDEX_EDITOR\n* GROUP_STREAM_PROCESSING_OWNER\n\n", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + } + }, + "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.", + "items" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "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.", + "example" : "32b6e34b3d91647abb20e7b8" + } + }, + "domainAllowList" : { + "uniqueItems" : true, + "type" : "array", + "description" : "Approved domains that restrict users who can join the organization based on their email address.", + "items" : { + "type" : "string" + } + }, + "domainRestrictionEnabled" : { + "type" : "boolean", + "description" : "Value that indicates whether domain restriction is enabled for this connected org." + }, + "identityProviderId" : { + "maxLength" : 20, + "minLength" : 20, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_READ_ONLY" ] + } + }, + "roleMappings" : { + "uniqueItems" : true, + "type" : "array", + "description" : "Role mappings that are configured in this organization.", + "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.", + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this user.", + "readOnly" : true + } + }, + "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`.", + "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`.", + "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.", + "items" : { + "$ref" : "#/components/schemas/ConnectedOrgConfig" + } + }, + "createdAt" : { + "type" : "string", + "description" : "Date that the identity provider was created on.", + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 20, + "minLength" : 20, + "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.", + "format" : "date-time", + "readOnly" : true + } + }, + "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.", + "items" : { + "type" : "string" + } + }, + "associatedOrgs" : { + "uniqueItems" : true, + "type" : "array", + "description" : "List that contains the connected organization configurations associated with the identity provider.", + "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.", + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 20, + "minLength" : 20, + "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.", + "items" : { + "type" : "string" + } + }, + "updatedAt" : { + "type" : "string", + "description" : "Date that the identity provider was last updated on.", + "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.", + "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.", + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 20, + "minLength" : 20, + "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.", + "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.", + "items" : { + "type" : "string" + } + }, + "associatedOrgs" : { + "uniqueItems" : true, + "type" : "array", + "description" : "List that contains the connected organization configurations associated with the identity provider.", + "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.", + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 20, + "minLength" : 20, + "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.", + "enum" : [ "HTTP-POST", "HTTP-REDIRECT" ] + }, + "responseSignatureAlgorithm" : { + "type" : "string", + "description" : "Signature algorithm that Federated Authentication uses to encrypt the identity provider signature.", + "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.", + "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`.", + "format" : "int32", + "readOnly" : true + } + } + }, + "PemFileInfo" : { + "type" : "object", + "properties" : { + "certificates" : { + "type" : "array", + "description" : "List of certificates in the file.", + "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.", + "format" : "date-time" + }, + "notBefore" : { + "type" : "string", + "description" : "Earliest date that the certificate is valid.", + "format" : "date-time" + } + } + }, + "FederationOidcIdentityProvider" : { + "required" : [ "id", "oktaIdpId" ], + "type" : "object", + "properties" : { + "associatedOrgs" : { + "uniqueItems" : true, + "type" : "array", + "description" : "List that contains the connected organization configurations associated with the identity provider.", + "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.", + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 20, + "minLength" : 20, + "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.", + "format" : "date-time", + "readOnly" : true + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/FederationOidcWorkforceIdentityProvider" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkloadIdentityProvider" + } ] + }, + "FederationOidcIdentityProviderUpdate" : { + "type" : "object", + "properties" : { + "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" ] + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "maxLength" : 50, + "minLength" : 1, + "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." + }, + "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.", + "example" : "urn:idp:default" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/FederationOidcWorkforceIdentityProviderUpdate" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkloadIdentityProviderUpdate" + } ] + }, + "FederationOidcWorkforceIdentityProviderUpdate" : { + "title" : "OIDC WORKFORCE", + "type" : "object", + "properties" : { + "associatedDomains" : { + "uniqueItems" : true, + "type" : "array", + "description" : "List that contains the domains associated with the identity provider.", + "items" : { + "type" : "string" + } + }, + "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." + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "maxLength" : 50, + "minLength" : 1, + "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." + }, + "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.", + "example" : "urn:idp:default" + }, + "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.", + "items" : { + "type" : "string" + } + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + } + }, + "FederationOidcWorkloadIdentityProviderUpdate" : { + "title" : "OIDC WORKLOAD", + "type" : "object", + "properties" : { + "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" ] + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "maxLength" : 50, + "minLength" : 1, + "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." + }, + "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.", + "example" : "urn:idp:default" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + }, + "userClaim" : { + "type" : "string", + "description" : "Identifier of the claim which contains the user ID in the token." + } + } + }, + "FederationIdentityProviderUpdate" : { + "type" : "object", + "properties" : { + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "maxLength" : 50, + "minLength" : 1, + "type" : "string", + "description" : "Human-readable label that identifies the identity provider." + }, + "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.", + "example" : "urn:idp:default" + }, + "protocol" : { + "type" : "string", + "description" : "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", + "enum" : [ "SAML", "OIDC" ] + } + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/FederationSamlIdentityProviderUpdate" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkforceIdentityProviderUpdate" + }, { + "$ref" : "#/components/schemas/FederationOidcWorkloadIdentityProviderUpdate" + } ] + }, + "FederationSamlIdentityProviderUpdate" : { + "title" : "SAML", + "required" : [ "ssoDebugEnabled" ], + "type" : "object", + "properties" : { + "associatedDomains" : { + "uniqueItems" : true, + "type" : "array", + "description" : "List that contains the domains associated with the identity provider.", + "items" : { + "type" : "string" + } + }, + "description" : { + "type" : "string", + "description" : "The description of the identity provider." + }, + "displayName" : { + "maxLength" : 50, + "minLength" : 1, + "type" : "string", + "description" : "Human-readable label that identifies the identity provider." + }, + "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.", + "example" : "urn:idp:default" + }, + "pemFileInfo" : { + "$ref" : "#/components/schemas/PemFileInfoUpdate" + }, + "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.", + "enum" : [ "HTTP-POST", "HTTP-REDIRECT" ] + }, + "responseSignatureAlgorithm" : { + "type" : "string", + "description" : "Signature algorithm that Federated Authentication uses to encrypt the identity provider signature.", + "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.", + "example" : "https://example.com" + }, + "status" : { + "type" : "string", + "description" : "String enum that indicates whether the identity provider is active.", + "enum" : [ "ACTIVE", "INACTIVE" ] + } + } + }, + "PemFileInfoUpdate" : { + "type" : "object", + "properties" : { + "certificates" : { + "type" : "array", + "description" : "List of certificates in the file.", + "items" : { + "$ref" : "#/components/schemas/X509CertificateUpdate" + } + }, + "fileName" : { + "type" : "string", + "description" : "Human-readable label given to the file." + } + }, + "description" : "PEM file information for the identity provider's current certificates." + }, + "X509CertificateUpdate" : { + "type" : "object", + "properties" : { + "content" : { + "type" : "string", + "description" : "Certificate content." + }, + "notAfter" : { + "type" : "string", + "description" : "Latest date that the certificate is valid.", + "format" : "date-time" + }, + "notBefore" : { + "type" : "string", + "description" : "Earliest date that the certificate is valid.", + "format" : "date-time" + } + } + }, + "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 + } + } + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", + "type" : "string", + "description" : "Human-readable label that identifies the project included in the MongoDB Cloud organization." + }, + "orgId" : { + "maxLength" : 24, + "minLength" : 24, + "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.\n\nIn Commercial Atlas, this field will be rejected in requests and missing in responses.\n\nThis field sets restrictions on available regions in the project.\n\n| Value | Available Regions |\n|-----------------------------------|------------|\n| `COMMERCIAL_FEDRAMP_REGIONS_ONLY` | Only allows deployments in FedRAMP Moderate regions.|\n| `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" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "withDefaultAlertsSettings" : { + "type" : "boolean", + "description" : "Flag that indicates whether to create the project with default alert settings.", + "writeOnly" : 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`." + }, + "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`.", + "format" : "int32", + "readOnly" : true + } + } + }, + "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", + "dataFederation.bytesProcessed.query" : "#/components/schemas/DataFederationQueryLimit", + "dataFederation.bytesProcessed.daily" : "#/components/schemas/DataFederationQueryLimit", + "dataFederation.bytesProcessed.weekly" : "#/components/schemas/DataFederationQueryLimit", + "dataFederation.bytesProcessed.monthly" : "#/components/schemas/DataFederationQueryLimit", + "atlas.project.deployment.salesSoldM0s" : "#/components/schemas/DefaultLimit" + } + } + }, + "DataFederationQueryLimit" : { + "title" : "Data Federation 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" ] + }, + "value" : { + "type" : "integer", + "description" : "Amount to set the limit to.", + "format" : "int64" + } + }, + "description" : "Details of a query limit for Data Federation. Query limit is the limit on the amount of usage during a time period based on cost." + }, + "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." + }, + "isDataExplorerEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable the Data Explorer for the specified project." + }, + "isExtendedStorageSizesEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable extended storage sizes for the specified project." + }, + "isPerformanceAdvisorEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable the Performance Advisor and Profiler for the specified project." + }, + "isRealtimePerformancePanelEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable the Real Time Performance Panel for the specified project." + }, + "isSchemaAdvisorEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether to enable the Schema Advisor for the specified project." + } + }, + "description" : "Collection of settings that configures the project." + }, + "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.\n\nOrganization Roles\n\n* ORG_OWNER\n* ORG_MEMBER\n* ORG_GROUP_CREATOR\n* ORG_BILLING_ADMIN\n* ORG_READ_ONLY\n\nProject Roles\n\n* GROUP_CLUSTER_MANAGER\n* GROUP_DATA_ACCESS_ADMIN\n* GROUP_DATA_ACCESS_READ_ONLY\n* GROUP_DATA_ACCESS_READ_WRITE\n* GROUP_OWNER\n* GROUP_READ_ONLY\n* GROUP_SEARCH_INDEX_EDITOR\n* GROUP_STREAM_PROCESSING_OWNER\n\n", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + }, + "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." + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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." + }, + "roles" : { + "type" : "array", + "description" : "List of objects that display the MongoDB Cloud user's roles and the corresponding organization or project to which that role applies. A role can apply to one organization or one project but not both.", + "items" : { + "$ref" : "#/components/schemas/CloudAccessRoleAssignment" + } + }, + "teamIds" : { + "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, + "items" : { + "maxLength" : 24, + "minLength" : 24, + "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" + } + } + }, + "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`.", + "format" : "int32", + "readOnly" : true + } + } + }, + "ClusterIPAddresses" : { + "title" : "Cluster IP Addresses", + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "readOnly" : true + }, + "inbound" : { + "type" : "array", + "description" : "List of inbound IP addresses associated with the cluster. If your network allows outbound HTTP requests only to specific IP addresses, you must allow access to the following IP addresses so that your application can connect to your Atlas cluster.", + "readOnly" : true, + "items" : { + "type" : "string" + } + }, + "outbound" : { + "type" : "array", + "description" : "List of outbound IP addresses associated with the cluster. If your network allows inbound HTTP requests only from specific IP addresses, you must allow access from the following IP addresses so that your Atlas cluster can communicate with your webhooks and KMS.", + "readOnly" : true, + "items" : { + "type" : "string" + } } - ], - "responses": { - "204": { - "description": "This endpoint does not return a response body.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/NoBody" - }, - "x-xgen-version": "2023-01-01" - } + }, + "description" : "List of IP addresses in a cluster." + }, + "GroupIPAddresses" : { + "title" : "Group IP Address", + "type" : "object", + "properties" : { + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "services" : { + "$ref" : "#/components/schemas/GroupService" + } + }, + "description" : "List of IP addresses in a project." + }, + "GroupService" : { + "title" : "Group Service IP Addresses", + "type" : "object", + "properties" : { + "clusters" : { + "type" : "array", + "description" : "IP addresses of clusters.", + "readOnly" : true, + "items" : { + "$ref" : "#/components/schemas/ClusterIPAddresses" } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" } }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" + "description" : "List of IP addresses in a project categorized by services.", + "readOnly" : true }, - "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 API Key must have the Project Owner role.", - "operationId": "updateProject", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" + "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" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + } + }, + "description" : "Request view to update the group." + }, + "UpdateGroupRolesForUser" : { + "type" : "object", + "properties" : { + "groupRoles" : { + "uniqueItems" : true, + "type" : "array", + "description" : "One or more project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + }, + "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" + } + } + } + }, + "Datadog" : { + "title" : "DATADOG", + "required" : [ "apiKey" ], + "type" : "object", + "properties" : { + "apiKey" : { + "type" : "string", + "description" : "Key that allows MongoDB Cloud to access your Datadog account.\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" : "****************************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.\n\nTo learn more about Datadog's regions, see Datadog Sites.", + "enum" : [ "US", "EU", "US3", "US5", "AP1" ] + }, + "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.\n\n**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" : { + "maxLength" : 40, + "minLength" : 40, + "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" : { + "maxLength" : 40, + "minLength" : 40, + "pattern" : "^([0-9a-f]){40}$", + "type" : "string", + "description" : "Unique 40-hexadecimal digit string that identifies your New Relic license.\n\n**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.\nTo 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.", + "example" : "bc3768f44193c282b2688ab39e00f8e4fc8d75ea" + }, + "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.\n\n***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.\n\nTo 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.\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" : "********************************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.\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" : "****************************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`.", + "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 + }, + "serviceDiscovery" : { + "type" : "string", + "description" : "Desired method to discover the Prometheus service.", + "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.\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.\n\n**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.\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" : "********************************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.\n\n**NOTE**: When you view or edit the alert for a webhook notification, the secret appears completely redacted.", + "example" : "******" + }, + "url" : { + "type" : "string", + "description" : "Endpoint web address to which MongoDB Cloud sends notifications.\n\n**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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "groupName" : { + "maxLength" : 64, + "minLength" : 1, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + } + }, + "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.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + } + }, + "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 organization or project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + } + } + } + }, + "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`.", + "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 organization- or project-level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + } + }, + "teamId" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the team.", + "example" : "32b6e34b3d91647abb20e7b8" + } + } + }, + "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.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER", "GROUP_OWNER", "GROUP_READ_ONLY" ] + } + }, + "userId" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization API key.", + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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.", + "items" : { + "$ref" : "#/components/schemas/CloudAccessRoleAssignment" + } + } + }, + "description" : "Details of the Programmatic API Keys." + }, + "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.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "ORG_TEAM_MEMBERS_ADMIN", "GROUP_ATLAS_ADMIN", "GROUP_AUTOMATION_ADMIN", "GROUP_BACKUP_ADMIN", "GROUP_MONITORING_ADMIN", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_USER_ADMIN", "GROUP_BILLING_ADMIN", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CHARTS_ADMIN", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + } + } + }, + "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`.", + "format" : "int32", + "readOnly" : true + } + } + }, + "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.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "ORG_TEAM_MEMBERS_ADMIN", "GROUP_ATLAS_ADMIN", "GROUP_AUTOMATION_ADMIN", "GROUP_BACKUP_ADMIN", "GROUP_MONITORING_ADMIN", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_USER_ADMIN", "GROUP_BILLING_ADMIN", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_CHARTS_ADMIN", "GROUP_CLUSTER_MANAGER", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + } + } + }, + "GroupRole" : { + "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.", + "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.\n\nProject Roles\n\n* GROUP_CLUSTER_MANAGER\n* GROUP_DATA_ACCESS_ADMIN\n* GROUP_DATA_ACCESS_READ_ONLY\n* GROUP_DATA_ACCESS_READ_WRITE\n* GROUP_OWNER\n* GROUP_READ_ONLY\n* GROUP_SEARCH_INDEX_EDITOR\n* GROUP_STREAM_PROCESSING_OWNER\n\n", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + } + }, + "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.", + "items" : { + "$ref" : "#/components/schemas/GroupRole" + } + }, + "id" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + } + }, + "teamIds" : { + "uniqueItems" : true, + "type" : "array", + "description" : "List of unique 24-hexadecimal digit strings that identifies each team.", + "readOnly" : true, + "items" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the team.", + "example" : "32b6e34b3d91647abb20e7b8" + } + }, + "username" : { + "type" : "string", + "description" : "Email address of the MongoDB Cloud user invited to join the organization.", + "format" : "email" + } + } + }, + "GroupMigrationRequest" : { + "type" : "object", + "properties" : { + "destinationOrgId" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to move the specified project to.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "destinationOrgPrivateApiKey" : { + "type" : "string", + "description" : "Unique string that identifies the private part of the API Key used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.", + "example" : "55c3bbb6-b4bb-0be1-e66d20841f3e", + "externalDocs" : { + "description" : "Grant Programmatic Access to Atlas", + "url" : "https://dochub.mongodb.org/core/atlas-create-prog-api-key" + } + }, + "destinationOrgPublicApiKey" : { + "maxLength" : 8, + "minLength" : 8, + "type" : "string", + "description" : "Unique string that identifies the public part of the API Key used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.", + "example" : "zmmrboas", + "externalDocs" : { + "description" : "Grant Programmatic Access to Atlas", + "url" : "https://dochub.mongodb.org/core/atlas-create-prog-api-key" + } + } + } + }, + "OrganizationInvitationGroupRoleAssignmentsRequest" : { + "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 these roles belong.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "roles" : { + "uniqueItems" : true, + "type" : "array", + "description" : "One or more project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + } + } + } + }, + "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.", + "items" : { + "$ref" : "#/components/schemas/OrganizationInvitationGroupRoleAssignmentsRequest" + } + }, + "roles" : { + "uniqueItems" : true, + "type" : "array", + "description" : "One or more organization level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY" ] + } + }, + "teamIds" : { + "uniqueItems" : true, + "type" : "array", + "description" : "List of teams to which you want to invite the desired MongoDB Cloud user.", + "items" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the team.", + "example" : "32b6e34b3d91647abb20e7b8" + } + }, + "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.", + "items" : { + "$ref" : "#/components/schemas/OrganizationInvitationGroupRoleAssignmentsRequest" + } + }, + "roles" : { + "uniqueItems" : true, + "type" : "array", + "description" : "One or more organization level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY" ] + } + }, + "teamIds" : { + "uniqueItems" : true, + "type" : "array", + "description" : "List of teams to which you want to invite the desired MongoDB Cloud user.", + "items" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the team.", + "example" : "32b6e34b3d91647abb20e7b8" + } + } + } + }, + "ApiAtlasCheckpointView" : { + "type" : "object", + "properties" : { + "clusterId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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.\n\n- For a replica set, this array contains a single document.\n- For a sharded cluster, this array contains one document for each shard plus one document for the config host.", + "readOnly" : true, + "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`.", + "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, + "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.", + "items" : { + "$ref" : "#/components/schemas/BackupLabel" + } + }, + "exportBucketId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "enum" : [ "Cancelled", "Failed", "InProgress", "Queued", "Successful" ] + } + } + }, + "DiskBackupExportMember" : { + "type" : "object", + "properties" : { + "exportId" : { + "maxLength" : 24, + "minLength" : 24, + "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." + }, + "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.", + "items" : { + "$ref" : "#/components/schemas/BackupLabel" + } + }, + "exportBucketId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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`.", + "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" : { + "maxLength" : 22, + "minLength" : 22, + "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, + "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, + "items" : { + "$ref" : "#/components/schemas/DiskBackupRestoreMember" + } + }, + "deliveryType" : { + "type" : "string", + "description" : "Human-readable label that categorizes the restore job to create.", + "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, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" + }, + "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, + "items" : { + "$ref" : "#/components/schemas/ApiPrivateDownloadDeliveryUrl" + } + }, + "snapshotId" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "targetClusterName" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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" : { + "maxLength" : 24, + "minLength" : 24, + "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`.", + "format" : "int32", + "readOnly" : true + } + } + }, + "DiskBackupShardedClusterSnapshot" : { + "title" : "Sharded Cluster Snapshot", + "type" : "object", + "properties" : { + "configServerType" : { + "type" : "string", + "description" : "Human-readable label that identifies the config server type for this snapshot.", + "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, + "enum" : [ "hourly", "daily", "weekly", "monthly", "yearly" ] + }, + "id" : { + "maxLength" : 24, + "minLength" : 24, + "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 + }, + "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, + "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, + "items" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "items" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "enum" : [ "onDemand", "scheduled" ] + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", + "readOnly" : true, + "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, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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 + } + } + }, + "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`.", + "format" : "int32", + "readOnly" : true + } + } + }, + "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, + "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, + "enum" : [ "hourly", "daily", "weekly", "monthly", "yearly" ] + }, + "id" : { + "maxLength" : 24, + "minLength" : 24, + "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 + }, + "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, + "items" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "enum" : [ "onDemand", "scheduled" ] + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", + "readOnly" : true, + "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, + "enum" : [ "replicaSet", "shardedCluster" ] + } + }, + "description" : "Details of the replica set snapshot that MongoDB Cloud created." + }, + "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`.", + "format" : "int32", + "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, + "enum" : [ "hourly", "daily", "weekly", "monthly", "yearly" ] + }, + "id" : { + "maxLength" : 24, + "minLength" : 24, + "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 + }, + "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, + "items" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "enum" : [ "onDemand", "scheduled" ] + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", + "readOnly" : true, + "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, + "enum" : [ "replicaSet", "shardedCluster" ] + } + }, + "discriminator" : { + "propertyName" : "type", + "mapping" : { + "replicaSet" : "#/components/schemas/DiskBackupReplicaSet", + "shardedCluster" : "#/components/schemas/DiskBackupShardedClusterSnapshot" + } + } + }, + "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 + } + } + }, + "BackupRestoreJob" : { + "required" : [ "delivery" ], + "type" : "object", + "properties" : { + "batchId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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.\n\n- If you set **checkpointId**, you can't set **oplogInc**, **oplogTs**, **snapshotId**, or **pointInTimeUTCMillis**.\n- 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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "items" : { + "$ref" : "#/components/schemas/RestoreJobFileHash" + } + }, + "id" : { + "maxLength" : 24, + "minLength" : 24, + "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 + }, + "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\"`.\n\n- If you set **oplogInc**, you must set **oplogTs**, and can't set **checkpointId**, **snapshotId**, or **pointInTimeUTCMillis**.\n- 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.\n\n- If you set **oplogTs**, you must set **oplogInc**, and you can't set **checkpointId**, **snapshotId**, or **pointInTimeUTCMillis**.\n- 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](https://en.wikipedia.org/wiki/Unix_time). This timestamp must fall within the last 24 hours of the current time. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`.\n\n- 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.\n- If you set **pointInTimeUTCMillis**, you can't set **oplogInc**, **oplogTs**, **snapshotId**, or **checkpointId**.", + "format" : "int64", + "writeOnly" : true + }, + "snapshotId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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\"`.\n\n If the target cluster doesn't have backup enabled, two resources return parameters with empty values:\n\n- **Get All Snapshots** endpoint returns an empty results array without **clusterId** elements\n- **Get a Snapshot** endpoint doesn't return a **clusterId** parameter.\n\nTo return a response with the **clusterId** parameter, either use the **delivery.targetClusterName** parameter or enable backup on the target cluster.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "targetClusterName" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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\"`.\n\nIf the target cluster doesn't have backup enabled, two resources return parameters with empty values:\n\n- **Get All Snapshots** endpoint returns an empty results array without **clusterId** elements\n- **Get a Snapshot** endpoint doesn't return a **clusterId** parameter.\n\nTo return a response with the **clusterId** parameter, either use the **delivery.targetClusterName** parameter or enable backup on the target cluster." + }, + "targetGroupId" : { + "maxLength" : 24, + "minLength" : 24, + "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 + } + }, + "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`.", + "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 + }, + "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.", + "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, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" + }, + "snapshotId" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "targetClusterName" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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" : { + "maxLength" : 24, + "minLength" : 24, + "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`.", + "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, + "enum" : [ "hourly", "daily", "weekly", "monthly" ] + }, + "id" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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, + "enum" : [ "onDemand", "scheduled" ] + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", + "readOnly" : true, + "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`.", + "format" : "int32", + "readOnly" : true + } + } + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" + }, + "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.", + "format" : "date-time" + }, + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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.\n\n- For a replica set, this array contains a single document.\n- For a sharded cluster, this array contains one document for each shard plus one document for the config host.", + "readOnly" : true, + "items" : { + "$ref" : "#/components/schemas/BackupSnapshotPart" + } + } + } + }, + "BackupSnapshotPart" : { + "title" : "Snapshot Components", + "type" : "object", + "properties" : { + "clusterId" : { + "maxLength" : 24, + "minLength" : 24, + "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" + }, + "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 + }, + "fileSizeBytes" : { + "type" : "integer", + "description" : "Number that indicates the total size of the data files in bytes.", + "format" : "int64", + "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 + }, + "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 + }, + "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`.", + "format" : "int32", + "readOnly" : true + } + } + }, + "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", + "enum" : [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 40 ] + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies the frequency type associated with the backup policy.", + "enum" : [ "ondemand" ] + }, + "id" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this backup policy item.", + "readOnly" : true + }, + "retentionUnit" : { + "type" : "string", + "description" : "Unit of time in which MongoDB Cloud measures snapshot retention.", + "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.\n\nFor 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`.\n\n- 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.\n\n- 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.\n\n- In a weekly policy item, `1` indicates that the weekly Snapshot occurs on Monday and `7` indicates Sunday.\n\n- 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.\n\n MongoDB Cloud ignores this setting for non-hourly policy items in Backup Compliance Policy settings.", + "format" : "int32", + "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 40 ] + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies the frequency type associated with the backup policy.", + "enum" : [ "daily", "hourly", "weekly", "monthly", "yearly" ] + }, + "id" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this backup policy item.", + "readOnly" : true + }, + "retentionUnit" : { + "type" : "string", + "description" : "Unit of time in which MongoDB Cloud measures Snapshot retention.", + "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.\n\nFor 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." + }, + "DataProtectionSettings20231001" : { + "required" : [ "authorizedEmail", "authorizedUserFirstName", "authorizedUserLastName" ], + "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 updated the Backup Compliance Policy settings." + }, + "authorizedUserLastName" : { + "type" : "string", + "description" : "Last name of the user who authorized to updated 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 + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project for the Backup Compliance Policy.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "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.", + "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 + } + } + }, + "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 + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project for the Backup Compliance Policy.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "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.", + "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 + } + } + }, + "DiskBackupSnapshotAWSExportBucket" : { + "required" : [ "bucketName", "cloudProvider", "iamRoleId" ], + "type" : "object", + "properties" : { + "_id" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "bucketName" : { + "maxLength" : 63, + "minLength" : 3, + "type" : "string", + "description" : "Human-readable label that identifies the AWS S3 Bucket or Azure Storage Container 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 will be exported to.", + "enum" : [ "AWS", "AZURE" ] + }, + "iamRoleId" : { + "maxLength" : 24, + "minLength" : 24, + "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" + }, + "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" + } + } + } + }, + "DiskBackupSnapshotAzureExportBucket" : { + "required" : [ "bucketName", "cloudProvider", "roleId", "serviceUrl", "tenantId" ], + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/DiskBackupSnapshotExportBucket" + }, { + "type" : "object", + "properties" : { + "roleId" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Azure Service Principal that MongoDB Cloud uses to access the Azure Blob Storage Container.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "serviceUrl" : { + "maxLength" : 55, + "minLength" : 33, + "type" : "string", + "description" : "URL that identifies the blob Endpoint of the Azure Blob Storage Account.", + "example" : "https://examplestorageaccount.blob.core.windows.net" + }, + "tenantId" : { + "maxLength" : 36, + "minLength" : 36, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$", + "type" : "string", + "description" : "UUID that identifies the Azure Active Directory Tenant ID.", + "example" : "4297fc77-1592-4de8-a6d5-a8c32401df87" + } + } + } ] + }, + "DiskBackupSnapshotExportBucket" : { + "required" : [ "bucketName", "cloudProvider" ], + "type" : "object", + "properties" : { + "_id" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "bucketName" : { + "maxLength" : 63, + "minLength" : 3, + "type" : "string", + "description" : "Human-readable label that identifies the AWS S3 Bucket or Azure Storage Container 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 will be exported to.", + "enum" : [ "AWS", "AZURE" ] + }, + "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" : "Disk backup snapshot Export Bucket.", + "discriminator" : { + "propertyName" : "cloudProvider", + "mapping" : { + "AWS" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket", + "AZURE" : "#/components/schemas/DiskBackupSnapshotAzureExportBucket" + } + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" + }, { + "$ref" : "#/components/schemas/DiskBackupSnapshotAzureExportBucket" + } ] + }, + "PaginatedBackupSnapshotExportBucketsView" : { + "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/DiskBackupSnapshotExportBucket" + } + }, + "totalCount" : { + "minimum" : 0, + "type" : "integer", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "format" : "int32", + "readOnly" : true + } + } + }, + "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/DiskBackupSnapshotAWSExportBucket" + } + }, + "totalCount" : { + "minimum" : 0, + "type" : "integer", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "format" : "int32", + "readOnly" : true + } + } + }, + "AdvancedDiskBackupSnapshotSchedulePolicy" : { + "type" : "object", + "properties" : { + "id" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this backup policy." + }, + "policyItems" : { + "type" : "array", + "description" : "List that contains the specifications for one policy.", + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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.", + "enum" : [ "monthly", "yearly" ] + } + }, + "description" : "Policy for automatically exporting Cloud Backup Snapshots." + }, + "DeleteCopiedBackups20240805" : { + "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' which can be found under [Cloud Providers](https://www.mongodb.com/docs/atlas/reference/cloud-providers/) 'regions' link.", + "writeOnly" : true + }, + "zoneId" : { + "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 [Return One Cluster from One Project](#operation/getCluster).", + "writeOnly" : true + } + }, + "description" : "Deleted copy setting whose backup copies need to also be deleted.", + "writeOnly" : true + }, + "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`.\n\n- 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.\n\n- 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.\n\n- In a weekly policy item, `1` indicates that the weekly Snapshot occurs on Monday and `7` indicates Sunday.\n\n- 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.\n\n MongoDB Cloud ignores this setting for non-hourly policy items in Backup Compliance Policy settings.", + "format" : "int32", + "enum" : [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 40 ] + }, + "frequencyType" : { + "type" : "string", + "description" : "Human-readable label that identifies the frequency type associated with the backup policy.", + "enum" : [ "daily", "hourly", "weekly", "monthly", "yearly", "ondemand" ] + }, + "id" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this backup policy item.", + "readOnly" : true + }, + "retentionUnit" : { + "type" : "string", + "description" : "Unit of time in which MongoDB Cloud measures Snapshot retention.", + "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.\n\nFor 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." + }, + "DiskBackupCopySetting20240805" : { + "required" : [ "zoneId" ], + "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.", + "items" : { + "type" : "string", + "enum" : [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY", "ON_DEMAND" ] + } + }, + "regionName" : { + "type" : "string", + "description" : "Target region to copy snapshots belonging to zoneId. Please supply the 'Atlas Region' which can be found under [Cloud Providers](https://www.mongodb.com/docs/atlas/reference/cloud-providers/) 'regions' link." + }, + "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." + }, + "zoneId" : { + "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 [Return One Cluster From One Project](#operation/getCluster)." + } + }, + "description" : "Copy setting item in the desired backup policy." + }, + "DiskBackupSnapshotSchedule20240805" : { + "type" : "object", + "properties" : { + "autoExportEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether MongoDB Cloud automatically exports Cloud Backup Snapshots to the Export Bucket." + }, + "clusterId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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.", + "items" : { + "$ref" : "#/components/schemas/DiskBackupCopySetting20240805" + } + }, + "deleteCopiedBackups" : { + "type" : "array", + "description" : "List that contains a document for each deleted copy setting whose backup copies you want to delete.", + "writeOnly" : true, + "items" : { + "$ref" : "#/components/schemas/DeleteCopiedBackups20240805" + } + }, + "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.", + "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." + }, + "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' which can be found under [Cloud Providers](https://www.mongodb.com/docs/atlas/reference/cloud-providers/) 'regions' link.", + "writeOnly" : true + }, + "replicationSpecId" : { + "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 in One Project and consult the replicationSpecs array [Return One Cluster in One Project](#operation/getLegacyCluster).", + "writeOnly" : true + }, + "zoneId" : { + "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 [Return One Cluster from One Project](#operation/getCluster).", + "writeOnly" : true + } + }, + "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.", + "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' which can be found under [Cloud Providers](https://www.mongodb.com/docs/atlas/reference/cloud-providers/) 'regions' link." + }, + "replicationSpecId" : { + "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 in One Project and consult the replicationSpecs array [Return One Cluster in One Project](#operation/getLegacyCluster)." + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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.", + "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, + "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.", + "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." + } + } + }, + "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 + }, + "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" + }, + "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, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "atlasAzureAppId" : { + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$", + "type" : "string", + "description" : "Azure Active Directory Application ID of Atlas." + }, + "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, + "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" : { + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$", + "type" : "string", + "description" : "UUID string that identifies the Azure Service Principal." + }, + "tenantId" : { + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$", + "type" : "string", + "description" : "UUID String that identifies the Azure Active Directory Tenant ID." + } + } + } ] + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + } + }, + "gcpServiceAccountForAtlas" : { + "maxLength" : 82, + "minLength" : 57, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + } + } + } ] + }, + "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" + }, + "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, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "atlasAzureAppId" : { + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$", + "type" : "string", + "description" : "Azure Active Directory Application ID of Atlas." + }, + "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, + "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" : { + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$", + "type" : "string", + "description" : "UUID string that identifies the Azure Service Principal." + }, + "tenantId" : { + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$", + "type" : "string", + "description" : "UUID String that identifies the Azure Active Directory Tenant ID." + } + }, + "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, + "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" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "readOnly" : true + } + }, + "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.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessAWSIAMRole" + } + }, + "azureServicePrincipals" : { + "type" : "array", + "description" : "List that contains the Azure Service Principals registered with MongoDB Cloud.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + } + } + } + }, + "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" + }, + "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, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "atlasAzureAppId" : { + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$", + "type" : "string", + "description" : "Azure Active Directory Application ID of Atlas." + }, + "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, + "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" : { + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$", + "type" : "string", + "description" : "UUID string that identifies the Azure Service Principal." + }, + "tenantId" : { + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$", + "type" : "string", + "description" : "UUID String that identifies the Azure Active Directory Tenant ID." + } + } + } ] + }, + "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" + } + } + }, + "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, + "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, + "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`.", + "format" : "int32", + "readOnly" : true + } + } + }, + "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" + }, + "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." + }, + "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", "GLOBAL" ] + }, + "roleId" : { + "maxLength" : 24, + "minLength" : 24, + "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", "AZURE_GERMANY" ] + }, + "clientID" : { + "type" : "string", + "description" : "Unique 36-hexadecimal character string that identifies an Azure application associated with your Azure Active Directory tenant.", + "format" : "uuid" + }, + "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." + }, + "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." + }, + "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.", + "format" : "uuid" + }, + "tenantID" : { + "type" : "string", + "description" : "Unique 36-hexadecimal character string that identifies the Azure Active Directory tenant within your Azure subscription.", + "format" : "uuid" + }, + "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" + }, + "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" + }, + "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/" + } + }, + "AzureKeyVaultEARPrivateEndpoint" : { + "title" : "Azure Key Vault EAR Private Endpoint", + "type" : "object", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider for the Encryption At Rest private endpoint.", + "readOnly" : true, + "enum" : [ "AZURE" ] + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message for failures associated with the Encryption At Rest private endpoint.", + "readOnly" : true + }, + "id" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "privateEndpointConnectionName" : { + "type" : "string", + "description" : "Connection name of the Azure Private Endpoint.", + "readOnly" : true + }, + "regionName" : { + "type" : "object", + "description" : "Cloud provider region in which the Encryption At Rest private endpoint is located.", + "oneOf" : [ { + "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" ] + } ] + }, + "status" : { + "type" : "string", + "description" : "State of the Encryption At Rest private endpoint.", + "readOnly" : true, + "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "ACTIVE", "FAILED", "PENDING_RECREATION", "DELETING" ] + } + }, + "description" : "Azure Key Vault Encryption At Rest Private Endpoint." + }, + "EARPrivateEndpoint" : { + "title" : "Encryption At Rest Private Endpoint", + "type" : "object", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider for the Encryption At Rest private endpoint.", + "readOnly" : true, + "enum" : [ "AZURE" ] + }, + "errorMessage" : { + "type" : "string", + "description" : "Error message for failures associated with the Encryption At Rest private endpoint.", + "readOnly" : true + }, + "id" : { + "maxLength" : 24, + "minLength" : 24, + "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" : "object", + "description" : "Cloud provider region in which the Encryption At Rest private endpoint is located.", + "oneOf" : [ { + "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" ] + } ] + }, + "status" : { + "type" : "string", + "description" : "State of the Encryption At Rest private endpoint.", + "readOnly" : true, + "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "ACTIVE", "FAILED", "PENDING_RECREATION", "DELETING" ] + } + }, + "description" : "Encryption At Rest Private Endpoint.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AzureKeyVaultEARPrivateEndpoint" + } ] + }, + "PaginatedApiAtlasEARPrivateEndpointView" : { + "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/EARPrivateEndpoint" + } + }, + "totalCount" : { + "minimum" : 0, + "type" : "integer", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "format" : "int32", + "readOnly" : true + } + } + }, + "TenantRestore" : { + "required" : [ "snapshotId", "targetDeploymentItemName" ], + "type" : "object", + "properties" : { + "clusterName" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 64, + "minLength" : 1, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" + } + } + }, + "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`.", + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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 + }, + "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`.", + "format" : "int32", + "readOnly" : true + } + } + }, + "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", "SINGAPORE_SGP" ] + }, + "ApiAtlasDataLakeStorageView" : { + "$ref" : "#/components/schemas/DataLakeStorage" + }, + "AtlasDataFederationAzureRegion" : { + "type" : "string", + "description" : "Atlas Data Federation Azure Regions.", + "enum" : [ "VIRGINIA_USA", "AMSTERDAM_NLD" ] + }, + "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.", + "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" : { + "type" : "string", + "description" : "Unique identifier of the role that Data Federation can use to access the data stores. Required if specifying cloudProviderConfig." + }, + "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" : { + "type" : "string", + "description" : "Unique identifier of the role that Data Federation can use to access the data stores. Required if specifying cloudProviderConfig." + } + }, + "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 + }, + "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" + }, + "iamUserARN" : { + "type" : "string", + "description" : "Amazon Resource Name (ARN) of the user that the data lake assumes when accessing data stores.", + "readOnly" : true + }, + "roleId" : { + "type" : "string", + "description" : "Unique identifier of the role that the data lake can use to access the data stores.Required if specifying cloudProviderConfig." + } + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "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, + "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.", + "items" : { + "$ref" : "#/components/schemas/DataLakePipelinesPartitionField" + } + } + } + } ] + }, + "DataLakeIngestionPipeline" : { + "title" : "Data Lake Pipeline", + "type" : "object", + "properties" : { + "_id" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Data Lake Pipeline.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "createdDate" : { + "type" : "string", + "description" : "Timestamp that indicates when the Data Lake Pipeline was created.", + "format" : "date-time", + "readOnly" : true + }, + "datasetRetentionPolicy" : { + "$ref" : "#/components/schemas/DatasetRetentionPolicy" + }, + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "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.", + "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.", + "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.", + "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" + } + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/OnDemandCpsSnapshotSource" + }, { + "$ref" : "#/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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "policyItemId" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies a policy item.", + "example" : "32b6e34b3d91647abb20e7b8" + } + } + } ] + }, + "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`.", + "format" : "int32", + "readOnly" : true + } + } + }, + "IngestionPipelineRun" : { + "title" : "Data Lake Pipeline Run", + "type" : "object", + "properties" : { + "_id" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "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.", + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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.", + "format" : "date-time", + "readOnly" : true + }, + "phase" : { + "type" : "string", + "description" : "Processing phase of the Data Lake Pipeline.", + "readOnly" : true, + "enum" : [ "SNAPSHOT", "EXPORT", "INGESTION" ] + }, + "pipelineId" : { + "maxLength" : 24, + "minLength" : 24, + "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.", + "format" : "date-time", + "readOnly" : true + }, + "snapshotId" : { + "maxLength" : 24, + "minLength" : 24, + "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`.", + "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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "writeOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + } + } + }, + "BasicDBObject" : { + "type" : "object", + "additionalProperties" : { + "type" : "object" + } + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this Atlas Search index.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n| Status | Index Condition |\n |---|---|\n | IN_PROGRESS | Atlas is building or re-building the index after an edit. |\n | STEADY | You can use this search index. |\n | FAILED | Atlas could not build the index. |\n | MIGRATING | Atlas is upgrading the underlying cluster tier and migrating indexes. |\n | PAUSED | The cluster is paused. |\n", + "readOnly" : true, + "enum" : [ "IN_PROGRESS", "STEADY", "FAILED", "MIGRATING", "STALE", "PAUSED" ] + }, + "type" : { + "type" : "string", + "description" : "Type of the index. Default type is search.", + "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:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\n 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" + }, + "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" + }, + "items" : { + "$ref" : "#/components/schemas/ApiAtlasFTSAnalyzersViewManual" + } + }, + "mappings" : { + "$ref" : "#/components/schemas/ApiAtlasFTSMappingsViewManual" + }, + "searchAnalyzer" : { + "type" : "string", + "description" : "Method applied to identify words when searching this index.", + "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" + }, + "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.", + "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" : "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" : "Label that identifies the MongoDB collection that stores words and their applicable synonyms." + } + }, + "description" : "Data set that stores words and their applicable synonyms." + }, + "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" + }, + "items" : { + "$ref" : "#/components/schemas/BasicDBObject" + } + } + } + } ] + }, + "ApiSearchDeploymentResponseView" : { + "type" : "object", + "properties" : { + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" }, - { - "$ref": "#/components/parameters/pretty" - } - ], - "requestBody": { - "description": "Project to update.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/GroupUpdate" - } + "id" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the search deployment.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "specs" : { + "type" : "array", + "description" : "List of settings that configure the Search Nodes for your cluster.", + "readOnly" : true, + "items" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentSpecView" } }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/Group" - }, - "x-xgen-version": "2023-01-01" - } - } + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of this search deployment.", + "readOnly" : true, + "enum" : [ "IDLE", "PAUSED", "UPDATING" ] + } + } + }, + "ApiSearchDeploymentSpecView" : { + "required" : [ "instanceSize", "nodeCount" ], + "type" : "object", + "properties" : { + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the Search Node instance sizes.", + "enum" : [ "S20_HIGHCPU_NVME", "S30_HIGHCPU_NVME", "S40_HIGHCPU_NVME", "S50_HIGHCPU_NVME", "S60_HIGHCPU_NVME", "S70_HIGHCPU_NVME", "S80_HIGHCPU_NVME", "S30_LOWCPU_NVME", "S40_LOWCPU_NVME", "S50_LOWCPU_NVME", "S60_LOWCPU_NVME", "S70_LOWCPU_NVME", "S80_LOWCPU_NVME", "S90_LOWCPU_NVME", "S100_LOWCPU_NVME", "S110_LOWCPU_NVME", "S120_LOWCPU_NVME", "S130_LOWCPU_NVME", "S135_LOWCPU_NVME", "S140_LOWCPU_NVME" ] + }, + "nodeCount" : { + "maximum" : 32, + "minimum" : 2, + "type" : "integer", + "description" : "Number of Search Nodes in the cluster.", + "format" : "int32", + "example" : 2 + } + } + }, + "ApiSearchDeploymentRequestView" : { + "required" : [ "specs" ], + "type" : "object", + "properties" : { + "specs" : { + "maxItems" : 1, + "minItems" : 1, + "type" : "array", + "description" : "List of settings that configure the Search Nodes for your cluster.", + "items" : { + "$ref" : "#/components/schemas/ApiSearchDeploymentSpecView" + } + } + } + }, + "AtlasSearchAnalyzer" : { + "title" : "Atlas Search Analyzer", + "required" : [ "name", "tokenizer" ], + "type" : "object", + "properties" : { + "charFilters" : { + "type" : "array", + "description" : "Filters that examine text one character at a time and perform filtering operations.", + "items" : { + "$ref" : "#/components/schemas/BasicDBObject" + } + }, + "name" : { + "type" : "string", + "description" : "Name that identifies the custom analyzer. Names must be unique within an index, and must not start with any of the following strings:\n- `lucene.`\n- `builtin.`\n- `mongodb.`" + }, + "tokenFilters" : { + "type" : "array", + "description" : "Filter that performs operations such as:\n\n- Stemming, which reduces related words, such as \"talking\", \"talked\", and \"talks\" to their root word \"talk\".\n\n- Redaction, which is the removal of sensitive information from public documents.", + "items" : { + "$ref" : "#/components/schemas/BasicDBObject" + } + }, + "tokenizer" : { + "type" : "object", + "additionalProperties" : { + "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." + }, + "description" : "Tokenizer that you want to use to create tokens. Tokens determine how Atlas Search splits up text into discrete chunks for indexing." + } + } + }, + "SearchHostStatusDetail" : { + "title" : "Search Host Status Detail", + "type" : "object", + "properties" : { + "hostname" : { + "type" : "string", + "description" : "Hostname that corresponds to the status detail." }, - "400": { - "$ref": "#/components/responses/badRequest" + "mainIndex" : { + "$ref" : "#/components/schemas/SearchMainIndexStatusDetail" }, - "401": { - "$ref": "#/components/responses/unauthorized" + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on the host." }, - "403": { - "$ref": "#/components/responses/forbidden" + "stagedIndex" : { + "$ref" : "#/components/schemas/SearchStagedIndexStatusDetail" }, - "404": { - "$ref": "#/components/responses/notFound" + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + } + }, + "SearchIndexDefinition" : { + "title" : "Search Index Definition", + "type" : "object", + "description" : "The search index definition set by the user." + }, + "SearchIndexDefinitionVersion" : { + "title" : "Search Index Definition Version", + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "description" : "The time at which this index definition was created.", + "format" : "date-time" }, - "500": { - "$ref": "#/components/responses/internalServerError" + "version" : { + "type" : "integer", + "description" : "The version number associated with this index definition when it was created.", + "format" : "int64" } }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - } - }, - "/api/atlas/v2/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 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.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", - "required": true, - "schema": { - "type": "string", - "enum": [ - "atlas.project.security.databaseAccess.users", - "atlas.project.deployment.clusters", - "atlas.project.deployment.serverlessMTMs", - "atlas.project.security.databaseAccess.customRoles", - "atlas.project.security.networkAccess.entries", - "atlas.project.security.networkAccess.crossRegionEntries", - "atlas.project.deployment.nodesPerPrivateLinkRegion", - "dataFederation.bytesProcessed.query", - "dataFederation.bytesProcessed.daily", - "dataFederation.bytesProcessed.weekly", - "dataFederation.bytesProcessed.monthly", - "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", - "atlas.project.deployment.privateServiceConnectionsSubnetMask" - ] - } - }, - { - "$ref": "#/components/parameters/envelope" + "description" : "Object which includes the version number of the index definition and the time that the index definition was created." + }, + "SearchIndexResponse" : { + "title" : "Search Index Response", + "type" : "object", + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Label that identifies the collection that contains one or more Atlas Search indexes." }, - { - "$ref": "#/components/parameters/groupId" + "database" : { + "type" : "string", + "description" : "Label that identifies the database that contains the collection with one or more Atlas Search indexes." }, - { - "$ref": "#/components/parameters/pretty" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/DataFederationLimit" - }, - "x-xgen-version": "2023-01-01" - } - } + "indexID" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this Atlas Search index.", + "example" : "32b6e34b3d91647abb20e7b8" }, - "400": { - "$ref": "#/components/responses/badRequest" + "latestDefinition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" }, - "401": { - "$ref": "#/components/responses/unauthorized" + "latestDefinitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - }, - "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 API Key must have the Project Owner role.", - "operationId": "deleteProjectLimit", - "parameters": [ - { - "name": "limitName", - "in": "path", - "description": "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", - "required": true, - "schema": { - "type": "string", - "enum": [ - "atlas.project.security.databaseAccess.users", - "atlas.project.deployment.clusters", - "atlas.project.deployment.serverlessMTMs", - "atlas.project.security.databaseAccess.customRoles", - "atlas.project.security.networkAccess.entries", - "atlas.project.security.networkAccess.crossRegionEntries", - "atlas.project.deployment.nodesPerPrivateLinkRegion", - "dataFederation.bytesProcessed.query", - "dataFederation.bytesProcessed.daily", - "dataFederation.bytesProcessed.weekly", - "dataFederation.bytesProcessed.monthly", - "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", - "atlas.project.deployment.privateServiceConnectionsSubnetMask" - ] - } - }, - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/pretty" - } - ], - "responses": { - "204": { - "description": "This endpoint does not return a response body.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/NoBody" - }, - "x-xgen-version": "2023-01-01" - } - } + "name" : { + "type" : "string", + "description" : "Label that identifies this index. Within each namespace, the names of all indexes must be unique." }, - "400": { - "$ref": "#/components/responses/badRequest" + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on all hosts." }, - "404": { - "$ref": "#/components/responses/notFound" + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] }, - "409": { - "$ref": "#/components/responses/conflict" + "statusDetail" : { + "type" : "array", + "description" : "List of documents detailing index status on each host.", + "items" : { + "$ref" : "#/components/schemas/SearchHostStatusDetail" + } }, - "500": { - "$ref": "#/components/responses/internalServerError" + "type" : { + "type" : "string", + "description" : "Type of the index. The default type is search.", + "enum" : [ "search", "vectorSearch" ] } }, - "security": [ - { - "DigestAuth": [] + "discriminator" : { + "propertyName" : "type", + "mapping" : { + "search" : "#/components/schemas/TextSearchIndexResponse", + "vectorSearch" : "#/components/schemas/VectorSearchIndexResponse" } - ], - "x-xgen-owner-team": "IAM" + } }, - "patch": { - "tags": ["Projects"], - "summary": "Set One Project Limit", - "description": "Sets the specified project limit. To use this resource, the requesting API Key must have the Project Owner role.\n\n**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.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", - "required": true, - "schema": { - "type": "string", - "enum": [ - "atlas.project.security.databaseAccess.users", - "atlas.project.deployment.clusters", - "atlas.project.deployment.serverlessMTMs", - "atlas.project.security.databaseAccess.customRoles", - "atlas.project.security.networkAccess.entries", - "atlas.project.security.networkAccess.crossRegionEntries", - "atlas.project.deployment.nodesPerPrivateLinkRegion", - "dataFederation.bytesProcessed.query", - "dataFederation.bytesProcessed.daily", - "dataFederation.bytesProcessed.weekly", - "dataFederation.bytesProcessed.monthly", - "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", - "atlas.project.deployment.privateServiceConnectionsSubnetMask" - ] - } - }, - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/pretty" - } - ], - "requestBody": { - "description": "Limit to update.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/DataFederationLimit" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/DataFederationLimit" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" + "SearchMainIndexStatusDetail" : { + "title" : "Search Main Index Status Detail", + "type" : "object", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" }, - "401": { - "$ref": "#/components/responses/unauthorized" + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" }, - "404": { - "$ref": "#/components/responses/notFound" + "message" : { + "type" : "string", + "description" : "Optional message describing an error." }, - "409": { - "$ref": "#/components/responses/conflict" + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index generation is queryable on the host." }, - "500": { - "$ref": "#/components/responses/internalServerError" + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] } }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - } - }, - "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DataFederationLimit" - } - }, - "x-xgen-version": "2023-01-01" - } + "description" : "Contains status information about the active index." + }, + "SearchMappings" : { + "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/field-mapping-definition-fts#static-and-dynamic-mappings" } }, - "400": { - "$ref": "#/components/responses/badRequest" + "fields" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "One or more field specifications for the Atlas Search index. Required if **mappings.dynamic** is omitted or set to **false**.", + "externalDocs" : { + "description" : "Atlas Search Index", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "x-additionalPropertiesName" : "Field Name" + }, + "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" + }, + "x-additionalPropertiesName" : "Field Name" + } + }, + "description" : "Index specifications for the collection's fields." + }, + "SearchStagedIndexStatusDetail" : { + "title" : "Search Staged Index Status Detail", + "type" : "object", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" }, - "401": { - "$ref": "#/components/responses/unauthorized" + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" }, - "404": { - "$ref": "#/components/responses/notFound" + "message" : { + "type" : "string", + "description" : "Optional message describing an error." }, - "409": { - "$ref": "#/components/responses/conflict" + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index generation is queryable on the host." }, - "500": { - "$ref": "#/components/responses/internalServerError" + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] } }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - } - }, - "/api/atlas/v2/groups/byName/{groupName}": { - "get": { - "tags": ["Projects"], - "summary": "Return One Project using Its 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 API Key must have the Project Read Only role.", - "operationId": "getProjectByName", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" + "description" : "Contains status information about an index building in the background." + }, + "SynonymMappingStatusDetail" : { + "title" : "Synonym Mapping Status Detail", + "type" : "object", + "properties" : { + "message" : { + "type" : "string", + "description" : "Optional message describing an error." }, - { - "$ref": "#/components/parameters/pretty" + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the synonym mapping is queryable on a host." }, - { - "name": "groupName", - "in": "path", - "description": "Human-readable label that identifies this project.", - "required": true, - "schema": { - "maxLength": 64, - "minLength": 1, - "type": "string" - } + "status" : { + "type" : "string", + "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", + "enum" : [ "FAILED", "BUILDING", "READY" ] } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/Group" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "400": { - "$ref": "#/components/responses/badRequest" + }, + "description" : "Contains the status of the index's synonym mappings on each search host. This field (and its subfields) only appear if the index has synonyms defined." + }, + "SynonymMappingStatusDetailMap" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetail" + }, + "x-additionalPropertiesName" : "Synonym Mapping Name" + }, + "TextSearchHostStatusDetail" : { + "title" : "Text Search Host Status Detail", + "type" : "object", + "properties" : { + "hostname" : { + "type" : "string", + "description" : "Hostname that corresponds to the status detail." }, - "409": { - "$ref": "#/components/responses/conflict" + "mainIndex" : { + "$ref" : "#/components/schemas/TextSearchIndexStatusDetail" }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on the host." + }, + "stagedIndex" : { + "$ref" : "#/components/schemas/TextSearchIndexStatusDetail" + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] } - ], - "x-xgen-owner-team": "IAM" - } - }, - "/api/atlas/v2/groups/{groupId}/settings": { - "get": { - "tags": ["Projects"], - "summary": "Return One Project Settings", - "description": "Returns details about the specified project's settings. To use this resource, the requesting API Key must have the Project Read Only role.", - "operationId": "getProjectSettings", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" + } + }, + "TextSearchIndexDefinition" : { + "title" : "Text Search Index Definition", + "required" : [ "mappings" ], + "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 making the following changes to the text in fields:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\n MongoDB Cloud uses the process you select to build the Atlas Search index.", + "externalDocs" : { + "description" : "Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/analyzers--fts" + }, + "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" ] }, - { - "$ref": "#/components/parameters/groupId" + "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" + }, + "items" : { + "$ref" : "#/components/schemas/AtlasSearchAnalyzer" + } + }, + "mappings" : { + "$ref" : "#/components/schemas/SearchMappings" }, - { - "$ref": "#/components/parameters/pretty" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/GroupSettings" - }, - "x-xgen-version": "2023-01-01" + "searchAnalyzer" : { + "type" : "string", + "description" : "Method applied to identify words when searching this index.", + "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 Stored Source Fields.", + "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" + }, + "items" : { + "$ref" : "#/components/schemas/SearchSynonymMappingDefinition" + } + } + }, + "description" : "The text search index definition set by the user." + }, + "TextSearchIndexResponse" : { + "title" : "Text Search Index Response", + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexResponse" + }, { + "type" : "object", + "properties" : { + "latestDefinition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + }, + "statusDetail" : { + "type" : "array", + "description" : "List of documents detailing index status on each host.", + "items" : { + "$ref" : "#/components/schemas/TextSearchHostStatusDetail" + } + }, + "synonymMappingStatus" : { + "type" : "string", + "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", + "enum" : [ "FAILED", "BUILDING", "READY" ] + }, + "synonymMappingStatusDetail" : { + "type" : "array", + "description" : "A list of documents describing the status of the index's synonym mappings on each search host. Only appears if the index has synonyms defined.", + "items" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetail" + } } } + } + } ] + }, + "TextSearchIndexStatusDetail" : { + "title" : "Text Search Index Status Detail", + "type" : "object", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + }, + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" }, - "401": { - "$ref": "#/components/responses/unauthorized" + "message" : { + "type" : "string", + "description" : "Optional message describing an error." }, - "403": { - "$ref": "#/components/responses/forbidden" + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index generation is queryable on the host." }, - "404": { - "$ref": "#/components/responses/notFound" + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] }, - "500": { - "$ref": "#/components/responses/internalServerError" + "synonymMappingStatus" : { + "type" : "string", + "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", + "enum" : [ "FAILED", "BUILDING", "READY" ] + }, + "synonymMappingStatusDetail" : { + "type" : "array", + "description" : "List of synonym statuses by mapping.", + "items" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetailMap" + } } }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" + "description" : "Contains status information about a text search index." }, - "patch": { - "tags": ["Projects"], - "summary": "Update One 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 API Key must have the Project Owner role.", - "operationId": "updateProjectSettings", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" + "VectorSearchHostStatusDetail" : { + "title" : "Vector Search Host Status Detail", + "type" : "object", + "properties" : { + "hostname" : { + "type" : "string", + "description" : "Hostname that corresponds to the status detail." + }, + "mainIndex" : { + "$ref" : "#/components/schemas/VectorSearchIndexStatusDetail" }, - { - "$ref": "#/components/parameters/groupId" + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on the host." }, - { - "$ref": "#/components/parameters/pretty" + "stagedIndex" : { + "$ref" : "#/components/schemas/VectorSearchIndexStatusDetail" + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] } - ], - "requestBody": { - "description": "Settings to update.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/GroupSettings" - } + } + }, + "VectorSearchIndexDefinition" : { + "title" : "Vector Search Index Definition", + "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" + }, + "items" : { + "$ref" : "#/components/schemas/BasicDBObject" } - }, - "required": true + } }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/GroupSettings" - }, - "x-xgen-version": "2023-01-01" + "description" : "The vector search index definition set by the user." + }, + "VectorSearchIndexResponse" : { + "title" : "Vector Search Index Response", + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexResponse" + }, { + "type" : "object", + "properties" : { + "latestDefinition" : { + "$ref" : "#/components/schemas/VectorSearchIndexDefinition" + }, + "statusDetail" : { + "type" : "array", + "description" : "List of documents detailing index status on each host.", + "items" : { + "$ref" : "#/components/schemas/VectorSearchHostStatusDetail" } } + } + } ] + }, + "VectorSearchIndexStatusDetail" : { + "title" : "Vector Search Index Status Detail", + "type" : "object", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/VectorSearchIndexDefinition" }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "403": { - "$ref": "#/components/responses/forbidden" + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" }, - "404": { - "$ref": "#/components/responses/notFound" + "message" : { + "type" : "string", + "description" : "Optional message describing an error." }, - "500": { - "$ref": "#/components/responses/internalServerError" + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index generation is queryable on the host." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] } }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - } - }, - "/api/atlas/v2/groups/{groupId}/users": { - "get": { - "tags": ["Projects"], - "summary": "Return All 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 API Key must have the Project Read Only role.", - "operationId": "listProjectUsers", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" + "description" : "Contains status information about a vector search index." + }, + "SearchIndexCreateRequest" : { + "required" : [ "collectionName", "database", "name" ], + "type" : "object", + "properties" : { + "collectionName" : { + "type" : "string", + "description" : "Label that identifies the collection to create an Atlas Search index in." }, - { - "$ref": "#/components/parameters/includeCount" + "database" : { + "type" : "string", + "description" : "Label that identifies the database that contains the collection to create an Atlas Search index in." }, - { - "$ref": "#/components/parameters/itemsPerPage" + "name" : { + "type" : "string", + "description" : "Label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique." }, - { - "$ref": "#/components/parameters/pageNum" + "type" : { + "type" : "string", + "description" : "Type of the index. The default type is search.", + "enum" : [ "search", "vectorSearch" ] + } + }, + "discriminator" : { + "propertyName" : "type", + "mapping" : { + "search" : "#/components/schemas/TextSearchIndexCreateRequest", + "vectorSearch" : "#/components/schemas/VectorSearchIndexCreateRequest" + } + } + }, + "TextSearchIndexCreateRequest" : { + "required" : [ "collectionName", "database", "definition", "name" ], + "type" : "object", + "description" : "Text Search Index Create Request", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexCreateRequest" + }, { + "type" : "object", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + } + } + } ] + }, + "VectorSearchIndexCreateRequest" : { + "required" : [ "collectionName", "database", "definition", "name" ], + "type" : "object", + "description" : "Vector Search Index Create Request", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexCreateRequest" + }, { + "type" : "object", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/VectorSearchIndexDefinition" + } + } + } ] + }, + "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, + "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.", + "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." + } + } + }, + "SearchIndexUpdateRequest" : { + "title" : "Search Index Update Request", + "required" : [ "definition" ], + "type" : "object", + "properties" : { + "definition" : { + "type" : "object", + "description" : "The index definition to update the search index to.", + "oneOf" : [ { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + }, { + "$ref" : "#/components/schemas/VectorSearchIndexDefinition" + } ] + } + } + }, + "Collation" : { + "required" : [ "locale" ], + "type" : "object", + "properties" : { + "alternate" : { + "type" : "string", + "description" : "Method to handle whitespace and punctuation as base characters for purposes of comparison.\n\n| Value | Evaluate Whitespace and Punctuation as Base Characters |\n|---|---|\n| `\"non-ignorable\"` | Yes |\n| `\"shifted\"` | No. MongoDB Cloud distinguishes these characters when `\"strength\" > 3`. |\n", + "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.\n\n| Value | String Comparison Method |\n |---|---|\n| `true` | Compare from back to front. |\n| `false` | Compare from front to back. |\n", + "default" : false + }, + "caseFirst" : { + "type" : "string", + "description" : "Method to handle sort order of case differences during tertiary level comparisons.\n\n| Value | Sort Order Method |\n |---|---|\n | `\"upper\"` | Uppercase sorts before lowercase. |\n | `\"lower\"` | Lowercase sorts before uppercase. |\n | `\"off\"` | Similar to \"lower\" with slight differences. |\n", + "default" : "off", + "enum" : [ "lower", "off", "upper" ] + }, + "caseLevel" : { + "type" : "boolean", + "description" : "Flag that indicates whether to include case comparison when `\"strength\" : 1` or `\"strength\" : 2`.\n\n| Value | Compare case at level 1 or 2? | Strength Level | Comparisons Include |\n |---|---|---|---|\n | true | Yes | 1 | Base characters and case. |\n | | | 2 | Base characters, diacritics (and possible other secondary differences), and case. |\n | false | No | | |\n", + "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\"`.", + "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\"`. This has no affect if `\"alternate\" : \"non-ignorable\"`.\n\n| Value | Ignore |\n |---|---|\n| `\"punct\"` | Both whitespace and punctuation |\n| `\"space\"` | Whitespace |\n", + "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.\n\n| Value | Normalization Method |\n |---|---|\n| `true` | Yes, check if fully normalized and perform normalization to compare text. |\n| `false` | No, don't check. |\n", + "default" : false + }, + "numericOrdering" : { + "type" : "boolean", + "description" : "Flag that indicates whether to compare sequences of digits as numbers or as strings.\n\n| Value | Comparison Method |\n |---|---|\n| `true` | Compare as numbers. This results in `10 > 2`. |\n| `false` | Compare as strings. This results in `\"10\" < \"2\"`. |\n", + "default" : false + }, + "strength" : { + "maximum" : 5, + "minimum" : 1, + "type" : "integer", + "description" : "Degree of comparison to perform when sorting words. MongoDB Cloud accepts the following values:\n\n| Value | Comparison Level | Comparison Method |\n|---|---|---|\n| 1 | Primary | Compares the base characters only, ignoring other differences such as diacritics and case. |\n| 2 | Secondary | Compares base characters (primary) and diacritics (secondary). Primary differences take precedence over secondary differences. |\n| 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. |\n| 4 | Quaternary | Compares for the specific use case to consider punctuation when levels 1 through 3 ignore punctuation or for processing Japanese text. |\n| 5 | Identical | Compares for the specific use case of tie breaker. |\n", + "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, + "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", + "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.\n\nMongoDB 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:\n1 or true to include the field and recursively all fields it is a prefix of in the index\n0 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:\n1 or true to include the field and recursively all fields it is a prefix of in the index\n0 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.", + "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.", + "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:\n\n- equality (`\"parameter\" : \"value\"` or using the `$eq` operator)\n- `\"$exists\": true`\n, maximum: `$gt`, `$gte`, `$lt`, `$lte` comparisons\n- `$type`\n- `$and` (top-level only)\n 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:\n\n- equality (`\"parameter\" : \"value\"` or using the `$eq` operator)\n- `\"$exists\": true`\n, maximum: `$gt`, `$gte`, `$lt`, `$lte` comparisons\n- `$type`\n- `$and` (top-level only)\n 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`.\n\nCompound 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:\n\n- equality (`\"parameter\" : \"value\"` or using the `$eq` operator)\n- `\"$exists\": true`\n, maximum: `$gt`, `$gte`, `$lt`, `$lte` comparisons\n- `$type`\n- `$and` (top-level only)\n 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:\n\n- equality (`\"parameter\" : \"value\"` or using the `$eq` operator)\n- `\"$exists\": true`\n, maximum: `$gt`, `$gte`, `$lt`, `$lte` comparisons\n- `$type`\n- `$and` (top-level only)\n 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." + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "items" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the index.", + "example" : "32b6e34b3d91647abb20e7b8" + } + }, + "indexStatsMeasurements" : { + "type" : "array", + "description" : "List that contains the Atlas Search index stats measurements.", + "readOnly" : true, + "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, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "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, + "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, + "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, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "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, + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement" + } + } + } + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "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, + "items" : { + "$ref" : "#/components/schemas/MongoDBAccessLogs" + } + } + } + }, + "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, + "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, + "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 + }, + "namespace" : { + "type" : "string", + "description" : "Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`.", + "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, + "items" : { + "$ref" : "#/components/schemas/PerformanceAdvisorSlowQuery" + } + } + } + }, + "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, + "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 + } + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this index.", + "readOnly" : true + }, + "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, + "items" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "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, + "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](https://en.wikipedia.org/wiki/Unix_time). This parameter relates to the **since** query parameter.", + "format" : "int64", + "readOnly" : true + } + }, + "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, + "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 + } + }, + "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, + "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, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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 }, - { - "$ref": "#/components/parameters/pretty" + "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 }, - { - "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 + "operations" : { + "type" : "array", + "description" : "List that contains specific about individual queries.", + "readOnly" : true, + "items" : { + "$ref" : "#/components/schemas/PerformanceAdvisorOperationView" } + } + } + }, + "MesurementsDatabase" : { + "type" : "object", + "properties" : { + "databaseName" : { + "type" : "string", + "description" : "Human-readable label that identifies the database that the specified MongoDB process serves." }, - { - "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 + "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" } } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedAppUserView" - }, - "x-xgen-version": "2023-01-01" - } + } + }, + "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`.", + "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" } }, - "401": { - "$ref": "#/components/responses/unauthorized" + "totalCount" : { + "minimum" : 0, + "type" : "integer", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "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, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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`.", + "format" : "int32", + "readOnly" : true + } + } + }, + "MeasurementsCollStatsLatencyCluster" : { + "type" : "object", + "properties" : { + "clusterId" : { + "type" : "string", + "description" : "Unique identifier for Clusters.", + "readOnly" : true + }, + "clusterView" : { + "type" : "string", + "description" : "Cluster topology view.", + "readOnly" : true + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" + }, + "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" + } + }, + "measurements" : { + "type" : "array", + "description" : "List that contains measurements and their data points.", + "readOnly" : true, + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement" + } + }, + "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 + } + } + }, + "CollStatsRankedNamespacesView" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the request project.", + "readOnly" : true + }, + "identifierId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the request process.", + "readOnly" : true + }, + "rankedNamespaces" : { + "type" : "array", + "description" : "Ordered list of the hottest namespaces, highest value first.", + "readOnly" : true, + "items" : { + "type" : "string", + "description" : "A single namespace.", + "readOnly" : true + } + } + } + }, + "PinnedNamespaces" : { + "type" : "object", + "properties" : { + "clusterId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the request cluster.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the request project.", + "readOnly" : true + }, + "pinnedNamespaces" : { + "type" : "array", + "description" : "List of all pinned namespaces.", + "readOnly" : true, + "items" : { + "type" : "string", + "description" : "A single pinned namespace.", + "readOnly" : true + } + } + }, + "description" : "Pinned namespaces view for cluster" + }, + "NamespacesRequest" : { + "type" : "object", + "properties" : { + "namespaces" : { + "uniqueItems" : true, + "type" : "array", + "description" : "List of namespace strings (combination of database and collection) on the specified host or cluster.", + "writeOnly" : true, + "items" : { + "type" : "string", + "description" : "Human-readable label that identifies the namespace on the specified host or cluster. The resource expresses this parameter value as `.`.", + "writeOnly" : true + } + } + } + }, + "MeasurementsCollStatsLatencyHost" : { + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" + }, + "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" + } + }, + "measurements" : { + "type" : "array", + "description" : "List that contains measurements and their data points.", + "readOnly" : true, + "items" : { + "$ref" : "#/components/schemas/MetricsMeasurement" + } + }, + "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 + } + } + }, + "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" ] + } + } + } ] + }, + "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" ] + } + } + } ] + }, + "BackupOnlineArchive" : { + "type" : "object", + "properties" : { + "_id" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the online archive.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "clusterName" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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.\n\nIf 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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "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.\n\n| State | Indication |\n|-------------|------------|\n| `PENDING` | MongoDB Cloud has queued documents for archive. Archiving hasn't started. |\n| `ARCHIVING` | MongoDB Cloud started archiving documents that meet the archival criteria. |\n| `IDLE` | MongoDB Cloud waits to start the next archival job. |\n| `PAUSING` | Someone chose to stop archiving. MongoDB Cloud finishes the running archival job then changes the state to `PAUSED` when that job completes. |\n| `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. |\n| `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. |\n| `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, + "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.\n**DATE** selects documents to archive based on a date.\n**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.\n\nUse 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.\n**\"criteria.type\": \"DATE\"** selects documents to archive based on a date.\n**\"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 or Epoch timestamps. The Epoch timestamp can be expressed as nanoseconds, milliseconds, or seconds. Set this parameter when **\"criteria.type\" : \"DATE\"**.\nYou must set **\"criteria.type\" : \"DATE\"** if **\"collectionType\": \"TIMESERIES\"**.", + "default" : "ISODATE", + "enum" : [ "ISODATE", "EPOCH_SECONDS", "EPOCH_MILLIS", "EPOCH_NANOSECONDS" ] + }, + "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](http://bsonspec.org/spec.html) must be of binary subtype 4. MongoDB Cloud skips partition parameters of type UUID with subtype 3.", + "readOnly" : true, + "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" ] + } + } + } ] + }, + "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" ] + } + } + } ] + }, + "BackupOnlineArchiveCreate" : { + "required" : [ "collName", "criteria", "dbName" ], + "type" : "object", + "properties" : { + "_id" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the online archive.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "clusterName" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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.\n\nIf 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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "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.\n\n| State | Indication |\n|-------------|------------|\n| `PENDING` | MongoDB Cloud has queued documents for archive. Archiving hasn't started. |\n| `ARCHIVING` | MongoDB Cloud started archiving documents that meet the archival criteria. |\n| `IDLE` | MongoDB Cloud waits to start the next archival job. |\n| `PAUSING` | Someone chose to stop archiving. MongoDB Cloud finishes the running archival job then changes the state to `PAUSED` when that job completes. |\n| `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. |\n| `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. |\n| `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, + "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** may be selected only if **AZURE** is the Cloud service provider for the cluster and no **AWS** online archive has been created for the cluster.", + "enum" : [ "AWS", "AZURE" ] + } + }, + "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`.", + "format" : "int32", + "readOnly" : true + } + } + }, + "ControlPlaneIPAddresses" : { + "title" : "Control Plane IP Addresses", + "type" : "object", + "properties" : { + "inbound" : { + "$ref" : "#/components/schemas/InboundControlPlaneCloudProviderIPAddresses" + }, + "outbound" : { + "$ref" : "#/components/schemas/OutboundControlPlaneCloudProviderIPAddresses" + } + }, + "description" : "List of IP addresses in the Atlas control plane." + }, + "InboundControlPlaneCloudProviderIPAddresses" : { + "title" : "Inbound Control Plane IP Addresses By Cloud Provider", + "type" : "object", + "properties" : { + "aws" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "readOnly" : true, + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "readOnly" : true + } + }, + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "readOnly" : true + }, + "azure" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "readOnly" : true, + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "readOnly" : true + } + }, + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "readOnly" : true + }, + "gcp" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "readOnly" : true, + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "readOnly" : true + } + }, + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "readOnly" : true + } + }, + "description" : "List of inbound IP addresses to the Atlas control plane, categorized by cloud provider. If your application allows outbound HTTP requests only to specific IP addresses, you must allow access to the following IP addresses so that your API requests can reach the Atlas control plane.", + "readOnly" : true + }, + "OutboundControlPlaneCloudProviderIPAddresses" : { + "title" : "Outbound Control Plane IP Addresses By Cloud Provider", + "type" : "object", + "properties" : { + "aws" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "readOnly" : true, + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "readOnly" : true + } + }, + "description" : "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", + "readOnly" : true + }, + "azure" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "readOnly" : true, + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "readOnly" : true + } + }, + "description" : "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", + "readOnly" : true + }, + "gcp" : { + "type" : "object", + "additionalProperties" : { + "type" : "array", + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "readOnly" : true, + "items" : { + "type" : "string", + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "readOnly" : true + } + }, + "description" : "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", + "readOnly" : true + } + }, + "description" : "List of outbound IP addresses from the Atlas control plane, categorized by cloud provider. If your network allows inbound HTTP requests only from specific IP addresses, you must allow access from the following IP addresses so that Atlas can communicate with your webhooks and KMS.", + "readOnly" : true + }, + "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).\nWhen `\"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-" + } + } + } + }, + "BaseCloudProviderInstanceSize" : { + "type" : "object", + "description" : "Minimum instance size to which your cluster can automatically scale. MongoDB Cloud requires this parameter if `\"replicationSpecs[n].regionConfigs[m].autoScaling.compute.scaleDownEnabled\" : true`.", + "oneOf" : [ { + "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" ] + } ] + }, + "MdbAvailableVersion" : { + "type" : "object", + "properties" : { + "cloudProvider" : { + "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" ] + }, + "defaultStatus" : { + "type" : "string", + "description" : "Whether the version is the current default for the Instance Size and Cloud Provider.", + "enum" : [ "DEFAULT", "NOT_DEFAULT" ] + }, + "instanceSize" : { + "$ref" : "#/components/schemas/BaseCloudProviderInstanceSize" + }, + "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" + } + }, + "version" : { + "type" : "string", + "description" : "The MongoDB Major Version in question.", + "externalDocs" : { + "description" : "MongoDB Versioning", + "url" : "https://www.mongodb.com/docs/manual/reference/versioning/" + } + } + } + }, + "PaginatedAvailableVersionView" : { + "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/MdbAvailableVersion" + } + }, + "totalCount" : { + "minimum" : 0, + "type" : "integer", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "format" : "int32", + "readOnly" : true + } + } + }, + "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.\n\nThese 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.\n\nTo modify the CIDR block, the target project cannot have:\n\n- Any M10 or greater clusters\n- Any other VPC peering connections\n\n 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.\n\n **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", "GLOBAL", "US_GOV_WEST_1", "US_GOV_EAST_1" ] + }, + "vpcId" : { + "minLength" : 5, + "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.\n\nThese 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.\n\nTo modify the CIDR block, the target project cannot have:\n\n- Any M10 or greater clusters\n- Any other VPC peering connections\n\n 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.\n\n **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_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "UK_SOUTH", "UK_WEST", "INDIA_CENTRAL", "INDIA_WEST", "INDIA_SOUTH", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "NORWAY_EAST", "NORWAY_WEST", "UAE_CENTRAL", "QATAR_CENTRAL", "POLAND_CENTRAL", "ISRAEL_CENTRAL", "ITALY_NORTH" ] + }, + "vnetName" : { + "maxLength" : 38, + "minLength" : 38, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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.\n\nThese CIDR blocks must fall within the ranges reserved per RFC 1918. GCP further limits the block to a lower bound of the `/18` range.\n\nTo modify the CIDR block, the target project cannot have:\n\n- Any M10 or greater clusters\n- Any other VPC peering connections\n\n 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.\n\n **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" : { + "maxLength" : 26, + "minLength" : 26, + "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" : { + "maxLength" : 36, + "minLength" : 36, + "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.", + "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.", + "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" ] + } + } + } + } ] + }, + "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`.", + "format" : "int32", + "readOnly" : true + } + }, + "description" : "List of Network Peering Containers that Amazon Web Services serves." + }, + "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" + } + } + } + }, + "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.\n\n| Type | Description |\n|------------|-------------|\n| `REGION` | Simulates a cluster outage for a region.|", + "enum" : [ "REGION" ] + } + } + }, + "ClusterOutageSimulation" : { + "type" : "object", + "properties" : { + "clusterName" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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.", + "items" : { + "$ref" : "#/components/schemas/AtlasClusterOutageSimulationOutageFilter" + } + }, + "startRequestDate" : { + "type" : "string", + "description" : "Date and time when MongoDB Cloud started the regional outage simulation.", + "format" : "date-time", + "readOnly" : true, + "example" : "2022-01-01T00:00:00Z" + }, + "state" : { + "type" : "string", + "description" : "Phase of the outage simulation.\n\n| State | Indication |\n|-------------|------------|\n| `START_REQUESTED` | User has requested cluster outage simulation.|\n| `STARTING` | MongoDB Cloud is starting cluster outage simulation.|\n| `SIMULATING` | MongoDB Cloud is simulating cluster outage.|\n| `RECOVERY_REQUESTED` | User has requested recovery from the simulated outage.|\n| `RECOVERING` | MongoDB Cloud is recovering the cluster from the simulated outage.|\n| `COMPLETE` | MongoDB Cloud has completed the cluster outage simulation.|", + "readOnly" : true, + "enum" : [ "START_REQUESTED", "STARTING", "SIMULATING", "RECOVERY_REQUESTED", "RECOVERING", "COMPLETE" ] + } + } + }, + "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", "CREATE_COLLECTION", "CREATE_INDEX", "DROP_COLLECTION", "ENABLE_PROFILER", "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", "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.", + "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.", + "items" : { + "$ref" : "#/components/schemas/DatabasePrivilegeAction" + } + }, + "inheritedRoles" : { + "uniqueItems" : true, + "type" : "array", + "description" : "List of the built-in roles that this custom role inherits.", + "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.", + "items" : { + "$ref" : "#/components/schemas/DatabasePrivilegeAction" + } + }, + "inheritedRoles" : { + "uniqueItems" : true, + "type" : "array", + "description" : "List of the built-in roles that this custom role inherits.", + "items" : { + "$ref" : "#/components/schemas/DatabaseInheritedRole" + } + } + } + }, + "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.", + "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`.", + "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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project.", + "writeOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "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.", + "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.", + "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.", + "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:\n\n| Authentication Method | Parameter Needed | Parameter Value | username Format |\n|---|---|---|---|\n| AWS IAM | awsIAMType | ROLE | ARN |\n| AWS IAM | awsIAMType | USER | ARN |\n| x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |\n| OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name |\n| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |\n" + }, + "x509Type" : { + "type" : "string", + "description" : "X.509 method that MongoDB Cloud uses to authenticate the database user.\n\n- For application-managed X.509, specify `MANAGED`.\n- For self-managed X.509, specify `CUSTOMER`.\n\nUsers created with the `CUSTOMER` method require a Common Name (CN) in the **username** parameter. You must create externally authenticated users on the `$external` database.", + "default" : "NONE", + "enum" : [ "NONE", "CUSTOMER", "MANAGED" ] + } + } + }, + "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." + }, + "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.", + "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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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 + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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](https://tools.ietf.org/html/2253).", + "readOnly" : true, + "example" : "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com" + }, + "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`.", + "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`.", + "format" : "int32", + "readOnly" : true + } + } + }, + "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.\n\n| Value | Day of Week |\n|---|---|\n| `1` | Sunday |\n| `2` | Monday |\n| `3` | Tuesday |\n| `4` | Wednesday |\n| `5` | Thursday |\n| `6` | Friday |\n| `7` | Saturday |\n", + "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 + }, + "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." + } + } + }, + "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" + }, + "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, + "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", "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_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" ] + } + } + } ] + }, + "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." + }, + "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/" + } + }, + "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", "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", "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.", + "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 cluster tier auto-scaling is enabled. Set to `true` to enable cluster tier auto-scaling. If enabled, you must specify a value for **providerSettings.autoScaling.compute.maxInstanceSize** also. Set to `false` to disable cluster tier auto-scaling.", + "default" : false }, - "500": { - "$ref": "#/components/responses/internalServerError" + "scaleDownEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the cluster tier can scale down. This is required if **autoScaling.compute.enabled** is `true`. If you enable this option, specify a value for **providerSettings.autoScaling.compute.minInstanceSize**.", + "default" : false } }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - } - }, - "/api/atlas/v2/groups/{groupId}/ipAddresses": { - "get": { - "tags": ["Projects"], - "summary": "Return All IP Addresses for One Project", - "description": "Returns all IP addresses for this project. To use this resource, the requesting API Key must have the Project Read Only role.", - "operationId": "returnAllIPAddresses", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" + "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." + }, + "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, + "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/" + } + }, + "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, + "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." + }, + "ClusterFreeAutoScaling" : { + "type" : "object", + "properties" : { + "compute" : { + "title" : "Tenant", + "type" : "string", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down." + } + }, + "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`.", + "enum" : [ "AWS", "GCP", "AZURE" ] + }, + "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}**." + } + } + } ] + }, + "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" + } + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSCloudProviderSettings" + }, { + "$ref" : "#/components/schemas/AzureCloudProviderSettings" + }, { + "$ref" : "#/components/schemas/CloudGCPProviderSettings" + }, { + "$ref" : "#/components/schemas/ClusterFreeProviderSettings" + } ] + }, + "EmployeeAccessGrantView" : { + "required" : [ "expirationTime", "grantType" ], + "type" : "object", + "properties" : { + "expirationTime" : { + "type" : "string", + "description" : "Expiration date for the employee access grant.", + "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 + }, + "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.", + "format" : "date-time", + "externalDocs" : { + "description" : "Reconfiguring a Replica Set during a regional outage", + "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + } + }, + "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.\n\nWhen configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings.\n\nWhen 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" + }, + "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.", + "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.", + "format" : "date-time", + "readOnly" : true + }, + "globalClusterSelfManagedSharding" : { + "type" : "boolean", + "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen 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.\n\nWhen 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.\n\nThis 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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "id" : { + "maxLength" : 24, + "minLength" : 24, + "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.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", + "deprecated" : true, + "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.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", + "externalDocs" : { + "description" : "Available MongoDB Versions in Atlas", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/database/#which-versions-of-mongodb-do-service-clusters-use-" + } + }, + "mongoDBVersion" : { + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "type" : "string", + "description" : "Version of MongoDB that the cluster runs." + }, + "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/" + } + }, + "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 + }, + "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/" + } + }, + "name" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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.\n\nBy default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes.\n\nWhen configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads.\n\nWhen 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.\n\n- For Global Clusters, each object in the array represents one zone where MongoDB Cloud deploys your clusters nodes.\n- For non-Global sharded clusters and replica sets, the single object represents where MongoDB Cloud deploys your clusters nodes.", + "items" : { + "$ref" : "#/components/schemas/LegacyReplicationSpec" + } + }, + "rootCertType" : { + "type" : "string", + "description" : "Root Certificate Authority that MongoDB Atlas clusters 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 the current operating condition of the cluster.", + "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" + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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.\n\n- If you include existing zones in the request, you must specify this parameter.\n\n- 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.\n\n If you are upgrading a replica set to a sharded cluster, you cannot increase the number of shards in the same update request. You should wait until after the cluster has completed upgrading to sharded and you have reconnected all application clients to the MongoDB router before adding additional shards. Otherwise, your data might become inconsistent once MongoDB Cloud begins distributing data across shards.", + "format" : "int32", + "default" : 1 + }, + "regionsConfig" : { + "title" : "Region Configuration", + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RegionSpec" + }, + "description" : "Physical location where MongoDB Cloud provisions cluster nodes." + }, + "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." + }, + "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.", + "format" : "date-time", + "externalDocs" : { + "description" : "Reconfiguring a Replica Set during a regional outage", + "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + } + }, + "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.\n\nWhen configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings.\n\nWhen 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" + }, + "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.", + "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.", + "format" : "date-time", + "readOnly" : true + }, + "globalClusterSelfManagedSharding" : { + "type" : "boolean", + "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen 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.\n\nWhen 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.\n\nThis 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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "id" : { + "maxLength" : 24, + "minLength" : 24, + "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.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", + "deprecated" : true, + "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.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", + "externalDocs" : { + "description" : "Available MongoDB Versions in Atlas", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/database/#which-versions-of-mongodb-do-service-clusters-use-" + } + }, + "mongoDBVersion" : { + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "type" : "string", + "description" : "Version of MongoDB that the cluster runs." + }, + "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/" + } + }, + "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 + }, + "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/" + } + }, + "name" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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.\n\nBy default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes.\n\nWhen configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads.\n\nWhen 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.\n\n- For Global Clusters, each object in the array represents one zone where MongoDB Cloud deploys your clusters nodes.\n- For non-Global sharded clusters and replica sets, the single object represents where MongoDB Cloud deploys your clusters nodes.", + "items" : { + "$ref" : "#/components/schemas/LegacyReplicationSpec" + } + }, + "rootCertType" : { + "type" : "string", + "description" : "Root Certificate Authority that MongoDB Atlas clusters 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 the current operating condition of the cluster.", + "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" + }, + "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**.\n If this parameter is `false`, the serverless instance uses **Basic Backup**.\n\n | Option | Description |\n |---|---|\n | Serverless Continuous Backup | Atlas takes incremental [snapshots](https://www.mongodb.com/docs/atlas/backup/cloud-backup/overview/#std-label-serverless-snapshots) of the data in your serverless instance every six hours and lets you restore the data from a selected point in time within the last 72 hours. Atlas also takes daily snapshots and retains these daily snapshots for 35 days. To learn more, see [Serverless Instance Costs](https://www.mongodb.com/docs/atlas/billing/serverless-instance-costs/#std-label-serverless-instance-costs). |\n | Basic Backup | Atlas takes incremental [snapshots](https://www.mongodb.com/docs/atlas/backup/cloud-backup/overview/#std-label-serverless-snapshots) of the data in your serverless instance every six hours and retains only the two most recent snapshots. You can use this option for free. |", + "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, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "id" : { + "maxLength" : 24, + "minLength" : 24, + "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 + }, + "name" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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 the current operating condition of the serverless instance.", + "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.", + "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, + "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" ] + }, + "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/)." + } + }, + "description" : "Group of cloud provider settings that configure the provisioned MongoDB serverless instance." + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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`.", + "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.\n\n| Status | Activity |\n|---|---|\n| `ACTIVE` | This access list entry applies to all relevant cloud providers. |\n| `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. |\n| `FAILED` | MongoDB Cloud didn't succeed in adding this access list entry. |\n", + "readOnly" : true, + "enum" : [ "PENDING", "FAILED", "ACTIVE" ] + } + } + }, + "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" : { + "maxLength" : 12, + "minLength" : 12, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "minLength" : 5, + "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" : { + "maxLength" : 32, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$", + "type" : "string", + "description" : "Unique string that identifies the Azure AD directory in which the VNet peered with the MongoDB Cloud VNet resides." + }, + "azureSubscriptionId" : { + "maxLength" : 32, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$", + "type" : "string", + "description" : "Unique string that identifies the Azure subscription in which the VNet you peered with the MongoDB Cloud VNet resides." + }, + "containerId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 30, + "minLength" : 6, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "networkName" : { + "maxLength" : 63, + "minLength" : 1, + "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`.", + "format" : "int32", + "readOnly" : true + } + }, + "description" : "Group of Network Peering connection settings." + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "items" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" + }, + "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 + } + } + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the interface endpoint.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + } + }, + "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." + }, + "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" + }, + "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." + } + } + } ] + }, + "CreateEndpointRequest" : { + "type" : "object", + "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" + }, + "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.\n\n- 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:\n - Your applications must use the new connection strings for existing multi-region and global sharded clusters. This might cause downtime.\n - Your MongoDB Cloud project can't contain replica sets nor can you create new replica sets in this project.\n\n - You can't disable this setting if you have:\n - more than one private endpoint in more than one region\n - more than one private endpoint in one region and one private endpoint in one or more regions.\n\n- 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`.", + "format" : "int32", + "readOnly" : true + } + } + }, + "PrivateNetworkEndpointIdEntry" : { + "required" : [ "endpointId" ], + "type" : "object", + "properties" : { + "azureConnectionName" : { + "type" : "string", + "description" : "Connection name that identifies the Azure private endpoint connection." }, - { - "$ref": "#/components/parameters/pretty" + "azureLinkId" : { + "type" : "string", + "description" : "Link ID that identifies the Azure private endpoint connection." }, - { - "$ref": "#/components/parameters/groupId" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/GroupIPAddresses" - }, - "x-xgen-version": "2023-01-01" - } + "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." + }, + "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." + }, + "endpointId" : { + "maxLength" : 22, + "minLength" : 22, + "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" } }, - "401": { - "$ref": "#/components/responses/unauthorized" + "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." + }, + "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" ] + } + } + }, + "CreatePushBasedLogExportProjectRequest" : { + "required" : [ "bucketName", "iamRoleId", "prefixPath" ], + "type" : "object", + "properties" : { + "bucketName" : { + "type" : "string", + "description" : "The name of the bucket to which the agent will send the logs to." + }, + "iamRoleId" : { + "type" : "string", + "description" : "ID of the AWS IAM role that will be used to write to the S3 bucket." + }, + "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" + } + }, + "prefixPath" : { + "type" : "string", + "description" : "S3 directory in which vector will write to in order to store the logs. An empty string denotes the root directory." + } + } + }, + "PushBasedLogExportProject" : { + "type" : "object", + "properties" : { + "bucketName" : { + "type" : "string", + "description" : "The name of the bucket to which the agent will send the logs to." + }, + "createDate" : { + "type" : "string", + "description" : "Date and time that this feature was enabled on.", + "format" : "date-time", + "readOnly" : true + }, + "iamRoleId" : { + "type" : "string", + "description" : "ID of the AWS IAM role that will be used to write to the S3 bucket." + }, + "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" + } + }, + "prefixPath" : { + "type" : "string", + "description" : "S3 directory in which vector will write to in order to store the logs. An empty string denotes the root directory." + }, + "state" : { + "type" : "string", + "description" : "Describes whether or not the feature is enabled and what status it is in.", + "readOnly" : true, + "enum" : [ "UNCONFIGURED", "INITIATING", "BUCKET_VERIFIED", "BUCKET_VERIFICATION_FAILED", "ASSUME_ROLE_FAILED", "ACTIVE" ] + } + } + }, + "LDAPVerifyConnectivityJobRequest" : { + "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 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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "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.\n\nUse 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", + "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", + "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\": \"\"`." }, - "404": { - "$ref": "#/components/responses/notFound" + "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." }, - "500": { - "$ref": "#/components/responses/internalServerError" + "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.", + "items" : { + "$ref" : "#/components/schemas/UserToDNMapping" + } } }, - "security": [ - { - "DigestAuth": [] + "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" + } } - ], - "x-xgen-owner-team": "Atlas Dedicated IV" - } - }, - "/api/atlas/v2/groups/{groupId}/users/{userId}": { - "delete": { - "tags": ["Projects"], - "summary": "Remove One User from One Project", - "description": "Removes the specified user from the specified project. To use this resource, the requesting API Key must have the Project Owner role.", - "operationId": "removeProjectUser", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" + } + }, + "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)." + }, + "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." + }, + "PinFCVView" : { + "type" : "object", + "properties" : { + "expirationDate" : { + "type" : "string", + "description" : "Expiration date of the fixed FCV. If left unspecified, will default to 4 weeks ahead of the existing pinnedDate (if an FCV is already pinned) or the current date. Note that this field cannot exceed 4 weeks from the pinned date.", + "format" : "date-time" }, - { - "$ref": "#/components/parameters/groupId" + "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" + } + } + } + }, + "GeoSharding" : { + "type" : "object", + "properties" : { + "customZoneMapping" : { + "type" : "object", + "additionalProperties" : { + "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `id` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `id` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true }, - { - "$ref": "#/components/parameters/pretty" + "managedNamespaces" : { + "type" : "array", + "description" : "List that contains a namespace for a Global Cluster. MongoDB Cloud manages this cluster.", + "readOnly" : true, + "items" : { + "$ref" : "#/components/schemas/ManagedNamespaces" + } }, - { - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } + "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 } - ], - "responses": { - "204": { - "description": "This endpoint does not return a response body.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "x-xgen-version": "2023-01-01" - } - } - }, - "403": { - "$ref": "#/components/responses/forbidden" + } + }, + "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.", + "readOnly" : true }, - "400": { - "$ref": "#/components/responses/badRequest" + "db" : { + "type" : "string", + "description" : "Human-readable label of the database to manage for this Global Cluster." }, - "404": { - "$ref": "#/components/responses/notFound" + "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.", + "writeOnly" : true, + "externalDocs" : { + "description" : "Hashed Shard Keys", + "url" : "https://www.mongodb.com/docs/manual/reference/method/sh.shardCollection/#hashed-shard-keys" + }, + "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/).", + "writeOnly" : true, + "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", + "writeOnly" : true, + "externalDocs" : { + "description" : "Global Cluster Sharding", + "url" : "https://www.mongodb.com/docs/atlas/shard-global-collection/" + } + }, + "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.", + "writeOnly" : true, + "externalDocs" : { + "description" : "Hashed Shard Key", + "url" : "https://www.mongodb.com/docs/manual/core/hashed-sharding/" + }, + "default" : false + } + } + }, + "GeoSharding20240805" : { + "type" : "object", + "properties" : { + "customZoneMapping" : { + "type" : "object", + "additionalProperties" : { + "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] + "managedNamespaces" : { + "type" : "array", + "description" : "List that contains a namespace for a Global Cluster. MongoDB Cloud manages this cluster.", + "readOnly" : true, + "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 } - ], - "x-xgen-owner-team": "IAM" - } - }, - "/api/atlas/v2/groups/{groupId}/users/{userId}/roles": { - "put": { - "tags": ["Projects"], - "summary": "Update Project Roles for One MongoDB Cloud User", - "description": "Updates the roles of the specified user in the specified project. To specify the user to update, provide the unique 24-hexadecimal digit string that identifies the user in the specified project. To use this resource, the requesting API Key must have the Group User Admin role.", - "operationId": "updateProjectRoles", - "parameters": [ - { - "$ref": "#/components/parameters/groupId" + } + }, + "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.\n\nThis parameter returns an empty object if no custom zones exist.", + "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." + }, + "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.\n\n Change this parameter if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" to \"AWS\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" to \"M30\"` or greater (not including `Mxx_NVME` tiers).\n\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType\" to \"PROVISIONED\"`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1.", + "format" : "int32" + }, + "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.", + "format" : "date-time", + "externalDocs" : { + "description" : "Reconfiguring a Replica Set during a regional outage", + "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + } + }, + "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.", + "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.\n\nWhen configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings.\n\nWhen 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" : { + "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" + }, + "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.", + "format" : "date-time", + "readOnly" : true + }, + "globalClusterSelfManagedSharding" : { + "type" : "boolean", + "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen 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.\n\nWhen 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.\n\nThis 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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "id" : { + "maxLength" : 24, + "minLength" : 24, + "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.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", + "deprecated" : true, + "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.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", + "externalDocs" : { + "description" : "Available MongoDB Versions in Atlas", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/database/#which-versions-of-mongodb-do-service-clusters-use-" + } + }, + "mongoDBVersion" : { + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "type" : "string", + "description" : "Version of MongoDB that the cluster runs.", + "readOnly" : true + }, + "name" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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.\n\nBy default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes.\n\nWhen configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads.\n\nWhen 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.", + "items" : { + "$ref" : "#/components/schemas/ReplicationSpec" + } + }, + "rootCertType" : { + "type" : "string", + "description" : "Root Certificate Authority that MongoDB Cloud cluster uses. MongoDB Cloud supports Internet Security Research Group.", + "default" : "ISRGROOTX1", + "enum" : [ "ISRGROOTX1" ] + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of this cluster.", + "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" + }, + "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 someone enabled instance size auto-scaling.\n\n- Set to `true` to enable instance size auto-scaling. If enabled, you must specify a value for **replicationSpecs[n].regionConfigs[m].autoScaling.compute.maxInstanceSize**.\n- Set to `false` to disable instance size automatic scaling." + }, + "maxInstanceSize" : { + "$ref" : "#/components/schemas/BaseCloudProviderInstanceSize" + }, + "minInstanceSize" : { + "$ref" : "#/components/schemas/BaseCloudProviderInstanceSize" + }, + "scaleDownEnabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether the instance size may scale down. MongoDB Cloud requires this parameter if `\"replicationSpecs[n].regionConfigs[m].autoScaling.compute.enabled\" : true`. If you enable this option, specify a value for **replicationSpecs[n].regionConfigs[m].autoScaling.compute.minInstanceSize**." + } + }, + "description" : "Options that determine how this cluster handles CPU scaling." + }, + "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:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" : \"Azure\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : \"M40\"` or greater not including `Mxx_NVME` tiers.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.", + "format" : "int32", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://www.mongodb.com/docs/atlas/customize-storage/#extend-iops-on-azure" + } + }, + "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" + } + } + } ] + }, + "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`.\n\n**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", "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_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ] + }, { + "title" : "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", "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", "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" + } ] + }, + "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.", + "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." + }, + "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.", + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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.\n\n If you are upgrading a replica set to a sharded cluster, you cannot increase the number of shards in the same update request. You should wait until after the cluster has completed upgrading to sharded and you have reconnected all application clients to the MongoDB router before adding additional shards. Otherwise, your data might become inconsistent once MongoDB Cloud begins distributing data across shards.", + "format" : "int32" + }, + "regionConfigs" : { + "type" : "array", + "description" : "Hardware specifications for nodes set for a given region. 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**.\n\n**Example:**\n\nIf you set `\"replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize\" : \"M30\"`, set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : `\"M30\"` if you have electable nodes and `\"replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize\" : `\"M30\"` if you have read-only nodes.", + "items" : { + "$ref" : "#/components/schemas/CloudRegionConfig" + } + }, + "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" : { + "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`.", + "enum" : [ "AWS", "GCP", "AZURE" ] + } + } + } ] + }, + "AWSHardwareSpec20240805" : { + "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 in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as \"base nodes\") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M100", "M140", "M200", "M300", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R700", "M40_NVME", "M50_NVME", "M60_NVME", "M80_NVME", "M200_NVME", "M400_NVME" ] + }, + "diskIOPS" : { + "type" : "integer", + "description" : "Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.\n\n You can set different IOPS values on different shards when provisioned IOPS are supported.\n\n Change this parameter if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" to \"AWS\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" to \"M30\"` or greater (not including `Mxx_NVME` tiers).\n\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType\" to \"PROVISIONED\"`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1.", + "format" : "int32" + }, + "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 must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "format" : "double" + }, + "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." + }, + "AWSRegionConfig20240805" : { + "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/CloudRegionConfig20240805" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" + } + } + } ] + }, + "AzureHardwareSpec20240805" : { + "type" : "object", + "properties" : { + "instanceSize" : { + "title" : "Azure Instance Sizes", + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as \"base nodes\") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M90", "M200", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "M60_NVME", "M80_NVME", "M200_NVME", "M300_NVME", "M400_NVME", "M600_NVME" ] + }, + "diskIOPS" : { + "type" : "integer", + "description" : "Target throughput desired for storage attached to your Azure-provisioned cluster. Change this parameter if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" : \"Azure\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : \"M40\"` or greater not including `Mxx_NVME` tiers.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.", + "format" : "int32", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://www.mongodb.com/docs/atlas/customize-storage/#extend-iops-on-azure" + } + }, + "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 must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "format" : "double" + }, + "nodeCount" : { + "type" : "integer", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region.", + "format" : "int32" + } + } + }, + "AzureRegionConfig20240805" : { + "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/CloudRegionConfig20240805" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" + } + } + } ] + }, + "CloudRegionConfig20240805" : { + "title" : "Cloud Service Provider Settings", + "type" : "object", + "properties" : { + "electableSpecs" : { + "$ref" : "#/components/schemas/HardwareSpec20240805" + }, + "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`.\n\n**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", "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_CENTRAL", "GERMANY_NORTH_EAST", "GERMANY_WEST_CENTRAL", "GERMANY_NORTH", "SWEDEN_CENTRAL", "SWEDEN_SOUTH", "SWITZERLAND_NORTH", "SWITZERLAND_WEST", "UK_SOUTH", "UK_WEST", "NORWAY_EAST", "NORWAY_WEST", "INDIA_CENTRAL", "INDIA_SOUTH", "INDIA_WEST", "CHINA_EAST", "CHINA_NORTH", "ASIA_EAST", "JAPAN_EAST", "JAPAN_WEST", "ASIA_SOUTH_EAST", "KOREA_CENTRAL", "KOREA_SOUTH", "FRANCE_CENTRAL", "FRANCE_SOUTH", "SOUTH_AFRICA_NORTH", "SOUTH_AFRICA_WEST", "UAE_CENTRAL", "UAE_NORTH", "QATAR_CENTRAL" ] + }, { + "title" : "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", "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", "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/AWSRegionConfig20240805", + "AZURE" : "#/components/schemas/AzureRegionConfig20240805", + "GCP" : "#/components/schemas/GCPRegionConfig20240805", + "TENANT" : "#/components/schemas/TenantRegionConfig20240805" + } + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSRegionConfig20240805" + }, { + "$ref" : "#/components/schemas/AzureRegionConfig20240805" + }, { + "$ref" : "#/components/schemas/GCPRegionConfig20240805" + }, { + "$ref" : "#/components/schemas/TenantRegionConfig20240805" + } ] + }, + "ClusterDescription20240805" : { + "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.", + "format" : "date-time", + "externalDocs" : { + "description" : "Reconfiguring a Replica Set during a regional outage", + "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + } + }, + "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.", + "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.\n\nWhen configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings.\n\nWhen 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 + }, + "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.", + "format" : "date-time", + "readOnly" : true + }, + "globalClusterSelfManagedSharding" : { + "type" : "boolean", + "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen 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.\n\nWhen 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.\n\nThis 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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "id" : { + "maxLength" : 24, + "minLength" : 24, + "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.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", + "deprecated" : true, + "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.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", + "externalDocs" : { + "description" : "Available MongoDB Versions in Atlas", + "url" : "https://www.mongodb.com/docs/atlas/reference/faq/database/#which-versions-of-mongodb-do-service-clusters-use-" + } + }, + "mongoDBVersion" : { + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "type" : "string", + "description" : "Version of MongoDB that the cluster runs.", + "readOnly" : true + }, + "name" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string", + "description" : "Human-readable label that identifies the 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/" + } + }, + "redactClientLogData" : { + "type" : "boolean", + "description" : "Enable or disable log redaction.", + "externalDocs" : { + "description" : "This options corresponds to the ``security.redactClientLogData`` cluster parameter.\n\nThis setting configures the ``mongod`` or ``mongos`` to redact any message accompanying a given log event before logging. This prevents the program from writing potentially sensitive data stored on the database to the diagnostic log. Metadata such as error or operation codes, line numbers, and source file names are still visible in the logs.\n\nUse ``redactClientLogData`` in conjunction with Encryption at Rest and TLS/SSL (Transport Encryption) to assist compliance with regulatory requirements.", + "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.redactClientLogData" + } + }, + "replicaSetScalingStrategy" : { + "type" : "string", + "description" : "Set this field to configure the replica set scaling mode for your cluster.\n\nBy default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes.\n\nWhen configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads.\n\nWhen 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. This array has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations.", + "items" : { + "$ref" : "#/components/schemas/ReplicationSpec20240805" + } + }, + "rootCertType" : { + "type" : "string", + "description" : "Root Certificate Authority that MongoDB Cloud cluster uses. MongoDB Cloud supports Internet Security Research Group.", + "default" : "ISRGROOTX1", + "enum" : [ "ISRGROOTX1" ] + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of this cluster.", + "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" + }, + "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" ] + } + } + }, + "DedicatedHardwareSpec20240805" : { + "type" : "object", + "properties" : { + "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 must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "format" : "double" + }, + "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.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSHardwareSpec20240805" + }, { + "$ref" : "#/components/schemas/AzureHardwareSpec20240805" + }, { + "$ref" : "#/components/schemas/GCPHardwareSpec20240805" + } ] + }, + "GCPHardwareSpec20240805" : { + "type" : "object", + "properties" : { + "instanceSize" : { + "title" : "GCP Instance Sizes", + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as \"base nodes\") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ] + }, + "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 must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "format" : "double" + }, + "nodeCount" : { + "type" : "integer", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region.", + "format" : "int32" + } + } + }, + "GCPRegionConfig20240805" : { + "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/CloudRegionConfig20240805" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" + } + } + } ] + }, + "HardwareSpec20240805" : { + "type" : "object", + "properties" : { + "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 must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "format" : "double" + } + }, + "description" : "Hardware specifications for all electable nodes deployed in the region. Electable nodes can become the primary and can enable local reads. If you don't specify this option, MongoDB Cloud deploys no electable nodes to the region.", + "oneOf" : [ { + "$ref" : "#/components/schemas/AWSHardwareSpec20240805" + }, { + "$ref" : "#/components/schemas/AzureHardwareSpec20240805" + }, { + "$ref" : "#/components/schemas/GCPHardwareSpec20240805" + }, { + "$ref" : "#/components/schemas/TenantHardwareSpec20240805" + } ] + }, + "ReplicationSpec20240805" : { + "title" : "Replication Specifications", + "type" : "object", + "properties" : { + "id" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a shard in a Cluster. If you include existing shard replication configurations in the request, you must specify this parameter. If you add a new shard to an existing Cluster, you may specify this parameter. The request deletes any existing shards in the Cluster that you exclude from the request.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "regionConfigs" : { + "type" : "array", + "description" : "Hardware specifications for nodes set for a given region. 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**.\n\n**Example:**\n\nIf you set `\"replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize\" : \"M30\"`, set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : `\"M30\"` if you have electable nodes and `\"replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize\" : `\"M30\"` if you have read-only nodes.", + "items" : { + "$ref" : "#/components/schemas/CloudRegionConfig20240805" + } + }, + "zoneId" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the zone in a Global Cluster. This value can be used to configure Global Cluster backup policies.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "zoneName" : { + "type" : "string", + "description" : "Human-readable label that describes the zone this shard belongs to in a Global Cluster. Provide this value only if \"clusterType\" : \"GEOSHARDED\" but not \"selfManagedSharding\" : true." + } + }, + "description" : "Details that explain how MongoDB Cloud replicates data on the specified MongoDB database." + }, + "TenantHardwareSpec20240805" : { + "type" : "object", + "properties" : { + "instanceSize" : { + "title" : "Tenant Instance Sizes", + "type" : "string", + "description" : "Hardware specification for the instances in this M0/M2/M5 tier cluster.", + "enum" : [ "M0", "M2", "M5" ] + }, + "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 must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "format" : "double" + } + } + }, + "TenantRegionConfig20240805" : { + "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/CloudRegionConfig20240805" + }, { + "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`.", + "enum" : [ "AWS", "GCP", "AZURE" ] + } + } + } ] + }, + "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`.", + "format" : "int32", + "readOnly" : true + } + } + }, + "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`.", + "format" : "int32", + "readOnly" : true + } + } + }, + "PaginatedClusterDescription20240805" : { + "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/ClusterDescription20240805" + } + }, + "totalCount" : { + "minimum" : 0, + "type" : "integer", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "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" + } + }, + "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/" + } + }, + "defaultReadConcern" : { + "type" : "string", + "description" : "Default level of acknowledgment requested from MongoDB for read operations set for this cluster.\n\nMongoDB 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/" + }, + "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, + "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" + } + }, + "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" + }, + "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" + } + }, + "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" + } + } + } + }, + "ClusterDescriptionProcessArgs20240805" : { + "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" + } + }, + "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/" + } + }, + "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/" + } + }, + "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" + } + }, + "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" + }, + "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" + } + }, + "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" + } + } + } + }, + "ApiAtlasPolicyView" : { + "type" : "object", + "properties" : { + "body" : { + "type" : "string", + "description" : "A string that defines the permissions for the policy. The syntax used is the Cedar Policy language.", + "readOnly" : true, + "example" : " forbid (\n principal,\n action == cloud::Action::\"cluster.createEdit\",\n resource\n ) when {\n context.cluster.regions.contains(cloud::region::\"aws:us-east-1\")\n };\n" + }, + "id" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the policy.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + } + } + }, + "ApiAtlasResourcePolicyView" : { + "type" : "object", + "properties" : { + "createdByUser" : { + "$ref" : "#/components/schemas/ApiAtlasUserMetadataView" + }, + "createdDate" : { + "type" : "string", + "description" : "Date and time in UTC when the atlas resource policy was created.", + "format" : "date-time", + "readOnly" : true, + "example" : "2022-01-01T00:00:00Z" + }, + "id" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the atlas resource policy.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "lastUpdatedByUser" : { + "$ref" : "#/components/schemas/ApiAtlasUserMetadataView" + }, + "lastUpdatedDate" : { + "type" : "string", + "description" : "Date and time in UTC when the atlas resource policy was last updated.", + "format" : "date-time", + "readOnly" : true, + "example" : "2022-01-01T00:00:00Z" + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that describes the atlas resource policy.", + "readOnly" : true + }, + "orgId" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization the atlas resource policy belongs to.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "policies" : { + "type" : "array", + "description" : "List of policies that make up the atlas resource policy.", + "readOnly" : true, + "items" : { + "$ref" : "#/components/schemas/ApiAtlasPolicyView" + } + }, + "version" : { + "type" : "string", + "description" : "A string that identifies the version of the atlas resource policy.", + "readOnly" : true, + "example" : "v1" + } + } + }, + "ApiAtlasUserMetadataView" : { + "type" : "object", + "properties" : { + "id" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies a user.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" }, - { - "name": "userId", - "in": "path", - "description": "Unique 24-hexadecimal digit string that identifies the user to modify.", - "required": true, - "schema": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" + "name" : { + "type" : "string", + "description" : "Human-readable label that describes a user.", + "readOnly" : true + } + }, + "description" : "The user that last updated the atlas resource policy.", + "readOnly" : true + }, + "ApiAtlasInvalidPolicyErrorDetailView" : { + "type" : "object", + "properties" : { + "detail" : { + "type" : "string", + "description" : "A string that provides a detailed description of a validation error.", + "readOnly" : true + } + } + }, + "ApiAtlasInvalidPolicyView" : { + "type" : "object", + "properties" : { + "body" : { + "type" : "string", + "description" : "A string that defines the permissions for the policy. The syntax used is the Cedar Policy language.", + "readOnly" : true, + "example" : " forbid (\n principal,\n action == cloud::Action::\"cluster.createEdit\",\n resource\n ) when {\n context.cluster.regions.contains(cloud::region::\"aws:us-east-1\")\n };\n" + }, + "errors" : { + "type" : "array", + "description" : "List of validation errors.", + "readOnly" : true, + "items" : { + "$ref" : "#/components/schemas/ApiAtlasInvalidPolicyErrorDetailView" + } + } + } + }, + "ApiAtlasInvalidResourcePolicyCreateErrorView" : { + "type" : "object", + "properties" : { + "errorType" : { + "type" : "string", + "description" : "Human-readable label that displays the type of an error.", + "enum" : [ "POLICY_PARSING_ERROR", "POLICY_HAS_FAILED_VALIDATIONS", "POLICY_HAS_INVALID_PRINCIPAL", "POLICY_HAS_BODY_EXCEEDING_MAX_SIZE", "POLICY_HAS_UNEXPECTED_ENTITIES" ] + }, + "invalidPolicies" : { + "type" : "array", + "description" : "List of invalid policies containing details of their validation errors.", + "readOnly" : true, + "items" : { + "$ref" : "#/components/schemas/ApiAtlasInvalidPolicyView" + } + } + } + }, + "ApiAtlasPolicyCreateView" : { + "required" : [ "body" ], + "type" : "object", + "properties" : { + "body" : { + "type" : "string", + "description" : "A string that defines the permissions for the policy. The syntax used is the Cedar Policy language.", + "example" : " forbid (\n principal,\n action == cloud::Action::\"cluster.createEdit\",\n resource\n ) when {\n context.cluster.regions.contains(cloud::region::\"aws:us-east-1\")\n };\n" + } + } + }, + "ApiAtlasResourcePolicyCreateView" : { + "required" : [ "name", "policies" ], + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that describes the atlas resource policy." + }, + "policies" : { + "type" : "array", + "description" : "List of policies that make up the atlas resource policy.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasPolicyCreateView" + } + } + } + }, + "ApiAtlasResourcePolicyEditView" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that describes the atlas resource policy." + }, + "policies" : { + "type" : "array", + "description" : "List of policies that make up the atlas resource policy.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasPolicyCreateView" + } + } + } + }, + "ApiAtlasNonCompliantResourceView" : { + "type" : "object", + "properties" : { + "orgId" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization the resource belongs to.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "resourceId" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the non-compliant resource.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "resourcePoliciesCausingNonCompliance" : { + "type" : "array", + "description" : "List of resource policies causing the resource to be considered non-compliant.", + "readOnly" : true, + "items" : { + "$ref" : "#/components/schemas/ApiAtlasResourcePolicyMetadataView" + } + }, + "resourceType" : { + "type" : "string", + "description" : "Human-readable label that displays the type of a resource.", + "readOnly" : true, + "enum" : [ "PROJECT", "CLUSTER" ] + } + } + }, + "ApiAtlasPolicyMetadataView" : { + "type" : "object", + "properties" : { + "policyId" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the policy.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + } + } + }, + "ApiAtlasResourcePolicyMetadataView" : { + "type" : "object", + "properties" : { + "policiesCausingNonCompliance" : { + "type" : "array", + "description" : "List of policies that are in conflict with the current state of the resource.", + "readOnly" : true, + "items" : { + "$ref" : "#/components/schemas/ApiAtlasPolicyMetadataView" + } + }, + "resourcePolicyId" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the atlas resource policy.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "resourcePolicyName" : { + "type" : "string", + "description" : "Human-readable label that describes the atlas resource policy.", + "readOnly" : true + } + } + }, + "SampleDatasetStatus" : { + "type" : "object", + "properties" : { + "_id" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies this sample dataset.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "clusterName" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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" ] + } + } + }, + "ServerlessInstanceDescriptionCreate" : { + "title" : "Serverless Instance Description Create", + "required" : [ "name", "providerSettings" ], + "type" : "object", + "properties" : { + "name" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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 the current operating condition of the serverless instance.", + "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.", + "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`.", + "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.", + "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." + }, + "ServerlessAWSTenantEndpoint" : { + "title" : "AWS", + "type" : "object", + "properties" : { + "_id" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "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" ] + } + }, + "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" + } + } + }, + "FlexBackupRestoreJob20250101" : { + "title" : "Flex Backup Restore Job", + "type" : "object", + "properties" : { + "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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "instanceName" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string", + "description" : "Human-readable label that identifies the source instance.", + "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" + } + }, + "projectId" : { + "maxLength" : 24, + "minLength" : 24, + "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" + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "readOnly" : true, + "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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", + "type" : "string", + "description" : "Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another USS instance or Dedicated cluster tier.", + "readOnly" : true + }, + "targetProjectId" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + } + }, + "description" : "Details for one restore job of a flex cluster." + }, + "FlexBackupRestoreJobCreate20250101" : { + "title" : "Create Flex Backup Restore Job", + "required" : [ "_snapshotId", "_targetDeploymentItemName" ], + "type" : "object", + "properties" : { + "_snapshotId" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "writeOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "_targetDeploymentItemName" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", + "type" : "string", + "description" : "Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another flex cluster or dedicated cluster tier.", + "writeOnly" : true + }, + "_targetProjectId" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.", + "writeOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "instanceName" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string", + "description" : "Human-readable label that identifies the source instance.", + "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" + } + }, + "projectId" : { + "maxLength" : 24, + "minLength" : 24, + "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" + }, + "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 + }, + "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" ] + } + }, + "description" : "Details to create one restore job of a flex cluster." + }, + "FlexBackupSnapshotDownloadCreate20250101" : { + "title" : "Flex Backup Snapshot Download Create", + "required" : [ "_snapshotId" ], + "type" : "object", + "properties" : { + "_snapshotId" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to download.", + "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" + } + } + }, + "description" : "Details for one backup snapshot download of a flex cluster." + }, + "PaginatedApiAtlasFlexBackupRestoreJob20250101View" : { + "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/FlexBackupRestoreJob20250101" + } + }, + "totalCount" : { + "minimum" : 0, + "type" : "integer", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "format" : "int32", + "readOnly" : true + } + } + }, + "FlexBackupSnapshot20250101" : { + "title" : "Flex Backup Snapshot", + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" + } + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "MongoDB host version that the snapshot runs.", + "readOnly" : true + }, + "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" ] + } + }, + "description" : "Details for one snapshot of a flex cluster." + }, + "PaginatedApiAtlasFlexBackupSnapshot20240710View" : { + "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/FlexBackupSnapshot20250101" + } + }, + "totalCount" : { + "minimum" : 0, + "type" : "integer", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "format" : "int32", + "readOnly" : true + } + } + }, + "FlexBackupSettings20250101" : { + "title" : "Flex Backup Configuration", + "type" : "object", + "properties" : { + "enabled" : { + "type" : "boolean", + "description" : "Flag that indicates whether backups are performed for this flex cluster. Backup uses [TODO](TODO) for flex clusters.", + "readOnly" : true, + "default" : true + } + }, + "description" : "Flex backup configuration", + "readOnly" : true + }, + "FlexClusterDescription20250101" : { + "title" : "Flex Cluster Description", + "required" : [ "providerSettings" ], + "type" : "object", + "properties" : { + "backupSettings" : { + "$ref" : "#/components/schemas/FlexBackupSettings20250101" + }, + "clusterType" : { + "type" : "string", + "description" : "Flex cluster topology.", + "readOnly" : true, + "enum" : [ "REPLICASET", "LOADBALANCED" ] + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/FlexConnectionStrings20250101" + }, + "createDate" : { + "type" : "string", + "description" : "Date and time when MongoDB Cloud created this instance. This parameter expresses its value in ISO 8601 format in UTC.", + "format" : "date-time", + "readOnly" : true + }, + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "id" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the 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 instance runs.", + "readOnly" : true + }, + "name" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string", + "description" : "Human-readable label that identifies the instance.", + "readOnly" : true + }, + "providerSettings" : { + "$ref" : "#/components/schemas/FlexProviderSettings20250101" + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of this instance.", + "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 instance.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "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.", + "readOnly" : true, + "default" : "LTS", + "enum" : [ "LTS" ] + } + }, + "description" : "Group of settings that configure a MongoDB Flex cluster." + }, + "FlexConnectionStrings20250101" : { + "title" : "Flex Cluster Connection Strings", + "type" : "object", + "properties" : { + "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 flex 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/" + } + }, + "FlexProviderSettings20250101" : { + "title" : "Cloud Service Provider Settings for a Flex Cluster", + "type" : "object", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the flex cluster.", + "readOnly" : true, + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "diskSizeGB" : { + "type" : "number", + "description" : "Storage capacity available to the flex cluster expressed in gigabytes.", + "format" : "double", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud service provider.", + "readOnly" : true, + "default" : "FLEX", + "enum" : [ "FLEX" ] + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB flex cluster. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).", + "readOnly" : true + } + }, + "description" : "Group of cloud provider settings that configure the provisioned MongoDB flex cluster.", + "readOnly" : true + }, + "FlexClusterDescriptionCreate20250101" : { + "title" : "Flex Cluster Description Create", + "required" : [ "name", "providerSettings" ], + "type" : "object", + "properties" : { + "name" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "type" : "string", + "description" : "Human-readable label that identifies the instance.", + "writeOnly" : true + }, + "providerSettings" : { + "$ref" : "#/components/schemas/FlexProviderSettingsCreate20250101" + }, + "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" + } + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "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 + } + }, + "description" : "Settings that you can specify when you create a flex cluster." + }, + "FlexProviderSettingsCreate20250101" : { + "title" : "Cloud Service Provider Settings for a Flex Cluster", + "required" : [ "backingProviderName", "regionName" ], + "type" : "object", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the flex cluster.", + "writeOnly" : true, + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB flex cluster. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).", + "writeOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "description" : "Storage capacity available to the flex cluster expressed in gigabytes.", + "format" : "double", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud service provider.", + "readOnly" : true, + "default" : "FLEX", + "enum" : [ "FLEX" ] + } + }, + "description" : "Group of cloud provider settings that configure the provisioned MongoDB flex cluster.", + "writeOnly" : true + }, + "PaginatedFlexClusters20250101" : { + "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" : { + "type" : "object" + } + }, + "totalCount" : { + "minimum" : 0, + "type" : "integer", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "format" : "int32", + "readOnly" : true + } + } + }, + "ApiVersion" : { + "type" : "object", + "properties" : { + "version" : { + "type" : "string", + "description" : "Object representing a version of the Atlas Admin API." + } + } + }, + "PaginatedApiVersions" : { + "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/ApiVersion" + } + }, + "totalCount" : { + "minimum" : 0, + "type" : "integer", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "format" : "int32", + "readOnly" : true + } + } + }, + "AtlasOrganization" : { + "required" : [ "name" ], + "type" : "object", + "properties" : { + "id" : { + "maxLength" : 24, + "minLength" : 24, + "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 + }, + "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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", + "type" : "string", + "description" : "Human-readable label that identifies the organization." + } + }, + "description" : "Details that describe the organization." + }, + "CreateOrganizationResponse" : { + "type" : "object", + "properties" : { + "apiKey" : { + "$ref" : "#/components/schemas/ApiKeyUserDetails" + }, + "federationSettingsId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" + } + } + }, + "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.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "ORG_TEAM_MEMBERS_ADMIN" ] + } + } + }, + "description" : "Details of the programmatic API key to be created." + }, + "CreateOrganizationRequest" : { + "required" : [ "name" ], + "type" : "object", + "properties" : { + "apiKey" : { + "$ref" : "#/components/schemas/CreateAtlasOrganizationApiKey" + }, + "federationSettingsId" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", + "type" : "string", + "description" : "Human-readable label that identifies the organization." + }, + "orgOwnerId" : { + "maxLength" : 24, + "minLength" : 24, + "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" + } + } + }, + "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`.", + "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" : "^((([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}))$", + "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" : { + "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}))$", + "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" + } + } + }, + "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.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "ORG_TEAM_MEMBERS_ADMIN" ] + } + } + } + }, + "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`.", + "format" : "int32", + "readOnly" : true + } + } + }, + "AddUserToTeam" : { + "required" : [ "id" ], + "type" : "object", + "properties" : { + "id" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user.", + "example" : "32b6e34b3d91647abb20e7b8" + } + } + }, + "Team" : { + "required" : [ "name" ], + "type" : "object", + "properties" : { + "id" : { + "maxLength" : 24, + "minLength" : 24, + "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.", + "items" : { + "type" : "string", + "description" : "List that contains email addresses that identify MongoDB Cloud users to in this team.", + "format" : "email" + } + } + } + }, + "TeamResponse" : { + "type" : "object", + "properties" : { + "id" : { + "maxLength" : 24, + "minLength" : 24, + "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`.", + "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" } }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "$ref": "#/components/parameters/envelope" - } - ], - "requestBody": { - "description": "Roles to update for the specified user.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/UpdateGroupRolesForUser" - } + "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`.", + "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.", + "items" : { + "type" : "string" } }, - "required": true + "hasRoleMappings" : { + "type" : "boolean", + "description" : "Flag that indicates whether this organization has role mappings configured." + }, + "id" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this federation.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "identityProviderId" : { + "maxLength" : 20, + "minLength" : 20, + "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." + }, + "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." + }, + "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/." + } + }, + "description" : "Collection of settings that configures the organization." + }, + "UpdateOrgRolesForUser" : { + "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" + } + }, + "orgRoles" : { + "uniqueItems" : true, + "type" : "array", + "description" : "One or more organization level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY" ] + } + } + } + }, + "GroupRoleAssignment" : { + "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 these roles belong.", + "example" : "32b6e34b3d91647abb20e7b8" + }, + "groupRoles" : { + "uniqueItems" : true, + "type" : "array", + "description" : "One or more project level roles assigned to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_OWNER", "GROUP_CLUSTER_MANAGER", "GROUP_STREAM_PROCESSING_OWNER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR" ] + } + } + } + }, + "OrgActiveUserResponse" : { + "required" : [ "createdAt", "firstName", "id", "lastName", "orgMembershipStatus", "roles", "username" ], + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OrgUserResponse" + }, { + "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.", + "readOnly" : true, + "example" : "US" + }, + "createdAt" : { + "type" : "string", + "description" : "Date and time when MongoDB Cloud created the current account. This value is in the ISO 8601 timestamp format in UTC.", + "format" : "date-time", + "readOnly" : true + }, + "firstName" : { + "type" : "string", + "description" : "First or given name that belongs to the MongoDB Cloud user.", + "readOnly" : true, + "example" : "John" + }, + "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.", + "readOnly" : true, + "example" : "Doe" + }, + "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.", + "readOnly" : true + } + } + } ] + }, + "OrgPendingUserResponse" : { + "required" : [ "id", "invitationCreatedAt", "invitationExpiresAt", "inviterUsername", "orgMembershipStatus", "roles", "username" ], + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OrgUserResponse" + }, { + "type" : "object", + "properties" : { + "invitationCreatedAt" : { + "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 + }, + "invitationExpiresAt" : { + "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 + }, + "inviterUsername" : { + "type" : "string", + "description" : "Username of the MongoDB Cloud user who sent the invitation to join the organization.", + "format" : "email", + "readOnly" : true + } + } + } ] + }, + "OrgUserResponse" : { + "required" : [ "id", "orgMembershipStatus", "roles", "username" ], + "type" : "object", + "properties" : { + "id" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "orgMembershipStatus" : { + "type" : "string", + "description" : "String enum that indicates whether the MongoDB Cloud user has a pending invitation to join the organization or they are already active in the organization.", + "readOnly" : true, + "enum" : [ "PENDING", "ACTIVE" ] + }, + "roles" : { + "$ref" : "#/components/schemas/OrgUserRolesResponse" + }, + "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, + "items" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8" + } + }, + "username" : { + "type" : "string", + "description" : "Email address that represents the username of the MongoDB Cloud user.", + "format" : "email", + "readOnly" : true + } + }, + "discriminator" : { + "propertyName" : "orgMembershipStatus", + "mapping" : { + "ACTIVE" : "#/components/schemas/OrgActiveUserResponse", + "PENDING" : "#/components/schemas/OrgPendingUserResponse" + } + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/OrgPendingUserResponse" + }, { + "$ref" : "#/components/schemas/OrgActiveUserResponse" + } ] + }, + "OrgUserRolesResponse" : { + "type" : "object", + "properties" : { + "groupRoleAssignments" : { + "type" : "array", + "description" : "List of project level role assignments assigned to the MongoDB Cloud user.", + "items" : { + "$ref" : "#/components/schemas/GroupRoleAssignment" + } + }, + "orgRoles" : { + "uniqueItems" : true, + "type" : "array", + "description" : "One or more organization level roles assigned to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_READ_ONLY", "ORG_MEMBER" ] + } + } + }, + "description" : "Organization and project level roles assigned to one MongoDB Cloud user within one organization.", + "readOnly" : true + }, + "OrgUserRequest" : { + "required" : [ "roles", "username" ], + "type" : "object", + "properties" : { + "roles" : { + "$ref" : "#/components/schemas/OrgUserRolesRequest" + }, + "teamIds" : { + "uniqueItems" : true, + "type" : "array", + "description" : "List of unique 24-hexadecimal digit strings that identifies the teams to which this MongoDB Cloud user belongs.", + "writeOnly" : true, + "items" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8" + } + }, + "username" : { + "type" : "string", + "description" : "Email address that represents the username of the MongoDB Cloud user.", + "format" : "email", + "writeOnly" : true + } + } + }, + "OrgUserRolesRequest" : { + "required" : [ "orgRoles" ], + "type" : "object", + "properties" : { + "groupRoleAssignments" : { + "type" : "array", + "description" : "List of project level role assignments to assign the MongoDB Cloud user.", + "items" : { + "$ref" : "#/components/schemas/GroupRoleAssignment" + } + }, + "orgRoles" : { + "minItems" : 1, + "uniqueItems" : true, + "type" : "array", + "description" : "One or more organization level roles to assign the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_READ_ONLY", "ORG_MEMBER" ] + } + } + }, + "description" : "Organization and project level roles to assign the MongoDB Cloud user within one organization.", + "writeOnly" : true + }, + "OrgUserUpdateRequest" : { + "type" : "object", + "properties" : { + "roles" : { + "$ref" : "#/components/schemas/OrgUserRolesRequest" + }, + "teamIds" : { + "uniqueItems" : true, + "type" : "array", + "description" : "List of unique 24-hexadecimal digit strings that identifies the teams to assign the MongoDB Cloud user.", + "writeOnly" : true, + "items" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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:\n\n| Phase Value | Reason |\n|---|---|\n| CLOSED | MongoDB finalized all charges in the billing cycle but has yet to charge the customer. |\n| FAILED | MongoDB attempted to charge the provided credit card but charge for that amount failed. |\n| FORGIVEN | Customer initiated payment which MongoDB later forgave. |\n| FREE | All charges totalled zero so the customer won't be charged. |\n| INVOICED | MongoDB handled these charges using elastic invoicing. |\n| PAID | MongoDB succeeded in charging the provided credit card. |\n| PENDING | Invoice includes charges for the current billing cycle. |\n| PREPAID | Customer has a pre-paid plan so they won't be charged. |\n", + "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`.", + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "items" : { + "$ref" : "#/components/schemas/InvoiceLineItem" + } + }, + "linkedInvoices" : { + "type" : "array", + "description" : "List that contains the invoices for organizations linked to the paying organization.", + "readOnly" : true, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "items" : { + "$ref" : "#/components/schemas/BillingPayment" + } + }, + "refunds" : { + "type" : "array", + "description" : "List that contains payments that MongoDB returned to the organization for this invoice.", + "readOnly" : true, + "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:\n\n| Phase Value | Reason |\n|---|---|\n| CLOSED | MongoDB finalized all charges in the billing cycle but has yet to charge the customer. |\n| FAILED | MongoDB attempted to charge the provided credit card but charge for that amount failed. |\n| FORGIVEN | Customer initiated payment which MongoDB later forgave. |\n| FREE | All charges totalled zero so the customer won't be charged. |\n| INVOICED | MongoDB handled these charges using elastic invoicing. |\n| PAID | MongoDB succeeded in charging the provided credit card. |\n| PENDING | Invoice includes charges for the current billing cycle. |\n| PREPAID | Customer has a pre-paid plan so they won't be charged. |\n", + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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.\n\nThese phases include:\n\n| Phase Value | Reason |\n|---|---|\n| `CANCELLED` | Customer or MongoDB cancelled the payment. |\n| `ERROR` | Issue arose when attempting to complete payment. |\n| `FAILED` | MongoDB tried to charge the credit card without success. |\n| `FAILED_AUTHENTICATION` | Strong Customer Authentication has failed. Confirm that your payment method is authenticated. |\n| `FORGIVEN` | Customer initiated payment which MongoDB later forgave. |\n| `INVOICED` | MongoDB issued an invoice that included this line item. |\n| `NEW` | Customer provided a method of payment, but MongoDB hasn't tried to charge the credit card. |\n| `PAID` | Customer submitted a successful payment. |\n| `PARTIAL_PAID` | Customer paid for part of this line item. |\n", + "enum" : [ "NEW", "FORGIVEN", "FAILED", "PAID", "PARTIAL_PAID", "CANCELLED", "INVOICED", "ERROR", "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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the payment that the organization had made.", + "readOnly" : true + }, + "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" : { + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][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" : { + "maxLength" : 24, + "minLength" : 24, + "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_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", "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_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_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_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" ] + }, + "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`.", + "format" : "int32", + "readOnly" : true + } + } + }, + "VPCPeeringActionChallenge" : { + "type" : "object", + "properties" : { + "requesterAccountId" : { + "type" : "string", + "description" : "The AWS requester account ID." + }, + "requesterVpcId" : { + "type" : "string", + "description" : "The AWS requester VPC ID." + }, + "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" : "Container for elements used to challenge the user before taking certain actions on VPC Peering connections." + }, + "DBRoleToExecute" : { + "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" + } + }, + "role" : { + "type" : "string", + "description" : "The name of the role to use. Can be a built in role or a custom role." + }, + "type" : { + "title" : "DB Role Type", + "type" : "string", + "description" : "Type of the DB role. Can be either BuiltIn or Custom.", + "enum" : [ "BUILT_IN", "CUSTOM" ] + } + }, + "description" : "The name of a Built in or Custom DB Role to connect to an Atlas Cluster." + }, + "StreamsClusterConnection" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/StreamsConnection" + }, { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Name of the cluster configured for this connection." + }, + "dbRoleToExecute" : { + "$ref" : "#/components/schemas/DBRoleToExecute" + } + } + } ] + }, + "StreamsConnection" : { + "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 stream connection. In the case of the Sample type, this is the name of the sample source." + }, + "type" : { + "type" : "string", + "description" : "Type of the connection. Can be either Cluster or Kafka.", + "enum" : [ "Kafka", "Cluster", "Sample" ] + } + }, + "description" : "Settings that define a connection to an external data store.", + "readOnly" : true, + "discriminator" : { + "propertyName" : "type", + "mapping" : { + "Cluster" : "#/components/schemas/StreamsClusterConnection", + "Kafka" : "#/components/schemas/StreamsKafkaConnection", + "Sample" : "#/components/schemas/StreamsSampleConnection" + } }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/UpdateGroupRolesForUser" - }, - "x-xgen-version": "2023-01-01" - } - } + "oneOf" : [ { + "$ref" : "#/components/schemas/StreamsSampleConnection" + }, { + "$ref" : "#/components/schemas/StreamsClusterConnection" + }, { + "$ref" : "#/components/schemas/StreamsKafkaConnection" + } ] + }, + "StreamsKafkaAuthentication" : { + "type" : "object", + "properties" : { + "password" : { + "type" : "string", + "description" : "Password of the account to connect to the Kafka cluster.", + "format" : "password", + "writeOnly" : 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" + } + }, + "mechanism" : { + "type" : "string", + "description" : "Style of authentication. Can be one of PLAIN, SCRAM-256, or SCRAM-512." }, - "401": { - "$ref": "#/components/responses/unauthorized" + "username" : { + "type" : "string", + "description" : "Username of the account to connect to the Kafka cluster." + } + }, + "description" : "User credentials required to connect to a Kafka Cluster. Includes the authentication type, as well as the parameters for that authentication mode." + }, + "StreamsKafkaConnection" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/StreamsConnection" + }, { + "type" : "object", + "properties" : { + "authentication" : { + "$ref" : "#/components/schemas/StreamsKafkaAuthentication" + }, + "bootstrapServers" : { + "type" : "string", + "description" : "Comma separated list of server addresses." + }, + "config" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.", + "example" : "{\"group.protocol.type\":\"consumer\",\"debug\":\"queue, msg, protocol\"}" + }, + "description" : "A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.", + "example" : { + "group.protocol.type" : "consumer", + "debug" : "queue, msg, protocol" + } + }, + "networking" : { + "$ref" : "#/components/schemas/StreamsKafkaNetworking" + }, + "security" : { + "$ref" : "#/components/schemas/StreamsKafkaSecurity" + } + } + } ] + }, + "StreamsKafkaNetworking" : { + "type" : "object", + "properties" : { + "access" : { + "$ref" : "#/components/schemas/StreamsKafkaNetworkingAccess" + }, + "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" : "Networking Access Type can either be 'PUBLIC' (default) or VPC. VPC type is in public preview, please file a support ticket to enable VPC Network Access" + }, + "StreamsKafkaNetworkingAccess" : { + "type" : "object", + "properties" : { + "connectionId" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Reserved. Will be used by PRIVATE_LINK connection type.", + "example" : "32b6e34b3d91647abb20e7b8" }, - "403": { - "$ref": "#/components/responses/forbidden" + "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" + } }, - "404": { - "$ref": "#/components/responses/notFound" + "name" : { + "type" : "string", + "description" : "Reserved. Will be used by PRIVATE_LINK connection type." }, - "500": { - "$ref": "#/components/responses/internalServerError" + "type" : { + "title" : "Networking Access Type", + "type" : "string", + "description" : "Selected networking type. Either PUBLIC, VPC or PRIVATE_LINK. Defaults to PUBLIC. For VPC, ensure that VPC peering exists and connectivity has been established between Atlas VPC and the VPC where Kafka cluster is hosted for the connection to function properly. PRIVATE_LINK support is coming soon.", + "enum" : [ "PUBLIC", "VPC", "PRIVATE_LINK" ] } }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - } - }, - "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ThirdPartyIntegration" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" + "description" : "Information about the networking access." + }, + "StreamsKafkaSecurity" : { + "type" : "object", + "properties" : { + "brokerPublicCertificate" : { + "type" : "string", + "description" : "A trusted, public x509 certificate for connecting to Kafka over SSL." + }, + "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" + } + }, + "protocol" : { + "type" : "string", + "description" : "Describes the transport type. Can be either PLAINTEXT or SSL." + } + }, + "description" : "Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use." + }, + "StreamsSampleConnection" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/StreamsConnection" + } ] + }, + "StreamsPrivateLinkConnection" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "The ID of the Private Link connection." + }, + "dnsDomain" : { + "type" : "string", + "description" : "Domain name of Confluent cluster." + }, + "dnsSubDomain" : { + "type" : "array", + "description" : "Sub-Domain name of Confluent cluster. These are typically your availability zones.", + "items" : { + "type" : "string" + } + }, + "interfaceEndpointId" : { + "type" : "string", + "description" : "Interface endpoint ID that is created from the service endpoint ID provided." + }, + "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" + } + }, + "provider" : { + "type" : "string", + "description" : "Provider where the Kafka cluster is deployed." + }, + "region" : { + "type" : "string", + "description" : "Domain name of Confluent cluster." + }, + "serviceEndpointId" : { + "type" : "string", + "description" : "AWS Service Endpoint ID." + }, + "state" : { + "type" : "string", + "description" : "State the connection is in." }, - "500": { - "$ref": "#/components/responses/internalServerError" + "vendor" : { + "type" : "string", + "description" : "Vendor who manages the Kafka cluster." } }, - "security": [ - { - "DigestAuth": [] + "description" : "Container for metadata needed to create a Private Link connection." + }, + "ApiStreamsAWSRegionView" : { + "type" : "string", + "description" : "Atlas Streams AWS Regions.", + "enum" : [ "SYDNEY_AUS", "MUMBAI_IND", "FRANKFURT_DEU", "DUBLIN_IRL", "LONDON_GBR", "VIRGINIA_USA", "OREGON_USA", "SAOPAULO_BRA", "MONTREAL_CAN", "TOKYO_JPN", "SINGAPORE_SGP" ] + }, + "ApiStreamsAzureRegionView" : { + "type" : "string", + "description" : "Atlas Streams Azure Regions.", + "enum" : [ "VIRGINIA_USA", "AMSTERDAM_NLD" ] + }, + "BaseStreamsRegion" : { + "type" : "object", + "description" : "Name of the cloud provider region hosting Atlas Stream Processing.", + "oneOf" : [ { + "$ref" : "#/components/schemas/ApiStreamsAWSRegionView" + }, { + "$ref" : "#/components/schemas/ApiStreamsAzureRegionView" + } ] + }, + "StreamConfig" : { + "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" + } + }, + "tier" : { + "title" : "Stream Instance Tier", + "type" : "string", + "description" : "Selected tier for the Stream Instance. Configures Memory / VCPU allowances.", + "enum" : [ "SP30", "SP10" ] + } + }, + "description" : "Configuration options for an Atlas Stream Processing Instance.", + "nullable" : true + }, + "StreamsDataProcessRegion" : { + "required" : [ "cloudProvider", "region" ], + "type" : "object", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Label that identifies the cloud service provider where MongoDB Cloud performs stream processing. Currently, this parameter supports AWS only.", + "enum" : [ "AWS", "GCP", "AZURE", "TENANT", "SERVERLESS" ] + }, + "region" : { + "$ref" : "#/components/schemas/BaseStreamsRegion" + }, + "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" : "Information about the cloud provider region in which MongoDB Cloud processes the stream." + }, + "StreamsSampleConnections" : { + "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" + } + }, + "solar" : { + "type" : "boolean", + "description" : "Flag that indicates whether to add a 'sample_stream_solar' connection.", + "default" : false + } + }, + "description" : "Sample connections to add to SPI." + }, + "StreamsTenant" : { + "type" : "object", + "properties" : { + "_id" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "connections" : { + "type" : "array", + "description" : "List of connections configured in the stream instance.", + "readOnly" : true, + "items" : { + "$ref" : "#/components/schemas/StreamsConnection" + } + }, + "dataProcessRegion" : { + "$ref" : "#/components/schemas/StreamsDataProcessRegion" + }, + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "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 stream instance.", + "readOnly" : true, + "items" : { + "type" : "string", + "description" : "Unique hostname assigned to the stream instance.", + "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" + } + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the stream instance." + }, + "sampleConnections" : { + "$ref" : "#/components/schemas/StreamsSampleConnections" + }, + "streamConfig" : { + "$ref" : "#/components/schemas/StreamConfig" } - ], - "x-xgen-owner-team": "CAP" + } }, - "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 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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ThirdPartyIntegration" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedIntegrationView" - }, - "x-xgen-version": "2023-01-01" - } + "PaginatedApiStreamsConnectionView" : { + "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/StreamsConnection" } }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" + "totalCount" : { + "minimum" : 0, + "type" : "integer", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "format" : "int32", + "readOnly" : true + } + } + }, + "PaginatedApiStreamsTenantView" : { + "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" + } }, - "404": { - "$ref": "#/components/responses/notFound" + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", + "readOnly" : true, + "items" : { + "$ref" : "#/components/schemas/StreamsTenant" + } }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] + "totalCount" : { + "minimum" : 0, + "type" : "integer", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "format" : "int32", + "readOnly" : true } - ], - "x-xgen-owner-team": "CAP" + } }, - "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 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" - ] + "PaginatedApiStreamsPrivateLinkView" : { + "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" } }, - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/includeCount" + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", + "readOnly" : true, + "items" : { + "$ref" : "#/components/schemas/StreamsPrivateLinkConnection" + } }, - { - "$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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ThirdPartyIntegration" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedIntegrationView" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "CAP" - }, - "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 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.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/NoBody" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "CAP" - } - }, - "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedIntegrationView" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "CAP" - } - }, - "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/GroupInvitation" - } - }, - "x-xgen-version": "2023-01-01", - "x-sunset": "2024-10-04" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "deprecated": true, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - }, - "post": { - "tags": ["Projects"], - "summary": "Invite One MongoDB Cloud User to Join 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 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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/GroupInvitationRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/GroupInvitation" - }, - "x-xgen-version": "2023-01-01", - "x-sunset": "2024-10-04" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "deprecated": true, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - }, - "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 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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/GroupInvitationRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/GroupInvitation" - }, - "x-xgen-version": "2023-01-01", - "x-sunset": "2024-10-04" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "deprecated": true, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - } - }, - "/api/atlas/v2/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 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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/GroupInvitation" - }, - "x-xgen-version": "2023-01-01", - "x-sunset": "2024-10-04" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "deprecated": true, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - }, - "delete": { - "tags": ["Projects"], - "summary": "Cancel 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 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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "This endpoint does not return a response body.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/NoBody" - }, - "x-xgen-version": "2023-01-01", - "x-sunset": "2024-10-04" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "deprecated": true, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - }, - "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 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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "requestBody": { - "description": "Updates the details of one pending invitation to the specified project.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/GroupInvitationUpdateRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/GroupInvitation" - }, - "x-xgen-version": "2023-01-01", - "x-sunset": "2024-10-04" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "deprecated": true, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - } - }, - "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedTeamRoleView" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - }, - "post": { - "tags": ["Teams"], - "summary": "Add One or More Teams 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 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/vnd.atlas.2023-01-01+json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/TeamRole" - } - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedTeamRoleView" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - } - }, - "/api/atlas/v2/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 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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "This endpoint does not return a response body.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - }, - "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 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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "requestBody": { - "description": "The project roles assigned to the specified team.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/TeamRole" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedTeamRoleView" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - } - }, - "/api/atlas/v2/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 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": { - "maxLength": 24, - "minLength": 24, - "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/vnd.atlas.2023-01-01+json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UserAccessRoleAssignment" - } - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "This endpoint does not return a response body.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/NoBody" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - }, - "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 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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/pretty" - } - ], - "responses": { - "204": { - "description": "This endpoint does not return a response body.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/NoBody" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - }, - "patch": { - "tags": ["Programmatic API Keys"], - "summary": "Update Roles of One Organization API Key to 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": { - "maxLength": 24, - "minLength": 24, - "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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/UpdateAtlasProjectApiKey" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ApiKeyUserDetails" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - } - }, - "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedApiApiUserView" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - }, - "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 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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/CreateAtlasProjectApiKey" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ApiKeyUserDetails" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - } - }, - "/api/atlas/v2/groups/{groupId}/access": { - "post": { - "tags": ["Projects"], - "summary": "Add One MongoDB Cloud User to One Project", - "description": "Adds one MongoDB Cloud user to the specified project. If the MongoDB Cloud user is not a member of the project's organization, then the user must accept their invitation to the organization to access information within the specified project. If the MongoDB Cloud User is already a member of the project's organization, then they will be added to the project immediately and an invitation will not be returned by this resource. To use this resource, the requesting API Key must have the Group User Admin role.", - "operationId": "addUserToProject", - "parameters": [ - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "$ref": "#/components/parameters/envelope" - } - ], - "requestBody": { - "description": "Adds one MongoDB Cloud user to the specified project.", - "content": { - "application/vnd.atlas.2023-02-01+json": { - "schema": { - "$ref": "#/components/schemas/GroupInvitationRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-02-01+json": { - "schema": { - "$ref": "#/components/schemas/OrganizationInvitation" - }, - "x-xgen-version": "2023-02-01" - } - } - }, - "204": { - "description": "No Content", - "content": { - "application/vnd.atlas.2023-02-01+json": { - "x-xgen-version": "2023-02-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - } - }, - "/api/atlas/v2/groups/{groupId}:migrate": { - "post": { - "tags": ["Projects"], - "summary": "Migrate One Project to Another Organization", - "description": "Migrates a project from its current organization to another organization. All project users and their roles will be copied to the same project in the destination organization. You must include an organization API key with the Organization Owner role for the destination organization to verify access to the destination organization when you authenticate with Programmatic API Keys. Otherwise, the requesting user must have the Organization Owner role in both organizations. To use this resource, the requesting API Key must have the Organization Owner role.", - "operationId": "migrateProjectToAnotherOrg", - "parameters": [ - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/envelope" - } - ], - "requestBody": { - "description": "Migrates a project from its current organization to another organization.", - "content": { - "application/vnd.atlas.2024-05-30+json": { - "schema": { - "$ref": "#/components/schemas/GroupMigrationRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2024-05-30+json": { - "schema": { - "$ref": "#/components/schemas/Group" - }, - "x-xgen-version": "2024-05-30" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - } - }, - "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/OrganizationInvitation" - } - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - }, - "post": { - "tags": ["Organizations"], - "summary": "Invite One MongoDB Cloud User to Join 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 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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/OrganizationInvitationRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/OrganizationInvitation" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - }, - "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 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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/OrganizationInvitationRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/OrganizationInvitation" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - } - }, - "/api/atlas/v2/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 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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/OrganizationInvitation" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - }, - "delete": { - "tags": ["Organizations"], - "summary": "Cancel 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 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.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/NoBody" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - }, - "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 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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "requestBody": { - "description": "Updates the details of one pending invitation to the specified organization.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/OrganizationInvitationUpdateRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/OrganizationInvitation" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - } - }, - "/api/atlas/v2/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 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": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedApiAtlasCheckpointView" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "deprecated": true, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Backup - Atlas" - } - }, - "/api/atlas/v2/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 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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ApiAtlasCheckpointView" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "deprecated": true, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Backup - Atlas" - } - }, - "/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}": { - "get": { - "tags": ["Cloud Backups"], - "summary": "Return One AWS S3 Bucket or Azure Blob Storage Container Used for Cloud Backup Snapshot Exports", - "description": "Returns one AWS S3 Bucket or Azure Blob Storage Container associated with the specified Project. To use this resource, the requesting API Key must have the Project Read Only role.", - "operationId": "getExportBucket", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "name": "exportBucketId", - "in": "path", - "description": "Unique 24-hexadecimal character string that identifies the Export Bucket.", - "required": true, - "schema": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "example": "32b6e34b3d91647abb20e7b8" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2024-05-30+json": { - "schema": { - "$ref": "#/components/schemas/DiskBackupSnapshotExportBucket" - }, - "examples": { - "AWS": { - "description": "AWS", - "value": { - "_id": "32b6e34b3d91647abb20e7b8", - "bucketName": "export-bucket", - "cloudProvider": "AWS", - "iamRoleId": "668c5f0ed436263134491592", - "links": [ - { - "href": "https://cloud.mongodb.com/api/atlas", - "rel": "self" - } - ] - } - }, - "Azure": { - "description": "Azure", - "value": { - "_id": "32b6e34b3d91647abb20e7b8", - "bucketName": "export-container", - "cloudProvider": "AZURE", - "roleId": "668c5f0ed436263134491592", - "serviceUrl": "https://examplestorageaccount.blob.core.windows.net", - "tenantId": "4297fc77-1592-4de8-a6d5-a8c32401df87", - "links": [ - { - "href": "https://cloud.mongodb.com/api/atlas", - "rel": "self" - } - ] - } - } - }, - "x-xgen-version": "2024-05-30" - }, - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/DiskBackupSnapshotAWSExportBucket" - }, - "x-xgen-version": "2023-01-01", - "x-sunset": "2025-05-30" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Backup - Atlas" - }, - "delete": { - "tags": ["Cloud Backups"], - "summary": "Revoke Access to AWS S3 Bucket or Azure Blob Storage Container for Cloud Backup Snapshot Exports", - "description": "Revoke MongoDB Cloud access to the specified AWS S3 Bucket or Azure Blob Storage Container. This prevents this Export Bucket from receiving Atlas Cloud Backup Snapshots. 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 API Key must have the Project Owner role.", - "operationId": "deleteExportBucket", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "name": "exportBucketId", - "in": "path", - "description": "Unique string that identifies the AWS S3 Bucket or Azure Blob Storage Container to which you export your Snapshots.", - "required": true, - "schema": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "example": "32b6e34b3d91647abb20e7b8" - } - } - ], - "responses": { - "204": { - "description": "This endpoint does not return a response body.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/NoBody" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Backup - Atlas" - } - }, - "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports": { - "get": { - "tags": ["Cloud Backups"], - "summary": "Return All Cloud Backup Snapshot Export Jobs", - "description": "Returns all Cloud Backup snapshot export jobs associated with the specified Atlas cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role.", - "operationId": "listBackupExportJobs", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "$ref": "#/components/parameters/includeCount" - }, - { - "$ref": "#/components/parameters/itemsPerPage" - }, - { - "$ref": "#/components/parameters/pageNum" - }, - { - "name": "clusterName", - "in": "path", - "description": "Human-readable label that identifies the cluster.", - "required": true, - "schema": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedApiAtlasDiskBackupExportJobView" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Backup - Atlas" - }, - "post": { - "tags": ["Cloud Backups"], - "summary": "Create One Cloud Backup 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 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": { - "maxLength": 64, - "minLength": 1, - "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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/DiskBackupExportJobRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/DiskBackupExportJob" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Backup - Atlas" - } - }, - "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}": { - "get": { - "tags": ["Cloud Backups"], - "summary": "Return One Cloud Backup Snapshot Export Job", - "description": "Returns one Cloud Backup snapshot export job associated with the specified Atlas cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role.", - "operationId": "getBackupExportJob", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "name": "clusterName", - "in": "path", - "description": "Human-readable label that identifies the cluster.", - "required": true, - "schema": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - }, - { - "name": "exportId", - "in": "path", - "description": "Unique string that identifies the export job to return.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/DiskBackupExportJob" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Backup - Atlas" - } - }, - "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}": { - "get": { - "tags": ["Cloud Backups"], - "summary": "Return One Restore Job of One Cluster", - "description": "Returns one cloud backup restore job for one cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role.", - "operationId": "getBackupRestoreJob", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "name": "clusterName", - "in": "path", - "description": "Human-readable label that identifies the cluster with the restore jobs you want to return.", - "required": true, - "schema": { - "maxLength": 64, - "minLength": 1, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/DiskBackupSnapshotRestoreJob" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Backup - Atlas" - }, - "delete": { - "tags": ["Cloud Backups"], - "summary": "Cancel One Restore Job of One Cluster", - "description": "Cancels one cloud backup restore job of one cluster from the specified project. To use this resource, the requesting API Key must have the Project Owner role.", - "operationId": "cancelBackupRestoreJob", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "name": "clusterName", - "in": "path", - "description": "Human-readable label that identifies the cluster.", - "required": true, - "schema": { - "maxLength": 64, - "minLength": 1, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "This endpoint does not return a response body.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/NoBody" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "405": { - "$ref": "#/components/responses/methodNotAllowed" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Backup - Atlas" - } - }, - "/api/atlas/v2/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 API Key must have the Project Owner role.", - "operationId": "listBackupRestoreJobs", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/includeCount" - }, - { - "$ref": "#/components/parameters/itemsPerPage" - }, - { - "$ref": "#/components/parameters/pageNum" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "name": "clusterName", - "in": "path", - "description": "Human-readable label that identifies the cluster with the restore jobs you want to return.", - "required": true, - "schema": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedCloudBackupRestoreJobView" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Backup - Atlas" - }, - "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.\n\n To use this resource, the requesting API Key must have the Project Owner role.", - "operationId": "createBackupRestoreJob", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "name": "clusterName", - "in": "path", - "description": "Human-readable label that identifies the cluster.", - "required": true, - "schema": { - "maxLength": 64, - "minLength": 1, - "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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/DiskBackupSnapshotRestoreJob" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/DiskBackupSnapshotRestoreJob" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Backup - Atlas" - } - }, - "/api/atlas/v2/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 API Key must have the Project Read Only 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": { - "maxLength": 64, - "minLength": 1, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/DiskBackupShardedClusterSnapshot" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Backup - Atlas" - }, - "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 API Key must have the Project Owner 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": { - "maxLength": 64, - "minLength": 1, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "This endpoint does not return a response body.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/NoBody" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Backup - Atlas" - } - }, - "/api/atlas/v2/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 API Key must have the Project Read Only 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": { - "maxLength": 64, - "minLength": 1, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/DiskBackupReplicaSet" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Backup - Atlas" - }, - "delete": { - "tags": ["Cloud Backups"], - "summary": "Remove One Replica Set Cloud Backup", - "description": "Removes the specified snapshot. To use this resource, the requesting API Key must have the Project Owner role.", - "operationId": "deleteReplicaSetBackup", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "name": "clusterName", - "in": "path", - "description": "Human-readable label that identifies the cluster.", - "required": true, - "schema": { - "maxLength": 64, - "minLength": 1, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "This endpoint does not return a response body.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/NoBody" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Backup - Atlas" - }, - "patch": { - "tags": ["Cloud Backups"], - "summary": "Change Expiration Date for One Cloud Backup", - "description": "Changes the expiration date for one cloud backup snapshot for one cluster in the specified project.", - "operationId": "updateSnapshotRetention", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "name": "clusterName", - "in": "path", - "description": "Human-readable label that identifies the cluster.", - "required": true, - "schema": { - "maxLength": 64, - "minLength": 1, - "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": { - "maxLength": 24, - "minLength": 24, - "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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/BackupSnapshotRetention" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/DiskBackupReplicaSet" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Backup - Atlas" - } - }, - "/api/atlas/v2/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 API Key must have the Project Read Only 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": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedCloudBackupShardedClusterSnapshotView" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Backup - Atlas" - } - }, - "/api/atlas/v2/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 API Key must have the Project Read Only role.", - "operationId": "listReplicaSetBackups", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/includeCount" - }, - { - "$ref": "#/components/parameters/itemsPerPage" - }, - { - "$ref": "#/components/parameters/pageNum" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "name": "clusterName", - "in": "path", - "description": "Human-readable label that identifies the cluster.", - "required": true, - "schema": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedCloudBackupReplicaSetView" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Backup - Atlas" - }, - "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.\n\n To use this resource, the requesting API Key must have the Project Owner role.", - "operationId": "takeSnapshot", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "name": "clusterName", - "in": "path", - "description": "Human-readable label that identifies the cluster.", - "required": true, - "schema": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - } - ], - "requestBody": { - "description": "Takes one on-demand snapshot.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/DiskBackupOnDemandSnapshotRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/DiskBackupSnapshot" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Backup - Atlas" - } - }, - "/api/atlas/v2/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 API Key must have the Project Read Only role.\n\n Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the [Cloud Backup documentation](https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule). If you use the `BATCH-ID` query parameter, you can retrieve all restore jobs in the specified batch. When creating a restore job for a sharded cluster, MongoDB Cloud creates a separate job for each shard, plus another for the config server. Each of those jobs are part of a batch. However, a batch can't include a restore job for a replica set.", - "operationId": "listLegacyBackupRestoreJobs", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/includeCount" - }, - { - "$ref": "#/components/parameters/itemsPerPage" - }, - { - "$ref": "#/components/parameters/pageNum" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedRestoreJobView" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "deprecated": true, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Backup - Atlas" - }, - "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 API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the [Cloud Backup documentation](https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule). This endpoint doesn't support creating checkpoint restore jobs for sharded clusters, or creating restore jobs for queryable backup snapshots. If you create an automated restore job by specifying `delivery.methodName` of `AUTOMATED_RESTORE` in your request body, MongoDB Cloud removes all existing data on the target cluster prior to the restore.", - "operationId": "createLegacyBackupRestoreJob", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "name": "clusterName", - "in": "path", - "description": "Human-readable label that identifies the cluster with the snapshot you want to return.", - "required": true, - "schema": { - "maxLength": 64, - "minLength": 1, - "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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/BackupRestoreJob" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedRestoreJobView" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "deprecated": true, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Backup - Atlas" - } - }, - "/api/atlas/v2/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 API Key must have the Project Read Only role.\n\n Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the [Cloud Backup documentation](https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule).", - "operationId": "getLegacyBackupRestoreJob", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "name": "clusterName", - "in": "path", - "description": "Human-readable label that identifies the cluster with the snapshot you want to return.", - "required": true, - "schema": { - "maxLength": 64, - "minLength": 1, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/BackupRestoreJob" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "deprecated": true, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Backup - Atlas" - } - }, - "/api/atlas/v2/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 API Key must have the Project Owner role.", - "operationId": "listServerlessBackupRestoreJobs", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/includeCount" - }, - { - "$ref": "#/components/parameters/itemsPerPage" - }, - { - "$ref": "#/components/parameters/pageNum" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "name": "clusterName", - "in": "path", - "description": "Human-readable label that identifies the serverless instance.", - "required": true, - "schema": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedApiAtlasServerlessBackupRestoreJobView" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Backup - Private Cloud" - }, - "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 API Key must have the Project Owner role.", - "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": { - "maxLength": 64, - "minLength": 1, - "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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ServerlessBackupRestoreJob" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ServerlessBackupRestoreJob" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Backup - Private Cloud" - } - }, - "/api/atlas/v2/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 API Key must have the Project Owner role.", - "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": { - "maxLength": 64, - "minLength": 1, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ServerlessBackupRestoreJob" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Backup - Private Cloud" - } - }, - "/api/atlas/v2/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 API Key must have the Project Read Only role.", - "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": { - "maxLength": 64, - "minLength": 1, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "example": "32b6e34b3d91647abb20e7b8" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ServerlessBackupSnapshot" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Backup - Private Cloud" - } - }, - "/api/atlas/v2/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 API Key must have the Project Read Only role.", - "operationId": "listServerlessBackups", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "$ref": "#/components/parameters/includeCount" - }, - { - "$ref": "#/components/parameters/itemsPerPage" - }, - { - "$ref": "#/components/parameters/pageNum" - }, - { - "name": "clusterName", - "in": "path", - "description": "Human-readable label that identifies the serverless instance.", - "required": true, - "schema": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedApiAtlasServerlessBackupSnapshotView" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Backup - Private Cloud" - } - }, - "/api/atlas/v2/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 API Key must have the Project Read Only role.\n\n Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the [Cloud Backup documentation](https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule).", - "operationId": "getLegacySnapshotSchedule", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "name": "clusterName", - "in": "path", - "description": "Human-readable label that identifies the cluster with the snapshot you want to return.", - "required": true, - "schema": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ApiAtlasSnapshotScheduleView" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "deprecated": true, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Backup - Atlas" - }, - "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 API Key must have the Project Owner role.\n\n Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the [Cloud Backup documentation](https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule).", - "operationId": "updateLegacySnapshotSchedule", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "name": "clusterName", - "in": "path", - "description": "Human-readable label that identifies the cluster with the snapshot you want to return.", - "required": true, - "schema": { - "maxLength": 64, - "minLength": 1, - "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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ApiAtlasSnapshotScheduleView" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ApiAtlasSnapshotScheduleView" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "deprecated": true, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Backup - Atlas" - } - }, - "/api/atlas/v2/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 API Key must have the Project Read Only role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the [Cloud Backup documentation](https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule).", - "operationId": "getLegacySnapshot", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "name": "clusterName", - "in": "path", - "description": "Human-readable label that identifies the cluster.", - "required": true, - "schema": { - "maxLength": 64, - "minLength": 1, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/BackupSnapshot" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "deprecated": true, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Backup - Atlas" - }, - "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 API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the [Cloud Backup documentation](https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule).", - "operationId": "deleteLegacySnapshot", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "name": "clusterName", - "in": "path", - "description": "Human-readable label that identifies the cluster.", - "required": true, - "schema": { - "maxLength": 64, - "minLength": 1, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "This endpoint does not return a response body.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/NoBody" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "deprecated": true, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Backup - Atlas" - }, - "patch": { - "tags": ["Legacy Backup"], - "summary": "Change One Legacy Backup Snapshot Expiration", - "description": "Changes the expiration date for one legacy backup snapshot for one cluster in the specified project. To use this resource, the requesting API Key must have the Project Owner role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the [Cloud Backup documentation](https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule).", - "operationId": "updateLegacySnapshotRetention", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "name": "clusterName", - "in": "path", - "description": "Human-readable label that identifies the cluster.", - "required": true, - "schema": { - "maxLength": 64, - "minLength": 1, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "requestBody": { - "description": "Changes One Legacy Backup Snapshot Expiration.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/BackupSnapshot" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/BackupSnapshot" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "deprecated": true, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Backup - Atlas" - } - }, - "/api/atlas/v2/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 API Key must have the Project Read Only role. Effective 23 March 2020, all new clusters can use only Cloud Backups. When you upgrade to 4.2, your backup system upgrades to cloud backup if it is currently set to legacy backup. After this upgrade, all your existing legacy backup snapshots remain available. They expire over time in accordance with your retention policy. Your backup policy resets to the default schedule. If you had a custom backup policy in place with legacy backups, you must re-create it with the procedure outlined in the [Cloud Backup documentation](https://www.mongodb.com/docs/atlas/backup/cloud-backup/scheduling/#std-label-cloud-provider-backup-schedule).", - "operationId": "listLegacySnapshots", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/includeCount" - }, - { - "$ref": "#/components/parameters/itemsPerPage" - }, - { - "$ref": "#/components/parameters/pageNum" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "name": "clusterName", - "in": "path", - "description": "Human-readable label that identifies the cluster.", - "required": true, - "schema": { - "maxLength": 64, - "minLength": 1, - "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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedSnapshotView" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "deprecated": true, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Backup - Atlas" - } - }, - "/api/atlas/v2/groups/{groupId}/backupCompliancePolicy": { - "get": { - "tags": ["Cloud Backups"], - "summary": "Return the Backup Compliance Policy settings", - "description": "Returns the Backup Compliance Policy settings with the specified project. To use this resource, the requesting API Key must have the Project Owner role.", - "operationId": "getDataProtectionSettings", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/pretty" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-10-01+json": { - "schema": { - "$ref": "#/components/schemas/DataProtectionSettings20231001" - }, - "x-xgen-version": "2023-10-01" - }, - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/DataProtectionSettings" - }, - "x-xgen-version": "2023-01-01", - "x-sunset": "2024-10-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Backup - Atlas" - }, - "put": { - "tags": ["Cloud Backups"], - "summary": "Update or enable the Backup Compliance Policy settings", - "description": "Updates the Backup Compliance Policy settings for the specified project. To use this resource, the requesting API Key must have the Project Owner role.", - "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/vnd.atlas.2023-10-01+json": { - "schema": { - "$ref": "#/components/schemas/DataProtectionSettings20231001" - }, - "x-xgen-version": "2023-10-01" - }, - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/DataProtectionSettings" - }, - "x-xgen-version": "2023-01-01", - "x-sunset": "2024-10-01" - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-10-01+json": { - "schema": { - "$ref": "#/components/schemas/DataProtectionSettings20231001" - }, - "x-xgen-version": "2023-10-01" - }, - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/DataProtectionSettings" - }, - "x-xgen-version": "2023-01-01", - "x-sunset": "2024-10-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Backup - Atlas" - } - }, - "/api/atlas/v2/groups/{groupId}/backup/exportBuckets": { - "get": { - "tags": ["Cloud Backups"], - "summary": "Return All AWS S3 Buckets and Azure Blob Storage Containers Used for Cloud Backup Snapshot Exports", - "description": "Returns all AWS S3 buckets and Azure Blob Storage Containers associated with the specified Project. To use this resource, the requesting API Key must have the Project Read Only role.", - "operationId": "listExportBuckets", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/includeCount" - }, - { - "$ref": "#/components/parameters/itemsPerPage" - }, - { - "$ref": "#/components/parameters/pageNum" - }, - { - "$ref": "#/components/parameters/pretty" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2024-05-30+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedBackupSnapshotExportBucketsView" - }, - "x-xgen-version": "2024-05-30" - }, - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedBackupSnapshotExportBucketView" - }, - "x-xgen-version": "2023-01-01", - "x-sunset": "2025-05-30" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Backup - Atlas" - }, - "post": { - "tags": ["Cloud Backups"], - "summary": "Grant Access to AWS S3 Bucket or Azure Blob Storage Container for Cloud Backup Snapshot Exports", - "description": "Grants MongoDB Cloud access to the specified AWS S3 Bucket or Azure Blob Storage Container. This enables this Export Bucket to receive Atlas Cloud Backup Snapshots. To use this resource, the requesting API Key must have the Project Owner role.", - "operationId": "createExportBucket", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/pretty" - } - ], - "requestBody": { - "description": "Grants MongoDB Cloud access to the specified AWS S3 Bucket or Azure Blob Storage Container.", - "content": { - "application/vnd.atlas.2024-05-30+json": { - "schema": { - "$ref": "#/components/schemas/DiskBackupSnapshotExportBucket" - }, - "examples": { - "AWS": { - "description": "AWS", - "value": { - "bucketName": "export-bucket", - "cloudProvider": "AWS", - "iamRoleId": "668c5f0ed436263134491592" - } - }, - "Azure": { - "description": "Azure", - "value": { - "bucketName": "export-container", - "cloudProvider": "AZURE", - "roleId": "668c5f0ed436263134491592", - "serviceUrl": "https://examplestorageaccount.blob.core.windows.net", - "tenantId": "4297fc77-1592-4de8-a6d5-a8c32401df87" - } - } - }, - "x-xgen-version": "2024-05-30" - }, - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/DiskBackupSnapshotAWSExportBucket" - }, - "x-xgen-version": "2023-01-01", - "x-sunset": "2025-05-30" - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2024-05-30+json": { - "schema": { - "$ref": "#/components/schemas/DiskBackupSnapshotExportBucket" - }, - "examples": { - "AWS": { - "description": "AWS", - "value": { - "_id": "32b6e34b3d91647abb20e7b8", - "bucketName": "export-bucket", - "cloudProvider": "AWS", - "iamRoleId": "668c5f0ed436263134491592", - "links": [ - { - "href": "https://cloud.mongodb.com/api/atlas", - "rel": "self" - } - ] - } - }, - "Azure": { - "description": "Azure", - "value": { - "_id": "32b6e34b3d91647abb20e7b8", - "bucketName": "export-container", - "cloudProvider": "AZURE", - "roleId": "668c5f0ed436263134491592", - "serviceUrl": "https://examplestorageaccount.blob.core.windows.net", - "tenantId": "4297fc77-1592-4de8-a6d5-a8c32401df87", - "links": [ - { - "href": "https://cloud.mongodb.com/api/atlas", - "rel": "self" - } - ] - } - } - }, - "x-xgen-version": "2024-05-30" - }, - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/DiskBackupSnapshotAWSExportBucket" - }, - "x-xgen-version": "2023-01-01", - "x-sunset": "2025-05-30" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Backup - Atlas" - } - }, - "/api/atlas/v2/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 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": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2024-08-05+json": { - "schema": { - "$ref": "#/components/schemas/DiskBackupSnapshotSchedule20240805" - }, - "x-xgen-version": "2024-08-05" - }, - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/DiskBackupSnapshotSchedule" - }, - "x-xgen-version": "2023-01-01", - "x-sunset": "2025-08-05" - } - } - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Backup - Atlas" - }, - "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 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": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2024-08-05+json": { - "schema": { - "$ref": "#/components/schemas/DiskBackupSnapshotSchedule20240805" - }, - "x-xgen-version": "2024-08-05" - }, - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/DiskBackupSnapshotSchedule" - }, - "x-xgen-version": "2023-01-01", - "x-sunset": "2025-08-05" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Backup - Atlas" - }, - "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 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": { - "maxLength": 64, - "minLength": 1, - "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.\n\n**Note**: In the request body, provide only the fields that you want to update.", - "content": { - "application/vnd.atlas.2024-08-05+json": { - "schema": { - "$ref": "#/components/schemas/DiskBackupSnapshotSchedule20240805" - } - }, - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/DiskBackupSnapshotSchedule" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2024-08-05+json": { - "schema": { - "$ref": "#/components/schemas/DiskBackupSnapshotSchedule20240805" - }, - "x-xgen-version": "2024-08-05" - }, - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/DiskBackupSnapshotSchedule" - }, - "x-xgen-version": "2023-01-01", - "x-sunset": "2025-08-05" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Backup - Atlas" - } - }, - "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/CloudProviderAccessRoles" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - }, - "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 API Key must have the Project Owner role.", - "externalDocs": { - "description": "Set Up Access to Cloud Providers", - "url": "https://www.mongodb.com/docs/atlas/security/cloud-provider-access/" - }, - "operationId": "createCloudProviderAccessRole", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/pretty" - } - ], - "requestBody": { - "description": "Creates one role for the specified cloud provider.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/CloudProviderAccessRole" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/CloudProviderAccessRole" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - } - }, - "/api/atlas/v2/groups/{groupId}/cloudProviderAccess/{roleId}": { - "get": { - "tags": ["Cloud Provider Access"], - "summary": "Return specified 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 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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/CloudProviderAccessRole" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - }, - "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 API Key must have the Project Owner role. This API endpoint is one step in a procedure to create unified access for MongoDB Cloud services.", - "externalDocs": { - "description": "Set Up Access to Cloud Providers", - "url": "https://www.mongodb.com/docs/atlas/security/cloud-provider-access/" - }, - "operationId": "authorizeCloudProviderAccessRole", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "name": "roleId", - "in": "path", - "description": "Unique 24-hexadecimal digit string that identifies the role.", - "required": true, - "schema": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "requestBody": { - "description": "Grants access to the specified project for the specified access role.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/CloudProviderAccessRole" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/CloudProviderAccessRole" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - } - }, - "/api/atlas/v2/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 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"] - } - }, - { - "name": "roleId", - "in": "path", - "description": "Unique 24-hexadecimal digit string that identifies the role.", - "required": true, - "schema": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "No Content", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - } - }, - "/api/atlas/v2/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 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", - "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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedApiAtlasProviderRegionsView" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - } - }, - "/api/atlas/v2/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 API Key to have the Project Owner role.\n\n**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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/EncryptionAtRest" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - }, - "patch": { - "tags": ["Encryption at Rest using Customer Key Management"], - "summary": "Update Configuration for Encryption at Rest using Customer-Managed Keys 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 API Key to have the Project Owner role. This feature isn't available for `M0` free clusters, `M2`, `M5`, or serverless clusters.\n\n 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:\n\nIf you have enabled Encryption at Rest using Customer Key Management (CMK), Atlas requires all of the parameters for the desired encryption provider.\n\n- To use AWS Key Management Service (KMS), MongoDB Cloud requires all the fields in the **awsKms** object.\n- To use Azure Key Vault, MongoDB Cloud requires all the fields in the **azureKeyVault** object.\n- To use Google Cloud Key Management Service (KMS), MongoDB Cloud requires all the fields in the **googleCloudKms** object.\n\nIf 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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/EncryptionAtRest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/EncryptionAtRest" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - } - }, - "/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints/{endpointId}": { - "get": { - "tags": ["Encryption at Rest using Customer Key Management"], - "summary": "Return One Private Endpoint for Encryption at Rest Using Customer Key Management", - "description": "Returns one private endpoint, identified by its ID, for encryption at rest using Customer Key Management.", - "operationId": "getEncryptionAtRestPrivateEndpoint", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "name": "cloudProvider", - "in": "path", - "description": "Human-readable label that identifies the cloud provider of the private endpoint.", - "required": true, - "schema": { - "type": "string", - "enum": ["AZURE"] - } - }, - { - "name": "endpointId", - "in": "path", - "description": "Unique 24-hexadecimal digit string that identifies the private endpoint.", - "required": true, - "schema": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/EARPrivateEndpoint" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-hidden-env": { - "envs": "qa,stage,prod" - }, - "x-xgen-owner-team": "Atlas Dedicated" - }, - "delete": { - "tags": ["Encryption at Rest using Customer Key Management"], - "summary": "Delete Private Endpoint for Encryption at Rest Using Customer Key Management", - "description": "Deletes one private endpoint, identified by its ID, for encryption at rest using Customer Key Management.", - "operationId": "requestEncryptionAtRestPrivateEndpointDeletion", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "name": "cloudProvider", - "in": "path", - "description": "Human-readable label that identifies the cloud provider of the private endpoint to delete.", - "required": true, - "schema": { - "type": "string", - "enum": ["AZURE"] - } - }, - { - "name": "endpointId", - "in": "path", - "description": "Unique 24-hexadecimal digit string that identifies the private endpoint to delete.", - "required": true, - "schema": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "requestBody": { - "description": "Cloud provider of the private endpoints to delete and the list of cloud provider regions in which to delete the private endpoints.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/EncryptionAtRestPrivateEndpointRequest" - } - } - }, - "required": true - }, - "responses": { - "204": { - "description": "This endpoint does not return a response body.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/NoBody" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-hidden-env": { - "envs": "qa,stage,prod" - }, - "x-xgen-owner-team": "Atlas Dedicated" - } - }, - "/api/atlas/v2/groups/{groupId}/encryptionAtRest/{cloudProvider}/privateEndpoints": { - "get": { - "tags": ["Encryption at Rest using Customer Key Management"], - "summary": "Return Private Endpoints of a Cloud Provider for Encryption at Rest Using Customer Key Management for One Project", - "description": "Returns the private endpoints of the specified cloud provider for encryption at rest using customer key management.", - "operationId": "getEncryptionAtRestPrivateEndpointsForCloudProvider", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "name": "cloudProvider", - "in": "path", - "description": "Human-readable label that identifies the cloud provider for the private endpoints to return.", - "required": true, - "schema": { - "type": "string", - "enum": ["AZURE"] - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedApiAtlasEARPrivateEndpointView" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-hidden-env": { - "envs": "qa,stage,prod" - }, - "x-xgen-owner-team": "Atlas Dedicated" - }, - "post": { - "tags": ["Encryption at Rest using Customer Key Management"], - "summary": "Create One Private Endpoint in a Specified Region for Encryption at Rest Using Customer Key Management", - "description": "Creates a private endpoint in the specified region for encryption at rest using customer key management.", - "operationId": "createEncryptionAtRestPrivateEndpoint", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "name": "cloudProvider", - "in": "path", - "description": "Human-readable label that identifies the cloud provider for the private endpoint to create.", - "required": true, - "schema": { - "type": "string", - "enum": ["AZURE"] - } - } - ], - "requestBody": { - "description": "Creates a private endpoint in the specified region.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/EARPrivateEndpoint" - } - } - }, - "required": true - }, - "responses": { - "202": { - "description": "Accepted", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/EARPrivateEndpoint" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-hidden-env": { - "envs": "qa,stage,prod" - }, - "x-xgen-owner-team": "Atlas Dedicated" - } - }, - "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/restore": { - "post": { - "tags": ["Shared-Tier Restore Jobs"], - "summary": "Create One Restore Job from One M2 or M5 Cluster", - "description": "Restores the specified cluster. MongoDB Cloud limits which clusters can be the target clusters of a restore. The target cluster can't use encryption at rest, run a major release MongoDB version different than the snapshot, or receive client requests during restores. MongoDB Cloud deletes all existing data on the target cluster prior to the restore operation. To use this resource, the requesting API Key must have the Project Owner role.", - "operationId": "createSharedClusterBackupRestoreJob", - "parameters": [ - { - "name": "clusterName", - "in": "path", - "description": "Human-readable label that identifies the cluster.", - "required": true, - "schema": { - "maxLength": 64, - "minLength": 1, - "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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/TenantRestore" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/TenantRestore" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - } - }, - "/api/atlas/v2/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 API Key must have the Project Owner role.", - "operationId": "downloadSharedClusterBackup", - "parameters": [ - { - "name": "clusterName", - "in": "path", - "description": "Human-readable label that identifies the cluster.", - "required": true, - "schema": { - "maxLength": 64, - "minLength": 1, - "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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/TenantRestore" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/TenantRestore" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - } - }, - "/api/atlas/v2/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. To use this resource, the requesting API Key must have the Project Read Only role.", - "operationId": "getSharedClusterBackupRestoreJob", - "parameters": [ - { - "name": "clusterName", - "in": "path", - "description": "Human-readable label that identifies the cluster.", - "required": true, - "schema": { - "maxLength": 64, - "minLength": 1, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/TenantRestore" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - } - }, - "/api/atlas/v2/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 API Key must have the Project Read Only role.", - "operationId": "listSharedClusterBackupRestoreJobs", - "parameters": [ - { - "name": "clusterName", - "in": "path", - "description": "Human-readable label that identifies the cluster.", - "required": true, - "schema": { - "maxLength": 64, - "minLength": 1, - "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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedTenantRestoreView" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - } - }, - "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/tenant/snapshots/{snapshotId}": { - "get": { - "tags": ["Shared-Tier Snapshots"], - "summary": "Return One Snapshot for One M2 or M5 Cluster", - "description": "Returns details for one snapshot for the specified shared cluster. To use this resource, the requesting API Key must have the Project Read Only role.", - "operationId": "getSharedClusterBackup", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "name": "clusterName", - "in": "path", - "description": "Human-readable label that identifies the cluster.", - "required": true, - "schema": { - "maxLength": 64, - "minLength": 1, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/BackupTenantSnapshot" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - } - }, - "/api/atlas/v2/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 API Key must have the Project Read Only role.", - "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": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedTenantSnapshotView" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - } - }, - "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DataLakeTenant" - } - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Extended I" - }, - "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 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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/DataLakeTenant" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/DataLakeTenant" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Extended I" - } - }, - "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/DataLakeTenant" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Extended I" - }, - "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 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.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/NoBody" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Extended I" - }, - "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 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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/DataLakeTenant" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/DataLakeTenant" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Extended I" - } - }, - "/api/atlas/v2/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 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.\n\n| Limit Name | Description | Default |\n| --- | --- | --- |\n| bytesProcessed.query | Limit on the number of bytes processed during a single data federation query | N/A |\n| bytesProcessed.daily | Limit on the number of bytes processed for the data federation instance for the current day | N/A |\n| bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A |\n| bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A |\n", - "required": true, - "schema": { - "type": "string", - "enum": [ - "bytesProcessed.query", - "bytesProcessed.daily", - "bytesProcessed.weekly", - "bytesProcessed.monthly" - ] - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/DataFederationTenantQueryLimit" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Extended I" - }, - "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 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.\n\n| Limit Name | Description | Default |\n| --- | --- | --- |\n| bytesProcessed.query | Limit on the number of bytes processed during a single data federation query | N/A |\n| bytesProcessed.daily | Limit on the number of bytes processed for the data federation instance for the current day | N/A |\n| bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A |\n| bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A |\n", - "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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/NoBody" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Extended I" - }, - "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 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.\n\n| Limit Name | Description | Default |\n| --- | --- | --- |\n| bytesProcessed.query | Limit on the number of bytes processed during a single data federation query | N/A |\n| bytesProcessed.daily | Limit on the number of bytes processed for the data federation instance for the current day | N/A |\n| bytesProcessed.weekly | Limit on the number of bytes processed for the data federation instance for the current week | N/A |\n| bytesProcessed.monthly | Limit on the number of bytes processed for the data federation instance for the current month | N/A |\n", - "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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/DataFederationTenantQueryLimit" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/DataFederationTenantQueryLimit" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Extended I" - } - }, - "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DataFederationTenantQueryLimit" - } - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Extended I" - } - }, - "/api/atlas/v2/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 API Key must have the Project Owner or Project Data Access Read Write roles. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: \"Accept: application/vnd.atlas.YYYY-MM-DD+gzip\".", - "operationId": "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/vnd.atlas.2023-01-01+gzip": { - "schema": { - "type": "string", - "description": "Compressed archive labeled `queryLogs.gz` downloads", - "format": "binary" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Extended I" - } - }, - "/api/atlas/v2/groups/{groupId}/pipelines": { - "get": { - "tags": ["Data Lake Pipelines"], - "summary": "Return All Data Lake Pipelines from One Project", - "description": "Returns a list of Data Lake Pipelines. To use this resource, the requesting API Key must have the Project Read Only role.", - "operationId": "listPipelines", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DataLakeIngestionPipeline" - } - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Extended I" - }, - "post": { - "tags": ["Data Lake Pipelines"], - "summary": "Create One Data Lake Pipeline", - "description": "Creates one Data Lake Pipeline.", - "operationId": "createPipeline", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - } - ], - "requestBody": { - "description": "Creates one Data Lake Pipeline.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/DataLakeIngestionPipeline" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/DataLakeIngestionPipeline" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Extended I" - } - }, - "/api/atlas/v2/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 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": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[^/\\\\ \"$]{1,64}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/DataLakeIngestionPipeline" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Extended I" - }, - "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": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[^/\\\\ \"$]{1,64}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "This endpoint does not return a response body.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/NoBody" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Extended I" - }, - "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": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[^/\\\\ \"$]{1,64}$", - "type": "string" - } - } - ], - "requestBody": { - "description": "Updates one Data Lake Pipeline.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/DataLakeIngestionPipeline" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/DataLakeIngestionPipeline" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Extended I" - } - }, - "/api/atlas/v2/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 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": { - "maxLength": 64, - "minLength": 1, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "example": "32b6e34b3d91647abb20e7b8" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/IngestionPipelineRun" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Extended I" - }, - "delete": { - "tags": ["Data Lake Pipelines"], - "summary": "Delete 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": { - "maxLength": 64, - "minLength": 1, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "example": "32b6e34b3d91647abb20e7b8" - } - } - ], - "responses": { - "202": { - "description": "Accepted", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/RequestAccepted" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Extended I" - } - }, - "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules": { - "get": { - "tags": ["Data Lake Pipelines"], - "summary": "Return Available 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 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": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[^/\\\\ \"$]{1,64}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DiskBackupApiPolicyItem" - } - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Extended I" - } - }, - "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots": { - "get": { - "tags": ["Data Lake Pipelines"], - "summary": "Return Available 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 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", - "example": "2022-01-01T00:00:00.000Z" - } - }, - { - "name": "pipelineName", - "in": "path", - "description": "Human-readable label that identifies the Data Lake Pipeline.", - "required": true, - "schema": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[^/\\\\ \"$]{1,64}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedBackupSnapshotView" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Extended I" - } - }, - "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs": { - "get": { - "tags": ["Data Lake Pipelines"], - "summary": "Return All Data Lake Pipeline Runs from One Project", - "description": "Returns a list of past Data Lake Pipeline runs. To use this resource, the requesting API Key must have the Project Read Only role.", - "operationId": "listPipelineRuns", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/includeCount" - }, - { - "$ref": "#/components/parameters/itemsPerPage" - }, - { - "$ref": "#/components/parameters/pageNum" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "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", - "example": "2022-01-01T00:00:00.000Z" - } - }, - { - "name": "pipelineName", - "in": "path", - "description": "Human-readable label that identifies the Data Lake Pipeline.", - "required": true, - "schema": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[^/\\\\ \"$]{1,64}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedPipelineRunView" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Extended I" - } - }, - "/api/atlas/v2/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 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": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[^/\\\\ \"$]{1,64}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/DataLakeIngestionPipeline" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Extended I" - } - }, - "/api/atlas/v2/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 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": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[^/\\\\ \"$]{1,64}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/DataLakeIngestionPipeline" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Extended I" - } - }, - "/api/atlas/v2/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": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[^/\\\\ \"$]{1,64}$", - "type": "string" - } - } - ], - "requestBody": { - "description": "Triggers a single ingestion run of a snapshot.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/TriggerIngestionPipelineRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/IngestionPipelineRun" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Extended I" - } - }, - "/api/atlas/v2/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 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": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - } - ], - "requestBody": { - "description": "Creates one Atlas Search index on the specified collection.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ClusterSearchIndex" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ClusterSearchIndex" - }, - "x-xgen-version": "2023-01-01", - "x-sunset": "2025-06-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "deprecated": true, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Search Web Platform" - } - }, - "/api/atlas/v2/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 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": { - "maxLength": 64, - "minLength": 1, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ClusterSearchIndex" - }, - "x-xgen-version": "2023-01-01", - "x-sunset": "2025-06-01" - } - } - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "deprecated": true, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Search Web Platform" - }, - "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 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": { - "maxLength": 64, - "minLength": 1, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "This endpoint does not return a response body.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/NoBody" - }, - "x-xgen-version": "2023-01-01", - "x-sunset": "2025-06-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "deprecated": true, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Search Web Platform" - }, - "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 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": { - "maxLength": 64, - "minLength": 1, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "requestBody": { - "description": "Details to update on the Atlas Search index.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ClusterSearchIndex" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ClusterSearchIndex" - }, - "x-xgen-version": "2023-01-01", - "x-sunset": "2025-06-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "deprecated": true, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Search Web Platform" - } - }, - "/api/atlas/v2/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 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": { - "maxLength": 64, - "minLength": 1, - "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/vnd.atlas.2023-01-01+json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ClusterSearchIndex" - } - }, - "x-xgen-version": "2023-01-01", - "x-sunset": "2025-06-01" - } - } - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "deprecated": true, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Search Web Platform" - } - }, - "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/deployment": { - "get": { - "tags": ["Atlas Search"], - "summary": "Return Search Nodes", - "description": "Return the Search Nodes for the specified cluster.", - "operationId": "getAtlasSearchDeployment", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "name": "clusterName", - "in": "path", - "description": "Label that identifies the cluster to return the Search Nodes for.", - "required": true, - "schema": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ApiSearchDeploymentResponseView" - }, - "x-xgen-version": "2023-01-01", - "x-sunset": "2026-03-01" - }, - "application/vnd.atlas.2024-05-30+json": { - "schema": { - "$ref": "#/components/schemas/ApiSearchDeploymentResponseView" - }, - "x-xgen-version": "2024-05-30" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Search Web Platform" - }, - "post": { - "tags": ["Atlas Search"], - "summary": "Create Search Nodes", - "description": "Creates Search Nodes for the specified cluster.", - "operationId": "createAtlasSearchDeployment", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "name": "clusterName", - "in": "path", - "description": "Label that identifies the cluster to create Search Nodes for.", - "required": true, - "schema": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - } - ], - "requestBody": { - "description": "Creates Search Nodes for the specified cluster.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ApiSearchDeploymentRequestView" - } - }, - "application/vnd.atlas.2024-05-30+json": { - "schema": { - "$ref": "#/components/schemas/ApiSearchDeploymentRequestView" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ApiSearchDeploymentResponseView" - }, - "x-xgen-version": "2023-01-01", - "x-sunset": "2026-03-01" - } - } - }, - "201": { - "description": "Created", - "content": { - "application/vnd.atlas.2024-05-30+json": { - "schema": { - "$ref": "#/components/schemas/ApiSearchDeploymentResponseView" - }, - "x-xgen-version": "2024-05-30" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Search Web Platform" - }, - "delete": { - "tags": ["Atlas Search"], - "summary": "Delete Search Nodes", - "description": "Deletes the Search Nodes for the specified cluster.", - "operationId": "deleteAtlasSearchDeployment", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "name": "clusterName", - "in": "path", - "description": "Label that identifies the cluster to delete.", - "required": true, - "schema": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "x-xgen-version": "2023-01-01", - "x-sunset": "2026-03-01" - } - } - }, - "204": { - "description": "This endpoint does not return a response body.", - "content": { - "application/vnd.atlas.2024-05-30+json": { - "schema": { - "$ref": "#/components/schemas/NoBody" - }, - "x-xgen-version": "2024-05-30" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Search Web Platform" - }, - "patch": { - "tags": ["Atlas Search"], - "summary": "Update Search Nodes", - "description": "Updates the Search Nodes for the specified cluster.", - "operationId": "updateAtlasSearchDeployment", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "name": "clusterName", - "in": "path", - "description": "Label that identifies the cluster to update the Search Nodes for.", - "required": true, - "schema": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - } - ], - "requestBody": { - "description": "Updates the Search Nodes for the specified cluster.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ApiSearchDeploymentRequestView" - } - }, - "application/vnd.atlas.2024-05-30+json": { - "schema": { - "$ref": "#/components/schemas/ApiSearchDeploymentRequestView" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ApiSearchDeploymentResponseView" - }, - "x-xgen-version": "2023-01-01", - "x-sunset": "2026-03-01" - }, - "application/vnd.atlas.2024-05-30+json": { - "schema": { - "$ref": "#/components/schemas/ApiSearchDeploymentResponseView" - }, - "x-xgen-version": "2024-05-30" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Search Web Platform" - } - }, - "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes": { - "get": { - "tags": ["Atlas Search"], - "summary": "Return All Atlas Search Indexes for One Cluster", - "description": "Returns all Atlas Search indexes on the specified cluster. Atlas Search indexes contain the indexed fields and the analyzers used to create the indexes. To use this resource, the requesting 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": "listAtlasSearchIndexesCluster", - "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": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2024-05-30+json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SearchIndexResponse" - } - }, - "x-xgen-version": "2024-05-30" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - }, - "503": { - "description": "Service Unavailable.", - "content": { - "application/vnd.atlas.2024-05-30+json": { - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - } - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Search Web Platform" - }, - "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 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": "createAtlasSearchIndex", - "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": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - } - ], - "requestBody": { - "description": "Creates one Atlas Search index on the specified collection.", - "content": { - "application/vnd.atlas.2024-05-30+json": { - "schema": { - "$ref": "#/components/schemas/SearchIndexCreateRequest" - } - } - }, - "required": true - }, - "responses": { - "201": { - "description": "Created", - "content": { - "application/vnd.atlas.2024-05-30+json": { - "schema": { - "$ref": "#/components/schemas/SearchIndexResponse" - }, - "x-xgen-version": "2024-05-30" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Search Web Platform" - } - }, - "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{indexId}": { - "get": { - "tags": ["Atlas Search"], - "summary": "Return One Atlas Search Index by ID", - "description": "Returns one Atlas Search index in the specified project. You identify this index using its unique ID. Atlas Search index contains the indexed fields and the analyzers used to create the index. To use this resource, the requesting API Key must have the Project Data Access Read Write role.", - "externalDocs": { - "description": "Atlas Search Indexes", - "url": "https://dochub.mongodb.org/core/index-definitions-fts" - }, - "operationId": "getAtlasSearchIndex", - "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": { - "maxLength": 64, - "minLength": 1, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2024-05-30+json": { - "schema": { - "$ref": "#/components/schemas/SearchIndexResponse" - }, - "x-xgen-version": "2024-05-30" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - }, - "503": { - "description": "Service Unavailable.", - "content": { - "application/vnd.atlas.2024-05-30+json": { - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - } - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Search Web Platform" - }, - "delete": { - "tags": ["Atlas Search"], - "summary": "Remove One Atlas Search Index by Id", - "description": "Removes one Atlas Search index that you identified with its unique ID. To use this resource, the requesting API key must have the Project Data Access Admin role. This deletion is eventually consistent.", - "externalDocs": { - "description": "Atlas Search Indexes", - "url": "https://dochub.mongodb.org/core/index-definitions-fts" - }, - "operationId": "deleteAtlasSearchIndex", - "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": { - "maxLength": 64, - "minLength": 1, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "This endpoint does not return a response body.", - "content": { - "application/vnd.atlas.2024-05-30+json": { - "schema": { - "$ref": "#/components/schemas/NoBody" - }, - "x-xgen-version": "2024-05-30" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Search Web Platform" - }, - "patch": { - "tags": ["Atlas Search"], - "summary": "Update One Atlas Search Index By ID", - "description": "Updates one Atlas Search index that you identified with its unique ID. Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. To use this resource, the requesting API Key must have the Project Data Access Admin role.", - "externalDocs": { - "description": "Atlas Search Indexes", - "url": "https://dochub.mongodb.org/core/index-definitions-fts" - }, - "operationId": "updateAtlasSearchIndex", - "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 you want to update.", - "required": true, - "schema": { - "maxLength": 64, - "minLength": 1, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "requestBody": { - "description": "Details to update on the Atlas Search index.", - "content": { - "application/vnd.atlas.2024-05-30+json": { - "schema": { - "$ref": "#/components/schemas/SearchIndexUpdateRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2024-05-30+json": { - "schema": { - "$ref": "#/components/schemas/SearchIndexResponse" - }, - "x-xgen-version": "2024-05-30" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Search Web Platform" - } - }, - "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/indexes/{databaseName}/{collectionName}/{indexName}": { - "get": { - "tags": ["Atlas Search"], - "summary": "Return One Atlas Search Index by Name", - "description": "Returns one Atlas Search index in the specified project. You identify this index using its database, collection and name. Atlas Search index contains the indexed fields and the analyzers used to create the index. To use this resource, the requesting 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": "getAtlasSearchIndexByName", - "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": { - "maxLength": 64, - "minLength": 1, - "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": "Label that identifies the database that contains the collection with one or more Atlas Search indexes.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "indexName", - "in": "path", - "description": "Name of the Atlas Search index to return.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2024-05-30+json": { - "schema": { - "$ref": "#/components/schemas/SearchIndexResponse" - }, - "x-xgen-version": "2024-05-30" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Search Web Platform" - }, - "delete": { - "tags": ["Atlas Search"], - "summary": "Remove One Atlas Search Index by Name", - "description": "Removes one Atlas Search index that you identified with its database, collection, and name. To use this resource, the requesting API key must have the Project Data Access Admin role. This deletion is eventually consistent.", - "externalDocs": { - "description": "Atlas Search Indexes", - "url": "https://dochub.mongodb.org/core/index-definitions-fts" - }, - "operationId": "deleteAtlasSearchIndexByName", - "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": { - "maxLength": 64, - "minLength": 1, - "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": "Label that identifies the database that contains the collection with one or more Atlas Search indexes.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "indexName", - "in": "path", - "description": "Name of the Atlas Search index to delete.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "This endpoint does not return a response body.", - "content": { - "application/vnd.atlas.2024-05-30+json": { - "schema": { - "$ref": "#/components/schemas/NoBody" - }, - "x-xgen-version": "2024-05-30" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Search Web Platform" - }, - "patch": { - "tags": ["Atlas Search"], - "summary": "Update One Atlas Search Index By Name", - "description": "Updates one Atlas Search index that you identified with its database, collection name, and index name. Atlas Search indexes define the fields on which to create the index and the analyzers to use when creating the index. To use this resource, the requesting 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": "updateAtlasSearchIndexByName", - "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 you want to update.", - "required": true, - "schema": { - "maxLength": 64, - "minLength": 1, - "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": "Label that identifies the database that contains the collection with one or more Atlas Search indexes.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "indexName", - "in": "path", - "description": "Name of the Atlas Search index to update.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "Details to update the Atlas Search index with.", - "content": { - "application/vnd.atlas.2024-05-30+json": { - "schema": { - "$ref": "#/components/schemas/SearchIndexUpdateRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2024-05-30+json": { - "schema": { - "$ref": "#/components/schemas/SearchIndexResponse" - }, - "x-xgen-version": "2024-05-30" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Search Web Platform" - } - }, - "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/search/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 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": "listAtlasSearchIndexes", - "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": { - "maxLength": 64, - "minLength": 1, - "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": "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/vnd.atlas.2024-05-30+json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SearchIndexResponse" - } - }, - "x-xgen-version": "2024-05-30" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - }, - "503": { - "description": "Service Unavailable.", - "content": { - "application/vnd.atlas.2024-05-30+json": { - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - } - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Search Web Platform" - } - }, - "/api/atlas/v2/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 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": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - } - ], - "requestBody": { - "description": "Rolling index to create on the specified cluster.", - "content": { - "application/vnd.atlas.2023-01-01+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", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Intel III" - } - }, - "/api/atlas/v2/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 Specified 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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/MeasurementsIndexes" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Intel I" - } - }, - "/api/atlas/v2/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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/CloudSearchMetrics" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Intel I" - } - }, - "/api/atlas/v2/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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/MeasurementsIndexes" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Intel I" - } - }, - "/api/atlas/v2/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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/MeasurementsNonIndex" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Intel I" - } - }, - "/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}": { - "get": { - "tags": ["Access Tracking"], - "summary": "Return Database Access History for One Cluster using Its 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 API Key must have the Project Monitoring Admin role.", - "externalDocs": { - "description": "Database Access History", - "url": "https://docs.atlas.mongodb.com/access-tracking/" - }, - "operationId": "listAccessLogsByClusterName", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "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": { - "maxLength": 64, - "minLength": 1, - "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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/MongoDBAccessLogsList" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Intel II" - } - }, - "/api/atlas/v2/groups/{groupId}/dbAccessHistory/processes/{hostname}": { - "get": { - "tags": ["Access Tracking"], - "summary": "Return Database Access History for One Cluster using Its 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 API Key must have the Project Monitoring Admin role.", - "externalDocs": { - "description": "Database Access History", - "url": "https://docs.atlas.mongodb.com/access-tracking/" - }, - "operationId": "listAccessLogsByHostname", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/MongoDBAccessLogsList" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Intel II" - } - }, - "/api/atlas/v2/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 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.\n\n- If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time.\n- 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).\n\n- If you don't specify the **duration** parameter, the endpoint returns data covering from the **since** value and the current time.\n- 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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/Namespaces" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Intel II" - } - }, - "/api/atlas/v2/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 API Key must have the Project Data Access Read Write role.", - "operationId": "listSlowQueries", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "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.\n\n- If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time.\n- 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", - "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).\n\n- If you don't specify the **duration** parameter, the endpoint returns data covering from the **since** value and the current time.\n- 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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PerformanceAdvisorSlowQueryList" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Intel II" - } - }, - "/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/suggestedIndexes": { - "get": { - "tags": ["Performance Advisor"], - "summary": "Return 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 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.\n\n- If you don't specify the **since** parameter, the endpoint returns data covering the duration before the current time.\n- 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", - "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).\n\n- If you don't specify the **duration** parameter, the endpoint returns data covering from the **since** value and the current time.\n- 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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PerformanceAdvisorResponse" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Intel II" - } - }, - "/api/atlas/v2/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`, and serverless clusters have some [operational limits](https://www.mongodb.com/docs/atlas/reference/free-shared-limitations/#operational-limitations). The MongoDB Cloud process must be a `mongod`. To use this resource, the requesting API Key must have the Project Read Only role.", - "operationId": "listDatabases", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/includeCount" - }, - { - "$ref": "#/components/parameters/itemsPerPage" - }, - { - "$ref": "#/components/parameters/pageNum" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedDatabaseView" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Intel I" - } - }, - "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedDiskPartitionView" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Intel I" - } - }, - "/api/atlas/v2/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:\n- Throughput of I/O operations for the disk partition used for the MongoDB process\n- Percentage of time during which requests the partition issued and serviced\n- Latency per operation type of the disk partition used for the MongoDB process\n- Amount of free and used disk space on the disk partition used for the MongoDB process\n- Measurements for the host, such as CPU usage or number of I/O operations\n\nTo use this resource, the requesting API Key must have the Project Read Only role.", - "operationId": "getHostMeasurements", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "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", - "COMPUTED_MEMORY", - "CONNECTIONS", - "CURSORS_TOTAL_OPEN", - "CURSORS_TOTAL_TIMED_OUT", - "DB_DATA_SIZE_TOTAL", - "DB_STORAGE_TOTAL", - "DOCUMENT_METRICS_DELETED", - "DOCUMENT_METRICS_INSERTED", - "DOCUMENT_METRICS_RETURNED", - "DOCUMENT_METRICS_UPDATED", - "EXTRA_INFO_PAGE_FAULTS", - "FTS_DISK_UTILIZATION", - "FTS_MEMORY_MAPPED", - "FTS_MEMORY_RESIDENT", - "FTS_MEMORY_VIRTUAL", - "FTS_PROCESS_CPU_KERNEL", - "FTS_PROCESS_CPU_USER", - "FTS_PROCESS_NORMALIZED_CPU_KERNEL", - "FTS_PROCESS_NORMALIZED_CPU_USER", - "GLOBAL_ACCESSES_NOT_IN_MEMORY", - "GLOBAL_LOCK_CURRENT_QUEUE_READERS", - "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL", - "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS", - "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN", - "INDEX_COUNTERS_BTREE_ACCESSES", - "INDEX_COUNTERS_BTREE_HITS", - "INDEX_COUNTERS_BTREE_MISS_RATIO", - "INDEX_COUNTERS_BTREE_MISSES", - "JOURNALING_COMMITS_IN_WRITE_LOCK", - "JOURNALING_MB", - "JOURNALING_WRITE_DATA_FILES_MB", - "MAX_PROCESS_CPU_CHILDREN_KERNEL", - "MAX_PROCESS_CPU_CHILDREN_USER", - "MAX_PROCESS_CPU_KERNEL", - "MAX_PROCESS_CPU_USER", - "MAX_PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL", - "MAX_PROCESS_NORMALIZED_CPU_CHILDREN_USER", - "MAX_PROCESS_NORMALIZED_CPU_KERNEL", - "MAX_PROCESS_NORMALIZED_CPU_USER", - "MAX_SWAP_USAGE_FREE", - "MAX_SWAP_USAGE_USED ", - "MAX_SYSTEM_CPU_GUEST", - "MAX_SYSTEM_CPU_IOWAIT", - "MAX_SYSTEM_CPU_IRQ", - "MAX_SYSTEM_CPU_KERNEL", - "MAX_SYSTEM_CPU_SOFTIRQ", - "MAX_SYSTEM_CPU_STEAL", - "MAX_SYSTEM_CPU_USER", - "MAX_SYSTEM_MEMORY_AVAILABLE", - "MAX_SYSTEM_MEMORY_FREE", - "MAX_SYSTEM_MEMORY_USED", - "MAX_SYSTEM_NETWORK_IN", - "MAX_SYSTEM_NETWORK_OUT", - "MAX_SYSTEM_NORMALIZED_CPU_GUEST", - "MAX_SYSTEM_NORMALIZED_CPU_IOWAIT", - "MAX_SYSTEM_NORMALIZED_CPU_IRQ", - "MAX_SYSTEM_NORMALIZED_CPU_KERNEL", - "MAX_SYSTEM_NORMALIZED_CPU_NICE", - "MAX_SYSTEM_NORMALIZED_CPU_SOFTIRQ", - "MAX_SYSTEM_NORMALIZED_CPU_STEAL", - "MAX_SYSTEM_NORMALIZED_CPU_USER", - "MEMORY_MAPPED", - "MEMORY_RESIDENT", - "MEMORY_VIRTUAL", - "NETWORK_BYTES_IN", - "NETWORK_BYTES_OUT", - "NETWORK_NUM_REQUESTS", - "OP_EXECUTION_TIME_COMMANDS", - "OP_EXECUTION_TIME_READS", - "OP_EXECUTION_TIME_WRITES", - "OPCOUNTER_CMD", - "OPCOUNTER_DELETE", - "OPCOUNTER_GETMORE", - "OPCOUNTER_INSERT", - "OPCOUNTER_QUERY", - "OPCOUNTER_REPL_CMD", - "OPCOUNTER_REPL_DELETE", - "OPCOUNTER_REPL_INSERT", - "OPCOUNTER_REPL_UPDATE", - "OPCOUNTER_UPDATE", - "OPERATIONS_SCAN_AND_ORDER", - "OPLOG_MASTER_LAG_TIME_DIFF", - "OPLOG_MASTER_TIME", - "OPLOG_RATE_GB_PER_HOUR", - "OPLOG_SLAVE_LAG_MASTER_TIME", - "OPLOG_REPLICATION_LAG", - "PROCESS_CPU_CHILDREN_KERNEL", - "PROCESS_CPU_CHILDREN_USER", - "PROCESS_CPU_KERNEL", - "PROCESS_CPU_USER", - "PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL", - "PROCESS_NORMALIZED_CPU_CHILDREN_USER", - "PROCESS_NORMALIZED_CPU_KERNEL", - "PROCESS_NORMALIZED_CPU_USER", - "QUERY_EXECUTOR_SCANNED", - "QUERY_EXECUTOR_SCANNED_OBJECTS", - "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED", - "QUERY_TARGETING_SCANNED_PER_RETURNED", - "RESTARTS_IN_LAST_HOUR", - "SWAP_USAGE_FREE", - "SWAP_USAGE_USED", - "SYSTEM_CPU_GUEST", - "SYSTEM_CPU_IOWAIT", - "SYSTEM_CPU_IRQ", - "SYSTEM_CPU_KERNEL", - "SYSTEM_CPU_NICE", - "SYSTEM_CPU_SOFTIRQ", - "SYSTEM_CPU_STEAL", - "SYSTEM_CPU_USER", - "SYSTEM_MEMORY_AVAILABLE", - "SYSTEM_MEMORY_FREE", - "SYSTEM_MEMORY_USED", - "SYSTEM_NETWORK_IN", - "SYSTEM_NETWORK_OUT", - "SYSTEM_NORMALIZED_CPU_GUEST", - "SYSTEM_NORMALIZED_CPU_IOWAIT", - "SYSTEM_NORMALIZED_CPU_IRQ", - "SYSTEM_NORMALIZED_CPU_KERNEL", - "SYSTEM_NORMALIZED_CPU_NICE", - "SYSTEM_NORMALIZED_CPU_SOFTIRQ", - "SYSTEM_NORMALIZED_CPU_STEAL", - "SYSTEM_NORMALIZED_CPU_USER", - "TICKETS_AVAILABLE_READS", - "TICKETS_AVAILABLE_WRITE", - "OPERATION_THROTTLING_REJECTED_OPERATIONS" - ] - } - } - }, - { - "$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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ApiMeasurementsGeneralView_Atlas" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Intel I" - } - }, - "/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}": { - "get": { - "tags": ["Monitoring and Logs"], - "summary": "Return One Database for a MongoDB Process", - "description": "Returns one database running on the specified host for the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", - "operationId": "getDatabase", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/MesurementsDatabase" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Intel I" - } - }, - "/api/atlas/v2/groups/{groupId}/processes/{processId}/databases/{databaseName}/measurements": { - "get": { - "tags": ["Monitoring and Logs"], - "summary": "Return Measurements of One Database for 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 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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ApiMeasurementsGeneralView_Atlas" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Intel I" - } - }, - "/api/atlas/v2/groups/{groupId}/processes/{processId}/disks/{partitionName}": { - "get": { - "tags": ["Monitoring and Logs"], - "summary": "Return Measurements of 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 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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/MeasurementDiskPartition" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Intel I" - } - }, - "/api/atlas/v2/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:\n- Throughput of I/O operations for the disk partition used for the MongoDB process\n- Percentage of time during which requests the partition issued and serviced\n- Latency per operation type of the disk partition used for the MongoDB process\n- Amount of free and used disk space on the disk partition used for the MongoDB process\n\nTo use this resource, the requesting API Key must have the Project Read Only role.", - "operationId": "getDiskMeasurements", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "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" - ] - } - } - }, - { - "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/granularity" - }, - { - "$ref": "#/components/parameters/period" - }, - { - "$ref": "#/components/parameters/start" - }, - { - "$ref": "#/components/parameters/end" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ApiMeasurementsGeneralView_Atlas" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Intel I" - } - }, - "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedHostView_Atlas" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Intel I" - } - }, - "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ApiHostView_Atlas" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Intel I" - } - }, - "/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/performanceAdvisor/autoIndexing": { - "get": { - "tags": ["Performance Advisor"], - "summary": "Return Serverless Auto Indexing Enabled", - "description": "Get whether the Serverless Auto Indexing feature is enabled.", - "operationId": "getServerlessAutoIndexing", - "parameters": [ - { - "$ref": "#/components/parameters/groupId" - }, - { - "name": "clusterName", - "in": "path", - "description": "Human-readable label that identifies the cluster.", - "required": true, - "schema": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/pretty" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "type": "boolean" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Intel II" - }, - "post": { - "tags": ["Performance Advisor"], - "summary": "Set Serverless Auto Indexing", - "description": "Set whether the Serverless Auto Indexing feature is enabled.", - "operationId": "setServerlessAutoIndexing", - "parameters": [ - { - "$ref": "#/components/parameters/groupId" - }, - { - "name": "clusterName", - "in": "path", - "description": "Human-readable label that identifies the cluster.", - "required": true, - "schema": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - }, - { - "name": "enable", - "in": "query", - "description": "Value that we want to set for the Serverless Auto Indexing toggle.", - "required": true, - "schema": { - "type": "boolean" - } - }, - { - "$ref": "#/components/parameters/pretty" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/NoBody" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Intel II" - } - }, - "/api/atlas/v2/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 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.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Intel II" - } - }, - "/api/atlas/v2/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 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.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Intel II" - } - }, - "/api/atlas/v2/groups/{groupId}/managedSlowMs": { - "get": { - "tags": ["Performance Advisor"], - "summary": "Return Managed Slow MS enabled", - "description": "Get whether the Managed Slow MS feature is enabled.", - "operationId": "getManagedSlowMs", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/pretty" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Intel II" - } - }, - "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/{databaseName}/{collectionName}/collStats/measurements": { - "get": { - "tags": ["Collection Level Metrics"], - "summary": "Return Cluster-Level Query Latency", - "description": "Get a list of the Coll Stats Latency cluster-level measurements for the given namespace.", - "operationId": "getCollStatsLatencyNamespaceClusterMeasurements", - "parameters": [ - { - "$ref": "#/components/parameters/groupId" - }, - { - "name": "clusterName", - "in": "path", - "description": "Human-readable label that identifies the cluster to retrieve metrics for.", - "required": true, - "schema": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - }, - { - "name": "clusterView", - "in": "path", - "description": "Human-readable label that identifies the cluster topology to retrieve metrics for.", - "required": true, - "schema": { - "type": "string", - "enum": ["PRIMARY", "SECONDARY", "INDIVIDUAL_PROCESS"] - } - }, - { - "$ref": "#/components/parameters/databaseName" - }, - { - "$ref": "#/components/parameters/collectionName" - }, - { - "$ref": "#/components/parameters/envelope" - }, - { - "name": "metrics", - "in": "query", - "description": "List that contains the metrics that you want to retrieve for the associated data series. If you don't set this parameter, this resource returns data series for all Coll Stats Latency metrics.", - "style": "form", - "explode": true, - "schema": { - "uniqueItems": true, - "type": "array", - "items": { - "type": "string", - "description": "Metric requested for the given cluster", - "enum": [ - "READS_OPS", - "READS_LATENCY", - "AVERAGE_READS_LATENCY", - "READS_P50_VALUE", - "READS_P95_VALUE", - "READS_P99_VALUE", - "WRITES_OPS", - "WRITES_LATENCY", - "AVERAGE_WRITES_LATENCY", - "WRITES_P50_VALUE", - "WRITES_P95_VALUE", - "WRITES_P99_VALUE", - "COMMANDS_OPS", - "COMMANDS_LATENCY", - "AVERAGE_COMMANDS_LATENCY", - "COMMANDS_P50_VALUE", - "COMMANDS_P95_VALUE", - "COMMANDS_P99_VALUE", - "TOTAL_OPS", - "TOTAL_LATENCY", - "AVERAGE_TOTAL_OPS_LATENCY", - "TOTAL_OPS_P50_VALUE", - "TOTAL_OPS_P95_VALUE", - "TOTAL_OPS_P99_VALUE" - ] - } - } - }, - { - "$ref": "#/components/parameters/start" - }, - { - "$ref": "#/components/parameters/end" - }, - { - "$ref": "#/components/parameters/period" - } - ], - "responses": { - "200": { - "description": "Succeeded", - "content": { - "application/vnd.atlas.2023-11-15+json": { - "schema": { - "$ref": "#/components/schemas/MeasurementsCollStatsLatencyCluster" - }, - "x-xgen-version": "2023-11-15" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Intel I" - } - }, - "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/{clusterView}/collStats/namespaces": { - "get": { - "tags": ["Collection Level Metrics"], - "summary": "Return Ranked Namespaces from a Cluster", - "description": "Return the subset of namespaces from the given cluster sorted by highest total execution time (descending) within the given time window.", - "operationId": "getCollStatsLatencyNamespacesForCluster", - "parameters": [ - { - "$ref": "#/components/parameters/groupId" - }, - { - "name": "clusterName", - "in": "path", - "description": "Human-readable label that identifies the cluster to pin namespaces to.", - "required": true, - "schema": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - }, - { - "name": "clusterView", - "in": "path", - "description": "Human-readable label that identifies the cluster topology to retrieve metrics for.", - "required": true, - "schema": { - "type": "string", - "enum": ["PRIMARY", "SECONDARY", "INDIVIDUAL_PROCESS"] - } - }, - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/start" - }, - { - "$ref": "#/components/parameters/end" - }, - { - "$ref": "#/components/parameters/period" - } - ], - "responses": { - "200": { - "description": "Succeeded", - "content": { - "application/vnd.atlas.2023-11-15+json": { - "schema": { - "$ref": "#/components/schemas/CollStatsRankedNamespacesView" - }, - "x-xgen-version": "2023-11-15" - } - } - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Intel I" - } - }, - "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/pinned": { - "get": { - "tags": ["Collection Level Metrics"], - "summary": "Return Pinned Namespaces", - "description": "Returns a list of given cluster's pinned namespaces, a set of namespaces manually selected by users to collect query latency metrics on.", - "operationId": "getPinnedNamespaces", - "parameters": [ - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/envelope" - }, - { - "name": "clusterName", - "in": "path", - "description": "Human-readable label that identifies the cluster to retrieve pinned namespaces for.", - "required": true, - "schema": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-11-15+json": { - "schema": { - "$ref": "#/components/schemas/PinnedNamespaces" - }, - "x-xgen-version": "2023-11-15" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Intel I" - }, - "put": { - "tags": ["Collection Level Metrics"], - "summary": "Pin Namespaces", - "description": "Pin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster. This initializes a pinned namespaces list or replaces any existing pinned namespaces list for the Group and Cluster.", - "operationId": "pinNamespacesPut", - "parameters": [ - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/envelope" - }, - { - "name": "clusterName", - "in": "path", - "description": "Human-readable label that identifies the cluster to pin namespaces to.", - "required": true, - "schema": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - } - ], - "requestBody": { - "description": "List of namespace strings (combination of database and collection name) to pin for query latency metric collection.", - "content": { - "application/vnd.atlas.2023-11-15+json": { - "schema": { - "$ref": "#/components/schemas/NamespacesRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-11-15+json": { - "schema": { - "$ref": "#/components/schemas/PinnedNamespaces" - }, - "x-xgen-version": "2023-11-15" - } - } - }, - "201": { - "description": "Created", - "content": { - "application/vnd.atlas.2023-11-15+json": { - "schema": { - "$ref": "#/components/schemas/PinnedNamespaces" - }, - "x-xgen-version": "2023-11-15" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Intel I" - }, - "patch": { - "tags": ["Collection Level Metrics"], - "summary": "Add Pinned Namespaces", - "description": "Add provided list of namespaces to existing pinned namespaces list for collection-level latency metrics collection for the given Group and Cluster", - "operationId": "pinNamespacesPatch", - "parameters": [ - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/envelope" - }, - { - "name": "clusterName", - "in": "path", - "description": "Human-readable label that identifies the cluster to pin namespaces to.", - "required": true, - "schema": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - } - ], - "requestBody": { - "description": "List of namespace strings (combination of database and collection name) to pin for query latency metric collection.", - "content": { - "application/vnd.atlas.2023-11-15+json": { - "schema": { - "$ref": "#/components/schemas/NamespacesRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-11-15+json": { - "schema": { - "$ref": "#/components/schemas/PinnedNamespaces" - }, - "x-xgen-version": "2023-11-15" - } - } - }, - "201": { - "description": "Created", - "content": { - "application/vnd.atlas.2023-11-15+json": { - "schema": { - "$ref": "#/components/schemas/PinnedNamespaces" - }, - "x-xgen-version": "2023-11-15" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Intel I" - } - }, - "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collStats/unpin": { - "patch": { - "tags": ["Collection Level Metrics"], - "summary": "Unpin namespaces", - "description": "Unpin provided list of namespaces for collection-level latency metrics collection for the given Group and Cluster", - "operationId": "unpinNamespaces", - "parameters": [ - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/envelope" - }, - { - "name": "clusterName", - "in": "path", - "description": "Human-readable label that identifies the cluster to unpin namespaces from.", - "required": true, - "schema": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - } - ], - "requestBody": { - "description": "List of namespace strings (combination of database and collection name) to pin for query latency metric collection.", - "content": { - "application/vnd.atlas.2023-11-15+json": { - "schema": { - "$ref": "#/components/schemas/NamespacesRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-11-15+json": { - "schema": { - "$ref": "#/components/schemas/PinnedNamespaces" - }, - "x-xgen-version": "2023-11-15" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Intel I" - } - }, - "/api/atlas/v2/groups/{groupId}/collStats/metrics": { - "get": { - "tags": ["Collection Level Metrics"], - "summary": "Return all metric names", - "description": "Returns all available Coll Stats Latency metric names and their respective units for the specified project at the time of request.", - "operationId": "getCollStatsLatencyNamespaceMetrics", - "parameters": [ - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/envelope" - } - ], - "responses": { - "200": { - "description": "Succeeded", - "content": { - "application/vnd.atlas.2023-11-15+json": { - "schema": { - "$ref": "#/components/schemas/NoBody" - }, - "x-xgen-version": "2023-11-15" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Intel I" - } - }, - "/api/atlas/v2/groups/{groupId}/processes/{processId}/{databaseName}/{collectionName}/collStats/measurements": { - "get": { - "tags": ["Collection Level Metrics"], - "summary": "Return Host-Level Query Latency", - "description": "Get a list of the Coll Stats Latency process-level measurements for the given namespace", - "operationId": "getCollStatsLatencyNamespaceHostMeasurements", - "parameters": [ - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/processId" - }, - { - "$ref": "#/components/parameters/databaseName" - }, - { - "$ref": "#/components/parameters/collectionName" - }, - { - "$ref": "#/components/parameters/envelope" - }, - { - "name": "metrics", - "in": "query", - "description": "List that contains the metrics that you want to retrieve for the associated data series. If you don't set this parameter, this resource returns data series for all Coll Stats Latency metrics.", - "schema": { - "uniqueItems": true, - "type": "array", - "items": { - "type": "string", - "description": "Metric requested for the given process", - "enum": [ - "READS_OPS", - "READS_LATENCY", - "AVERAGE_READS_LATENCY", - "READS_P50_VALUE", - "READS_P95_VALUE", - "READS_P99_VALUE", - "WRITES_OPS", - "WRITES_LATENCY", - "AVERAGE_WRITES_LATENCY", - "WRITES_P50_VALUE", - "WRITES_P95_VALUE", - "WRITES_P99_VALUE", - "COMMANDS_OPS", - "COMMANDS_LATENCY", - "AVERAGE_COMMANDS_LATENCY", - "COMMANDS_P50_VALUE", - "COMMANDS_P95_VALUE", - "COMMANDS_P99_VALUE", - "TOTAL_OPS", - "TOTAL_LATENCY", - "AVERAGE_TOTAL_OPS_LATENCY", - "TOTAL_OPS_P50_VALUE", - "TOTAL_OPS_P95_VALUE", - "TOTAL_OPS_P99_VALUE" - ] - } - } - }, - { - "$ref": "#/components/parameters/start" - }, - { - "$ref": "#/components/parameters/end" - }, - { - "$ref": "#/components/parameters/period" - } - ], - "responses": { - "200": { - "description": "Succeeded", - "content": { - "application/vnd.atlas.2023-11-15+json": { - "schema": { - "$ref": "#/components/schemas/MeasurementsCollStatsLatencyHost" - }, - "x-xgen-version": "2023-11-15" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Intel I" - } - }, - "/api/atlas/v2/groups/{groupId}/processes/{processId}/collStats/namespaces": { - "get": { - "tags": ["Collection Level Metrics"], - "summary": "Return Ranked Namespaces from a Host", - "description": "Return the subset of namespaces from the given process ranked by highest total execution time (descending) within the given time window.", - "operationId": "getCollStatsLatencyNamespacesForHost", - "parameters": [ - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/processId" - }, - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/start" - }, - { - "$ref": "#/components/parameters/end" - }, - { - "$ref": "#/components/parameters/period" - } - ], - "responses": { - "200": { - "description": "Succeeded", - "content": { - "application/vnd.atlas.2023-11-15+json": { - "schema": { - "$ref": "#/components/schemas/CollStatsRankedNamespacesView" - }, - "x-xgen-version": "2023-11-15" - } - } - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Intel I" - } - }, - "/api/atlas/v2/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 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": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedOnlineArchiveView" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Online Archive II" - }, - "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 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": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - } - ], - "requestBody": { - "description": "Creates one online archive.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/BackupOnlineArchiveCreate" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/BackupOnlineArchive" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-changelog": { - "2023-08-02": "If 'criteria':'DATE' is specified, then you must specify 'DATE' values in partition fields" - }, - "x-xgen-owner-team": "Atlas Online Archive II" - } - }, - "/api/atlas/v2/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 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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/BackupOnlineArchive" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Online Archive II" - }, - "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 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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "This endpoint does not return a response body.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/NoBody" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Online Archive II" - }, - "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 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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - } - ], - "requestBody": { - "description": "Updates, pauses, or resumes one online archive.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/BackupOnlineArchive" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/BackupOnlineArchive" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Online Archive II" - } - }, - "/api/atlas/v2/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 API Key must have the Project Data Access Read Only or higher role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: \"Accept: application/vnd.atlas.YYYY-MM-DD+gzip\".", - "externalDocs": { - "description": "Online Archive", - "url": "https://docs.atlas.mongodb.com/online-archive/manage-online-archive/#std-label-manage-online-archive" - }, - "operationId": "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": { - "maxLength": 64, - "minLength": 1, - "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/vnd.atlas.2023-01-01+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" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Online Archive II" - } - }, - "/api/atlas/v2/unauth/controlPlaneIPAddresses": { - "get": { - "tags": ["Root"], - "summary": "Return All Control Plane IP Addresses", - "description": "Returns all control plane IP addresses. Currently, inbound Atlas control plane IP addresses are not yet available. The inbound IP address list in your API response is empty. To manually retrieve a list of inbound Atlas control plane IP addresses, see [Required Inbound Access](https://www.mongodb.com/docs/atlas/setup-cluster-security/#std-label-atlas-required-inbound-access).", - "operationId": "returnAllControlPlaneIPAddresses", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-11-15+json": { - "schema": { - "$ref": "#/components/schemas/ControlPlaneIPAddresses" - }, - "x-xgen-version": "2023-11-15" - } - } - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "x-xgen-owner-team": "Atlas Dedicated IV" - } - }, - "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/AWSCustomDNSEnabledView" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - }, - "patch": { - "tags": ["AWS Clusters DNS"], - "summary": "Toggle 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 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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/AWSCustomDNSEnabledView" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/AWSCustomDNSEnabledView" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - } - }, - "/api/atlas/v2/groups/{groupId}/mongoDBVersions": { - "get": { - "tags": ["Projects"], - "summary": "Return Available MongoDB LTS Versions for clusters in One Project", - "description": "Returns the MongoDB Long Term Support Major Versions available to new clusters in this project.", - "operationId": "getProjectLTSVersions", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "name": "cloudProvider", - "in": "query", - "description": "Filter results to only one cloud provider.", - "schema": { - "type": "string", - "enum": ["AWS", "AZURE", "GCP", "TENANT"] - } - }, - { - "name": "instanceSize", - "in": "query", - "description": "Filter results to only one instance size.", - "schema": { - "type": "string", - "example": "M10" - } - }, - { - "name": "defaultStatus", - "in": "query", - "description": "Filter results to only the default values per tier. This value must be DEFAULT.", - "schema": { - "type": "string", - "enum": ["DEFAULT"] - } - }, - { - "name": "itemsPerPage", - "in": "query", - "description": "Number of items that the response returns per page.", - "schema": { - "minimum": 1, - "type": "integer", - "format": "int64", - "example": 100, - "default": 100 - } - }, - { - "$ref": "#/components/parameters/pageNum" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedAvailableVersionView" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - } - }, - "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedCloudProviderContainerView" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - }, - "post": { - "tags": ["Network Peering"], - "summary": "Create One New 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 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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/CloudProviderContainer" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/CloudProviderContainer" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - } - }, - "/api/atlas/v2/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 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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "example": "32b6e34b3d91647abb20e7b8" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/CloudProviderContainer" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - }, - "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 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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "example": "32b6e34b3d91647abb20e7b8" - } - } - ], - "responses": { - "204": { - "description": "This endpoint does not return a response body.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/NoBody" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - }, - "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 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": { - "maxLength": 24, - "minLength": 24, - "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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/CloudProviderContainer" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/CloudProviderContainer" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - } - }, - "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedCloudProviderContainerView" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - } - }, - "/api/atlas/v2/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 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": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ClusterStatus" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - } - }, - "/api/atlas/v2/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": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ClusterOutageSimulation" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - }, - "post": { - "tags": ["Cluster Outage Simulation"], - "summary": "Start an 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": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - } - ], - "requestBody": { - "description": "Describes the outage simulation.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ClusterOutageSimulation" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ClusterOutageSimulation" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - }, - "delete": { - "tags": ["Cluster Outage Simulation"], - "summary": "End an 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": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ClusterOutageSimulation" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - } - }, - "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UserCustomDBRole" - } - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - }, - "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 API Key must have the Project Owner 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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/UserCustomDBRole" - } - } - }, - "required": true - }, - "responses": { - "202": { - "description": "Accepted", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/UserCustomDBRole" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - } - }, - "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/UserCustomDBRole" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - }, - "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 API Key must have the Project Atlas 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", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - }, - "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 API Key must have the Project Owner 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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/UpdateCustomDBRole" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/UserCustomDBRole" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - } - }, - "/api/atlas/v2/groups/{groupId}/databaseUsers": { - "get": { - "tags": ["Database Users"], - "summary": "Return All Database Users from One Project", - "description": "Returns all database users that belong to the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", - "operationId": "listDatabaseUsers", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/includeCount" - }, - { - "$ref": "#/components/parameters/itemsPerPage" - }, - { - "$ref": "#/components/parameters/pageNum" - }, - { - "$ref": "#/components/parameters/pretty" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedApiAtlasDatabaseUserView" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - }, - "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](https://cloud.mongodb.com/support). To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles.", - "operationId": "createDatabaseUser", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/pretty" - } - ], - "requestBody": { - "description": "Creates one database user in the specified project.", - "content": { - "application/vnd.atlas.2023-01-01+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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/CloudDatabaseUser" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - } - }, - "/api/atlas/v2/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 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:\n\n| Authentication Method | Parameter Needed | Parameter Value | username Format |\n|---|---|---|---|\n| AWS IAM | awsIAMType | ROLE | ARN |\n| AWS IAM | awsIAMType | USER | ARN |\n| x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |\n| OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name |\n| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |\n", - "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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/CloudDatabaseUser" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - }, - "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 API Key must have the Project Owner 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:\n\n| Authentication Method | Parameter Needed | Parameter Value | username Format |\n|---|---|---|---|\n| AWS IAM | awsIAMType | ROLE | ARN |\n| AWS IAM | awsIAMType | USER | ARN |\n| x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |\n| OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name |\n| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |\n", - "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.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/NoBody" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - }, - "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 API Key must have the Project Owner or Project Charts Admin roles.", - "operationId": "updateDatabaseUser", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "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:\n\n| Authentication Method | Parameter Needed | Parameter Value | username Format |\n|---|---|---|---|\n| AWS IAM | awsIAMType | ROLE | ARN |\n| AWS IAM | awsIAMType | USER | ARN |\n| x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |\n| OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name |\n| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |\n", - "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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/CloudDatabaseUser" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/CloudDatabaseUser" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - } - }, - "/api/atlas/v2/groups/{groupId}/databaseUsers/{username}/certs": { - "get": { - "tags": ["X.509 Authentication"], - "summary": "Return All X.509 Certificates Assigned to One MongoDB 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 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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedUserCertView" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - }, - "post": { - "tags": ["X.509 Authentication"], - "summary": "Create One X.509 Certificate for One MongoDB 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 API Key must have the Project Owner role.\n\nTo get MongoDB Cloud to generate a managed certificate for a database user, set `\"x509Type\" : \"MANAGED\"` on the desired MongoDB Database User.\n\nIf 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/vnd.atlas.2023-01-01+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/vnd.atlas.2023-01-01+json": { - "schema": { - "type": "string", - "description": "PEM file that contains the user's X.509 certificate and private key." - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - } - }, - "/api/atlas/v2/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 API Key must have the Project Owner role.", - "operationId": "deferMaintenanceWindow", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - } - }, - "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/GroupMaintenanceWindow" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - }, - "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 API Key must have the Project Owner role. Urgent maintenance activities such as security patches can't wait for your chosen window. MongoDB Cloud starts those maintenance activities when needed. After you schedule maintenance for your cluster, you can't change your maintenance window until the current maintenance efforts complete. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or unexpected system issues could delay the start time. To use this resource, the requesting API Key must have the Project Owner role.", - "operationId": "resetMaintenanceWindow", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - } - ], - "responses": { - "204": { - "description": "This endpoint does not return a response body.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - }, - "patch": { - "tags": ["Maintenance Windows"], - "summary": "Update 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. To use this resource, the requesting API Key must have the Project Owner role.", - "operationId": "updateMaintenanceWindow", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - } - ], - "requestBody": { - "description": "Updates the maintenance window for the specified project.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/GroupMaintenanceWindow" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/NoBody" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - } - }, - "/api/atlas/v2/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 API Key must have the Project Owner role.", - "operationId": "toggleMaintenanceAutoDefer", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - } - }, - "/api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade": { - "post": { - "tags": ["Clusters"], - "summary": "Upgrade One Shared-tier Cluster", - "description": "Upgrades a shared-tier cluster in the specified project. To use this resource, the requesting API key must have the Project Cluster Manager role. Each project supports up to 25 clusters.", - "operationId": "upgradeSharedCluster", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/pretty" - } - ], - "requestBody": { - "description": "Details of the shared-tier cluster upgrade in the specified project.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/LegacyAtlasTenantClusterUpgradeRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/LegacyAtlasCluster" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "402": { - "$ref": "#/components/responses/paymentRequired" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas" - } - }, - "/api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless": { - "post": { - "tags": ["Clusters"], - "summary": "Upgrades One Shared-Tier Cluster to the Serverless Instance", - "description": "Upgrades a shared-tier cluster to a serverless instance in the specified project. To use this resource, the requesting API key must have the Project Cluster Manager role.", - "operationId": "upgradeSharedClusterToServerless", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/pretty" - } - ], - "requestBody": { - "description": "Details of the shared-tier cluster upgrade in the specified project.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ServerlessInstanceDescription" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ServerlessInstanceDescription" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "402": { - "$ref": "#/components/responses/paymentRequired" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas" - } - }, - "/api/atlas/v2/groups/{groupId}/accessList": { - "get": { - "tags": ["Project IP Access List"], - "summary": "Return Project IP Access List", - "description": "Returns all access list entries from the specified project's IP access list. Each entry in the project's IP access list contains either one IP address or one CIDR-notated block of IP addresses. MongoDB Cloud only allows client connections to the cluster from entries in the project's IP access list. To use this resource, the requesting API Key must have the Project Read Only or Project Charts Admin roles. This resource replaces the whitelist resource. MongoDB Cloud removed whitelists in July 2021. Update your applications to use this new resource. The `/groups/{GROUP-ID}/accessList` endpoint manages the database IP access list. This endpoint is distinct from the `orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accesslist` endpoint, which manages the access list for MongoDB Cloud organizations.", - "externalDocs": { - "description": "IP access list", - "url": "https://docs.atlas.mongodb.com/security/ip-access-list/#std-label-access-list" - }, - "operationId": "listProjectIpAccessLists", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/includeCount" - }, - { - "$ref": "#/components/parameters/itemsPerPage" - }, - { - "$ref": "#/components/parameters/pageNum" - }, - { - "$ref": "#/components/parameters/pretty" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedNetworkAccessView" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas" - }, - "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 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/vnd.atlas.2023-01-01+json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/NetworkPermissionEntry" - } - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedNetworkAccessView" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas" - } - }, - "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/NetworkPermissionEntry" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas" - }, - "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 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:\n\n- how your application established the connection,\n- how MongoDB Cloud or the driver using the address behaves, and\n- 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.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/NoBody" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas" - } - }, - "/api/atlas/v2/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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/NetworkPermissionEntryStatus" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "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" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas" - } - }, - "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedContainerPeerView" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - }, - "post": { - "tags": ["Network Peering"], - "summary": "Create One New 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 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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/BaseNetworkPeeringConnectionSettings" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/BaseNetworkPeeringConnectionSettings" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - } - }, - "/api/atlas/v2/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 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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/BaseNetworkPeeringConnectionSettings" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - }, - "delete": { - "tags": ["Network Peering"], - "summary": "Remove One Existing 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 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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "responses": { - "202": { - "description": "Accepted", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/RequestAccepted" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - }, - "patch": { - "tags": ["Network Peering"], - "summary": "Update One New Network Peering Connection", - "description": "Updates one specified network peering connection in the specified project. To use this resource, the requesting API Key must have the Project Owner role.", - "operationId": "updatePeeringConnection", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "name": "peerId", - "in": "path", - "description": "Unique 24-hexadecimal digit string that identifies the network peering connection that you want to update.", - "required": true, - "schema": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "requestBody": { - "description": "Modify one network peering connection.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/BaseNetworkPeeringConnectionSettings" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/BaseNetworkPeeringConnectionSettings" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - } - }, - "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/CloudProviderEndpointServiceRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/EndpointService" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - } - }, - "/api/atlas/v2/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 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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "requestBody": { - "description": "Creates one private endpoint for the specified cloud service provider.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/CreateEndpointRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PrivateLinkEndpoint" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "402": { - "$ref": "#/components/responses/paymentRequired" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - } - }, - "/api/atlas/v2/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 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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PrivateLinkEndpoint" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - }, - "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 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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "This endpoint does not return a response body.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/NoBody" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - } - }, - "/api/atlas/v2/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 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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/EndpointService" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - }, - "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 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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "This endpoint does not return a response body.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/NoBody" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - } - }, - "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/EndpointService" - } - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - } - }, - "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ProjectSettingItemView" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - }, - "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 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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ProjectSettingItemView" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ProjectSettingItemView" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - } - }, - "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PrivateIPModeView" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "deprecated": true, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - }, - "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 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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PrivateIPModeView" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PrivateIPModeView" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "deprecated": true, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - } - }, - "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedPrivateNetworkEndpointIdEntryView" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Online Archive II" - }, - "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.\n\n `us-east-1` is `com.amazonaws.vpce.us-east-1.vpce-svc-00e311695874992b4`.\n\n `us-west-1` is `com.amazonaws.vpce.us-west-2.vpce-svc-09d86b19e59d1b4bb`.\n\n `eu-west-1` is `com.amazonaws.vpce.eu-west-1.vpce-svc-0824460b72e1a420e`.\n\n `eu-west-2` is `com.amazonaws.vpce.eu-west-2.vpce-svc-052f1840aa0c4f1f9`.\n\n `eu-central-1` is `com.amazonaws.vpce.eu-central-1.vpce-svc-0ac8ce91871138c0d`.\n\n `sa-east-1` is `com.amazonaws.vpce.sa-east-1.vpce-svc-0b56e75e8cdf50044`.\n\n `ap-southeast-2` is `com.amazonaws.vpce.ap-southeast-2.vpce-svc-036f1de74d761706e`.\n\n `ap-south-1` is `com.amazonaws.vpce.ap-south-1.vpce-svc-03eb8a541f96d356d`.\n\n To use this resource, the requesting API Key must have the Project Owner or Project Charts Admin roles.", - "operationId": "createDataFederationPrivateEndpoint", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/pretty" - } - ], - "requestBody": { - "description": "Private endpoint for Federated Database Instances and Online Archives to add to the specified project.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PrivateNetworkEndpointIdEntry" - } - } - }, - "required": true - }, - "responses": { - "201": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedPrivateNetworkEndpointIdEntryView" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Online Archive II" - } - }, - "/api/atlas/v2/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 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": { - "maxLength": 22, - "minLength": 22, - "pattern": "^vpce-[0-9a-f]{17}$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PrivateNetworkEndpointIdEntry" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Online Archive II" - }, - "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 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": { - "maxLength": 22, - "minLength": 22, - "pattern": "^vpce-[0-9a-f]{17}$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "This endpoint does not return a response body.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/NoBody" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Online Archive II" - } - }, - "/api/atlas/v2/groups/{groupId}/pushBasedLogExport": { - "get": { - "tags": ["Push-Based Log Export"], - "summary": "Get the push-based log export configuration for a project", - "description": "Fetches the current project level settings for the push-based log export feature.", - "operationId": "getPushBasedLogConfiguration", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/pretty" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PushBasedLogExportProject" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - }, - "post": { - "tags": ["Push-Based Log Export"], - "summary": "Enable the push-based log export feature for a project", - "description": "Configures the project level settings for the push-based log export feature.", - "operationId": "createPushBasedLogConfiguration", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/pretty" - } - ], - "requestBody": { - "description": "The project configuration details. The S3 bucket name, IAM role ID, and prefix path fields are required.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/CreatePushBasedLogExportProjectRequest" - }, - "x-xgen-version": "2023-01-01" - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - }, - "delete": { - "tags": ["Push-Based Log Export"], - "summary": "Disable the push-based log export feature for a project", - "description": "Disables the push-based log export feature by resetting the project level settings to its default configuration.", - "operationId": "deletePushBasedLogConfiguration", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/pretty" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - }, - "patch": { - "tags": ["Push-Based Log Export"], - "summary": "Update the push-based log export feature for a project", - "description": "Updates the project level settings for the push-based log export feature.", - "operationId": "updatePushBasedLogConfiguration", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/pretty" - } - ], - "requestBody": { - "description": "The project configuration details. The S3 bucket name, IAM role ID, and prefix path fields are the only fields that may be specified. Fields left unspecified will not be modified.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PushBasedLogExportProject" - }, - "x-xgen-version": "2023-01-01" - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - } - }, - "/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}": { - "get": { - "tags": ["LDAP Configuration"], - "summary": "Return the Status of One Verify LDAP Configuration Request", - "description": "Returns the status of one request to verify one LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role.", - "operationId": "getLDAPConfigurationStatus", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "name": "requestId", - "in": "path", - "description": "Unique string that identifies the request to verify an LDAP configuration.", - "required": true, - "schema": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/LDAPVerifyConnectivityJobRequest" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - } - }, - "/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify": { - "post": { - "tags": ["LDAP Configuration"], - "summary": "Verify the LDAP Configuration in One Project", - "description": "Verifies the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role.", - "operationId": "verifyLDAPConfiguration", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/pretty" - } - ], - "requestBody": { - "description": "The LDAP configuration for the specified project that you want to verify.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/LDAPVerifyConnectivityJobRequestParams" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/LDAPVerifyConnectivityJobRequest" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - } - }, - "/api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping": { - "delete": { - "tags": ["LDAP Configuration"], - "summary": "Remove the Current 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 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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/UserSecurity" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - } - }, - "/api/atlas/v2/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.\n\n 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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/UserSecurity" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - } - }, - "/api/atlas/v2/groups/{groupId}/userSecurity": { - "get": { - "tags": ["LDAP Configuration"], - "summary": "Return the Current LDAP or X.509 Configuration", - "description": "Returns the current LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role.", - "operationId": "getLDAPConfiguration", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/pretty" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/UserSecurity" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - }, - "patch": { - "tags": ["LDAP Configuration"], - "summary": "Edit the LDAP or X.509 Configuration", - "description": "Edits the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role.\n\nUpdating 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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/UserSecurity" - } - } - }, - "required": true - }, - "responses": { - "202": { - "description": "Accepted", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/UserSecurity" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - } - }, - "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}": { - "get": { - "tags": ["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 clusters with asymmetrically-sized shards. To use this resource, the requesting API Key must have the Project Read Only role. This feature is not available for serverless clusters.", - "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": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/LegacyAtlasCluster" - }, - "x-xgen-version": "2023-01-01", - "x-sunset": "2025-06-01" - }, - "application/vnd.atlas.2023-02-01+json": { - "schema": { - "$ref": "#/components/schemas/AdvancedClusterDescription" - }, - "x-xgen-version": "2023-02-01", - "x-sunset": "2026-03-01" - }, - "application/vnd.atlas.2024-08-05+json": { - "schema": { - "$ref": "#/components/schemas/ClusterDescription20240805" - }, - "x-xgen-version": "2024-08-05" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - }, - "delete": { - "tags": ["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 API Key must have the Project Owner role. This feature is not available for serverless clusters.", - "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": { - "maxLength": 64, - "minLength": 1, - "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", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "x-xgen-version": "2023-01-01", - "x-sunset": "2025-06-01" - }, - "application/vnd.atlas.2023-02-01+json": { - "x-xgen-version": "2023-02-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - }, - "patch": { - "tags": ["Clusters"], - "summary": "Modify One Cluster from 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 clusters with asymmetrically-sized shards. To update a cluster's termination protection, the requesting API Key must have the Project Owner role. For all other updates, the requesting API Key must have the Project Cluster Manager role. You can't modify a paused cluster (`paused : true`). You must call this endpoint to set `paused : false`. After this endpoint responds with `paused : false`, you can call it again with the changes you want to make to the cluster. This feature is not available for serverless clusters.", - "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": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - } - ], - "requestBody": { - "description": "Cluster to update in the specified project.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/LegacyAtlasCluster" - } - }, - "application/vnd.atlas.2023-02-01+json": { - "schema": { - "$ref": "#/components/schemas/AdvancedClusterDescription" - } - }, - "application/vnd.atlas.2024-08-05+json": { - "schema": { - "$ref": "#/components/schemas/ClusterDescription20240805" - }, - "x-xgen-version": "2024-08-05" - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/LegacyAtlasCluster" - }, - "x-xgen-version": "2023-01-01", - "x-sunset": "2025-06-01" - }, - "application/vnd.atlas.2023-02-01+json": { - "schema": { - "$ref": "#/components/schemas/AdvancedClusterDescription" - }, - "x-xgen-version": "2023-02-01", - "x-sunset": "2026-03-01" - }, - "application/vnd.atlas.2024-08-05+json": { - "schema": { - "$ref": "#/components/schemas/ClusterDescription20240805" - }, - "x-xgen-version": "2024-08-05" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - } - }, - "/api/atlas/v2/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 and contain log data from the previous five minutes. If you poll the API for log files, we recommend polling every five minutes. For example, if the logs are updated at 4:00 UTC and then you poll the API, the API returns log data from the interval between 3:55 UTC and 4:00 UTC. This feature isn't available for `M0` free clusters, `M2`, `M5`, or serverless clusters. To use this resource, the requesting API Key must have the Project Data Access Read Only or higher role. 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": "Date and time when the period specifies the inclusive ending point for the range of log messages to retrieve. This parameter expresses its value in the number of seconds that have elapsed since the UNIX epoch.", - "schema": { - "minimum": 1199145600, - "type": "integer", - "format": "int64" - } - }, - { - "name": "startDate", - "in": "query", - "description": "Date and time when the period specifies the inclusive starting point for the range of log messages to retrieve. This parameter expresses its value in the number of seconds that have elapsed since the UNIX epoch.", - "schema": { - "minimum": 1199145600, - "type": "integer", - "format": "int64" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-02-01+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" - }, - "x-xgen-version": "2023-02-01" - }, - "application/vnd.atlas.2023-01-01+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" - }, - "x-xgen-version": "2023-01-01", - "x-sunset": "2025-06-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - } - }, - "/api/atlas/v2/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 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": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "x-xgen-version": "2023-01-01", - "x-sunset": "2025-06-01" - }, - "application/vnd.atlas.2023-02-01+json": { - "x-xgen-version": "2023-02-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - } - }, - "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:pinFeatureCompatibilityVersion": { - "post": { - "tags": ["Clusters"], - "summary": "Pin FCV for One Cluster from One Project", - "description": "Pins the FCV to the current MongoDB version.", - "operationId": "pinFeatureCompatibilityVersion", - "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": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - } - ], - "requestBody": { - "description": "Optional request params for tuning FCV pinning configuration.", - "content": { - "application/vnd.atlas.2024-05-30+json": { - "schema": { - "$ref": "#/components/schemas/PinFCVView" - }, - "x-xgen-version": "2024-05-30" - } - } - }, - "responses": { - "204": { - "description": "This endpoint does not return a response body.", - "content": { - "application/vnd.atlas.2024-05-30+json": { - "schema": { - "$ref": "#/components/schemas/NoBody" - }, - "x-xgen-version": "2024-05-30" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-hidden-env": { - "envs": "qa,stage,prod" - }, - "x-xgen-owner-team": "Atlas Dedicated" - } - }, - "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:unpinFeatureCompatibilityVersion": { - "post": { - "tags": ["Clusters"], - "summary": "Unpins FCV for One Cluster from One Project", - "description": "Unpins the current fixed Feature Compatibility Version. This feature is not available for clusters on rapid release.", - "operationId": "unpinFeatureCompatibilityVersion", - "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": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "This endpoint does not return a response body.", - "content": { - "application/vnd.atlas.2024-05-30+json": { - "schema": { - "$ref": "#/components/schemas/NoBody" - }, - "x-xgen-version": "2024-05-30" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "402": { - "$ref": "#/components/responses/paymentRequired" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-hidden-env": { - "envs": "qa,stage,prod" - }, - "x-xgen-owner-team": "Atlas Dedicated" - } - }, - "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites/customZoneMapping": { - "post": { - "tags": ["Global Clusters"], - "summary": "Add One Entry to One Custom Zone Mapping", - "description": "Creates one custom zone mapping for the specified global cluster. A custom zone mapping matches one ISO 3166-2 location code to a zone in your global cluster. By default, MongoDB Cloud maps each location code to the closest geographical zone. To use this resource, the requesting API Key must have the Project Owner role.", - "externalDocs": { - "description": "Global Clusters", - "url": "https://www.mongodb.com/docs/atlas/global-clusters/" - }, - "operationId": "createCustomZoneMapping", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "name": "clusterName", - "in": "path", - "description": "Human-readable label that identifies this cluster.", - "required": true, - "schema": { - "maxLength": 64, - "minLength": 1, - "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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/CustomZoneMappings" - } - }, - "application/vnd.atlas.2023-02-01+json": { - "schema": { - "$ref": "#/components/schemas/CustomZoneMappings" - } - }, - "application/vnd.atlas.2024-08-05+json": { - "schema": { - "$ref": "#/components/schemas/CustomZoneMappings" - }, - "x-xgen-version": "2024-08-05" - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/GeoSharding" - }, - "x-xgen-version": "2023-01-01", - "x-sunset": "2025-06-01" - }, - "application/vnd.atlas.2023-02-01+json": { - "schema": { - "$ref": "#/components/schemas/GeoSharding" - }, - "x-xgen-version": "2023-02-01", - "x-sunset": "2026-03-01" - }, - "application/vnd.atlas.2024-08-05+json": { - "schema": { - "$ref": "#/components/schemas/GeoSharding20240805" - }, - "x-xgen-version": "2024-08-05" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - }, - "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 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": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/GeoSharding" - }, - "x-xgen-version": "2023-01-01", - "x-sunset": "2025-06-01" - }, - "application/vnd.atlas.2023-02-01+json": { - "schema": { - "$ref": "#/components/schemas/GeoSharding" - }, - "x-xgen-version": "2023-02-01", - "x-sunset": "2026-03-01" - }, - "application/vnd.atlas.2024-08-05+json": { - "schema": { - "$ref": "#/components/schemas/GeoSharding20240805" - }, - "x-xgen-version": "2024-08-05" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - } - }, - "/api/atlas/v2/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 API Key must have the Project Data Access Admin role.", - "externalDocs": { - "description": "Global Clusters", - "url": "https://www.mongodb.com/docs/atlas/global-clusters/" - }, - "operationId": "createManagedNamespace", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "name": "clusterName", - "in": "path", - "description": "Human-readable label that identifies this cluster.", - "required": true, - "schema": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - } - ], - "requestBody": { - "description": "Managed namespace to create within the specified global cluster.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ManagedNamespaces" - } - }, - "application/vnd.atlas.2023-02-01+json": { - "schema": { - "$ref": "#/components/schemas/ManagedNamespaces" - } - }, - "application/vnd.atlas.2024-08-05+json": { - "schema": { - "$ref": "#/components/schemas/ManagedNamespaces" - }, - "x-xgen-version": "2024-08-05" - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/GeoSharding" - }, - "x-xgen-version": "2023-01-01", - "x-sunset": "2025-06-01" - }, - "application/vnd.atlas.2023-02-01+json": { - "schema": { - "$ref": "#/components/schemas/GeoSharding" - }, - "x-xgen-version": "2023-02-01", - "x-sunset": "2026-03-01" - }, - "application/vnd.atlas.2024-08-05+json": { - "schema": { - "$ref": "#/components/schemas/GeoSharding20240805" - }, - "x-xgen-version": "2024-08-05" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "405": { - "$ref": "#/components/responses/methodNotAllowed" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - }, - "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 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": { - "maxLength": 64, - "minLength": 1, - "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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/GeoSharding" - }, - "x-xgen-version": "2023-01-01", - "x-sunset": "2025-06-01" - }, - "application/vnd.atlas.2023-02-01+json": { - "schema": { - "$ref": "#/components/schemas/GeoSharding" - }, - "x-xgen-version": "2023-02-01", - "x-sunset": "2026-03-01" - }, - "application/vnd.atlas.2024-08-05+json": { - "schema": { - "$ref": "#/components/schemas/GeoSharding20240805" - }, - "x-xgen-version": "2024-08-05" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - } - }, - "/api/atlas/v2/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 includes clusters with asymmetrically-sized shards. To use this resource, the requesting API Key must have the Project Read Only role. This feature is not available for serverless clusters.", - "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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedLegacyClusterView" - }, - "x-xgen-version": "2023-01-01", - "x-sunset": "2025-06-01" - }, - "application/vnd.atlas.2023-02-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedAdvancedClusterDescriptionView" - }, - "x-xgen-version": "2023-02-01", - "x-sunset": "2026-03-01" - }, - "application/vnd.atlas.2024-08-05+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedClusterDescription20240805" - }, - "x-xgen-version": "2024-08-05" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - }, - "post": { - "tags": ["Clusters"], - "summary": "Create One Cluster from 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 clusters with asymmetrically-sized shards. Each project supports up to 25 database deployments. To use this resource, the requesting API Key must have the Project Owner role. This feature is not available for serverless clusters.", - "operationId": "createCluster", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/pretty" - } - ], - "requestBody": { - "description": "Cluster to create in the specific project.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/LegacyAtlasCluster" - } - }, - "application/vnd.atlas.2023-02-01+json": { - "schema": { - "$ref": "#/components/schemas/AdvancedClusterDescription" - } - }, - "application/vnd.atlas.2024-08-05+json": { - "schema": { - "$ref": "#/components/schemas/ClusterDescription20240805" - }, - "examples": { - "Cluster": { - "description": "Cluster", - "value": "{\n \"clusterType\": \"SHARDED\",\n \"links\": [],\n \"name\": \"myCluster\",\n \"replicationSpecs\": [\n {\n \"regionConfigs\": [\n {\n \"analyticsAutoScaling\": {\n \"autoIndexing\": {\n \"enabled\": false\n },\n \"compute\": {\n \"enabled\": true,\n \"maxInstanceSize\": \"M40\",\n \"minInstanceSize\": \"M30\",\n \"scaleDownEnabled\": true\n },\n \"diskGB\": {\n \"enabled\": true\n }\n },\n \"analyticsSpecs\": {\n \"instanceSize\": \"M30\",\n \"nodeCount\": 0,\n \"diskSizeGB\": 10.0\n },\n \"autoScaling\": {\n \"autoIndexing\": {\n \"enabled\": false\n },\n \"compute\": {\n \"enabled\": true,\n \"maxInstanceSize\": \"M40\",\n \"minInstanceSize\": \"M30\",\n \"scaleDownEnabled\": true\n },\n \"diskGB\": {\n \"enabled\": true\n }\n },\n \"electableSpecs\": {\n \"instanceSize\": \"M30\",\n \"nodeCount\": 3,\n \"diskSizeGB\": 10.0\n },\n \"hiddenSecondarySpecs\": {\n \"instanceSize\": \"M30\",\n \"nodeCount\": 0,\n \"diskSizeGB\": 10.0\n },\n \"priority\": 7,\n \"providerName\": \"AWS\",\n \"readOnlySpecs\": {\n \"instanceSize\": \"M30\",\n \"nodeCount\": 0,\n \"diskSizeGB\": 10.0\n },\n \"regionName\": \"US_EAST_1\"\n }\n ],\n \"zoneName\": \"Zone 1\"\n },\n {\n \"regionConfigs\": [\n {\n \"analyticsAutoScaling\": {\n \"autoIndexing\": {\n \"enabled\": false\n },\n \"compute\": {\n \"enabled\": true,\n \"maxInstanceSize\": \"M20\",\n \"minInstanceSize\": \"M10\",\n \"scaleDownEnabled\": true\n },\n \"diskGB\": {\n \"enabled\": true\n }\n },\n \"analyticsSpecs\": {\n \"instanceSize\": \"M10\",\n \"nodeCount\": 0,\n \"diskSizeGB\": 10.0\n },\n \"autoScaling\": {\n \"autoIndexing\": {\n \"enabled\": false\n },\n \"compute\": {\n \"enabled\": true,\n \"maxInstanceSize\": \"M20\",\n \"minInstanceSize\": \"M10\",\n \"scaleDownEnabled\": true\n },\n \"diskGB\": {\n \"enabled\": true\n }\n },\n \"electableSpecs\": {\n \"instanceSize\": \"M10\",\n \"nodeCount\": 3,\n \"diskSizeGB\": 10.0\n },\n \"hiddenSecondarySpecs\": {\n \"instanceSize\": \"M10\",\n \"nodeCount\": 0,\n \"diskSizeGB\": 10.0\n },\n \"priority\": 7,\n \"providerName\": \"AWS\",\n \"readOnlySpecs\": {\n \"instanceSize\": \"M10\",\n \"nodeCount\": 0,\n \"diskSizeGB\": 10.0\n },\n \"regionName\": \"US_EAST_1\"\n }\n ],\n \"zoneName\": \"Zone 1\"\n },\n ]\n}\n" - } - }, - "x-xgen-version": "2024-08-05" - } - }, - "required": true - }, - "responses": { - "201": { - "description": "Created", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/LegacyAtlasCluster" - }, - "x-xgen-version": "2023-01-01", - "x-sunset": "2025-06-01" - }, - "application/vnd.atlas.2023-02-01+json": { - "schema": { - "$ref": "#/components/schemas/AdvancedClusterDescription" - }, - "x-xgen-version": "2023-02-01", - "x-sunset": "2026-03-01" - }, - "application/vnd.atlas.2024-08-05+json": { - "schema": { - "$ref": "#/components/schemas/ClusterDescription20240805" - }, - "x-xgen-version": "2024-08-05" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "402": { - "$ref": "#/components/responses/paymentRequired" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - } - }, - "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/globalWrites": { - "get": { - "tags": ["Global Clusters"], - "summary": "Return One Managed Namespace in One Global Cluster", - "description": "Returns one managed namespace within the specified global cluster. A managed namespace identifies a collection using the database name, the dot separator, and the collection name. To use this resource, the requesting API Key must have the Project Read Only role.", - "externalDocs": { - "description": "Global Clusters", - "url": "https://www.mongodb.com/docs/atlas/global-clusters/" - }, - "operationId": "getManagedNamespace", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "name": "clusterName", - "in": "path", - "description": "Human-readable label that identifies this cluster.", - "required": true, - "schema": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/GeoSharding" - }, - "x-xgen-version": "2023-01-01", - "x-sunset": "2025-06-01" - }, - "application/vnd.atlas.2023-02-01+json": { - "schema": { - "$ref": "#/components/schemas/GeoSharding" - }, - "x-xgen-version": "2023-02-01", - "x-sunset": "2026-03-01" - }, - "application/vnd.atlas.2024-08-05+json": { - "schema": { - "$ref": "#/components/schemas/GeoSharding20240805" - }, - "x-xgen-version": "2024-08-05" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - } - }, - "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs": { - "get": { - "tags": ["Clusters"], - "summary": "Return One 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, or serverless clusters. To use this resource, the requesting API Key must have the Project Read Only role.", - "externalDocs": { - "description": "Global Clusters", - "url": "https://www.mongodb.com/docs/atlas/global-clusters/" - }, - "operationId": "getClusterAdvancedConfiguration", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "name": "clusterName", - "in": "path", - "description": "Human-readable label that identifies the cluster.", - "required": true, - "schema": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ClusterDescriptionProcessArgs" - }, - "x-xgen-version": "2023-01-01", - "x-sunset": "2026-03-01" - }, - "application/vnd.atlas.2024-08-05+json": { - "schema": { - "$ref": "#/components/schemas/ClusterDescriptionProcessArgs20240805" - }, - "x-xgen-version": "2024-08-05" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - }, - "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 API Key must have the Project Cluster Manager role. This feature isn't available for `M0` free clusters, `M2` and `M5` shared-tier clusters, or serverless clusters.", - "externalDocs": { - "description": "Global Clusters", - "url": "https://www.mongodb.com/docs/atlas/global-clusters/" - }, - "operationId": "updateClusterAdvancedConfiguration", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "name": "clusterName", - "in": "path", - "description": "Human-readable label that identifies the cluster.", - "required": true, - "schema": { - "maxLength": 64, - "minLength": 1, - "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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ClusterDescriptionProcessArgs" - }, - "x-xgen-version": "2023-01-01" - }, - "application/vnd.atlas.2024-08-05+json": { - "schema": { - "$ref": "#/components/schemas/ClusterDescriptionProcessArgs20240805" - }, - "x-xgen-version": "2024-08-05" - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ClusterDescriptionProcessArgs" - }, - "x-xgen-version": "2023-01-01", - "x-sunset": "2026-03-01" - }, - "application/vnd.atlas.2024-08-05+json": { - "schema": { - "$ref": "#/components/schemas/ClusterDescriptionProcessArgs20240805" - }, - "x-xgen-version": "2024-08-05" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Dedicated" - } - }, - "/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}": { - "get": { - "tags": ["Clusters"], - "summary": "Check Status of Cluster Sample Dataset Request", - "description": "Checks the progress of loading the sample dataset into one cluster. To use this resource, the requesting API Key must have the Project Owner role.", - "operationId": "getSampleDatasetLoadStatus", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "name": "sampleDatasetId", - "in": "path", - "description": "Unique 24-hexadecimal digit string that identifies the loaded sample dataset.", - "required": true, - "schema": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/SampleDatasetStatus" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas" - } - }, - "/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}": { - "post": { - "tags": ["Clusters"], - "summary": "Load Sample Dataset Request into Cluster", - "description": "Requests loading the MongoDB sample dataset into the specified cluster. To use this resource, the requesting API Key must have the Project Owner role.", - "operationId": "loadSampleDataset", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "name": "name", - "in": "path", - "description": "Human-readable label that identifies the cluster into which you load the sample dataset.", - "required": true, - "schema": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - } - ], - "responses": { - "201": { - "description": "Created", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/SampleDatasetStatus" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas" - } - }, - "/api/atlas/v2/groups/{groupId}/serverless": { - "get": { - "tags": ["Serverless Instances"], - "summary": "Return All Serverless Instances from One Project", - "description": "Returns details for all serverless instances in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", - "operationId": "listServerlessInstances", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/includeCount" - }, - { - "$ref": "#/components/parameters/itemsPerPage" - }, - { - "$ref": "#/components/parameters/pageNum" - }, - { - "$ref": "#/components/parameters/pretty" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedServerlessInstanceDescriptionView" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Serverless II" - }, - "post": { - "tags": ["Serverless Instances"], - "summary": "Create One Serverless Instance in One Project", - "description": "Creates one serverless instance in the specified project. To use this resource, the requesting API Key must have the Project Owner role.", - "operationId": "createServerlessInstance", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/pretty" - } - ], - "requestBody": { - "description": "Create One Serverless Instance in One Project.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ServerlessInstanceDescriptionCreate" - } - } - }, - "required": true - }, - "responses": { - "201": { - "description": "Created", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ServerlessInstanceDescription" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "402": { - "$ref": "#/components/responses/paymentRequired" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Serverless II" - } - }, - "/api/atlas/v2/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 API Key must have the Project Read Only role.", - "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": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ServerlessInstanceDescription" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Serverless II" - }, - "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 API Key must have the Project Owner role.", - "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": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "This endpoint does not return a response body.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/NoBody" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Serverless II" - }, - "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 API Key must have the Project Owner role.", - "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": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - } - ], - "requestBody": { - "description": "Update One Serverless Instance in One Project.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ServerlessInstanceDescriptionUpdate" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ServerlessInstanceDescription" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "402": { - "$ref": "#/components/responses/paymentRequired" - }, - "409": { - "$ref": "#/components/responses/conflict" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Serverless II" - } - }, - "/api/atlas/v2/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.", - "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": { - "maxLength": 64, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ServerlessTenantEndpoint" - } - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - }, - "400": { - "$ref": "#/components/responses/badRequest" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Serverless II" - }, - "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 API Key must have the Project Owner role.\n\n A new endpoint won't be immediately available after creation. Read the steps in the linked tutorial for detailed guidance.", - "externalDocs": { - "description": "Set Up a Private Endpoint for a Serverless Instance Tutorial", - "url": "https://dochub.mongodb.org/core/serverless-private-endpoint" - }, - "operationId": "createServerlessPrivateEndpoint", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "name": "instanceName", - "in": "path", - "description": "Human-readable label that identifies the serverless instance for which the tenant endpoint will be created.", - "required": true, - "schema": { - "maxLength": 64, - "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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ServerlessTenantCreateRequest" - } - } - }, - "required": true - }, - "responses": { - "201": { - "description": "Created", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ServerlessTenantEndpoint" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - }, - "400": { - "$ref": "#/components/responses/badRequest" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Serverless II" - } - }, - "/api/atlas/v2/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.", - "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": { - "maxLength": 64, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ServerlessTenantEndpoint" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - }, - "400": { - "$ref": "#/components/responses/badRequest" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Serverless II" - }, - "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 API Key must have the Project Owner role.", - "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": { - "maxLength": 64, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "This endpoint does not return a response body.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/NoBody" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - }, - "400": { - "$ref": "#/components/responses/badRequest" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Serverless II" - }, - "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 API Key must have the Project Owner role.", - "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": { - "maxLength": 64, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "requestBody": { - "description": "Object used for update.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ServerlessTenantEndpointUpdate" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ServerlessTenantEndpoint" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - }, - "400": { - "$ref": "#/components/responses/badRequest" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Serverless II" - } - }, - "/api/atlas/v2/groups/{groupId}/uss/{name}/backup/restoreJobs": { - "get": { - "tags": ["USS Restore Jobs"], - "summary": "Return All Restore Jobs for One USS Instance", - "description": "Returns all restore jobs for one USS instance from the specified project. To use this resource, the requesting API Key must have the Project Owner role.", - "operationId": "listUSSBackupRestoreJobs", - "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": "name", - "in": "path", - "description": "Human-readable label that identifies the USS instance.", - "required": true, - "schema": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2025-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedApiAtlasUSSBackupRestoreJob20250101View" - }, - "x-xgen-version": "2025-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-hidden-env": { - "envs": "dev,qa,stage,prod" - }, - "x-xgen-owner-team": "Atlas Serverless II" - }, - "post": { - "tags": ["USS Restore Jobs"], - "summary": "Restore One Snapshot of One USS Instance", - "description": "Restores one snapshot of one USS instance from the specified project. To use this resource, the requesting API Key must have the Project Owner role.", - "operationId": "createUSSBackupRestoreJob", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "name": "name", - "in": "path", - "description": "Human-readable label that identifies the USS instance whose snapshot you want to restore.", - "required": true, - "schema": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - } - ], - "requestBody": { - "description": "Restores one snapshot of one USS instance from the specified project.", - "content": { - "application/vnd.atlas.2025-01-01+json": { - "schema": { - "$ref": "#/components/schemas/USSBackupRestoreJobCreate20250101" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2025-01-01+json": { - "schema": { - "$ref": "#/components/schemas/USSBackupRestoreJob20250101" - }, - "x-xgen-version": "2025-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-hidden-env": { - "envs": "dev,qa,stage,prod" - }, - "x-xgen-owner-team": "Atlas Serverless II" - } - }, - "/api/atlas/v2/groups/{groupId}/uss/{name}/backup/download": { - "post": { - "tags": ["USS Snapshots"], - "summary": "Download One USS Instance Snapshot", - "description": "Requests one snapshot for the specified USS instance. This resource returns a `snapshotURL` that you can use to download the snapshot. This `snapshotURL` remains active for four hours after you make the request. To use this resource, the requesting API Key must have the Project Owner role.", - "operationId": "downloadUSSBackup", - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Human-readable label that identifies the USS instance.", - "required": true, - "schema": { - "maxLength": 64, - "minLength": 1, - "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/vnd.atlas.2025-01-01+json": { - "schema": { - "$ref": "#/components/schemas/USSBackupSnapshotDownloadCreate20250101" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2025-01-01+json": { - "schema": { - "$ref": "#/components/schemas/USSBackupRestoreJob20250101" - }, - "x-xgen-version": "2025-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-hidden-env": { - "envs": "dev,qa,stage,prod" - }, - "x-xgen-owner-team": "Atlas Serverless II" - } - }, - "/api/atlas/v2/groups/{groupId}/uss/{name}/backup/restoreJobs/{restoreJobId}": { - "get": { - "tags": ["USS Restore Jobs"], - "summary": "Return One Restore Job for One USS Instance", - "description": "Returns one restore job for one USS instance from the specified project. To use this resource, the requesting API Key must have the Project Owner role.", - "operationId": "getUSSBackupRestoreJob", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "name": "name", - "in": "path", - "description": "Human-readable label that identifies the USS instance.", - "required": true, - "schema": { - "maxLength": 64, - "minLength": 1, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2025-01-01+json": { - "schema": { - "$ref": "#/components/schemas/USSBackupRestoreJob20250101" - }, - "x-xgen-version": "2025-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-hidden-env": { - "envs": "dev,qa,stage,prod" - }, - "x-xgen-owner-team": "Atlas Serverless II" - } - }, - "/api/atlas/v2/groups/{groupId}/uss/{name}/backup/snapshots/{snapshotId}": { - "get": { - "tags": ["USS Snapshots"], - "summary": "Return One Snapshot of One USS Instance", - "description": "Returns one snapshot of one USS instance from the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", - "operationId": "getUSSBackup", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "name": "name", - "in": "path", - "description": "Human-readable label that identifies the USS instance.", - "required": true, - "schema": { - "maxLength": 64, - "minLength": 1, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "example": "32b6e34b3d91647abb20e7b8" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2025-01-01+json": { - "schema": { - "$ref": "#/components/schemas/USSBackupSnapshot20250101" - }, - "x-xgen-version": "2025-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-hidden-env": { - "envs": "dev,qa,stage,prod" - }, - "x-xgen-owner-team": "Atlas Serverless II" - } - }, - "/api/atlas/v2/groups/{groupId}/uss/{name}/backup/snapshots": { - "get": { - "tags": ["USS Snapshots"], - "summary": "Return All Snapshots of One USS Instance", - "description": "Returns all snapshots of one USS instance from the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", - "operationId": "listUSSBackups", - "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": "name", - "in": "path", - "description": "Human-readable label that identifies the USS instance.", - "required": true, - "schema": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2025-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedApiAtlasUSSBackupSnapshot20240710View" - }, - "x-xgen-version": "2025-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-hidden-env": { - "envs": "dev,qa,stage,prod" - }, - "x-xgen-owner-team": "Atlas Serverless II" - } - }, - "/api/atlas/v2/groups/{groupId}/uss": { - "get": { - "tags": ["USS Instances"], - "summary": "Return All USS Instances from One Project", - "description": "Returns details for all USS instances in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", - "operationId": "listUSSInstances", - "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/vnd.atlas.2025-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedUSSInstance20250101" - }, - "x-xgen-version": "2025-01-01" - } - } - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-hidden-env": { - "envs": "qa,prod" - }, - "x-xgen-owner-team": "Atlas Serverless II" - }, - "post": { - "tags": ["USS Instances"], - "summary": "Create One USS Instance in One Project", - "description": "Creates one USS instance in the specified project. To use this resource, the requesting API Key must have the Project Owner role.", - "operationId": "createUSSInstance", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/pretty" - } - ], - "requestBody": { - "description": "Create One USS Instance in One Project.", - "content": { - "application/vnd.atlas.2025-01-01+json": { - "schema": { - "$ref": "#/components/schemas/USSInstanceDescriptionCreate20250101" - } - } - }, - "required": true - }, - "responses": { - "201": { - "description": "Created", - "content": { - "application/vnd.atlas.2025-01-01+json": { - "schema": { - "$ref": "#/components/schemas/USSInstanceDescription20250101" - }, - "x-xgen-version": "2025-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "402": { - "$ref": "#/components/responses/paymentRequired" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-hidden-env": { - "envs": "qa,prod" - }, - "x-xgen-owner-team": "Atlas Serverless II" - } - }, - "/api/atlas/v2/groups/{groupId}/uss/{name}": { - "get": { - "tags": ["USS Instances"], - "summary": "Return One USS Instance from One Project", - "description": "Returns details for one USS instance in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", - "operationId": "getUSSInstance", - "parameters": [ - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "name": "name", - "in": "path", - "description": "Human-readable label that identifies the USS instance.", - "required": true, - "schema": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2025-01-01+json": { - "schema": { - "$ref": "#/components/schemas/USSInstanceDescription20250101" - }, - "x-xgen-version": "2025-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-hidden-env": { - "envs": "qa,prod" - }, - "x-xgen-owner-team": "Atlas Serverless II" - }, - "delete": { - "tags": ["USS Instances"], - "summary": "Remove One USS Instance from One Project", - "description": "Removes one USS instance from the specified project. The USS instance must have termination protection disabled in order to be deleted. To use this resource, the requesting API Key must have the Project Owner role.", - "operationId": "deleteUSSInstance", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "name": "name", - "in": "path", - "description": "Human-readable label that identifies the USS instance.", - "required": true, - "schema": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "This endpoint does not return a response body.", - "content": { - "application/vnd.atlas.2025-01-01+json": { - "schema": { - "$ref": "#/components/schemas/NoBody" - }, - "x-xgen-version": "2025-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-hidden-env": { - "envs": "qa,prod" - }, - "x-xgen-owner-team": "Atlas Serverless II" - }, - "patch": { - "tags": ["USS Instances"], - "summary": "Update One USS Instance in One Project", - "description": "Updates one USS instance in the specified project. To use this resource, the requesting API Key must have the Project Owner role.", - "operationId": "updateUSSInstance", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "name": "name", - "in": "path", - "description": "Human-readable label that identifies the USS instance.", - "required": true, - "schema": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string" - } - } - ], - "requestBody": { - "description": "Update One USS Instance in One Project.", - "content": { - "application/vnd.atlas.2025-01-01+json": { - "schema": { - "$ref": "#/components/schemas/USSInstanceDescription20250101" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2025-01-01+json": { - "schema": { - "$ref": "#/components/schemas/USSInstanceDescription20250101" - }, - "x-xgen-version": "2025-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "402": { - "$ref": "#/components/responses/paymentRequired" - }, - "409": { - "$ref": "#/components/responses/conflict" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-hidden-env": { - "envs": "qa,prod" - }, - "x-xgen-owner-team": "Atlas Serverless II" - } - }, - "/api/atlas/v2/orgs": { - "get": { - "tags": ["Organizations"], - "summary": "Return All Organizations", - "description": "Returns all organizations to which the requesting API Key has access. To use this resource, the requesting API Key must have the Organization Member role.", - "operationId": "listOrganizations", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/includeCount" - }, - { - "$ref": "#/components/parameters/itemsPerPage" - }, - { - "$ref": "#/components/parameters/pageNum" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedOrganizationView" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - }, - "post": { - "tags": ["Organizations"], - "summary": "Create One Organization", - "description": "Creates one organization in MongoDB Cloud and links it to the requesting API Key's organization. To use this resource, the requesting API Key must have the Organization Owner role. The requesting API Key's organization must be a paying organization. To learn more, see [Configure a Paying Organization](https://www.mongodb.com/docs/atlas/billing/#configure-a-paying-organization) in the MongoDB Atlas documentation.", - "operationId": "createOrganization", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/pretty" - } - ], - "requestBody": { - "description": "Organization that you want to create.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/CreateOrganizationRequest" - } - } - }, - "required": true - }, - "responses": { - "201": { - "description": "Created", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/CreateOrganizationResponse" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "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" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - } - }, - "/api/atlas/v2/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 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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedApiUserAccessListResponseView" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - }, - "post": { - "tags": ["Programmatic API Keys"], - "summary": "Create Access List Entries 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 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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "requestBody": { - "description": "Access list entries to be created for the specified organization API key.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/UserAccessListRequest" - } - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedApiUserAccessListResponseView" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - } - }, - "/api/atlas/v2/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 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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/UserAccessListResponse" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - }, - "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 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": { - "maxLength": 24, - "minLength": 24, - "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.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/NoBody" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - } - }, - "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedApiApiUserView" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - }, - "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 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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/CreateAtlasOrganizationApiKey" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ApiKeyUserDetails" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - } - }, - "/api/atlas/v2/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 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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ApiKeyUserDetails" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - }, - "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 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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "This endpoint does not return a response body.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/NoBody" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/UpdateAtlasOrganizationApiKey" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/ApiKeyUserDetails" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - } - }, - "/api/atlas/v2/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 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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedApiAppUserView" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - }, - "post": { - "tags": ["Teams"], - "summary": "Assign MongoDB Cloud Users from 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 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": { - "maxLength": 24, - "minLength": 24, - "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/vnd.atlas.2023-01-01+json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AddUserToTeam" - } - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedApiAppUserView" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - } - }, - "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedTeamView" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - }, - "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 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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/Team" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/Team" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - } - }, - "/api/atlas/v2/orgs/{orgId}/teams/{teamId}": { - "get": { - "tags": ["Teams"], - "summary": "Return One Team using its 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 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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/TeamResponse" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - }, - "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 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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "This endpoint does not return a response body.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/NoBody" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - }, - "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 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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "requestBody": { - "description": "Details to update on the specified team.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/TeamUpdate" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/TeamResponse" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - } - }, - "/api/atlas/v2/orgs/{orgId}/teams/byName/{teamName}": { - "get": { - "tags": ["Teams"], - "summary": "Return One Team using its 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 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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/TeamResponse" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - } - }, - "/api/atlas/v2/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 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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "This endpoint does not return a response body.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - } - }, - "/api/atlas/v2/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 API Key must have the Organization User Admin role.", - "operationId": "removeOrganizationUser", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/orgId" - }, - { - "name": "userId", - "in": "path", - "description": "Unique 24-hexadecimal digit string that identifies the user to be deleted.", - "required": true, - "schema": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "This endpoint does not return a response body.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/NoBody" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - } - }, - "/api/atlas/v2/orgs/{orgId}": { - "get": { - "tags": ["Organizations"], - "summary": "Return One Organization", - "description": "Returns one organization to which the requesting API key has access. To use this resource, the requesting API Key must have the Organization Member role.", - "operationId": "getOrganization", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/orgId" - }, - { - "$ref": "#/components/parameters/pretty" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/AtlasOrganization" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - }, - "delete": { - "tags": ["Organizations"], - "summary": "Remove One Organization", - "description": "Removes one specified organization. MongoDB Cloud imposes the following limits on this resource:\n\n - Organizations with active projects cannot be removed.\n - All projects in the organization must be removed before you can remove the organization.\n To use this resource, the requesting API Key must have the Organization Owner role.", - "operationId": "deleteOrganization", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/orgId" - } - ], - "responses": { - "204": { - "description": "This endpoint does not return a response body.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/NoBody" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "402": { - "$ref": "#/components/responses/paymentRequired" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - }, - "patch": { - "tags": ["Organizations"], - "summary": "Rename One Organization", - "description": "Renames one organization. To use this resource, the requesting API Key must have the Organization Owner role.", - "operationId": "renameOrganization", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/orgId" - }, - { - "$ref": "#/components/parameters/pretty" - } - ], - "requestBody": { - "description": "Details to update on the specified organization.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/AtlasOrganization" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/AtlasOrganization" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - } - }, - "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/OrgFederationSettings" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - } - }, - "/api/atlas/v2/orgs/{orgId}/groups": { - "get": { - "tags": ["Organizations"], - "summary": "Return One or More Projects in One Organization", - "description": "Returns multiple projects in the specified organization. Each organization can have multiple projects. Use projects to:\n\n- Isolate different environments, such as development, test, or production environments, from each other.\n- Associate different MongoDB Cloud users or teams with different environments, or give different permission to MongoDB Cloud users in different environments.\n- Maintain separate cluster security configurations.\n- Create different alert settings.\n\nTo use this resource, the requesting API Key must have the Organization Member role.", - "operationId": "listOrganizationProjects", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/includeCount" - }, - { - "$ref": "#/components/parameters/itemsPerPage" - }, - { - "$ref": "#/components/parameters/orgId" - }, - { - "$ref": "#/components/parameters/pageNum" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedAtlasGroupView" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - } - }, - "/api/atlas/v2/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 API Key must have the Organization Owner role.", - "operationId": "getOrganizationSettings", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/orgId" - }, - { - "$ref": "#/components/parameters/pretty" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/OrganizationSettings" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - }, - "patch": { - "tags": ["Organizations"], - "summary": "Update Settings for One Organization", - "description": "Updates the organization's settings. To use this resource, the requesting API Key must have the Organization Owner role.", - "operationId": "updateOrganizationSettings", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/orgId" - }, - { - "$ref": "#/components/parameters/pretty" - } - ], - "requestBody": { - "description": "Details to update on the specified organization's settings.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/OrganizationSettings" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/OrganizationSettings" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - } - }, - "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedAppUserView" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - } - }, - "/api/atlas/v2/orgs/{orgId}/users/{userId}/roles": { - "put": { - "tags": ["Organizations"], - "summary": "Update Organization Roles for One MongoDB Cloud User", - "description": "Updates the roles of the specified user in the specified organization. To specify the user to update, provide the unique 24-hexadecimal digit string that identifies the user in the specified organization. To use this resource, the requesting API Key must have the Organization User Admin role.", - "operationId": "updateOrganizationRoles", - "parameters": [ - { - "$ref": "#/components/parameters/orgId" - }, - { - "name": "userId", - "in": "path", - "description": "Unique 24-hexadecimal digit string that identifies the user to modify.", - "required": true, - "schema": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "$ref": "#/components/parameters/envelope" - } - ], - "requestBody": { - "description": "Roles to update for the specified user.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/UpdateOrgRolesForUser" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/UpdateOrgRolesForUser" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - } - }, - "/api/atlas/v2/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 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.\nTo 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", - "example": true, - "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", - "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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedApiInvoiceMetadataView" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Payments" - } - }, - "/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}": { - "get": { - "tags": ["Invoices"], - "summary": "Return One Organization Invoice", - "description": "Returns one invoice that MongoDB issued to the specified organization. A unique 24-hexadecimal digit string identifies the invoice. You can choose to receive this invoice in JSON or CSV format. To use this resource, the requesting API Key must have the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can query for a linked invoice if you have the Organization Billing Admin or Organization Owner role.\nTo 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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/BillingInvoice" - }, - "x-xgen-version": "2023-01-01" - }, - "application/vnd.atlas.2023-01-01+csv": { - "schema": { - "type": "string" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Payments" - } - }, - "/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/csv": { - "get": { - "tags": ["Invoices"], - "summary": "Return One Organization Invoice as CSV", - "description": "Returns one invoice that MongoDB issued to the specified organization in CSV format. A unique 24-hexadecimal digit string identifies the invoice. To use this resource, the requesting API Key have at least the Organization Billing Viewer, Organization Billing Admin, or Organization Owner role. If you have a cross-organization setup, you can query for a linked invoice if you have the Organization Billing Admin or Organization Owner Role.\n 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": { - "application/vnd.atlas.2023-01-01+csv": { - "schema": { - "type": "string" - }, - "example": "Invoice Number,666acb8787ba43606905dcae,\nBilling Period,\"June 1, 2024 - July 1, 2024\",\nOrganization Name,Test 2,\nOrganization ID,666acb8787ba43606905dcac,\n\nDate,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\n", - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Payments" - } - }, - "/api/atlas/v2/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 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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedApiInvoiceView" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Payments" - } - }, - "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections": { - "get": { - "tags": ["Streams"], - "summary": "Return All Connections Of The Stream Instances", - "description": "Returns all connections of the stream instance for the specified project.To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role.", - "operationId": "listStreamConnections", - "parameters": [ - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/itemsPerPage" - }, - { - "$ref": "#/components/parameters/pageNum" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "name": "tenantName", - "in": "path", - "description": "Human-readable label that identifies the stream instance.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-02-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedApiStreamsConnectionView" - }, - "x-xgen-version": "2023-02-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-changelog": { - "2023-09-11": "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." - }, - "x-xgen-owner-team": "Atlas Streams" - }, - "post": { - "tags": ["Streams"], - "summary": "Create One Connection", - "description": "Creates one connection for a stream instance in the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Stream Processing Owner role.", - "operationId": "createStreamConnection", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "name": "tenantName", - "in": "path", - "description": "Human-readable label that identifies the stream instance.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "Details to create one connection for a streams instance in the specified project.", - "content": { - "application/vnd.atlas.2023-02-01+json": { - "schema": { - "$ref": "#/components/schemas/StreamsConnection" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-02-01+json": { - "schema": { - "$ref": "#/components/schemas/StreamsConnection" - }, - "x-xgen-version": "2023-02-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "409": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-changelog": { - "2023-09-11": "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." - }, - "x-xgen-owner-team": "Atlas Streams" - } - }, - "/api/atlas/v2/groups/{groupId}/streams": { - "get": { - "tags": ["Streams"], - "summary": "Return All Project Stream Instances", - "description": "Returns all stream instances for the specified project.", - "operationId": "listStreamInstances", - "parameters": [ - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/itemsPerPage" - }, - { - "$ref": "#/components/parameters/pageNum" - }, - { - "$ref": "#/components/parameters/pretty" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-02-01+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedApiStreamsTenantView" - }, - "x-xgen-version": "2023-02-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-changelog": { - "2023-09-11": "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." - }, - "x-xgen-owner-team": "Atlas Streams" - }, - "post": { - "tags": ["Streams"], - "summary": "Create One Stream Instance", - "description": "Creates one stream instance in the specified project. To use this resource, the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role.", - "operationId": "createStreamInstance", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "$ref": "#/components/parameters/groupId" - } - ], - "requestBody": { - "description": "Details to create one streams instance in the specified project.", - "content": { - "application/vnd.atlas.2023-02-01+json": { - "schema": { - "$ref": "#/components/schemas/StreamsTenant" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-02-01+json": { - "schema": { - "$ref": "#/components/schemas/StreamsTenant" - }, - "x-xgen-version": "2023-02-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-changelog": { - "2023-09-11": "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." - }, - "x-xgen-owner-team": "Atlas Streams" - } - }, - "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}": { - "get": { - "tags": ["Streams"], - "summary": "Return One Stream Connection", - "description": "Returns the details of one stream connection within the specified stream instance. To use this resource, the requesting API Key must have the Project Read Only role.", - "operationId": "getStreamConnection", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "name": "tenantName", - "in": "path", - "description": "Human-readable label that identifies the stream instance to return.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "connectionName", - "in": "path", - "description": "Human-readable label that identifies the stream connection to return.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-02-01+json": { - "schema": { - "$ref": "#/components/schemas/StreamsConnection" - }, - "x-xgen-version": "2023-02-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-changelog": { - "2023-09-11": "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." - }, - "x-xgen-owner-team": "Atlas Streams" - }, - "delete": { - "tags": ["Streams"], - "summary": "Delete One Stream Connection", - "description": "Delete one connection of the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role.", - "operationId": "deleteStreamConnection", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "name": "tenantName", - "in": "path", - "description": "Human-readable label that identifies the stream instance.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "connectionName", - "in": "path", - "description": "Human-readable label that identifies the stream connection.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "202": { - "description": "Accepted", - "content": { - "application/vnd.atlas.2023-02-01+json": { - "schema": { - "$ref": "#/components/schemas/NoBody" - }, - "x-xgen-version": "2023-02-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-changelog": { - "2023-09-11": "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." - }, - "x-xgen-owner-team": "Atlas Streams" - }, - "patch": { - "tags": ["Streams"], - "summary": "Update One Stream Connection", - "description": "Update one connection for the specified stream instance in the specified project. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role.", - "operationId": "updateStreamConnection", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "name": "tenantName", - "in": "path", - "description": "Human-readable label that identifies the stream instance.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "connectionName", - "in": "path", - "description": "Human-readable label that identifies the stream connection.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "Details to update one connection for a streams instance in the specified project.", - "content": { - "application/vnd.atlas.2023-02-01+json": { - "schema": { - "$ref": "#/components/schemas/StreamsConnection" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-02-01+json": { - "schema": { - "$ref": "#/components/schemas/StreamsConnection" - }, - "x-xgen-version": "2023-02-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-changelog": { - "2023-09-11": "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." - }, - "x-xgen-owner-team": "Atlas Streams" - } - }, - "/api/atlas/v2/groups/{groupId}/streams/{tenantName}": { - "get": { - "tags": ["Streams"], - "summary": "Return One Stream Instance", - "description": "Returns the details of one stream instance within the specified project. To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role.", - "operationId": "getStreamInstance", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "name": "tenantName", - "in": "path", - "description": "Human-readable label that identifies the stream instance to return.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "includeConnections", - "in": "query", - "description": "Flag to indicate whether connections information should be included in the stream instance.", - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-02-01+json": { - "schema": { - "$ref": "#/components/schemas/StreamsTenant" - }, - "x-xgen-version": "2023-02-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-changelog": { - "2023-09-11": "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." - }, - "x-xgen-owner-team": "Atlas Streams" - }, - "delete": { - "tags": ["Streams"], - "summary": "Delete One Stream Instance", - "description": "Delete one stream instance in the specified project. To use this resource, the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role.", - "operationId": "deleteStreamInstance", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "name": "tenantName", - "in": "path", - "description": "Human-readable label that identifies the stream instance to delete.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "202": { - "description": "Accepted", - "content": { - "application/vnd.atlas.2023-02-01+json": { - "schema": { - "$ref": "#/components/schemas/NoBody" - }, - "x-xgen-version": "2023-02-01" - } - } - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-changelog": { - "2023-09-11": "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." - }, - "x-xgen-owner-team": "Atlas Streams" - }, - "patch": { - "tags": ["Streams"], - "summary": "Update One Stream Instance", - "description": "Update one stream instance in the specified project. To use this resource, the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role.", - "operationId": "updateStreamInstance", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "name": "tenantName", - "in": "path", - "description": "Human-readable label that identifies the stream instance to update.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "Details of the new data process region to update in the streams instance.", - "content": { - "application/vnd.atlas.2023-02-01+json": { - "schema": { - "$ref": "#/components/schemas/StreamsDataProcessRegion" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-02-01+json": { - "schema": { - "$ref": "#/components/schemas/StreamsTenant" - }, - "x-xgen-version": "2023-02-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-changelog": { - "2023-09-11": "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." - }, - "x-xgen-owner-team": "Atlas Streams" - } - }, - "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs": { - "get": { - "tags": ["Streams"], - "summary": "Download Audit Logs for One Atlas Stream Processing Instance", - "description": "Downloads the audit logs for the specified Atlas Streams Processing instance. By default, logs cover periods of 30 days. To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: \"Accept: application/vnd.atlas.YYYY-MM-DD+gzip\".", - "operationId": "downloadStreamTenantAuditLogs", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$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 stream instance.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-02-01+gzip": { - "schema": { - "type": "string", - "description": "Compressed archive labeled `auditLogs.gz` downloads", - "format": "binary" - }, - "x-xgen-version": "2023-02-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "409": { - "$ref": "#/components/responses/conflict" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Streams" - } - }, - "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor": { - "post": { - "tags": ["Streams"], - "summary": "Create One Stream Processor", - "description": "Create one Stream Processor within the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role.", - "operationId": "createStreamProcessor", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "name": "tenantName", - "in": "path", - "description": "Human-readable label that identifies the stream instance.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "description": "Details to create an Atlas Streams Processor.", - "content": { - "application/vnd.atlas.2024-05-30+json": { - "schema": { - "$ref": "#/components/schemas/StreamsProcessor" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2024-05-30+json": { - "schema": { - "$ref": "#/components/schemas/StreamsProcessor" - }, - "x-xgen-version": "2024-05-30" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "409": { - "$ref": "#/components/responses/unauthorized" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Streams" - } - }, - "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}": { - "get": { - "tags": ["Streams"], - "summary": "Get One Stream Processor", - "description": "Get one Stream Processor within the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role.", - "operationId": "getStreamProcessor", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "name": "tenantName", - "in": "path", - "description": "Human-readable label that identifies the stream instance.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "processorName", - "in": "path", - "description": "Human-readable label that identifies the stream processor.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2024-05-30+json": { - "schema": { - "$ref": "#/components/schemas/StreamsProcessorWithStats" - }, - "x-xgen-version": "2024-05-30" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Streams" - }, - "delete": { - "tags": ["Streams"], - "summary": "Delete One Stream Processor", - "description": "Delete a Stream Processor within the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role.", - "operationId": "deleteStreamProcessor", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "name": "tenantName", - "in": "path", - "description": "Human-readable label that identifies the stream instance.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "processorName", - "in": "path", - "description": "Human-readable label that identifies the stream processor.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "This endpoint does not return a response body.", - "content": { - "application/vnd.atlas.2024-05-30+json": { - "x-xgen-version": "2024-05-30" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Streams" - } - }, - "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processors": { - "get": { - "tags": ["Streams"], - "summary": "Return All Stream Processors In The Stream Instance.", - "description": "Returns all Stream Processors within the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role.", - "operationId": "listStreamProcessors", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "$ref": "#/components/parameters/itemsPerPage" - }, - { - "$ref": "#/components/parameters/pageNum" - }, - { - "$ref": "#/components/parameters/includeCount" - }, - { - "name": "tenantName", - "in": "path", - "description": "Human-readable label that identifies the stream instance.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2024-05-30+json": { - "schema": { - "$ref": "#/components/schemas/PaginatedApiStreamsStreamProcessorWithStatsView" - }, - "x-xgen-version": "2024-05-30" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Streams" - } - }, - "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:start": { - "post": { - "tags": ["Streams"], - "summary": "Start One Stream Processor", - "description": "Start a Stream Processor within the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role.", - "operationId": "startStreamProcessor", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "name": "tenantName", - "in": "path", - "description": "Human-readable label that identifies the stream instance.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "processorName", - "in": "path", - "description": "Human-readable label that identifies the stream processor.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2024-05-30+json": { - "schema": { - "$ref": "#/components/schemas/NoBody" - }, - "x-xgen-version": "2024-05-30" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Streams" - } - }, - "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/processor/{processorName}:stop": { - "post": { - "tags": ["Streams"], - "summary": "Stop One Stream Processor", - "description": "Stop a Stream Processor within the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role.", - "operationId": "stopStreamProcessor", - "parameters": [ - { - "$ref": "#/components/parameters/envelope" - }, - { - "$ref": "#/components/parameters/pretty" - }, - { - "$ref": "#/components/parameters/groupId" - }, - { - "name": "tenantName", - "in": "path", - "description": "Human-readable label that identifies the stream instance.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "processorName", - "in": "path", - "description": "Human-readable label that identifies the stream processor.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2024-05-30+json": { - "schema": { - "$ref": "#/components/schemas/NoBody" - }, - "x-xgen-version": "2024-05-30" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Streams" - } - }, - "/api/atlas/v2": { - "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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/SystemStatus" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "description": "Unauthorized.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiError" - } - } - } - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "apix" - } - }, - "/api/atlas/v2/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.\n\n 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.\n\n To use this resource, the requesting 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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/CloudAppUser" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/CloudAppUser" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - } - }, - "/api/atlas/v2/users/{userId}": { - "get": { - "tags": ["MongoDB Cloud Users"], - "summary": "Return One MongoDB Cloud User using Its 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 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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/CloudAppUser" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - } - }, - "/api/atlas/v2/users/byName/{userName}": { - "get": { - "tags": ["MongoDB Cloud Users"], - "summary": "Return One MongoDB Cloud User using Their 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 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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/CloudAppUser" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "IAM" - } - }, - "/api/atlas/v2/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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/TargetOrgRequest" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/TargetOrg" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Migrations" - }, - "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.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/NoBody" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Migrations" - } - }, - "/api/atlas/v2/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/vnd.atlas.2023-01-01+json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LiveImportAvailableProject" - } - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Migrations" - } - }, - "/api/atlas/v2/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/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/LiveMigrationResponse" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Migrations" - } - }, - "/api/atlas/v2/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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "example": "507f1f77bcf86cd799439011" - } - }, - { - "$ref": "#/components/parameters/envelope" - } - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/LiveImportValidation" - }, - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Migrations" - } - }, - "/api/atlas/v2/groups/{groupId}/liveMigrations/{liveMigrationId}/cutover": { - "put": { - "tags": ["Cloud Migration Service"], - "summary": "Cut Over the 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": { - "description": "Accepted.", - "content": { - "application/vnd.atlas.2023-01-01+json": { - "x-xgen-version": "2023-01-01" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Migrations" - } - }, - "/api/atlas/v2/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.\n\n Please make sure to [validate](#tag/Cloud-Migration-Service/operation/validateMigration) your migration before initiating it.\n\n 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.\n\n **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/vnd.atlas.2024-05-30+json": { - "schema": { - "$ref": "#/components/schemas/LiveMigrationRequest20240530" - }, - "x-xgen-version": "2024-05-30" - }, - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/LiveMigrationRequest" - }, - "x-xgen-version": "2023-01-01", - "x-sunset": "2025-05-30" - } - }, - "required": true - }, - "responses": { - "201": { - "description": "Created", - "content": { - "application/vnd.atlas.2024-05-30+json": { - "schema": { - "$ref": "#/components/schemas/LiveMigrationResponse" - }, - "x-xgen-version": "2024-05-30" - }, - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/LiveMigrationResponse" - }, - "x-xgen-version": "2023-01-01", - "x-sunset": "2025-05-30" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Migrations" - } - }, - "/api/atlas/v2/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/vnd.atlas.2024-05-30+json": { - "schema": { - "$ref": "#/components/schemas/LiveMigrationRequest20240530" - }, - "x-xgen-version": "2024-05-30" - }, - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/LiveMigrationRequest" - }, - "x-xgen-version": "2023-01-01", - "x-sunset": "2025-05-30" - } - }, - "required": true - }, - "responses": { - "200": { - "description": "OK", - "content": { - "application/vnd.atlas.2024-05-30+json": { - "schema": { - "$ref": "#/components/schemas/LiveImportValidation" - }, - "x-xgen-version": "2024-05-30" - }, - "application/vnd.atlas.2023-01-01+json": { - "schema": { - "$ref": "#/components/schemas/LiveImportValidation" - }, - "x-xgen-version": "2023-01-01", - "x-sunset": "2025-05-30" - } - } - }, - "400": { - "$ref": "#/components/responses/badRequest" - }, - "401": { - "$ref": "#/components/responses/unauthorized" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/notFound" - }, - "500": { - "$ref": "#/components/responses/internalServerError" - } - }, - "security": [ - { - "DigestAuth": [] - } - ], - "x-xgen-owner-team": "Atlas Migrations" - } - } - }, - "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." - }, - "EventTypeDetails": { - "title": "Event type details", - "type": "object", - "properties": { - "alertable": { - "type": "boolean", - "description": "Whether or not this event type can be configured as an alert via the API.", - "readOnly": true - }, - "description": { - "type": "string", - "description": "Description of the event type.", - "readOnly": true - }, - "eventType": { - "type": "string", - "description": "Enum representation of the event type.", - "readOnly": true - } - }, - "description": "A singular type of event" - }, - "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" - } - } - }, - "PaginatedEventTypeDetailsResponse": { - "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 providers when completing this request.", - "readOnly": true, - "items": { - "$ref": "#/components/schemas/EventTypeDetails" - } - }, - "totalCount": { - "minimum": 0, - "type": "integer", - "description": "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", - "format": "int32", - "readOnly": true - } - } - }, - "AlertAudit": { - "title": "Alert Audits", - "required": ["created", "eventTypeName", "id"], - "type": "object", - "properties": { - "alertId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "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 - }, - "eventTypeName": { - "$ref": "#/components/schemas/AlertAuditTypeView" - }, - "groupId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "default": false - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "format": "email", - "readOnly": true - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "example": "test.user@mongodb.com" - } - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "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 - }, - "eventTypeName": { - "$ref": "#/components/schemas/AlertConfigAuditTypeView" - }, - "groupId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "default": false - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "format": "email", - "readOnly": true - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "example": "test.user@mongodb.com" - } - }, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "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 - }, - "eventTypeName": { - "$ref": "#/components/schemas/ApiUserEventTypeViewForNdsGroup" - }, - "groupId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "default": false - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "format": "email", - "readOnly": true, - "example": "test.user@mongodb.com" - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "example": "test.user@mongodb.com" - } - }, - "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 - }, - "eventTypeName": { - "$ref": "#/components/schemas/AppServiceEventTypeView" - }, - "groupId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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." - }, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "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 - }, - "eventTypeName": { - "$ref": "#/components/schemas/AutomationConfigEventTypeView" - }, - "groupId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "default": false - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "format": "email", - "readOnly": true, - "example": "test.user@mongodb.com" - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "example": "test.user@mongodb.com" - } - }, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "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 - }, - "eventTypeName": { - "$ref": "#/components/schemas/BillingEventTypeViewForNdsGroup" - }, - "groupId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the event.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "invoiceId": { - "maxLength": 24, - "minLength": 24, - "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, - "default": false - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "format": "email", - "readOnly": true, - "example": "test.user@mongodb.com" - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "example": "test.user@mongodb.com" - } - }, - "description": "Billing event identifies different activities related to billing, payment or financial status change of an organization." - }, - "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 - }, - "eventTypeName": { - "$ref": "#/components/schemas/ClusterEventTypeViewForNdsGroup" - }, - "groupId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "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 - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "default": false - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "format": "email", - "readOnly": true, - "example": "test.user@mongodb.com" - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "example": "test.user@mongodb.com" - } - }, - "description": "Data Explorer accessed event tracks different data operations via Data Explorer interactions." - }, - "DataMetricEventView": { - "required": ["created", "eventTypeName", "id"], - "type": "object", - "properties": { - "apiKeyId": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "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 - }, - "currentValue": { - "$ref": "#/components/schemas/DataMetricValueView" - }, - "eventTypeName": { - "$ref": "#/components/schemas/HostMetricEventTypeView" - }, - "groupId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "default": false - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "format": "email", - "readOnly": true, - "example": "test.user@mongodb.com" - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "example": "test.user@mongodb.com" - } - } - }, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "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 - }, - "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_AGGREGATE", - "CLUSTER_CONNECTION_CREATE_COLLECTION", - "CLUSTER_CONNECTION_SAMPLE_COLLECTION_FIELD_NAMES" - ] - }, - { - "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_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" - ] - }, - { - "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" - ] - }, - { - "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": "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"] - }, - { - "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", - "AGENT_VERSION_FIXED", - "AGENT_VERSION_UNFIXED", - "FIXED_VERSION_UPDATED", - "FIXED_AGENT_VERSION_UPDATED", - "CLUSTER_FCV_DOWNGRADED" - ] - } - ] - }, - "groupId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "default": false - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "format": "email", - "readOnly": true, - "example": "test.user@mongodb.com" - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "example": "test.user@mongodb.com" - } - }, - "description": "Other events which don't have extra details beside of basic one." - }, - "EventViewForNdsGroup": { - "type": "object", - "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/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" - } - ] - }, - "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" - ] - }, - "FTSIndexAuditView": { - "title": "FTS Index Audits", - "required": ["created", "eventTypeName", "id"], - "type": "object", - "properties": { - "apiKeyId": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "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 - }, - "eventTypeName": { - "$ref": "#/components/schemas/FTSIndexAuditTypeView" - }, - "groupId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "default": false - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "format": "email", - "readOnly": true - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "example": "test.user@mongodb.com" - } - }, - "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 - }, - "eventTypeName": { - "$ref": "#/components/schemas/ReplicaSetEventTypeViewForNdsGroup" - }, - "groupId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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 providers 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`.", - "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_ENOUGH_DISK_SPACE", - "HOST_NOT_ENOUGH_DISK_SPACE" - ] - }, - "HostEventViewForNdsGroup": { - "title": "Host Events", - "required": ["created", "eventTypeName", "id"], - "type": "object", - "properties": { - "apiKeyId": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "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 - }, - "eventTypeName": { - "$ref": "#/components/schemas/HostEventTypeViewForNdsGroup" - }, - "groupId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "default": false - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "format": "email", - "readOnly": true, - "example": "test.user@mongodb.com" - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "example": "test.user@mongodb.com" - } - }, - "description": "Host event identifies different activities about mongod host." - }, - "HostMetricEvent": { - "title": "Host Metric Events", - "required": ["created", "eventTypeName", "id"], - "type": "object", - "properties": { - "apiKeyId": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "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 - }, - "currentValue": { - "$ref": "#/components/schemas/HostMetricValue" - }, - "eventTypeName": { - "$ref": "#/components/schemas/HostMetricEventTypeView" - }, - "groupId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "default": false - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "format": "email", - "readOnly": true, - "example": "test.user@mongodb.com" - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "example": "test.user@mongodb.com" - } - }, - "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_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", - "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, - "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 - }, - "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_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_SSL_ROTATED", - "CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER", - "CLUSTER_INSTANCE_SSL_REVOKED", - "RELOAD_SSL_ON_PROCESSES", - "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", - "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", - "MOVE_SKIPPED", - "PROXY_RESTARTED", - "PROXY_PANICKED", - "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", - "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", - "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", - "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", - "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", - "PENDING_INDEXES_DELETED", - "PENDING_INDEXES_CANCELED", - "PROCESS_RESTART_REQUESTED", - "AUTO_HEALING_ACTION", - "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", - "CLUSTER_FORCE_RECONFIG_REQUESTED", - "PROJECT_BYPASSED_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", - "ATLAS_SQL_SCHEDULED_UPDATE_CREATED", - "ATLAS_SQL_SCHEDULED_UPDATE_MODIFIED", - "ATLAS_SQL_SCHEDULED_UPDATE_REMOVED" - ] - }, - "NDSAuditViewForNdsGroup": { - "title": "NDS Audits", - "required": ["created", "eventTypeName", "id"], - "type": "object", - "properties": { - "apiKeyId": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "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 - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "default": false - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "format": "email", - "readOnly": true - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "example": "test.user@mongodb.com" - }, - "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" - ] - }, - "NDSAutoScalingAuditViewForNdsGroup": { - "title": "NDS Auto Scaling Audits", - "required": ["created", "eventTypeName", "id"], - "type": "object", - "properties": { - "apiKeyId": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "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 - }, - "eventTypeName": { - "$ref": "#/components/schemas/NDSAutoScalingAuditTypeViewForNdsGroup" - }, - "groupId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "default": false - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "format": "email", - "readOnly": true - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "example": "test.user@mongodb.com" - } - }, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "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 - }, - "eventTypeName": { - "$ref": "#/components/schemas/NDSServerlessInstanceAuditTypeView" - }, - "groupId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "default": false - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "format": "email", - "readOnly": true - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "example": "test.user@mongodb.com" - } - }, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "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 - }, - "endpointId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "default": false - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "format": "email", - "readOnly": true - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "example": "test.user@mongodb.com" - } - }, - "description": "NDS tenant endpoint audit indicates when atlas auto-scaling cluster tier up or down." - }, - "NumberMetricEventView": { - "required": ["created", "eventTypeName", "id"], - "type": "object", - "properties": { - "apiKeyId": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "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 - }, - "currentValue": { - "$ref": "#/components/schemas/NumberMetricValueView" - }, - "eventTypeName": { - "$ref": "#/components/schemas/HostMetricEventTypeView" - }, - "groupId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "default": false - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "format": "email", - "readOnly": true, - "example": "test.user@mongodb.com" - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "example": "test.user@mongodb.com" - } - } - }, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "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 - }, - "currentValue": { - "$ref": "#/components/schemas/RawMetricValueView" - }, - "eventTypeName": { - "$ref": "#/components/schemas/HostMetricEventTypeView" - }, - "groupId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "default": false - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "format": "email", - "readOnly": true, - "example": "test.user@mongodb.com" - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "example": "test.user@mongodb.com" - } - } - }, - "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" - ] - }, - "ResourceEventTypeView": { - "title": "Resource Event Types", - "type": "string", - "description": "Unique identifier of event type.", - "example": "TAGS_MODIFIED", - "enum": ["TAGS_MODIFIED", "GROUP_TAGS_MODIFIED"] - }, - "ResourceEventViewForNdsGroup": { - "title": "Resource Events", - "required": ["created", "eventTypeName", "id", "resourceType"], - "type": "object", - "properties": { - "apiKeyId": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "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 - }, - "eventTypeName": { - "$ref": "#/components/schemas/ResourceEventTypeView" - }, - "groupId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "default": false - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "format": "email", - "readOnly": true, - "example": "test.user@mongodb.com" - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "example": "test.user@mongodb.com" - } - }, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "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 - }, - "eventTypeName": { - "$ref": "#/components/schemas/SearchDeploymentAuditTypeView" - }, - "groupId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "default": false - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "format": "email", - "readOnly": true - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "example": "test.user@mongodb.com" - } - }, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "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 - }, - "eventTypeName": { - "$ref": "#/components/schemas/ServiceAccountEventTypeViewForNdsGroup" - }, - "groupId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "default": false - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "format": "email", - "readOnly": true, - "example": "test.user@mongodb.com" - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "example": "test.user@mongodb.com" - } - }, - "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"] - }, - "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 - }, - "eventTypeName": { - "$ref": "#/components/schemas/StreamProcessorEventTypeViewForNdsGroup" - }, - "groupId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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 - }, - "eventTypeName": { - "$ref": "#/components/schemas/StreamsEventTypeViewForNdsGroup" - }, - "groupId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "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 - }, - "eventTypeName": { - "$ref": "#/components/schemas/TeamEventTypeViewForNdsGroup" - }, - "groupId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "default": false - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "format": "email", - "readOnly": true, - "example": "test.user@mongodb.com" - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "example": "test.user@mongodb.com" - } - }, - "description": "Team event identifies different activities around organization teams." - }, - "TimeMetricEventView": { - "required": ["created", "eventTypeName", "id"], - "type": "object", - "properties": { - "apiKeyId": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "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 - }, - "currentValue": { - "$ref": "#/components/schemas/TimeMetricValueView" - }, - "eventTypeName": { - "$ref": "#/components/schemas/HostMetricEventTypeView" - }, - "groupId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "default": false - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "format": "email", - "readOnly": true, - "example": "test.user@mongodb.com" - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "example": "test.user@mongodb.com" - } - } - }, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "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 - }, - "eventTypeName": { - "$ref": "#/components/schemas/UserEventTypeViewForNdsGroup" - }, - "groupId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "default": false - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "format": "email", - "readOnly": true, - "example": "test.user@mongodb.com" - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "example": "test.user@mongodb.com" - } - }, - "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" - }, - "alertConfigId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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 - }, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the event.", - "readOnly": true, - "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 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_AGGREGATE", - "CLUSTER_CONNECTION_CREATE_COLLECTION", - "CLUSTER_CONNECTION_SAMPLE_COLLECTION_FIELD_NAMES" - ] - }, - { - "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_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": "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" - ] - }, - { - "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" - ] - }, - { - "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" - ] - }, - { - "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_ENOUGH_DISK_SPACE", - "HOST_NOT_ENOUGH_DISK_SPACE" - ] - }, - { - "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_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_SSL_ROTATED", - "CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER", - "CLUSTER_INSTANCE_SSL_REVOKED", - "RELOAD_SSL_ON_PROCESSES", - "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", - "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", - "MOVE_SKIPPED", - "PROXY_RESTARTED", - "PROXY_PANICKED", - "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", - "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", - "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", - "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", - "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", - "PENDING_INDEXES_DELETED", - "PENDING_INDEXES_CANCELED", - "PROCESS_RESTART_REQUESTED", - "AUTO_HEALING_ACTION", - "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", - "CLUSTER_FORCE_RECONFIG_REQUESTED", - "PROJECT_BYPASSED_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", - "ATLAS_SQL_SCHEDULED_UPDATE_CREATED", - "ATLAS_SQL_SCHEDULED_UPDATE_MODIFIED", - "ATLAS_SQL_SCHEDULED_UPDATE_REMOVED" - ] - }, - { - "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" - ] - }, - { - "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" - ] - }, - { - "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": "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"] - }, - { - "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", - "AGENT_VERSION_FIXED", - "AGENT_VERSION_UNFIXED", - "FIXED_VERSION_UPDATED", - "FIXED_AGENT_VERSION_UPDATED", - "CLUSTER_FCV_DOWNGRADED" - ] - }, - { - "title": "Resource Event Types", - "type": "string", - "enum": ["TAGS_MODIFIED", "GROUP_TAGS_MODIFIED"] - } - ] - }, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "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 - }, - "eventTypeName": { - "$ref": "#/components/schemas/ApiUserEventTypeViewForOrg" - }, - "groupId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "default": false - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "format": "email", - "readOnly": true, - "example": "test.user@mongodb.com" - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "example": "test.user@mongodb.com" - } - }, - "description": "API User event identifies different activities around user api keys." - }, - "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", - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "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 - }, - "eventTypeName": { - "$ref": "#/components/schemas/BillingEventTypeViewForOrg" - }, - "groupId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the event.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "invoiceId": { - "maxLength": 24, - "minLength": 24, - "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, - "default": false - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "format": "email", - "readOnly": true, - "example": "test.user@mongodb.com" - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "example": "test.user@mongodb.com" - } - }, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "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 - }, - "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" - ] - }, - { - "title": "Support Event Types", - "type": "string", - "enum": ["SUPPORT_EMAILS_SENT_SUCCESSFULLY", "SUPPORT_EMAILS_SENT_FAILURE"] - } - ] - }, - "groupId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "default": false - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "format": "email", - "readOnly": true, - "example": "test.user@mongodb.com" - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "example": "test.user@mongodb.com" - } - }, - "description": "Other events which don't have extra details beside of basic one." - }, - "EventViewForOrg": { - "type": "object", - "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" - } - ] - }, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "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 - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "default": false - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "format": "email", - "readOnly": true - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "example": "test.user@mongodb.com" - }, - "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", - "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" - ] - }, - "OrgEventViewForOrg": { - "title": "Org Events", - "required": ["created", "eventTypeName", "id"], - "type": "object", - "properties": { - "apiKeyId": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "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 - }, - "eventTypeName": { - "$ref": "#/components/schemas/OrgEventTypeViewForOrg" - }, - "groupId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the event.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "invoiceId": { - "maxLength": 24, - "minLength": 24, - "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, - "default": false - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "format": "email", - "readOnly": true, - "example": "test.user@mongodb.com" - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "example": "test.user@mongodb.com" - } - }, - "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 providers 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`.", - "format": "int32", - "readOnly": true - } - } - }, - "ResourceEventTypeViewForOrg": { - "title": "Resource Event Types", - "type": "string", - "description": "Unique identifier of event type.", - "example": "GROUP_TAGS_MODIFIED", - "enum": ["GROUP_TAGS_MODIFIED"] - }, - "ResourceEventViewForOrg": { - "title": "Resource Events", - "required": ["created", "eventTypeName", "id", "resourceType"], - "type": "object", - "properties": { - "apiKeyId": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "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 - }, - "eventTypeName": { - "$ref": "#/components/schemas/ResourceEventTypeViewForOrg" - }, - "groupId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "default": false - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "format": "email", - "readOnly": true, - "example": "test.user@mongodb.com" - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "example": "test.user@mongodb.com" - } - }, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "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 - }, - "eventTypeName": { - "$ref": "#/components/schemas/ServiceAccountEventTypeViewForOrg" - }, - "groupId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "default": false - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "format": "email", - "readOnly": true, - "example": "test.user@mongodb.com" - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "example": "test.user@mongodb.com" - } - }, - "description": "Service Account event identifies different activities around user api keys." - }, - "TeamEvent": { - "title": "Team Events", - "required": ["created", "eventTypeName", "id"], - "type": "object", - "properties": { - "apiKeyId": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "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 - }, - "eventTypeName": { - "$ref": "#/components/schemas/TeamEventTypeView" - }, - "groupId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "default": false - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "format": "email", - "readOnly": true, - "example": "test.user@mongodb.com" - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "example": "test.user@mongodb.com" - } - }, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "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 - }, - "eventTypeName": { - "$ref": "#/components/schemas/UserEventTypeViewForOrg" - }, - "groupId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "default": false - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "format": "email", - "readOnly": true, - "example": "test.user@mongodb.com" - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "example": "test.user@mongodb.com" - } - }, - "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", - "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", - "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" - ] - }, - { - "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" - ] - }, - { - "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": ["GROUP_TAGS_MODIFIED"] - } - ] - }, - "AlertViewForNdsGroup": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/AppServiceAlertView" - }, - { - "$ref": "#/components/schemas/ClusterAlertView" - }, - { - "$ref": "#/components/schemas/HostAlertViewForNdsGroup" - }, - { - "$ref": "#/components/schemas/HostMetricAlert" - }, - { - "$ref": "#/components/schemas/ReplicaSetAlertViewForNdsGroup" - }, - { - "$ref": "#/components/schemas/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.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value.", - "format": "date-time" - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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 - }, - "eventTypeName": { - "$ref": "#/components/schemas/AppServiceEventTypeViewAlertable" - }, - "groupId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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 - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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 - }, - "status": { - "type": "string", - "description": "State of this alert at the time you requested its details.", - "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 - } - }, - "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" - ] - }, - "ClusterAlertView": { - "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.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value.", - "format": "date-time" - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 64, - "minLength": 1, - "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 - }, - "eventTypeName": { - "$ref": "#/components/schemas/ClusterEventTypeViewAlertable" - }, - "groupId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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 - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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 - }, - "status": { - "type": "string", - "description": "State of this alert at the time you requested its details.", - "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 - } - }, - "description": "Cluster alert notifies different activities and conditions about cluster of mongod hosts." - }, - "ClusterEventTypeViewAlertable": { - "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.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value.", - "format": "date-time" - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 64, - "minLength": 1, - "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 - }, - "currentValue": { - "$ref": "#/components/schemas/DataMetricValueView" - }, - "eventTypeName": { - "$ref": "#/components/schemas/HostMetricEventTypeViewAlertable" - }, - "groupId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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 - }, - "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`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**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" - }, - "orgId": { - "maxLength": 24, - "minLength": 24, - "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 - }, - "status": { - "type": "string", - "description": "State of this alert at the time you requested its details.", - "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 - } - } - }, - "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.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value.", - "format": "date-time" - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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 - }, - "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_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" - ] - }, - { - "title": "Group Event Types", - "type": "string", - "enum": ["USERS_WITHOUT_MULTI_FACTOR_AUTH", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED"] - }, - { - "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" - ] - }, - { - "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": "User Event Types", - "type": "string", - "enum": ["JOINED_GROUP", "REMOVED_FROM_GROUP", "USER_ROLES_CHANGED_AUDIT"] - }, - { - "title": "Resource Event Types", - "type": "string", - "enum": ["TAGS_MODIFIED", "GROUP_TAGS_MODIFIED"] - }, - { - "title": "Stream Processor Event Types", - "type": "string", - "enum": ["STREAM_PROCESSOR_STATE_IS_FAILED"] - }, - { - "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" - ] - } - ] - }, - "groupId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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 - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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 - }, - "status": { - "type": "string", - "description": "State of this alert at the time you requested its details.", - "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 - } - }, - "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.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value.", - "format": "date-time" - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 64, - "minLength": 1, - "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 - }, - "eventTypeName": { - "$ref": "#/components/schemas/HostEventTypeViewForNdsGroupAlertable" - }, - "groupId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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 - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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 - }, - "status": { - "type": "string", - "description": "State of this alert at the time you requested its details.", - "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 - } - }, - "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_NOT_ENOUGH_DISK_SPACE"] - }, - "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.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value.", - "format": "date-time" - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 64, - "minLength": 1, - "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 - }, - "currentValue": { - "$ref": "#/components/schemas/HostMetricValue" - }, - "eventTypeName": { - "$ref": "#/components/schemas/HostMetricEventTypeViewAlertable" - }, - "groupId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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 - }, - "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`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**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" - }, - "orgId": { - "maxLength": 24, - "minLength": 24, - "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 - }, - "status": { - "type": "string", - "description": "State of this alert at the time you requested its details.", - "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 - } - }, - "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_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", - "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.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value.", - "format": "date-time" - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 64, - "minLength": 1, - "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 - }, - "currentValue": { - "$ref": "#/components/schemas/NumberMetricValueView" - }, - "eventTypeName": { - "$ref": "#/components/schemas/HostMetricEventTypeViewAlertable" - }, - "groupId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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 - }, - "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`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**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" - }, - "orgId": { - "maxLength": 24, - "minLength": 24, - "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 - }, - "status": { - "type": "string", - "description": "State of this alert at the time you requested its details.", - "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 - } - } - }, - "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 providers 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`.", - "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.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value.", - "format": "date-time" - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 64, - "minLength": 1, - "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 - }, - "currentValue": { - "$ref": "#/components/schemas/RawMetricValueView" - }, - "eventTypeName": { - "$ref": "#/components/schemas/HostMetricEventTypeViewAlertable" - }, - "groupId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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 - }, - "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`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**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" - }, - "orgId": { - "maxLength": 24, - "minLength": 24, - "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 - }, - "status": { - "type": "string", - "description": "State of this alert at the time you requested its details.", - "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 - } - } - }, - "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.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value.", - "format": "date-time" - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 64, - "minLength": 1, - "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 - }, - "eventTypeName": { - "$ref": "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertable" - }, - "groupId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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 - }, - "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, - "items": { - "maxLength": 32, - "minLength": 8, - "pattern": "^([a-f0-9]{8,32})$", - "type": "string", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - } - }, - "orgId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 64, - "minLength": 1, - "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 - }, - "status": { - "type": "string", - "description": "State of this alert at the time you requested its details.", - "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 - } - }, - "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"] - }, - "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.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value.", - "format": "date-time" - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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 - }, - "eventTypeName": { - "$ref": "#/components/schemas/HostEventTypeViewForNdsGroupAlertable" - }, - "groupId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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 - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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 - }, - "status": { - "type": "string", - "description": "State of this alert at the time you requested its details.", - "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 - } - }, - "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.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value.", - "format": "date-time" - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 64, - "minLength": 1, - "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 - }, - "currentValue": { - "$ref": "#/components/schemas/TimeMetricValueView" - }, - "eventTypeName": { - "$ref": "#/components/schemas/HostMetricEventTypeViewAlertable" - }, - "groupId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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 - }, - "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`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**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" - }, - "orgId": { - "maxLength": 24, - "minLength": 24, - "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 - }, - "status": { - "type": "string", - "description": "State of this alert at the time you requested its details.", - "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 - } - } - }, - "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.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value.", - "format": "date-time" - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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 - }, - "groupId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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 - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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 - }, - "status": { - "type": "string", - "description": "State of this alert at the time you requested its details.", - "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 - } - }, - "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." - }, - "AcknowledgeAlert": { - "title": "Acknowledge Alert", - "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.", - "format": "date-time" - }, - "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." - }, - "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" - } - }, - "unacknowledgeAlert": { - "type": "boolean", - "description": "Flag that indicates to unacknowledge a previously acknowledged alert. By default this value is set to false. If set to true, it will override the acknowledgedUntil parameter." - } - }, - "description": "Acknowledging an alert prevents successive notifications. Specify the acknowledgeUntil date and optional comment or unacknowledgeAlert boolean." - }, - "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.", - "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.", - "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 - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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.", - "items": { - "$ref": "#/components/schemas/AppServiceMetricMatcher" - } - }, - "notifications": { - "type": "array", - "description": "List that contains the targets that MongoDB Cloud sends notifications.", - "items": { - "$ref": "#/components/schemas/AlertsNotificationRootForGroup" - } - }, - "updated": { - "type": "string", - "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 - } - }, - "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 - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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.", - "items": { - "$ref": "#/components/schemas/AppServiceMetricMatcher" - } - }, - "metricThreshold": { - "$ref": "#/components/schemas/AppServiceMetricThreshold" - }, - "notifications": { - "type": "array", - "description": "List that contains the targets that MongoDB Cloud sends notifications.", - "items": { - "$ref": "#/components/schemas/AlertsNotificationRootForGroup" - } - }, - "updated": { - "type": "string", - "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 - } - }, - "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": { - "$ref": "#/components/schemas/Operator" - }, - "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.", - "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" - } - } - }, - "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 - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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.", - "items": { - "$ref": "#/components/schemas/AlertMatcher" - } - }, - "notifications": { - "type": "array", - "description": "List that contains the targets that MongoDB Cloud sends notifications.", - "items": { - "$ref": "#/components/schemas/AlertsNotificationRootForGroup" - } - }, - "threshold": { - "$ref": "#/components/schemas/GreaterThanRawThreshold" - }, - "updated": { - "type": "string", - "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 - } - }, - "description": "Billing threshold alert configuration allows to select thresholds for bills and invoices which trigger alerts and how users are notified." - }, - "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 - }, - "enabled": { - "type": "boolean", - "description": "Flag that indicates whether someone enabled this alert configuration for the specified project.", - "default": false - }, - "eventTypeName": { - "$ref": "#/components/schemas/ClusterEventTypeViewAlertable" - }, - "groupId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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.", - "items": { - "$ref": "#/components/schemas/ClusterMatcher" - } - }, - "notifications": { - "type": "array", - "description": "List that contains the targets that MongoDB Cloud sends notifications.", - "items": { - "$ref": "#/components/schemas/AlertsNotificationRootForGroup" - } - }, - "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 - } - }, - "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"] - }, - "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 - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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.", - "items": { - "$ref": "#/components/schemas/AlertMatcher" - } - }, - "notifications": { - "type": "array", - "description": "List that contains the targets that MongoDB Cloud sends notifications.", - "items": { - "$ref": "#/components/schemas/AlertsNotificationRootForGroup" - } - }, - "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 - } - }, - "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." - }, - "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": { - "$ref": "#/components/schemas/Operator" - }, - "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\"`.\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": "****************************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\"`.\n\nTo learn more about Datadog's regions, see Datadog Sites.", - "default": "US", - "enum": ["US", "EU", "US3", "US5", "AP1"] - }, - "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.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", - "format": "int32" - }, - "notifierId": { - "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." - }, - "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 - }, - "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_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": "FTS Index Audit Types", - "type": "string", - "enum": [ - "FTS_INDEX_DELETION_FAILED", - "FTS_INDEX_BUILD_COMPLETE", - "FTS_INDEX_BUILD_FAILED", - "FTS_INDEXES_RESTORE_FAILED" - ] - }, - { - "title": "Group Event Types", - "type": "string", - "enum": ["USERS_WITHOUT_MULTI_FACTOR_AUTH", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED"] - }, - { - "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" - ] - }, - { - "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", "GROUP_TAGS_MODIFIED"] - }, - { - "title": "Stream Processor Event Types", - "type": "string", - "enum": ["STREAM_PROCESSOR_STATE_IS_FAILED"] - }, - { - "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" - ] - } - ] - }, - "groupId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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.", - "items": { - "$ref": "#/components/schemas/AlertMatcher" - } - }, - "notifications": { - "type": "array", - "description": "List that contains the targets that MongoDB Cloud sends notifications.", - "items": { - "$ref": "#/components/schemas/AlertsNotificationRootForGroup" - } - }, - "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 - } - }, - "description": "Other alerts which don't have extra details beside of basic one." - }, - "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:\n\n- specific MongoDB Cloud users (`\"notifications.[n].typeName\" : \"USER\"`)\n- MongoDB Cloud users with specific project roles (`\"notifications.[n].typeName\" : \"GROUP\"`)\n- MongoDB Cloud users with specific organization roles (`\"notifications.[n].typeName\" : \"ORG\"`)\n- MongoDB Cloud teams (`\"notifications.[n].typeName\" : \"TEAM\"`)\n\nTo 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.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", - "format": "int32" - }, - "notifierId": { - "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 - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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.", - "items": { - "$ref": "#/components/schemas/AlertMatcher" - } - }, - "notifications": { - "type": "array", - "description": "List that contains the targets that MongoDB Cloud sends notifications.", - "items": { - "$ref": "#/components/schemas/AlertsNotificationRootForGroup" - } - }, - "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 - } - }, - "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" - ] - }, - "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 - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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.", - "items": { - "$ref": "#/components/schemas/ReplicaSetMatcher" - } - }, - "notifications": { - "type": "array", - "description": "List that contains the targets that MongoDB Cloud sends notifications.", - "items": { - "$ref": "#/components/schemas/AlertsNotificationRootForGroup" - } - }, - "threshold": { - "$ref": "#/components/schemas/GreaterThanRawThreshold" - }, - "updated": { - "type": "string", - "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 - } - } - }, - "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", - "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/StreamProcessorAlertConfigViewForNdsGroup" - } - ] - }, - "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:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" - }, - "intervalMin": { - "minimum": 5, - "type": "integer", - "description": "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", - "format": "int32" - }, - "notifierId": { - "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](https://dochub.mongodb.org/core/atlas-org-roles) or [project roles](https://dochub.mongodb.org/core/atlas-proj-roles) that receive the configured alert. The resource requires this parameter 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.", - "items": { - "type": "string", - "description": "One organization or project role that receive the configured alert.", - "enum": [ - "GROUP_CLUSTER_MANAGER", - "GROUP_DATA_ACCESS_ADMIN", - "GROUP_DATA_ACCESS_READ_ONLY", - "GROUP_DATA_ACCESS_READ_WRITE", - "GROUP_OWNER", - "GROUP_READ_WRITE", - "ORG_OWNER", - "ORG_MEMBER", - "ORG_GROUP_CREATOR", - "ORG_BILLING_ADMIN", - "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:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" - }, - "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.\n\nPagerDuty, 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.\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": "************************************1234" - }, - "notifierId": { - "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 - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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.", - "items": { - "$ref": "#/components/schemas/HostMatcher" - } - }, - "notifications": { - "type": "array", - "description": "List that contains the targets that MongoDB Cloud sends notifications.", - "items": { - "$ref": "#/components/schemas/AlertsNotificationRootForGroup" - } - }, - "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 - } - }, - "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 - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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.", - "items": { - "$ref": "#/components/schemas/HostMatcher" - } - }, - "metricThreshold": { - "$ref": "#/components/schemas/HostMetricThreshold" - }, - "notifications": { - "type": "array", - "description": "List that contains the targets that MongoDB Cloud sends notifications.", - "items": { - "$ref": "#/components/schemas/AlertsNotificationRootForGroup" - } - }, - "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 - } - }, - "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": { - "$ref": "#/components/schemas/Operator" - }, - "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.", - "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/RawMetricThresholdView", - "ASSERT_WARNING": "#/components/schemas/RawMetricThresholdView", - "ASSERT_MSG": "#/components/schemas/RawMetricThresholdView", - "ASSERT_USER": "#/components/schemas/RawMetricThresholdView", - "OPCOUNTER_CMD": "#/components/schemas/RawMetricThresholdView", - "OPCOUNTER_QUERY": "#/components/schemas/RawMetricThresholdView", - "OPCOUNTER_UPDATE": "#/components/schemas/RawMetricThresholdView", - "OPCOUNTER_DELETE": "#/components/schemas/RawMetricThresholdView", - "OPCOUNTER_INSERT": "#/components/schemas/RawMetricThresholdView", - "OPCOUNTER_GETMORE": "#/components/schemas/RawMetricThresholdView", - "OPCOUNTER_REPL_CMD": "#/components/schemas/RawMetricThresholdView", - "OPCOUNTER_REPL_UPDATE": "#/components/schemas/RawMetricThresholdView", - "OPCOUNTER_REPL_DELETE": "#/components/schemas/RawMetricThresholdView", - "OPCOUNTER_REPL_INSERT": "#/components/schemas/RawMetricThresholdView", - "FTS_MEMORY_RESIDENT": "#/components/schemas/DataMetricThresholdView", - "FTS_MEMORY_VIRTUAL": "#/components/schemas/DataMetricThresholdView", - "FTS_MEMORY_MAPPED": "#/components/schemas/DataMetricThresholdView", - "FTS_PROCESS_CPU_USER": "#/components/schemas/RawMetricThresholdView", - "FTS_PROCESS_CPU_KERNEL": "#/components/schemas/RawMetricThresholdView", - "NORMALIZED_FTS_PROCESS_CPU_USER": "#/components/schemas/RawMetricThresholdView", - "NORMALIZED_FTS_PROCESS_CPU_KERNEL": "#/components/schemas/RawMetricThresholdView", - "SYSTEM_MEMORY_PERCENT_USED": "#/components/schemas/RawMetricThresholdView", - "MEMORY_RESIDENT": "#/components/schemas/DataMetricThresholdView", - "MEMORY_VIRTUAL": "#/components/schemas/DataMetricThresholdView", - "MEMORY_MAPPED": "#/components/schemas/DataMetricThresholdView", - "COMPUTED_MEMORY": "#/components/schemas/DataMetricThresholdView", - "INDEX_COUNTERS_BTREE_ACCESSES": "#/components/schemas/RawMetricThresholdView", - "INDEX_COUNTERS_BTREE_HITS": "#/components/schemas/RawMetricThresholdView", - "INDEX_COUNTERS_BTREE_MISSES": "#/components/schemas/RawMetricThresholdView", - "INDEX_COUNTERS_BTREE_MISS_RATIO": "#/components/schemas/RawMetricThresholdView", - "GLOBAL_LOCK_PERCENTAGE": "#/components/schemas/RawMetricThresholdView", - "BACKGROUND_FLUSH_AVG": "#/components/schemas/TimeMetricThresholdView", - "CONNECTIONS": "#/components/schemas/RawMetricThresholdView", - "CONNECTIONS_MAX": "#/components/schemas/RawMetricThresholdView", - "CONNECTIONS_PERCENT": "#/components/schemas/RawMetricThresholdView", - "GLOBAL_ACCESSES_NOT_IN_MEMORY": "#/components/schemas/RawMetricThresholdView", - "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN": "#/components/schemas/RawMetricThresholdView", - "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL": "#/components/schemas/RawMetricThresholdView", - "GLOBAL_LOCK_CURRENT_QUEUE_READERS": "#/components/schemas/RawMetricThresholdView", - "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS": "#/components/schemas/RawMetricThresholdView", - "CURSORS_TOTAL_OPEN": "#/components/schemas/RawMetricThresholdView", - "CURSORS_TOTAL_TIMED_OUT": "#/components/schemas/RawMetricThresholdView", - "CURSORS_TOTAL_CLIENT_CURSORS_SIZE": "#/components/schemas/RawMetricThresholdView", - "NETWORK_BYTES_IN": "#/components/schemas/DataMetricThresholdView", - "NETWORK_BYTES_OUT": "#/components/schemas/DataMetricThresholdView", - "NETWORK_NUM_REQUESTS": "#/components/schemas/RawMetricThresholdView", - "OPLOG_MASTER_TIME": "#/components/schemas/TimeMetricThresholdView", - "OPLOG_MASTER_TIME_ESTIMATED_TTL": "#/components/schemas/TimeMetricThresholdView", - "OPLOG_SLAVE_LAG_MASTER_TIME": "#/components/schemas/TimeMetricThresholdView", - "OPLOG_MASTER_LAG_TIME_DIFF": "#/components/schemas/TimeMetricThresholdView", - "OPLOG_RATE_GB_PER_HOUR": "#/components/schemas/DataMetricThresholdView", - "EXTRA_INFO_PAGE_FAULTS": "#/components/schemas/RawMetricThresholdView", - "DB_STORAGE_TOTAL": "#/components/schemas/DataMetricThresholdView", - "DB_DATA_SIZE_TOTAL": "#/components/schemas/DataMetricThresholdView", - "DB_DATA_SIZE_TOTAL_WO_SYSTEM": "#/components/schemas/DataMetricThresholdView", - "DB_INDEX_SIZE_TOTAL": "#/components/schemas/DataMetricThresholdView", - "JOURNALING_COMMITS_IN_WRITE_LOCK": "#/components/schemas/RawMetricThresholdView", - "JOURNALING_MB": "#/components/schemas/DataMetricThresholdView", - "JOURNALING_WRITE_DATA_FILES_MB": "#/components/schemas/DataMetricThresholdView", - "TICKETS_AVAILABLE_READS": "#/components/schemas/RawMetricThresholdView", - "TICKETS_AVAILABLE_WRITES": "#/components/schemas/RawMetricThresholdView", - "CACHE_USAGE_DIRTY": "#/components/schemas/DataMetricThresholdView", - "CACHE_USAGE_USED": "#/components/schemas/DataMetricThresholdView", - "CACHE_BYTES_READ_INTO": "#/components/schemas/DataMetricThresholdView", - "CACHE_BYTES_WRITTEN_FROM": "#/components/schemas/DataMetricThresholdView", - "NORMALIZED_SYSTEM_CPU_USER": "#/components/schemas/RawMetricThresholdView", - "NORMALIZED_SYSTEM_CPU_STEAL": "#/components/schemas/RawMetricThresholdView", - "DISK_PARTITION_SPACE_USED_DATA": "#/components/schemas/RawMetricThresholdView", - "DISK_PARTITION_SPACE_USED_INDEX": "#/components/schemas/RawMetricThresholdView", - "DISK_PARTITION_SPACE_USED_JOURNAL": "#/components/schemas/RawMetricThresholdView", - "DISK_PARTITION_READ_IOPS_DATA": "#/components/schemas/RawMetricThresholdView", - "DISK_PARTITION_READ_IOPS_INDEX": "#/components/schemas/RawMetricThresholdView", - "DISK_PARTITION_READ_IOPS_JOURNAL": "#/components/schemas/RawMetricThresholdView", - "DISK_PARTITION_WRITE_IOPS_DATA": "#/components/schemas/RawMetricThresholdView", - "DISK_PARTITION_WRITE_IOPS_INDEX": "#/components/schemas/RawMetricThresholdView", - "DISK_PARTITION_WRITE_IOPS_JOURNAL": "#/components/schemas/RawMetricThresholdView", - "DISK_PARTITION_READ_LATENCY_DATA": "#/components/schemas/TimeMetricThresholdView", - "DISK_PARTITION_READ_LATENCY_INDEX": "#/components/schemas/TimeMetricThresholdView", - "DISK_PARTITION_READ_LATENCY_JOURNAL": "#/components/schemas/TimeMetricThresholdView", - "DISK_PARTITION_WRITE_LATENCY_DATA": "#/components/schemas/TimeMetricThresholdView", - "DISK_PARTITION_WRITE_LATENCY_INDEX": "#/components/schemas/TimeMetricThresholdView", - "DISK_PARTITION_WRITE_LATENCY_JOURNAL": "#/components/schemas/TimeMetricThresholdView", - "DISK_PARTITION_QUEUE_DEPTH_DATA": "#/components/schemas/RawMetricThresholdView", - "DISK_PARTITION_QUEUE_DEPTH_INDEX": "#/components/schemas/RawMetricThresholdView", - "DISK_PARTITION_QUEUE_DEPTH_JOURNAL": "#/components/schemas/RawMetricThresholdView", - "FTS_DISK_UTILIZATION": "#/components/schemas/DataMetricThresholdView", - "MUNIN_CPU_USER": "#/components/schemas/RawMetricThresholdView", - "MUNIN_CPU_NICE": "#/components/schemas/RawMetricThresholdView", - "MUNIN_CPU_SYSTEM": "#/components/schemas/RawMetricThresholdView", - "MUNIN_CPU_IOWAIT": "#/components/schemas/RawMetricThresholdView", - "MUNIN_CPU_IRQ": "#/components/schemas/RawMetricThresholdView", - "MUNIN_CPU_SOFTIRQ": "#/components/schemas/RawMetricThresholdView", - "MUNIN_CPU_STEAL": "#/components/schemas/RawMetricThresholdView", - "DOCUMENT_RETURNED": "#/components/schemas/RawMetricThresholdView", - "DOCUMENT_INSERTED": "#/components/schemas/RawMetricThresholdView", - "DOCUMENT_UPDATED": "#/components/schemas/RawMetricThresholdView", - "DOCUMENT_DELETED": "#/components/schemas/RawMetricThresholdView", - "OPERATIONS_SCAN_AND_ORDER": "#/components/schemas/RawMetricThresholdView", - "QUERY_EXECUTOR_SCANNED": "#/components/schemas/RawMetricThresholdView", - "QUERY_EXECUTOR_SCANNED_OBJECTS": "#/components/schemas/RawMetricThresholdView", - "OPERATION_THROTTLING_REJECTED_OPERATIONS": "#/components/schemas/RawMetricThresholdView", - "QUERY_TARGETING_SCANNED_PER_RETURNED": "#/components/schemas/RawMetricThresholdView", - "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED": "#/components/schemas/RawMetricThresholdView", - "AVG_READ_EXECUTION_TIME": "#/components/schemas/TimeMetricThresholdView", - "AVG_WRITE_EXECUTION_TIME": "#/components/schemas/TimeMetricThresholdView", - "AVG_COMMAND_EXECUTION_TIME": "#/components/schemas/TimeMetricThresholdView", - "LOGICAL_SIZE": "#/components/schemas/DataMetricThresholdView", - "RESTARTS_IN_LAST_HOUR": "#/components/schemas/RawMetricThresholdView", - "SYSTEM_MEMORY_USED": "#/components/schemas/DataMetricThresholdView", - "SYSTEM_MEMORY_AVAILABLE": "#/components/schemas/DataMetricThresholdView", - "SWAP_USAGE_USED": "#/components/schemas/DataMetricThresholdView", - "SWAP_USAGE_FREE": "#/components/schemas/DataMetricThresholdView", - "SYSTEM_NETWORK_IN": "#/components/schemas/DataMetricThresholdView", - "SYSTEM_NETWORK_OUT": "#/components/schemas/DataMetricThresholdView", - "MAX_NORMALIZED_SYSTEM_CPU_USER": "#/components/schemas/RawMetricThresholdView", - "MAX_NORMALIZED_SYSTEM_CPU_STEAL": "#/components/schemas/RawMetricThresholdView", - "MAX_DISK_PARTITION_SPACE_USED_DATA": "#/components/schemas/RawMetricThresholdView", - "MAX_DISK_PARTITION_SPACE_USED_INDEX": "#/components/schemas/RawMetricThresholdView", - "MAX_DISK_PARTITION_SPACE_USED_JOURNAL": "#/components/schemas/RawMetricThresholdView", - "MAX_DISK_PARTITION_READ_IOPS_DATA": "#/components/schemas/RawMetricThresholdView", - "MAX_DISK_PARTITION_READ_IOPS_INDEX": "#/components/schemas/RawMetricThresholdView", - "MAX_DISK_PARTITION_READ_IOPS_JOURNAL": "#/components/schemas/RawMetricThresholdView", - "MAX_DISK_PARTITION_WRITE_IOPS_DATA": "#/components/schemas/RawMetricThresholdView", - "MAX_DISK_PARTITION_WRITE_IOPS_INDEX": "#/components/schemas/RawMetricThresholdView", - "MAX_DISK_PARTITION_WRITE_IOPS_JOURNAL": "#/components/schemas/RawMetricThresholdView", - "MAX_DISK_PARTITION_READ_LATENCY_DATA": "#/components/schemas/TimeMetricThresholdView", - "MAX_DISK_PARTITION_READ_LATENCY_INDEX": "#/components/schemas/TimeMetricThresholdView", - "MAX_DISK_PARTITION_READ_LATENCY_JOURNAL": "#/components/schemas/TimeMetricThresholdView", - "MAX_DISK_PARTITION_WRITE_LATENCY_DATA": "#/components/schemas/TimeMetricThresholdView", - "MAX_DISK_PARTITION_WRITE_LATENCY_INDEX": "#/components/schemas/TimeMetricThresholdView", - "MAX_DISK_PARTITION_WRITE_LATENCY_JOURNAL": "#/components/schemas/TimeMetricThresholdView", - "MAX_DISK_PARTITION_QUEUE_DEPTH_DATA": "#/components/schemas/RawMetricThresholdView", - "MAX_DISK_PARTITION_QUEUE_DEPTH_INDEX": "#/components/schemas/RawMetricThresholdView", - "MAX_DISK_PARTITION_QUEUE_DEPTH_JOURNAL": "#/components/schemas/RawMetricThresholdView", - "MAX_SYSTEM_MEMORY_PERCENT_USED": "#/components/schemas/RawMetricThresholdView", - "MAX_SYSTEM_MEMORY_USED": "#/components/schemas/DataMetricThresholdView", - "MAX_SYSTEM_MEMORY_AVAILABLE": "#/components/schemas/DataMetricThresholdView", - "MAX_SWAP_USAGE_USED": "#/components/schemas/DataMetricThresholdView", - "MAX_SWAP_USAGE_FREE": "#/components/schemas/DataMetricThresholdView", - "MAX_SYSTEM_NETWORK_IN": "#/components/schemas/DataMetricThresholdView", - "MAX_SYSTEM_NETWORK_OUT": "#/components/schemas/DataMetricThresholdView", - "SEARCH_INDEX_SIZE": "#/components/schemas/DataMetricThresholdView", - "SEARCH_NUMBER_OF_FIELDS_IN_INDEX": "#/components/schemas/RawMetricThresholdView", - "SEARCH_REPLICATION_LAG": "#/components/schemas/TimeMetricThresholdView", - "SEARCH_MAX_NUMBER_OF_LUCENE_DOCS": "#/components/schemas/NumberMetricThresholdView", - "SEARCH_OPCOUNTER_INSERT": "#/components/schemas/RawMetricThresholdView", - "SEARCH_OPCOUNTER_DELETE": "#/components/schemas/RawMetricThresholdView", - "SEARCH_OPCOUNTER_UPDATE": "#/components/schemas/RawMetricThresholdView", - "SEARCH_OPCOUNTER_GETMORE": "#/components/schemas/RawMetricThresholdView", - "SEARCH_NUMBER_OF_QUERIES_TOTAL": "#/components/schemas/RawMetricThresholdView", - "SEARCH_NUMBER_OF_QUERIES_ERROR": "#/components/schemas/RawMetricThresholdView", - "SEARCH_NUMBER_OF_QUERIES_SUCCESS": "#/components/schemas/RawMetricThresholdView", - "FTS_JVM_MAX_MEMORY": "#/components/schemas/DataMetricThresholdView", - "FTS_JVM_CURRENT_MEMORY": "#/components/schemas/DataMetricThresholdView" - } - } - }, - "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 - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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.", - "items": { - "$ref": "#/components/schemas/ReplicaSetMatcher" - } - }, - "notifications": { - "type": "array", - "description": "List that contains the targets that MongoDB Cloud sends notifications.", - "items": { - "$ref": "#/components/schemas/AlertsNotificationRootForGroup" - } - }, - "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 - } - } - }, - "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"] - }, - "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.\n\nPagerDuty, 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.\n\n**NOTE**: When you view or edit the alert for a Microsoft Teams notification, the URL appears partially redacted.", - "example": "https://webhook.com/****" - }, - "notifierId": { - "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." - }, - "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 - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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.", - "items": { - "$ref": "#/components/schemas/AlertMatcher" - } - }, - "notifications": { - "type": "array", - "description": "List that contains the targets that MongoDB Cloud sends notifications.", - "items": { - "$ref": "#/components/schemas/AlertsNotificationRootForGroup" - } - }, - "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 - } - }, - "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" - ] - }, - "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": { - "$ref": "#/components/schemas/Operator" - }, - "threshold": { - "type": "number", - "description": "Value of metric that, when exceeded, triggers an alert.", - "format": "double" - }, - "units": { - "$ref": "#/components/schemas/NumberMetricUnits" - } - } - }, - "Operator": { - "type": "string", - "description": "Comparison operator to apply when checking the current metric value.", - "enum": ["<", ">"] - }, - "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.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", - "format": "int32" - }, - "notifierId": { - "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.\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": "********************************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:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" - }, - "intervalMin": { - "minimum": 5, - "type": "integer", - "description": "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", - "format": "int32" - }, - "notifierId": { - "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](https://dochub.mongodb.org/core/atlas-org-roles) or [project roles](https://dochub.mongodb.org/core/atlas-proj-roles) that receive the configured alert. The resource requires this parameter 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.", - "items": { - "type": "string", - "description": "One organization or project role that receive the configured alert.", - "enum": [ - "GROUP_CLUSTER_MANAGER", - "GROUP_DATA_ACCESS_ADMIN", - "GROUP_DATA_ACCESS_READ_ONLY", - "GROUP_DATA_ACCESS_READ_WRITE", - "GROUP_OWNER", - "GROUP_READ_WRITE", - "ORG_OWNER", - "ORG_MEMBER", - "ORG_GROUP_CREATOR", - "ORG_BILLING_ADMIN", - "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:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" - }, - "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.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", - "format": "int32" - }, - "notifierId": { - "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.\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": "****************************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 providers 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`.", - "format": "int32", - "readOnly": true - } - } - }, - "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": { - "$ref": "#/components/schemas/Operator" - }, - "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": { - "$ref": "#/components/schemas/Operator" - }, - "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 - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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.", - "items": { - "$ref": "#/components/schemas/ReplicaSetMatcher" - } - }, - "notifications": { - "type": "array", - "description": "List that contains the targets that MongoDB Cloud sends notifications.", - "items": { - "$ref": "#/components/schemas/AlertsNotificationRootForGroup" - } - }, - "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 - } - }, - "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"] - }, - "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 - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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.", - "items": { - "$ref": "#/components/schemas/ReplicaSetMatcher" - } - }, - "notifications": { - "type": "array", - "description": "List that contains the targets that MongoDB Cloud sends notifications.", - "items": { - "$ref": "#/components/schemas/AlertsNotificationRootForGroup" - } - }, - "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 - } - }, - "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" - } - } - }, - "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.\n\nPagerDuty, 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": { - "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." - }, - "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 - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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.", - "items": { - "$ref": "#/components/schemas/AlertMatcher" - } - }, - "metricThreshold": { - "$ref": "#/components/schemas/ServerlessMetricThreshold" - }, - "notifications": { - "type": "array", - "description": "List that contains the targets that MongoDB Cloud sends notifications.", - "items": { - "$ref": "#/components/schemas/AlertsNotificationRootForGroup" - } - }, - "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 - } - }, - "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": { - "$ref": "#/components/schemas/Operator" - }, - "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.", - "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/RawMetricThresholdView", - "SERVERLESS_DATA_SIZE_TOTAL": "#/components/schemas/DataMetricThresholdView", - "SERVERLESS_NETWORK_BYTES_IN": "#/components/schemas/DataMetricThresholdView", - "SERVERLESS_NETWORK_BYTES_OUT": "#/components/schemas/DataMetricThresholdView", - "SERVERLESS_NETWORK_NUM_REQUESTS": "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_OPCOUNTER_CMD": "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_OPCOUNTER_DELETE": "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_OPCOUNTER_GETMORE": "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_OPCOUNTER_INSERT": "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_OPCOUNTER_QUERY": "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_OPCOUNTER_UPDATE": "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_TOTAL_READ_UNITS": "#/components/schemas/RPUMetricThresholdView", - "SERVERLESS_TOTAL_WRITE_UNITS": "#/components/schemas/RPUMetricThresholdView", - "SERVERLESS_AVG_READ_EXECUTION_TIME": "#/components/schemas/TimeMetricThresholdView", - "SERVERLESS_AVG_WRITE_EXECUTION_TIME": "#/components/schemas/TimeMetricThresholdView", - "SERVERLESS_AVG_COMMAND_EXECUTION_TIME": "#/components/schemas/TimeMetricThresholdView" - } - } - }, - "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"] - }, - "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.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", - "format": "int32" - }, - "notifierId": { - "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 - }, - "enabled": { - "type": "boolean", - "description": "Flag that indicates whether someone enabled this alert configuration for the specified project.", - "default": false - }, - "eventTypeName": { - "$ref": "#/components/schemas/StreamProcessorEventTypeViewAlertable" - }, - "groupId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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.", - "items": { - "$ref": "#/components/schemas/StreamsMatcher" - } - }, - "notifications": { - "type": "array", - "description": "List that contains the targets that MongoDB Cloud sends notifications.", - "items": { - "$ref": "#/components/schemas/AlertsNotificationRootForGroup" - } - }, - "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 - } - }, - "description": "Host metric alert configuration allows to select which Atlas streams processors trigger alerts and how users are notified." - }, - "StreamProcessorEventTypeViewAlertable": { - "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"] - }, - "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"] - }, - "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:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" - }, - "intervalMin": { - "minimum": 5, - "type": "integer", - "description": "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", - "format": "int32" - }, - "notifierId": { - "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:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" - }, - "teamId": { - "maxLength": 24, - "minLength": 24, - "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." - }, - "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": { - "$ref": "#/components/schemas/Operator" - }, - "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:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" - }, - "intervalMin": { - "minimum": 5, - "type": "integer", - "description": "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", - "format": "int32" - }, - "notifierId": { - "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:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" - }, - "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.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", - "format": "int32" - }, - "notifierId": { - "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.\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": "********************************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.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", - "format": "int32" - }, - "notifierId": { - "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.\n\nAtlas returns this value if you set `\"notifications.[n].typeName\" :\"WEBHOOK\"` and either:\n* You set `notification.[n].webhookSecret` to a non-empty string\n* You set a default webhookSecret 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)\n\n**NOTE**: When you view or edit the alert for a webhook notification, the secret appears completely redacted.", - "example": "******" - }, - "webhookUrl": { - "type": "string", - "description": "Target URL for a webhook-based alert.\n\nAtlas returns this value if you set `\"notifications.[n].typeName\" :\"WEBHOOK\"` and either:\n* You set `notification.[n].webhookURL` to a non-empty string\n* 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)\n\n**NOTE**: When you view or edit the alert for a Webhook URL notification, the URL appears partially redacted.", - "example": "https://webhook.com/****" - } - }, - "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"] - } - ] - }, - "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 - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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.", - "items": { - "$ref": "#/components/schemas/AlertMatcher" - } - }, - "notifications": { - "type": "array", - "description": "List that contains the targets that MongoDB Cloud sends notifications.", - "items": { - "$ref": "#/components/schemas/AlertsNotificationBase" - } - }, - "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 - } - }, - "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.", - "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.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", - "format": "int32" - }, - "notifierId": { - "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:\n\n- specific MongoDB Cloud users (`\"notifications.[n].typeName\" : \"USER\"`)\n- MongoDB Cloud users with specific project roles (`\"notifications.[n].typeName\" : \"GROUP\"`)\n- MongoDB Cloud users with specific organization roles (`\"notifications.[n].typeName\" : \"ORG\"`)\n- MongoDB Cloud teams (`\"notifications.[n].typeName\" : \"TEAM\"`)\n\nTo 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.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", - "format": "int32" - }, - "notifierId": { - "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." - }, - "GroupServiceAccountRoleAssignment": { - "type": "object", - "properties": { - "roles": { - "uniqueItems": true, - "type": "array", - "description": "Group access roles.", - "items": { - "type": "string", - "description": "Project roles associated with the service account.", - "enum": [ - "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" - ] - } - } - } - }, - "GroupServiceAccount": { - "type": "object", - "properties": { - "createdAt": { - "type": "string", - "description": "Service account creation time.", - "format": "date-time" - }, - "description": { - "type": "string", - "description": "Description of the service account." - }, - "id": { - "pattern": "^mdb_sa_id_[a-fA-F\\d]{24}$", - "type": "string", - "description": "ID for the service account." - }, - "name": { - "type": "string", - "description": "Name for service account." - }, - "roles": { - "uniqueItems": true, - "type": "array", - "description": "Roles assigned to the Service Account group.", - "items": { - "type": "string", - "description": "Project roles associated with the service account.", - "enum": [ - "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" - ] - } - }, - "secrets": { - "uniqueItems": true, - "type": "array", - "description": "List of secrets.", - "items": { - "$ref": "#/components/schemas/ServiceAccountSecret" - } - } - } - }, - "ServiceAccountSecret": { - "required": ["createdAt", "expiresAt", "id"], - "type": "object", - "properties": { - "createdAt": { - "type": "string", - "description": "Timestamp representing creation time.", - "format": "date-time", - "readOnly": true - }, - "expiresAt": { - "type": "string", - "description": "Timestamp representing secret expiration time.", - "format": "date-time", - "readOnly": true - }, - "id": { - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal character string that identifies the secret.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "lastUsedAt": { - "type": "string", - "description": "Timestamp representing last secret usage.", - "format": "date-time", - "readOnly": true - }, - "maskedSecretValue": { - "type": "string", - "description": "Service Account secret with masked values of the first 20 characters.", - "readOnly": true, - "example": "mdb_ic_sk_...12ce" - }, - "secret": { - "pattern": "^mdb_sa_sk_[0-9a-zA-Z]{40}$", - "type": "string", - "description": "Secret for the service account. It will be returned only the first time after service account creation.", - "readOnly": true - } - } - }, - "GroupServiceAccountRequest": { - "required": ["description", "name", "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": { - "type": "array", - "description": "Project roles associated with the service account.", - "items": { - "type": "string", - "description": "Project roles associated with the service account.", - "enum": [ - "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" - ] - } - }, - "secretExpiresAfterHours": { - "type": "integer", - "description": "Secret expiration time.", - "format": "int32" - } - } - }, - "PaginatedGroupServiceAccounts": { - "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 providers when completing this request.", - "readOnly": true, - "items": { - "$ref": "#/components/schemas/GroupServiceAccount" - } - }, - "totalCount": { - "minimum": 0, - "type": "integer", - "description": "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", - "format": "int32", - "readOnly": true - } - }, - "description": "List of Service Accounts" - }, - "GroupServiceAccountUpdateRequest": { - "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": { - "type": "array", - "description": "Project roles associated with the service account.", - "items": { - "type": "string", - "description": "Project roles associated with the service account.", - "enum": [ - "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" - ] - } - } - } - }, - "ServiceAccountSecretRequest": { - "required": ["secretExpiresAfterHours"], - "type": "object", - "properties": { - "secretExpiresAfterHours": { - "type": "integer", - "description": "Number of hours representing validity duration for secret.", - "format": "int32" - } - } - }, - "OrgServiceAccount": { - "type": "object", - "properties": { - "createdAt": { - "type": "string", - "description": "Service account creation time.", - "format": "date-time" - }, - "description": { - "type": "string", - "description": "Description of the service account." - }, - "id": { - "pattern": "^mdb_sa_id_[a-fA-F\\d]{24}$", - "type": "string", - "description": "ID for the service account." - }, - "name": { - "type": "string", - "description": "Name for service account." - }, - "roles": { - "uniqueItems": true, - "type": "array", - "description": "Organization roles assigned to the Service Account.", - "items": { - "type": "string", - "description": "Organization roles associated with the service account.", - "enum": [ - "ORG_MEMBER", - "ORG_READ_ONLY", - "ORG_BILLING_ADMIN", - "ORG_BILLING_READ_ONLY", - "ORG_GROUP_CREATOR", - "ORG_OWNER" - ] - } - }, - "secrets": { - "uniqueItems": true, - "type": "array", - "description": "List of secrets.", - "items": { - "$ref": "#/components/schemas/ServiceAccountSecret" - } - } - } - }, - "OrgServiceAccountRequest": { - "required": ["description", "name", "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": { - "type": "array", - "description": "Organization roles associated with the service account.", - "items": { - "type": "string", - "description": "Organization roles associated with the service account.", - "enum": [ - "ORG_MEMBER", - "ORG_READ_ONLY", - "ORG_BILLING_ADMIN", - "ORG_BILLING_READ_ONLY", - "ORG_GROUP_CREATOR", - "ORG_OWNER" - ] - } - }, - "secretExpiresAfterHours": { - "type": "integer", - "description": "Secret expiration time.", - "format": "int32" - } - } - }, - "PaginatedServiceAccountGroup": { - "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 providers when completing this request.", - "readOnly": true, - "items": { - "$ref": "#/components/schemas/ServiceAccountGroup" - } - }, - "totalCount": { - "minimum": 0, - "type": "integer", - "description": "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", - "format": "int32", - "readOnly": true - } - }, - "description": "List of Service Account projects." - }, - "ServiceAccountGroup": { - "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.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - } - } - }, - "PaginatedOrgServiceAccounts": { - "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 providers when completing this request.", - "readOnly": true, - "items": { - "$ref": "#/components/schemas/OrgServiceAccount" - } - }, - "totalCount": { - "minimum": 0, - "type": "integer", - "description": "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", - "format": "int32", - "readOnly": true - } - }, - "description": "List of Service Accounts" - }, - "OrgServiceAccountUpdateRequest": { - "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": { - "type": "array", - "description": "Organization roles associated with the Service account.", - "items": { - "type": "string", - "description": "Organization roles associated with the service account.", - "enum": [ - "ORG_MEMBER", - "ORG_READ_ONLY", - "ORG_BILLING_ADMIN", - "ORG_BILLING_READ_ONLY", - "ORG_GROUP_CREATOR", - "ORG_OWNER" - ] - } - } - } - }, - "CostExplorerFilterResponseView": { - "type": "object", - "properties": { - "token": { - "maxLength": 64, - "minLength": 64, - "type": "string", - "description": "The token used to identify the created Cost Explorer query.", - "example": "d9ab638a801efe182f98ae3e18ea4bb47b9fda808a28a8c7de205bb0e94f7d71" - } - }, - "description": "Response object to give information about created query." - }, - "CostExplorerFilterRequestBody": { - "required": ["endDate", "startDate"], - "type": "object", - "properties": { - "clusters": { - "type": "array", - "description": "The list of projects to be included in the Cost Explorer Query.", - "example": ["5feeac500000000000000000", "61cfdfd00000000000000000"], - "items": { - "type": "string" - } - }, - "endDate": { - "type": "string", - "description": "The exclusive ending date for the Cost Explorer query. The date must be the start of a month.", - "format": "date", - "example": "2022-02-01" - }, - "groupBy": { - "type": "string", - "description": "The dimension to group the returned usage results by. At least one filter value needs to be provided for a dimension to be used.", - "enum": ["organizations", "projects", "clusters", "services"] - }, - "includePartialMatches": { - "type": "boolean", - "description": "Flag to control whether usage that matches the filter criteria, but does not have values for all filter criteria is included in response. Default is false, which excludes the partially matching data." - }, - "organizations": { - "type": "array", - "description": "The list of organizations to be included in the Cost Explorer Query.", - "example": ["5feeac500000000000000000", "61cfdfd00000000000000000"], - "items": { - "type": "string" - } - }, - "projects": { - "type": "array", - "description": "The list of projects to be included in the Cost Explorer Query.", - "example": ["5feeac500000000000000000", "61cfdfd00000000000000000"], - "items": { - "type": "string" - } - }, - "services": { - "type": "array", - "description": "The list of projects to be included in the Cost Explorer Query.", - "example": ["Data Transfer", "Atlas Data Federation"], - "items": { - "type": "string", - "enum": [ - "Atlas", - "Clusters", - "Storage", - "Serverless Instances", - "Backup", - "Data Transfer", - "BI Connector", - "Premium Features", - "Atlas Data Federation", - "Atlas Stream Processing", - "App Services", - "Charts", - "Cloud Manager", - "Cloud Manager Standard/Premium", - "Legacy Backup", - "Flex Consulting", - "Support", - "Credits" - ] - } - }, - "startDate": { - "type": "string", - "description": "The inclusive starting date for the Cost Explorer query. The date must be the start of a month.", - "format": "date", - "example": "2022-02-01" - } - }, - "description": "Request body for a cost explorer query." - }, - "CostExplorerQueryResult": { - "type": "object" - }, - "PaginatedPublicApiUsageDetailsLineItemView": { - "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 providers when completing this request.", - "readOnly": true, - "items": { - "$ref": "#/components/schemas/PublicApiUsageDetailsLineItemView" - } - }, - "totalCount": { - "minimum": 0, - "type": "integer", - "description": "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", - "format": "int32", - "readOnly": true - } - } - }, - "PublicApiUsageDetailsLineItemView": { - "type": "object", - "properties": { - "billDate": { - "type": "string", - "description": "Billing date of the line item.", - "format": "date-time" - }, - "clusterName": { - "type": "string", - "description": "Cluster associated with the line item." - }, - "description": { - "type": "string", - "description": "Description of the line item, which can include SKU name and other identifying information." - }, - "groupId": { - "type": "string", - "description": "Group id associated with the line item." - }, - "quantity": { - "type": "number", - "description": "Quantity of line item in units associated with SKU.", - "format": "double", - "readOnly": true - }, - "totalPriceCents": { - "type": "integer", - "description": "Price * quantity in applicable units, expressed as an integral number of cents.", - "format": "int64" - }, - "unitPriceDollars": { - "type": "number", - "description": "Price in units associated with the SKU for the line item.", - "format": "double" - }, - "usageDate": { - "type": "string", - "description": "Usage date of the line item.", - "format": "date-time" - } - } - }, - "ApiPublicUsageDetailsQueryRequest": { - "type": "object", - "properties": { - "filters": { - "$ref": "#/components/schemas/UsageDetailsFilterRequest" - }, - "sortField": { - "type": "string", - "description": "Specify the field used to specify how to sort query results. Default to bill date.", - "enum": ["USAGE_DATES", "BILL_DATES", "TOTAL_PRICE_CENTS"] - }, - "sortOrder": { - "type": "string", - "description": "Specify the sort order (ascending / descending) used to specify how to sort query results. Defaults to descending.", - "enum": ["ASCENDING", "DESCENDING"] - } - }, - "description": "Request body for an Invoice Usage Details query with filtering, pagination, and sort." - }, - "UsageDetailsFilterRequest": { - "type": "object", - "properties": { - "billEndDate": { - "type": "string", - "description": "The inclusive billing start date for usage details filter.", - "format": "date", - "example": "2023-02-01" - }, - "billStartDate": { - "type": "string", - "description": "The inclusive billing start date for usage details filter.", - "format": "date", - "example": "2023-02-01" - }, - "clusterIds": { - "uniqueItems": true, - "type": "array", - "description": "The list of unique cluster ids to be included in the Usage Details filter.", - "example": ["650d11400000000000000000", "650dd6200000000000000000"], - "items": { - "type": "string" - } - }, - "groupIds": { - "uniqueItems": true, - "type": "array", - "description": "The list of groups to be included in the Usage Details filter.", - "example": ["650d11400000000000000000", "650dd6200000000000000000"], - "items": { - "type": "string" - } - }, - "includeZeroCentLineItems": { - "type": "boolean", - "description": "Whether zero cent line items should be included." - }, - "skuServices": { - "uniqueItems": true, - "type": "array", - "description": "The list of projects to be included in the Cost Explorer Query.", - "example": ["Atlas", "Clusters", "Storage"], - "items": { - "type": "string", - "enum": [ - "Atlas", - "Clusters", - "Storage", - "Serverless Instances", - "Backup", - "Data Transfer", - "BI Connector", - "Premium Features", - "Atlas Data Federation", - "Atlas Stream Processing", - "App Services", - "Charts", - "Cloud Manager", - "Cloud Manager Standard/Premium", - "Legacy Backup", - "Flex Consulting", - "Support", - "Credits" - ] - } - }, - "usageEndDate": { - "type": "string", - "description": "The inclusive billing start date for usage details filter.", - "format": "date", - "example": "2023-02-01" - }, - "usageStartDate": { - "type": "string", - "description": "The inclusive usage start date for usage details filter.", - "format": "date", - "example": "2023-02-01" - } - }, - "description": "Request body which contains various fields to filter line items as part of certain Invoice Usage Details queries." - }, - "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, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 64, - "minLength": 1, - "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, - "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, - "items": { - "$ref": "#/components/schemas/CloudCluster" - } - }, - "groupId": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal character string that identifies the project.", - "readOnly": true - }, - "groupName": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", - "type": "string", - "description": "Human-readable label that identifies the project." - }, - "orgId": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal character string that identifies the organization that contains the project.", - "readOnly": true - }, - "orgName": { - "maxLength": 64, - "minLength": 1, - "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, - "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 providers 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`.", - "format": "int32", - "readOnly": true - } - } - }, - "ExampleResourceResponse20230201": { - "required": ["description"], - "type": "object", - "properties": { - "additionalInfo": { - "type": "string", - "description": "Dummy additional field added to the response." - }, - "data": { - "type": "array", - "description": "Array that contains the dummy metadata.", - "items": { - "type": "string", - "description": "Dummy data added as response." - } - }, - "description": { - "type": "string", - "description": "Dummy description added as response." - }, - "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" - } - } - } - }, - "ExampleResourceResponse20230101": { - "required": ["data"], - "type": "object", - "properties": { - "data": { - "type": "string", - "description": "Dummy data added as response." - }, - "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" - } - } - } - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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.", - "items": { - "$ref": "#/components/schemas/RoleAssignment" - } - } - }, - "description": "Mapping settings that link one IdP and MongoDB Cloud." - }, - "RoleAssignment": { - "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. Each element within **roleAssignments** can have a value for **groupId** or **orgId**, but not both.", - "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. 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.\n\nOrganization Roles\n\n* ORG_OWNER\n* ORG_MEMBER\n* ORG_GROUP_CREATOR\n* ORG_BILLING_ADMIN\n* ORG_READ_ONLY\n\nProject Roles\n\n* GROUP_CLUSTER_MANAGER\n* GROUP_DATA_ACCESS_ADMIN\n* GROUP_DATA_ACCESS_READ_ONLY\n* GROUP_DATA_ACCESS_READ_WRITE\n* GROUP_OWNER\n* GROUP_READ_ONLY\n* GROUP_SEARCH_INDEX_EDITOR\n* GROUP_STREAM_PROCESSING_OWNER\n\n", - "enum": [ - "ORG_OWNER", - "ORG_MEMBER", - "ORG_GROUP_CREATOR", - "ORG_BILLING_ADMIN", - "ORG_READ_ONLY", - "GROUP_CLUSTER_MANAGER", - "GROUP_DATA_ACCESS_ADMIN", - "GROUP_DATA_ACCESS_READ_ONLY", - "GROUP_DATA_ACCESS_READ_WRITE", - "GROUP_OWNER", - "GROUP_READ_ONLY", - "GROUP_SEARCH_INDEX_EDITOR", - "GROUP_STREAM_PROCESSING_OWNER" - ] - } - } - }, - "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.", - "items": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "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.", - "example": "32b6e34b3d91647abb20e7b8" - } - }, - "domainAllowList": { - "uniqueItems": true, - "type": "array", - "description": "Approved domains that restrict users who can join the organization based on their email address.", - "items": { - "type": "string" - } - }, - "domainRestrictionEnabled": { - "type": "boolean", - "description": "Value that indicates whether domain restriction is enabled for this connected org." - }, - "identityProviderId": { - "maxLength": 20, - "minLength": 20, - "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": { - "maxLength": 24, - "minLength": 24, - "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.", - "items": { - "type": "string", - "enum": [ - "ORG_OWNER", - "ORG_MEMBER", - "ORG_GROUP_CREATOR", - "ORG_BILLING_ADMIN", - "ORG_BILLING_READ_ONLY", - "ORG_READ_ONLY" - ] - } - }, - "roleMappings": { - "uniqueItems": true, - "type": "array", - "description": "Role mappings that are configured in this organization.", - "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.", - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies this user.", - "readOnly": true - } - }, - "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 providers 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`.", - "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 providers 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`.", - "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.", - "items": { - "$ref": "#/components/schemas/ConnectedOrgConfig" - } - }, - "createdAt": { - "type": "string", - "description": "Date that the identity provider was created on.", - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 20, - "minLength": 20, - "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.", - "format": "date-time", - "readOnly": true - } - }, - "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.", - "items": { - "type": "string" - } - }, - "associatedOrgs": { - "uniqueItems": true, - "type": "array", - "description": "List that contains the connected organization configurations associated with the identity provider.", - "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.", - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 20, - "minLength": 20, - "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.", - "items": { - "type": "string" - } - }, - "updatedAt": { - "type": "string", - "description": "Date that the identity provider was last updated on.", - "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.", - "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.", - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 20, - "minLength": 20, - "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.", - "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.", - "items": { - "type": "string" - } - }, - "associatedOrgs": { - "uniqueItems": true, - "type": "array", - "description": "List that contains the connected organization configurations associated with the identity provider.", - "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.", - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 20, - "minLength": 20, - "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.", - "enum": ["HTTP-POST", "HTTP-REDIRECT"] - }, - "responseSignatureAlgorithm": { - "type": "string", - "description": "Signature algorithm that Federated Authentication uses to encrypt the identity provider signature.", - "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.", - "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 providers 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`.", - "format": "int32", - "readOnly": true - } - } - }, - "PemFileInfo": { - "type": "object", - "properties": { - "certificates": { - "type": "array", - "description": "List of certificates in the file.", - "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.", - "format": "date-time" - }, - "notBefore": { - "type": "string", - "description": "Earliest date that the certificate is valid.", - "format": "date-time" - } - } - }, - "FederationOidcIdentityProvider": { - "required": ["id", "oktaIdpId"], - "type": "object", - "properties": { - "associatedOrgs": { - "uniqueItems": true, - "type": "array", - "description": "List that contains the connected organization configurations associated with the identity provider.", - "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.", - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 20, - "minLength": 20, - "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.", - "format": "date-time", - "readOnly": true - }, - "userClaim": { - "type": "string", - "description": "Identifier of the claim which contains the user ID in the token." - } - }, - "oneOf": [ - { - "$ref": "#/components/schemas/FederationOidcWorkforceIdentityProvider" - }, - { - "$ref": "#/components/schemas/FederationOidcWorkloadIdentityProvider" - } - ] - }, - "FederationOidcIdentityProviderUpdate": { - "type": "object", - "properties": { - "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"] - }, - "description": { - "type": "string", - "description": "The description of the identity provider." - }, - "displayName": { - "maxLength": 50, - "minLength": 1, - "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." - }, - "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.", - "example": "urn:idp:default" - }, - "protocol": { - "type": "string", - "description": "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", - "enum": ["SAML", "OIDC"] - }, - "userClaim": { - "type": "string", - "description": "Identifier of the claim which contains the user ID in the token." - } - }, - "oneOf": [ - { - "$ref": "#/components/schemas/FederationOidcWorkforceIdentityProviderUpdate" - }, - { - "$ref": "#/components/schemas/FederationOidcWorkloadIdentityProviderUpdate" - } - ] - }, - "FederationOidcWorkforceIdentityProviderUpdate": { - "title": "OIDC WORKFORCE", - "type": "object", - "properties": { - "associatedDomains": { - "uniqueItems": true, - "type": "array", - "description": "List that contains the domains associated with the identity provider.", - "items": { - "type": "string" - } - }, - "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." - }, - "description": { - "type": "string", - "description": "The description of the identity provider." - }, - "displayName": { - "maxLength": 50, - "minLength": 1, - "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." - }, - "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.", - "example": "urn:idp:default" - }, - "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.", - "items": { - "type": "string" - } - }, - "userClaim": { - "type": "string", - "description": "Identifier of the claim which contains the user ID in the token." - } - } - }, - "FederationOidcWorkloadIdentityProviderUpdate": { - "title": "OIDC WORKLOAD", - "type": "object", - "properties": { - "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"] - }, - "description": { - "type": "string", - "description": "The description of the identity provider." - }, - "displayName": { - "maxLength": 50, - "minLength": 1, - "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." - }, - "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.", - "example": "urn:idp:default" - }, - "protocol": { - "type": "string", - "description": "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", - "enum": ["SAML", "OIDC"] - }, - "userClaim": { - "type": "string", - "description": "Identifier of the claim which contains the user ID in the token." - } - } - }, - "FederationIdentityProviderUpdate": { - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "The description of the identity provider." - }, - "displayName": { - "maxLength": 50, - "minLength": 1, - "type": "string", - "description": "Human-readable label that identifies the identity provider." - }, - "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.", - "example": "urn:idp:default" - }, - "protocol": { - "type": "string", - "description": "String enum that indicates the protocol of the identity provider. Either SAML or OIDC.", - "enum": ["SAML", "OIDC"] - } - }, - "oneOf": [ - { - "$ref": "#/components/schemas/FederationSamlIdentityProviderUpdate" - }, - { - "$ref": "#/components/schemas/FederationOidcWorkforceIdentityProviderUpdate" - }, - { - "$ref": "#/components/schemas/FederationOidcWorkloadIdentityProviderUpdate" - } - ] - }, - "FederationSamlIdentityProviderUpdate": { - "title": "SAML", - "required": ["ssoDebugEnabled"], - "type": "object", - "properties": { - "associatedDomains": { - "uniqueItems": true, - "type": "array", - "description": "List that contains the domains associated with the identity provider.", - "items": { - "type": "string" - } - }, - "description": { - "type": "string", - "description": "The description of the identity provider." - }, - "displayName": { - "maxLength": 50, - "minLength": 1, - "type": "string", - "description": "Human-readable label that identifies the identity provider." - }, - "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.", - "example": "urn:idp:default" - }, - "pemFileInfo": { - "$ref": "#/components/schemas/PemFileInfoUpdate" - }, - "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.", - "enum": ["HTTP-POST", "HTTP-REDIRECT"] - }, - "responseSignatureAlgorithm": { - "type": "string", - "description": "Signature algorithm that Federated Authentication uses to encrypt the identity provider signature.", - "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.", - "example": "https://example.com" - }, - "status": { - "type": "string", - "description": "String enum that indicates whether the identity provider is active.", - "enum": ["ACTIVE", "INACTIVE"] - } - } - }, - "PemFileInfoUpdate": { - "type": "object", - "properties": { - "certificates": { - "type": "array", - "description": "List of certificates in the file.", - "items": { - "$ref": "#/components/schemas/X509CertificateUpdate" - } - }, - "fileName": { - "type": "string", - "description": "Human-readable label given to the file." - } - }, - "description": "PEM file information for the identity provider's current certificates." - }, - "X509CertificateUpdate": { - "type": "object", - "properties": { - "content": { - "type": "string", - "description": "Certificate content." - }, - "notAfter": { - "type": "string", - "description": "Latest date that the certificate is valid.", - "format": "date-time" - }, - "notBefore": { - "type": "string", - "description": "Earliest date that the certificate is valid.", - "format": "date-time" - } - } - }, - "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 - } - } - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", - "type": "string", - "description": "Human-readable label that identifies the project included in the MongoDB Cloud organization." - }, - "orgId": { - "maxLength": 24, - "minLength": 24, - "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.\n\nIn Commercial Atlas, this field will be rejected in requests and missing in responses.\n\nThis field sets restrictions on available regions in the project.\n\n| Value | Available Regions |\n|-----------------------------------|------------|\n| `COMMERCIAL_FEDRAMP_REGIONS_ONLY` | Only allows deployments in FedRAMP Moderate regions.|\n| `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" - }, - "items": { - "$ref": "#/components/schemas/ResourceTag" - } - }, - "withDefaultAlertsSettings": { - "type": "boolean", - "description": "Flag that indicates whether to create the project with default alert settings.", - "writeOnly": 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`." - }, - "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 providers 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`.", - "format": "int32", - "readOnly": true - } - } - }, - "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", - "dataFederation.bytesProcessed.query": "#/components/schemas/DataFederationQueryLimit", - "dataFederation.bytesProcessed.daily": "#/components/schemas/DataFederationQueryLimit", - "dataFederation.bytesProcessed.weekly": "#/components/schemas/DataFederationQueryLimit", - "dataFederation.bytesProcessed.monthly": "#/components/schemas/DataFederationQueryLimit" - } - } - }, - "DataFederationQueryLimit": { - "title": "Data Federation 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"] - }, - "value": { - "type": "integer", - "description": "Amount to set the limit to.", - "format": "int64" - } - }, - "description": "Details of a query limit for Data Federation. Query limit is the limit on the amount of usage during a time period based on cost." - }, - "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." - }, - "isDataExplorerEnabled": { - "type": "boolean", - "description": "Flag that indicates whether to enable the Data Explorer for the specified project." - }, - "isExtendedStorageSizesEnabled": { - "type": "boolean", - "description": "Flag that indicates whether to enable extended storage sizes for the specified project." - }, - "isPerformanceAdvisorEnabled": { - "type": "boolean", - "description": "Flag that indicates whether to enable the Performance Advisor and Profiler for the specified project." - }, - "isRealtimePerformancePanelEnabled": { - "type": "boolean", - "description": "Flag that indicates whether to enable the Real Time Performance Panel for the specified project." - }, - "isSchemaAdvisorEnabled": { - "type": "boolean", - "description": "Flag that indicates whether to enable the Schema Advisor for the specified project." - } - }, - "description": "Collection of settings that configures the project." - }, - "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.\n\nOrganization Roles\n\n* ORG_OWNER\n* ORG_MEMBER\n* ORG_GROUP_CREATOR\n* ORG_BILLING_ADMIN\n* ORG_READ_ONLY\n\nProject Roles\n\n* GROUP_CLUSTER_MANAGER\n* GROUP_DATA_ACCESS_ADMIN\n* GROUP_DATA_ACCESS_READ_ONLY\n* GROUP_DATA_ACCESS_READ_WRITE\n* GROUP_OWNER\n* GROUP_READ_ONLY\n* GROUP_SEARCH_INDEX_EDITOR\n* GROUP_STREAM_PROCESSING_OWNER\n\n", - "enum": [ - "ORG_OWNER", - "ORG_MEMBER", - "ORG_GROUP_CREATOR", - "ORG_BILLING_ADMIN", - "ORG_READ_ONLY", - "GROUP_CLUSTER_MANAGER", - "GROUP_DATA_ACCESS_ADMIN", - "GROUP_DATA_ACCESS_READ_ONLY", - "GROUP_DATA_ACCESS_READ_WRITE", - "GROUP_OWNER", - "GROUP_READ_ONLY", - "GROUP_SEARCH_INDEX_EDITOR", - "GROUP_STREAM_PROCESSING_OWNER" - ] - } - }, - "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." - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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." - }, - "roles": { - "type": "array", - "description": "List of objects that display the MongoDB Cloud user's roles and the corresponding organization or project to which that role applies. A role can apply to one organization or one project but not both.", - "items": { - "$ref": "#/components/schemas/CloudAccessRoleAssignment" - } - }, - "teamIds": { - "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, - "items": { - "maxLength": 24, - "minLength": 24, - "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" - } - } - }, - "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 providers 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`.", - "format": "int32", - "readOnly": true - } - } - }, - "ClusterIPAddresses": { - "title": "Cluster IP Addresses", - "type": "object", - "properties": { - "clusterName": { - "type": "string", - "description": "Human-readable label that identifies the cluster.", - "readOnly": true - }, - "inbound": { - "type": "array", - "description": "List of inbound IP addresses associated with the cluster. If your network allows outbound HTTP requests only to specific IP addresses, you must allow access to the following IP addresses so that your application can connect to your Atlas cluster.", - "readOnly": true, - "items": { - "type": "string" - } - }, - "outbound": { - "type": "array", - "description": "List of outbound IP addresses associated with the cluster. If your network allows inbound HTTP requests only from specific IP addresses, you must allow access from the following IP addresses so that your Atlas cluster can communicate with your webhooks and KMS.", - "readOnly": true, - "items": { - "type": "string" - } - } - }, - "description": "List of IP addresses in a cluster." - }, - "GroupIPAddresses": { - "title": "Group IP Address", - "type": "object", - "properties": { - "groupId": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "services": { - "$ref": "#/components/schemas/GroupService" - } - }, - "description": "List of IP addresses in a project." - }, - "GroupService": { - "title": "Group Service IP Addresses", - "type": "object", - "properties": { - "clusters": { - "type": "array", - "description": "IP addresses of clusters.", - "readOnly": true, - "items": { - "$ref": "#/components/schemas/ClusterIPAddresses" - } - } - }, - "description": "List of IP addresses in a project categorized by services.", - "readOnly": true - }, - "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" - }, - "items": { - "$ref": "#/components/schemas/ResourceTag" - } - } - }, - "description": "Request view to update the group." - }, - "UpdateGroupRolesForUser": { - "type": "object", - "properties": { - "groupRoles": { - "uniqueItems": true, - "type": "array", - "description": "One or more project level roles to assign to the MongoDB Cloud user.", - "items": { - "type": "string", - "enum": [ - "GROUP_CLUSTER_MANAGER", - "GROUP_DATA_ACCESS_ADMIN", - "GROUP_DATA_ACCESS_READ_ONLY", - "GROUP_DATA_ACCESS_READ_WRITE", - "GROUP_OWNER", - "GROUP_READ_ONLY", - "GROUP_SEARCH_INDEX_EDITOR", - "GROUP_STREAM_PROCESSING_OWNER" - ] - } - }, - "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" - } - } - } - }, - "Datadog": { - "title": "DATADOG", - "required": ["apiKey"], - "type": "object", - "properties": { - "apiKey": { - "type": "string", - "description": "Key that allows MongoDB Cloud to access your Datadog account.\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": "****************************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.\n\nTo learn more about Datadog's regions, see Datadog Sites.", - "enum": ["US", "EU", "US3", "US5", "AP1"] - }, - "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.\n\n**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": { - "maxLength": 40, - "minLength": 40, - "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": { - "maxLength": 40, - "minLength": 40, - "pattern": "^([0-9a-f]){40}$", - "type": "string", - "description": "Unique 40-hexadecimal digit string that identifies your New Relic license.\n\n**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.\nTo 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.", - "example": "bc3768f44193c282b2688ab39e00f8e4fc8d75ea" - }, - "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.\n\n***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.\n\nTo 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.\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": "********************************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.\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": "****************************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 providers 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`.", - "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 - }, - "serviceDiscovery": { - "type": "string", - "description": "Desired method to discover the Prometheus service.", - "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.\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.\n\n**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.\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": "********************************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.\n\n**NOTE**: When you view or edit the alert for a webhook notification, the secret appears completely redacted.", - "example": "******" - }, - "url": { - "type": "string", - "description": "Endpoint web address to which MongoDB Cloud sends notifications.\n\n**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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal character string that identifies the project.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "groupName": { - "maxLength": 64, - "minLength": 1, - "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": { - "maxLength": 24, - "minLength": 24, - "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.", - "items": { - "type": "string", - "enum": [ - "GROUP_CLUSTER_MANAGER", - "GROUP_DATA_ACCESS_ADMIN", - "GROUP_DATA_ACCESS_READ_ONLY", - "GROUP_DATA_ACCESS_READ_WRITE", - "GROUP_OWNER", - "GROUP_READ_ONLY" - ] - } - }, - "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.", - "items": { - "type": "string", - "enum": [ - "GROUP_CLUSTER_MANAGER", - "GROUP_DATA_ACCESS_ADMIN", - "GROUP_DATA_ACCESS_READ_ONLY", - "GROUP_DATA_ACCESS_READ_WRITE", - "GROUP_OWNER", - "GROUP_READ_ONLY" - ] - } - }, - "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 organization or project level roles to assign to the MongoDB Cloud user.", - "items": { - "type": "string", - "enum": [ - "GROUP_CLUSTER_MANAGER", - "GROUP_DATA_ACCESS_ADMIN", - "GROUP_DATA_ACCESS_READ_ONLY", - "GROUP_DATA_ACCESS_READ_WRITE", - "GROUP_OWNER", - "GROUP_READ_ONLY" - ] - } - } - } - }, - "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 providers 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`.", - "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 organization- or project-level roles to assign to the MongoDB Cloud user.", - "items": { - "type": "string", - "enum": [ - "GROUP_CLUSTER_MANAGER", - "GROUP_DATA_ACCESS_ADMIN", - "GROUP_DATA_ACCESS_READ_ONLY", - "GROUP_DATA_ACCESS_READ_WRITE", - "GROUP_OWNER", - "GROUP_READ_ONLY" - ] - } - }, - "teamId": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal character string that identifies the team.", - "example": "32b6e34b3d91647abb20e7b8" - } - } - }, - "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.", - "items": { - "type": "string", - "enum": [ - "GROUP_CLUSTER_MANAGER", - "GROUP_DATA_ACCESS_ADMIN", - "GROUP_DATA_ACCESS_READ_ONLY", - "GROUP_DATA_ACCESS_READ_WRITE", - "GROUP_SEARCH_INDEX_EDITOR", - "GROUP_STREAM_PROCESSING_OWNER", - "GROUP_OWNER", - "GROUP_READ_ONLY" - ] - } - }, - "userId": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the organization API key.", - "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": { - "maxLength": 24, - "minLength": 24, - "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.", - "items": { - "$ref": "#/components/schemas/CloudAccessRoleAssignment" - } - } - }, - "description": "Details of the Programmatic API Keys." - }, - "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.", - "items": { - "type": "string", - "enum": [ - "ORG_OWNER", - "ORG_MEMBER", - "ORG_GROUP_CREATOR", - "ORG_BILLING_ADMIN", - "ORG_READ_ONLY", - "ORG_TEAM_MEMBERS_ADMIN", - "GROUP_ATLAS_ADMIN", - "GROUP_AUTOMATION_ADMIN", - "GROUP_BACKUP_ADMIN", - "GROUP_MONITORING_ADMIN", - "GROUP_OWNER", - "GROUP_READ_ONLY", - "GROUP_USER_ADMIN", - "GROUP_BILLING_ADMIN", - "GROUP_DATA_ACCESS_ADMIN", - "GROUP_DATA_ACCESS_READ_ONLY", - "GROUP_DATA_ACCESS_READ_WRITE", - "GROUP_CHARTS_ADMIN", - "GROUP_CLUSTER_MANAGER", - "GROUP_SEARCH_INDEX_EDITOR", - "GROUP_STREAM_PROCESSING_OWNER" - ] - } - } - } - }, - "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 providers 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`.", - "format": "int32", - "readOnly": true - } - } - }, - "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.", - "items": { - "type": "string", - "enum": [ - "ORG_OWNER", - "ORG_MEMBER", - "ORG_GROUP_CREATOR", - "ORG_BILLING_ADMIN", - "ORG_READ_ONLY", - "ORG_TEAM_MEMBERS_ADMIN", - "GROUP_ATLAS_ADMIN", - "GROUP_AUTOMATION_ADMIN", - "GROUP_BACKUP_ADMIN", - "GROUP_MONITORING_ADMIN", - "GROUP_OWNER", - "GROUP_READ_ONLY", - "GROUP_USER_ADMIN", - "GROUP_BILLING_ADMIN", - "GROUP_DATA_ACCESS_ADMIN", - "GROUP_DATA_ACCESS_READ_ONLY", - "GROUP_DATA_ACCESS_READ_WRITE", - "GROUP_CHARTS_ADMIN", - "GROUP_CLUSTER_MANAGER", - "GROUP_SEARCH_INDEX_EDITOR", - "GROUP_STREAM_PROCESSING_OWNER" - ] - } - } - } - }, - "GroupRole": { - "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.", - "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.\n\nProject Roles\n\n* GROUP_CLUSTER_MANAGER\n* GROUP_DATA_ACCESS_ADMIN\n* GROUP_DATA_ACCESS_READ_ONLY\n* GROUP_DATA_ACCESS_READ_WRITE\n* GROUP_OWNER\n* GROUP_READ_ONLY\n* GROUP_SEARCH_INDEX_EDITOR\n* GROUP_STREAM_PROCESSING_OWNER\n\n", - "enum": [ - "GROUP_CLUSTER_MANAGER", - "GROUP_DATA_ACCESS_ADMIN", - "GROUP_DATA_ACCESS_READ_ONLY", - "GROUP_DATA_ACCESS_READ_WRITE", - "GROUP_OWNER", - "GROUP_READ_ONLY", - "GROUP_SEARCH_INDEX_EDITOR", - "GROUP_STREAM_PROCESSING_OWNER" - ] - } - } - }, - "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.", - "items": { - "$ref": "#/components/schemas/GroupRole" - } - }, - "id": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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.", - "items": { - "type": "string", - "enum": [ - "ORG_OWNER", - "ORG_MEMBER", - "ORG_GROUP_CREATOR", - "ORG_BILLING_ADMIN", - "ORG_READ_ONLY", - "GROUP_CLUSTER_MANAGER", - "GROUP_DATA_ACCESS_ADMIN", - "GROUP_DATA_ACCESS_READ_ONLY", - "GROUP_DATA_ACCESS_READ_WRITE", - "GROUP_OWNER", - "GROUP_READ_ONLY" - ] - } - }, - "teamIds": { - "uniqueItems": true, - "type": "array", - "description": "List of unique 24-hexadecimal digit strings that identifies each team.", - "readOnly": true, - "items": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the team.", - "example": "32b6e34b3d91647abb20e7b8" - } - }, - "username": { - "type": "string", - "description": "Email address of the MongoDB Cloud user invited to join the organization.", - "format": "email" - } - } - }, - "GroupMigrationRequest": { - "type": "object", - "properties": { - "destinationOrgId": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the organization to move the specified project to.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "destinationOrgPrivateApiKey": { - "type": "string", - "description": "Unique string that identifies the private part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.", - "readOnly": true, - "example": "55c3bbb6-b4bb-0be1-e66d20841f3e" - }, - "destinationOrgPublicApiKey": { - "maxLength": 8, - "minLength": 8, - "type": "string", - "description": "Unique string that identifies the public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.", - "readOnly": true, - "example": "zmmrboas" - } - } - }, - "OrganizationInvitationGroupRoleAssignmentsRequest": { - "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 these roles belong.", - "example": "32b6e34b3d91647abb20e7b8" - }, - "roles": { - "uniqueItems": true, - "type": "array", - "description": "One or more project level roles to assign to the MongoDB Cloud user.", - "items": { - "type": "string", - "enum": [ - "GROUP_CLUSTER_MANAGER", - "GROUP_DATA_ACCESS_ADMIN", - "GROUP_DATA_ACCESS_READ_ONLY", - "GROUP_DATA_ACCESS_READ_WRITE", - "GROUP_OWNER", - "GROUP_READ_ONLY" - ] - } - } - } - }, - "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.", - "items": { - "$ref": "#/components/schemas/OrganizationInvitationGroupRoleAssignmentsRequest" - } - }, - "roles": { - "uniqueItems": true, - "type": "array", - "description": "One or more organization level roles to assign to the MongoDB Cloud user.", - "items": { - "type": "string", - "enum": ["ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY"] - } - }, - "teamIds": { - "uniqueItems": true, - "type": "array", - "description": "List of teams to which you want to invite the desired MongoDB Cloud user.", - "items": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the team.", - "example": "32b6e34b3d91647abb20e7b8" - } - }, - "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.", - "items": { - "$ref": "#/components/schemas/OrganizationInvitationGroupRoleAssignmentsRequest" - } - }, - "roles": { - "uniqueItems": true, - "type": "array", - "description": "One or more organization level roles to assign to the MongoDB Cloud user.", - "items": { - "type": "string", - "enum": ["ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY"] - } - }, - "teamIds": { - "uniqueItems": true, - "type": "array", - "description": "List of teams to which you want to invite the desired MongoDB Cloud user.", - "items": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the team.", - "example": "32b6e34b3d91647abb20e7b8" - } - } - } - }, - "ApiAtlasCheckpointView": { - "type": "object", - "properties": { - "clusterId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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.\n\n- For a replica set, this array contains a single document.\n- For a sharded cluster, this array contains one document for each shard plus one document for the config host.", - "readOnly": true, - "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 providers 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`.", - "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, - "items": { - "$ref": "#/components/schemas/DiskBackupExportMember" - } - }, - "createdAt": { - "type": "string", - "description": "Date and time when someone created this 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 to the bucket when the export job finishes.", - "items": { - "$ref": "#/components/schemas/BackupLabel" - } - }, - "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, - "items": { - "type": "string", - "description": "One Uniform Resource Locator that point to the compressed snapshot files for manual download." - } - }, - "exportBucketId": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal character string that identifies the Export Bucket to export to.", - "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": { - "maxLength": 24, - "minLength": 24, - "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": "Full path on the cloud provider bucket to the folder where the snapshot is exported.", - "readOnly": true - }, - "snapshotId": { - "maxLength": 24, - "minLength": 24, - "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, - "enum": ["Cancelled", "Failed", "InProgress", "Queued", "Successful"] - } - } - }, - "DiskBackupExportMember": { - "type": "object", - "properties": { - "exportId": { - "maxLength": 24, - "minLength": 24, - "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 for the collections on the replica set only." - }, - "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.", - "items": { - "$ref": "#/components/schemas/BackupLabel" - } - }, - "exportBucketId": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal character string that identifies the Export Bucket to export to.", - "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": { - "maxLength": 24, - "minLength": 24, - "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 providers 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`.", - "format": "int32", - "readOnly": true - } - } - }, - "DiskBackupRestoreMember": { - "type": "object", - "properties": { - "downloadUrl": { - "type": "string", - "description": "One Uniform Resource Locator that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", - "readOnly": true - }, - "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, - "items": { - "$ref": "#/components/schemas/DiskBackupRestoreMember" - } - }, - "deliveryType": { - "type": "string", - "description": "Human-readable label that categorizes the restore job to create.", - "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, - "items": { - "type": "string", - "description": "One Uniform Resource Locator that point 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": { - "maxLength": 24, - "minLength": 24, - "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" - }, - "snapshotId": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal character string that identifies the snapshot.", - "example": "32b6e34b3d91647abb20e7b8" - }, - "targetClusterName": { - "maxLength": 64, - "minLength": 1, - "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": { - "maxLength": 24, - "minLength": 24, - "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 providers 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`.", - "format": "int32", - "readOnly": true - } - } - }, - "DiskBackupShardedClusterSnapshot": { - "title": "Sharded Cluster Snapshot", - "type": "object", - "properties": { - "configServerType": { - "type": "string", - "description": "Human-readable label that identifies the config server type for this snapshot.", - "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, - "enum": ["hourly", "daily", "weekly", "monthly", "yearly"] - }, - "id": { - "maxLength": 24, - "minLength": 24, - "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 - }, - "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, - "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, - "items": { - "maxLength": 24, - "minLength": 24, - "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, - "items": { - "maxLength": 24, - "minLength": 24, - "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, - "enum": ["onDemand", "scheduled"] - }, - "status": { - "type": "string", - "description": "Human-readable label that indicates the stage of the backup process for this snapshot.", - "readOnly": true, - "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, - "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": { - "maxLength": 24, - "minLength": 24, - "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 - } - } - }, - "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 providers 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`.", - "format": "int32", - "readOnly": true - } - } - }, - "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, - "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, - "enum": ["hourly", "daily", "weekly", "monthly", "yearly"] - }, - "id": { - "maxLength": 24, - "minLength": 24, - "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 - }, - "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, - "items": { - "maxLength": 24, - "minLength": 24, - "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, - "enum": ["onDemand", "scheduled"] - }, - "status": { - "type": "string", - "description": "Human-readable label that indicates the stage of the backup process for this snapshot.", - "readOnly": true, - "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, - "enum": ["replicaSet", "shardedCluster"] - } - }, - "description": "Details of the replica set snapshot that MongoDB Cloud created." - }, - "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 providers 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`.", - "format": "int32", - "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, - "enum": ["hourly", "daily", "weekly", "monthly", "yearly"] - }, - "id": { - "maxLength": 24, - "minLength": 24, - "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 - }, - "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, - "items": { - "maxLength": 24, - "minLength": 24, - "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, - "enum": ["onDemand", "scheduled"] - }, - "status": { - "type": "string", - "description": "Human-readable label that indicates the stage of the backup process for this snapshot.", - "readOnly": true, - "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, - "enum": ["replicaSet", "shardedCluster"] - } - }, - "discriminator": { - "propertyName": "type", - "mapping": { - "replicaSet": "#/components/schemas/DiskBackupReplicaSet", - "shardedCluster": "#/components/schemas/DiskBackupShardedClusterSnapshot" - } - } - }, - "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 - } - } - }, - "BackupRestoreJob": { - "required": ["delivery"], - "type": "object", - "properties": { - "batchId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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.\n\n- If you set **checkpointId**, you can't set **oplogInc**, **oplogTs**, **snapshotId**, or **pointInTimeUTCMillis**.\n- 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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 64, - "minLength": 1, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "items": { - "$ref": "#/components/schemas/RestoreJobFileHash" - } - }, - "id": { - "maxLength": 24, - "minLength": 24, - "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 - }, - "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\"`.\n\n- If you set **oplogInc**, you must set **oplogTs**, and can't set **checkpointId**, **snapshotId**, or **pointInTimeUTCMillis**.\n- 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.\n\n- If you set **oplogTs**, you must set **oplogInc**, and you can't set **checkpointId**, **snapshotId**, or **pointInTimeUTCMillis**.\n- 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](https://en.wikipedia.org/wiki/Unix_time). This timestamp must fall within the last 24 hours of the current time. This parameter applies when `\"delivery.methodName\" : \"AUTOMATED_RESTORE\"`.\n\n- 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.\n- If you set **pointInTimeUTCMillis**, you can't set **oplogInc**, **oplogTs**, **snapshotId**, or **checkpointId**.", - "format": "int64", - "writeOnly": true - }, - "snapshotId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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\"`.\n\n If the target cluster doesn't have backup enabled, two resources return parameters with empty values:\n\n- **Get All Snapshots** endpoint returns an empty results array without **clusterId** elements\n- **Get a Snapshot** endpoint doesn't return a **clusterId** parameter.\n\nTo return a response with the **clusterId** parameter, either use the **delivery.targetClusterName** parameter or enable backup on the target cluster.", - "example": "32b6e34b3d91647abb20e7b8" - }, - "targetClusterName": { - "maxLength": 64, - "minLength": 1, - "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\"`.\n\nIf the target cluster doesn't have backup enabled, two resources return parameters with empty values:\n\n- **Get All Snapshots** endpoint returns an empty results array without **clusterId** elements\n- **Get a Snapshot** endpoint doesn't return a **clusterId** parameter.\n\nTo return a response with the **clusterId** parameter, either use the **delivery.targetClusterName** parameter or enable backup on the target cluster." - }, - "targetGroupId": { - "maxLength": 24, - "minLength": 24, - "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 - } - }, - "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 providers 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`.", - "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 - }, - "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.", - "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, - "items": { - "type": "string", - "description": "One Uniform Resource Locator that point 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": { - "maxLength": 24, - "minLength": 24, - "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" - }, - "snapshotId": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal character string that identifies the snapshot.", - "example": "32b6e34b3d91647abb20e7b8" - }, - "targetClusterName": { - "maxLength": 64, - "minLength": 1, - "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": { - "maxLength": 24, - "minLength": 24, - "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 providers 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`.", - "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, - "enum": ["hourly", "daily", "weekly", "monthly"] - }, - "id": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 64, - "minLength": 1, - "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, - "enum": ["onDemand", "scheduled"] - }, - "status": { - "type": "string", - "description": "Human-readable label that indicates the stage of the backup process for this snapshot.", - "readOnly": true, - "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 providers 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`.", - "format": "int32", - "readOnly": true - } - } - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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" - }, - "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.", - "format": "date-time" - }, - "groupId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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.\n\n- For a replica set, this array contains a single document.\n- For a sharded cluster, this array contains one document for each shard plus one document for the config host.", - "readOnly": true, - "items": { - "$ref": "#/components/schemas/BackupSnapshotPart" - } - } - } - }, - "BackupSnapshotPart": { - "title": "Snapshot Components", - "type": "object", - "properties": { - "clusterId": { - "maxLength": 24, - "minLength": 24, - "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" - }, - "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 - }, - "fileSizeBytes": { - "type": "integer", - "description": "Number that indicates the total size of the data files in bytes.", - "format": "int64", - "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 - }, - "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 - }, - "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 providers 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`.", - "format": "int32", - "readOnly": true - } - } - }, - "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", - "enum": [ - 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, - 40 - ] - }, - "frequencyType": { - "type": "string", - "description": "Human-readable label that identifies the frequency type associated with the backup policy.", - "enum": ["ondemand"] - }, - "id": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies this backup policy item.", - "readOnly": true - }, - "retentionUnit": { - "type": "string", - "description": "Unit of time in which MongoDB Cloud measures snapshot retention.", - "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.\n\nFor 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`.\n\n- 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.\n\n- 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.\n\n- In a weekly policy item, `1` indicates that the weekly Snapshot occurs on Monday and `7` indicates Sunday.\n\n- 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.\n\n MongoDB Cloud ignores this setting for non-hourly policy items in Backup Compliance Policy settings.", - "format": "int32", - "enum": [ - 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 40 - ] - }, - "frequencyType": { - "type": "string", - "description": "Human-readable label that identifies the frequency type associated with the backup policy.", - "enum": ["daily", "hourly", "weekly", "monthly", "yearly"] - }, - "id": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies this backup policy item.", - "readOnly": true - }, - "retentionUnit": { - "type": "string", - "description": "Unit of time in which MongoDB Cloud measures Snapshot retention.", - "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.\n\nFor 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." - }, - "DataProtectionSettings20231001": { - "required": ["authorizedEmail", "authorizedUserFirstName", "authorizedUserLastName"], - "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 updated the Backup Compliance Policy settings." - }, - "authorizedUserLastName": { - "type": "string", - "description": "Last name of the user who authorized to updated 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 - }, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the project for the Backup Compliance Policy.", - "example": "32b6e34b3d91647abb20e7b8" - }, - "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.", - "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 - } - } - }, - "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 - }, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the project for the Backup Compliance Policy.", - "example": "32b6e34b3d91647abb20e7b8" - }, - "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.", - "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 - } - } - }, - "DiskBackupSnapshotAWSExportBucket": { - "required": ["bucketName", "cloudProvider", "iamRoleId"], - "type": "object", - "properties": { - "_id": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal character string that identifies the Export Bucket.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "bucketName": { - "maxLength": 63, - "minLength": 3, - "type": "string", - "description": "Human-readable label that identifies the AWS S3 Bucket or Azure Storage Container 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 will be exported to.", - "enum": ["AWS", "AZURE"] - }, - "iamRoleId": { - "maxLength": 24, - "minLength": 24, - "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" - }, - "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" - } - } - } - }, - "DiskBackupSnapshotAzureExportBucket": { - "required": ["bucketName", "cloudProvider", "roleId", "serviceUrl", "tenantId"], - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/DiskBackupSnapshotExportBucket" - }, - { - "type": "object", - "properties": { - "roleId": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the Azure Service Principal that MongoDB Cloud uses to access the Azure Blob Storage Container.", - "example": "32b6e34b3d91647abb20e7b8" - }, - "serviceUrl": { - "maxLength": 55, - "minLength": 33, - "type": "string", - "description": "URL that identifies the blob Endpoint of the Azure Blob Storage Account.", - "example": "https://examplestorageaccount.blob.core.windows.net" - }, - "tenantId": { - "maxLength": 36, - "minLength": 36, - "pattern": "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$", - "type": "string", - "description": "UUID that identifies the Azure Active Directory Tenant ID.", - "example": "4297fc77-1592-4de8-a6d5-a8c32401df87" - } - } - } - ] - }, - "DiskBackupSnapshotExportBucket": { - "required": ["bucketName", "cloudProvider"], - "type": "object", - "properties": { - "_id": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal character string that identifies the Export Bucket.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "bucketName": { - "maxLength": 63, - "minLength": 3, - "type": "string", - "description": "Human-readable label that identifies the AWS S3 Bucket or Azure Storage Container 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 will be exported to.", - "enum": ["AWS", "AZURE"] - }, - "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": "Disk backup snapshot Export Bucket.", - "discriminator": { - "propertyName": "cloudProvider", - "mapping": { - "AWS": "#/components/schemas/DiskBackupSnapshotAWSExportBucket", - "AZURE": "#/components/schemas/DiskBackupSnapshotAzureExportBucket" - } - }, - "oneOf": [ - { - "$ref": "#/components/schemas/DiskBackupSnapshotAWSExportBucket" - }, - { - "$ref": "#/components/schemas/DiskBackupSnapshotAzureExportBucket" - } - ] - }, - "PaginatedBackupSnapshotExportBucketsView": { - "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 providers when completing this request.", - "readOnly": true, - "items": { - "$ref": "#/components/schemas/DiskBackupSnapshotExportBucket" - } - }, - "totalCount": { - "minimum": 0, - "type": "integer", - "description": "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", - "format": "int32", - "readOnly": true - } - } - }, - "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 providers when completing this request.", - "readOnly": true, - "items": { - "$ref": "#/components/schemas/DiskBackupSnapshotAWSExportBucket" - } - }, - "totalCount": { - "minimum": 0, - "type": "integer", - "description": "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", - "format": "int32", - "readOnly": true - } - } - }, - "AdvancedDiskBackupSnapshotSchedulePolicy": { - "type": "object", - "properties": { - "id": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies this backup policy." - }, - "policyItems": { - "type": "array", - "description": "List that contains the specifications for one policy.", - "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": { - "maxLength": 24, - "minLength": 24, - "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.", - "enum": ["monthly", "yearly"] - } - }, - "description": "Policy for automatically exporting Cloud Backup Snapshots." - }, - "DeleteCopiedBackups20240805": { - "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' which can be found under [Cloud Providers](https://www.mongodb.com/docs/atlas/reference/cloud-providers/) 'regions' link.", - "writeOnly": true - }, - "zoneId": { - "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 [Return One Cluster from One Project](#operation/getCluster).", - "writeOnly": true - } - }, - "description": "Deleted copy setting whose backup copies need to also be deleted.", - "writeOnly": true - }, - "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`.\n\n- 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.\n\n- 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.\n\n- In a weekly policy item, `1` indicates that the weekly Snapshot occurs on Monday and `7` indicates Sunday.\n\n- 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.\n\n MongoDB Cloud ignores this setting for non-hourly policy items in Backup Compliance Policy settings.", - "format": "int32", - "enum": [ - 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 40 - ] - }, - "frequencyType": { - "type": "string", - "description": "Human-readable label that identifies the frequency type associated with the backup policy.", - "enum": ["daily", "hourly", "weekly", "monthly", "yearly", "ondemand"] - }, - "id": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies this backup policy item.", - "readOnly": true - }, - "retentionUnit": { - "type": "string", - "description": "Unit of time in which MongoDB Cloud measures Snapshot retention.", - "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.\n\nFor 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." - }, - "DiskBackupCopySetting20240805": { - "required": ["zoneId"], - "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.", - "items": { - "type": "string", - "enum": ["HOURLY", "DAILY", "WEEKLY", "MONTHLY", "YEARLY", "ON_DEMAND"] - } - }, - "regionName": { - "type": "string", - "description": "Target region to copy snapshots belonging to zoneId. Please supply the 'Atlas Region' which can be found under [Cloud Providers](https://www.mongodb.com/docs/atlas/reference/cloud-providers/) 'regions' link." - }, - "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." - }, - "zoneId": { - "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 [Return One Cluster From One Project](#operation/getCluster)." - } - }, - "description": "Copy setting item in the desired backup policy." - }, - "DiskBackupSnapshotSchedule20240805": { - "type": "object", - "properties": { - "autoExportEnabled": { - "type": "boolean", - "description": "Flag that indicates whether MongoDB Cloud automatically exports Cloud Backup Snapshots to the Export Bucket." - }, - "clusterId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 64, - "minLength": 1, - "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.", - "items": { - "$ref": "#/components/schemas/DiskBackupCopySetting20240805" - } - }, - "deleteCopiedBackups": { - "type": "array", - "description": "List that contains a document for each deleted copy setting whose backup copies you want to delete.", - "writeOnly": true, - "items": { - "$ref": "#/components/schemas/DeleteCopiedBackups20240805" - } - }, - "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.", - "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." - }, - "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' which can be found under [Cloud Providers](https://www.mongodb.com/docs/atlas/reference/cloud-providers/) 'regions' link.", - "writeOnly": true - }, - "replicationSpecId": { - "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 in One Project and consult the replicationSpecs array [Return One Cluster in One Project](#operation/getLegacyCluster).", - "writeOnly": true - }, - "zoneId": { - "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 [Return One Cluster from One Project](#operation/getCluster).", - "writeOnly": true - } - }, - "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.", - "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' which can be found under [Cloud Providers](https://www.mongodb.com/docs/atlas/reference/cloud-providers/) 'regions' link." - }, - "replicationSpecId": { - "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 in One Project and consult the replicationSpecs array [Return One Cluster in One Project](#operation/getLegacyCluster)." - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 64, - "minLength": 1, - "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.", - "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, - "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.", - "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." - } - } - }, - "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 - }, - "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" - }, - "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, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the role.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "atlasAzureAppId": { - "maxLength": 36, - "minLength": 32, - "pattern": "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$", - "type": "string", - "description": "Azure Active Directory Application ID of Atlas." - }, - "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, - "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": { - "maxLength": 36, - "minLength": 32, - "pattern": "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$", - "type": "string", - "description": "UUID string that identifies the Azure Service Principal." - }, - "tenantId": { - "maxLength": 36, - "minLength": 32, - "pattern": "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$", - "type": "string", - "description": "UUID String that identifies the Azure Active Directory Tenant ID." - } - } - } - ] - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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." - }, - "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"] - } - }, - "description": "Cloud provider access role.", - "discriminator": { - "propertyName": "providerName", - "mapping": { - "AWS": "#/components/schemas/CloudProviderAccessAWSIAMRole", - "AZURE": "#/components/schemas/CloudProviderAccessAzureServicePrincipal" - } - }, - "oneOf": [ - { - "$ref": "#/components/schemas/CloudProviderAccessAWSIAMRole" - }, - { - "$ref": "#/components/schemas/CloudProviderAccessAzureServicePrincipal" - } - ] - }, - "CloudProviderAccessRoles": { - "type": "object", - "properties": { - "awsIamRoles": { - "type": "array", - "description": "List that contains the Amazon Web Services (AWS) IAM roles registered and authorized with MongoDB Cloud.", - "items": { - "$ref": "#/components/schemas/CloudProviderAccessAWSIAMRole" - } - } - } - }, - "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, - "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, - "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 providers 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`.", - "format": "int32", - "readOnly": true - } - } - }, - "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" - }, - "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." - }, - "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", - "GLOBAL" - ] - }, - "roleId": { - "maxLength": 24, - "minLength": 24, - "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", "AZURE_GERMANY"] - }, - "clientID": { - "type": "string", - "description": "Unique 36-hexadecimal character string that identifies an Azure application associated with your Azure Active Directory tenant.", - "format": "uuid" - }, - "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." - }, - "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." - }, - "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.", - "format": "uuid" - }, - "tenantID": { - "type": "string", - "description": "Unique 36-hexadecimal character string that identifies the Azure Active Directory tenant within your Azure subscription.", - "format": "uuid" - }, - "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" - }, - "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" - }, - "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/" - } - }, - "AzureKeyVaultEARPrivateEndpoint": { - "title": "Azure Key Vault EAR Private Endpoint", - "type": "object", - "properties": { - "cloudProvider": { - "type": "string", - "description": "Human-readable label that identifies the cloud provider for the Encryption At Rest private endpoint.", - "readOnly": true, - "enum": ["AZURE"] - }, - "errorMessage": { - "type": "string", - "description": "Error message for failures associated with the Encryption At Rest private endpoint.", - "readOnly": true - }, - "id": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "privateEndpointConnectionName": { - "type": "string", - "description": "Connection name of the Azure Private Endpoint.", - "readOnly": true - }, - "regionName": { - "type": "object", - "description": "Cloud provider region in which the Encryption At Rest private endpoint is located.", - "oneOf": [ - { - "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" - ] - } - ] - }, - "status": { - "type": "string", - "description": "State of the Encryption At Rest private endpoint.", - "readOnly": true, - "enum": ["INITIATING", "PENDING_ACCEPTANCE", "ACTIVE", "FAILED"] - } - }, - "description": "Azure Key Vault Encryption At Rest Private Endpoint." - }, - "EARPrivateEndpoint": { - "title": "Encryption At Rest Private Endpoint", - "type": "object", - "properties": { - "cloudProvider": { - "type": "string", - "description": "Human-readable label that identifies the cloud provider for the Encryption At Rest private endpoint.", - "readOnly": true, - "enum": ["AZURE"] - }, - "errorMessage": { - "type": "string", - "description": "Error message for failures associated with the Encryption At Rest private endpoint.", - "readOnly": true - }, - "id": { - "maxLength": 24, - "minLength": 24, - "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": "object", - "description": "Cloud provider region in which the Encryption At Rest private endpoint is located.", - "oneOf": [ - { - "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" - ] - } - ] - }, - "status": { - "type": "string", - "description": "State of the Encryption At Rest private endpoint.", - "readOnly": true, - "enum": ["INITIATING", "PENDING_ACCEPTANCE", "ACTIVE", "FAILED"] - } - }, - "description": "Encryption At Rest Private Endpoint.", - "oneOf": [ - { - "$ref": "#/components/schemas/AzureKeyVaultEARPrivateEndpoint" - } - ] - }, - "PaginatedApiAtlasEARPrivateEndpointView": { - "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 providers when completing this request.", - "readOnly": true, - "items": { - "$ref": "#/components/schemas/EARPrivateEndpoint" - } - }, - "totalCount": { - "minimum": 0, - "type": "integer", - "description": "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", - "format": "int32", - "readOnly": true - } - } - }, - "EncryptionAtRestPrivateEndpointRequest": { - "title": "Encryption At Rest Private Endpoints setup.", - "required": ["cloudProvider"], - "type": "object", - "properties": { - "cloudProvider": { - "type": "string", - "description": "Cloud service provider name.", - "enum": ["AZURE"] - }, - "regions": { - "uniqueItems": true, - "type": "array", - "description": "List of regions.", - "items": { - "type": "string" - } - } - }, - "description": "Create or delete private endpoints from the specified regions list." - }, - "TenantRestore": { - "required": ["snapshotId", "targetDeploymentItemName"], - "type": "object", - "properties": { - "clusterName": { - "maxLength": 64, - "minLength": 1, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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" - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 64, - "minLength": 1, - "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": { - "maxLength": 24, - "minLength": 24, - "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" - } - } - }, - "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 providers 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`.", - "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": { - "maxLength": 24, - "minLength": 24, - "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 - }, - "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 providers 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`.", - "format": "int32", - "readOnly": true - } - } - }, - "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", - "SINGAPORE_SGP" - ] - }, - "ApiAtlasDataLakeStorageView": { - "$ref": "#/components/schemas/DataLakeStorage" - }, - "AtlasDataFederationAzureRegion": { - "type": "string", - "description": "Atlas Data Federation Azure Regions.", - "enum": ["VIRGINIA_USA", "AMSTERDAM_NLD"] - }, - "BaseAtlasDataLakeRegion": { - "type": "object", - "description": "Name of the region to which the data lake routes client connections.", - "oneOf": [ - { - "$ref": "#/components/schemas/ApiAtlasDataLakeAWSRegionView" - }, - { - "$ref": "#/components/schemas/AtlasDataFederationAzureRegion" - } - ] - }, - "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": { - "type": "string", - "description": "Unique identifier of the role that Data Federation can use to access the data stores.Required if specifying cloudProviderConfig." - }, - "servicePrincipalId": { - "type": "string", - "description": "The ID of the Service Principal for which there is an access policyfor 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." - }, - "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 - }, - "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" - }, - "iamUserARN": { - "type": "string", - "description": "Amazon Resource Name (ARN) of the user that the data lake assumes when accessing data stores.", - "readOnly": true - }, - "roleId": { - "type": "string", - "description": "Unique identifier of the role that the data lake can use to access the data stores.Required if specifying cloudProviderConfig." - } - }, - "description": "Configuration for running Data Federation in AWS." - }, - "DataLakeCloudProviderConfig": { - "title": "Data Lake Cloud Provider", - "type": "object", - "properties": { - "aws": { - "$ref": "#/components/schemas/DataLakeAWSCloudProviderConfig" - }, - "azure": { - "$ref": "#/components/schemas/DataFederationAzureCloudProviderConfig" - } - }, - "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"] - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "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, - "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.", - "items": { - "$ref": "#/components/schemas/DataLakePipelinesPartitionField" - } - } - } - } - ] - }, - "DataLakeIngestionPipeline": { - "title": "Data Lake Pipeline", - "type": "object", - "properties": { - "_id": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the Data Lake Pipeline.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "createdDate": { - "type": "string", - "description": "Timestamp that indicates when the Data Lake Pipeline was created.", - "format": "date-time", - "readOnly": true - }, - "datasetRetentionPolicy": { - "$ref": "#/components/schemas/DatasetRetentionPolicy" - }, - "groupId": { - "maxLength": 24, - "minLength": 24, - "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.", - "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.", - "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.", - "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" - } - }, - "oneOf": [ - { - "$ref": "#/components/schemas/OnDemandCpsSnapshotSource" - }, - { - "$ref": "#/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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal character string that identifies the project.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "policyItemId": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal character string that identifies a policy item.", - "example": "32b6e34b3d91647abb20e7b8" - } - } - } - ] - }, - "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 providers 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`.", - "format": "int32", - "readOnly": true - } - } - }, - "IngestionPipelineRun": { - "title": "Data Lake Pipeline Run", - "type": "object", - "properties": { - "_id": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal character string that identifies a Data Lake Pipeline run.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "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.", - "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": { - "maxLength": 24, - "minLength": 24, - "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.", - "format": "date-time", - "readOnly": true - }, - "phase": { - "type": "string", - "description": "Processing phase of the Data Lake Pipeline.", - "readOnly": true, - "enum": ["SNAPSHOT", "EXPORT", "INGESTION"] - }, - "pipelineId": { - "maxLength": 24, - "minLength": 24, - "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.", - "format": "date-time", - "readOnly": true - }, - "snapshotId": { - "maxLength": 24, - "minLength": 24, - "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 providers 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`.", - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal character string that identifies the snapshot.", - "writeOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - } - } - }, - "BasicDBObject": { - "type": "object", - "additionalProperties": { - "type": "object" - } - }, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies this Atlas Search index.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "name": { - "type": "string", - "description": "Human-readable label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique." - }, - "status": { - "type": "string", - "description": "Condition of the search index when you made this request.\n\n| Status | Index Condition |\n |---|---|\n | IN_PROGRESS | Atlas is building or re-building the index after an edit. |\n | STEADY | You can use this search index. |\n | FAILED | Atlas could not build the index. |\n | MIGRATING | Atlas is upgrading the underlying cluster tier and migrating indexes. |\n | PAUSED | The cluster is paused. |\n", - "readOnly": true, - "enum": ["IN_PROGRESS", "STEADY", "FAILED", "MIGRATING", "STALE", "PAUSED"] - }, - "type": { - "type": "string", - "description": "Type of the index. Default type is search.", - "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:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\n 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" - }, - "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" - }, - "items": { - "$ref": "#/components/schemas/ApiAtlasFTSAnalyzersViewManual" - } - }, - "mappings": { - "$ref": "#/components/schemas/ApiAtlasFTSMappingsViewManual" - }, - "searchAnalyzer": { - "type": "string", - "description": "Method applied to identify words when searching this index.", - "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" - }, - "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.", - "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": "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": "Label that identifies the MongoDB collection that stores words and their applicable synonyms." - } - }, - "description": "Data set that stores words and their applicable synonyms." - }, - "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" - }, - "items": { - "$ref": "#/components/schemas/BasicDBObject" - } - } - } - } - ] - }, - "ApiSearchDeploymentResponseView": { - "type": "object", - "properties": { - "groupId": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal character string that identifies the project.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "id": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the search deployment.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "specs": { - "type": "array", - "description": "List of settings that configure the Search Nodes for your cluster.", - "readOnly": true, - "items": { - "$ref": "#/components/schemas/ApiSearchDeploymentSpecView" - } - }, - "stateName": { - "type": "string", - "description": "Human-readable label that indicates the current operating condition of this search deployment.", - "readOnly": true, - "enum": ["IDLE", "PAUSED", "UPDATING"] - } - } - }, - "ApiSearchDeploymentSpecView": { - "required": ["instanceSize", "nodeCount"], - "type": "object", - "properties": { - "instanceSize": { - "type": "string", - "description": "Hardware specification for the Search Node instance sizes.", - "enum": [ - "S20_HIGHCPU_NVME", - "S30_HIGHCPU_NVME", - "S40_HIGHCPU_NVME", - "S50_HIGHCPU_NVME", - "S60_HIGHCPU_NVME", - "S70_HIGHCPU_NVME", - "S80_HIGHCPU_NVME", - "S30_LOWCPU_NVME", - "S40_LOWCPU_NVME", - "S50_LOWCPU_NVME", - "S60_LOWCPU_NVME", - "S70_LOWCPU_NVME", - "S80_LOWCPU_NVME", - "S90_LOWCPU_NVME", - "S100_LOWCPU_NVME", - "S110_LOWCPU_NVME", - "S120_LOWCPU_NVME", - "S130_LOWCPU_NVME", - "S135_LOWCPU_NVME", - "S140_LOWCPU_NVME" - ] - }, - "nodeCount": { - "maximum": 32, - "minimum": 2, - "type": "integer", - "description": "Number of Search Nodes in the cluster.", - "format": "int32", - "example": 2 - } - } - }, - "ApiSearchDeploymentRequestView": { - "required": ["specs"], - "type": "object", - "properties": { - "specs": { - "maxItems": 1, - "minItems": 1, - "type": "array", - "description": "List of settings that configure the Search Nodes for your cluster.", - "items": { - "$ref": "#/components/schemas/ApiSearchDeploymentSpecView" - } - } - } - }, - "AtlasSearchAnalyzer": { - "title": "Atlas Search Analyzer", - "required": ["name", "tokenizer"], - "type": "object", - "properties": { - "charFilters": { - "type": "array", - "description": "Filters that examine text one character at a time and perform filtering operations.", - "items": { - "$ref": "#/components/schemas/BasicDBObject" - } - }, - "name": { - "type": "string", - "description": "Name that identifies the custom analyzer. Names must be unique within an index, and must not start with any of the following strings:\n- `lucene.`\n- `builtin.`\n- `mongodb.`" - }, - "tokenFilters": { - "type": "array", - "description": "Filter that performs operations such as:\n\n- Stemming, which reduces related words, such as \"talking\", \"talked\", and \"talks\" to their root word \"talk\".\n\n- Redaction, which is the removal of sensitive information from public documents.", - "items": { - "$ref": "#/components/schemas/BasicDBObject" - } - }, - "tokenizer": { - "type": "object", - "additionalProperties": { - "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." - }, - "description": "Tokenizer that you want to use to create tokens. Tokens determine how Atlas Search splits up text into discrete chunks for indexing." - } - } - }, - "SearchHostStatusDetail": { - "title": "Search Host Status Detail", - "type": "object", - "properties": { - "hostname": { - "type": "string", - "description": "Hostname that corresponds to the status detail." - }, - "mainIndex": { - "$ref": "#/components/schemas/SearchMainIndexStatusDetail" - }, - "queryable": { - "type": "boolean", - "description": "Flag that indicates whether the index is queryable on the host." - }, - "stagedIndex": { - "$ref": "#/components/schemas/SearchStagedIndexStatusDetail" - }, - "status": { - "type": "string", - "description": "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", - "enum": ["DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST"] - } - } - }, - "SearchIndexDefinition": { - "title": "Search Index Definition", - "type": "object", - "description": "The search index definition set by the user." - }, - "SearchIndexDefinitionVersion": { - "title": "Search Index Definition Version", - "type": "object", - "properties": { - "createdAt": { - "type": "string", - "description": "The time at which this index definition was created.", - "format": "date-time" - }, - "version": { - "type": "integer", - "description": "The version number associated with this index definition when it was created.", - "format": "int64" - } - }, - "description": "Object which includes the version number of the index definition and the time that the index definition was created." - }, - "SearchIndexResponse": { - "title": "Search Index Response", - "type": "object", - "properties": { - "collectionName": { - "type": "string", - "description": "Label that identifies the collection that contains one or more Atlas Search indexes." - }, - "database": { - "type": "string", - "description": "Label that identifies the database that contains the collection with one or more Atlas Search indexes." - }, - "indexID": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies this Atlas Search index.", - "example": "32b6e34b3d91647abb20e7b8" - }, - "latestDefinition": { - "$ref": "#/components/schemas/SearchIndexDefinition" - }, - "latestDefinitionVersion": { - "$ref": "#/components/schemas/SearchIndexDefinitionVersion" - }, - "name": { - "type": "string", - "description": "Label that identifies this index. Within each namespace, the names of all indexes must be unique." - }, - "queryable": { - "type": "boolean", - "description": "Flag that indicates whether the index is queryable on all hosts." - }, - "status": { - "type": "string", - "description": "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", - "enum": ["DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST"] - }, - "statusDetail": { - "type": "array", - "description": "List of documents detailing index status on each host.", - "items": { - "$ref": "#/components/schemas/SearchHostStatusDetail" - } - }, - "type": { - "type": "string", - "description": "Type of the index. The default type is search.", - "enum": ["search", "vectorSearch"] - } - }, - "discriminator": { - "propertyName": "type", - "mapping": { - "search": "#/components/schemas/TextSearchIndexResponse", - "vectorSearch": "#/components/schemas/VectorSearchIndexResponse" - } - } - }, - "SearchMainIndexStatusDetail": { - "title": "Search Main Index Status Detail", - "type": "object", - "properties": { - "definition": { - "$ref": "#/components/schemas/SearchIndexDefinition" - }, - "definitionVersion": { - "$ref": "#/components/schemas/SearchIndexDefinitionVersion" - }, - "message": { - "type": "string", - "description": "Optional message describing an error." - }, - "queryable": { - "type": "boolean", - "description": "Flag that indicates whether the index generation is queryable on the host." - }, - "status": { - "type": "string", - "description": "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", - "enum": ["DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST"] - } - }, - "description": "Contains status information about the active index." - }, - "SearchMappings": { - "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/field-mapping-definition-fts#static-and-dynamic-mappings" - } - }, - "fields": { - "type": "object", - "additionalProperties": { - "type": "object", - "description": "One or more field specifications for the Atlas Search index. Required if **mappings.dynamic** is omitted or set to **false**.", - "externalDocs": { - "description": "Atlas Search Index", - "url": "https://dochub.mongodb.org/core/index-definitions-fts" - }, - "x-additionalPropertiesName": "Field Name" - }, - "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" - }, - "x-additionalPropertiesName": "Field Name" - } - }, - "description": "Index specifications for the collection's fields." - }, - "SearchStagedIndexStatusDetail": { - "title": "Search Staged Index Status Detail", - "type": "object", - "properties": { - "definition": { - "$ref": "#/components/schemas/SearchIndexDefinition" - }, - "definitionVersion": { - "$ref": "#/components/schemas/SearchIndexDefinitionVersion" - }, - "message": { - "type": "string", - "description": "Optional message describing an error." - }, - "queryable": { - "type": "boolean", - "description": "Flag that indicates whether the index generation is queryable on the host." - }, - "status": { - "type": "string", - "description": "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", - "enum": ["DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST"] - } - }, - "description": "Contains status information about an index building in the background." - }, - "SynonymMappingStatusDetail": { - "title": "Synonym Mapping Status Detail", - "type": "object", - "properties": { - "message": { - "type": "string", - "description": "Optional message describing an error." - }, - "queryable": { - "type": "boolean", - "description": "Flag that indicates whether the synonym mapping is queryable on a host." - }, - "status": { - "type": "string", - "description": "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", - "enum": ["FAILED", "BUILDING", "READY"] - } - }, - "description": "Contains the status of the index's synonym mappings on each search host. This field (and its subfields) only appear if the index has synonyms defined." - }, - "SynonymMappingStatusDetailMap": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/SynonymMappingStatusDetail" - }, - "x-additionalPropertiesName": "Synonym Mapping Name" - }, - "TextSearchHostStatusDetail": { - "title": "Text Search Host Status Detail", - "type": "object", - "properties": { - "hostname": { - "type": "string", - "description": "Hostname that corresponds to the status detail." - }, - "mainIndex": { - "$ref": "#/components/schemas/TextSearchIndexStatusDetail" - }, - "queryable": { - "type": "boolean", - "description": "Flag that indicates whether the index is queryable on the host." - }, - "stagedIndex": { - "$ref": "#/components/schemas/TextSearchIndexStatusDetail" - }, - "status": { - "type": "string", - "description": "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", - "enum": ["DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST"] - } - } - }, - "TextSearchIndexDefinition": { - "title": "Text Search Index Definition", - "required": ["mappings"], - "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 making the following changes to the text in fields:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\n MongoDB Cloud uses the process you select to build the Atlas Search index.", - "externalDocs": { - "description": "Atlas Search Analyzers", - "url": "https://dochub.mongodb.org/core/analyzers--fts" - }, - "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" - }, - "items": { - "$ref": "#/components/schemas/AtlasSearchAnalyzer" - } - }, - "mappings": { - "$ref": "#/components/schemas/SearchMappings" - }, - "searchAnalyzer": { - "type": "string", - "description": "Method applied to identify words when searching this index.", - "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 Stored Source Fields.", - "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" - }, - "items": { - "$ref": "#/components/schemas/SearchSynonymMappingDefinition" - } - } - }, - "description": "The text search index definition set by the user." - }, - "TextSearchIndexResponse": { - "title": "Text Search Index Response", - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/SearchIndexResponse" - }, - { - "type": "object", - "properties": { - "latestDefinition": { - "$ref": "#/components/schemas/TextSearchIndexDefinition" - }, - "statusDetail": { - "type": "array", - "description": "List of documents detailing index status on each host.", - "items": { - "$ref": "#/components/schemas/TextSearchHostStatusDetail" - } - }, - "synonymMappingStatus": { - "type": "string", - "description": "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", - "enum": ["FAILED", "BUILDING", "READY"] - }, - "synonymMappingStatusDetail": { - "type": "array", - "description": "A list of documents describing the status of the index's synonym mappings on each search host. Only appears if the index has synonyms defined.", - "items": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/SynonymMappingStatusDetail" - } - } - } - } - } - ] - }, - "TextSearchIndexStatusDetail": { - "title": "Text Search Index Status Detail", - "type": "object", - "properties": { - "definition": { - "$ref": "#/components/schemas/TextSearchIndexDefinition" - }, - "definitionVersion": { - "$ref": "#/components/schemas/SearchIndexDefinitionVersion" - }, - "message": { - "type": "string", - "description": "Optional message describing an error." - }, - "queryable": { - "type": "boolean", - "description": "Flag that indicates whether the index generation is queryable on the host." - }, - "status": { - "type": "string", - "description": "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", - "enum": ["DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST"] - }, - "synonymMappingStatus": { - "type": "string", - "description": "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", - "enum": ["FAILED", "BUILDING", "READY"] - }, - "synonymMappingStatusDetail": { - "type": "array", - "description": "List of synonym statuses by mapping.", - "items": { - "$ref": "#/components/schemas/SynonymMappingStatusDetailMap" - } - } - }, - "description": "Contains status information about a text search index." - }, - "VectorSearchHostStatusDetail": { - "title": "Vector Search Host Status Detail", - "type": "object", - "properties": { - "hostname": { - "type": "string", - "description": "Hostname that corresponds to the status detail." - }, - "mainIndex": { - "$ref": "#/components/schemas/VectorSearchIndexStatusDetail" - }, - "queryable": { - "type": "boolean", - "description": "Flag that indicates whether the index is queryable on the host." - }, - "stagedIndex": { - "$ref": "#/components/schemas/VectorSearchIndexStatusDetail" - }, - "status": { - "type": "string", - "description": "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", - "enum": ["DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST"] - } - } - }, - "VectorSearchIndexDefinition": { - "title": "Vector Search Index Definition", - "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" - }, - "items": { - "$ref": "#/components/schemas/BasicDBObject" - } - } - }, - "description": "The vector search index definition set by the user." - }, - "VectorSearchIndexResponse": { - "title": "Vector Search Index Response", - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/SearchIndexResponse" - }, - { - "type": "object", - "properties": { - "latestDefinition": { - "$ref": "#/components/schemas/VectorSearchIndexDefinition" - }, - "statusDetail": { - "type": "array", - "description": "List of documents detailing index status on each host.", - "items": { - "$ref": "#/components/schemas/VectorSearchHostStatusDetail" - } - } - } - } - ] - }, - "VectorSearchIndexStatusDetail": { - "title": "Vector Search Index Status Detail", - "type": "object", - "properties": { - "definition": { - "$ref": "#/components/schemas/VectorSearchIndexDefinition" - }, - "definitionVersion": { - "$ref": "#/components/schemas/SearchIndexDefinitionVersion" - }, - "message": { - "type": "string", - "description": "Optional message describing an error." - }, - "queryable": { - "type": "boolean", - "description": "Flag that indicates whether the index generation is queryable on the host." - }, - "status": { - "type": "string", - "description": "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", - "enum": ["DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST"] - } - }, - "description": "Contains status information about a vector search index." - }, - "SearchIndexCreateRequest": { - "required": ["collectionName", "database", "name"], - "type": "object", - "properties": { - "collectionName": { - "type": "string", - "description": "Label that identifies the collection to create an Atlas Search index in." - }, - "database": { - "type": "string", - "description": "Label that identifies the database that contains the collection to create an Atlas Search index in." - }, - "name": { - "type": "string", - "description": "Label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique." - }, - "type": { - "type": "string", - "description": "Type of the index. The default type is search.", - "enum": ["search", "vectorSearch"] - } - }, - "discriminator": { - "propertyName": "type", - "mapping": { - "search": "#/components/schemas/TextSearchIndexCreateRequest", - "vectorSearch": "#/components/schemas/VectorSearchIndexCreateRequest" - } - } - }, - "TextSearchIndexCreateRequest": { - "required": ["collectionName", "database", "definition", "name"], - "type": "object", - "description": "Text Search Index Create Request", - "allOf": [ - { - "$ref": "#/components/schemas/SearchIndexCreateRequest" - }, - { - "type": "object", - "properties": { - "definition": { - "$ref": "#/components/schemas/TextSearchIndexDefinition" - } - } - } - ] - }, - "VectorSearchIndexCreateRequest": { - "required": ["collectionName", "database", "definition", "name"], - "type": "object", - "description": "Vector Search Index Create Request", - "allOf": [ - { - "$ref": "#/components/schemas/SearchIndexCreateRequest" - }, - { - "type": "object", - "properties": { - "definition": { - "$ref": "#/components/schemas/VectorSearchIndexDefinition" - } - } - } - ] - }, - "ApiError": { - "type": "object", - "properties": { - "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", - "externalDocs": { - "url": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status" - } - }, - "errorCode": { - "type": "string", - "description": "Application error code returned with this error." - }, - "parameters": { - "type": "array", - "description": "Parameters used to give more information about the error.", - "items": { - "type": "object" - } - }, - "reason": { - "type": "string", - "description": "Application error message returned with this error." - } - } - }, - "SearchIndexUpdateRequest": { - "title": "Search Index Update Request", - "required": ["definition"], - "type": "object", - "properties": { - "definition": { - "type": "object", - "description": "The index definition to update the search index to.", - "oneOf": [ - { - "$ref": "#/components/schemas/TextSearchIndexDefinition" - }, - { - "$ref": "#/components/schemas/VectorSearchIndexDefinition" - } - ] - } - } - }, - "Collation": { - "required": ["locale"], - "type": "object", - "properties": { - "alternate": { - "type": "string", - "description": "Method to handle whitespace and punctuation as base characters for purposes of comparison.\n\n| Value | Evaluate Whitespace and Punctuation as Base Characters |\n|---|---|\n| `\"non-ignorable\"` | Yes |\n| `\"shifted\"` | No. MongoDB Cloud distinguishes these characters when `\"strength\" > 3`. |\n", - "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.\n\n| Value | String Comparison Method |\n |---|---|\n| `true` | Compare from back to front. |\n| `false` | Compare from front to back. |\n", - "default": false - }, - "caseFirst": { - "type": "string", - "description": "Method to handle sort order of case differences during tertiary level comparisons.\n\n| Value | Sort Order Method |\n |---|---|\n | `\"upper\"` | Uppercase sorts before lowercase. |\n | `\"lower\"` | Lowercase sorts before uppercase. |\n | `\"off\"` | Similar to \"lower\" with slight differences. |\n", - "default": "off", - "enum": ["lower", "off", "upper"] - }, - "caseLevel": { - "type": "boolean", - "description": "Flag that indicates whether to include case comparison when `\"strength\" : 1` or `\"strength\" : 2`.\n\n| Value | Compare case at level 1 or 2? | Strength Level | Comparisons Include |\n |---|---|---|---|\n | true | Yes | 1 | Base characters and case. |\n | | | 2 | Base characters, diacritics (and possible other secondary differences), and case. |\n | false | No | | |\n", - "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\"`.", - "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\"`. This has no affect if `\"alternate\" : \"non-ignorable\"`.\n\n| Value | Ignore |\n |---|---|\n| `\"punct\"` | Both whitespace and punctuation |\n| `\"space\"` | Whitespace |\n", - "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.\n\n| Value | Normalization Method |\n |---|---|\n| `true` | Yes, check if fully normalized and perform normalization to compare text. |\n| `false` | No, don't check. |\n", - "default": false - }, - "numericOrdering": { - "type": "boolean", - "description": "Flag that indicates whether to compare sequences of digits as numbers or as strings.\n\n| Value | Comparison Method |\n |---|---|\n| `true` | Compare as numbers. This results in `10 > 2`. |\n| `false` | Compare as strings. This results in `\"10\" < \"2\"`. |\n", - "default": false - }, - "strength": { - "maximum": 5, - "minimum": 1, - "type": "integer", - "description": "Degree of comparison to perform when sorting words. MongoDB Cloud accepts the following values:\n\n| Value | Comparison Level | Comparison Method |\n|---|---|---|\n| 1 | Primary | Compares the base characters only, ignoring other differences such as diacritics and case. |\n| 2 | Secondary | Compares base characters (primary) and diacritics (secondary). Primary differences take precedence over secondary differences. |\n| 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. |\n| 4 | Quaternary | Compares for the specific use case to consider punctuation when levels 1 through 3 ignore punctuation or for processing Japanese text. |\n| 5 | Identical | Compares for the specific use case of tie breaker. |\n", - "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, - "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", - "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.\n\nMongoDB 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:\n1 or true to include the field and recursively all fields it is a prefix of in the index\n0 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:\n1 or true to include the field and recursively all fields it is a prefix of in the index\n0 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.", - "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.", - "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:\n\n- equality (`\"parameter\" : \"value\"` or using the `$eq` operator)\n- `\"$exists\": true`\n, maximum: `$gt`, `$gte`, `$lt`, `$lte` comparisons\n- `$type`\n- `$and` (top-level only)\n 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:\n\n- equality (`\"parameter\" : \"value\"` or using the `$eq` operator)\n- `\"$exists\": true`\n, maximum: `$gt`, `$gte`, `$lt`, `$lte` comparisons\n- `$type`\n- `$and` (top-level only)\n 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`.\n\nCompound 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:\n\n- equality (`\"parameter\" : \"value\"` or using the `$eq` operator)\n- `\"$exists\": true`\n, maximum: `$gt`, `$gte`, `$lt`, `$lte` comparisons\n- `$type`\n- `$and` (top-level only)\n 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:\n\n- equality (`\"parameter\" : \"value\"` or using the `$eq` operator)\n- `\"$exists\": true`\n, maximum: `$gt`, `$gte`, `$lt`, `$lte` comparisons\n- `$type`\n- `$and` (top-level only)\n 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." - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "items": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the index.", - "example": "32b6e34b3d91647abb20e7b8" - } - }, - "indexStatsMeasurements": { - "type": "array", - "description": "List that contains the Atlas Search index stats measurements.", - "readOnly": true, - "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, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "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, - "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, - "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, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "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, - "items": { - "$ref": "#/components/schemas/MetricsMeasurement" - } - } - } - }, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal character string that identifies the project.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "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, - "items": { - "$ref": "#/components/schemas/MongoDBAccessLogs" - } - } - } - }, - "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, - "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, - "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 - }, - "namespace": { - "type": "string", - "description": "Human-readable label that identifies the namespace on the specified host. The resource expresses this parameter value as `.`.", - "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, - "items": { - "$ref": "#/components/schemas/PerformanceAdvisorSlowQuery" - } - } - } - }, - "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, - "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 - } - }, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies this index.", - "readOnly": true - }, - "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, - "items": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "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, - "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](https://en.wikipedia.org/wiki/Unix_time). This parameter relates to the **since** query parameter.", - "format": "int64", - "readOnly": true - } - }, - "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, - "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 - } - }, - "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, - "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, - "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": { - "maxLength": 24, - "minLength": 24, - "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 - }, - "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, - "items": { - "$ref": "#/components/schemas/PerformanceAdvisorOperationView" - } - } - } - }, - "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 providers 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`.", - "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 providers 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`.", - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "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, - "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": { - "maxLength": 24, - "minLength": 24, - "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 providers 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`.", - "format": "int32", - "readOnly": true - } - } - }, - "MeasurementsCollStatsLatencyCluster": { - "type": "object", - "properties": { - "clusterId": { - "type": "string", - "description": "Unique identifier for Clusters.", - "readOnly": true - }, - "clusterView": { - "type": "string", - "description": "Cluster topology view.", - "readOnly": true - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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" - }, - "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" - } - }, - "measurements": { - "type": "array", - "description": "List that contains measurements and their data points.", - "readOnly": true, - "items": { - "$ref": "#/components/schemas/MetricsMeasurement" - } - }, - "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 - } - } - }, - "CollStatsRankedNamespacesView": { - "type": "object", - "properties": { - "groupId": { - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the request project.", - "readOnly": true - }, - "identifierId": { - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the request process.", - "readOnly": true - }, - "rankedNamespaces": { - "type": "array", - "description": "Ordered list of the hottest namespaces, highest value first.", - "readOnly": true, - "items": { - "type": "string", - "description": "A single namespace.", - "readOnly": true - } - } - } - }, - "PinnedNamespaces": { - "type": "object", - "properties": { - "clusterId": { - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the request cluster.", - "readOnly": true - }, - "groupId": { - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the request project.", - "readOnly": true - }, - "pinnedNamespaces": { - "type": "array", - "description": "List of all pinned namespaces.", - "readOnly": true, - "items": { - "type": "string", - "description": "A single pinned namespace.", - "readOnly": true - } - } - }, - "description": "Pinned namespaces view for cluster" - }, - "NamespacesRequest": { - "type": "object", - "properties": { - "namespaces": { - "uniqueItems": true, - "type": "array", - "description": "List of namespace strings (combination of database and collection) on the specified host or cluster.", - "writeOnly": true, - "items": { - "type": "string", - "description": "Human-readable label that identifies the namespace on the specified host or cluster. The resource expresses this parameter value as `.`.", - "writeOnly": true - } - } - } - }, - "MeasurementsCollStatsLatencyHost": { - "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": { - "maxLength": 24, - "minLength": 24, - "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" - }, - "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" - } - }, - "measurements": { - "type": "array", - "description": "List that contains measurements and their data points.", - "readOnly": true, - "items": { - "$ref": "#/components/schemas/MetricsMeasurement" - } - }, - "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 - } - } - }, - "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" - ] - } - } - } - ] - }, - "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"] - } - } - } - ] - }, - "BackupOnlineArchive": { - "type": "object", - "properties": { - "_id": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the online archive.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "clusterName": { - "maxLength": 64, - "minLength": 1, - "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.\n\nIf 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": { - "maxLength": 24, - "minLength": 24, - "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, - "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.\n\n| State | Indication |\n|-------------|------------|\n| `PENDING` | MongoDB Cloud has queued documents for archive. Archiving hasn't started. |\n| `ARCHIVING` | MongoDB Cloud started archiving documents that meet the archival criteria. |\n| `IDLE` | MongoDB Cloud waits to start the next archival job. |\n| `PAUSING` | Someone chose to stop archiving. MongoDB Cloud finishes the running archival job then changes the state to `PAUSED` when that job completes. |\n| `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. |\n| `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. |\n| `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, - "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.\n**DATE** selects documents to archive based on a date.\n**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.\n\nUse 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.\n**\"criteria.type\": \"DATE\"** selects documents to archive based on a date.\n**\"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"] - } - }, - "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" - } - } - }, - "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 or Epoch timestamps. The Epoch timestamp can be expressed as nanoseconds, milliseconds, or seconds. Set this parameter when **\"criteria.type\" : \"DATE\"**.\nYou must set **\"criteria.type\" : \"DATE\"** if **\"collectionType\": \"TIMESERIES\"**.", - "default": "ISODATE", - "enum": ["ISODATE", "EPOCH_SECONDS", "EPOCH_MILLIS", "EPOCH_NANOSECONDS"] - }, - "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" - } - ] - }, - "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](http://bsonspec.org/spec.html) must be of binary subtype 4. MongoDB Cloud skips partition parameters of type UUID with subtype 3.", - "readOnly": true, - "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" - ] - } - } - } - ] - }, - "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"] - } - } - } - ] - }, - "BackupOnlineArchiveCreate": { - "required": ["collName", "criteria", "dbName"], - "type": "object", - "properties": { - "_id": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the online archive.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "clusterName": { - "maxLength": 64, - "minLength": 1, - "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.\n\nIf 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": { - "maxLength": 24, - "minLength": 24, - "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, - "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.\n\n| State | Indication |\n|-------------|------------|\n| `PENDING` | MongoDB Cloud has queued documents for archive. Archiving hasn't started. |\n| `ARCHIVING` | MongoDB Cloud started archiving documents that meet the archival criteria. |\n| `IDLE` | MongoDB Cloud waits to start the next archival job. |\n| `PAUSING` | Someone chose to stop archiving. MongoDB Cloud finishes the running archival job then changes the state to `PAUSED` when that job completes. |\n| `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. |\n| `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. |\n| `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, - "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** may be selected only if **AZURE** is the Cloud service provider for the cluster and no **AWS** online archive has been created for the cluster.", - "enum": ["AWS", "AZURE"] - } - }, - "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" - } - } - }, - "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 providers 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`.", - "format": "int32", - "readOnly": true - } - } - }, - "ControlPlaneIPAddresses": { - "title": "Control Plane IP Addresses", - "type": "object", - "properties": { - "inbound": { - "$ref": "#/components/schemas/InboundControlPlaneCloudProviderIPAddresses" - }, - "outbound": { - "$ref": "#/components/schemas/OutboundControlPlaneCloudProviderIPAddresses" - } - }, - "description": "List of IP addresses in the Atlas control plane." - }, - "InboundControlPlaneCloudProviderIPAddresses": { - "title": "Inbound Control Plane IP Addresses By Cloud Provider", - "type": "object", - "properties": { - "aws": { - "type": "object", - "additionalProperties": { - "type": "array", - "description": "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", - "readOnly": true, - "items": { - "type": "string", - "description": "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", - "readOnly": true - } - }, - "description": "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", - "readOnly": true - }, - "azure": { - "type": "object", - "additionalProperties": { - "type": "array", - "description": "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", - "readOnly": true, - "items": { - "type": "string", - "description": "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", - "readOnly": true - } - }, - "description": "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", - "readOnly": true - }, - "gcp": { - "type": "object", - "additionalProperties": { - "type": "array", - "description": "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", - "readOnly": true, - "items": { - "type": "string", - "description": "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", - "readOnly": true - } - }, - "description": "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", - "readOnly": true - } - }, - "description": "List of inbound IP addresses to the Atlas control plane, categorized by cloud provider. If your application allows outbound HTTP requests only to specific IP addresses, you must allow access to the following IP addresses so that your API requests can reach the Atlas control plane.", - "readOnly": true - }, - "OutboundControlPlaneCloudProviderIPAddresses": { - "title": "Outbound Control Plane IP Addresses By Cloud Provider", - "type": "object", - "properties": { - "aws": { - "type": "object", - "additionalProperties": { - "type": "array", - "description": "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", - "readOnly": true, - "items": { - "type": "string", - "description": "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", - "readOnly": true - } - }, - "description": "Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.", - "readOnly": true - }, - "azure": { - "type": "object", - "additionalProperties": { - "type": "array", - "description": "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", - "readOnly": true, - "items": { - "type": "string", - "description": "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", - "readOnly": true - } - }, - "description": "Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.", - "readOnly": true - }, - "gcp": { - "type": "object", - "additionalProperties": { - "type": "array", - "description": "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", - "readOnly": true, - "items": { - "type": "string", - "description": "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", - "readOnly": true - } - }, - "description": "Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.", - "readOnly": true - } - }, - "description": "List of outbound IP addresses from the Atlas control plane, categorized by cloud provider. If your network allows inbound HTTP requests only from specific IP addresses, you must allow access from the following IP addresses so that Atlas can communicate with your webhooks and KMS.", - "readOnly": true - }, - "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).\nWhen `\"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-" - } - } - } - }, - "BaseCloudProviderInstanceSize": { - "type": "object", - "description": "Minimum instance size to which your cluster can automatically scale. MongoDB Cloud requires this parameter if `\"replicationSpecs[n].regionConfigs[m].autoScaling.compute.scaleDownEnabled\" : true`.", - "oneOf": [ - { - "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" - ] - } - ] - }, - "MdbAvailableVersion": { - "type": "object", - "properties": { - "cloudProvider": { - "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"] - }, - "defaultStatus": { - "type": "string", - "description": "Whether the version is the current default for the Instance Size and Cloud Provider.", - "enum": ["DEFAULT", "NOT_DEFAULT"] - }, - "instanceSize": { - "$ref": "#/components/schemas/BaseCloudProviderInstanceSize" - }, - "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" - } - }, - "version": { - "type": "string", - "description": "The MongoDB Major Version in question.", - "externalDocs": { - "description": "MongoDB Versioning", - "url": "https://www.mongodb.com/docs/manual/reference/versioning/" - } - } - } - }, - "PaginatedAvailableVersionView": { - "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 providers when completing this request.", - "readOnly": true, - "items": { - "$ref": "#/components/schemas/MdbAvailableVersion" - } - }, - "totalCount": { - "minimum": 0, - "type": "integer", - "description": "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", - "format": "int32", - "readOnly": true - } - } - }, - "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.\n\nThese 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.\n\nTo modify the CIDR block, the target project cannot have:\n\n- Any M10 or greater clusters\n- Any other VPC peering connections\n\n 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.\n\n **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", - "GLOBAL", - "US_GOV_WEST_1", - "US_GOV_EAST_1" - ] - }, - "vpcId": { - "minLength": 5, - "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.\n\nThese 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.\n\nTo modify the CIDR block, the target project cannot have:\n\n- Any M10 or greater clusters\n- Any other VPC peering connections\n\n 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.\n\n **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_CENTRAL", - "GERMANY_NORTH_EAST", - "GERMANY_WEST_CENTRAL", - "GERMANY_NORTH", - "SWITZERLAND_NORTH", - "SWITZERLAND_WEST", - "SWEDEN_CENTRAL", - "SWEDEN_SOUTH", - "UK_SOUTH", - "UK_WEST", - "INDIA_CENTRAL", - "INDIA_WEST", - "INDIA_SOUTH", - "CHINA_EAST", - "CHINA_NORTH", - "ASIA_EAST", - "JAPAN_EAST", - "JAPAN_WEST", - "ASIA_SOUTH_EAST", - "KOREA_CENTRAL", - "KOREA_SOUTH", - "FRANCE_CENTRAL", - "FRANCE_SOUTH", - "SOUTH_AFRICA_NORTH", - "SOUTH_AFRICA_WEST", - "NORWAY_EAST", - "NORWAY_WEST", - "UAE_CENTRAL", - "QATAR_CENTRAL", - "POLAND_CENTRAL", - "ISRAEL_CENTRAL", - "ITALY_NORTH" - ] - }, - "vnetName": { - "maxLength": 38, - "minLength": 38, - "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": { - "maxLength": 24, - "minLength": 24, - "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.\n\nThese CIDR blocks must fall within the ranges reserved per RFC 1918. GCP further limits the block to a lower bound of the `/18` range.\n\nTo modify the CIDR block, the target project cannot have:\n\n- Any M10 or greater clusters\n- Any other VPC peering connections\n\n 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.\n\n **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": { - "maxLength": 26, - "minLength": 26, - "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": { - "maxLength": 36, - "minLength": 36, - "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.", - "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.", - "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" - ] - } - } - } - } - ] - }, - "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 providers 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`.", - "format": "int32", - "readOnly": true - } - }, - "description": "List of Network Peering Containers that Amazon Web Services serves." - }, - "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" - } - } - } - }, - "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.\n\n| Type | Description |\n|------------|-------------|\n| `REGION` | Simulates a cluster outage for a region.|", - "enum": ["REGION"] - } - } - }, - "ClusterOutageSimulation": { - "type": "object", - "properties": { - "clusterName": { - "maxLength": 64, - "minLength": 1, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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.", - "items": { - "$ref": "#/components/schemas/AtlasClusterOutageSimulationOutageFilter" - } - }, - "startRequestDate": { - "type": "string", - "description": "Date and time when MongoDB Cloud started the regional outage simulation.", - "format": "date-time", - "readOnly": true, - "example": "2022-01-01T00:00:00Z" - }, - "state": { - "type": "string", - "description": "Phase of the outage simulation.\n\n| State | Indication |\n|-------------|------------|\n| `START_REQUESTED` | User has requested cluster outage simulation.|\n| `STARTING` | MongoDB Cloud is starting cluster outage simulation.|\n| `SIMULATING` | MongoDB Cloud is simulating cluster outage.|\n| `RECOVERY_REQUESTED` | User has requested recovery from the simulated outage.|\n| `RECOVERING` | MongoDB Cloud is recovering the cluster from the simulated outage.|\n| `COMPLETE` | MongoDB Cloud has completed the cluster outage simulation.|", - "readOnly": true, - "enum": ["START_REQUESTED", "STARTING", "SIMULATING", "RECOVERY_REQUESTED", "RECOVERING", "COMPLETE"] - } - } - }, - "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", - "CREATE_COLLECTION", - "CREATE_INDEX", - "DROP_COLLECTION", - "ENABLE_PROFILER", - "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", - "STORAGE_GET_CONFIG", - "STORAGE_SET_CONFIG", - "FLUSH_ROUTER_CONFIG", - "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.", - "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.", - "items": { - "$ref": "#/components/schemas/DatabasePrivilegeAction" - } - }, - "inheritedRoles": { - "uniqueItems": true, - "type": "array", - "description": "List of the built-in roles that this custom role inherits.", - "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.", - "items": { - "$ref": "#/components/schemas/DatabasePrivilegeAction" - } - }, - "inheritedRoles": { - "uniqueItems": true, - "type": "array", - "description": "List of the built-in roles that this custom role inherits.", - "items": { - "$ref": "#/components/schemas/DatabaseInheritedRole" - } - } - } - }, - "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.", - "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`.", - "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" - }, - "groupId": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the project.", - "writeOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "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.", - "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.", - "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.", - "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:\n\n| Authentication Method | Parameter Needed | Parameter Value | username Format |\n|---|---|---|---|\n| AWS IAM | awsIAMType | ROLE | ARN |\n| AWS IAM | awsIAMType | USER | ARN |\n| x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | USER | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| LDAP | ldapAuthType | GROUP | [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name |\n| OIDC Workforce | oidcAuthType | IDP_GROUP | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name |\n| OIDC Workload | oidcAuthType | USER | Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name |\n| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Alphanumeric string |\n" - }, - "x509Type": { - "type": "string", - "description": "X.509 method that MongoDB Cloud uses to authenticate the database user.\n\n- For application-managed X.509, specify `MANAGED`.\n- For self-managed X.509, specify `CUSTOMER`.\n\nUsers created with the `CUSTOMER` method require a Common Name (CN) in the **username** parameter. You must create externally authenticated users on the `$external` database.", - "default": "NONE", - "enum": ["NONE", "CUSTOMER", "MANAGED"] - } - } - }, - "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." - }, - "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.", - "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": { - "maxLength": 64, - "minLength": 1, - "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 - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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](https://tools.ietf.org/html/2253).", - "readOnly": true, - "example": "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com" - }, - "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 providers 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`.", - "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 providers 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`.", - "format": "int32", - "readOnly": true - } - } - }, - "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.\n\n| Value | Day of Week |\n|---|---|\n| `1` | Sunday |\n| `2` | Monday |\n| `3` | Tuesday |\n| `4` | Wednesday |\n| `5` | Thursday |\n| `6` | Friday |\n| `7` | Saturday |\n", - "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 - }, - "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." - } - } - }, - "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" - }, - "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, - "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", - "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_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" - ] - } - } - } - ] - }, - "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." - }, - "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/" - } - }, - "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", - "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", - "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." - } - }, - "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 cluster tier auto-scaling is enabled. Set to `true` to enable cluster tier auto-scaling. If enabled, you must specify a value for **providerSettings.autoScaling.compute.maxInstanceSize** also. Set to `false` to disable cluster tier auto-scaling." - }, - "scaleDownEnabled": { - "type": "boolean", - "description": "Flag that indicates whether the cluster tier can scale down. This is required if **autoScaling.compute.enabled** is `true`. If you enable this option, specify a value for **providerSettings.autoScaling.compute.minInstanceSize**." - } - }, - "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." - }, - "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.", - "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.", - "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, - "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/" - } - }, - "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, - "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." - }, - "ClusterFreeAutoScaling": { - "type": "object", - "properties": { - "compute": { - "title": "Tenant", - "type": "string", - "description": "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down." - } - }, - "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`.", - "enum": ["AWS", "GCP", "AZURE"] - }, - "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}**." - } - } - } - ] - }, - "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" - } - }, - "oneOf": [ - { - "$ref": "#/components/schemas/AWSCloudProviderSettings" - }, - { - "$ref": "#/components/schemas/AzureCloudProviderSettings" - }, - { - "$ref": "#/components/schemas/CloudGCPProviderSettings" - }, - { - "$ref": "#/components/schemas/ClusterFreeProviderSettings" - } - ] - }, - "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.", - "format": "date-time", - "externalDocs": { - "description": "Reconfiguring a Replica Set during a regional outage", - "url": "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" - } - }, - "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"] - }, - "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" - }, - "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.", - "externalDocs": { - "description": "Encryption at Rest using Customer Key Management", - "url": "https://www.mongodb.com/docs/atlas/security-kms-encryption/" - }, - "enum": ["NONE", "AWS", "AZURE", "GCP"] - }, - "globalClusterSelfManagedSharding": { - "type": "boolean", - "description": "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen 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.\n\nWhen 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.\n\nThis 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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal character string that identifies the project.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "id": { - "maxLength": 24, - "minLength": 24, - "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.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", - "deprecated": true, - "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" - } - }, - "mongoDBMajorVersion": { - "type": "string", - "description": "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", - "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-" - } - }, - "mongoDBVersion": { - "pattern": "([\\d]+\\.[\\d]+\\.[\\d]+)", - "type": "string", - "description": "Version of MongoDB that the cluster runs." - }, - "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/" - } - }, - "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 - }, - "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/" - } - }, - "name": { - "maxLength": 64, - "minLength": 1, - "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" - }, - "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.\n\n- For Global Clusters, each object in the array represents one zone where MongoDB Cloud deploys your clusters nodes.\n- For non-Global sharded clusters and replica sets, the single object represents where MongoDB Cloud deploys your clusters nodes.", - "items": { - "$ref": "#/components/schemas/LegacyReplicationSpec" - } - }, - "rootCertType": { - "type": "string", - "description": "Root Certificate Authority that MongoDB Atlas clusters 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 the current operating condition of the cluster.", - "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" - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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.\n\n- If you include existing zones in the request, you must specify this parameter.\n\n- 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.\n\n If you are upgrading a replica set to a sharded cluster, you cannot increase the number of shards in the same update request. You should wait until after the cluster has completed upgrading to sharded and you have reconnected all application clients to the MongoDB router before adding additional shards. Otherwise, your data might become inconsistent once MongoDB Cloud begins distributing data across shards.", - "format": "int32", - "default": 1 - }, - "regionsConfig": { - "title": "Region Configuration", - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/RegionSpec" - }, - "description": "Physical location where MongoDB Cloud provisions cluster nodes." - }, - "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." - }, - "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.", - "format": "date-time", - "externalDocs": { - "description": "Reconfiguring a Replica Set during a regional outage", - "url": "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" - } - }, - "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"] - }, - "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" - }, - "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.", - "externalDocs": { - "description": "Encryption at Rest using Customer Key Management", - "url": "https://www.mongodb.com/docs/atlas/security-kms-encryption/" - }, - "enum": ["NONE", "AWS", "AZURE", "GCP"] - }, - "globalClusterSelfManagedSharding": { - "type": "boolean", - "description": "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen 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.\n\nWhen 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.\n\nThis 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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal character string that identifies the project.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "id": { - "maxLength": 24, - "minLength": 24, - "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.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", - "deprecated": true, - "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" - } - }, - "mongoDBMajorVersion": { - "type": "string", - "description": "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", - "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-" - } - }, - "mongoDBVersion": { - "pattern": "([\\d]+\\.[\\d]+\\.[\\d]+)", - "type": "string", - "description": "Version of MongoDB that the cluster runs." - }, - "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/" - } - }, - "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 - }, - "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/" - } - }, - "name": { - "maxLength": 64, - "minLength": 1, - "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" - }, - "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.\n\n- For Global Clusters, each object in the array represents one zone where MongoDB Cloud deploys your clusters nodes.\n- For non-Global sharded clusters and replica sets, the single object represents where MongoDB Cloud deploys your clusters nodes.", - "items": { - "$ref": "#/components/schemas/LegacyReplicationSpec" - } - }, - "rootCertType": { - "type": "string", - "description": "Root Certificate Authority that MongoDB Atlas clusters 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 the current operating condition of the cluster.", - "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" - }, - "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**.\n If this parameter is `false`, the serverless instance uses **Basic Backup**.\n\n | Option | Description |\n |---|---|\n | Serverless Continuous Backup | Atlas takes incremental [snapshots](https://www.mongodb.com/docs/atlas/backup/cloud-backup/overview/#std-label-serverless-snapshots) of the data in your serverless instance every six hours and lets you restore the data from a selected point in time within the last 72 hours. Atlas also takes daily snapshots and retains these daily snapshots for 35 days. To learn more, see [Serverless Instance Costs](https://www.mongodb.com/docs/atlas/billing/serverless-instance-costs/#std-label-serverless-instance-costs). |\n | Basic Backup | Atlas takes incremental [snapshots](https://www.mongodb.com/docs/atlas/backup/cloud-backup/overview/#std-label-serverless-snapshots) of the data in your serverless instance every six hours and retains only the two most recent snapshots. You can use this option for free. |", - "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, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal character string that identifies the project.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "id": { - "maxLength": 24, - "minLength": 24, - "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 - }, - "name": { - "maxLength": 64, - "minLength": 1, - "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 the current operating condition of the serverless instance.", - "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.", - "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, - "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"] - }, - "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/)." - } - }, - "description": "Group of cloud provider settings that configure the provisioned MongoDB serverless instance." - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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 providers 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`.", - "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.\n\n| Status | Activity |\n|---|---|\n| `ACTIVE` | This access list entry applies to all relevant cloud providers. |\n| `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. |\n| `FAILED` | MongoDB Cloud didn't succeed in adding this access list entry. |\n", - "readOnly": true, - "enum": ["PENDING", "FAILED", "ACTIVE"] - } - } - }, - "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": { - "maxLength": 12, - "minLength": 12, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "minLength": 5, - "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": { - "maxLength": 32, - "minLength": 32, - "pattern": "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$", - "type": "string", - "description": "Unique string that identifies the Azure AD directory in which the VNet peered with the MongoDB Cloud VNet resides." - }, - "azureSubscriptionId": { - "maxLength": 32, - "minLength": 32, - "pattern": "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$", - "type": "string", - "description": "Unique string that identifies the Azure subscription in which the VNet you peered with the MongoDB Cloud VNet resides." - }, - "containerId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 30, - "minLength": 6, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the network peering connection.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "networkName": { - "maxLength": 63, - "minLength": 1, - "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 providers 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`.", - "format": "int32", - "readOnly": true - } - }, - "description": "Group of Network Peering connection settings." - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "items": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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" - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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" - }, - "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 - } - } - }, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the interface endpoint.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - } - }, - "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." - }, - "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" - }, - "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." - } - } - } - ] - }, - "CreateEndpointRequest": { - "type": "object", - "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" - }, - "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.\n\n- 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:\n - Your applications must use the new connection strings for existing multi-region and global sharded clusters. This might cause downtime.\n - Your MongoDB Cloud project can't contain replica sets nor can you create new replica sets in this project.\n\n - You can't disable this setting if you have:\n - more than one private endpoint in more than one region\n - more than one private endpoint in one region and one private endpoint in one or more regions.\n\n- 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." + "totalCount" : { + "minimum" : 0, + "type" : "integer", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "format" : "int32", + "readOnly" : true } } }, - "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 providers 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`.", - "format": "int32", - "readOnly": true + "Document" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "The stats associated with the stream processor.", + "readOnly" : true, + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor" } + }, + "description" : "The stats associated with the stream processor.", + "readOnly" : true, + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor" } }, - "PrivateNetworkEndpointIdEntry": { - "required": ["endpointId"], - "type": "object", - "properties": { - "comment": { - "type": "string", - "description": "Human-readable string to associate with this private endpoint." + "StreamsDLQ" : { + "type" : "object", + "properties" : { + "coll" : { + "type" : "string", + "description" : "Name of the collection to use for the DLQ." }, - "customerEndpointDNSName": { - "type": "string", - "description": "Human-readable label to identify customer's VPC endpoint DNS name." + "connectionName" : { + "type" : "string", + "description" : "Name of the connection to write DLQ messages to. Must be an Atlas connection." }, - "endpointId": { - "maxLength": 22, - "minLength": 22, - "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" - } - }, - "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." - }, - "type": { - "type": "string", - "description": "Human-readable label that identifies the resource type associated with this private endpoint.", - "default": "DATA_LAKE", - "enum": ["DATA_LAKE"] - } - } - }, - "CreatePushBasedLogExportProjectRequest": { - "required": ["bucketName", "iamRoleId", "prefixPath"], - "type": "object", - "properties": { - "bucketName": { - "type": "string", - "description": "The name of the bucket to which the agent will send the logs to." - }, - "iamRoleId": { - "type": "string", - "description": "ID of the AWS IAM role that will be used to write to the S3 bucket." - }, - "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" - } - }, - "prefixPath": { - "type": "string", - "description": "S3 directory in which vector will write to in order to store the logs. An empty string denotes the root directory." - } - } - }, - "PushBasedLogExportProject": { - "type": "object", - "properties": { - "bucketName": { - "type": "string", - "description": "The name of the bucket to which the agent will send the logs to." - }, - "createDate": { - "type": "string", - "description": "Date and time that this feature was enabled on.", - "format": "date-time", - "readOnly": true - }, - "iamRoleId": { - "type": "string", - "description": "ID of the AWS IAM role that will be used to write to the S3 bucket." - }, - "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" - } - }, - "prefixPath": { - "type": "string", - "description": "S3 directory in which vector will write to in order to store the logs. An empty string denotes the root directory." - }, - "state": { - "type": "string", - "description": "Describes whether or not the feature is enabled and what status it is in.", - "readOnly": true, - "enum": [ - "UNCONFIGURED", - "INITIATING", - "BUCKET_VERIFIED", - "BUCKET_VERIFICATION_FAILED", - "ASSUME_ROLE_FAILED", - "ACTIVE" - ] - } - } - }, - "LDAPVerifyConnectivityJobRequest": { - "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 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": { - "maxLength": 24, - "minLength": 24, - "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, - "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.\n\nUse 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", - "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", - "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\": \"\"`." + "db" : { + "type" : "string", + "description" : "Name of the database to use for the DLQ." }, - "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.", - "items": { - "$ref": "#/components/schemas/UserToDNMapping" + "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": "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" - } - } + "description" : "Dead letter queue for the stream processor.", + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/reference/glossary/#std-term-dead-letter-queue" } }, - "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)." - }, - "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." - }, - "PinFCVView": { - "type": "object", - "properties": { - "expirationDate": { - "type": "string", - "description": "Expiration date of the fixed FCV. If left unspecified, will default to 4 weeks ahead of the existing pinnedDate (if an FCV is already pinned) or the current date. Note that this field cannot exceed 4 weeks from the pinned date.", - "format": "date-time" + "StreamsOptions" : { + "type" : "object", + "properties" : { + "dlq" : { + "$ref" : "#/components/schemas/StreamsDLQ" }, - "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" + "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" - } - } - } - }, - "GeoSharding": { - "type": "object", - "properties": { - "customZoneMapping": { - "type": "object", - "additionalProperties": { - "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `id` property.\n\nThis parameter returns an empty object if no custom zones exist.", - "readOnly": true - }, - "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `id` property.\n\nThis 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, - "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.", - "readOnly": true - }, - "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.", - "writeOnly": true, - "externalDocs": { - "description": "Hashed Shard Keys", - "url": "https://www.mongodb.com/docs/manual/reference/method/sh.shardCollection/#hashed-shard-keys" - }, - "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/).", - "writeOnly": true, - "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", - "writeOnly": true, - "externalDocs": { - "description": "Global Cluster Sharding", - "url": "https://www.mongodb.com/docs/atlas/shard-global-collection/" - } - }, - "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.", - "writeOnly": true, - "externalDocs": { - "description": "Hashed Shard Key", - "url": "https://www.mongodb.com/docs/manual/core/hashed-sharding/" - }, - "default": false - } - } - }, - "GeoSharding20240805": { - "type": "object", - "properties": { - "customZoneMapping": { - "type": "object", - "additionalProperties": { - "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.\n\nThis parameter returns an empty object if no custom zones exist.", - "readOnly": true - }, - "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.\n\nThis 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, - "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 - } - } - }, - "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.\n\nThis parameter returns an empty object if no custom zones exist.", - "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." - }, - "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.\n\n Change this parameter only if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" to \"AWS\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" to \"M30\"` or greater (not including `Mxx_NVME` tiers).\n\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType\" to \"PROVISIONED\"`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1.", - "format": "int32" - }, - "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.", - "format": "date-time", - "externalDocs": { - "description": "Reconfiguring a Replica Set during a regional outage", - "url": "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" - } - }, - "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.", - "default": false - }, - "biConnector": { - "$ref": "#/components/schemas/BiConnector" - }, - "clusterType": { - "type": "string", - "description": "Configuration of nodes that comprise the cluster.", - "enum": ["REPLICASET", "SHARDED", "GEOSHARDED"] - }, - "connectionStrings": { - "$ref": "#/components/schemas/ClusterConnectionStrings" - }, - "createDate": { - "type": "string", - "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": { - "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" - }, - "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"] - }, - "globalClusterSelfManagedSharding": { - "type": "boolean", - "description": "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen 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.\n\nWhen 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.\n\nThis 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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal character string that identifies the project.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "id": { - "maxLength": 24, - "minLength": 24, - "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.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", - "deprecated": true, - "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" - } - }, - "mongoDBMajorVersion": { - "type": "string", - "description": "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", - "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-" - } - }, - "mongoDBVersion": { - "pattern": "([\\d]+\\.[\\d]+\\.[\\d]+)", - "type": "string", - "description": "Version of MongoDB that the cluster runs.", - "readOnly": true - }, - "name": { - "maxLength": 64, - "minLength": 1, - "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/" - } - }, - "replicationSpecs": { - "type": "array", - "description": "List of settings that configure your cluster regions. For Global Clusters, each object in the array represents a zone where your clusters nodes deploy. For non-Global sharded clusters and replica sets, this array has one object representing where your clusters nodes deploy.", - "items": { - "$ref": "#/components/schemas/ReplicationSpec" - } - }, - "rootCertType": { - "type": "string", - "description": "Root Certificate Authority that MongoDB Cloud cluster uses. MongoDB Cloud supports Internet Security Research Group.", - "default": "ISRGROOTX1", - "enum": ["ISRGROOTX1"] - }, - "stateName": { - "type": "string", - "description": "Human-readable label that indicates the current operating condition of this cluster.", - "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" - }, - "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 someone enabled instance size auto-scaling.\n\n- Set to `true` to enable instance size auto-scaling. If enabled, you must specify a value for **replicationSpecs[n].regionConfigs[m].autoScaling.compute.maxInstanceSize**.\n- Set to `false` to disable instance size automatic scaling." - }, - "maxInstanceSize": { - "$ref": "#/components/schemas/BaseCloudProviderInstanceSize" - }, - "minInstanceSize": { - "$ref": "#/components/schemas/BaseCloudProviderInstanceSize" - }, - "scaleDownEnabled": { - "type": "boolean", - "description": "Flag that indicates whether the instance size may scale down. MongoDB Cloud requires this parameter if `\"replicationSpecs[n].regionConfigs[m].autoScaling.compute.enabled\" : true`. If you enable this option, specify a value for **replicationSpecs[n].regionConfigs[m].autoScaling.compute.minInstanceSize**." - } - }, - "description": "Options that determine how this cluster handles CPU scaling." - }, - "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" - ] - }, - "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" - } - } - } - ] - }, - "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`.\n\n**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", - "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_CENTRAL", - "GERMANY_NORTH_EAST", - "GERMANY_WEST_CENTRAL", - "GERMANY_NORTH", - "SWEDEN_CENTRAL", - "SWEDEN_SOUTH", - "SWITZERLAND_NORTH", - "SWITZERLAND_WEST", - "UK_SOUTH", - "UK_WEST", - "NORWAY_EAST", - "NORWAY_WEST", - "INDIA_CENTRAL", - "INDIA_SOUTH", - "INDIA_WEST", - "CHINA_EAST", - "CHINA_NORTH", - "ASIA_EAST", - "JAPAN_EAST", - "JAPAN_WEST", - "ASIA_SOUTH_EAST", - "KOREA_CENTRAL", - "KOREA_SOUTH", - "FRANCE_CENTRAL", - "FRANCE_SOUTH", - "SOUTH_AFRICA_NORTH", - "SOUTH_AFRICA_WEST", - "UAE_CENTRAL", - "UAE_NORTH", - "QATAR_CENTRAL" - ] - }, - { - "title": "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", - "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", - "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" - } - ] - }, - "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.", - "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." - }, - "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.", - "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": { - "maxLength": 24, - "minLength": 24, - "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.\n\n If you are upgrading a replica set to a sharded cluster, you cannot increase the number of shards in the same update request. You should wait until after the cluster has completed upgrading to sharded and you have reconnected all application clients to the MongoDB router before adding additional shards. Otherwise, your data might become inconsistent once MongoDB Cloud begins distributing data across shards.", - "format": "int32" - }, - "regionConfigs": { - "type": "array", - "description": "Hardware specifications for nodes set for a given region. 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**.\n\n**Example:**\n\nIf you set `\"replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize\" : \"M30\"`, set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : `\"M30\"` if you have electable nodes and `\"replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize\" : `\"M30\"` if you have read-only nodes.", - "items": { - "$ref": "#/components/schemas/CloudRegionConfig" - } - }, - "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": { - "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`.", - "enum": ["AWS", "GCP", "AZURE"] - } - } - } - ] - }, - "AWSHardwareSpec20240805": { - "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 in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as \"base nodes\") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.", - "enum": [ - "M10", - "M20", - "M30", - "M40", - "M50", - "M60", - "M80", - "M100", - "M140", - "M200", - "M300", - "R40", - "R50", - "R60", - "R80", - "R200", - "R300", - "R400", - "R700", - "M40_NVME", - "M50_NVME", - "M60_NVME", - "M80_NVME", - "M200_NVME", - "M400_NVME" - ] - }, - "diskIOPS": { - "type": "integer", - "description": "Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.\n\n You can set different IOPS values on different shards when provisioned IOPS are supported.\n\n Change this parameter only if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" to \"AWS\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" to \"M30\"` or greater (not including `Mxx_NVME` tiers).\n\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType\" to \"PROVISIONED\"`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1.", - "format": "int32" - }, - "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 must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", - "format": "double" - }, - "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." - }, - "AWSRegionConfig20240805": { - "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/CloudRegionConfig20240805" - }, - { - "type": "object", - "properties": { - "analyticsAutoScaling": { - "$ref": "#/components/schemas/AdvancedAutoScalingSettings" - }, - "analyticsSpecs": { - "$ref": "#/components/schemas/DedicatedHardwareSpec20240805" - }, - "autoScaling": { - "$ref": "#/components/schemas/AdvancedAutoScalingSettings" - }, - "readOnlySpecs": { - "$ref": "#/components/schemas/DedicatedHardwareSpec20240805" - } - } - } - ] - }, - "AzureHardwareSpec20240805": { - "type": "object", - "properties": { - "instanceSize": { - "title": "Azure Instance Sizes", - "type": "string", - "description": "Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as \"base nodes\") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.", - "enum": [ - "M10", - "M20", - "M30", - "M40", - "M50", - "M60", - "M80", - "M90", - "M200", - "R40", - "R50", - "R60", - "R80", - "R200", - "R300", - "R400", - "M60_NVME", - "M80_NVME", - "M200_NVME", - "M300_NVME", - "M400_NVME", - "M600_NVME" - ] - }, - "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 must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", - "format": "double" - }, - "nodeCount": { - "type": "integer", - "description": "Number of nodes of the given type for MongoDB Cloud to deploy to the region.", - "format": "int32" - } - } - }, - "AzureRegionConfig20240805": { - "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/CloudRegionConfig20240805" - }, - { - "type": "object", - "properties": { - "analyticsAutoScaling": { - "$ref": "#/components/schemas/AdvancedAutoScalingSettings" - }, - "analyticsSpecs": { - "$ref": "#/components/schemas/DedicatedHardwareSpec20240805" - }, - "autoScaling": { - "$ref": "#/components/schemas/AdvancedAutoScalingSettings" - }, - "readOnlySpecs": { - "$ref": "#/components/schemas/DedicatedHardwareSpec20240805" - } - } - } - ] - }, - "CloudRegionConfig20240805": { - "title": "Cloud Service Provider Settings", - "type": "object", - "properties": { - "electableSpecs": { - "$ref": "#/components/schemas/HardwareSpec20240805" - }, - "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`.\n\n**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", - "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_CENTRAL", - "GERMANY_NORTH_EAST", - "GERMANY_WEST_CENTRAL", - "GERMANY_NORTH", - "SWEDEN_CENTRAL", - "SWEDEN_SOUTH", - "SWITZERLAND_NORTH", - "SWITZERLAND_WEST", - "UK_SOUTH", - "UK_WEST", - "NORWAY_EAST", - "NORWAY_WEST", - "INDIA_CENTRAL", - "INDIA_SOUTH", - "INDIA_WEST", - "CHINA_EAST", - "CHINA_NORTH", - "ASIA_EAST", - "JAPAN_EAST", - "JAPAN_WEST", - "ASIA_SOUTH_EAST", - "KOREA_CENTRAL", - "KOREA_SOUTH", - "FRANCE_CENTRAL", - "FRANCE_SOUTH", - "SOUTH_AFRICA_NORTH", - "SOUTH_AFRICA_WEST", - "UAE_CENTRAL", - "UAE_NORTH", - "QATAR_CENTRAL" - ] - }, - { - "title": "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", - "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", - "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/AWSRegionConfig20240805", - "AZURE": "#/components/schemas/AzureRegionConfig20240805", - "GCP": "#/components/schemas/GCPRegionConfig20240805", - "TENANT": "#/components/schemas/TenantRegionConfig20240805" - } - }, - "oneOf": [ - { - "$ref": "#/components/schemas/AWSRegionConfig20240805" - }, - { - "$ref": "#/components/schemas/AzureRegionConfig20240805" - }, - { - "$ref": "#/components/schemas/GCPRegionConfig20240805" - }, - { - "$ref": "#/components/schemas/TenantRegionConfig20240805" - } - ] - }, - "ClusterDescription20240805": { - "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.", - "format": "date-time", - "externalDocs": { - "description": "Reconfiguring a Replica Set during a regional outage", - "url": "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" - } - }, - "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.", - "default": false - }, - "biConnector": { - "$ref": "#/components/schemas/BiConnector" - }, - "clusterType": { - "type": "string", - "description": "Configuration of nodes that comprise the cluster.", - "enum": ["REPLICASET", "SHARDED", "GEOSHARDED"] - }, - "connectionStrings": { - "$ref": "#/components/schemas/ClusterConnectionStrings" - }, - "createDate": { - "type": "string", - "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 - }, - "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"] - }, - "globalClusterSelfManagedSharding": { - "type": "boolean", - "description": "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen 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.\n\nWhen 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.\n\nThis 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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal character string that identifies the project.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "id": { - "maxLength": 24, - "minLength": 24, - "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.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", - "deprecated": true, - "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" - } - }, - "mongoDBMajorVersion": { - "type": "string", - "description": "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", - "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-" - } - }, - "mongoDBVersion": { - "pattern": "([\\d]+\\.[\\d]+\\.[\\d]+)", - "type": "string", - "description": "Version of MongoDB that the cluster runs.", - "readOnly": true - }, - "name": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string", - "description": "Human-readable label that identifies the 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/" - } - }, - "replicationSpecs": { - "type": "array", - "description": "List of settings that configure your cluster regions. This array has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations.", - "items": { - "$ref": "#/components/schemas/ReplicationSpec20240805" - } - }, - "rootCertType": { - "type": "string", - "description": "Root Certificate Authority that MongoDB Cloud cluster uses. MongoDB Cloud supports Internet Security Research Group.", - "default": "ISRGROOTX1", - "enum": ["ISRGROOTX1"] - }, - "stateName": { - "type": "string", - "description": "Human-readable label that indicates the current operating condition of this cluster.", - "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" - }, - "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"] - } - } - }, - "DedicatedHardwareSpec20240805": { - "type": "object", - "properties": { - "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 must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", - "format": "double" - }, - "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.", - "oneOf": [ - { - "$ref": "#/components/schemas/AWSHardwareSpec20240805" - }, - { - "$ref": "#/components/schemas/AzureHardwareSpec20240805" - }, - { - "$ref": "#/components/schemas/GCPHardwareSpec20240805" - } - ] - }, - "GCPHardwareSpec20240805": { - "type": "object", - "properties": { - "instanceSize": { - "title": "GCP Instance Sizes", - "type": "string", - "description": "Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as \"base nodes\") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.", - "enum": [ - "M10", - "M20", - "M30", - "M40", - "M50", - "M60", - "M80", - "M140", - "M200", - "M250", - "M300", - "M400", - "R40", - "R50", - "R60", - "R80", - "R200", - "R300", - "R400", - "R600" - ] - }, - "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 must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", - "format": "double" - }, - "nodeCount": { - "type": "integer", - "description": "Number of nodes of the given type for MongoDB Cloud to deploy to the region.", - "format": "int32" - } - } - }, - "GCPRegionConfig20240805": { - "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/CloudRegionConfig20240805" - }, - { - "type": "object", - "properties": { - "analyticsAutoScaling": { - "$ref": "#/components/schemas/AdvancedAutoScalingSettings" - }, - "analyticsSpecs": { - "$ref": "#/components/schemas/DedicatedHardwareSpec20240805" - }, - "autoScaling": { - "$ref": "#/components/schemas/AdvancedAutoScalingSettings" - }, - "readOnlySpecs": { - "$ref": "#/components/schemas/DedicatedHardwareSpec20240805" - } - } - } - ] - }, - "HardwareSpec20240805": { - "type": "object", - "properties": { - "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 must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", - "format": "double" - } - }, - "description": "Hardware specifications for all electable nodes deployed in the region. Electable nodes can become the primary and can enable local reads. If you don't specify this option, MongoDB Cloud deploys no electable nodes to the region.", - "oneOf": [ - { - "$ref": "#/components/schemas/AWSHardwareSpec20240805" - }, - { - "$ref": "#/components/schemas/AzureHardwareSpec20240805" - }, - { - "$ref": "#/components/schemas/GCPHardwareSpec20240805" - }, - { - "$ref": "#/components/schemas/TenantHardwareSpec20240805" - } - ] - }, - "ReplicationSpec20240805": { - "title": "Replication Specifications", - "type": "object", - "properties": { - "id": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the replication object for a shard in a Cluster. If you include existing shard replication configurations in the request, you must specify this parameter. If you add a new shard to an existing Cluster, you may specify this parameter. The request deletes any existing shards in the Cluster that you exclude from the request.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "regionConfigs": { - "type": "array", - "description": "Hardware specifications for nodes set for a given region. 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**.\n\n**Example:**\n\nIf you set `\"replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize\" : \"M30\"`, set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : `\"M30\"` if you have electable nodes and `\"replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize\" : `\"M30\"` if you have read-only nodes.", - "items": { - "$ref": "#/components/schemas/CloudRegionConfig20240805" - } - }, - "zoneId": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the zone in a Global Cluster. This value can be used to configure Global Cluster backup policies.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "zoneName": { - "type": "string", - "description": "Human-readable label that describes the zone this shard belongs to in a Global Cluster. Provide this value only if \"clusterType\" : \"GEOSHARDED\" but not \"selfManagedSharding\" : true." - } - }, - "description": "Details that explain how MongoDB Cloud replicates data on the specified MongoDB database." - }, - "TenantHardwareSpec20240805": { - "type": "object", - "properties": { - "instanceSize": { - "title": "Tenant Instance Sizes", - "type": "string", - "description": "Hardware specification for the instances in this M0/M2/M5 tier cluster.", - "enum": ["M0", "M2", "M5"] - }, - "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 must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", - "format": "double" - } - } - }, - "TenantRegionConfig20240805": { - "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/CloudRegionConfig20240805" - }, - { - "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`.", - "enum": ["AWS", "GCP", "AZURE"] - } - } - } - ] - }, - "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 providers 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`.", - "format": "int32", - "readOnly": true - } - } - }, - "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 providers 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`.", - "format": "int32", - "readOnly": true - } - } - }, - "PaginatedClusterDescription20240805": { - "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 providers when completing this request.", - "readOnly": true, - "items": { - "$ref": "#/components/schemas/ClusterDescription20240805" - } - }, - "totalCount": { - "minimum": 0, - "type": "integer", - "description": "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", - "format": "int32", - "readOnly": true - } - } - }, - "ClusterDescriptionProcessArgs": { - "type": "object", - "properties": { - "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" - } - }, - "defaultReadConcern": { - "type": "string", - "description": "Default level of acknowledgment requested from MongoDB for read operations set for this cluster.\n\nMongoDB 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/" - }, - "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, - "default": true - }, - "javascriptEnabled": { - "type": "boolean", - "description": "Flag that indicates whether the cluster allows execution of operations that perform server-side executions of JavaScript.", - "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" - } - }, - "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" - }, - "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" - } - }, - "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" - } - } - } - }, - "ClusterDescriptionProcessArgs20240805": { - "type": "object", - "properties": { - "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" - } - }, - "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/" - } - }, - "javascriptEnabled": { - "type": "boolean", - "description": "Flag that indicates whether the cluster allows execution of operations that perform server-side executions of JavaScript.", - "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" - } - }, - "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" - }, - "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" - } - }, - "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" - } - } - } - }, - "SampleDatasetStatus": { - "type": "object", - "properties": { - "_id": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal character string that identifies this sample dataset.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "clusterName": { - "maxLength": 64, - "minLength": 1, - "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"] - } - } - }, - "ServerlessInstanceDescriptionCreate": { - "title": "Serverless Instance Description Create", - "required": ["name", "providerSettings"], - "type": "object", - "properties": { - "name": { - "maxLength": 64, - "minLength": 1, - "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 the current operating condition of the serverless instance.", - "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.", - "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 providers 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`.", - "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.", - "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." - }, - "ServerlessAWSTenantEndpoint": { - "title": "AWS", - "type": "object", - "properties": { - "_id": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the private endpoint.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the private endpoint.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the private endpoint.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "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"] - } - }, - "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" - } - } - }, - "USSBackupRestoreJob20250101": { - "title": "USS Backup Restore Job", - "type": "object", - "properties": { - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the restore job.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "instanceName": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string", - "description": "Human-readable label that identifies the source instance.", - "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" - } - }, - "projectId": { - "maxLength": 24, - "minLength": 24, - "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" - }, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", - "readOnly": true, - "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": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", - "type": "string", - "description": "Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another USS instance or Dedicated cluster tier.", - "readOnly": true - }, - "targetProjectId": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - } - }, - "description": "Details for one restore job of a USS instance." - }, - "USSBackupRestoreJobCreate20250101": { - "title": "Create USS Backup Restore Job", - "required": ["_snapshotId", "_targetDeploymentItemName"], - "type": "object", - "properties": { - "_snapshotId": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", - "writeOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "_targetDeploymentItemName": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", - "type": "string", - "description": "Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another USS instance or Dedicated cluster tier.", - "writeOnly": true - }, - "_targetProjectId": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.", - "writeOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the restore job.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "instanceName": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string", - "description": "Human-readable label that identifies the source instance.", - "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" - } - }, - "projectId": { - "maxLength": 24, - "minLength": 24, - "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" - }, - "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 - }, - "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"] - } - }, - "description": "Details to create one restore job of a USS instance." - }, - "USSBackupSnapshotDownloadCreate20250101": { - "title": "USS Backup Snapshot Download Create", - "required": ["_snapshotId"], - "type": "object", - "properties": { - "_snapshotId": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the snapshot to download.", - "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" - } - } - }, - "description": "Details for one backup snapshot download of a USS instance." - }, - "PaginatedApiAtlasUSSBackupRestoreJob20250101View": { - "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 providers when completing this request.", - "readOnly": true, - "items": { - "$ref": "#/components/schemas/USSBackupRestoreJob20250101" - } - }, - "totalCount": { - "minimum": 0, - "type": "integer", - "description": "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", - "format": "int32", - "readOnly": true - } - } - }, - "USSBackupSnapshot20250101": { - "title": "USS Backup Snapshot", - "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": { - "maxLength": 24, - "minLength": 24, - "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" - } - }, - "mongoDBVersion": { - "type": "string", - "description": "MongoDB host version that the snapshot runs.", - "readOnly": true - }, - "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"] - } - }, - "description": "Details for one snapshot of a USS instance." - }, - "PaginatedApiAtlasUSSBackupSnapshot20240710View": { - "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 providers when completing this request.", - "readOnly": true, - "items": { - "$ref": "#/components/schemas/USSBackupSnapshot20250101" - } - }, - "totalCount": { - "minimum": 0, - "type": "integer", - "description": "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", - "format": "int32", - "readOnly": true - } - } - }, - "USSBackupSettings20250101": { - "title": "USS backup configuration", - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "Flag that indicates whether backups are performed for this USS instance. Backup uses [TODO](TODO) for USS instances.", - "readOnly": true, - "default": true - } - }, - "description": "USS backup configuration", - "readOnly": true - }, - "USSConnectionStrings20250101": { - "title": "USS Instance Connection Strings", - "type": "object", - "properties": { - "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 USS 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/" - } - }, - "USSInstanceDescription20250101": { - "title": "USS Instance Description", - "required": ["providerSettings"], - "type": "object", - "properties": { - "backupSettings": { - "$ref": "#/components/schemas/USSBackupSettings20250101" - }, - "clusterType": { - "type": "string", - "description": "USS instance topology.", - "readOnly": true, - "enum": ["REPLICASET", "LOADBALANCED"] - }, - "connectionStrings": { - "$ref": "#/components/schemas/USSConnectionStrings20250101" - }, - "createDate": { - "type": "string", - "description": "Date and time when MongoDB Cloud created this instance. This parameter expresses its value in ISO 8601 format in UTC.", - "format": "date-time", - "readOnly": true - }, - "groupId": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal character string that identifies the project.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "id": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the 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 instance runs.", - "readOnly": true - }, - "name": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string", - "description": "Human-readable label that identifies the instance.", - "readOnly": true - }, - "providerSettings": { - "$ref": "#/components/schemas/USSProviderSettings20250101" - }, - "stateName": { - "type": "string", - "description": "Human-readable label that indicates the current operating condition of this instance.", - "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 instance.", - "externalDocs": { - "description": "Resource Tags", - "url": "https://dochub.mongodb.org/core/add-cluster-tag-atlas" - }, - "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.", - "readOnly": true, - "default": "LTS", - "enum": ["LTS"] - } - }, - "description": "Group of settings that configure a MongoDB USS instance." - }, - "USSProviderSettings20250101": { - "title": "Cloud Service Provider Settings for a USS Instance", - "type": "object", - "properties": { - "backingProviderName": { - "type": "string", - "description": "Cloud service provider on which MongoDB Cloud provisioned the USS instance.", - "readOnly": true, - "enum": ["AWS", "AZURE", "GCP"] - }, - "diskSizeGB": { - "type": "number", - "description": "Storage capacity available to the USS instance expressed in gigabytes.", - "format": "double", - "readOnly": true - }, - "providerName": { - "type": "string", - "description": "Human-readable label that identifies the cloud service provider.", - "readOnly": true, - "default": "USS", - "enum": ["USS"] - }, - "regionName": { - "type": "string", - "description": "Human-readable label that identifies the geographic location of your MongoDB USS 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/).", - "readOnly": true - } - }, - "description": "Group of cloud provider settings that configure the provisioned MongoDB USS instance.", - "readOnly": true - }, - "USSInstanceDescriptionCreate20250101": { - "title": "USS Instance Description Create", - "required": ["name", "providerSettings"], - "type": "object", - "properties": { - "name": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "type": "string", - "description": "Human-readable label that identifies the instance.", - "writeOnly": true - }, - "providerSettings": { - "$ref": "#/components/schemas/USSProviderSettingsCreate20250101" - }, - "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" - } - }, - "tags": { - "type": "array", - "description": "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.", - "externalDocs": { - "description": "Resource Tags", - "url": "https://dochub.mongodb.org/core/add-cluster-tag-atlas" - }, - "items": { - "$ref": "#/components/schemas/ResourceTag" - } - }, - "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 - } - }, - "description": "Settings that you can specify when you create a USS instance." - }, - "USSProviderSettingsCreate20250101": { - "title": "Cloud Service Provider Settings for a USS Instance", - "required": ["backingProviderName", "regionName"], - "type": "object", - "properties": { - "backingProviderName": { - "type": "string", - "description": "Cloud service provider on which MongoDB Cloud provisioned the serverless instance.", - "writeOnly": true, - "enum": ["AWS", "AZURE", "GCP"] - }, - "regionName": { - "type": "string", - "description": "Human-readable label that identifies the geographic location of your MongoDB USS 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/).", - "writeOnly": true - }, - "diskSizeGB": { - "type": "number", - "description": "Storage capacity available to the USS instance expressed in gigabytes.", - "format": "double", - "readOnly": true - }, - "providerName": { - "type": "string", - "description": "Human-readable label that identifies the cloud service provider.", - "readOnly": true, - "default": "USS", - "enum": ["USS"] - } - }, - "description": "Group of cloud provider settings that configure the provisioned MongoDB USS instance.", - "writeOnly": true - }, - "PaginatedUSSInstance20250101": { - "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 providers when completing this request.", - "readOnly": true, - "items": { - "type": "object" - } - }, - "totalCount": { - "minimum": 0, - "type": "integer", - "description": "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", - "format": "int32", - "readOnly": true - } - } - }, - "AtlasOrganization": { - "required": ["name"], - "type": "object", - "properties": { - "id": { - "maxLength": 24, - "minLength": 24, - "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 - }, - "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": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", - "type": "string", - "description": "Human-readable label that identifies the organization." - } - }, - "description": "Details that describe the organization." - }, - "CreateOrganizationResponse": { - "type": "object", - "properties": { - "apiKey": { - "$ref": "#/components/schemas/ApiKeyUserDetails" - }, - "federationSettingsId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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" - } - } - }, - "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.", - "items": { - "type": "string", - "enum": [ - "ORG_OWNER", - "ORG_MEMBER", - "ORG_GROUP_CREATOR", - "ORG_BILLING_ADMIN", - "ORG_READ_ONLY", - "ORG_TEAM_MEMBERS_ADMIN" - ] - } - } - }, - "description": "Details of the programmatic API key to be created." - }, - "CreateOrganizationRequest": { - "required": ["name"], - "type": "object", - "properties": { - "apiKey": { - "$ref": "#/components/schemas/CreateAtlasOrganizationApiKey" - }, - "federationSettingsId": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", - "type": "string", - "description": "Human-readable label that identifies the organization." - }, - "orgOwnerId": { - "maxLength": 24, - "minLength": 24, - "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" - } - } - }, - "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 providers 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`.", - "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": "^((([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}))$", - "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": { - "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}))$", - "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" - } - } - }, - "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.", - "items": { - "type": "string", - "enum": [ - "ORG_OWNER", - "ORG_MEMBER", - "ORG_GROUP_CREATOR", - "ORG_BILLING_ADMIN", - "ORG_READ_ONLY", - "ORG_TEAM_MEMBERS_ADMIN" - ] - } - } - } - }, - "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 providers 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`.", - "format": "int32", - "readOnly": true - } - } - }, - "AddUserToTeam": { - "required": ["id"], - "type": "object", - "properties": { - "id": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user.", - "example": "32b6e34b3d91647abb20e7b8" - } - } - }, - "Team": { - "required": ["name"], - "type": "object", - "properties": { - "id": { - "maxLength": 24, - "minLength": 24, - "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.", - "items": { - "type": "string", - "description": "List that contains email addresses that identify MongoDB Cloud users to in this team.", - "format": "email" - } - } - } - }, - "TeamResponse": { - "type": "object", - "properties": { - "id": { - "maxLength": 24, - "minLength": 24, - "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 providers 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`.", - "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" + "items" : { + "$ref" : "#/components/schemas/Link" } + } + }, + "description" : "Optional configuration for the stream processor." + }, + "StreamsProcessor" : { + "type" : "object", + "properties" : { + "_id" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the stream processor.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" }, - "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 providers 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`.", - "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.", - "items": { - "type": "string" - } - }, - "hasRoleMappings": { - "type": "boolean", - "description": "Flag that indicates whether this organization has role mappings configured." - }, - "id": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies this federation.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "identityProviderId": { - "maxLength": 20, - "minLength": 20, - "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." - }, - "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." - }, - "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 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/." - } - }, - "description": "Collection of settings that configures the organization." - }, - "UpdateOrgRolesForUser": { - "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" - } - }, - "orgRoles": { - "uniqueItems": true, - "type": "array", - "description": "One or more organization level roles to assign to the MongoDB Cloud user.", - "items": { - "type": "string", - "enum": ["ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY"] - } - } - } - }, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "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": { - "maxLength": 24, - "minLength": 24, - "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:\n\n| Phase Value | Reason |\n|---|---|\n| CLOSED | MongoDB finalized all charges in the billing cycle but has yet to charge the customer. |\n| FAILED | MongoDB attempted to charge the provided credit card but charge for that amount failed. |\n| FORGIVEN | Customer initiated payment which MongoDB later forgave. |\n| FREE | All charges totalled zero so the customer won't be charged. |\n| INVOICED | MongoDB handled these charges using elastic invoicing. |\n| PAID | MongoDB succeeded in charging the provided credit card. |\n| PENDING | Invoice includes charges for the current billing cycle. |\n| PREPAID | Customer has a pre-paid plan so they won't be charged. |\n", - "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 providers 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`.", - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "items": { - "$ref": "#/components/schemas/InvoiceLineItem" - } - }, - "linkedInvoices": { - "type": "array", - "description": "List that contains the invoices for organizations linked to the paying organization.", - "readOnly": true, - "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": { - "maxLength": 24, - "minLength": 24, - "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, - "items": { - "$ref": "#/components/schemas/BillingPayment" - } - }, - "refunds": { - "type": "array", - "description": "List that contains payments that MongoDB returned to the organization for this invoice.", - "readOnly": true, - "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:\n\n| Phase Value | Reason |\n|---|---|\n| CLOSED | MongoDB finalized all charges in the billing cycle but has yet to charge the customer. |\n| FAILED | MongoDB attempted to charge the provided credit card but charge for that amount failed. |\n| FORGIVEN | Customer initiated payment which MongoDB later forgave. |\n| FREE | All charges totalled zero so the customer won't be charged. |\n| INVOICED | MongoDB handled these charges using elastic invoicing. |\n| PAID | MongoDB succeeded in charging the provided credit card. |\n| PENDING | Invoice includes charges for the current billing cycle. |\n| PREPAID | Customer has a pre-paid plan so they won't be charged. |\n", - "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": { - "maxLength": 24, - "minLength": 24, - "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.\n\nThese phases include:\n\n| Phase Value | Reason |\n|---|---|\n| `CANCELLED` | Customer or MongoDB cancelled the payment. |\n| `ERROR` | Issue arose when attempting to complete payment. |\n| `FAILED` | MongoDB tried to charge the credit card without success. |\n| `FAILED_AUTHENTICATION` | Strong Customer Authentication has failed. Confirm that your payment method is authenticated. |\n| `FORGIVEN` | Customer initiated payment which MongoDB later forgave. |\n| `INVOICED` | MongoDB issued an invoice that included this line item. |\n| `NEW` | Customer provided a method of payment, but MongoDB hasn't tried to charge the credit card. |\n| `PAID` | Customer submitted a successful payment. |\n| `PARTIAL_PAID` | Customer paid for part of this line item. |\n", - "enum": [ - "NEW", - "FORGIVEN", - "FAILED", - "PAID", - "PARTIAL_PAID", - "CANCELLED", - "INVOICED", - "ERROR", - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the payment that the organization had made.", - "readOnly": true - }, - "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": { - "maxLength": 64, - "minLength": 1, - "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": { - "maxLength": 24, - "minLength": 24, - "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_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", - "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_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_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" - ] - }, - "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 providers 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`.", - "format": "int32", - "readOnly": true - } - } - }, - "DBRoleToExecute": { - "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" - } - }, - "role": { - "type": "string", - "description": "The name of the role to use. Can be a built in role or a custom role." - }, - "type": { - "title": "DB Role Type", - "type": "string", - "description": "Type of the DB role. Can be either BuiltIn or Custom.", - "enum": ["BUILT_IN", "CUSTOM"] - } - }, - "description": "The name of a Built in or Custom DB Role to connect to an Atlas Cluster." - }, - "ProxyInfo": { - "type": "object", - "properties": { - "authKey": { - "type": "string", - "description": "Authentication key for the proxy." - }, - "dnsName": { - "type": "string", - "description": "DNS name to use to reach the proxy/s." - } - }, - "description": "VPC Proxy Information." - }, - "StreamsClusterConnection": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/StreamsConnection" - }, - { - "type": "object", - "properties": { - "clusterName": { - "type": "string", - "description": "Name of the cluster configured for this connection." - }, - "dbRoleToExecute": { - "$ref": "#/components/schemas/DBRoleToExecute" - } - } - } - ] - }, - "StreamsConnection": { - "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" + "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" - } + "items" : { + "$ref" : "#/components/schemas/Link" + } }, - "name": { - "type": "string", - "description": "Human-readable label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source." + "name" : { + "type" : "string", + "description" : "Human-readable name of the stream processor." }, - "type": { - "type": "string", - "description": "Type of the connection. Can be either Cluster or Kafka.", - "enum": ["Kafka", "Cluster", "Sample"] - } - }, - "description": "Settings that define a connection to an external data store.", - "readOnly": true, - "discriminator": { - "propertyName": "type", - "mapping": { - "Cluster": "#/components/schemas/StreamsClusterConnection", - "Kafka": "#/components/schemas/StreamsKafkaConnection", - "Sample": "#/components/schemas/StreamsSampleConnection" + "options" : { + "$ref" : "#/components/schemas/StreamsOptions" + }, + "pipeline" : { + "type" : "array", + "description" : "Stream aggregation pipeline you want to apply to your streaming data.", + "externalDocs" : { + "description" : "Supported Aggregation Pipeline Stages", + "url" : "https://www.mongodb.com/docs/atlas/atlas-stream-processing/stream-aggregation/#std-label-stream-aggregation" + }, + "items" : { + "$ref" : "#/components/schemas/Document" + } } }, - "oneOf": [ - { - "$ref": "#/components/schemas/StreamsSampleConnection" - }, - { - "$ref": "#/components/schemas/StreamsClusterConnection" - }, - { - "$ref": "#/components/schemas/StreamsKafkaConnection" - } - ] + "description" : "An atlas stream processor." }, - "StreamsKafkaAuthentication": { - "type": "object", - "properties": { - "password": { - "type": "string", - "description": "Password of the account to connect to the Kafka cluster.", - "format": "password", - "writeOnly": 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" + "StreamsProcessorWithStats" : { + "required" : [ "_id", "name", "pipeline", "state" ], + "type" : "object", + "properties" : { + "_id" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the stream processor.", + "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" + "items" : { + "$ref" : "#/components/schemas/Link" } }, - "mechanism": { - "type": "string", - "description": "Style of authentication. Can be one of PLAIN, SCRAM-256, or SCRAM-512." - }, - "username": { - "type": "string", - "description": "Username of the account to connect to the Kafka cluster." + "name" : { + "type" : "string", + "description" : "Human-readable name of the stream processor.", + "readOnly" : true + }, + "options" : { + "$ref" : "#/components/schemas/StreamsOptions" + }, + "pipeline" : { + "type" : "array", + "description" : "Stream aggregation pipeline you want to apply to your streaming data.", + "readOnly" : true, + "items" : { + "$ref" : "#/components/schemas/Document" + } + }, + "state" : { + "type" : "string", + "description" : "The state of the stream processor. Commonly occurring states are 'CREATED', 'STARTED', 'STOPPED' and 'FAILED'.", + "readOnly" : true + }, + "stats" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "The stats associated with the stream processor.", + "readOnly" : true, + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor" + } + }, + "description" : "The stats associated with the stream processor.", + "readOnly" : true, + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor" + } + } + }, + "description" : "An atlas stream processor with optional stats." + }, + "PaginatedApiStreamsStreamProcessorWithStatsView" : { + "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/StreamsProcessorWithStats" + } + }, + "totalCount" : { + "minimum" : 0, + "type" : "integer", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "format" : "int32", + "readOnly" : true + } + } + }, + "TenantWithSampleConnections" : { + "type" : "object" + }, + "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, + "items" : { + "$ref" : "#/components/schemas/AccessListItemView" + } + }, + "id" : { + "maxLength" : 24, + "minLength" : 24, + "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, + "items" : { + "$ref" : "#/components/schemas/CloudAccessRoleAssignment" + } + } + }, + "description" : "Details contained in one API key.", + "nullable" : true, + "readOnly" : true + }, + "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, + "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 + } + } + }, + "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.", + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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](https://docs.mongodb.com/manual/reference/command/setFeatureCompatibilityVersion) that this cluster supports.", + "readOnly" : true + }, + "managed" : { + "type" : "boolean", + "description" : "Flag that indicates whether Automation manages this cluster.", + "readOnly" : true + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that this cluster runs.", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies this cluster.", + "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 + }, + "sharded" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone configured this cluster as a sharded cluster.\n\n- If `true`, this cluster serves as a sharded cluster.\n- 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.", + "items" : { + "$ref" : "#/components/schemas/AvailableClustersDeployment" + } + }, + "migrationHosts" : { + "type" : "array", + "description" : "Hostname of MongoDB Agent list that you configured to perform a migration.", + "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" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to be migrated.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + } + } + }, + "LiveMigrationResponse" : { + "type" : "object", + "properties" : { + "_id" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the migration job.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "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, + "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.\n\n| Status | Explanation |\n|----------|-------------|\n| NEW | Someone scheduled a local cluster migration to MongoDB Atlas. |\n| FAILED | The cluster migration to MongoDB Atlas failed. |\n| COMPLETE | The cluster migration to MongoDB Atlas succeeded. |\n| 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. |\n| 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
|\n", + "readOnly" : true, + "enum" : [ "NEW", "WORKING", "FAILED", "COMPLETE", "EXPIRED" ] + } + } + }, + "LiveImportValidation" : { + "type" : "object", + "properties" : { + "_id" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the validation.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "errorMessage" : { + "type" : "string", + "description" : "Reason why the validation job failed.", + "nullable" : true, + "readOnly" : true + }, + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to validate.", + "readOnly" : true, + "example" : "32b6e34b3d91647abb20e7b8" + }, + "sourceGroupId" : { + "maxLength" : 24, + "minLength" : 24, + "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" ] + } + } + }, + "Destination" : { + "required" : [ "clusterName", "groupId", "hostnameSchemaType" ], + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Label that identifies the destination cluster." + }, + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the destination project.", + "example" : "9b43a5b329223c3a1591a678" + }, + "hostnameSchemaType" : { + "type" : "string", + "description" : "The network type to use between the migration host and the destination cluster.", + "enum" : [ "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." + }, + "LiveMigrationRequest20240530" : { + "required" : [ "destination", "source" ], + "type" : "object", + "properties" : { + "_id" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the migration request.", + "readOnly" : true, + "example" : "507f1f77bcf86cd799439011" + }, + "destination" : { + "$ref" : "#/components/schemas/Destination" + }, + "dropDestinationData" : { + "type" : "boolean", + "description" : "Flag that indicates whether the migration process drops all collections from the destination cluster before the migration starts.", + "writeOnly" : true, + "default" : false + }, + "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" + }, + "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" + } + } + } + }, + "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, + "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, + "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" : { + "type" : "string", + "description" : "Label that identifies the source cluster name." + }, + "groupId" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the source project.", + "example" : "9b43a5b329223c3a1591a678" + }, + "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." + }, + "LiveMigrationRequest" : { + "required" : [ "destination", "dropEnabled", "source" ], + "type" : "object", + "properties" : { + "_id" : { + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the migration request.", + "readOnly" : true, + "example" : "507f1f77bcf86cd799439011" + }, + "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" + } + } + }, + "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:\n- `lucene.`\n- `builtin.`\n- `mongodb.`" + }, + "charFilters" : { + "type" : "array", + "description" : "Filters that examine text one character at a time and perform filtering operations.", + "items" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/charFilterhtmlStrip" + }, { + "$ref" : "#/components/schemas/charFiltericuNormalize" + }, { + "$ref" : "#/components/schemas/charFiltermapping" + }, { + "$ref" : "#/components/schemas/charFilterpersian" + } ] + } + }, + "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:\n\n- Stemming, which reduces related words, such as \"talking\", \"talked\", and \"talks\" to their root word \"talk\".\n\n- Redaction, the removal of sensitive information from public documents.", + "items" : { + "anyOf" : [ { + "$ref" : "#/components/schemas/tokenFilterasciiFolding" + }, { + "$ref" : "#/components/schemas/tokenFilterdaitchMokotoffSoundex" + }, { + "$ref" : "#/components/schemas/tokenFilteredgeGram" + }, { + "$ref" : "#/components/schemas/TokenFilterEnglishPossessive" + }, { + "$ref" : "#/components/schemas/TokenFilterFlattenGraph" + }, { + "$ref" : "#/components/schemas/tokenFiltericuFolding" + }, { + "$ref" : "#/components/schemas/tokenFiltericuNormalizer" + }, { + "$ref" : "#/components/schemas/TokenFilterkStemming" + }, { + "$ref" : "#/components/schemas/tokenFilterlength" + }, { + "$ref" : "#/components/schemas/tokenFilterlowercase" + }, { + "$ref" : "#/components/schemas/tokenFilternGram" + }, { + "$ref" : "#/components/schemas/TokenFilterPorterStemming" + }, { + "$ref" : "#/components/schemas/tokenFilterregex" + }, { + "$ref" : "#/components/schemas/tokenFilterreverse" + }, { + "$ref" : "#/components/schemas/tokenFiltershingle" + }, { + "$ref" : "#/components/schemas/tokenFiltersnowballStemming" + }, { + "$ref" : "#/components/schemas/TokenFilterSpanishPluralStemming" + }, { + "$ref" : "#/components/schemas/TokenFilterStempel" + }, { + "$ref" : "#/components/schemas/tokenFilterstopword" + }, { + "$ref" : "#/components/schemas/tokenFiltertrim" + }, { + "$ref" : "#/components/schemas/TokenFilterWordDelimiterGraph" + } ] + } + } + }, + "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.", + "enum" : [ "htmlStrip" ] + }, + "ignoredTags" : { + "type" : "array", + "description" : "The HTML tags that you want to exclude from filtering.", + "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.", + "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.", + "enum" : [ "mapping" ] + }, + "mappings" : { + "type" : "object", + "properties" : { + "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:\n\n` : `" + } + }, + "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.", + "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.", + "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": "User credentials required to connect to a Kafka Cluster. Includes the authentication type, as well as the parameters for that authentication mode." - }, - "StreamsKafkaConnection": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/StreamsConnection" - }, - { - "type": "object", - "properties": { - "authentication": { - "$ref": "#/components/schemas/StreamsKafkaAuthentication" - }, - "bootstrapServers": { - "type": "string", - "description": "Comma separated list of server addresses." - }, - "config": { - "type": "object", - "additionalProperties": { - "type": "string", - "description": "A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.", - "example": "{\"group.protocol.type\":\"consumer\",\"debug\":\"queue, msg, protocol\"}" - }, - "description": "A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.", - "example": { - "group.protocol.type": "consumer", - "debug": "queue, msg, protocol" + "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.", + "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.", + "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.", + "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.", + "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.", + "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.", + "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.", + "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.", + "enum" : [ "asciiFolding" ] + }, + "originalTokens" : { + "type" : "string", + "description" : "Value that indicates whether to include or omit the original tokens in the output of the token filter.\n\nChoose `include` if you want to support queries on both the original tokens as well as the converted forms.\n\n Choose `omit` if you want to query only on the converted forms of the original tokens.", + "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.", + "enum" : [ "daitchMokotoffSoundex" ] + }, + "originalTokens" : { + "type" : "string", + "description" : "Value that indicates whether to include or omit the original tokens in the output of the token filter.\n\nChoose `include` if you want to support queries on both the original tokens as well as the converted forms.\n\n Choose `omit` if you want to query only on the converted forms of the original tokens.", + "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.\n\n**NOTE**: Don't use the **daitchMokotoffSoundex** token filter in:\n\n-Synonym or autocomplete mapping definitions\n- 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.", + "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**.", + "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.", + "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.", + "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.", + "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.", + "enum" : [ "icuNormalizer" ] + }, + "normalizationForm" : { + "type" : "string", + "description" : "Normalization form to apply.", + "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.", + "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.", + "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.", + "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.", + "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**.", + "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.", + "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.", + "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.", + "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.", + "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.", + "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.", + "enum" : [ "snowballStemming" ] + }, + "stemmerName" : { + "type" : "string", + "description" : "Snowball-generated stemmer to use.", + "enum" : [ "arabic", "armenian", "basque", "catalan", "danish", "dutch", "english", "finnish", "french", "german", "german2", "hungarian", "irish", "italian", "kp", "lithuanian", "lovins", "norwegian", "porter", "portuguese", "romanian", "russian", "spanish", "swedish", "turkish" ] + } + }, + "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.", + "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.", + "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.", + "enum" : [ "stopword" ] + }, + "tokens" : { + "type" : "array", + "description" : "The stop words that correspond to the tokens to remove. Value must be one or more stop words.", + "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.", + "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.", + "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.", + "items" : { + "type" : "string" } }, - "networking": { - "$ref": "#/components/schemas/StreamsKafkaNetworking" - }, - "proxyInfo": { - "$ref": "#/components/schemas/ProxyInfo" - }, - "security": { - "$ref": "#/components/schemas/StreamsKafkaSecurity" + "ignoreCase" : { + "type" : "boolean", + "description" : "Flag that indicates whether to ignore letter case sensitivity for protected words.", + "default" : true } - } - } - ] - }, - "StreamsKafkaNetworking": { - "type": "object", - "properties": { - "access": { - "$ref": "#/components/schemas/StreamsKafkaNetworkingAccess" - }, - "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" : "Object that contains options for protected words." } }, - "description": "Networking Access Type can either be 'PUBLIC' (default) or VPC. VPC type is in public preview, please file a support ticket to enable VPC Network Access" + "description" : "Filter that splits tokens into sub-tokens based on configured rules." }, - "StreamsKafkaNetworkingAccess": { - "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" + "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" } }, - "name": { - "type": "string", - "description": "Id of the vpc peer when the type is VPC." - }, - "type": { - "title": "Networking Access Type", - "type": "string", - "description": "Selected networking type. Either PUBLIC or VPC. Defaults to PUBLIC", - "enum": ["PUBLIC", "VPC"] - } - }, - "description": "Information about the networking access." - }, - "StreamsKafkaSecurity": { - "type": "object", - "properties": { - "brokerPublicCertificate": { - "type": "string", - "description": "A trusted, public x509 certificate for connecting to Kafka over SSL." - }, - "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" + "stores" : { + "type" : "array", + "description" : "Array that contains the data stores for the data lake.", + "items" : { + "$ref" : "#/components/schemas/DataLakeStoreSettings" } - }, - "protocol": { - "type": "string", - "description": "Describes the transport type. Can be either PLAINTEXT or SSL." } }, - "description": "Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use." - }, - "StreamsSampleConnection": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/StreamsConnection" - } - ] - }, - "ApiStreamsAWSRegionView": { - "type": "string", - "description": "Atlas Streams AWS Regions.", - "enum": ["VIRGINIA_USA"] - }, - "BaseStreamsRegion": { - "type": "object", - "description": "Name of the cloud provider region hosting Atlas Stream Processing.", - "oneOf": [ - { - "$ref": "#/components/schemas/ApiStreamsAWSRegionView" - } - ] - }, - "StreamConfig": { - "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" - } - }, - "tier": { - "title": "Stream Instance Tier", - "type": "string", - "description": "Selected tier for the Stream Instance. Configures Memory / VCPU allowances.", - "enum": ["SP30", "SP10"] - } - }, - "description": "Configuration options for an Atlas Stream Processing Instance.", - "nullable": true - }, - "StreamsDataProcessRegion": { - "required": ["cloudProvider", "region"], - "type": "object", - "properties": { - "cloudProvider": { - "type": "string", - "description": "Label that identifies the cloud service provider where MongoDB Cloud performs stream processing. Currently, this parameter supports AWS only.", - "enum": ["AWS", "GCP", "AZURE", "TENANT", "SERVERLESS"] - }, - "region": { - "$ref": "#/components/schemas/BaseStreamsRegion" - }, - "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": "Information about the cloud provider region in which MongoDB Cloud processes the stream." - }, - "StreamsTenant": { - "type": "object", - "properties": { - "_id": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal character string that identifies the project.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "connections": { - "type": "array", - "description": "List of connections configured in the stream instance.", - "readOnly": true, - "items": { - "$ref": "#/components/schemas/StreamsConnection" - } - }, - "dataProcessRegion": { - "$ref": "#/components/schemas/StreamsDataProcessRegion" - }, - "groupId": { - "maxLength": 24, - "minLength": 24, - "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 stream instance.", - "readOnly": true, - "items": { - "type": "string", - "description": "Unique hostname assigned to the stream instance.", - "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" - } - }, - "name": { - "type": "string", - "description": "Human-readable label that identifies the stream instance." - }, - "streamConfig": { - "$ref": "#/components/schemas/StreamConfig" - } - } - }, - "PaginatedApiStreamsConnectionView": { - "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 providers when completing this request.", - "readOnly": true, - "items": { - "$ref": "#/components/schemas/StreamsConnection" - } - }, - "totalCount": { - "minimum": 0, - "type": "integer", - "description": "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", - "format": "int32", - "readOnly": true - } - } + "description" : "Configuration information for each data store and its mapping to MongoDB Cloud databases." }, - "PaginatedApiStreamsTenantView": { - "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 providers when completing this request.", - "readOnly": true, - "items": { - "$ref": "#/components/schemas/StreamsTenant" + "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" } }, - "totalCount": { - "minimum": 0, - "type": "integer", - "description": "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", - "format": "int32", - "readOnly": true - } - } - }, - "Document": { - "type": "object", - "additionalProperties": { - "type": "object", - "description": "The stats associated with the stream processor.", - "readOnly": true - }, - "description": "The stats associated with the stream processor.", - "readOnly": true - }, - "StreamsDLQ": { - "type": "object", - "properties": { - "coll": { - "type": "string", - "description": "Name of the collection that will be used for the DLQ." - }, - "connectionName": { - "type": "string", - "description": "Connection name that will be used to write DLQ messages to. Has to be an Atlas connection." - }, - "db": { - "type": "string", - "description": "Name of the database that will be used for the DLQ." - }, - "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": "Dead letter queue for the stream processor." - }, - "StreamsOptions": { - "type": "object", - "properties": { - "dlq": { - "$ref": "#/components/schemas/StreamsDLQ" - }, - "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": "Optional configuration for the stream processor." - }, - "StreamsProcessor": { - "type": "object", - "properties": { - "_id": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal character string that identifies the stream processor.", - "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 name of the stream processor." + "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 }, - "options": { - "$ref": "#/components/schemas/StreamsOptions" - }, - "pipeline": { - "type": "array", - "description": "Stream aggregation pipeline you want to apply to your streaming data.", - "items": { - "$ref": "#/components/schemas/Document" - } - } - }, - "description": "An atlas stream processor." - }, - "StreamsProcessorWithStats": { - "required": ["_id", "name", "pipeline", "state"], - "type": "object", - "properties": { - "_id": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal character string that identifies the stream processor.", - "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 name of the stream processor.", - "readOnly": true - }, - "pipeline": { - "type": "array", - "description": "Stream aggregation pipeline you want to apply to your streaming data.", - "readOnly": true, - "items": { - "$ref": "#/components/schemas/Document" - } - }, - "state": { - "type": "string", - "description": "The state of the stream processor.", - "readOnly": true - }, - "stats": { - "type": "object", - "additionalProperties": { - "type": "object", - "description": "The stats associated with the stream processor.", - "readOnly": true - }, - "description": "The stats associated with the stream processor.", - "readOnly": true - } - }, - "description": "An atlas stream processor with optional stats." - }, - "PaginatedApiStreamsStreamProcessorWithStatsView": { - "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 providers when completing this request.", - "readOnly": true, - "items": { - "$ref": "#/components/schemas/StreamsProcessorWithStats" - } - }, - "totalCount": { - "minimum": 0, - "type": "integer", - "description": "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", - "format": "int32", - "readOnly": true - } - } - }, - "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, - "items": { - "$ref": "#/components/schemas/AccessListItemView" - } - }, - "id": { - "maxLength": 24, - "minLength": 24, - "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, - "items": { - "$ref": "#/components/schemas/CloudAccessRoleAssignment" - } - } - }, - "description": "Details contained in one API key.", - "nullable": true, - "readOnly": true - }, - "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, - "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 - } - } - }, - "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.", - "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": { - "maxLength": 24, - "minLength": 24, - "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](https://docs.mongodb.com/manual/reference/command/setFeatureCompatibilityVersion) that this cluster supports.", - "readOnly": true - }, - "managed": { - "type": "boolean", - "description": "Flag that indicates whether Automation manages this cluster.", - "readOnly": true - }, - "mongoDBVersion": { - "type": "string", - "description": "Version of MongoDB that this cluster runs.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "Human-readable label that identifies this cluster.", - "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 - }, - "sharded": { - "type": "boolean", - "description": "Flag that indicates whether someone configured this cluster as a sharded cluster.\n\n- If `true`, this cluster serves as a sharded cluster.\n- 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.", - "items": { - "$ref": "#/components/schemas/AvailableClustersDeployment" - } - }, - "migrationHosts": { - "type": "array", - "description": "Hostname of MongoDB Agent list that you configured to perform a migration.", - "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": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the project to be migrated.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - } - } - }, - "LiveMigrationResponse": { - "type": "object", - "properties": { - "_id": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the migration job.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "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, - "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.\n\n| Status | Explanation |\n|----------|-------------|\n| NEW | Someone scheduled a local cluster migration to MongoDB Atlas. |\n| FAILED | The cluster migration to MongoDB Atlas failed. |\n| COMPLETE | The cluster migration to MongoDB Atlas succeeded. |\n| 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. |\n| 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
|\n", - "readOnly": true, - "enum": ["NEW", "WORKING", "FAILED", "COMPLETE", "EXPIRED"] - } - } - }, - "LiveImportValidation": { - "type": "object", - "properties": { - "_id": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the validation.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "errorMessage": { - "type": "string", - "description": "Reason why the validation job failed.", - "nullable": true, - "readOnly": true - }, - "groupId": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the project to validate.", - "readOnly": true, - "example": "32b6e34b3d91647abb20e7b8" - }, - "sourceGroupId": { - "maxLength": 24, - "minLength": 24, - "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"] - } - } - }, - "Destination": { - "required": ["clusterName", "groupId", "hostnameSchemaType"], - "type": "object", - "properties": { - "clusterName": { - "type": "string", - "description": "Label that identifies the destination cluster." - }, - "groupId": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the destination project.", - "example": "9b43a5b329223c3a1591a678" - }, - "hostnameSchemaType": { - "type": "string", - "description": "The network type to use between the migration host and the destination cluster.", - "default": "PUBLIC", - "enum": ["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." - }, - "LiveMigrationRequest20240530": { - "required": ["destination", "source"], - "type": "object", - "properties": { - "_id": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the migration request.", - "readOnly": true, - "example": "507f1f77bcf86cd799439011" - }, - "destination": { - "$ref": "#/components/schemas/Destination" - }, - "dropDestinationData": { - "type": "boolean", - "description": "Flag that indicates whether the migration process drops all collections from the destination cluster before the migration starts.", - "writeOnly": true, - "default": false - }, - "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" - }, - "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" - } - } - } - }, - "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, - "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, - "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": { - "type": "string", - "description": "Label that identifies the source cluster name." - }, - "groupId": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the source project.", - "example": "9b43a5b329223c3a1591a678" - }, - "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." - }, - "LiveMigrationRequest": { - "required": ["destination", "dropEnabled", "source"], - "type": "object", - "properties": { - "_id": { - "maxLength": 24, - "minLength": 24, - "pattern": "^([a-f0-9]{24})$", - "type": "string", - "description": "Unique 24-hexadecimal digit string that identifies the migration request.", - "readOnly": true, - "example": "507f1f77bcf86cd799439011" - }, - "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" - } - } - }, - "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:\n- `lucene.`\n- `builtin.`\n- `mongodb.`" - }, - "charFilters": { - "type": "array", - "description": "Filters that examine text one character at a time and perform filtering operations.", - "items": { - "type": "object", - "oneOf": [ - { - "$ref": "#/components/schemas/charFilterhtmlStrip" - }, - { - "$ref": "#/components/schemas/charFiltericuNormalize" - }, - { - "$ref": "#/components/schemas/charFiltermapping" - }, - { - "$ref": "#/components/schemas/charFilterpersian" - } - ] - } - }, - "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" - } - ] + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the database to which the data lake maps data." }, - "tokenFilters": { - "type": "array", - "description": "Filter that performs operations such as:\n\n- Stemming, which reduces related words, such as \"talking\", \"talked\", and \"talks\" to their root word \"talk\".\n\n- Redaction, the removal of sensitive information from public documents.", - "items": { - "anyOf": [ - { - "$ref": "#/components/schemas/tokenFilterasciiFolding" - }, - { - "$ref": "#/components/schemas/tokenFilterdaitchMokotoffSoundex" - }, - { - "$ref": "#/components/schemas/tokenFilteredgeGram" - }, - { - "$ref": "#/components/schemas/TokenFilterEnglishPossessive" - }, - { - "$ref": "#/components/schemas/TokenFilterFlattenGraph" - }, - { - "$ref": "#/components/schemas/tokenFiltericuFolding" - }, - { - "$ref": "#/components/schemas/tokenFiltericuNormalizer" - }, - { - "$ref": "#/components/schemas/TokenFilterkStemming" - }, - { - "$ref": "#/components/schemas/tokenFilterlength" - }, - { - "$ref": "#/components/schemas/tokenFilterlowercase" - }, - { - "$ref": "#/components/schemas/tokenFilternGram" - }, - { - "$ref": "#/components/schemas/TokenFilterPorterStemming" - }, - { - "$ref": "#/components/schemas/tokenFilterregex" - }, - { - "$ref": "#/components/schemas/tokenFilterreverse" - }, - { - "$ref": "#/components/schemas/tokenFiltershingle" - }, - { - "$ref": "#/components/schemas/tokenFiltersnowballStemming" - }, - { - "$ref": "#/components/schemas/TokenFilterSpanishPluralStemming" - }, - { - "$ref": "#/components/schemas/TokenFilterStempel" - }, - { - "$ref": "#/components/schemas/tokenFilterstopword" - }, - { - "$ref": "#/components/schemas/tokenFiltertrim" - }, - { - "$ref": "#/components/schemas/TokenFilterWordDelimiterGraph" - } - ] + "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": "Settings that describe one Atlas Search custom analyzer." + "description" : "Database associated with this data lake. Databases contain collections and views." }, - "charFilterhtmlStrip": { - "title": "htmlStrip", - "required": ["type"], - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "Human-readable label that identifies this character filter type.", - "enum": ["htmlStrip"] - }, - "ignoredTags": { - "type": "array", - "description": "The HTML tags that you want to exclude from filtering.", - "items": { - "type": "string" + "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" } - } - }, - "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.", - "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.", - "enum": ["mapping"] }, - "mappings": { - "type": "object", - "properties": { - "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:\n\n` : `" + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection to which MongoDB Cloud maps the data in the data stores." } }, - "description": "Filter that applies normalization mappings that you specify to characters." + "description" : "A collection and data sources that map to a ``stores`` data store." }, - "charFilterpersian": { - "title": "persian", - "required": ["type"], - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "Human-readable label that identifies this character filter type.", - "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.", - "enum": ["edgeGram"] + "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 }, - "minGram": { - "type": "integer", - "description": "Characters to include in the shortest token that Atlas Search creates." + "collection" : { + "type" : "string", + "description" : "Human-readable label that identifies the collection in the database. For creating a wildcard (`*`) collection, you must omit this parameter." }, - "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.", - "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.", - "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.", - "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.", - "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.", - "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.", - "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.", - "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.", - "enum": ["asciiFolding"] - }, - "originalTokens": { - "type": "string", - "description": "Value that indicates whether to include or omit the original tokens in the output of the token filter.\n\nChoose `include` if you want to support queries on both the original tokens as well as the converted forms.\n\n Choose `omit` if you want to query only on the converted forms of the original tokens.", - "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.", - "enum": ["daitchMokotoffSoundex"] - }, - "originalTokens": { - "type": "string", - "description": "Value that indicates whether to include or omit the original tokens in the output of the token filter.\n\nChoose `include` if you want to support queries on both the original tokens as well as the converted forms.\n\n Choose `omit` if you want to query only on the converted forms of the original tokens.", - "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.\n\n**NOTE**: Don't use the **daitchMokotoffSoundex** token filter in:\n\n-Synonym or autocomplete mapping definitions\n- 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.", - "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**.", - "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.", - "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.", - "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.", - "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.", - "enum": ["icuNormalizer"] - }, - "normalizationForm": { - "type": "string", - "description": "Normalization form to apply.", - "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.", - "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.", - "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.", - "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.", - "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**.", - "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.", - "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.", - "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.", - "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.", - "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.", - "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.", - "enum": ["snowballStemming"] - }, - "stemmerName": { - "type": "string", - "description": "Snowball-generated stemmer to use.", - "enum": [ - "arabic", - "armenian", - "basque", - "catalan", - "danish", - "dutch", - "english", - "finnish", - "french", - "german", - "german2", - "hungarian", - "irish", - "italian", - "kp", - "lithuanian", - "lovins", - "norwegian", - "porter", - "portuguese", - "romanian", - "russian", - "spanish", - "swedish", - "turkish" - ] - } - }, - "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.", - "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.", - "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.", - "enum": ["stopword"] - }, - "tokens": { - "type": "array", - "description": "The stop words that correspond to the tokens to remove. Value must be one or more stop words.", - "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.", - "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.", - "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.", - "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" - } + "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)." }, - "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", - "atlas": "#/components/schemas/DataLakeAtlasStoreInstance", - "http": "#/components/schemas/DataLakeHTTPStore", - "azure": "#/components/schemas/DataLakeAzureBlobStore" - } - }, - "oneOf": [ - { - "$ref": "#/components/schemas/DataLakeS3StoreSettings" - }, - { - "$ref": "#/components/schemas/DataLakeDLSAWSStore" - }, - { - "$ref": "#/components/schemas/DataLakeDLSAzureStore" - }, - { - "$ref": "#/components/schemas/DataLakeAtlasStoreInstance" - }, - { - "$ref": "#/components/schemas/DataLakeHTTPStore" - }, - { - "$ref": "#/components/schemas/DataLakeAzureBlobStore" - } - ] - }, - "DataLakeS3StoreSettings": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/DataLakeStoreSettings" + "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." }, - { - "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" + "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)." }, - "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" + "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", + "atlas" : "#/components/schemas/DataLakeAtlasStoreInstance", + "http" : "#/components/schemas/DataLakeHTTPStore", + "azure" : "#/components/schemas/DataLakeAzureBlobStore" + } + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/DataLakeS3StoreSettings" + }, { + "$ref" : "#/components/schemas/DataLakeDLSAWSStore" + }, { + "$ref" : "#/components/schemas/DataLakeDLSAzureStore" + }, { + "$ref" : "#/components/schemas/DataLakeAtlasStoreInstance" + }, { + "$ref" : "#/components/schemas/DataLakeHTTPStore" + }, { + "$ref" : "#/components/schemas/DataLakeAzureBlobStore" + } ] + }, + "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 }, - "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/" + "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." }, - "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." - } + "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." - } + "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." } } - ] + } ] } }, - "responses": { - "accepted": { - "description": "Accepted." + "responses" : { + "accepted" : { + "description" : "Accepted." }, - "badRequest": { - "description": "Bad Request.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiError" + "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." + "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" + "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" + "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" + "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" + "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." + "noBody" : { + "description" : "This endpoint does not return a response body." }, - "unauthorized": { - "description": "Unauthorized.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiError" + "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)" + "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" + "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." + "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" + "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)" + "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" + "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)" + "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" + "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)" + "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)" } } } }, - "internalServerError": { - "description": "Internal Server Error.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiError" + "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)" + "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", - "example": false, - "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", - "example": false, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 20, - "minLength": 20, - "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.\n\n**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": { - "maxLength": 24, - "minLength": 24, - "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": { - "maxLength": 24, - "minLength": 24, - "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", - "example": true, - "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", - "example": 100, - "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", - "example": 1, - "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": { - "DigestAuth": { - "type": "http", - "scheme": "digest" + }, + "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", + "example" : false, + "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", + "example" : false, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 20, + "minLength" : 20, + "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.\n\n**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" : { + "maxLength" : 24, + "minLength" : 24, + "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" : { + "maxLength" : 24, + "minLength" : 24, + "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", + "example" : true, + "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", + "example" : 100, + "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", + "example" : 1, + "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" : { + "DigestAuth" : { + "type" : "http", + "scheme" : "digest" } } } diff --git a/tools/cli/test/data/split/dev/openapi-v2-2023-01-01.json b/tools/cli/test/data/split/dev/openapi-v2-2023-01-01.json index 2269499285..9e6c526bbc 100644 --- a/tools/cli/test/data/split/dev/openapi-v2-2023-01-01.json +++ b/tools/cli/test/data/split/dev/openapi-v2-2023-01-01.json @@ -1,7 +1,7 @@ { "openapi" : "3.0.1", "info" : { - "description" : "The MongoDB Atlas Administration API allows developers to manage all components in MongoDB Atlas.\n\nThe Atlas Administration API uses HTTP Digest Authentication to authenticate requests. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request. For example, to [return database access history](#tag/Access-Tracking/operation/listAccessLogsByClusterName) with [cURL](https://en.wikipedia.org/wiki/CURL), run the following command in the terminal:\n\n```\ncurl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true\"\n```\n\nTo learn more, see [Get Started with the Atlas Administration API](https://www.mongodb.com/docs/atlas/configure-api-access/). For support, see [MongoDB Support](https://www.mongodb.com/support/get-started).", + "description" : "The MongoDB Atlas Administration API allows developers to manage all components in MongoDB Atlas.\n\nThe Atlas Administration API uses HTTP Digest Authentication to authenticate requests. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request. For example, to [return database access history](#tag/Access-Tracking/operation/listAccessLogsByClusterName) with [cURL](https://en.wikipedia.org/wiki/CURL), run the following command in the terminal:\n\n```\ncurl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true\"\n```\n\nTo learn more, see [Get Started with the Atlas Administration API](https://www.mongodb.com/docs/atlas/configure-api-access/). For support, see [MongoDB Support](https://www.mongodb.com/support/get-started).\n\nYou can also explore the various endpoints available through the Atlas Administration API in MongoDB's [Postman workspace](https://www.postman.com/mongodb-devrel/workspace/mongodb-atlas-administration-apis/).", "license" : { "name" : "CC BY-NC-SA 3.0 US", "url" : "https://creativecommons.org/licenses/by-nc-sa/3.0/us/" @@ -9,7 +9,7 @@ "termsOfService" : "https://www.mongodb.com/mongodb-management-service-terms-and-conditions", "title" : "MongoDB Atlas Administration API", "version" : "2.0", - "x-xgen-sha" : "09d9d18db2111c955a8e01702a27ca2763417782" + "x-xgen-sha" : "e6ba3136dbd0be2a81dd4ed21b9e6c470edd4420" }, "servers" : [ { "url" : "https://cloud.mongodb.com" @@ -57,7 +57,11 @@ "description" : "Returns, adds, edits, and removes Federated Database Instances. This resource requires your project ID. Changes to federated database instance configurations can affect costs.", "name" : "Data Federation" }, { - "description" : "Returns, adds, edits, and removes Atlas Data Lake Pipelines and associated runs.", + "description" : "Returns, edits, and removes Atlas Data Lake Pipelines and associated runs.", + "externalDocs" : { + "description" : "Data Lake Pipelines are deprecated. Please see Data Lake Deprecation Guide.", + "url" : "https://dochub.mongodb.org/core/data-lake-deprecation" + }, "name" : "Data Lake Pipelines" }, { "description" : "Returns, adds, edits, and removes database users.", @@ -119,6 +123,9 @@ }, { "description" : "You can continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket. Atlas exports logs every 5 minutes.", "name" : "Push-Based Log Export" + }, { + "description" : "Configure and manage Atlas Resource Policies within your organization.", + "name" : "Resource Policies" }, { "description" : "Creates one index to a database deployment in a rolling manner. You can't create a rolling index on an `M0` free cluster or `M2/M5` shared cluster.", "name" : "Rolling Index" @@ -135,6 +142,13 @@ "url" : "https://dochub.mongodb.org/core/serverless-private-endpoint" }, "name" : "Serverless Private Endpoints" + }, { + "description" : "Endpoints for managing Service Accounts and secrets. Service Accounts are used for programmatic access to the Atlas Admin API through the OAuth 2.0 Client Credentials flow. This feature is available as a Preview feature.", + "externalDocs" : { + "description" : "Get Started with the Atlas Administration API", + "url" : "https://www.mongodb.com/docs/atlas/configure-api-access/" + }, + "name" : "Service Accounts" }, { "description" : "Returns and adds restore jobs for shared-tier database deployments.", "name" : "Shared-Tier Restore Jobs" @@ -2672,7 +2686,7 @@ "/api/atlas/v2/groups/{groupId}/backup/exportBuckets" : { "get" : { "deprecated" : true, - "description" : "Returns all AWS S3 buckets and Azure Blob Storage Containers associated with the specified Project. To use this resource, the requesting API Key must have the Project Read Only role.", + "description" : "Returns all Export Buckets associated with the specified Project. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "listExportBuckets", "parameters" : [ { "$ref" : "#/components/parameters/envelope" @@ -2709,13 +2723,13 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Return All AWS S3 Buckets and Azure Blob Storage Containers Used for Cloud Backup Snapshot Exports", + "summary" : "Return All Snapshot Export Buckets", "tags" : [ "Cloud Backups" ], - "x-sunset" : "2025-05-30" + "x-sunset" : "2026-05-30" }, "post" : { "deprecated" : true, - "description" : "Grants MongoDB Cloud access to the specified AWS S3 Bucket or Azure Blob Storage Container. This enables this Export Bucket to receive Atlas Cloud Backup Snapshots. To use this resource, the requesting API Key must have the Project Owner role.", + "description" : "Creates a Snapshot Export Bucket for an AWS S3 Bucket or Azure Blob Storage Container. Once created, an snapshots can be exported to the Export Bucket and its referenced AWS S3 Bucket or Azure Blob Storage Container. To use this resource, the requesting API Key must have the Project Owner role.", "operationId" : "createExportBucket", "parameters" : [ { "$ref" : "#/components/parameters/envelope" @@ -2734,7 +2748,7 @@ "x-xgen-version" : "2023-01-01" } }, - "description" : "Grants MongoDB Cloud access to the specified AWS S3 Bucket or Azure Blob Storage Container.", + "description" : "Specifies the role and AWS S3 Bucket or Azure Blob Storage Container that the Export Bucket should reference.", "required" : true }, "responses" : { @@ -2765,21 +2779,21 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Grant Access to AWS S3 Bucket or Azure Blob Storage Container for Cloud Backup Snapshot Exports", + "summary" : "Create One Snapshot Export Bucket", "tags" : [ "Cloud Backups" ], - "x-sunset" : "2025-05-30" + "x-sunset" : "2026-05-30" } }, "/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}" : { "delete" : { - "description" : "Revoke MongoDB Cloud access to the specified AWS S3 Bucket or Azure Blob Storage Container. This prevents this Export Bucket from receiving Atlas Cloud Backup Snapshots. 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 API Key must have the Project Owner role.", + "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 API Key must have the Project Owner role.", "operationId" : "deleteExportBucket", "parameters" : [ { "$ref" : "#/components/parameters/envelope" }, { "$ref" : "#/components/parameters/groupId" }, { - "description" : "Unique string that identifies the AWS S3 Bucket or Azure Blob Storage Container to which you export your Snapshots.", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", "in" : "path", "name" : "exportBucketId", "required" : true, @@ -2819,12 +2833,12 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Revoke Access to AWS S3 Bucket or Azure Blob Storage Container for Cloud Backup Snapshot Exports", + "summary" : "Delete One Snapshot Export Bucket", "tags" : [ "Cloud Backups" ] }, "get" : { "deprecated" : true, - "description" : "Returns one AWS S3 Bucket or Azure Blob Storage Container associated with the specified Project. To use this resource, the requesting API Key must have the Project Read Only role.", + "description" : "Returns one Export Bucket associated with the specified Project. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "getExportBucket", "parameters" : [ { "$ref" : "#/components/parameters/envelope" @@ -2868,9 +2882,9 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Return One AWS S3 Bucket or Azure Blob Storage Container Used for Cloud Backup Snapshot Exports", + "summary" : "Return One Snapshot Export Bucket", "tags" : [ "Cloud Backups" ], - "x-sunset" : "2025-05-30" + "x-sunset" : "2026-05-30" } }, "/api/atlas/v2/groups/{groupId}/backupCompliancePolicy" : { @@ -2912,7 +2926,7 @@ } ], "summary" : "Return the Backup Compliance Policy settings", "tags" : [ "Cloud Backups" ], - "x-sunset" : "2024-10-01" + "x-sunset" : "2026-10-01" }, "put" : { "deprecated" : true, @@ -2976,7 +2990,7 @@ } ], "summary" : "Update or enable the Backup Compliance Policy settings", "tags" : [ "Cloud Backups" ], - "x-sunset" : "2024-10-01" + "x-sunset" : "2025-10-01" } }, "/api/atlas/v2/groups/{groupId}/cloudProviderAccess" : { @@ -3033,7 +3047,7 @@ "content" : { "application/vnd.atlas.2023-01-01+json" : { "schema" : { - "$ref" : "#/components/schemas/CloudProviderAccessRole" + "$ref" : "#/components/schemas/CloudProviderAccessRoleRequest" } } }, @@ -3083,7 +3097,7 @@ "required" : true, "schema" : { "type" : "string", - "enum" : [ "AWS" ] + "enum" : [ "AWS", "AZURE", "GCP" ] } }, { "description" : "Unique 24-hexadecimal digit string that identifies the role.", @@ -3171,7 +3185,7 @@ "tags" : [ "Cloud Provider Access" ] }, "patch" : { - "description" : "Grants access to the specified project for the specified access role. To use this resource, the requesting API Key must have the Project Owner role. This API endpoint is one step in a procedure to create unified access for MongoDB Cloud services.", + "description" : "Grants access to the specified project for the specified access role. To use this resource, the requesting API Key must have the Project Owner role. This API endpoint is one step in a procedure to create unified access for MongoDB Cloud services. 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/" @@ -3199,7 +3213,7 @@ "content" : { "application/vnd.atlas.2023-01-01+json" : { "schema" : { - "$ref" : "#/components/schemas/CloudProviderAccessRole" + "$ref" : "#/components/schemas/CloudProviderAccessRoleRequestUpdate" } } }, @@ -3551,7 +3565,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster.", @@ -3612,7 +3626,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -3666,7 +3680,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -3718,7 +3732,7 @@ }, "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports" : { "get" : { - "description" : "Returns all Cloud Backup snapshot export jobs associated with the specified Atlas cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role.", + "description" : "Returns all Cloud Backup Snapshot Export Jobs associated with the specified Atlas cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role.", "operationId" : "listBackupExportJobs", "parameters" : [ { "$ref" : "#/components/parameters/envelope" @@ -3741,7 +3755,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -3766,11 +3780,11 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Return All Cloud Backup Snapshot Export Jobs", + "summary" : "Return All Snapshot Export Jobs", "tags" : [ "Cloud Backups" ] }, "post" : { - "description" : "Exports one backup snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. To use this resource, the requesting API Key must have the Project Atlas Admin role.", + "description" : "Exports one backup Snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. To use this resource, the requesting API Key must have the Project Atlas Admin role.", "operationId" : "createBackupExportJob", "parameters" : [ { "$ref" : "#/components/parameters/envelope" @@ -3785,7 +3799,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -3830,13 +3844,13 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Create One Cloud Backup Snapshot Export Job", + "summary" : "Create One Snapshot Export Job", "tags" : [ "Cloud Backups" ] } }, "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}" : { "get" : { - "description" : "Returns one Cloud Backup snapshot export job associated with the specified Atlas cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role.", + "description" : "Returns one Cloud Backup Snapshot Export Job associated with the specified Atlas cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role.", "operationId" : "getBackupExportJob", "parameters" : [ { "$ref" : "#/components/parameters/envelope" @@ -3851,15 +3865,19 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { - "description" : "Unique string that identifies the export job to return.", + "description" : "Unique 24-hexadecimal character string that identifies the Export Job.", "in" : "path", "name" : "exportId", "required" : true, "schema" : { - "type" : "string" + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" } } ], "responses" : { @@ -3884,7 +3902,7 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Return One Cloud Backup Snapshot Export Job", + "summary" : "Return One Snapshot Export Job", "tags" : [ "Cloud Backups" ] } }, @@ -3913,7 +3931,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -3959,7 +3977,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -4027,7 +4045,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the restore job to remove.", @@ -4087,7 +4105,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the restore job to return.", @@ -4145,7 +4163,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -4175,7 +4193,7 @@ } ], "summary" : "Remove All Cloud Backup Schedules", "tags" : [ "Cloud Backups" ], - "x-sunset" : "2025-08-05" + "x-sunset" : "2026-05-30" }, "get" : { "deprecated" : true, @@ -4196,7 +4214,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -4223,7 +4241,7 @@ } ], "summary" : "Return One Cloud Backup Schedule", "tags" : [ "Cloud Backups" ], - "x-sunset" : "2025-08-05" + "x-sunset" : "2026-05-30" }, "patch" : { "deprecated" : true, @@ -4244,7 +4262,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -4285,7 +4303,7 @@ } ], "summary" : "Update Cloud Backup Schedule for One Cluster", "tags" : [ "Cloud Backups" ], - "x-sunset" : "2025-08-05" + "x-sunset" : "2026-05-30" } }, "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots" : { @@ -4313,7 +4331,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -4362,7 +4380,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -4424,7 +4442,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -4481,7 +4499,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -4543,7 +4561,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -4594,7 +4612,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -4654,7 +4672,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -4714,7 +4732,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -4781,7 +4799,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "$ref" : "#/components/parameters/envelope" @@ -4852,7 +4870,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "$ref" : "#/components/parameters/envelope" @@ -4920,7 +4938,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "$ref" : "#/components/parameters/envelope" @@ -4971,7 +4989,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "$ref" : "#/components/parameters/envelope" @@ -5039,7 +5057,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -5090,7 +5108,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -5159,7 +5177,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -5219,7 +5237,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -5278,7 +5296,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -5349,7 +5367,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Name of the collection that contains one or more Atlas Search indexes.", @@ -5422,7 +5440,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the Atlas Search index. Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes.", @@ -5488,7 +5506,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "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.", @@ -5551,7 +5569,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "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.", @@ -5633,7 +5651,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -5687,7 +5705,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -5739,7 +5757,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -5805,7 +5823,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "$ref" : "#/components/parameters/groupId" @@ -5876,7 +5894,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -5946,7 +5964,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -6100,7 +6118,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -6150,7 +6168,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -6243,7 +6261,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Flag that indicates whether to download logs for queries against your online archive only or both your online archive and cluster.", @@ -6322,7 +6340,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -6386,7 +6404,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -6453,7 +6471,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -6525,7 +6543,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -6581,7 +6599,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -6637,7 +6655,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -6704,7 +6722,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -6759,7 +6777,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -6827,7 +6845,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -6890,7 +6908,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -6940,7 +6958,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -7003,7 +7021,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", @@ -7066,7 +7084,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -7117,7 +7135,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -7168,7 +7186,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -7233,7 +7251,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -7300,7 +7318,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -7347,7 +7365,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -7413,7 +7431,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Human-readable label that specifies whether to return only completed, incomplete, or all snapshots. By default, MongoDB Cloud only returns completed snapshots.", @@ -7471,7 +7489,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -7532,7 +7550,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -7590,7 +7608,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -7660,7 +7678,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -7721,7 +7739,7 @@ } } }, { - "description" : "Date and time when the period specifies the inclusive ending point for the range of log messages to retrieve. This parameter expresses its value in the number of seconds that have elapsed since the UNIX epoch.", + "description" : "Specifies the date and time for the ending point of the range of log messages to retrieve, in the number of seconds that have elapsed since the UNIX epoch. This value will default to 24 hours after the start date. If the start date is also unspecified, the value will default to the time of the request.", "in" : "query", "name" : "endDate", "schema" : { @@ -7730,7 +7748,7 @@ "minimum" : 1199145600 } }, { - "description" : "Date and time when the period specifies the inclusive starting point for the range of log messages to retrieve. This parameter expresses its value in the number of seconds that have elapsed since the UNIX epoch.", + "description" : "Specifies the date and time for the starting point of the range of log messages to retrieve, in the number of seconds that have elapsed since the UNIX epoch. This value will default to 24 hours prior to the end date. If the end date is also unspecified, the value will default to 24 hours prior to the time of the request.", "in" : "query", "name" : "startDate", "schema" : { @@ -9498,7 +9516,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Date and time when to stop retrieving database history. If you specify **end**, you must also specify **start**. This parameter uses UNIX epoch time in milliseconds.", @@ -9761,6 +9779,12 @@ "$ref" : "#/components/parameters/pretty" }, { "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" }, { "description" : "Human-readable label that identifies the cloud provider for the private endpoints to return.", "in" : "path", @@ -9883,17 +9907,6 @@ "pattern" : "^([a-f0-9]{24})$" } } ], - "requestBody" : { - "content" : { - "application/vnd.atlas.2023-01-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/EncryptionAtRestPrivateEndpointRequest" - } - } - }, - "description" : "Cloud provider of the private endpoints to delete and the list of cloud provider regions in which to delete the private endpoints.", - "required" : true - }, "responses" : { "204" : { "content" : { @@ -9964,6 +9977,9 @@ "403" : { "$ref" : "#/components/responses/forbidden" }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, "500" : { "$ref" : "#/components/responses/internalServerError" } @@ -10001,7 +10017,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, "style" : "form" @@ -10719,7 +10735,7 @@ } ], "summary" : "Return All Project Invitations", "tags" : [ "Projects" ], - "x-sunset" : "2024-10-04" + "x-sunset" : "2024-11-04" }, "patch" : { "deprecated" : true, @@ -10773,7 +10789,7 @@ } ], "summary" : "Update One Project Invitation", "tags" : [ "Projects" ], - "x-sunset" : "2024-10-04" + "x-sunset" : "2024-11-04" }, "post" : { "deprecated" : true, @@ -10821,7 +10837,7 @@ } ], "summary" : "Invite One MongoDB Cloud User to Join One Project", "tags" : [ "Projects" ], - "x-sunset" : "2024-10-04" + "x-sunset" : "2024-11-04" } }, "/api/atlas/v2/groups/{groupId}/invites/{invitationId}" : { @@ -10869,7 +10885,7 @@ } ], "summary" : "Cancel One Project Invitation", "tags" : [ "Projects" ], - "x-sunset" : "2024-10-04" + "x-sunset" : "2024-11-04" }, "get" : { "deprecated" : true, @@ -10920,7 +10936,7 @@ } ], "summary" : "Return One Project Invitation", "tags" : [ "Projects" ], - "x-sunset" : "2024-10-04" + "x-sunset" : "2024-11-04" }, "patch" : { "deprecated" : true, @@ -10983,7 +10999,7 @@ } ], "summary" : "Update One Project Invitation by Invitation ID", "tags" : [ "Projects" ], - "x-sunset" : "2024-10-04" + "x-sunset" : "2024-11-04" } }, "/api/atlas/v2/groups/{groupId}/ipAddresses" : { @@ -11080,13 +11096,13 @@ "description" : "Removes the specified project limit. Depending on the limit, Atlas either resets the limit to its default value or removes the limit entirely. To use this resource, the requesting API Key must have the Project Owner role.", "operationId" : "deleteProjectLimit", "parameters" : [ { - "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", + "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| 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 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n| atlas.project.deployment.salesSoldM0s | Limit on the number of M0 clusters in this project if the org is sales-sold | 100 | 100 |\n", "in" : "path", "name" : "limitName", "required" : true, "schema" : { "type" : "string", - "enum" : [ "atlas.project.security.databaseAccess.users", "atlas.project.deployment.clusters", "atlas.project.deployment.serverlessMTMs", "atlas.project.security.databaseAccess.customRoles", "atlas.project.security.networkAccess.entries", "atlas.project.security.networkAccess.crossRegionEntries", "atlas.project.deployment.nodesPerPrivateLinkRegion", "dataFederation.bytesProcessed.query", "dataFederation.bytesProcessed.daily", "dataFederation.bytesProcessed.weekly", "dataFederation.bytesProcessed.monthly", "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", "atlas.project.deployment.privateServiceConnectionsSubnetMask" ] + "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" @@ -11130,13 +11146,13 @@ "description" : "Returns the specified limit for the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "getProjectLimit", "parameters" : [ { - "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", + "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| 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 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n| atlas.project.deployment.salesSoldM0s | Limit on the number of M0 clusters in this project if the org is sales-sold | 100 | 100 |\n", "in" : "path", "name" : "limitName", "required" : true, "schema" : { "type" : "string", - "enum" : [ "atlas.project.security.databaseAccess.users", "atlas.project.deployment.clusters", "atlas.project.deployment.serverlessMTMs", "atlas.project.security.databaseAccess.customRoles", "atlas.project.security.networkAccess.entries", "atlas.project.security.networkAccess.crossRegionEntries", "atlas.project.deployment.nodesPerPrivateLinkRegion", "dataFederation.bytesProcessed.query", "dataFederation.bytesProcessed.daily", "dataFederation.bytesProcessed.weekly", "dataFederation.bytesProcessed.monthly", "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", "atlas.project.deployment.privateServiceConnectionsSubnetMask" ] + "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" @@ -11183,13 +11199,13 @@ "description" : "Sets the specified project limit. To use this resource, the requesting API Key must have the Project Owner role.\n\n**NOTE**: Increasing the following configuration limits might lead to slower response times in the MongoDB Cloud UI or increased user management overhead leading to authentication or authorization re-architecture. If possible, we recommend that you create additional projects to gain access to more of these resources for a more sustainable growth pattern.", "operationId" : "setProjectLimit", "parameters" : [ { - "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", + "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| 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 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n| atlas.project.deployment.salesSoldM0s | Limit on the number of M0 clusters in this project if the org is sales-sold | 100 | 100 |\n", "in" : "path", "name" : "limitName", "required" : true, "schema" : { "type" : "string", - "enum" : [ "atlas.project.security.databaseAccess.users", "atlas.project.deployment.clusters", "atlas.project.deployment.serverlessMTMs", "atlas.project.security.databaseAccess.customRoles", "atlas.project.security.networkAccess.entries", "atlas.project.security.networkAccess.crossRegionEntries", "atlas.project.deployment.nodesPerPrivateLinkRegion", "dataFederation.bytesProcessed.query", "dataFederation.bytesProcessed.daily", "dataFederation.bytesProcessed.weekly", "dataFederation.bytesProcessed.monthly", "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", "atlas.project.deployment.privateServiceConnectionsSubnetMask" ] + "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" @@ -12178,6 +12194,7 @@ }, "/api/atlas/v2/groups/{groupId}/pipelines" : { "get" : { + "deprecated" : true, "description" : "Returns a list of Data Lake Pipelines. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "listPipelines", "parameters" : [ { @@ -12214,10 +12231,16 @@ "DigestAuth" : [ ] } ], "summary" : "Return All Data Lake Pipelines from One Project", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" }, "post" : { + "deprecated" : true, "description" : "Creates one Data Lake Pipeline.", + "externalDocs" : { + "description" : "Data Lake Pipelines are deprecated. Please see Data Lake Deprecation Guide.", + "url" : "https://dochub.mongodb.org/core/data-lake-deprecation" + }, "operationId" : "createPipeline", "parameters" : [ { "$ref" : "#/components/parameters/envelope" @@ -12264,11 +12287,13 @@ "DigestAuth" : [ ] } ], "summary" : "Create One Data Lake Pipeline", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}" : { "delete" : { + "deprecated" : true, "description" : "Removes one Data Lake Pipeline.", "operationId" : "deletePipeline", "parameters" : [ { @@ -12313,9 +12338,11 @@ "DigestAuth" : [ ] } ], "summary" : "Remove One Data Lake Pipeline", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" }, "get" : { + "deprecated" : true, "description" : "Returns the details of one Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "getPipeline", "parameters" : [ { @@ -12362,9 +12389,11 @@ "DigestAuth" : [ ] } ], "summary" : "Return One Data Lake Pipeline", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" }, "patch" : { + "deprecated" : true, "description" : "Updates one Data Lake Pipeline.", "operationId" : "updatePipeline", "parameters" : [ { @@ -12426,11 +12455,13 @@ "DigestAuth" : [ ] } ], "summary" : "Update One Data Lake Pipeline", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules" : { "get" : { + "deprecated" : true, "description" : "Returns a list of backup schedule policy items that you can use as a Data Lake Pipeline source. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "listPipelineSchedules", "parameters" : [ { @@ -12480,11 +12511,13 @@ "DigestAuth" : [ ] } ], "summary" : "Return Available Ingestion Schedules for One Data Lake Pipeline", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots" : { "get" : { + "deprecated" : true, "description" : "Returns a list of backup snapshots that you can use to trigger an on demand pipeline run. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "listPipelineSnapshots", "parameters" : [ { @@ -12546,11 +12579,13 @@ "DigestAuth" : [ ] } ], "summary" : "Return Available Backup Snapshots for One Data Lake Pipeline", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause" : { "post" : { + "deprecated" : true, "description" : "Pauses ingestion for a Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "pausePipeline", "parameters" : [ { @@ -12597,11 +12632,13 @@ "DigestAuth" : [ ] } ], "summary" : "Pause One Data Lake Pipeline", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume" : { "post" : { + "deprecated" : true, "description" : "Resumes ingestion for a Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "resumePipeline", "parameters" : [ { @@ -12648,11 +12685,13 @@ "DigestAuth" : [ ] } ], "summary" : "Resume One Data Lake Pipeline", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs" : { "get" : { + "deprecated" : true, "description" : "Returns a list of past Data Lake Pipeline runs. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "listPipelineRuns", "parameters" : [ { @@ -12714,11 +12753,13 @@ "DigestAuth" : [ ] } ], "summary" : "Return All Data Lake Pipeline Runs from One Project", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}" : { "delete" : { + "deprecated" : true, "description" : "Deletes dataset that Atlas generated during the specified pipeline run.", "operationId" : "deletePipelineRunDataset", "parameters" : [ { @@ -12777,9 +12818,11 @@ "DigestAuth" : [ ] } ], "summary" : "Delete Pipeline Run Dataset", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" }, "get" : { + "deprecated" : true, "description" : "Returns the details of one Data Lake Pipeline run within the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "getPipelineRun", "parameters" : [ { @@ -12838,11 +12881,13 @@ "DigestAuth" : [ ] } ], "summary" : "Return One Data Lake Pipeline Run", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger" : { "post" : { + "deprecated" : true, "description" : "Triggers a Data Lake Pipeline ingestion of a specified snapshot.", "operationId" : "triggerSnapshotIngestion", "parameters" : [ { @@ -12900,7 +12945,8 @@ "DigestAuth" : [ ] } ], "summary" : "Trigger on demand snapshot ingestion", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService" : { @@ -13060,7 +13106,7 @@ "schema" : { "type" : "string", "maxLength" : 64, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -13113,7 +13159,7 @@ "schema" : { "type" : "string", "maxLength" : 64, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -13172,7 +13218,7 @@ "schema" : { "type" : "string", "maxLength" : 64, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be removed.", @@ -13229,7 +13275,7 @@ "schema" : { "type" : "string", "maxLength" : 64, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the tenant endpoint.", @@ -13286,7 +13332,7 @@ "schema" : { "type" : "string", "maxLength" : 64, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be updated.", @@ -14419,7 +14465,7 @@ "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" ] + "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" ] }, "maxItems" : 10, "minItems" : 1, @@ -14498,7 +14544,7 @@ "items" : { "type" : "string", "description" : "One measurement requested for this MongoDB process.", - "enum" : [ "ASSERT_MSG", "ASSERT_REGULAR", "ASSERT_USER", "ASSERT_WARNING", "BACKGROUND_FLUSH_AVG", "CACHE_BYTES_READ_INTO", "CACHE_BYTES_WRITTEN_FROM", "CACHE_DIRTY_BYTES", "CACHE_USED_BYTES", "COMPUTED_MEMORY", "CONNECTIONS", "CURSORS_TOTAL_OPEN", "CURSORS_TOTAL_TIMED_OUT", "DB_DATA_SIZE_TOTAL", "DB_STORAGE_TOTAL", "DOCUMENT_METRICS_DELETED", "DOCUMENT_METRICS_INSERTED", "DOCUMENT_METRICS_RETURNED", "DOCUMENT_METRICS_UPDATED", "EXTRA_INFO_PAGE_FAULTS", "FTS_DISK_UTILIZATION", "FTS_MEMORY_MAPPED", "FTS_MEMORY_RESIDENT", "FTS_MEMORY_VIRTUAL", "FTS_PROCESS_CPU_KERNEL", "FTS_PROCESS_CPU_USER", "FTS_PROCESS_NORMALIZED_CPU_KERNEL", "FTS_PROCESS_NORMALIZED_CPU_USER", "GLOBAL_ACCESSES_NOT_IN_MEMORY", "GLOBAL_LOCK_CURRENT_QUEUE_READERS", "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL", "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS", "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN", "INDEX_COUNTERS_BTREE_ACCESSES", "INDEX_COUNTERS_BTREE_HITS", "INDEX_COUNTERS_BTREE_MISS_RATIO", "INDEX_COUNTERS_BTREE_MISSES", "JOURNALING_COMMITS_IN_WRITE_LOCK", "JOURNALING_MB", "JOURNALING_WRITE_DATA_FILES_MB", "MAX_PROCESS_CPU_CHILDREN_KERNEL", "MAX_PROCESS_CPU_CHILDREN_USER", "MAX_PROCESS_CPU_KERNEL", "MAX_PROCESS_CPU_USER", "MAX_PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL", "MAX_PROCESS_NORMALIZED_CPU_CHILDREN_USER", "MAX_PROCESS_NORMALIZED_CPU_KERNEL", "MAX_PROCESS_NORMALIZED_CPU_USER", "MAX_SWAP_USAGE_FREE", "MAX_SWAP_USAGE_USED ", "MAX_SYSTEM_CPU_GUEST", "MAX_SYSTEM_CPU_IOWAIT", "MAX_SYSTEM_CPU_IRQ", "MAX_SYSTEM_CPU_KERNEL", "MAX_SYSTEM_CPU_SOFTIRQ", "MAX_SYSTEM_CPU_STEAL", "MAX_SYSTEM_CPU_USER", "MAX_SYSTEM_MEMORY_AVAILABLE", "MAX_SYSTEM_MEMORY_FREE", "MAX_SYSTEM_MEMORY_USED", "MAX_SYSTEM_NETWORK_IN", "MAX_SYSTEM_NETWORK_OUT", "MAX_SYSTEM_NORMALIZED_CPU_GUEST", "MAX_SYSTEM_NORMALIZED_CPU_IOWAIT", "MAX_SYSTEM_NORMALIZED_CPU_IRQ", "MAX_SYSTEM_NORMALIZED_CPU_KERNEL", "MAX_SYSTEM_NORMALIZED_CPU_NICE", "MAX_SYSTEM_NORMALIZED_CPU_SOFTIRQ", "MAX_SYSTEM_NORMALIZED_CPU_STEAL", "MAX_SYSTEM_NORMALIZED_CPU_USER", "MEMORY_MAPPED", "MEMORY_RESIDENT", "MEMORY_VIRTUAL", "NETWORK_BYTES_IN", "NETWORK_BYTES_OUT", "NETWORK_NUM_REQUESTS", "OP_EXECUTION_TIME_COMMANDS", "OP_EXECUTION_TIME_READS", "OP_EXECUTION_TIME_WRITES", "OPCOUNTER_CMD", "OPCOUNTER_DELETE", "OPCOUNTER_GETMORE", "OPCOUNTER_INSERT", "OPCOUNTER_QUERY", "OPCOUNTER_REPL_CMD", "OPCOUNTER_REPL_DELETE", "OPCOUNTER_REPL_INSERT", "OPCOUNTER_REPL_UPDATE", "OPCOUNTER_UPDATE", "OPERATIONS_SCAN_AND_ORDER", "OPLOG_MASTER_LAG_TIME_DIFF", "OPLOG_MASTER_TIME", "OPLOG_RATE_GB_PER_HOUR", "OPLOG_SLAVE_LAG_MASTER_TIME", "OPLOG_REPLICATION_LAG", "PROCESS_CPU_CHILDREN_KERNEL", "PROCESS_CPU_CHILDREN_USER", "PROCESS_CPU_KERNEL", "PROCESS_CPU_USER", "PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL", "PROCESS_NORMALIZED_CPU_CHILDREN_USER", "PROCESS_NORMALIZED_CPU_KERNEL", "PROCESS_NORMALIZED_CPU_USER", "QUERY_EXECUTOR_SCANNED", "QUERY_EXECUTOR_SCANNED_OBJECTS", "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED", "QUERY_TARGETING_SCANNED_PER_RETURNED", "RESTARTS_IN_LAST_HOUR", "SWAP_USAGE_FREE", "SWAP_USAGE_USED", "SYSTEM_CPU_GUEST", "SYSTEM_CPU_IOWAIT", "SYSTEM_CPU_IRQ", "SYSTEM_CPU_KERNEL", "SYSTEM_CPU_NICE", "SYSTEM_CPU_SOFTIRQ", "SYSTEM_CPU_STEAL", "SYSTEM_CPU_USER", "SYSTEM_MEMORY_AVAILABLE", "SYSTEM_MEMORY_FREE", "SYSTEM_MEMORY_USED", "SYSTEM_NETWORK_IN", "SYSTEM_NETWORK_OUT", "SYSTEM_NORMALIZED_CPU_GUEST", "SYSTEM_NORMALIZED_CPU_IOWAIT", "SYSTEM_NORMALIZED_CPU_IRQ", "SYSTEM_NORMALIZED_CPU_KERNEL", "SYSTEM_NORMALIZED_CPU_NICE", "SYSTEM_NORMALIZED_CPU_SOFTIRQ", "SYSTEM_NORMALIZED_CPU_STEAL", "SYSTEM_NORMALIZED_CPU_USER", "TICKETS_AVAILABLE_READS", "TICKETS_AVAILABLE_WRITE", "OPERATION_THROTTLING_REJECTED_OPERATIONS" ] + "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_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" ] }, "maxItems" : 10, "minItems" : 1, @@ -15002,7 +15048,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -15203,7 +15249,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -15252,7 +15298,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -15320,7 +15366,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the restore job to return.", @@ -15388,7 +15434,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -15437,7 +15483,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -15496,7 +15542,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "$ref" : "#/components/parameters/envelope" @@ -15542,7 +15588,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Value that we want to set for the Serverless Auto Indexing toggle.", @@ -15600,20 +15646,20 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { - "204" : { + "202" : { "content" : { "application/vnd.atlas.2023-01-01+json" : { "schema" : { - "$ref" : "#/components/schemas/NoBody" + "$ref" : "#/components/schemas/RequestAccepted" }, "x-xgen-version" : "2023-01-01" } }, - "description" : "This endpoint does not return a response body." + "description" : "Accepted" }, "400" : { "$ref" : "#/components/responses/badRequest" @@ -15652,7 +15698,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -15704,7 +15750,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -18421,6 +18467,9 @@ }, "description" : "OK" }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, "401" : { "$ref" : "#/components/responses/unauthorized" }, @@ -19047,12 +19096,15 @@ }, "/api/atlas/v2/orgs/{orgId}/users/{userId}" : { "delete" : { + "deprecated" : true, "description" : "Removes one MongoDB Cloud user from the specified organization. To use this resource, the requesting API Key must have the Organization User Admin role.", "operationId" : "removeOrganizationUser", "parameters" : [ { "$ref" : "#/components/parameters/envelope" }, { "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" }, { "description" : "Unique 24-hexadecimal digit string that identifies the user to be deleted.", "in" : "path", @@ -19096,8 +19148,9 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Remove One MongoDB Cloud User from One Organization", - "tags" : [ "Organizations" ] + "summary" : "Remove One MongoDB Cloud User From One Organization", + "tags" : [ "Organizations" ], + "x-sunset" : "2026-01-01" } }, "/api/atlas/v2/orgs/{orgId}/users/{userId}/roles" : { @@ -19818,7 +19871,7 @@ "diskIOPS" : { "type" : "integer", "format" : "int32", - "description" : "Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.\n\n Change this parameter only if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" to \"AWS\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" to \"M30\"` or greater (not including `Mxx_NVME` tiers).\n\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType\" to \"PROVISIONED\"`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1." + "description" : "Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.\n\n Change this parameter if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" to \"AWS\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" to \"M30\"` or greater (not including `Mxx_NVME` tiers).\n\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType\" to \"PROVISIONED\"`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1." }, "ebsVolumeType" : { "type" : "string", @@ -19847,7 +19900,7 @@ "diskIOPS" : { "type" : "integer", "format" : "int32", - "description" : "Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.\n\n You can set different IOPS values on different shards when provisioned IOPS are supported.\n\n Change this parameter only if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" to \"AWS\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" to \"M30\"` or greater (not including `Mxx_NVME` tiers).\n\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType\" to \"PROVISIONED\"`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1." + "description" : "Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.\n\n You can set different IOPS values on different shards when provisioned IOPS are supported.\n\n Change this parameter if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" to \"AWS\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" to \"M30\"` or greater (not including `Mxx_NVME` tiers).\n\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType\" to \"PROVISIONED\"`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1." }, "diskSizeGB" : { "type" : "number", @@ -20178,6 +20231,26 @@ "description" : "Configuration of nodes that comprise the cluster.", "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] }, + "configServerManagementMode" : { + "type" : "string", + "default" : "ATLAS_MANAGED", + "description" : "Config Server Management Mode for creating or updating a sharded cluster.\n\nWhen configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings.\n\nWhen configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server.", + "enum" : [ "ATLAS_MANAGED", "FIXED_TO_DEDICATED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + } + }, + "configServerType" : { + "type" : "string", + "description" : "Describes a sharded cluster's config server type.", + "enum" : [ "DEDICATED", "EMBEDDED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + }, + "readOnly" : true + }, "connectionStrings" : { "$ref" : "#/components/schemas/ClusterConnectionStrings" }, @@ -20213,6 +20286,17 @@ "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" } }, + "featureCompatibilityVersion" : { + "type" : "string", + "description" : "Feature compatibility version of the cluster.", + "readOnly" : true + }, + "featureCompatibilityVersionExpirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Feature compatibility version expiration date.", + "readOnly" : true + }, "globalClusterSelfManagedSharding" : { "type" : "boolean", "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen 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.\n\nWhen 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.\n\nThis setting cannot be changed once the cluster is deployed.", @@ -20259,6 +20343,9 @@ }, "readOnly" : true }, + "mongoDBEmployeeAccessGrant" : { + "$ref" : "#/components/schemas/EmployeeAccessGrantView" + }, "mongoDBMajorVersion" : { "type" : "string", "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", @@ -20278,7 +20365,7 @@ "description" : "Human-readable label that identifies the advanced cluster.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, "paused" : { "type" : "boolean", @@ -20292,6 +20379,16 @@ "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" } }, + "replicaSetScalingStrategy" : { + "type" : "string", + "default" : "WORKLOAD_TYPE", + "description" : "Set this field to configure the replica set scaling mode for your cluster.\n\nBy default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes.\n\nWhen configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads.\n\nWhen configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads.", + "enum" : [ "SEQUENTIAL", "WORKLOAD_TYPE", "NODE_TYPE" ], + "externalDocs" : { + "description" : "Modify the Replica Set Scaling Mode", + "url" : "https://dochub.mongodb.org/core/scale-nodes" + } + }, "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.", @@ -21162,6 +21259,257 @@ }, "title" : "mappings" }, + "ApiAtlasInvalidPolicyErrorDetailView" : { + "type" : "object", + "properties" : { + "detail" : { + "type" : "string", + "description" : "A string that provides a detailed description of a validation error.", + "readOnly" : true + } + } + }, + "ApiAtlasInvalidPolicyView" : { + "type" : "object", + "properties" : { + "body" : { + "type" : "string", + "description" : "A string that defines the permissions for the policy. The syntax used is the Cedar Policy language.", + "example" : " forbid (\n principal,\n action == cloud::Action::\"cluster.createEdit\",\n resource\n ) when {\n context.cluster.regions.contains(cloud::region::\"aws:us-east-1\")\n };\n", + "readOnly" : true + }, + "errors" : { + "type" : "array", + "description" : "List of validation errors.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasInvalidPolicyErrorDetailView" + }, + "readOnly" : true + } + } + }, + "ApiAtlasInvalidResourcePolicyCreateErrorView" : { + "type" : "object", + "properties" : { + "errorType" : { + "type" : "string", + "description" : "Human-readable label that displays the type of an error.", + "enum" : [ "POLICY_PARSING_ERROR", "POLICY_HAS_FAILED_VALIDATIONS", "POLICY_HAS_INVALID_PRINCIPAL", "POLICY_HAS_BODY_EXCEEDING_MAX_SIZE", "POLICY_HAS_UNEXPECTED_ENTITIES" ] + }, + "invalidPolicies" : { + "type" : "array", + "description" : "List of invalid policies containing details of their validation errors.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasInvalidPolicyView" + }, + "readOnly" : true + } + } + }, + "ApiAtlasNonCompliantResourceView" : { + "type" : "object", + "properties" : { + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization the resource belongs to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resourceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the non-compliant resource.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resourcePoliciesCausingNonCompliance" : { + "type" : "array", + "description" : "List of resource policies causing the resource to be considered non-compliant.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasResourcePolicyMetadataView" + }, + "readOnly" : true + }, + "resourceType" : { + "type" : "string", + "description" : "Human-readable label that displays the type of a resource.", + "enum" : [ "PROJECT", "CLUSTER" ], + "readOnly" : true + } + } + }, + "ApiAtlasPolicyCreateView" : { + "type" : "object", + "properties" : { + "body" : { + "type" : "string", + "description" : "A string that defines the permissions for the policy. The syntax used is the Cedar Policy language.", + "example" : " forbid (\n principal,\n action == cloud::Action::\"cluster.createEdit\",\n resource\n ) when {\n context.cluster.regions.contains(cloud::region::\"aws:us-east-1\")\n };\n" + } + }, + "required" : [ "body" ] + }, + "ApiAtlasPolicyMetadataView" : { + "type" : "object", + "properties" : { + "policyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "ApiAtlasPolicyView" : { + "type" : "object", + "properties" : { + "body" : { + "type" : "string", + "description" : "A string that defines the permissions for the policy. The syntax used is the Cedar Policy language.", + "example" : " forbid (\n principal,\n action == cloud::Action::\"cluster.createEdit\",\n resource\n ) when {\n context.cluster.regions.contains(cloud::region::\"aws:us-east-1\")\n };\n", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "ApiAtlasResourcePolicyCreateView" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that describes the atlas resource policy." + }, + "policies" : { + "type" : "array", + "description" : "List of policies that make up the atlas resource policy.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasPolicyCreateView" + } + } + }, + "required" : [ "name", "policies" ] + }, + "ApiAtlasResourcePolicyEditView" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that describes the atlas resource policy." + }, + "policies" : { + "type" : "array", + "description" : "List of policies that make up the atlas resource policy.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasPolicyCreateView" + } + } + } + }, + "ApiAtlasResourcePolicyMetadataView" : { + "type" : "object", + "properties" : { + "policiesCausingNonCompliance" : { + "type" : "array", + "description" : "List of policies that are in conflict with the current state of the resource.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasPolicyMetadataView" + }, + "readOnly" : true + }, + "resourcePolicyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the atlas resource policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resourcePolicyName" : { + "type" : "string", + "description" : "Human-readable label that describes the atlas resource policy.", + "readOnly" : true + } + } + }, + "ApiAtlasResourcePolicyView" : { + "type" : "object", + "properties" : { + "createdByUser" : { + "$ref" : "#/components/schemas/ApiAtlasUserMetadataView" + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time in UTC when the atlas resource policy was created.", + "example" : "2022-01-01T00:00:00Z", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the atlas resource policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastUpdatedByUser" : { + "$ref" : "#/components/schemas/ApiAtlasUserMetadataView" + }, + "lastUpdatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time in UTC when the atlas resource policy was last updated.", + "example" : "2022-01-01T00:00:00Z", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that describes the atlas resource policy.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization the atlas resource policy belongs to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "policies" : { + "type" : "array", + "description" : "List of policies that make up the atlas resource policy.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasPolicyView" + }, + "readOnly" : true + }, + "version" : { + "type" : "string", + "description" : "A string that identifies the version of the atlas resource policy.", + "example" : "v1", + "readOnly" : true + } + } + }, "ApiAtlasSnapshotScheduleView" : { "type" : "object", "properties" : { @@ -21238,6 +21586,27 @@ }, "required" : [ "clusterCheckpointIntervalMin", "clusterId", "dailySnapshotRetentionDays", "groupId", "monthlySnapshotRetentionMonths", "pointInTimeWindowHours", "snapshotIntervalHours", "snapshotRetentionDays", "weeklySnapshotRetentionWeeks" ] }, + "ApiAtlasUserMetadataView" : { + "type" : "object", + "description" : "The user that last updated the atlas resource policy.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies a user.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that describes a user.", + "readOnly" : true + } + }, + "readOnly" : true + }, "ApiBSONTimestampView" : { "type" : "object", "description" : "BSON timestamp that indicates when the checkpoint token entry in the oplog occurred.", @@ -21294,6 +21663,9 @@ "ApiError" : { "type" : "object", "properties" : { + "badRequestDetail" : { + "$ref" : "#/components/schemas/BadRequestDetail" + }, "detail" : { "type" : "string", "description" : "Describes the specific conditions or reasons that cause each type of error." @@ -21304,24 +21676,30 @@ "description" : "HTTP status code returned with this error.", "externalDocs" : { "url" : "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status" - } + }, + "readOnly" : true }, "errorCode" : { "type" : "string", - "description" : "Application error code returned with this error." + "description" : "Application error code returned with this error.", + "readOnly" : true }, "parameters" : { "type" : "array", "description" : "Parameters used to give more information about the error.", "items" : { - "type" : "object" - } + "type" : "object", + "readOnly" : true + }, + "readOnly" : true }, "reason" : { "type" : "string", - "description" : "Application error message returned with this error." + "description" : "Application error message returned with this error.", + "readOnly" : true } - } + }, + "required" : [ "error", "errorCode" ] }, "ApiHostView_Atlas" : { "type" : "object", @@ -21577,6 +21955,24 @@ } } }, + "ApiPrivateDownloadDeliveryUrl" : { + "type" : "object", + "description" : "One Uniform Resource Locator (URL) that points to the compressed snapshot files for manual download and the corresponding private endpoint.", + "properties" : { + "deliveryUrl" : { + "type" : "string", + "description" : "One Uniform Resource Locator that points to the compressed snapshot files for manual download." + }, + "endpointId" : { + "type" : "string", + "description" : "Unique 22-character alphanumeric string that identifies the private endpoint.", + "example" : "vpce-3bf78b0ddee411ba1", + "maxLength" : 22, + "minLength" : 22, + "pattern" : "^vpce-[0-9a-f]{17}$" + } + } + }, "ApiPublicUsageDetailsQueryRequest" : { "type" : "object", "description" : "Request body for an Invoice Usage Details query with filtering, pagination, and sort.", @@ -21670,7 +22066,12 @@ "ApiStreamsAWSRegionView" : { "type" : "string", "description" : "Atlas Streams AWS Regions.", - "enum" : [ "VIRGINIA_USA" ] + "enum" : [ "SYDNEY_AUS", "MUMBAI_IND", "FRANKFURT_DEU", "DUBLIN_IRL", "LONDON_GBR", "VIRGINIA_USA", "OREGON_USA", "SAOPAULO_BRA", "MONTREAL_CAN", "TOKYO_JPN", "SINGAPORE_SGP" ] + }, + "ApiStreamsAzureRegionView" : { + "type" : "string", + "description" : "Atlas Streams Azure Regions.", + "enum" : [ "VIRGINIA_USA", "AMSTERDAM_NLD" ] }, "ApiUserEventTypeViewForNdsGroup" : { "type" : "string", @@ -21894,6 +22295,15 @@ "required" : [ "created", "eventTypeName", "id" ], "title" : "API User Events" }, + "ApiVersion" : { + "type" : "object", + "properties" : { + "version" : { + "type" : "string", + "description" : "Object representing a version of the Atlas Admin API." + } + } + }, "AppServiceAlertConfigViewForNdsGroup" : { "type" : "object", "description" : "App Services metric alert configuration allows to select which app service conditions and events trigger alerts and how users are notified.", @@ -22316,7 +22726,9 @@ "enum" : [ "AVERAGE" ] }, "operator" : { - "$ref" : "#/components/schemas/Operator" + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, "threshold" : { "type" : "number", @@ -22356,6 +22768,11 @@ "description" : "Atlas Data Federation Azure Regions.", "enum" : [ "VIRGINIA_USA", "AMSTERDAM_NLD" ] }, + "AtlasDataFederationGCPRegion" : { + "type" : "string", + "description" : "Atlas Data Federation GCP Regions.", + "enum" : [ "IOWA_USA", "BELGIUM_EU" ] + }, "AtlasOrganization" : { "type" : "object", "description" : "Details that describe the organization.", @@ -22396,6 +22813,122 @@ }, "required" : [ "name" ] }, + "AtlasResourcePolicyAuditForOrg" : { + "type" : "object", + "description" : "Atlas resource policy audits indicate org level changes to resource policies", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "RESOURCE_POLICY_CREATED", "RESOURCE_POLICY_MODIFIED", "RESOURCE_POLICY_DELETED" ], + "example" : "RESOURCE_POLICY_CREATED", + "title" : "Atlas Resource Policy Audit Types" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "resourcePolicyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the resource policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Atlas Resource Policy Audits" + }, "AtlasSearchAnalyzer" : { "type" : "object", "properties" : { @@ -22911,6 +23444,15 @@ "AzureHardwareSpec" : { "type" : "object", "properties" : { + "diskIOPS" : { + "type" : "integer", + "format" : "int32", + "description" : "Target throughput desired for storage attached to your Azure-provisioned cluster. Change this parameter if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" : \"Azure\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : \"M40\"` or greater not including `Mxx_NVME` tiers.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://www.mongodb.com/docs/atlas/customize-storage/#extend-iops-on-azure" + } + }, "instanceSize" : { "type" : "string", "description" : "Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts of the node type.", @@ -22927,6 +23469,15 @@ "AzureHardwareSpec20240805" : { "type" : "object", "properties" : { + "diskIOPS" : { + "type" : "integer", + "format" : "int32", + "description" : "Target throughput desired for storage attached to your Azure-provisioned cluster. Change this parameter if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" : \"Azure\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : \"M40\"` or greater not including `Mxx_NVME` tiers.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://www.mongodb.com/docs/atlas/customize-storage/#extend-iops-on-azure" + } + }, "diskSizeGB" : { "type" : "number", "format" : "double", @@ -23054,7 +23605,7 @@ "status" : { "type" : "string", "description" : "State of the Encryption At Rest private endpoint.", - "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "ACTIVE", "FAILED" ], + "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "ACTIVE", "FAILED", "PENDING_RECREATION", "DELETING" ], "readOnly" : true } }, @@ -23387,7 +23938,7 @@ "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to create an online archive.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "collName" : { @@ -23471,7 +24022,7 @@ "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to create an online archive.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "collName" : { @@ -23574,7 +24125,7 @@ "description" : "Human-readable label that identifies the cluster containing the snapshots you want to retrieve.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -23731,7 +24282,7 @@ "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\"`.\n\nIf the target cluster doesn't have backup enabled, two resources return parameters with empty values:\n\n- **Get All Snapshots** endpoint returns an empty results array without **clusterId** elements\n- **Get a Snapshot** endpoint doesn't return a **clusterId** parameter.\n\nTo return a response with the **clusterId** parameter, either use the **delivery.targetClusterName** parameter or enable backup on the target cluster.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, "targetGroupId" : { "type" : "string", @@ -23992,6 +24543,20 @@ } } }, + "BadRequestDetail" : { + "type" : "object", + "description" : "Bad request detail.", + "properties" : { + "fields" : { + "type" : "array", + "description" : "Describes all violations in a client request.", + "items" : { + "$ref" : "#/components/schemas/FieldViolation" + } + } + }, + "readOnly" : true + }, "BaseAtlasDataLakeRegion" : { "type" : "object", "description" : "Name of the region to which the data lake routes client connections.", @@ -23999,6 +24564,8 @@ "$ref" : "#/components/schemas/ApiAtlasDataLakeAWSRegionView" }, { "$ref" : "#/components/schemas/AtlasDataFederationAzureRegion" + }, { + "$ref" : "#/components/schemas/AtlasDataFederationGCPRegion" } ] }, "BaseCloudProviderInstanceSize" : { @@ -24066,6 +24633,8 @@ "description" : "Name of the cloud provider region hosting Atlas Stream Processing.", "oneOf" : [ { "$ref" : "#/components/schemas/ApiStreamsAWSRegionView" + }, { + "$ref" : "#/components/schemas/ApiStreamsAzureRegionView" } ] }, "BasicBSONList" : { @@ -24955,7 +25524,7 @@ "description" : "Human-readable label that identifies the cluster.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "nodeCount" : { @@ -25007,6 +25576,11 @@ "format" : "date-time", "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." }, + "description" : { + "type" : "string", + "description" : "Description of this database user.", + "maxLength" : 100 + }, "groupId" : { "type" : "string", "description" : "Unique 24-hexadecimal digit string that identifies the project.", @@ -25185,6 +25759,123 @@ "description" : "Details that describe the features linked to the Amazon Web Services (AWS) Identity and Access Management (IAM) role.", "required" : [ "providerName" ] }, + "CloudProviderAccessAWSIAMRoleRequest" : { + "type" : "object", + "description" : "Details that describe the features linked to the Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "properties" : { + "atlasAWSAccountArn" : { + "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.", + "example" : "arn:aws:iam::772401394250:role/my-test-aws-role", + "maxLength" : 2048, + "minLength" : 20, + "readOnly" : true + }, + "atlasAssumedRoleExternalId" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique external ID that MongoDB Cloud uses when it assumes the IAM role in your Amazon Web Services (AWS) account.", + "readOnly" : true + }, + "authorizedDate" : { + "type" : "string", + "format" : "date-time", + "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.", + "readOnly" : true + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "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.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider of the role.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "roleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + }, + "required" : [ "providerName" ] + }, + "CloudProviderAccessAWSIAMRoleRequestUpdate" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessRoleRequestUpdate" + }, { + "type" : "object", + "properties" : { + "atlasAWSAccountArn" : { + "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.", + "example" : "arn:aws:iam::772401394250:role/my-test-aws-role", + "maxLength" : 2048, + "minLength" : 20, + "readOnly" : true + }, + "atlasAssumedRoleExternalId" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique external ID that MongoDB Cloud uses when it assumes the IAM role in your Amazon Web Services (AWS) account.", + "readOnly" : true + }, + "authorizedDate" : { + "type" : "string", + "format" : "date-time", + "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.", + "readOnly" : true + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "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.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "iamAssumedRoleArn" : { + "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", + "maxLength" : 2048, + "minLength" : 20 + }, + "roleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + } ], + "description" : "Details that describe the features linked to the Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "required" : [ "providerName" ] + }, "CloudProviderAccessAzureServicePrincipal" : { "type" : "object", "allOf" : [ { @@ -25247,6 +25938,130 @@ "description" : "Details that describe the features linked to the Azure Service Principal.", "required" : [ "providerName" ] }, + "CloudProviderAccessAzureServicePrincipalRequest" : { + "type" : "object", + "description" : "Details that describe the features linked to the Azure Service Principal.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "atlasAzureAppId" : { + "type" : "string", + "description" : "Azure Active Directory Application ID of Atlas.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this Azure Service Principal was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Azure Service Principal.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "lastUpdatedDate" : { + "type" : "string", + "format" : "date-time", + "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.", + "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.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "tenantId" : { + "type" : "string", + "description" : "UUID String that identifies the Azure Active Directory Tenant ID.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + } + }, + "required" : [ "providerName" ] + }, + "CloudProviderAccessAzureServicePrincipalRequestUpdate" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessRoleRequestUpdate" + }, { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "atlasAzureAppId" : { + "type" : "string", + "description" : "Azure Active Directory Application ID of Atlas.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this Azure Service Principal was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Azure Service Principal.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "lastUpdatedDate" : { + "type" : "string", + "format" : "date-time", + "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.", + "readOnly" : true + }, + "servicePrincipalId" : { + "type" : "string", + "description" : "UUID string that identifies the Azure Service Principal.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "tenantId" : { + "type" : "string", + "description" : "UUID String that identifies the Azure Active Directory Tenant ID.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + } + } + } ], + "description" : "Details that describe the features linked to the Azure Service Principal.", + "required" : [ "providerName" ] + }, "CloudProviderAccessDataLakeFeatureUsage" : { "type" : "object", "allOf" : [ { @@ -25373,6 +26188,92 @@ } } }, + "CloudProviderAccessGCPServiceAccount" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, { + "type" : "object", + "properties" : { + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this Google Service Account was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Google Service Account.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "gcpServiceAccountForAtlas" : { + "type" : "string", + "description" : "Email address for the Google Service Account created by Atlas.", + "maxLength" : 82, + "minLength" : 57, + "pattern" : "^mongodb-atlas-[0-9a-z]{16}@p-[0-9a-z]{24}.iam.gserviceaccount.com$" + }, + "roleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + } ], + "description" : "Details that describe the features linked to the GCP Service Account.", + "required" : [ "providerName" ] + }, + "CloudProviderAccessGCPServiceAccountRequest" : { + "type" : "object", + "description" : "Details that describe the features linked to the GCP Service Account.", + "properties" : { + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this GCP Service Account was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this GCP Service Account.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "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" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "readOnly" : true + } + }, + "required" : [ "providerName" ] + }, + "CloudProviderAccessGCPServiceAccountRequestUpdate" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessRoleRequestUpdate" + } ], + "description" : "Details that describe the features linked to the GCP Service Account.", + "required" : [ "providerName" ] + }, "CloudProviderAccessPushBasedLogExportFeatureUsage" : { "type" : "object", "allOf" : [ { @@ -25393,20 +26294,63 @@ "discriminator" : { "mapping" : { "AWS" : "#/components/schemas/CloudProviderAccessAWSIAMRole", - "AZURE" : "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + "AZURE" : "#/components/schemas/CloudProviderAccessAzureServicePrincipal", + "GCP" : "#/components/schemas/CloudProviderAccessGCPServiceAccount" + }, + "propertyName" : "providerName" + }, + "properties" : { + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider of the role.", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, + "required" : [ "providerName" ] + }, + "CloudProviderAccessRoleRequest" : { + "type" : "object", + "description" : "Cloud provider access role.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/CloudProviderAccessAWSIAMRoleRequest", + "AZURE" : "#/components/schemas/CloudProviderAccessAzureServicePrincipalRequest", + "GCP" : "#/components/schemas/CloudProviderAccessGCPServiceAccountRequest" }, "propertyName" : "providerName" }, "oneOf" : [ { - "$ref" : "#/components/schemas/CloudProviderAccessAWSIAMRole" + "$ref" : "#/components/schemas/CloudProviderAccessAWSIAMRoleRequest" }, { - "$ref" : "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + "$ref" : "#/components/schemas/CloudProviderAccessAzureServicePrincipalRequest" + }, { + "$ref" : "#/components/schemas/CloudProviderAccessGCPServiceAccountRequest" } ], "properties" : { "providerName" : { "type" : "string", "description" : "Human-readable label that identifies the cloud provider of the role.", - "enum" : [ "AWS", "AZURE" ] + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, + "required" : [ "providerName" ] + }, + "CloudProviderAccessRoleRequestUpdate" : { + "type" : "object", + "description" : "Cloud provider access role.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/CloudProviderAccessAWSIAMRoleRequestUpdate", + "AZURE" : "#/components/schemas/CloudProviderAccessAzureServicePrincipalRequestUpdate", + "GCP" : "#/components/schemas/CloudProviderAccessGCPServiceAccountRequestUpdate" + }, + "propertyName" : "providerName" + }, + "properties" : { + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider of the role.", + "enum" : [ "AWS", "AZURE", "GCP" ] } }, "required" : [ "providerName" ] @@ -25420,6 +26364,13 @@ "items" : { "$ref" : "#/components/schemas/CloudProviderAccessAWSIAMRole" } + }, + "azureServicePrincipals" : { + "type" : "array", + "description" : "List that contains the Azure Service Principals registered with MongoDB Cloud.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + } } } }, @@ -25802,7 +26753,7 @@ "example" : "cluster1", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -25895,6 +26846,7 @@ }, "diskGBEnabled" : { "type" : "boolean", + "default" : false, "description" : "Flag that indicates whether someone enabled disk auto-scaling for this cluster." } }, @@ -25924,10 +26876,12 @@ "properties" : { "enabled" : { "type" : "boolean", + "default" : false, "description" : "Flag that indicates whether cluster tier auto-scaling is enabled. Set to `true` to enable cluster tier auto-scaling. If enabled, you must specify a value for **providerSettings.autoScaling.compute.maxInstanceSize** also. Set to `false` to disable cluster tier auto-scaling." }, "scaleDownEnabled" : { "type" : "boolean", + "default" : false, "description" : "Flag that indicates whether the cluster tier can scale down. This is required if **autoScaling.compute.enabled** is `true`. If you enable this option, specify a value for **providerSettings.autoScaling.compute.minInstanceSize**." } } @@ -25962,14 +26916,14 @@ "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.", + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to Atlas through the interface endpoint that the key names. If the cluster uses an optimized connection string, `awsPrivateLinkSrv` contains the optimized connection string. If the cluster has the non-optimized (legacy) connection string, `awsPrivateLinkSrv` contains the non-optimized connection string even if an optimized connection string is also present.", "externalDocs" : { "description" : "Network Peering Connection", "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" }, "readOnly" : true }, - "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.", + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to Atlas through the interface endpoint that the key names. If the cluster uses an optimized connection string, `awsPrivateLinkSrv` contains the optimized connection string. If the cluster has the non-optimized (legacy) connection string, `awsPrivateLinkSrv` contains the non-optimized connection string even if an optimized connection string is also present.", "externalDocs" : { "description" : "Network Peering Connection", "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" @@ -26049,6 +27003,26 @@ "description" : "Configuration of nodes that comprise the cluster.", "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] }, + "configServerManagementMode" : { + "type" : "string", + "default" : "ATLAS_MANAGED", + "description" : "Config Server Management Mode for creating or updating a sharded cluster.\n\nWhen configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings.\n\nWhen configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server.", + "enum" : [ "ATLAS_MANAGED", "FIXED_TO_DEDICATED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + } + }, + "configServerType" : { + "type" : "string", + "description" : "Describes a sharded cluster's config server type.", + "enum" : [ "DEDICATED", "EMBEDDED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + }, + "readOnly" : true + }, "connectionStrings" : { "$ref" : "#/components/schemas/ClusterConnectionStrings" }, @@ -26077,6 +27051,17 @@ "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" } }, + "featureCompatibilityVersion" : { + "type" : "string", + "description" : "Feature compatibility version of the cluster.", + "readOnly" : true + }, + "featureCompatibilityVersionExpirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Feature compatibility version expiration date.", + "readOnly" : true + }, "globalClusterSelfManagedSharding" : { "type" : "boolean", "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen 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.\n\nWhen 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.\n\nThis setting cannot be changed once the cluster is deployed.", @@ -26123,6 +27108,9 @@ }, "readOnly" : true }, + "mongoDBEmployeeAccessGrant" : { + "$ref" : "#/components/schemas/EmployeeAccessGrantView" + }, "mongoDBMajorVersion" : { "type" : "string", "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", @@ -26142,7 +27130,7 @@ "description" : "Human-readable label that identifies the cluster.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, "paused" : { "type" : "boolean", @@ -26156,6 +27144,24 @@ "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" } }, + "redactClientLogData" : { + "type" : "boolean", + "description" : "Enable or disable log redaction.", + "externalDocs" : { + "description" : "This options corresponds to the ``security.redactClientLogData`` cluster parameter.\n\nThis setting configures the ``mongod`` or ``mongos`` to redact any message accompanying a given log event before logging. This prevents the program from writing potentially sensitive data stored on the database to the diagnostic log. Metadata such as error or operation codes, line numbers, and source file names are still visible in the logs.\n\nUse ``redactClientLogData`` in conjunction with Encryption at Rest and TLS/SSL (Transport Encryption) to assist compliance with regulatory requirements.", + "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.redactClientLogData" + } + }, + "replicaSetScalingStrategy" : { + "type" : "string", + "default" : "WORKLOAD_TYPE", + "description" : "Set this field to configure the replica set scaling mode for your cluster.\n\nBy default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes.\n\nWhen configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads.\n\nWhen configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads.", + "enum" : [ "SEQUENTIAL", "WORKLOAD_TYPE", "NODE_TYPE" ], + "externalDocs" : { + "description" : "Modify the Replica Set Scaling Mode", + "url" : "https://dochub.mongodb.org/core/scale-nodes" + } + }, "replicationSpecs" : { "type" : "array", "description" : "List of settings that configure your cluster regions. This array has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations.", @@ -26265,6 +27271,16 @@ "ClusterDescriptionProcessArgs" : { "type" : "object", "properties" : { + "changeStreamOptionsPreAndPostImagesExpireAfterSeconds" : { + "type" : "integer", + "format" : "int32", + "default" : -1, + "description" : "The minimum pre- and post-image retention time in seconds.", + "externalDocs" : { + "description" : "This option corresponds to the ``changeStreamOptions.preAndPostImages.expireAfterSeconds`` cluster parameter. This setting controls the retention policy of change stream pre- and post-images. Pre- and post-images are the versions of a document before and after document modification, respectively. ``expireAfterSeconds`` controls how long MongoDB retains pre- and post-images. When set to -1 (off), MongoDB uses the default retention policy: pre- and post-images are retained until the corresponding change stream events are removed from the oplog. To set the minimum pre- and post-image retention time, specify an integer value greater than zero. Setting this too low could increase the risk of interrupting Realm sync or triggers processing. The default value is -1 (off).", + "url" : "https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/changeStreamOptions/#mongodb-parameter-param.changeStreamOptions.preAndPostImages.expireAfterSeconds" + } + }, "chunkMigrationConcurrency" : { "type" : "integer", "format" : "int32", @@ -26274,6 +27290,15 @@ "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.chunkMigrationConcurrency" } }, + "defaultMaxTimeMS" : { + "type" : "integer", + "format" : "int32", + "description" : "Default time limit in milliseconds for individual read operations to complete.", + "externalDocs" : { + "description" : "This option corresponds to the defaultMaxTimeMS cluster parameter.", + "url" : "https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/defaultMaxTimeMS/" + } + }, "defaultReadConcern" : { "type" : "string", "default" : "available", @@ -26304,7 +27329,7 @@ }, "javascriptEnabled" : { "type" : "boolean", - "description" : "Flag that indicates whether the cluster allows execution of operations that perform server-side executions of JavaScript.", + "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" @@ -26392,6 +27417,16 @@ "ClusterDescriptionProcessArgs20240805" : { "type" : "object", "properties" : { + "changeStreamOptionsPreAndPostImagesExpireAfterSeconds" : { + "type" : "integer", + "format" : "int32", + "default" : -1, + "description" : "The minimum pre- and post-image retention time in seconds.", + "externalDocs" : { + "description" : "This option corresponds to the ``changeStreamOptions.preAndPostImages.expireAfterSeconds`` cluster parameter. This setting controls the retention policy of change stream pre- and post-images. Pre- and post-images are the versions of a document before and after document modification, respectively. ``expireAfterSeconds`` controls how long MongoDB retains pre- and post-images. When set to -1 (off), MongoDB uses the default retention policy: pre- and post-images are retained until the corresponding change stream events are removed from the oplog. To set the minimum pre- and post-image retention time, specify an integer value greater than zero. Setting this too low could increase the risk of interrupting Realm sync or triggers processing. The default value is -1 (off).", + "url" : "https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/changeStreamOptions/#mongodb-parameter-param.changeStreamOptions.preAndPostImages.expireAfterSeconds" + } + }, "chunkMigrationConcurrency" : { "type" : "integer", "format" : "int32", @@ -26401,6 +27436,15 @@ "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.chunkMigrationConcurrency" } }, + "defaultMaxTimeMS" : { + "type" : "integer", + "format" : "int32", + "description" : "Default time limit in milliseconds for individual read operations to complete.", + "externalDocs" : { + "description" : "This option corresponds to the defaultMaxTimeMS cluster parameter.", + "url" : "https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/defaultMaxTimeMS/" + } + }, "defaultWriteConcern" : { "type" : "string", "description" : "Default level of acknowledgment requested from MongoDB for write operations when none is specified by the driver.", @@ -26411,7 +27455,7 @@ }, "javascriptEnabled" : { "type" : "boolean", - "description" : "Flag that indicates whether the cluster allows execution of operations that perform server-side executions of JavaScript.", + "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" @@ -26678,7 +27722,7 @@ "description" : "Human-readable label that identifies the cluster that undergoes outage simulation.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "groupId" : { @@ -27272,7 +28316,8 @@ "discriminator" : { "mapping" : { "AWS" : "#/components/schemas/AWSCreateDataProcessRegionView", - "AZURE" : "#/components/schemas/AzureCreateDataProcessRegionView" + "AZURE" : "#/components/schemas/AzureCreateDataProcessRegionView", + "GCP" : "#/components/schemas/GCPCreateDataProcessRegionView" }, "propertyName" : "cloudProvider" }, @@ -27769,11 +28814,11 @@ }, "roleId" : { "type" : "string", - "description" : "Unique identifier of the role that Data Federation can use to access the data stores.Required if specifying cloudProviderConfig." + "description" : "Unique identifier of the role that Data Federation can use to access the data stores. Required if specifying cloudProviderConfig." }, "servicePrincipalId" : { "type" : "string", - "description" : "The ID of the Service Principal for which there is an access policyfor Atlas to access Azure resources.", + "description" : "The ID of the Service Principal for which there is an access policy for Atlas to access Azure resources.", "readOnly" : true }, "tenantId" : { @@ -27784,6 +28829,22 @@ }, "required" : [ "roleId" ] }, + "DataFederationGCPCloudProviderConfig" : { + "type" : "object", + "description" : "Configuration for running Data Federation in GCP.", + "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" : { + "type" : "string", + "description" : "Unique identifier of the role that Data Federation can use to access the data stores. Required if specifying cloudProviderConfig." + } + }, + "required" : [ "roleId" ] + }, "DataFederationLimit" : { "type" : "object", "description" : "Details of user managed limits.", @@ -27791,6 +28852,7 @@ "mapping" : { "atlas.project.deployment.clusters" : "#/components/schemas/DefaultLimit", "atlas.project.deployment.nodesPerPrivateLinkRegion" : "#/components/schemas/DefaultLimit", + "atlas.project.deployment.salesSoldM0s" : "#/components/schemas/DefaultLimit", "atlas.project.deployment.serverlessMTMs" : "#/components/schemas/DefaultLimit", "atlas.project.security.databaseAccess.customRoles" : "#/components/schemas/DefaultLimit", "atlas.project.security.databaseAccess.users" : "#/components/schemas/DefaultLimit", @@ -28131,9 +29193,12 @@ }, "azure" : { "$ref" : "#/components/schemas/DataFederationAzureCloudProviderConfig" + }, + "gcp" : { + "$ref" : "#/components/schemas/DataFederationGCPCloudProviderConfig" } }, - "title" : "Data Lake Cloud Provider" + "title" : "Data Federation Cloud Provider" }, "DataLakeDLSAWSStore" : { "type" : "object", @@ -28174,7 +29239,7 @@ "cloudProvider" : { "type" : "string", "description" : "Name of the cloud service that hosts the Federated Database Instance's infrastructure.", - "enum" : [ "AWS", "AZURE" ] + "enum" : [ "AWS", "AZURE", "GCP" ] }, "region" : { "$ref" : "#/components/schemas/BaseAtlasDataLakeRegion" @@ -28596,7 +29661,7 @@ "example" : "cluster1", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -28838,7 +29903,9 @@ "enum" : [ "AVERAGE" ] }, "operator" : { - "$ref" : "#/components/schemas/Operator" + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, "threshold" : { "type" : "number", @@ -28881,7 +29948,8 @@ "discriminator" : { "mapping" : { "AWS" : "#/components/schemas/AWSDataProcessRegionView", - "AZURE" : "#/components/schemas/AzureDataProcessRegionView" + "AZURE" : "#/components/schemas/AzureDataProcessRegionView", + "GCP" : "#/components/schemas/GCPDataProcessRegionView" }, "propertyName" : "cloudProvider" }, @@ -28889,7 +29957,7 @@ "cloudProvider" : { "type" : "string", "description" : "Human-readable label that identifies the Cloud service provider where you store your archived data.", - "enum" : [ "AWS", "AZURE" ], + "enum" : [ "AWS", "AZURE", "GCP" ], "readOnly" : true } }, @@ -29116,7 +30184,7 @@ "action" : { "type" : "string", "description" : "Human-readable label that identifies the privilege action.", - "enum" : [ "FIND", "INSERT", "REMOVE", "UPDATE", "BYPASS_DOCUMENT_VALIDATION", "USE_UUID", "KILL_OP", "CREATE_COLLECTION", "CREATE_INDEX", "DROP_COLLECTION", "ENABLE_PROFILER", "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", "STORAGE_GET_CONFIG", "STORAGE_SET_CONFIG", "FLUSH_ROUTER_CONFIG", "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" ] + "enum" : [ "FIND", "INSERT", "REMOVE", "UPDATE", "BYPASS_DOCUMENT_VALIDATION", "USE_UUID", "KILL_OP", "CREATE_COLLECTION", "CREATE_INDEX", "DROP_COLLECTION", "ENABLE_PROFILER", "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", "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", @@ -29395,7 +30463,7 @@ "title" : "Cps Backup Event Types" }, { "type" : "string", - "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEXES_RESTORE_FAILED" ], + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEXES_RESTORE_FAILED", "FTS_INDEXES_SYNONYM_MAPPING_INVALID" ], "title" : "FTS Index Audit Types" }, { "type" : "string", @@ -29538,7 +30606,7 @@ "title" : "Encryption Event Types" }, { "type" : "string", - "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEXES_RESTORE_FAILED" ], + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEXES_RESTORE_FAILED", "FTS_INDEXES_SYNONYM_MAPPING_INVALID" ], "title" : "FTS Index Audit Types" }, { "type" : "string", @@ -29803,7 +30871,7 @@ "title" : "Tenant Backup Event Types" }, { "type" : "string", - "enum" : [ "CLUSTER_VERSION_FIXED", "CLUSTER_VERSION_UNFIXED", "CLUSTER_FCV_FIXED", "CLUSTER_FCV_UNFIXED", "AGENT_VERSION_FIXED", "AGENT_VERSION_UNFIXED", "FIXED_VERSION_UPDATED", "FIXED_AGENT_VERSION_UPDATED", "CLUSTER_FCV_DOWNGRADED" ], + "enum" : [ "CLUSTER_VERSION_FIXED", "CLUSTER_VERSION_UNFIXED", "CLUSTER_FCV_FIXED", "CLUSTER_FCV_UNFIXED", "CLUSTER_FCV_EXPIRATION_DATE_UPDATED", "AGENT_VERSION_FIXED", "AGENT_VERSION_UNFIXED", "FIXED_VERSION_UPDATED", "FIXED_AGENT_VERSION_UPDATED", "CLUSTER_FCV_DOWNGRADED", "CLUSTER_BINARY_VERSION_DOWNGRADED", "CLUSTER_BINARY_VERSION_UPGRADED" ], "title" : "Version Audit Types" } ] }, @@ -30127,7 +31195,6 @@ }, "hostnameSchemaType" : { "type" : "string", - "default" : "PUBLIC", "description" : "The network type to use between the migration host and the destination cluster.", "enum" : [ "PUBLIC", "PRIVATE_LINK", "VPC_PEERING" ] }, @@ -30251,28 +31318,19 @@ "createdAt" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when someone created this export job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "description" : "Date and time when a user or Atlas created the Export Job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", "readOnly" : true }, "customData" : { "type" : "array", - "description" : "Collection of key-value pairs that represent custom data for the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes.", + "description" : "Collection of key-value pairs that represent custom data for the metadata file that MongoDB Cloud uploads when the Export Job finishes.", "items" : { "$ref" : "#/components/schemas/BackupLabel" } }, - "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\"`.", - "items" : { - "type" : "string", - "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download." - }, - "readOnly" : true - }, "exportBucketId" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket to export to.", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -30285,7 +31343,7 @@ "finishedAt" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when this export job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "description" : "Date and time when this Export Job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", "readOnly" : true }, "id" : { @@ -30311,7 +31369,7 @@ }, "prefix" : { "type" : "string", - "description" : "Full path on the cloud provider bucket to the folder where the snapshot is exported.", + "description" : "Prefix used for all blob storage objects uploaded as part of the Export Job.", "pattern" : "/exported_snapshots/\\{ORG-NAME\\}/\\{PROJECT-NAME\\}/\\{CLUSTER-NAME\\}/\\{SNAPSHOT-INITIATION-DATE\\}/\\{TIMESTAMP\\}", "readOnly" : true }, @@ -30325,7 +31383,7 @@ }, "state" : { "type" : "string", - "description" : "State of the export job.", + "description" : "State of the Export Job.", "enum" : [ "Cancelled", "Failed", "InProgress", "Queued", "Successful" ], "readOnly" : true } @@ -30344,7 +31402,7 @@ }, "exportBucketId" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket to export to.", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -30545,7 +31603,15 @@ "properties" : { "downloadUrl" : { "type" : "string", - "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", + "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.", + "items" : { + "$ref" : "#/components/schemas/ApiPrivateDownloadDeliveryUrl" + }, "readOnly" : true }, "replicaSetName" : { @@ -30973,7 +32039,7 @@ "description" : "One or more Uniform Resource Locators (URLs) that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", "items" : { "type" : "string", - "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download." + "description" : "One Uniform Resource Locator that points to the compressed snapshot files for manual download." }, "readOnly" : true }, @@ -31042,6 +32108,14 @@ "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`.", "minimum" : 1199145600 }, + "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.", + "items" : { + "$ref" : "#/components/schemas/ApiPrivateDownloadDeliveryUrl" + }, + "readOnly" : true + }, "snapshotId" : { "type" : "string", "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", @@ -31055,7 +32129,7 @@ "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.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, "targetGroupId" : { "type" : "string", @@ -31095,7 +32169,7 @@ "description" : "Human-readable label that identifies the cluster with the Snapshot you want to return.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "copySettings" : { @@ -31196,7 +32270,7 @@ "description" : "Human-readable label that identifies the cluster with the Snapshot you want to return.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "copySettings" : { @@ -31291,9 +32365,15 @@ "additionalProperties" : { "type" : "object", "description" : "The stats associated with the stream processor.", + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor" + }, "readOnly" : true }, "description" : "The stats associated with the stream processor.", + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor" + }, "readOnly" : true }, "EARPrivateEndpoint" : { @@ -31336,7 +32416,7 @@ "status" : { "type" : "string", "description" : "State of the Encryption At Rest private endpoint.", - "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "ACTIVE", "FAILED" ], + "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "ACTIVE", "FAILED", "PENDING_RECREATION", "DELETING" ], "readOnly" : true } }, @@ -31376,6 +32456,36 @@ "required" : [ "typeName" ], "title" : "Email Notification" }, + "EmployeeAccessGrantView" : { + "type" : "object", + "description" : "MongoDB employee granted access level and expiration for a cluster.", + "properties" : { + "expirationTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Expiration date for the employee access grant." + }, + "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.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "required" : [ "expirationTime", "grantType" ] + }, "EncryptionAtRest" : { "type" : "object", "properties" : { @@ -31390,27 +32500,6 @@ } } }, - "EncryptionAtRestPrivateEndpointRequest" : { - "type" : "object", - "description" : "Create or delete private endpoints from the specified regions list.", - "properties" : { - "cloudProvider" : { - "type" : "string", - "description" : "Cloud service provider name.", - "enum" : [ "AZURE" ] - }, - "regions" : { - "type" : "array", - "description" : "List of regions.", - "items" : { - "type" : "string" - }, - "uniqueItems" : true - } - }, - "required" : [ "cloudProvider" ], - "title" : "Encryption At Rest Private Endpoints setup." - }, "EncryptionKeyAlertConfigViewForNdsGroup" : { "type" : "object", "description" : "Encryption key alert configuration allows to select thresholds which trigger alerts and how users are notified.", @@ -31636,7 +32725,7 @@ "title" : "Export Bucket Audit Types" }, { "type" : "string", - "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEX_CREATED", "FTS_INDEX_UPDATED", "FTS_INDEX_DELETED", "FTS_INDEX_CLEANED_UP", "FTS_INDEXES_RESTORED", "FTS_INDEXES_RESTORE_FAILED" ], + "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" : "FTS Index Audit Types" }, { "type" : "string", @@ -31656,7 +32745,7 @@ "title" : "Group Integration 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_ENOUGH_DISK_SPACE", "HOST_NOT_ENOUGH_DISK_SPACE" ], + "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_ENOUGH_DISK_SPACE", "HOST_NOT_ENOUGH_DISK_SPACE" ], "title" : "Host Event Types" }, { "type" : "string", @@ -31668,7 +32757,7 @@ "title" : "Index Build 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_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_SSL_ROTATED", "CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER", "CLUSTER_INSTANCE_SSL_REVOKED", "RELOAD_SSL_ON_PROCESSES", "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", "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", "MOVE_SKIPPED", "PROXY_RESTARTED", "PROXY_PANICKED", "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", "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", "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", "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", "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", "PENDING_INDEXES_DELETED", "PENDING_INDEXES_CANCELED", "PROCESS_RESTART_REQUESTED", "AUTO_HEALING_ACTION", "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", "CLUSTER_FORCE_RECONFIG_REQUESTED", "PROJECT_BYPASSED_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", "ATLAS_SQL_SCHEDULED_UPDATE_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_MODIFIED", "ATLAS_SQL_SCHEDULED_UPDATE_REMOVED" ], + "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_SSL_ROTATED", "CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER", "CLUSTER_INSTANCE_SSL_REVOKED", "RELOAD_SSL_ON_PROCESSES", "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", "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", "MOVE_SKIPPED", "PROXY_RESTARTED", "PROXY_PANICKED", "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", "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", "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", "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", "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", "CLUSTER_FORCE_RECONFIG_REQUESTED", "PROJECT_BYPASSED_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" ], "title" : "NDS Audit Types" }, { "type" : "string", @@ -31768,7 +32857,7 @@ "title" : "User Event Types" }, { "type" : "string", - "enum" : [ "CLUSTER_VERSION_FIXED", "CLUSTER_VERSION_UNFIXED", "CLUSTER_FCV_FIXED", "CLUSTER_FCV_UNFIXED", "AGENT_VERSION_FIXED", "AGENT_VERSION_UNFIXED", "FIXED_VERSION_UPDATED", "FIXED_AGENT_VERSION_UPDATED", "CLUSTER_FCV_DOWNGRADED" ], + "enum" : [ "CLUSTER_VERSION_FIXED", "CLUSTER_VERSION_UNFIXED", "CLUSTER_FCV_FIXED", "CLUSTER_FCV_UNFIXED", "CLUSTER_FCV_EXPIRATION_DATE_UPDATED", "AGENT_VERSION_FIXED", "AGENT_VERSION_UNFIXED", "FIXED_VERSION_UPDATED", "FIXED_AGENT_VERSION_UPDATED", "CLUSTER_FCV_DOWNGRADED", "CLUSTER_BINARY_VERSION_DOWNGRADED", "CLUSTER_BINARY_VERSION_UPGRADED" ], "title" : "Version Audit Types" }, { "type" : "string", @@ -31838,6 +32927,10 @@ "type" : "string", "enum" : [ "GROUP_TAGS_MODIFIED" ], "title" : "Resource Event Types" + }, { + "type" : "string", + "enum" : [ "RESOURCE_POLICY_CREATED", "RESOURCE_POLICY_MODIFIED", "RESOURCE_POLICY_DELETED" ], + "title" : "Atlas Resource Policy Audit Types" } ] }, "EventViewForNdsGroup" : { @@ -31916,6 +33009,8 @@ "$ref" : "#/components/schemas/UserEventViewForOrg" }, { "$ref" : "#/components/schemas/ResourceEventViewForOrg" + }, { + "$ref" : "#/components/schemas/AtlasResourcePolicyAuditForOrg" } ] }, "ExampleResourceResponse20230101" : { @@ -31976,7 +33071,7 @@ }, "ExportStatus" : { "type" : "object", - "description" : "State of the export job for the collections on the replica set only.", + "description" : "State of the Export Job.", "properties" : { "exportedCollections" : { "type" : "integer", @@ -32011,7 +33106,7 @@ "FTSIndexAuditTypeView" : { "type" : "string", "description" : "Unique identifier of event type.", - "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEX_CREATED", "FTS_INDEX_UPDATED", "FTS_INDEX_DELETED", "FTS_INDEX_CLEANED_UP", "FTS_INDEXES_RESTORED", "FTS_INDEXES_RESTORE_FAILED" ], + "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" ], "example" : "FTS_INDEX_CREATED", "title" : "FTS Index Audit Types" }, @@ -32917,37 +34012,53 @@ }, "title" : "Field Transformation" }, - "ForNdsGroup" : { + "FieldViolation" : { "type" : "object", - "description" : "ReplicaSet Event identifies different activities about replica set of mongod instances.", "properties" : { - "created" : { + "description" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "description" : "A description of why the request element is bad." }, - "eventTypeName" : { - "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroup" + "field" : { + "type" : "string", + "description" : "A path that leads to a field in the request body." + } + }, + "required" : [ "description", "field" ] + }, + "FlexBackupRestoreJob20250101" : { + "type" : "object", + "description" : "Details for one restore job of a flex cluster.", + "properties" : { + "deliveryType" : { + "type" : "string", + "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", + "enum" : [ "RESTORE", "DOWNLOAD" ], + "readOnly" : true }, - "groupId" : { + "expirationDate" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, + "instanceName" : { + "type" : "string", + "description" : "Human-readable label that identifies the source instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "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.", @@ -32960,485 +34071,317 @@ }, "readOnly" : true }, - "orgId" : { + "projectId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "port" : { - "type" : "integer", - "format" : "int32", - "description" : "IANA port on which the MongoDB process listens for requests.", - "example" : 27017, + "restoreFinishedDate" : { + "type" : "string", + "format" : "date-time", + "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.", "readOnly" : true }, - "raw" : { - "$ref" : "#/components/schemas/raw" - }, - "replicaSetName" : { + "restoreScheduledDate" : { "type" : "string", - "description" : "Human-readable label of the replica set associated with the event.", - "example" : "event-replica-set", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "shardName" : { + "snapshotFinishedDate" : { "type" : "string", - "description" : "Human-readable label of the shard associated with the event.", - "example" : "event-sh-01", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true - } - }, - "required" : [ "created", "eventTypeName", "id" ], - "title" : "ReplicaSet Events" - }, - "GCPCloudProviderContainer" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/CloudProviderContainer" - }, { - "type" : "object", - "properties" : { - "atlasCidrBlock" : { - "type" : "string", - "description" : "IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.\n\nThese CIDR blocks must fall within the ranges reserved per RFC 1918. GCP further limits the block to a lower bound of the `/18` range.\n\nTo modify the CIDR block, the target project cannot have:\n\n- Any M10 or greater clusters\n- Any other VPC peering connections\n\n 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.\n\n **Example:** A project in an Google Cloud (GCP) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets.", - "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" - }, - "gcpProjectId" : { - "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.", - "maxLength" : 26, - "minLength" : 26, - "pattern" : "^p-[0-9a-z]{24}$", - "readOnly" : true - }, - "networkName" : { - "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.", - "maxLength" : 36, - "minLength" : 36, - "pattern" : "^nt-[0-9a-f]{24}-[0-9a-z]{8}$", - "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.", - "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.", - "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" ] - } - } - } - } ], - "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", - "required" : [ "atlasCidrBlock" ], - "title" : "GCP" - }, - "GCPComputeAutoScaling" : { - "type" : "object", - "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", - "properties" : { - "maxInstanceSize" : { + }, + "snapshotId" : { "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" ], - "title" : "GCP Instance Sizes" + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "minInstanceSize" : { + "snapshotUrl" : { "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" ], - "title" : "GCP Instance Sizes" - } - }, - "title" : "GCP" - }, - "GCPConsumerForwardingRule" : { - "type" : "object", - "properties" : { - "endpointName" : { + "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" : "Human-readable label that identifies the Google Cloud consumer forwarding rule that you created.", - "externalDocs" : { - "description" : "Google Cloud Forwarding Rule Concepts", - "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" - }, + "description" : "Phase of the restore workflow for this job at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], "readOnly" : true }, - "ipAddress" : { + "targetDeploymentItemName" : { "type" : "string", - "description" : "One Private Internet Protocol version 4 (IPv4) address to which this Google Cloud consumer forwarding rule resolves.", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "description" : "Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another USS instance or Dedicated cluster tier.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", "readOnly" : true }, - "status" : { + "targetProjectId" : { "type" : "string", - "description" : "State of the MongoDB Cloud endpoint group when MongoDB Cloud received this request.", - "enum" : [ "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true } - } + }, + "title" : "Flex Backup Restore Job" }, - "GCPEndpointService" : { + "FlexBackupRestoreJobCreate20250101" : { "type" : "object", - "description" : "Group of Private Endpoint Service settings.", + "description" : "Details to create one restore job of a flex cluster.", "properties" : { - "cloudProvider" : { + "_snapshotId" : { "type" : "string", - "description" : "Cloud service provider that serves the requested endpoint service.", - "enum" : [ "AWS", "AZURE", "GCP" ], - "readOnly" : true + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true }, - "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" - }, - "items" : { - "type" : "string", - "description" : "One Google Cloud network endpoint group that corresponds to the Private Service Connect endpoint service." - } + "_targetDeploymentItemName" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another flex cluster or dedicated cluster tier.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", + "writeOnly" : true }, - "errorMessage" : { + "_targetProjectId" : { "type" : "string", - "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "deliveryType" : { + "type" : "string", + "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", + "enum" : [ "RESTORE", "DOWNLOAD" ], + "readOnly" : true + }, + "expirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "regionName" : { + "instanceName" : { "type" : "string", - "description" : "Cloud provider region that manages this Private Endpoint Service.", + "description" : "Human-readable label that identifies the source instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, - "serviceAttachmentNames" : { + "links" : { "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.", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", "externalDocs" : { - "description" : "Google Cloud Private Service Connect Service Attachments", - "url" : "https://cloud.google.com/vpc/docs/private-service-connect#service-attachments" + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" }, "items" : { - "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.", - "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\\-]+" - } + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true }, - "status" : { + "projectId" : { "type" : "string", - "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", - "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true - } - }, - "required" : [ "cloudProvider" ], - "title" : "GCP" - }, - "GCPHardwareSpec" : { - "type" : "object", - "properties" : { - "instanceSize" : { + }, + "restoreFinishedDate" : { "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" ], - "title" : "GCP Instance Sizes" + "format" : "date-time", + "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.", + "readOnly" : true }, - "nodeCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + "restoreScheduledDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "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.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true } - } + }, + "required" : [ "_snapshotId", "_targetDeploymentItemName" ], + "title" : "Create Flex Backup Restore Job" }, - "GCPHardwareSpec20240805" : { + "FlexBackupSettings20250101" : { "type" : "object", + "description" : "Flex backup configuration", "properties" : { - "diskSizeGB" : { - "type" : "number", - "format" : "double", - "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", - "maximum" : 4096, - "minimum" : 10 - }, - "instanceSize" : { - "type" : "string", - "description" : "Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as \"base nodes\") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.", - "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], - "title" : "GCP Instance Sizes" - }, - "nodeCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + "enabled" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether backups are performed for this flex cluster. Backup uses [TODO](TODO) for flex clusters.", + "readOnly" : true } - } + }, + "readOnly" : true, + "title" : "Flex Backup Configuration" }, - "GCPNetworkPeeringConnectionSettings" : { + "FlexBackupSnapshot20250101" : { "type" : "object", - "description" : "Group of Network Peering connection settings.", + "description" : "Details for one snapshot of a flex cluster.", "properties" : { - "containerId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" - }, - "errorMessage" : { + "expiration" : { "type" : "string", - "description" : "Details of the error returned when requesting a GCP network peering resource. The resource returns `null` if the request succeeded.", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "gcpProjectId" : { + "finishTime" : { "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.", - "maxLength" : 30, - "minLength" : 6, - "pattern" : "^[a-z][0-9a-z-]{4,28}[0-9a-z]{1}" + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "networkName" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBVersion" : { "type" : "string", - "description" : "Human-readable label that identifies the network to peer with the MongoDB Cloud VPC.", - "maxLength" : 63, - "minLength" : 1, - "pattern" : "[a-z]([-a-z0-9]{0,62}[a-z0-9]{0,1})?" + "description" : "MongoDB host version that the snapshot runs.", + "readOnly" : true }, - "providerName" : { + "scheduledTime" : { "type" : "string", - "description" : "Cloud service provider that serves the requested network peering connection.", - "enum" : [ "AWS", "AZURE", "GCP" ] + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will take the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "startTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began taking the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true }, "status" : { "type" : "string", - "description" : "State of the network peering connection at the time you made the request.", - "enum" : [ "ADDING_PEER", "WAITING_FOR_USER", "AVAILABLE", "FAILED", "DELETING" ], + "description" : "Phase of the workflow for this snapshot at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], "readOnly" : true } }, - "required" : [ "containerId", "gcpProjectId", "networkName" ], - "title" : "GCP" + "title" : "Flex Backup Snapshot" }, - "GCPRegionConfig" : { + "FlexBackupSnapshotDownloadCreate20250101" : { "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/CloudRegionConfig" - }, { - "type" : "object", - "properties" : { - "analyticsAutoScaling" : { - "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" - }, - "analyticsSpecs" : { - "$ref" : "#/components/schemas/DedicatedHardwareSpec" + "description" : "Details for one backup snapshot download of a flex cluster.", + "properties" : { + "_snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to download.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" }, - "autoScaling" : { - "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + "items" : { + "$ref" : "#/components/schemas/Link" }, - "readOnlySpecs" : { - "$ref" : "#/components/schemas/DedicatedHardwareSpec" - } + "readOnly" : true } - } ], - "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", - "title" : "GCP Regional Replication Specifications" - }, - "GCPRegionConfig20240805" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/CloudRegionConfig20240805" - }, { - "type" : "object", - "properties" : { - "analyticsAutoScaling" : { - "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" - }, - "analyticsSpecs" : { - "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" - }, - "autoScaling" : { - "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" - }, - "readOnlySpecs" : { - "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" - } - } - } ], - "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", - "title" : "GCP Regional Replication Specifications" - }, - "GeoSharding" : { - "type" : "object", - "properties" : { - "customZoneMapping" : { - "type" : "object", - "additionalProperties" : { - "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `id` property.\n\nThis parameter returns an empty object if no custom zones exist.", - "readOnly" : true - }, - "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `id` property.\n\nThis 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.", - "items" : { - "$ref" : "#/components/schemas/ManagedNamespaces" - }, - "readOnly" : true - }, - "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 - } - } - }, - "GeoSharding20240805" : { - "type" : "object", - "properties" : { - "customZoneMapping" : { - "type" : "object", - "additionalProperties" : { - "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.\n\nThis parameter returns an empty object if no custom zones exist.", - "readOnly" : true - }, - "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.\n\nThis 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.", - "items" : { - "$ref" : "#/components/schemas/ManagedNamespaces" - }, - "readOnly" : true - }, - "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 - } - } - }, - "GoogleCloudKMS" : { - "type" : "object", - "description" : "Details that define the configuration of Encryption at Rest using Google Cloud Key Management Service (KMS).", - "externalDocs" : { - "description" : "Google Cloud Key Management Service", - "url" : "https://www.mongodb.com/docs/atlas/security-gcp-kms/" }, - "properties" : { - "enabled" : { - "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" - }, - "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.", - "externalDocs" : { - "description" : "Google Cloud Authentication", - "url" : "https://cloud.google.com/docs/authentication/getting-started" - }, - "writeOnly" : true - }, - "valid" : { - "type" : "boolean", - "description" : "Flag that indicates whether the Google Cloud Key Management Service (KMS) encryption key can encrypt and decrypt data.", - "readOnly" : true - } - } + "required" : [ "_snapshotId" ], + "title" : "Flex Backup Snapshot Download Create" }, - "GreaterThanDaysThresholdView" : { + "FlexClusterDescription20250101" : { "type" : "object", - "description" : "Threshold value that triggers an alert.", + "description" : "Group of settings that configure a MongoDB Flex cluster.", "properties" : { - "operator" : { - "type" : "string", - "description" : "Comparison operator to apply when checking the current metric value.", - "enum" : [ "GREATER_THAN" ] - }, - "threshold" : { - "type" : "integer", - "format" : "int32", - "description" : "Value of metric that, when exceeded, triggers an alert." + "backupSettings" : { + "$ref" : "#/components/schemas/FlexBackupSettings20250101" }, - "units" : { - "type" : "string", - "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", - "enum" : [ "DAYS" ] - } - } - }, - "GreaterThanRawThreshold" : { - "type" : "object", - "description" : "A Limit that triggers an alert when greater than a number.", - "properties" : { - "operator" : { + "clusterType" : { "type" : "string", - "description" : "Comparison operator to apply when checking the current metric value.", - "enum" : [ "GREATER_THAN" ] + "description" : "Flex cluster topology.", + "enum" : [ "REPLICASET", "LOADBALANCED" ], + "readOnly" : true }, - "threshold" : { - "type" : "integer", - "format" : "int32", - "description" : "Value of metric that, when exceeded, triggers an alert." + "connectionStrings" : { + "$ref" : "#/components/schemas/FlexConnectionStrings20250101" }, - "units" : { - "$ref" : "#/components/schemas/RawMetricUnits" - } - }, - "title" : "Greater Than Raw Threshold" - }, - "GreaterThanRawThresholdAlertConfigViewForNdsGroup" : { - "type" : "object", - "properties" : { - "created" : { + "createDate" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Date and time when MongoDB Cloud created this instance. This parameter expresses its value in ISO 8601 format in UTC.", "readOnly" : true }, - "enabled" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." - }, - "eventTypeName" : { - "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" - }, "groupId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "description" : "Unique 24-hexadecimal character string that identifies the project.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -33447,7 +34390,7 @@ }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "description" : "Unique 24-hexadecimal digit string that identifies the instance.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -33466,76 +34409,60 @@ }, "readOnly" : true }, - "matchers" : { - "type" : "array", - "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", - "items" : { - "$ref" : "#/components/schemas/ReplicaSetMatcher" - } + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the instance runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true }, - "notifications" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "readOnly" : true + }, + "providerSettings" : { + "$ref" : "#/components/schemas/FlexProviderSettings20250101" + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of this instance.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { "type" : "array", - "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, "items" : { - "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + "$ref" : "#/components/schemas/ResourceTag" } }, - "threshold" : { - "$ref" : "#/components/schemas/GreaterThanRawThreshold" + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." }, - "updated" : { + "versionReleaseSystem" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions.", + "enum" : [ "LTS" ], "readOnly" : true } }, - "required" : [ "eventTypeName", "notifications" ] - }, - "GreaterThanTimeThreshold" : { - "type" : "object", - "description" : "A Limit that triggers an alert when greater than a time period.", - "properties" : { - "operator" : { - "type" : "string", - "description" : "Comparison operator to apply when checking the current metric value.", - "enum" : [ "GREATER_THAN" ] - }, - "threshold" : { - "type" : "integer", - "format" : "int32", - "description" : "Value of metric that, when exceeded, triggers an alert." - }, - "units" : { - "$ref" : "#/components/schemas/TimeMetricUnits" - } - }, - "title" : "Greater Than Time Threshold" + "required" : [ "providerSettings" ], + "title" : "Flex Cluster Description" }, - "Group" : { + "FlexClusterDescriptionCreate20250101" : { "type" : "object", + "description" : "Settings that you can specify when you create a flex cluster.", "properties" : { - "clusterCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Quantity of MongoDB Cloud clusters deployed in this project.", - "readOnly" : true - }, - "created" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created this project. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true - }, - "id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, "links" : { "type" : "array", "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", @@ -33550,145 +34477,161 @@ }, "name" : { "type" : "string", - "description" : "Human-readable label that identifies the project included in the MongoDB Cloud organization.", + "description" : "Human-readable label that identifies the instance.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" - }, - "orgId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud organization to which the project belongs.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "writeOnly" : true }, - "regionUsageRestrictions" : { - "type" : "string", - "default" : "COMMERCIAL_FEDRAMP_REGIONS_ONLY", - "description" : "Applies to Atlas for Government only.\n\nIn Commercial Atlas, this field will be rejected in requests and missing in responses.\n\nThis field sets restrictions on available regions in the project.\n\n| Value | Available Regions |\n|-----------------------------------|------------|\n| `COMMERCIAL_FEDRAMP_REGIONS_ONLY` | Only allows deployments in FedRAMP Moderate regions.|\n| `GOV_REGIONS_ONLY` | Only allows deployments in GovCloud regions.|", - "enum" : [ "COMMERCIAL_FEDRAMP_REGIONS_ONLY", "GOV_REGIONS_ONLY" ], - "externalDocs" : { - "url" : "https://www.mongodb.com/docs/atlas/government/overview/supported-regions/#supported-cloud-providers-and-regions" - } + "providerSettings" : { + "$ref" : "#/components/schemas/FlexProviderSettingsCreate20250101" }, "tags" : { "type" : "array", - "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the project.", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.", "externalDocs" : { "description" : "Resource Tags", - "url" : "https://www.mongodb.com/docs/atlas/tags" + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" }, "items" : { "$ref" : "#/components/schemas/ResourceTag" } }, - "withDefaultAlertsSettings" : { + "terminationProtectionEnabled" : { "type" : "boolean", - "description" : "Flag that indicates whether to create the project with default alert settings.", - "writeOnly" : true + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." } }, - "required" : [ "clusterCount", "created", "name", "orgId" ] + "required" : [ "name", "providerSettings" ], + "title" : "Flex Cluster Description Create" }, - "GroupAlertsConfig" : { + "FlexConnectionStrings20250101" : { "type" : "object", - "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/StreamProcessorAlertConfigViewForNdsGroup" - } ] + "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "properties" : { + "standard" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this cluster. This connection string uses the mongodb:// protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "standardSrv" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this flex cluster. This connection string uses the `mongodb+srv://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Flex Cluster Connection Strings" }, - "GroupIPAddresses" : { + "FlexProviderSettings20250101" : { "type" : "object", - "description" : "List of IP addresses in a project.", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB flex cluster.", "properties" : { - "groupId" : { + "backingProviderName" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the flex cluster.", + "enum" : [ "AWS", "AZURE", "GCP" ], "readOnly" : true }, - "services" : { - "$ref" : "#/components/schemas/GroupService" + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity available to the flex cluster expressed in gigabytes.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "default" : "FLEX", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "FLEX" ], + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB flex cluster. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).", + "readOnly" : true } }, - "title" : "Group IP Address" + "readOnly" : true, + "title" : "Cloud Service Provider Settings for a Flex Cluster" }, - "GroupInvitation" : { + "FlexProviderSettingsCreate20250101" : { "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB flex cluster.", "properties" : { - "createdAt" : { + "backingProviderName" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud sent the invitation. This parameter expresses its value in ISO 8601 format in UTC.", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the flex cluster.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "writeOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity available to the flex cluster expressed in gigabytes.", "readOnly" : true }, - "expiresAt" : { + "providerName" : { + "type" : "string", + "default" : "FLEX", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "FLEX" ], + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB flex cluster. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).", + "writeOnly" : true + } + }, + "required" : [ "backingProviderName", "regionName" ], + "title" : "Cloud Service Provider Settings for a Flex Cluster", + "writeOnly" : true + }, + "ForNdsGroup" : { + "type" : "object", + "description" : "ReplicaSet Event identifies different activities about replica set of mongod instances.", + "properties" : { + "created" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when MongoDB Cloud expires the invitation. This parameter expresses its value in ISO 8601 format in UTC.", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroup" + }, "groupId" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the project.", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "groupName" : { - "type" : "string", - "description" : "Human-readable label that identifies the project to which you invited the MongoDB Cloud user.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", - "readOnly" : true - }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the invitation.", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "inviterUsername" : { - "type" : "string", - "format" : "email", - "description" : "Email address of the MongoDB Cloud user who sent the invitation.", - "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.", @@ -33701,56 +34644,828 @@ }, "readOnly" : true }, - "roles" : { - "type" : "array", - "description" : "One or more organization or project level roles to assign to the MongoDB Cloud user.", - "items" : { - "type" : "string", - "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] - }, - "uniqueItems" : true + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "username" : { + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "replicaSetName" : { "type" : "string", - "format" : "email", - "description" : "Email address of the MongoDB Cloud user invited to join the project.", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", "readOnly" : true - } - } - }, - "GroupInvitationRequest" : { - "type" : "object", - "properties" : { - "roles" : { - "type" : "array", - "description" : "One or more project level roles to assign to the MongoDB Cloud user.", - "items" : { - "type" : "string", - "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] - }, - "uniqueItems" : true }, - "username" : { + "shardName" : { "type" : "string", - "format" : "email", - "description" : "Email address of the MongoDB Cloud user invited to the specified project." + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true } - } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "ReplicaSet Events" }, - "GroupInvitationUpdateRequest" : { + "GCPCloudProviderContainer" : { "type" : "object", - "properties" : { - "roles" : { - "type" : "array", - "description" : "One or more organization or project level roles to assign to the MongoDB Cloud user.", - "items" : { + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, { + "type" : "object", + "properties" : { + "atlasCidrBlock" : { "type" : "string", - "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + "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.\n\nThese CIDR blocks must fall within the ranges reserved per RFC 1918. GCP further limits the block to a lower bound of the `/18` range.\n\nTo modify the CIDR block, the target project cannot have:\n\n- Any M10 or greater clusters\n- Any other VPC peering connections\n\n 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.\n\n **Example:** A project in an Google Cloud (GCP) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets.", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" }, - "uniqueItems" : true - } - } - }, + "gcpProjectId" : { + "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.", + "maxLength" : 26, + "minLength" : 26, + "pattern" : "^p-[0-9a-z]{24}$", + "readOnly" : true + }, + "networkName" : { + "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.", + "maxLength" : 36, + "minLength" : 36, + "pattern" : "^nt-[0-9a-f]{24}-[0-9a-z]{8}$", + "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.", + "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.", + "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" ] + } + } + } + } ], + "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", + "required" : [ "atlasCidrBlock" ], + "title" : "GCP" + }, + "GCPComputeAutoScaling" : { + "type" : "object", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", + "properties" : { + "maxInstanceSize" : { + "type" : "string", + "description" : "Maximum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "minInstanceSize" : { + "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" ], + "title" : "GCP Instance Sizes" + } + }, + "title" : "GCP" + }, + "GCPConsumerForwardingRule" : { + "type" : "object", + "properties" : { + "endpointName" : { + "type" : "string", + "description" : "Human-readable label that identifies the Google Cloud consumer forwarding rule that you created.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "One Private Internet Protocol version 4 (IPv4) address to which this Google Cloud consumer forwarding rule resolves.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the MongoDB Cloud endpoint group when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + } + }, + "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" ] + } + } + } ] + }, + "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.", + "enum" : [ "CENTRAL_US", "WESTERN_EUROPE" ], + "readOnly" : true + } + } + } ] + }, + "GCPEndpointService" : { + "type" : "object", + "description" : "Group of Private Endpoint Service settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "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" + }, + "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" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "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" + }, + "items" : { + "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.", + "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\\-]+" + } + }, + "status" : { + "type" : "string", + "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "GCP" + }, + "GCPHardwareSpec" : { + "type" : "object", + "properties" : { + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts 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" ], + "title" : "GCP Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "GCPHardwareSpec20240805" : { + "type" : "object", + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as \"base nodes\") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "GCPNetworkPeeringConnectionSettings" : { + "type" : "object", + "description" : "Group of Network Peering connection settings.", + "properties" : { + "containerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "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" : { + "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.", + "maxLength" : 30, + "minLength" : 6, + "pattern" : "^[a-z][0-9a-z-]{4,28}[0-9a-z]{1}" + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "networkName" : { + "type" : "string", + "description" : "Human-readable label that identifies the network to peer with the MongoDB Cloud VPC.", + "maxLength" : 63, + "minLength" : 1, + "pattern" : "[a-z]([-a-z0-9]{0,62}[a-z0-9]{0,1})?" + }, + "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.", + "enum" : [ "ADDING_PEER", "WAITING_FOR_USER", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "containerId", "gcpProjectId", "networkName" ], + "title" : "GCP" + }, + "GCPRegionConfig" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "GCP Regional Replication Specifications" + }, + "GCPRegionConfig20240805" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20240805" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "GCP Regional Replication Specifications" + }, + "GeoSharding" : { + "type" : "object", + "properties" : { + "customZoneMapping" : { + "type" : "object", + "additionalProperties" : { + "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `id` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `id` property.\n\nThis 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.", + "items" : { + "$ref" : "#/components/schemas/ManagedNamespaces" + }, + "readOnly" : true + }, + "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 + } + } + }, + "GeoSharding20240805" : { + "type" : "object", + "properties" : { + "customZoneMapping" : { + "type" : "object", + "additionalProperties" : { + "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.\n\nThis 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.", + "items" : { + "$ref" : "#/components/schemas/ManagedNamespaces" + }, + "readOnly" : true + }, + "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 + } + } + }, + "GoogleCloudKMS" : { + "type" : "object", + "description" : "Details that define the configuration of Encryption at Rest using Google Cloud Key Management Service (KMS).", + "externalDocs" : { + "description" : "Google Cloud Key Management Service", + "url" : "https://www.mongodb.com/docs/atlas/security-gcp-kms/" + }, + "properties" : { + "enabled" : { + "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" + }, + "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.", + "externalDocs" : { + "description" : "Google Cloud Authentication", + "url" : "https://cloud.google.com/docs/authentication/getting-started" + }, + "writeOnly" : true + }, + "valid" : { + "type" : "boolean", + "description" : "Flag that indicates whether the Google Cloud Key Management Service (KMS) encryption key can encrypt and decrypt data.", + "readOnly" : true + } + } + }, + "GreaterThanDaysThresholdView" : { + "type" : "object", + "description" : "Threshold value that triggers an alert.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "GREATER_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "DAYS" ] + } + } + }, + "GreaterThanRawThreshold" : { + "type" : "object", + "description" : "A Limit that triggers an alert when greater than a number.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "GREATER_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/RawMetricUnits" + } + }, + "title" : "Greater Than Raw Threshold" + }, + "GreaterThanRawThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ReplicaSetMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/GreaterThanRawThreshold" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ] + }, + "GreaterThanTimeThreshold" : { + "type" : "object", + "description" : "A Limit that triggers an alert when greater than a time period.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "GREATER_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "title" : "Greater Than Time Threshold" + }, + "Group" : { + "type" : "object", + "properties" : { + "clusterCount" : { + "type" : "integer", + "format" : "int64", + "description" : "Quantity of MongoDB Cloud clusters deployed in this project.", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this project. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the project included in the MongoDB Cloud organization.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud organization to which the project belongs.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "regionUsageRestrictions" : { + "type" : "string", + "default" : "COMMERCIAL_FEDRAMP_REGIONS_ONLY", + "description" : "Applies to Atlas for Government only.\n\nIn Commercial Atlas, this field will be rejected in requests and missing in responses.\n\nThis field sets restrictions on available regions in the project.\n\n| Value | Available Regions |\n|-----------------------------------|------------|\n| `COMMERCIAL_FEDRAMP_REGIONS_ONLY` | Only allows deployments in FedRAMP Moderate regions.|\n| `GOV_REGIONS_ONLY` | Only allows deployments in GovCloud regions.|", + "enum" : [ "COMMERCIAL_FEDRAMP_REGIONS_ONLY", "GOV_REGIONS_ONLY" ], + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/government/overview/supported-regions/#supported-cloud-providers-and-regions" + } + }, + "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" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "withDefaultAlertsSettings" : { + "type" : "boolean", + "description" : "Flag that indicates whether to create the project with default alert settings.", + "writeOnly" : true + } + }, + "required" : [ "clusterCount", "created", "name", "orgId" ] + }, + "GroupAlertsConfig" : { + "type" : "object", + "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/StreamProcessorAlertConfigViewForNdsGroup" + } ] + }, + "GroupIPAddresses" : { + "type" : "object", + "description" : "List of IP addresses in a project.", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "services" : { + "$ref" : "#/components/schemas/GroupService" + } + }, + "title" : "Group IP Address" + }, + "GroupInvitation" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud sent the invitation. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud expires the invitation. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "groupName" : { + "type" : "string", + "description" : "Human-readable label that identifies the project to which you invited the MongoDB Cloud user.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the invitation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "inviterUsername" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user who sent the invitation.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "roles" : { + "type" : "array", + "description" : "One or more organization or project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user invited to join the project.", + "readOnly" : true + } + } + }, + "GroupInvitationRequest" : { + "type" : "object", + "properties" : { + "roles" : { + "type" : "array", + "description" : "One or more project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user invited to the specified project." + } + } + }, + "GroupInvitationUpdateRequest" : { + "type" : "object", + "properties" : { + "roles" : { + "type" : "array", + "description" : "One or more organization or project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + } + } + }, "GroupMaintenanceWindow" : { "type" : "object", "properties" : { @@ -33794,22 +35509,27 @@ "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "pattern" : "^([a-f0-9]{24})$" }, "destinationOrgPrivateApiKey" : { "type" : "string", - "description" : "Unique string that identifies the private part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.", + "description" : "Unique string that identifies the private part of the API Key used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.", "example" : "55c3bbb6-b4bb-0be1-e66d20841f3e", - "readOnly" : true + "externalDocs" : { + "description" : "Grant Programmatic Access to Atlas", + "url" : "https://dochub.mongodb.org/core/atlas-create-prog-api-key" + } }, "destinationOrgPublicApiKey" : { "type" : "string", - "description" : "Unique string that identifies the public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.", + "description" : "Unique string that identifies the public part of the API Key used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.", "example" : "zmmrboas", + "externalDocs" : { + "description" : "Grant Programmatic Access to Atlas", + "url" : "https://dochub.mongodb.org/core/atlas-create-prog-api-key" + }, "maxLength" : 8, - "minLength" : 8, - "readOnly" : true + "minLength" : 8 } } }, @@ -33876,7 +35596,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/EventViewForNdsGroup" }, @@ -33909,6 +35629,28 @@ } } }, + "GroupRoleAssignment" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to which these roles belong.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "groupRoles" : { + "type" : "array", + "description" : "One or more project level roles assigned to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_OWNER", "GROUP_CLUSTER_MANAGER", "GROUP_STREAM_PROCESSING_OWNER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR" ] + }, + "uniqueItems" : true + } + } + }, "GroupService" : { "type" : "object", "description" : "List of IP addresses in a project categorized by services.", @@ -33928,37 +35670,37 @@ "GroupServiceAccount" : { "type" : "object", "properties" : { + "clientId" : { + "type" : "string", + "description" : "The Client ID of the Service Account.", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + }, "createdAt" : { "type" : "string", "format" : "date-time", - "description" : "Service account creation time." + "description" : "The date that the Service Account was created on." }, "description" : { "type" : "string", - "description" : "Description of the service account." - }, - "id" : { - "type" : "string", - "description" : "ID for the service account.", - "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + "description" : "Human readable description for the Service Account." }, "name" : { "type" : "string", - "description" : "Name for service account." + "description" : "Human-readable name for the Service Account." }, "roles" : { "type" : "array", - "description" : "Roles assigned to the Service Account group.", + "description" : "A list of Project roles associated with the Service Account.", "items" : { "type" : "string", - "description" : "Project roles associated with the service account.", + "description" : "Project roles available for Service Accounts.", "enum" : [ "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" ] }, "uniqueItems" : true }, "secrets" : { "type" : "array", - "description" : "List of secrets.", + "description" : "A list of secrets associated with the specified Service Account.", "items" : { "$ref" : "#/components/schemas/ServiceAccountSecret" }, @@ -33971,73 +35713,74 @@ "properties" : { "description" : { "type" : "string", - "description" : "Human readable description for the service account.", + "description" : "Human readable description for the Service Account.", "maxLength" : 250, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "name" : { "type" : "string", - "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "description" : "Human-readable name for the Service Account. The name is modifiable and does not have to be unique.", "maxLength" : 64, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "roles" : { "type" : "array", - "description" : "Project roles associated with the service account.", + "description" : "A list of project-level roles for the Service Account.", "items" : { "type" : "string", - "description" : "Project roles associated with the service account.", + "description" : "Project roles available for Service Accounts.", "enum" : [ "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" ] } }, "secretExpiresAfterHours" : { "type" : "integer", "format" : "int32", - "description" : "Secret expiration time." + "description" : "The expiration time of the new Service Account secret. The expiration is provided in hours." } }, - "required" : [ "description", "name", "secretExpiresAfterHours" ] + "required" : [ "description", "name", "roles", "secretExpiresAfterHours" ] }, "GroupServiceAccountRoleAssignment" : { "type" : "object", "properties" : { "roles" : { "type" : "array", - "description" : "Group access roles.", + "description" : "The Project permissions for the Service Account in the specified Project.", "items" : { "type" : "string", - "description" : "Project roles associated with the service account.", + "description" : "Project roles available for Service Accounts.", "enum" : [ "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" ] }, "uniqueItems" : true } - } + }, + "required" : [ "roles" ] }, "GroupServiceAccountUpdateRequest" : { "type" : "object", "properties" : { "description" : { "type" : "string", - "description" : "Human readable description for the service account.", + "description" : "Human readable description for the Service Account.", "maxLength" : 250, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "name" : { "type" : "string", - "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "description" : "Human-readable name for the Service Account. The name is modifiable and does not have to be unique.", "maxLength" : 64, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "roles" : { "type" : "array", - "description" : "Project roles associated with the service account.", + "description" : "A list of Project roles associated with the Service Account.", "items" : { "type" : "string", - "description" : "Project roles associated with the service account.", + "description" : "Project roles available for Service Accounts.", "enum" : [ "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" ] } } @@ -34281,7 +36024,7 @@ "example" : "cluster1", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -34376,14 +36119,14 @@ "HostEventTypeViewForNdsGroup" : { "type" : "string", "description" : "Unique identifier of event type.", - "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_ENOUGH_DISK_SPACE", "HOST_NOT_ENOUGH_DISK_SPACE" ], + "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_ENOUGH_DISK_SPACE", "HOST_NOT_ENOUGH_DISK_SPACE" ], "example" : "HOST_DOWN", "title" : "Host Event Types" }, "HostEventTypeViewForNdsGroupAlertable" : { "type" : "string", "description" : "Event type that triggers an alert.", - "enum" : [ "HOST_DOWN", "HOST_HAS_INDEX_SUGGESTIONS", "HOST_MONGOT_CRASHING_OOM", "HOST_NOT_ENOUGH_DISK_SPACE" ], + "enum" : [ "HOST_DOWN", "HOST_HAS_INDEX_SUGGESTIONS", "HOST_MONGOT_CRASHING_OOM", "HOST_MONGOT_STOP_REPLICATION", "HOST_NOT_ENOUGH_DISK_SPACE" ], "example" : "HOST_DOWN", "title" : "Host Event Types" }, @@ -34669,6 +36412,7 @@ "OPCOUNTER_REPL_INSERT" : "#/components/schemas/RawMetricAlertView", "OPCOUNTER_REPL_UPDATE" : "#/components/schemas/RawMetricAlertView", "OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricAlertView", + "OPERATIONS_QUERIES_KILLED" : "#/components/schemas/RawMetricAlertView", "OPERATIONS_SCAN_AND_ORDER" : "#/components/schemas/RawMetricAlertView", "OPERATION_THROTTLING_REJECTED_OPERATIONS" : "#/components/schemas/RawMetricAlertView", "OPLOG_MASTER_LAG_TIME_DIFF" : "#/components/schemas/TimeMetricAlertView", @@ -34738,7 +36482,7 @@ "example" : "cluster1", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -35047,6 +36791,7 @@ "OPCOUNTER_REPL_INSERT" : "#/components/schemas/RawMetricEventView", "OPCOUNTER_REPL_UPDATE" : "#/components/schemas/RawMetricEventView", "OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricEventView", + "OPERATIONS_QUERIES_KILLED" : "#/components/schemas/RawMetricEventView", "OPERATIONS_SCAN_AND_ORDER" : "#/components/schemas/RawMetricEventView", "OPERATION_THROTTLING_REJECTED_OPERATIONS" : "#/components/schemas/RawMetricEventView", "OPLOG_MASTER_LAG_TIME_DIFF" : "#/components/schemas/TimeMetricEventView", @@ -35352,6 +37097,7 @@ "OPCOUNTER_REPL_INSERT" : "#/components/schemas/RawMetricThresholdView", "OPCOUNTER_REPL_UPDATE" : "#/components/schemas/RawMetricThresholdView", "OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "OPERATIONS_QUERIES_KILLED" : "#/components/schemas/RawMetricThresholdView", "OPERATIONS_SCAN_AND_ORDER" : "#/components/schemas/RawMetricThresholdView", "OPERATION_THROTTLING_REJECTED_OPERATIONS" : "#/components/schemas/RawMetricThresholdView", "OPLOG_MASTER_LAG_TIME_DIFF" : "#/components/schemas/TimeMetricThresholdView", @@ -35398,7 +37144,9 @@ "enum" : [ "AVERAGE" ] }, "operator" : { - "$ref" : "#/components/schemas/Operator" + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, "threshold" : { "type" : "number", @@ -35750,7 +37498,7 @@ "description" : "Human-readable label that identifies the cluster that incurred the charge.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -35804,7 +37552,7 @@ "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.", - "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_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", "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_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_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" ], + "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_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", "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_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_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_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" ], "readOnly" : true }, "startDate" : { @@ -36094,6 +37842,323 @@ "description" : "Configuration of nodes that comprise the cluster.", "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] }, + "configServerManagementMode" : { + "type" : "string", + "default" : "ATLAS_MANAGED", + "description" : "Config Server Management Mode for creating or updating a sharded cluster.\n\nWhen configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings.\n\nWhen configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server.", + "enum" : [ "ATLAS_MANAGED", "FIXED_TO_DEDICATED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + } + }, + "configServerType" : { + "type" : "string", + "description" : "Describes a sharded cluster's config server type.", + "enum" : [ "DEDICATED", "EMBEDDED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + }, + "readOnly" : true + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/ClusterConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "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.", + "maximum" : 4096, + "minimum" : 10 + }, + "diskWarmingMode" : { + "type" : "string", + "default" : "FULLY_WARMED", + "description" : "Disk warming mode selection.", + "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], + "externalDocs" : { + "description" : "Reduce Secondary Disk Warming Impact", + "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" + } + }, + "encryptionAtRestProvider" : { + "type" : "string", + "description" : "Cloud service provider that manages your customer keys to provide an additional layer of Encryption at Rest for the cluster.", + "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "featureCompatibilityVersion" : { + "type" : "string", + "description" : "Feature compatibility version of the cluster.", + "readOnly" : true + }, + "featureCompatibilityVersionExpirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Feature compatibility version expiration date.", + "readOnly" : true + }, + "globalClusterSelfManagedSharding" : { + "type" : "boolean", + "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen 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.\n\nWhen 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.\n\nThis 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" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "labels" : { + "type" : "array", + "deprecated" : true, + "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBEmployeeAccessGrant" : { + "$ref" : "#/components/schemas/EmployeeAccessGrantView" + }, + "mongoDBMajorVersion" : { + "type" : "string", + "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", + "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-" + } + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the cluster runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)" + }, + "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.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "mongoURIUpdated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated the connection string. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "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.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + }, + "numShards" : { + "type" : "integer", + "format" : "int32", + "default" : 1, + "description" : "Number of shards up to 50 to deploy for a sharded cluster. The resource returns `1` to indicate a replica set and values of `2` and higher to indicate a sharded cluster. The returned value equals the number of shards in the cluster.", + "externalDocs" : { + "description" : "Sharding", + "url" : "https://docs.mongodb.com/manual/sharding/" + }, + "maximum" : 50, + "minimum" : 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", + "default" : "WORKLOAD_TYPE", + "description" : "Set this field to configure the replica set scaling mode for your cluster.\n\nBy default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes.\n\nWhen configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads.\n\nWhen configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads.", + "enum" : [ "SEQUENTIAL", "WORKLOAD_TYPE", "NODE_TYPE" ], + "externalDocs" : { + "description" : "Modify the Replica Set Scaling Mode", + "url" : "https://dochub.mongodb.org/core/scale-nodes" + } + }, + "replicationFactor" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "deprecated" : true, + "description" : "Number of members that belong to the replica set. Each member retains a copy of your databases, providing high availability and data redundancy. Use **replicationSpecs** instead.", + "enum" : [ 3, 5, 7 ] + }, + "replicationSpec" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RegionSpec" + }, + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "title" : "Region Configuration" + }, + "replicationSpecs" : { + "type" : "array", + "description" : "List of settings that configure your cluster regions.\n\n- For Global Clusters, each object in the array represents one zone where MongoDB Cloud deploys your clusters nodes.\n- For non-Global sharded clusters and replica sets, the single object represents where MongoDB Cloud deploys your clusters nodes.", + "items" : { + "$ref" : "#/components/schemas/LegacyReplicationSpec" + } + }, + "rootCertType" : { + "type" : "string", + "default" : "ISRGROOTX1", + "description" : "Root Certificate Authority that MongoDB Atlas clusters uses. MongoDB Cloud supports Internet Security Research Group.", + "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.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the cluster.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", + "enum" : [ "LTS", "CONTINUOUS" ] + } + }, + "title" : "Cluster Description" + }, + "LegacyAtlasTenantClusterUpgradeRequest" : { + "type" : "object", + "description" : "Request containing target state of tenant cluster to be upgraded", + "properties" : { + "acceptDataRisksAndForceReplicaSetReconfig" : { + "type" : "string", + "format" : "date-time", + "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", + "externalDocs" : { + "description" : "Reconfiguring a Replica Set during a regional outage", + "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + } + }, + "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", + "default" : "ATLAS_MANAGED", + "description" : "Config Server Management Mode for creating or updating a sharded cluster.\n\nWhen configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings.\n\nWhen configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server.", + "enum" : [ "ATLAS_MANAGED", "FIXED_TO_DEDICATED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + } + }, + "configServerType" : { + "type" : "string", + "description" : "Describes a sharded cluster's config server type.", + "enum" : [ "DEDICATED", "EMBEDDED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + }, + "readOnly" : true + }, "connectionStrings" : { "$ref" : "#/components/schemas/ClusterConnectionStrings" }, @@ -36129,6 +38194,17 @@ "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" } }, + "featureCompatibilityVersion" : { + "type" : "string", + "description" : "Feature compatibility version of the cluster.", + "readOnly" : true + }, + "featureCompatibilityVersionExpirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Feature compatibility version expiration date.", + "readOnly" : true + }, "globalClusterSelfManagedSharding" : { "type" : "boolean", "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen 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.\n\nWhen 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.\n\nThis setting cannot be changed once the cluster is deployed.", @@ -36175,6 +38251,9 @@ }, "readOnly" : true }, + "mongoDBEmployeeAccessGrant" : { + "$ref" : "#/components/schemas/EmployeeAccessGrantView" + }, "mongoDBMajorVersion" : { "type" : "string", "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", @@ -36217,7 +38296,7 @@ "description" : "Human-readable label that identifies the cluster.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, "numShards" : { "type" : "integer", @@ -36250,259 +38329,16 @@ "providerSettings" : { "$ref" : "#/components/schemas/ClusterProviderSettings" }, - "replicationFactor" : { - "type" : "integer", - "format" : "int32", - "default" : 3, - "deprecated" : true, - "description" : "Number of members that belong to the replica set. Each member retains a copy of your databases, providing high availability and data redundancy. Use **replicationSpecs** instead.", - "enum" : [ 3, 5, 7 ] - }, - "replicationSpec" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/RegionSpec" - }, - "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", - "title" : "Region Configuration" - }, - "replicationSpecs" : { - "type" : "array", - "description" : "List of settings that configure your cluster regions.\n\n- For Global Clusters, each object in the array represents one zone where MongoDB Cloud deploys your clusters nodes.\n- For non-Global sharded clusters and replica sets, the single object represents where MongoDB Cloud deploys your clusters nodes.", - "items" : { - "$ref" : "#/components/schemas/LegacyReplicationSpec" - } - }, - "rootCertType" : { - "type" : "string", - "default" : "ISRGROOTX1", - "description" : "Root Certificate Authority that MongoDB Atlas clusters uses. MongoDB Cloud supports Internet Security Research Group.", - "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.", - "externalDocs" : { - "description" : "Connection string URI format.", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, - "readOnly" : true - }, - "stateName" : { + "replicaSetScalingStrategy" : { "type" : "string", - "description" : "Human-readable label that indicates the current operating condition of the cluster.", - "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], - "readOnly" : true - }, - "tags" : { - "type" : "array", - "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "default" : "WORKLOAD_TYPE", + "description" : "Set this field to configure the replica set scaling mode for your cluster.\n\nBy default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes.\n\nWhen configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads.\n\nWhen configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads.", + "enum" : [ "SEQUENTIAL", "WORKLOAD_TYPE", "NODE_TYPE" ], "externalDocs" : { - "description" : "Resource Tags", - "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" - }, - "items" : { - "$ref" : "#/components/schemas/ResourceTag" - } - }, - "terminationProtectionEnabled" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." - }, - "versionReleaseSystem" : { - "type" : "string", - "default" : "LTS", - "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", - "enum" : [ "LTS", "CONTINUOUS" ] - } - }, - "title" : "Cluster Description" - }, - "LegacyAtlasTenantClusterUpgradeRequest" : { - "type" : "object", - "description" : "Request containing target state of tenant cluster to be upgraded", - "properties" : { - "acceptDataRisksAndForceReplicaSetReconfig" : { - "type" : "string", - "format" : "date-time", - "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", - "externalDocs" : { - "description" : "Reconfiguring a Replica Set during a regional outage", - "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + "description" : "Modify the Replica Set Scaling Mode", + "url" : "https://dochub.mongodb.org/core/scale-nodes" } }, - "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" ] - }, - "connectionStrings" : { - "$ref" : "#/components/schemas/ClusterConnectionStrings" - }, - "createDate" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", - "readOnly" : true - }, - "diskSizeGB" : { - "type" : "number", - "format" : "double", - "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.", - "maximum" : 4096, - "minimum" : 10 - }, - "diskWarmingMode" : { - "type" : "string", - "default" : "FULLY_WARMED", - "description" : "Disk warming mode selection.", - "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], - "externalDocs" : { - "description" : "Reduce Secondary Disk Warming Impact", - "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" - } - }, - "encryptionAtRestProvider" : { - "type" : "string", - "description" : "Cloud service provider that manages your customer keys to provide an additional layer of Encryption at Rest for the cluster.", - "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], - "externalDocs" : { - "description" : "Encryption at Rest using Customer Key Management", - "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" - } - }, - "globalClusterSelfManagedSharding" : { - "type" : "boolean", - "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen 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.\n\nWhen 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.\n\nThis 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" : { - "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the project.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "labels" : { - "type" : "array", - "deprecated" : true, - "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", - "items" : { - "$ref" : "#/components/schemas/ComponentLabel" - } - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - }, - "mongoDBMajorVersion" : { - "type" : "string", - "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", - "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-" - } - }, - "mongoDBVersion" : { - "type" : "string", - "description" : "Version of MongoDB that the cluster runs.", - "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)" - }, - "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.", - "externalDocs" : { - "description" : "Connection string URI format.", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, - "readOnly" : true - }, - "mongoURIUpdated" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when someone last updated the connection string. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", - "readOnly" : true - }, - "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.", - "externalDocs" : { - "description" : "Connection string URI format.", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "Human-readable label that identifies the cluster.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - }, - "numShards" : { - "type" : "integer", - "format" : "int32", - "default" : 1, - "description" : "Number of shards up to 50 to deploy for a sharded cluster. The resource returns `1` to indicate a replica set and values of `2` and higher to indicate a sharded cluster. The returned value equals the number of shards in the cluster.", - "externalDocs" : { - "description" : "Sharding", - "url" : "https://docs.mongodb.com/manual/sharding/" - }, - "maximum" : 50, - "minimum" : 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" - }, "replicationFactor" : { "type" : "integer", "format" : "int32", @@ -37049,6 +38885,10 @@ "type" : "string", "enum" : [ "INSTANCE_NAME", "PROCESSOR_NAME" ], "title" : "Streams Matcher Fields" + }, { + "type" : "string", + "enum" : [ "RULE_ID" ], + "title" : "Log Ingestion Matcher Fields" } ] }, "MatcherHostType" : { @@ -37699,7 +39539,7 @@ "NDSAuditTypeViewForNdsGroup" : { "type" : "string", "description" : "Unique identifier of event type.", - "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_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_SSL_ROTATED", "CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER", "CLUSTER_INSTANCE_SSL_REVOKED", "RELOAD_SSL_ON_PROCESSES", "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", "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", "MOVE_SKIPPED", "PROXY_RESTARTED", "PROXY_PANICKED", "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", "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", "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", "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", "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", "PENDING_INDEXES_DELETED", "PENDING_INDEXES_CANCELED", "PROCESS_RESTART_REQUESTED", "AUTO_HEALING_ACTION", "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", "CLUSTER_FORCE_RECONFIG_REQUESTED", "PROJECT_BYPASSED_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", "ATLAS_SQL_SCHEDULED_UPDATE_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_MODIFIED", "ATLAS_SQL_SCHEDULED_UPDATE_REMOVED" ], + "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_SSL_ROTATED", "CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER", "CLUSTER_INSTANCE_SSL_REVOKED", "RELOAD_SSL_ON_PROCESSES", "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", "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", "MOVE_SKIPPED", "PROXY_RESTARTED", "PROXY_PANICKED", "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", "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", "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", "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", "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", "CLUSTER_FORCE_RECONFIG_REQUESTED", "PROJECT_BYPASSED_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" ], "example" : "CLUSTER_CREATED", "title" : "NDS Audit Types" }, @@ -38596,7 +40436,7 @@ "example" : "cluster1", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -38838,7 +40678,9 @@ "enum" : [ "AVERAGE" ] }, "operator" : { - "$ref" : "#/components/schemas/Operator" + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, "threshold" : { "type" : "number", @@ -39022,6 +40864,54 @@ "required" : [ "typeName" ], "title" : "OpsGenie Notification" }, + "OrgActiveUserResponse" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OrgUserResponse" + }, { + "type" : "object", + "properties" : { + "country" : { + "type" : "string", + "description" : "Two alphabet characters that identifies MongoDB Cloud user's geographic location. This parameter uses the ISO 3166-1a2 code format.", + "example" : "US", + "pattern" : "^([A-Z]{2})$", + "readOnly" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the current account. This value is in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "firstName" : { + "type" : "string", + "description" : "First or given name that belongs to the MongoDB Cloud user.", + "example" : "John", + "readOnly" : true + }, + "lastAuth" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the current account last authenticated. This value is in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "lastName" : { + "type" : "string", + "description" : "Last name, family name, or surname that belongs to the MongoDB Cloud user.", + "example" : "Doe", + "readOnly" : true + }, + "mobileNumber" : { + "type" : "string", + "description" : "Mobile phone number that belongs to the MongoDB Cloud user.", + "pattern" : "(?:(?:\\\\+?1\\\\s*(?:[.-]\\\\s*)?)?(?:(\\\\s*([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9])\\\\s*)|([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9]))\\\\s*(?:[.-]\\\\s*)?)([2-9]1[02-9]|[2-9][02-9]1|[2-9][02-9]{2})\\\\s*(?:[.-]\\\\s*)?([0-9]{4})$", + "readOnly" : true + } + } + } ], + "required" : [ "createdAt", "firstName", "id", "lastName", "orgMembershipStatus", "roles", "username" ] + }, "OrgEventTypeViewForOrg" : { "type" : "string", "description" : "Unique identifier of event type.", @@ -39303,7 +41193,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/EventViewForOrg" }, @@ -39318,40 +41208,69 @@ } } }, + "OrgPendingUserResponse" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OrgUserResponse" + }, { + "type" : "object", + "properties" : { + "invitationCreatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud sent the invitation. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "invitationExpiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the invitation from MongoDB Cloud expires. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "inviterUsername" : { + "type" : "string", + "format" : "email", + "description" : "Username of the MongoDB Cloud user who sent the invitation to join the organization.", + "readOnly" : true + } + } + } ], + "required" : [ "id", "invitationCreatedAt", "invitationExpiresAt", "inviterUsername", "orgMembershipStatus", "roles", "username" ] + }, "OrgServiceAccount" : { "type" : "object", "properties" : { + "clientId" : { + "type" : "string", + "description" : "The Client ID of the Service Account.", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + }, "createdAt" : { "type" : "string", "format" : "date-time", - "description" : "Service account creation time." + "description" : "The date that the Service Account was created on." }, "description" : { "type" : "string", - "description" : "Description of the service account." - }, - "id" : { - "type" : "string", - "description" : "ID for the service account.", - "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + "description" : "Human readable description for the Service Account." }, "name" : { "type" : "string", - "description" : "Name for service account." + "description" : "Human-readable name for the Service Account." }, "roles" : { "type" : "array", - "description" : "Organization roles assigned to the Service Account.", + "description" : "A list of Organization roles associated with the Service Account.", "items" : { "type" : "string", - "description" : "Organization roles associated with the service account.", + "description" : "Organization roles available for Service Accounts.", "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] }, "uniqueItems" : true }, "secrets" : { "type" : "array", - "description" : "List of secrets.", + "description" : "A list of secrets associated with the specified Service Account.", "items" : { "$ref" : "#/components/schemas/ServiceAccountSecret" }, @@ -39364,63 +41283,215 @@ "properties" : { "description" : { "type" : "string", - "description" : "Human readable description for the service account.", + "description" : "Human readable description for the Service Account.", "maxLength" : 250, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "name" : { "type" : "string", - "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "description" : "Human-readable name for the Service Account. The name is modifiable and does not have to be unique.", "maxLength" : 64, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "roles" : { "type" : "array", - "description" : "Organization roles associated with the service account.", + "description" : "A list of organization-level roles for the Service Account.", "items" : { "type" : "string", - "description" : "Organization roles associated with the service account.", + "description" : "Organization roles available for Service Accounts.", "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] } }, "secretExpiresAfterHours" : { "type" : "integer", "format" : "int32", - "description" : "Secret expiration time." + "description" : "The expiration time of the new Service Account secret. The expiration is provided in hours." } }, - "required" : [ "description", "name", "secretExpiresAfterHours" ] + "required" : [ "description", "name", "roles", "secretExpiresAfterHours" ] }, "OrgServiceAccountUpdateRequest" : { "type" : "object", "properties" : { "description" : { "type" : "string", - "description" : "Human readable description for the service account.", + "description" : "Human readable description for the Service Account.", "maxLength" : 250, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "name" : { "type" : "string", - "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "description" : "Human-readable name for the Service Account. The name is modifiable and does not have to be unique.", "maxLength" : 64, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "roles" : { "type" : "array", - "description" : "Organization roles associated with the Service account.", + "description" : "A list of organization-level roles for the Service Account.", "items" : { "type" : "string", - "description" : "Organization roles associated with the service account.", + "description" : "Organization roles available for Service Accounts.", "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] } } } }, + "OrgUserRequest" : { + "type" : "object", + "properties" : { + "roles" : { + "$ref" : "#/components/schemas/OrgUserRolesRequest" + }, + "teamIds" : { + "type" : "array", + "description" : "List of unique 24-hexadecimal digit strings that identifies the teams to which this MongoDB Cloud user belongs.", + "items" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "uniqueItems" : true, + "writeOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address that represents the username of the MongoDB Cloud user.", + "writeOnly" : true + } + }, + "required" : [ "roles", "username" ] + }, + "OrgUserResponse" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "ACTIVE" : "#/components/schemas/OrgActiveUserResponse", + "PENDING" : "#/components/schemas/OrgPendingUserResponse" + }, + "propertyName" : "orgMembershipStatus" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/OrgPendingUserResponse" + }, { + "$ref" : "#/components/schemas/OrgActiveUserResponse" + } ], + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgMembershipStatus" : { + "type" : "string", + "description" : "String enum that indicates whether the MongoDB Cloud user has a pending invitation to join the organization or they are already active in the organization.", + "enum" : [ "PENDING", "ACTIVE" ], + "readOnly" : true + }, + "roles" : { + "$ref" : "#/components/schemas/OrgUserRolesResponse" + }, + "teamIds" : { + "type" : "array", + "description" : "List of unique 24-hexadecimal digit strings that identifies the teams to which this MongoDB Cloud user belongs.", + "items" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address that represents the username of the MongoDB Cloud user.", + "readOnly" : true + } + }, + "required" : [ "id", "orgMembershipStatus", "roles", "username" ] + }, + "OrgUserRolesRequest" : { + "type" : "object", + "description" : "Organization and project level roles to assign the MongoDB Cloud user within one organization.", + "properties" : { + "groupRoleAssignments" : { + "type" : "array", + "description" : "List of project level role assignments to assign the MongoDB Cloud user.", + "items" : { + "$ref" : "#/components/schemas/GroupRoleAssignment" + } + }, + "orgRoles" : { + "type" : "array", + "description" : "One or more organization level roles to assign the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_READ_ONLY", "ORG_MEMBER" ] + }, + "minItems" : 1, + "uniqueItems" : true + } + }, + "required" : [ "orgRoles" ], + "writeOnly" : true + }, + "OrgUserRolesResponse" : { + "type" : "object", + "description" : "Organization and project level roles assigned to one MongoDB Cloud user within one organization.", + "properties" : { + "groupRoleAssignments" : { + "type" : "array", + "description" : "List of project level role assignments assigned to the MongoDB Cloud user.", + "items" : { + "$ref" : "#/components/schemas/GroupRoleAssignment" + } + }, + "orgRoles" : { + "type" : "array", + "description" : "One or more organization level roles assigned to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_READ_ONLY", "ORG_MEMBER" ] + }, + "uniqueItems" : true + } + }, + "readOnly" : true + }, + "OrgUserUpdateRequest" : { + "type" : "object", + "properties" : { + "roles" : { + "$ref" : "#/components/schemas/OrgUserRolesRequest" + }, + "teamIds" : { + "type" : "array", + "description" : "List of unique 24-hexadecimal digit strings that identifies the teams to assign the MongoDB Cloud user.", + "items" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "uniqueItems" : true, + "writeOnly" : true + } + } + }, "OrganizationInvitation" : { "type" : "object", "properties" : { @@ -39625,7 +41696,7 @@ }, "restrictEmployeeAccess" : { "type" : "boolean", - "description" : "Flag that indicates whether to block MongoDB Support from accessing Atlas infrastructure 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/." + "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/." } } }, @@ -39772,7 +41843,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/AdvancedClusterDescription" }, @@ -39804,7 +41875,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/GroupAlertsConfig" }, @@ -39836,7 +41907,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/AlertViewForNdsGroup" }, @@ -39868,7 +41939,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ApiKeyUserDetails" }, @@ -39900,7 +41971,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/CloudAppUser" }, @@ -39932,7 +42003,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ApiAtlasCheckpointView" }, @@ -39965,7 +42036,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/CloudDatabaseUser" }, @@ -39997,7 +42068,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/DiskBackupExportJob" }, @@ -40029,7 +42100,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/EARPrivateEndpoint" }, @@ -40044,7 +42115,7 @@ } } }, - "PaginatedApiAtlasProviderRegionsView" : { + "PaginatedApiAtlasFlexBackupRestoreJob20250101View" : { "type" : "object", "properties" : { "links" : { @@ -40061,9 +42132,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/CloudProviderRegions" + "$ref" : "#/components/schemas/FlexBackupRestoreJob20250101" }, "readOnly" : true }, @@ -40076,7 +42147,7 @@ } } }, - "PaginatedApiAtlasServerlessBackupRestoreJobView" : { + "PaginatedApiAtlasFlexBackupSnapshot20240710View" : { "type" : "object", "properties" : { "links" : { @@ -40093,9 +42164,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" + "$ref" : "#/components/schemas/FlexBackupSnapshot20250101" }, "readOnly" : true }, @@ -40108,7 +42179,7 @@ } } }, - "PaginatedApiAtlasServerlessBackupSnapshotView" : { + "PaginatedApiAtlasProviderRegionsView" : { "type" : "object", "properties" : { "links" : { @@ -40125,9 +42196,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/ServerlessBackupSnapshot" + "$ref" : "#/components/schemas/CloudProviderRegions" }, "readOnly" : true }, @@ -40140,7 +42211,7 @@ } } }, - "PaginatedApiAtlasUSSBackupRestoreJob20250101View" : { + "PaginatedApiAtlasServerlessBackupRestoreJobView" : { "type" : "object", "properties" : { "links" : { @@ -40157,9 +42228,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/USSBackupRestoreJob20250101" + "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" }, "readOnly" : true }, @@ -40172,7 +42243,7 @@ } } }, - "PaginatedApiAtlasUSSBackupSnapshot20240710View" : { + "PaginatedApiAtlasServerlessBackupSnapshotView" : { "type" : "object", "properties" : { "links" : { @@ -40189,9 +42260,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/USSBackupSnapshot20250101" + "$ref" : "#/components/schemas/ServerlessBackupSnapshot" }, "readOnly" : true }, @@ -40221,7 +42292,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/BillingInvoiceMetadata" }, @@ -40253,7 +42324,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/BillingInvoice" }, @@ -40285,7 +42356,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/StreamsConnection" }, @@ -40300,6 +42371,38 @@ } } }, + "PaginatedApiStreamsPrivateLinkView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", + "items" : { + "$ref" : "#/components/schemas/StreamsPrivateLinkConnection" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, "PaginatedApiStreamsStreamProcessorWithStatsView" : { "type" : "object", "properties" : { @@ -40317,7 +42420,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/StreamsProcessorWithStats" }, @@ -40349,7 +42452,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/StreamsTenant" }, @@ -40381,7 +42484,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/UserAccessListResponse" }, @@ -40396,6 +42499,38 @@ } } }, + "PaginatedApiVersions" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ApiVersion" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, "PaginatedAppUserView" : { "type" : "object", "properties" : { @@ -40413,7 +42548,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/CloudAppUser" }, @@ -40445,7 +42580,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/Group" }, @@ -40477,7 +42612,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/MdbAvailableVersion" }, @@ -40509,7 +42644,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" }, @@ -40541,7 +42676,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/DiskBackupSnapshotExportBucket" }, @@ -40573,7 +42708,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/DiskBackupSnapshot" }, @@ -40605,7 +42740,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/DiskBackupReplicaSet" }, @@ -40637,7 +42772,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/DiskBackupSnapshotRestoreJob" }, @@ -40669,7 +42804,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/DiskBackupShardedClusterSnapshot" }, @@ -40702,7 +42837,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/CloudProviderContainer" }, @@ -40735,7 +42870,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ClusterDescription20240805" }, @@ -40767,7 +42902,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ConnectedOrgConfig" }, @@ -40800,7 +42935,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" }, @@ -40832,7 +42967,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/MesurementsDatabase" }, @@ -40864,7 +42999,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/MeasurementDiskPartition" }, @@ -40896,7 +43031,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/EventTypeDetails" }, @@ -40928,7 +43063,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/FederationIdentityProvider" }, @@ -40943,9 +43078,41 @@ } } }, + "PaginatedFlexClusters20250101" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", + "items" : { + "type" : "object" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, "PaginatedGroupServiceAccounts" : { "type" : "object", - "description" : "List of Service Accounts", + "description" : "A list of Project Service Accounts.", "properties" : { "links" : { "type" : "array", @@ -40961,7 +43128,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/GroupServiceAccount" }, @@ -40993,7 +43160,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ApiHostView_Atlas" }, @@ -41025,7 +43192,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ThirdPartyIntegration" }, @@ -41057,7 +43224,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/LegacyAtlasCluster" }, @@ -41089,7 +43256,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/NetworkPermissionEntry" }, @@ -41121,7 +43288,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/BackupOnlineArchive" }, @@ -41153,7 +43320,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/OrgGroup" }, @@ -41170,7 +43337,7 @@ }, "PaginatedOrgServiceAccounts" : { "type" : "object", - "description" : "List of Service Accounts", + "description" : "A list of Organization Service Accounts.", "properties" : { "links" : { "type" : "array", @@ -41186,7 +43353,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/OrgServiceAccount" }, @@ -41218,7 +43385,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/AtlasOrganization" }, @@ -41250,7 +43417,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/IngestionPipelineRun" }, @@ -41282,7 +43449,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/PrivateNetworkEndpointIdEntry" }, @@ -41314,7 +43481,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/PublicApiUsageDetailsLineItemView" }, @@ -41346,7 +43513,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/BackupRestoreJob" }, @@ -41379,7 +43546,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/AuthFederationRoleMapping" }, @@ -41411,7 +43578,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ServerlessInstanceDescription" }, @@ -41428,7 +43595,7 @@ }, "PaginatedServiceAccountGroup" : { "type" : "object", - "description" : "List of Service Account projects.", + "description" : "A list of projects associated with the Service Account.", "properties" : { "links" : { "type" : "array", @@ -41444,7 +43611,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ServiceAccountGroup" }, @@ -41459,7 +43626,7 @@ } } }, - "PaginatedSnapshotView" : { + "PaginatedServiceAccountIPAccessEntryView" : { "type" : "object", "properties" : { "links" : { @@ -41476,9 +43643,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/BackupSnapshot" + "$ref" : "#/components/schemas/ServiceAccountIPAccessListEntry" }, "readOnly" : true }, @@ -41491,7 +43658,7 @@ } } }, - "PaginatedTeamRoleView" : { + "PaginatedSnapshotView" : { "type" : "object", "properties" : { "links" : { @@ -41508,9 +43675,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/TeamRole" + "$ref" : "#/components/schemas/BackupSnapshot" }, "readOnly" : true }, @@ -41523,7 +43690,7 @@ } } }, - "PaginatedTeamView" : { + "PaginatedTeamRoleView" : { "type" : "object", "properties" : { "links" : { @@ -41540,9 +43707,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/TeamResponse" + "$ref" : "#/components/schemas/TeamRole" }, "readOnly" : true }, @@ -41555,7 +43722,7 @@ } } }, - "PaginatedTenantRestoreView" : { + "PaginatedTeamView" : { "type" : "object", "properties" : { "links" : { @@ -41572,9 +43739,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/TenantRestore" + "$ref" : "#/components/schemas/TeamResponse" }, "readOnly" : true }, @@ -41587,7 +43754,7 @@ } } }, - "PaginatedTenantSnapshotView" : { + "PaginatedTenantRestoreView" : { "type" : "object", "properties" : { "links" : { @@ -41604,9 +43771,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/BackupTenantSnapshot" + "$ref" : "#/components/schemas/TenantRestore" }, "readOnly" : true }, @@ -41619,7 +43786,7 @@ } } }, - "PaginatedUSSInstance20250101" : { + "PaginatedTenantSnapshotView" : { "type" : "object", "properties" : { "links" : { @@ -41636,9 +43803,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "type" : "object" + "$ref" : "#/components/schemas/BackupTenantSnapshot" }, "readOnly" : true }, @@ -41668,7 +43835,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/UserCert" }, @@ -42175,6 +44342,14 @@ "PrivateNetworkEndpointIdEntry" : { "type" : "object", "properties" : { + "azureConnectionName" : { + "type" : "string", + "description" : "Connection name that identifies the Azure private endpoint connection." + }, + "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." @@ -42183,6 +44358,11 @@ "type" : "string", "description" : "Human-readable label to identify customer's VPC endpoint DNS name." }, + "customerEndpointIPAddress" : { + "type" : "string", + "description" : "IP address used to connect to the Azure private endpoint.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + }, "endpointId" : { "type" : "string", "description" : "Unique 22-character alphanumeric string that identifies the private endpoint.", @@ -42195,6 +44375,10 @@ "minLength" : 22, "pattern" : "^vpce-[0-9a-f]{17}$" }, + "errorMessage" : { + "type" : "string", + "description" : "Error message describing a failure approving the private endpoint request." + }, "provider" : { "type" : "string", "default" : "AWS", @@ -42205,6 +44389,11 @@ "type" : "string", "description" : "Human-readable label to identify the region of customer's VPC endpoint." }, + "status" : { + "type" : "string", + "description" : "Status of the private endpoint connection request.", + "enum" : [ "PENDING", "OK", "FAILED", "DELETING" ] + }, "type" : { "type" : "string", "default" : "DATA_LAKE", @@ -42261,20 +44450,6 @@ "required" : [ "enabled", "serviceDiscovery", "username" ], "title" : "PROMETHEUS" }, - "ProxyInfo" : { - "type" : "object", - "description" : "VPC Proxy Information.", - "properties" : { - "authKey" : { - "type" : "string", - "description" : "Authentication key for the proxy." - }, - "dnsName" : { - "type" : "string", - "description" : "DNS name to use to reach the proxy/s." - } - } - }, "PublicApiUsageDetailsLineItemView" : { "type" : "object", "properties" : { @@ -42372,7 +44547,9 @@ "enum" : [ "AVERAGE" ] }, "operator" : { - "$ref" : "#/components/schemas/Operator" + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, "threshold" : { "type" : "number", @@ -42420,7 +44597,7 @@ "example" : "cluster1", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -42662,7 +44839,9 @@ "enum" : [ "AVERAGE" ] }, "operator" : { - "$ref" : "#/components/schemas/Operator" + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, "threshold" : { "type" : "number", @@ -42840,7 +45019,7 @@ "example" : "cluster1", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -43120,472 +45299,69 @@ } }, "zoneName" : { - "type" : "string", - "description" : "Human-readable label that identifies the zone in a Global Cluster. Provide this value only if `\"clusterType\" : \"GEOSHARDED\"`." - } - }, - "title" : "Replication Specifications" - }, - "ReplicationSpec20240805" : { - "type" : "object", - "description" : "Details that explain how MongoDB Cloud replicates data on the specified MongoDB database.", - "properties" : { - "id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a shard in a Cluster. If you include existing shard replication configurations in the request, you must specify this parameter. If you add a new shard to an existing Cluster, you may specify this parameter. The request deletes any existing shards in the Cluster that you exclude from the request.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "regionConfigs" : { - "type" : "array", - "description" : "Hardware specifications for nodes set for a given region. 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**.\n\n**Example:**\n\nIf you set `\"replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize\" : \"M30\"`, set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : `\"M30\"` if you have electable nodes and `\"replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize\" : `\"M30\"` if you have read-only nodes.", - "items" : { - "$ref" : "#/components/schemas/CloudRegionConfig20240805" - } - }, - "zoneId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the zone in a Global Cluster. This value can be used to configure Global Cluster backup policies.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "zoneName" : { - "type" : "string", - "description" : "Human-readable label that describes the zone this shard belongs to in a Global Cluster. Provide this value only if \"clusterType\" : \"GEOSHARDED\" but not \"selfManagedSharding\" : true." - } - }, - "title" : "Replication Specifications" - }, - "RequestAccepted" : { - "type" : "object", - "description" : "Accepted" - }, - "ResourceEventTypeView" : { - "type" : "string", - "description" : "Unique identifier of event type.", - "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], - "example" : "TAGS_MODIFIED", - "title" : "Resource Event Types" - }, - "ResourceEventTypeViewForOrg" : { - "type" : "string", - "description" : "Unique identifier of event type.", - "enum" : [ "GROUP_TAGS_MODIFIED" ], - "example" : "GROUP_TAGS_MODIFIED", - "title" : "Resource Event Types" - }, - "ResourceEventViewForNdsGroup" : { - "type" : "object", - "description" : "Resource event reflects different activities about resources.", - "properties" : { - "apiKeyId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "created" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true - }, - "eventTypeName" : { - "$ref" : "#/components/schemas/ResourceEventTypeView" - }, - "groupId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "isGlobalAdmin" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", - "readOnly" : true - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - }, - "orgId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "publicKey" : { - "type" : "string", - "format" : "email", - "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "example" : "test.user@mongodb.com", - "readOnly" : true - }, - "raw" : { - "$ref" : "#/components/schemas/raw" - }, - "remoteAddress" : { - "type" : "string", - "description" : "IPv4 or IPv6 address from which the user triggered this event.", - "example" : "216.172.40.186", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", - "readOnly" : true - }, - "resourceId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the resource associated with the event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "resourceType" : { - "type" : "string", - "description" : "Unique identifier of resource type.", - "example" : "cluster" - }, - "userId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "username" : { - "type" : "string", - "format" : "email", - "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", - "example" : "test.user@mongodb.com", - "readOnly" : true - } - }, - "required" : [ "created", "eventTypeName", "id", "resourceType" ], - "title" : "Resource Events" - }, - "ResourceEventViewForOrg" : { - "type" : "object", - "description" : "Resource event reflects different activities about resources.", - "properties" : { - "apiKeyId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "created" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true - }, - "eventTypeName" : { - "$ref" : "#/components/schemas/ResourceEventTypeViewForOrg" - }, - "groupId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "isGlobalAdmin" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", - "readOnly" : true - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - }, - "orgId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "publicKey" : { - "type" : "string", - "format" : "email", - "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "example" : "test.user@mongodb.com", - "readOnly" : true - }, - "raw" : { - "$ref" : "#/components/schemas/raw" - }, - "remoteAddress" : { - "type" : "string", - "description" : "IPv4 or IPv6 address from which the user triggered this event.", - "example" : "216.172.40.186", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", - "readOnly" : true - }, - "resourceId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the resource associated with the event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "resourceType" : { - "type" : "string", - "description" : "Unique identifier of resource type.", - "example" : "cluster" - }, - "userId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "username" : { - "type" : "string", - "format" : "email", - "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", - "example" : "test.user@mongodb.com", - "readOnly" : true - } - }, - "required" : [ "created", "eventTypeName", "id", "resourceType" ], - "title" : "Resource Events" - }, - "ResourceTag" : { - "type" : "object", - "description" : "Key-value pair that tags and categorizes a MongoDB Cloud organization, project, or cluster. For example, `environment : production`.", - "properties" : { - "key" : { - "type" : "string", - "description" : "Constant that defines the set of the tag. For example, `environment` in the `environment : production` tag.", - "maxLength" : 255, - "minLength" : 1 - }, - "value" : { - "type" : "string", - "description" : "Variable that belongs to the set of the tag. For example, `production` in the `environment : production` tag.", - "maxLength" : 255, - "minLength" : 1 - } - }, - "required" : [ "key", "value" ], - "title" : "Resource Tag" - }, - "RestoreJobFileHash" : { - "type" : "object", - "description" : "Key and value pair that map one restore file to one hashed checksum. This parameter applies after you download the corresponding **delivery.url**.", - "properties" : { - "fileName" : { - "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.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - }, - "typeName" : { - "type" : "string", - "description" : "Human-readable label that identifies the hashing algorithm used to compute the hash value.", - "enum" : [ "SHA1" ], - "readOnly" : true - } - }, - "readOnly" : true - }, - "RoleAssignment" : { - "type" : "object", - "properties" : { - "groupId" : { - "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", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" - }, - "orgId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization to which this role belongs. Each element within **roleAssignments** can have a value for **orgId** or **groupId**, but not both.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" - }, - "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.\n\nOrganization Roles\n\n* ORG_OWNER\n* ORG_MEMBER\n* ORG_GROUP_CREATOR\n* ORG_BILLING_ADMIN\n* ORG_READ_ONLY\n\nProject Roles\n\n* GROUP_CLUSTER_MANAGER\n* GROUP_DATA_ACCESS_ADMIN\n* GROUP_DATA_ACCESS_READ_ONLY\n* GROUP_DATA_ACCESS_READ_WRITE\n* GROUP_OWNER\n* GROUP_READ_ONLY\n* GROUP_SEARCH_INDEX_EDITOR\n* GROUP_STREAM_PROCESSING_OWNER\n\n", - "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] - } - } - }, - "SMSNotification" : { - "type" : "object", - "description" : "SMS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", - "properties" : { - "delayMin" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." - }, - "intervalMin" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", - "minimum" : 5 - }, - "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" : { - "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" ] + "type" : "string", + "description" : "Human-readable label that identifies the zone in a Global Cluster. Provide this value only if `\"clusterType\" : \"GEOSHARDED\"`." } }, - "required" : [ "typeName" ], - "title" : "SMS Notification" + "title" : "Replication Specifications" }, - "SampleDatasetStatus" : { + "ReplicationSpec20240805" : { "type" : "object", + "description" : "Details that explain how MongoDB Cloud replicates data on the specified MongoDB database.", "properties" : { - "_id" : { + "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies this sample dataset.", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a shard in a Cluster. If you include existing shard replication configurations in the request, you must specify this parameter. If you add a new shard to an existing Cluster, you may specify this parameter. The request deletes any existing shards in the Cluster that you exclude from the request.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "clusterName" : { - "type" : "string", - "description" : "Human-readable label that identifies the cluster into which you loaded the sample dataset.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "readOnly" : true - }, - "completeDate" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when the sample dataset load job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", - "readOnly" : true - }, - "createDate" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when you started the sample dataset load job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", - "readOnly" : true + "regionConfigs" : { + "type" : "array", + "description" : "Hardware specifications for nodes set for a given region. 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**.\n\n**Example:**\n\nIf you set `\"replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize\" : \"M30\"`, set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : `\"M30\"` if you have electable nodes and `\"replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize\" : `\"M30\"` if you have read-only nodes.", + "items" : { + "$ref" : "#/components/schemas/CloudRegionConfig20240805" + } }, - "errorMessage" : { + "zoneId" : { "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.", + "description" : "Unique 24-hexadecimal digit string that identifies the zone in a Global Cluster. This value can be used to configure Global Cluster backup policies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "state" : { + "zoneName" : { "type" : "string", - "description" : "Status of the sample dataset load job.", - "enum" : [ "WORKING", "FAILED", "COMPLETED" ], - "readOnly" : true + "description" : "Human-readable label that describes the zone this shard belongs to in a Global Cluster. Provide this value only if \"clusterType\" : \"GEOSHARDED\" but not \"selfManagedSharding\" : true." } - } + }, + "title" : "Replication Specifications" }, - "SearchDeploymentAuditTypeView" : { + "RequestAccepted" : { + "type" : "object", + "description" : "Accepted" + }, + "ResourceEventTypeView" : { "type" : "string", "description" : "Unique identifier of event type.", - "enum" : [ "SEARCH_DEPLOYMENT_CREATED", "SEARCH_DEPLOYMENT_UPDATED", "SEARCH_DEPLOYMENT_DELETED" ], - "example" : "SEARCH_DEPLOYMENT_CREATED", - "title" : "Search Deployment Audit Types" + "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], + "example" : "TAGS_MODIFIED", + "title" : "Resource Event Types" }, - "SearchDeploymentAuditView" : { + "ResourceEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "GROUP_TAGS_MODIFIED" ], + "example" : "GROUP_TAGS_MODIFIED", + "title" : "Resource Event Types" + }, + "ResourceEventViewForNdsGroup" : { "type" : "object", - "description" : "Indicates activities on decoupled search nodes.", + "description" : "Resource event reflects different activities about resources.", "properties" : { "apiKeyId" : { "type" : "string", @@ -43603,7 +45379,7 @@ "readOnly" : true }, "eventTypeName" : { - "$ref" : "#/components/schemas/SearchDeploymentAuditTypeView" + "$ref" : "#/components/schemas/ResourceEventTypeView" }, "groupId" : { "type" : "string", @@ -43654,6 +45430,7 @@ "type" : "string", "format" : "email", "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true }, "raw" : { @@ -43666,6 +45443,20 @@ "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", "readOnly" : true }, + "resourceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the resource associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resourceType" : { + "type" : "string", + "description" : "Unique identifier of resource type.", + "example" : "cluster" + }, "userId" : { "type" : "string", "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", @@ -43683,541 +45474,159 @@ "readOnly" : true } }, - "required" : [ "created", "eventTypeName", "id" ], - "title" : "Search Deployment Audits" - }, - "SearchHostStatusDetail" : { - "type" : "object", - "properties" : { - "hostname" : { - "type" : "string", - "description" : "Hostname that corresponds to the status detail." - }, - "mainIndex" : { - "$ref" : "#/components/schemas/SearchMainIndexStatusDetail" - }, - "queryable" : { - "type" : "boolean", - "description" : "Flag that indicates whether the index is queryable on the host." - }, - "stagedIndex" : { - "$ref" : "#/components/schemas/SearchStagedIndexStatusDetail" - }, - "status" : { - "type" : "string", - "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", - "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] - } - }, - "title" : "Search Host Status Detail" - }, - "SearchIndex" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/ClusterSearchIndex" - }, { - "type" : "object", - "properties" : { - "analyzer" : { - "type" : "string", - "default" : "lucene.standard", - "description" : "Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves a variety of changes made to the text in fields:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\n MongoDB Cloud uses the selected process to build the Atlas Search index.", - "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ], - "externalDocs" : { - "description" : "Atlas Search Analyzers", - "url" : "https://dochub.mongodb.org/core/analyzers--fts" - } - }, - "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" - }, - "items" : { - "$ref" : "#/components/schemas/ApiAtlasFTSAnalyzersViewManual" - } - }, - "mappings" : { - "$ref" : "#/components/schemas/ApiAtlasFTSMappingsViewManual" - }, - "searchAnalyzer" : { - "type" : "string", - "default" : "lucene.standard", - "description" : "Method applied to identify words when searching this index.", - "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] - }, - "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" - }, - "items" : { - "$ref" : "#/components/schemas/SearchSynonymMappingDefinition" - } - } - } - } ], - "required" : [ "collectionName", "database", "name" ] - }, - "SearchIndexCreateRequest" : { - "type" : "object", - "discriminator" : { - "mapping" : { - "search" : "#/components/schemas/TextSearchIndexCreateRequest", - "vectorSearch" : "#/components/schemas/VectorSearchIndexCreateRequest" - }, - "propertyName" : "type" - }, - "properties" : { - "collectionName" : { - "type" : "string", - "description" : "Label that identifies the collection to create an Atlas Search index in." - }, - "database" : { - "type" : "string", - "description" : "Label that identifies the database that contains the collection to create an Atlas Search index in." - }, - "name" : { - "type" : "string", - "description" : "Label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique." - }, - "type" : { - "type" : "string", - "description" : "Type of the index. The default type is search.", - "enum" : [ "search", "vectorSearch" ] - } - }, - "required" : [ "collectionName", "database", "name" ] - }, - "SearchIndexDefinition" : { - "type" : "object", - "description" : "The search index definition set by the user.", - "title" : "Search Index Definition" - }, - "SearchIndexDefinitionVersion" : { - "type" : "object", - "description" : "Object which includes the version number of the index definition and the time that the index definition was created.", - "properties" : { - "createdAt" : { - "type" : "string", - "format" : "date-time", - "description" : "The time at which this index definition was created." - }, - "version" : { - "type" : "integer", - "format" : "int64", - "description" : "The version number associated with this index definition when it was created." - } - }, - "title" : "Search Index Definition Version" + "required" : [ "created", "eventTypeName", "id", "resourceType" ], + "title" : "Resource Events" }, - "SearchIndexResponse" : { + "ResourceEventViewForOrg" : { "type" : "object", - "discriminator" : { - "mapping" : { - "search" : "#/components/schemas/TextSearchIndexResponse", - "vectorSearch" : "#/components/schemas/VectorSearchIndexResponse" - }, - "propertyName" : "type" - }, + "description" : "Resource event reflects different activities about resources.", "properties" : { - "collectionName" : { - "type" : "string", - "description" : "Label that identifies the collection that contains one or more Atlas Search indexes." - }, - "database" : { - "type" : "string", - "description" : "Label that identifies the database that contains the collection with one or more Atlas Search indexes." - }, - "indexID" : { + "apiKeyId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies this Atlas Search index.", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" - }, - "latestDefinition" : { - "$ref" : "#/components/schemas/SearchIndexDefinition" - }, - "latestDefinitionVersion" : { - "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" - }, - "name" : { - "type" : "string", - "description" : "Label that identifies this index. Within each namespace, the names of all indexes must be unique." - }, - "queryable" : { - "type" : "boolean", - "description" : "Flag that indicates whether the index is queryable on all hosts." - }, - "status" : { - "type" : "string", - "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", - "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] - }, - "statusDetail" : { - "type" : "array", - "description" : "List of documents detailing index status on each host.", - "items" : { - "$ref" : "#/components/schemas/SearchHostStatusDetail" - } - }, - "type" : { - "type" : "string", - "description" : "Type of the index. The default type is search.", - "enum" : [ "search", "vectorSearch" ] - } - }, - "title" : "Search Index Response" - }, - "SearchIndexUpdateRequest" : { - "type" : "object", - "properties" : { - "definition" : { - "type" : "object", - "description" : "The index definition to update the search index to.", - "oneOf" : [ { - "$ref" : "#/components/schemas/TextSearchIndexDefinition" - }, { - "$ref" : "#/components/schemas/VectorSearchIndexDefinition" - } ] - } - }, - "required" : [ "definition" ], - "title" : "Search Index Update Request" - }, - "SearchMainIndexStatusDetail" : { - "type" : "object", - "description" : "Contains status information about the active index.", - "properties" : { - "definition" : { - "$ref" : "#/components/schemas/SearchIndexDefinition" - }, - "definitionVersion" : { - "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" - }, - "message" : { - "type" : "string", - "description" : "Optional message describing an error." - }, - "queryable" : { - "type" : "boolean", - "description" : "Flag that indicates whether the index generation is queryable on the host." - }, - "status" : { - "type" : "string", - "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", - "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] - } - }, - "title" : "Search Main Index Status Detail" - }, - "SearchMappings" : { - "type" : "object", - "description" : "Index specifications for the collection's fields.", - "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/field-mapping-definition-fts#static-and-dynamic-mappings" - } - }, - "fields" : { - "type" : "object", - "additionalProperties" : { - "type" : "object", - "description" : "One or more field specifications for the Atlas Search index. Required if **mappings.dynamic** is omitted or set to **false**.", - "externalDocs" : { - "description" : "Atlas Search Index", - "url" : "https://dochub.mongodb.org/core/index-definitions-fts" - }, - "x-additionalPropertiesName" : "Field Name" - }, - "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" - }, - "x-additionalPropertiesName" : "Field Name" - } - }, - "title" : "Mappings" - }, - "SearchStagedIndexStatusDetail" : { - "type" : "object", - "description" : "Contains status information about an index building in the background.", - "properties" : { - "definition" : { - "$ref" : "#/components/schemas/SearchIndexDefinition" - }, - "definitionVersion" : { - "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" - }, - "message" : { - "type" : "string", - "description" : "Optional message describing an error." - }, - "queryable" : { - "type" : "boolean", - "description" : "Flag that indicates whether the index generation is queryable on the host." + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "status" : { - "type" : "string", - "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", - "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] - } - }, - "title" : "Search Staged Index Status Detail" - }, - "SearchSynonymMappingDefinition" : { - "type" : "object", - "description" : "Synonyms used for this full text index.", - "properties" : { - "analyzer" : { + "created" : { "type" : "string", - "description" : "Specific pre-defined method chosen to apply to the synonyms to be searched.", - "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true }, - "name" : { - "type" : "string", - "description" : "Label that identifies the synonym definition. Each **synonym.name** must be unique within the same index definition." + "eventTypeName" : { + "$ref" : "#/components/schemas/ResourceEventTypeViewForOrg" }, - "source" : { - "$ref" : "#/components/schemas/SynonymSource" - } - }, - "required" : [ "analyzer", "name", "source" ], - "title" : "Synonym Mapping Definition" - }, - "ServerlessAWSTenantEndpoint" : { - "type" : "object", - "description" : "View for a serverless AWS tenant endpoint.", - "properties" : { - "_id" : { + "groupId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "cloudProviderEndpointId" : { - "type" : "string", - "description" : "Unique string that identifies the private endpoint's network interface.", - "pattern" : "^vpce-[0-9a-f]{17}$", - "readOnly" : true - }, - "comment" : { - "type" : "string", - "description" : "Human-readable comment associated with the private endpoint.", - "maxLength" : 80, - "readOnly" : true - }, - "endpointServiceName" : { + "id" : { "type" : "string", - "description" : "Unique string that identifies the Amazon Web Services (AWS) PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", - "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "errorMessage" : { - "type" : "string", - "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", "readOnly" : true }, - "providerName" : { - "type" : "string", - "description" : "Human-readable label that identifies the cloud service provider.", - "enum" : [ "AWS" ], + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, "readOnly" : true }, - "status" : { - "type" : "string", - "description" : "Human-readable label that indicates the current operating status of the private endpoint.", - "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], - "readOnly" : true - } - }, - "title" : "AWS" - }, - "ServerlessAWSTenantEndpointUpdate" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" - }, { - "type" : "object", - "properties" : { - "cloudProviderEndpointId" : { - "type" : "string", - "description" : "Unique string that identifies the private endpoint's network interface.", - "pattern" : "^vpce-[0-9a-f]{17}$", - "writeOnly" : true - } - } - } ], - "description" : "Updates to a serverless AWS tenant endpoint.", - "required" : [ "providerName" ], - "title" : "AWS" - }, - "ServerlessAzureTenantEndpoint" : { - "type" : "object", - "description" : "View for a serverless Azure tenant endpoint.", - "properties" : { - "_id" : { + "orgId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "cloudProviderEndpointId" : { - "type" : "string", - "description" : "Unique string that identifies the Azure private endpoint's network interface that someone added to this private endpoint service.", - "pattern" : "^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\\.Network/privateEndpoints/[-\\w._()]+$", - "readOnly" : true - }, - "comment" : { + "publicKey" : { "type" : "string", - "description" : "Human-readable comment associated with the private endpoint.", - "maxLength" : 80, + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true }, - "endpointServiceName" : { - "type" : "string", - "description" : "Unique string that identifies the Azure private endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", - "pattern" : "^pls_[0-9a-f]{24}$", - "readOnly" : true + "raw" : { + "$ref" : "#/components/schemas/raw" }, - "errorMessage" : { + "remoteAddress" : { "type" : "string", - "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", "readOnly" : true }, - "privateEndpointIpAddress" : { + "resourceId" : { "type" : "string", - "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "description" : "Unique 24-hexadecimal digit string that identifies the resource associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "privateLinkServiceResourceId" : { + "resourceType" : { "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 + "description" : "Unique identifier of resource type.", + "example" : "cluster" }, - "providerName" : { + "userId" : { "type" : "string", - "description" : "Human-readable label that identifies the cloud service provider.", - "enum" : [ "AZURE" ], + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "status" : { + "username" : { "type" : "string", - "description" : "Human-readable label that indicates the current operating status of the private endpoint.", - "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true } }, - "title" : "Azure" - }, - "ServerlessAzureTenantEndpointUpdate" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" - }, { - "type" : "object", - "properties" : { - "cloudProviderEndpointId" : { - "type" : "string", - "description" : "Unique string that identifies the Azure private endpoint's network interface for this private endpoint service.", - "pattern" : "^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\\.Network/privateEndpoints/[-\\w._()]+$", - "writeOnly" : true - }, - "privateEndpointIpAddress" : { - "type" : "string", - "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", - "writeOnly" : true - } - } - } ], - "description" : "Updates to a serverless Azure tenant endpoint.", - "required" : [ "providerName" ], - "title" : "AZURE" + "required" : [ "created", "eventTypeName", "id", "resourceType" ], + "title" : "Resource Events" }, - "ServerlessBackupRestoreJob" : { + "ResourceTag" : { "type" : "object", + "description" : "Key-value pair that tags and categorizes a MongoDB Cloud organization, project, or cluster. For example, `environment : production`.", "properties" : { - "cancelled" : { - "type" : "boolean", - "description" : "Flag that indicates whether someone canceled this restore job.", - "readOnly" : true - }, - "deliveryType" : { + "key" : { "type" : "string", - "description" : "Human-readable label that categorizes the restore job to create.", - "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\"`.", - "items" : { - "type" : "string", - "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download." - }, - "readOnly" : true - }, - "desiredTimestamp" : { - "$ref" : "#/components/schemas/ApiBSONTimestampView" - }, - "expired" : { - "type" : "boolean", - "description" : "Flag that indicates whether the restore job expired.", - "readOnly" : true + "description" : "Constant that defines the set of the tag. For example, `environment` in the `environment : production` tag.", + "maxLength" : 255, + "minLength" : 1 }, - "expiresAt" : { + "value" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when the restore job expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true - }, - "failed" : { - "type" : "boolean", - "description" : "Flag that indicates whether the restore job failed.", - "readOnly" : true - }, - "finishedAt" : { + "description" : "Variable that belongs to the set of the tag. For example, `production` in the `environment : production` tag.", + "maxLength" : 255, + "minLength" : 1 + } + }, + "required" : [ "key", "value" ], + "title" : "Resource Tag" + }, + "RestoreJobFileHash" : { + "type" : "object", + "description" : "Key and value pair that map one restore file to one hashed checksum. This parameter applies after you download the corresponding **delivery.url**.", + "properties" : { + "fileName" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when the restore job completed. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Human-readable label that identifies the hashed file.", "readOnly" : true }, - "id" : { + "hash" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the restore job.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "description" : "Hashed checksum that maps to the restore file.", "readOnly" : true }, "links" : { @@ -44232,87 +45641,173 @@ }, "readOnly" : true }, - "oplogInc" : { - "type" : "integer", - "format" : "int32", - "description" : "Oplog operation number from which you want to restore this snapshot. This number represents the second part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", - "example" : 1, - "minimum" : 1 + "typeName" : { + "type" : "string", + "description" : "Human-readable label that identifies the hashing algorithm used to compute the hash value.", + "enum" : [ "SHA1" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "RoleAssignment" : { + "type" : "object", + "properties" : { + "groupId" : { + "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", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" }, - "oplogTs" : { + "orgId" : { + "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", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "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.\n\nOrganization Roles\n\n* ORG_OWNER\n* ORG_MEMBER\n* ORG_GROUP_CREATOR\n* ORG_BILLING_ADMIN\n* ORG_READ_ONLY\n\nProject Roles\n\n* GROUP_CLUSTER_MANAGER\n* GROUP_DATA_ACCESS_ADMIN\n* GROUP_DATA_ACCESS_READ_ONLY\n* GROUP_DATA_ACCESS_READ_WRITE\n* GROUP_OWNER\n* GROUP_READ_ONLY\n* GROUP_SEARCH_INDEX_EDITOR\n* GROUP_STREAM_PROCESSING_OWNER\n\n", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + } + }, + "SMSNotification" : { + "type" : "object", + "description" : "SMS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { "type" : "integer", "format" : "int32", - "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`.", - "minimum" : 1199145600 + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." }, - "pointInTimeUTCSeconds" : { + "intervalMin" : { "type" : "integer", "format" : "int32", - "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`.", - "minimum" : 1199145600 + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 }, - "snapshotId" : { + "mobileNumber" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "description" : "Mobile phone number to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"SMS\"`.", + "example" : "1233337892" + }, + "notifierId" : { + "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" ] + } + }, + "required" : [ "typeName" ], + "title" : "SMS Notification" + }, + "SampleDatasetStatus" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies this sample dataset.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "targetClusterName" : { + "clusterName" : { "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\"`.", + "description" : "Human-readable label that identifies the cluster into which you loaded the sample dataset.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "readOnly" : true }, - "targetGroupId" : { + "completeDate" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the target project for the specified **targetClusterName**.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" + "format" : "date-time", + "description" : "Date and time when the sample dataset load job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true }, - "timestamp" : { + "createDate" : { "type" : "string", "format" : "date-time", - "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.", + "description" : "Date and time when you started the sample dataset load job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "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.", + "enum" : [ "WORKING", "FAILED", "COMPLETED" ], "readOnly" : true } - }, - "required" : [ "deliveryType", "targetClusterName", "targetGroupId" ] + } }, - "ServerlessBackupSnapshot" : { + "SearchDeploymentAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "SEARCH_DEPLOYMENT_CREATED", "SEARCH_DEPLOYMENT_UPDATED", "SEARCH_DEPLOYMENT_DELETED" ], + "example" : "SEARCH_DEPLOYMENT_CREATED", + "title" : "Search Deployment Audit Types" + }, + "SearchDeploymentAuditView" : { "type" : "object", + "description" : "Indicates activities on decoupled search nodes.", "properties" : { - "createdAt" : { + "apiKeyId" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "expiresAt" : { + "created" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "frequencyType" : { + "eventTypeName" : { + "$ref" : "#/components/schemas/SearchDeploymentAuditTypeView" + }, + "groupId" : { "type" : "string", - "description" : "Human-readable label that identifies how often this snapshot triggers.", - "enum" : [ "hourly", "daily", "weekly", "monthly" ], + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, "links" : { "type" : "array", "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", @@ -44325,450 +45820,445 @@ }, "readOnly" : true }, - "mongodVersion" : { + "orgId" : { "type" : "string", - "description" : "Version of the MongoDB host that this snapshot backs up.", - "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "serverlessInstanceName" : { + "publicKey" : { "type" : "string", - "description" : "Human-readable label given to the serverless instance from which MongoDB Cloud took this snapshot.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", "readOnly" : true }, - "snapshotType" : { + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { "type" : "string", - "description" : "Human-readable label that identifies when this snapshot triggers.", - "enum" : [ "onDemand", "scheduled" ], + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", "readOnly" : true }, - "status" : { + "userId" : { "type" : "string", - "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", - "enum" : [ "queued", "inProgress", "completed", "failed" ], + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "storageSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "Number of bytes taken to store the backup snapshot.", + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true } - } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Search Deployment Audits" }, - "ServerlessConnectionStringsPrivateEndpointItem" : { + "SearchHostStatusDetail" : { "type" : "object", - "description" : "Details of a private endpoint deployed for this serverless instance.", "properties" : { - "endpointId" : { + "hostname" : { "type" : "string", - "description" : "Unique string that the cloud provider uses to identify the private endpoint.", - "readOnly" : true + "description" : "Hostname that corresponds to the status detail." }, - "providerName" : { - "type" : "string", - "description" : "Cloud provider where the private endpoint is deployed.", - "enum" : [ "AWS", "AZURE" ], - "readOnly" : true + "mainIndex" : { + "$ref" : "#/components/schemas/SearchMainIndexStatusDetail" }, - "region" : { + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on the host." + }, + "stagedIndex" : { + "$ref" : "#/components/schemas/SearchStagedIndexStatusDetail" + }, + "status" : { "type" : "string", - "description" : "Region where the private endpoint is deployed.", - "readOnly" : true + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] } }, - "title" : "Serverless Instance Private Endpoint Connection Strings Endpoint" + "title" : "Search Host Status Detail" }, - "ServerlessConnectionStringsPrivateEndpointList" : { + "SearchIndex" : { "type" : "object", - "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/" + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, { + "type" : "object", + "properties" : { + "analyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves a variety of changes made to the text in fields:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\n MongoDB Cloud uses the selected process to build the Atlas Search index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ], + "externalDocs" : { + "description" : "Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/analyzers--fts" + } + }, + "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" + }, + "items" : { + "$ref" : "#/components/schemas/ApiAtlasFTSAnalyzersViewManual" + } + }, + "mappings" : { + "$ref" : "#/components/schemas/ApiAtlasFTSMappingsViewManual" + }, + "searchAnalyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Method applied to identify words when searching this index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] + }, + "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" + }, + "items" : { + "$ref" : "#/components/schemas/SearchSynonymMappingDefinition" + } + } + } + } ], + "required" : [ "collectionName", "database", "name" ] + }, + "SearchIndexCreateRequest" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "search" : "#/components/schemas/TextSearchIndexCreateRequest", + "vectorSearch" : "#/components/schemas/VectorSearchIndexCreateRequest" + }, + "propertyName" : "type" }, "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**.", - "items" : { - "$ref" : "#/components/schemas/ServerlessConnectionStringsPrivateEndpointItem" - }, - "readOnly" : true + "collectionName" : { + "type" : "string", + "description" : "Label that identifies the collection to create an Atlas Search index in." }, - "srvConnectionString" : { + "database" : { "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 + "description" : "Label that identifies the database that contains the collection to create an Atlas Search index in." + }, + "name" : { + "type" : "string", + "description" : "Label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique." }, "type" : { "type" : "string", - "description" : "MongoDB process type to which your application connects.", - "enum" : [ "MONGOS" ], - "readOnly" : true + "description" : "Type of the index. The default type is search.", + "enum" : [ "search", "vectorSearch" ] } }, - "title" : "Serverless Instance Private Endpoint Connection String" + "required" : [ "collectionName", "database", "name" ] }, - "ServerlessEventTypeViewAlertable" : { - "type" : "string", - "description" : "Event type that triggers an alert.", - "enum" : [ "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], - "example" : "OUTSIDE_SERVERLESS_METRIC_THRESHOLD", - "title" : "Serverless Event Types" + "SearchIndexDefinition" : { + "type" : "object", + "description" : "The search index definition set by the user.", + "title" : "Search Index Definition" + }, + "SearchIndexDefinitionVersion" : { + "type" : "object", + "description" : "Object which includes the version number of the index definition and the time that the index definition was created.", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "The time at which this index definition was created." + }, + "version" : { + "type" : "integer", + "format" : "int64", + "description" : "The version number associated with this index definition when it was created." + } + }, + "title" : "Search Index Definition Version" }, - "ServerlessInstanceDescription" : { + "SearchIndexResponse" : { "type" : "object", - "description" : "Group of settings that configure a MongoDB serverless instance.", - "properties" : { - "connectionStrings" : { - "$ref" : "#/components/schemas/ServerlessInstanceDescriptionConnectionStrings" + "discriminator" : { + "mapping" : { + "search" : "#/components/schemas/TextSearchIndexResponse", + "vectorSearch" : "#/components/schemas/VectorSearchIndexResponse" }, - "createDate" : { + "propertyName" : "type" + }, + "properties" : { + "collectionName" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", - "readOnly" : true + "description" : "Label that identifies the collection that contains one or more Atlas Search indexes." }, - "groupId" : { + "database" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the project.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "description" : "Label that identifies the database that contains the collection with one or more Atlas Search indexes." }, - "id" : { + "indexID" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the serverless instance.", + "description" : "Unique 24-hexadecimal digit string that identifies this Atlas Search index.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "pattern" : "^([a-f0-9]{24})$" }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true + "latestDefinition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" }, - "mongoDBVersion" : { - "type" : "string", - "description" : "Version of MongoDB that the serverless instance runs.", - "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", - "readOnly" : true + "latestDefinitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" }, "name" : { "type" : "string", - "description" : "Human-readable label that identifies the serverless instance.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - }, - "providerSettings" : { - "$ref" : "#/components/schemas/ServerlessProviderSettings" + "description" : "Label that identifies this index. Within each namespace, the names of all indexes must be unique." }, - "serverlessBackupOptions" : { - "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on all hosts." }, - "stateName" : { + "status" : { "type" : "string", - "description" : "Human-readable label that indicates the current operating condition of the serverless instance.", - "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], - "readOnly" : true + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] }, - "tags" : { + "statusDetail" : { "type" : "array", - "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", + "description" : "List of documents detailing index status on each host.", "items" : { - "$ref" : "#/components/schemas/ResourceTag" + "$ref" : "#/components/schemas/SearchHostStatusDetail" } }, - "terminationProtectionEnabled" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." + "type" : { + "type" : "string", + "description" : "Type of the index. The default type is search.", + "enum" : [ "search", "vectorSearch" ] } }, - "required" : [ "providerSettings" ], - "title" : "Serverless Instance Description" + "title" : "Search Index Response" }, - "ServerlessInstanceDescriptionConnectionStrings" : { + "SearchIndexUpdateRequest" : { "type" : "object", - "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", - "externalDocs" : { - "description" : "Connection string URI format.", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, "properties" : { - "privateEndpoint" : { - "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.", - "items" : { - "$ref" : "#/components/schemas/ServerlessConnectionStringsPrivateEndpointList" - }, - "readOnly" : true - }, - "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.", - "externalDocs" : { - "description" : "Connection String URI Format", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, - "readOnly" : true + "definition" : { + "type" : "object", + "description" : "The index definition to update the search index to.", + "oneOf" : [ { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + }, { + "$ref" : "#/components/schemas/VectorSearchIndexDefinition" + } ] } }, - "readOnly" : true, - "title" : "Serverless Instance Connection Strings" + "required" : [ "definition" ], + "title" : "Search Index Update Request" }, - "ServerlessInstanceDescriptionCreate" : { + "SearchMainIndexStatusDetail" : { "type" : "object", - "description" : "Settings that you can specify when you create a serverless instance.", + "description" : "Contains status information about the active index.", "properties" : { - "name" : { - "type" : "string", - "description" : "Human-readable label that identifies the serverless instance.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "writeOnly" : true - }, - "providerSettings" : { - "$ref" : "#/components/schemas/ServerlessProviderSettings" + "definition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" }, - "serverlessBackupOptions" : { - "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" }, - "stateName" : { + "message" : { "type" : "string", - "description" : "Human-readable label that indicates the current operating condition of the serverless instance.", - "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], - "readOnly" : true - }, - "tags" : { - "type" : "array", - "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", - "items" : { - "$ref" : "#/components/schemas/ResourceTag" - } + "description" : "Optional message describing an error." }, - "terminationProtectionEnabled" : { + "queryable" : { "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." + "description" : "Flag that indicates whether the index generation is queryable on the host." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] } }, - "required" : [ "name", "providerSettings" ], - "title" : "Serverless Instance Description Create" + "title" : "Search Main Index Status Detail" }, - "ServerlessInstanceDescriptionUpdate" : { + "SearchMappings" : { "type" : "object", - "description" : "Settings that you can update when you request a serverless cluster update.", + "description" : "Index specifications for the collection's fields.", "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.", - "items" : { - "$ref" : "#/components/schemas/ResourceTag" + "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/field-mapping-definition-fts#static-and-dynamic-mappings" } }, - "terminationProtectionEnabled" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." + "fields" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "One or more field specifications for the Atlas Search index. Required if **mappings.dynamic** is omitted or set to **false**.", + "externalDocs" : { + "description" : "Atlas Search Index", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "x-additionalPropertiesName" : "Field Name" + }, + "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" + }, + "x-additionalPropertiesName" : "Field Name" } }, - "title" : "Serverless Instance Description Update" + "title" : "Mappings" }, - "ServerlessMetricAlertConfigViewForNdsGroup" : { + "SearchStagedIndexStatusDetail" : { "type" : "object", - "description" : "Serverless metric alert configuration allows to select which serverless database metrics trigger alerts and how users are notified.", + "description" : "Contains status information about an index building in the background.", "properties" : { - "created" : { + "definition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" + }, + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "message" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "description" : "Optional message describing an error." }, - "enabled" : { + "queryable" : { "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + "description" : "Flag that indicates whether the index generation is queryable on the host." }, - "eventTypeName" : { - "$ref" : "#/components/schemas/ServerlessEventTypeViewAlertable" + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Search Staged Index Status Detail" + }, + "SearchSynonymMappingDefinition" : { + "type" : "object", + "description" : "Synonyms used for this full text index.", + "properties" : { + "analyzer" : { + "type" : "string", + "description" : "Specific pre-defined method chosen to apply to the synonyms to be searched.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] }, - "groupId" : { + "name" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "description" : "Label that identifies the synonym definition. Each **synonym.name** must be unique within the same index definition." }, - "id" : { + "source" : { + "$ref" : "#/components/schemas/SynonymSource" + } + }, + "required" : [ "analyzer", "name", "source" ], + "title" : "Synonym Mapping Definition" + }, + "ServerlessAWSTenantEndpoint" : { + "type" : "object", + "description" : "View for a serverless AWS tenant endpoint.", + "properties" : { + "_id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - }, - "matchers" : { - "type" : "array", - "description" : "Matching conditions for target resources.", - "items" : { - "$ref" : "#/components/schemas/AlertMatcher" - } - }, - "metricThreshold" : { - "$ref" : "#/components/schemas/ServerlessMetricThreshold" - }, - "notifications" : { - "type" : "array", - "description" : "List that contains the targets that MongoDB Cloud sends notifications.", - "items" : { - "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" - } - }, - "updated" : { + "cloudProviderEndpointId" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Unique string that identifies the private endpoint's network interface.", + "pattern" : "^vpce-[0-9a-f]{17}$", "readOnly" : true - } - }, - "required" : [ "eventTypeName", "notifications" ], - "title" : "Serverless Alert Configuration" - }, - "ServerlessMetricThreshold" : { - "type" : "object", - "description" : "Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.", - "discriminator" : { - "mapping" : { - "SERVERLESS_AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", - "SERVERLESS_AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", - "SERVERLESS_AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", - "SERVERLESS_CONNECTIONS" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricThresholdView", - "SERVERLESS_NETWORK_BYTES_IN" : "#/components/schemas/DataMetricThresholdView", - "SERVERLESS_NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricThresholdView", - "SERVERLESS_NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_OPCOUNTER_CMD" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_OPCOUNTER_QUERY" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_TOTAL_READ_UNITS" : "#/components/schemas/RPUMetricThresholdView", - "SERVERLESS_TOTAL_WRITE_UNITS" : "#/components/schemas/RPUMetricThresholdView" }, - "propertyName" : "metricName" - }, - "properties" : { - "metricName" : { + "comment" : { "type" : "string", - "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "readOnly" : true }, - "mode" : { + "endpointServiceName" : { "type" : "string", - "description" : "MongoDB Cloud computes the current metric value as an average.", - "enum" : [ "AVERAGE" ] - }, - "operator" : { - "$ref" : "#/components/schemas/Operator" - }, - "threshold" : { - "type" : "number", - "format" : "double", - "description" : "Value of metric that, when exceeded, triggers an alert." + "description" : "Unique string that identifies the Amazon Web Services (AWS) PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}", + "readOnly" : true }, - "units" : { - "type" : "string", - "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", - "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] - } - }, - "required" : [ "metricName" ], - "title" : "Serverless Metric Threshold" - }, - "ServerlessMetricUnits" : { - "type" : "string", - "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", - "enum" : [ "RPU", "THOUSAND_RPU", "MILLION_RPU", "WPU", "THOUSAND_WPU", "MILLION_WPU" ], - "example" : "RPU", - "title" : "Serverless Metric Units" - }, - "ServerlessProviderSettings" : { - "type" : "object", - "description" : "Group of cloud provider settings that configure the provisioned MongoDB serverless instance.", - "properties" : { - "backingProviderName" : { + "errorMessage" : { "type" : "string", - "description" : "Cloud service provider on which MongoDB Cloud provisioned the serverless instance.", - "enum" : [ "AWS", "AZURE", "GCP" ] + "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", + "readOnly" : true }, "providerName" : { "type" : "string", - "default" : "SERVERLESS", "description" : "Human-readable label that identifies the cloud service provider.", - "enum" : [ "SERVERLESS" ] + "enum" : [ "AWS" ], + "readOnly" : true }, - "regionName" : { + "status" : { "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/)." + "description" : "Human-readable label that indicates the current operating status of the private endpoint.", + "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true } }, - "required" : [ "backingProviderName", "regionName" ], - "title" : "Cloud Service Provider Settings for a Serverless Instance" + "title" : "AWS" }, - "ServerlessTenantCreateRequest" : { + "ServerlessAWSTenantEndpointUpdate" : { "type" : "object", - "properties" : { - "comment" : { - "type" : "string", - "description" : "Human-readable comment associated with the private endpoint.", - "maxLength" : 80, - "writeOnly" : true + "allOf" : [ { + "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" + }, { + "type" : "object", + "properties" : { + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface.", + "pattern" : "^vpce-[0-9a-f]{17}$", + "writeOnly" : true + } } - } + } ], + "description" : "Updates to a serverless AWS tenant endpoint.", + "required" : [ "providerName" ], + "title" : "AWS" }, - "ServerlessTenantEndpoint" : { + "ServerlessAzureTenantEndpoint" : { "type" : "object", - "oneOf" : [ { - "$ref" : "#/components/schemas/ServerlessAWSTenantEndpoint" - }, { - "$ref" : "#/components/schemas/ServerlessAzureTenantEndpoint" - } ], + "description" : "View for a serverless Azure tenant endpoint.", "properties" : { "_id" : { "type" : "string", @@ -44781,7 +46271,8 @@ }, "cloudProviderEndpointId" : { "type" : "string", - "description" : "Unique string that identifies the private endpoint's network interface.", + "description" : "Unique string that identifies the Azure private endpoint's network interface that someone added to this private endpoint service.", + "pattern" : "^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\\.Network/privateEndpoints/[-\\w._()]+$", "readOnly" : true }, "comment" : { @@ -44792,8 +46283,8 @@ }, "endpointServiceName" : { "type" : "string", - "description" : "Unique string that identifies the PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", - "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}|pls_[0-9a-f]{24}$", + "description" : "Unique string that identifies the Azure private endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^pls_[0-9a-f]{24}$", "readOnly" : true }, "errorMessage" : { @@ -44801,112 +46292,113 @@ "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", "readOnly" : true }, - "status" : { + "privateEndpointIpAddress" : { "type" : "string", - "description" : "Human-readable label that indicates the current operating status of the private endpoint.", - "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", "readOnly" : true - } - } - }, - "ServerlessTenantEndpointUpdate" : { - "type" : "object", - "description" : "Update view for a serverless tenant endpoint.", - "discriminator" : { - "mapping" : { - "AWS" : "#/components/schemas/ServerlessAWSTenantEndpointUpdate", - "AZURE" : "#/components/schemas/ServerlessAzureTenantEndpointUpdate" }, - "propertyName" : "providerName" - }, - "properties" : { - "comment" : { + "privateLinkServiceResourceId" : { "type" : "string", - "description" : "Human-readable comment associated with the private endpoint.", - "maxLength" : 80, - "writeOnly" : true + "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 provider of the tenant endpoint.", - "enum" : [ "AWS", "AZURE" ], - "writeOnly" : true + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "AZURE" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating status of the private endpoint.", + "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true } }, - "required" : [ "providerName" ] - }, - "ServiceAccountEventTypeViewForNdsGroup" : { - "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" ], - "title" : "Service Account Event Types" - }, - "ServiceAccountEventTypeViewForOrg" : { - "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" ], - "title" : "Service Account Event Types" + "title" : "Azure" }, - "ServiceAccountGroup" : { + "ServerlessAzureTenantEndpointUpdate" : { "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "allOf" : [ { + "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" + }, { + "type" : "object", + "properties" : { + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure private endpoint's network interface for this private endpoint service.", + "pattern" : "^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\\.Network/privateEndpoints/[-\\w._()]+$", + "writeOnly" : true + }, + "privateEndpointIpAddress" : { + "type" : "string", + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "writeOnly" : true + } } - } + } ], + "description" : "Updates to a serverless Azure tenant endpoint.", + "required" : [ "providerName" ], + "title" : "AZURE" }, - "ServiceAccountGroupEvents" : { + "ServerlessBackupRestoreJob" : { "type" : "object", - "description" : "Service Account event identifies different activities around user api keys.", "properties" : { - "apiKeyId" : { + "cancelled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone canceled this restore job.", + "readOnly" : true + }, + "deliveryType" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "description" : "Human-readable label that categorizes the restore job to create.", + "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\"`.", + "items" : { + "type" : "string", + "description" : "One Uniform Resource Locator that points to the compressed snapshot files for manual download." + }, "readOnly" : true }, - "created" : { + "desiredTimestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "expired" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job expired.", + "readOnly" : true + }, + "expiresAt" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Date and time when the restore job expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "eventTypeName" : { - "$ref" : "#/components/schemas/ServiceAccountEventTypeViewForNdsGroup" + "failed" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job failed.", + "readOnly" : true }, - "groupId" : { + "finishedAt" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "format" : "date-time", + "description" : "Date and time when the restore job completed. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "description" : "Unique 24-hexadecimal character string that identifies the restore job.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "isGlobalAdmin" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", - "readOnly" : true - }, "links" : { "type" : "array", "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", @@ -44919,98 +46411,87 @@ }, "readOnly" : true }, - "orgId" : { + "oplogInc" : { + "type" : "integer", + "format" : "int32", + "description" : "Oplog operation number from which you want to restore this snapshot. This number represents the second part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", + "example" : 1, + "minimum" : 1 + }, + "oplogTs" : { + "type" : "integer", + "format" : "int32", + "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`.", + "minimum" : 1199145600 + }, + "pointInTimeUTCSeconds" : { + "type" : "integer", + "format" : "int32", + "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`.", + "minimum" : 1199145600 + }, + "snapshotId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "publicKey" : { - "type" : "string", - "format" : "email", - "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "example" : "test.user@mongodb.com", - "readOnly" : true - }, - "raw" : { - "$ref" : "#/components/schemas/raw" + "pattern" : "^([a-f0-9]{24})$" }, - "remoteAddress" : { + "targetClusterName" : { "type" : "string", - "description" : "IPv4 or IPv6 address from which the user triggered this event.", - "example" : "216.172.40.186", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", - "readOnly" : true + "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\"`.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, - "userId" : { + "targetGroupId" : { "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.", + "description" : "Unique 24-hexadecimal digit string that identifies the target project for the specified **targetClusterName**.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "pattern" : "^([a-f0-9]{24})$" }, - "username" : { + "timestamp" : { "type" : "string", - "format" : "email", - "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", - "example" : "test.user@mongodb.com", + "format" : "date-time", + "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.", "readOnly" : true } }, - "required" : [ "created", "eventTypeName", "id" ], - "title" : "ServiceAccount Events" + "required" : [ "deliveryType", "targetClusterName", "targetGroupId" ] }, - "ServiceAccountOrgEvents" : { + "ServerlessBackupSnapshot" : { "type" : "object", - "description" : "Service Account event identifies different activities around user api keys.", "properties" : { - "apiKeyId" : { + "createdAt" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "created" : { + "expiresAt" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "eventTypeName" : { - "$ref" : "#/components/schemas/ServiceAccountEventTypeViewForOrg" - }, - "groupId" : { + "frequencyType" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "description" : "Human-readable label that identifies how often this snapshot triggers.", + "enum" : [ "hourly", "daily", "weekly", "monthly" ], "readOnly" : true }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "isGlobalAdmin" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", - "readOnly" : true - }, "links" : { "type" : "array", "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", @@ -45023,332 +46504,278 @@ }, "readOnly" : true }, - "orgId" : { + "mongodVersion" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "description" : "Version of the MongoDB host that this snapshot backs up.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", "readOnly" : true }, - "publicKey" : { + "serverlessInstanceName" : { "type" : "string", - "format" : "email", - "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "example" : "test.user@mongodb.com", + "description" : "Human-readable label given to the serverless instance from which MongoDB Cloud took this snapshot.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, - "raw" : { - "$ref" : "#/components/schemas/raw" - }, - "remoteAddress" : { + "snapshotType" : { "type" : "string", - "description" : "IPv4 or IPv6 address from which the user triggered this event.", - "example" : "216.172.40.186", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "description" : "Human-readable label that identifies when this snapshot triggers.", + "enum" : [ "onDemand", "scheduled" ], "readOnly" : true }, - "userId" : { + "status" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", + "enum" : [ "queued", "inProgress", "completed", "failed" ], "readOnly" : true }, - "username" : { - "type" : "string", - "format" : "email", - "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", - "example" : "test.user@mongodb.com", + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of bytes taken to store the backup snapshot.", "readOnly" : true } - }, - "required" : [ "created", "eventTypeName", "id" ], - "title" : "ServiceAccount Events" + } }, - "ServiceAccountSecret" : { + "ServerlessConnectionStringsPrivateEndpointItem" : { "type" : "object", + "description" : "Details of a private endpoint deployed for this serverless instance.", "properties" : { - "createdAt" : { + "endpointId" : { "type" : "string", - "format" : "date-time", - "description" : "Timestamp representing creation time.", + "description" : "Unique string that the cloud provider uses to identify the private endpoint.", "readOnly" : true }, - "expiresAt" : { + "providerName" : { "type" : "string", - "format" : "date-time", - "description" : "Timestamp representing secret expiration time.", + "description" : "Cloud provider where the private endpoint is deployed.", + "enum" : [ "AWS", "AZURE" ], "readOnly" : true }, - "id" : { + "region" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the secret.", - "example" : "32b6e34b3d91647abb20e7b8", - "pattern" : "^([a-f0-9]{24})$", + "description" : "Region where the private endpoint is deployed.", "readOnly" : true - }, - "lastUsedAt" : { - "type" : "string", - "format" : "date-time", - "description" : "Timestamp representing last secret usage.", + } + }, + "title" : "Serverless Instance Private Endpoint Connection Strings Endpoint" + }, + "ServerlessConnectionStringsPrivateEndpointList" : { + "type" : "object", + "description" : "Private endpoint connection string that you can use to connect to this serverless instance through a private endpoint.", + "externalDocs" : { + "description" : "Private Endpoint for Serverless Instance", + "url" : "https://docs.atlas.mongodb.com/security-serverless-private-endpoint/" + }, + "properties" : { + "endpoints" : { + "type" : "array", + "description" : "List that contains the private endpoints through which you connect to MongoDB Cloud when you use **connectionStrings.privateEndpoint[n].srvConnectionString**.", + "items" : { + "$ref" : "#/components/schemas/ServerlessConnectionStringsPrivateEndpointItem" + }, "readOnly" : true }, - "maskedSecretValue" : { + "srvConnectionString" : { "type" : "string", - "description" : "Service Account secret with masked values of the first 20 characters.", - "example" : "mdb_ic_sk_...12ce", + "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 }, - "secret" : { + "type" : { "type" : "string", - "description" : "Secret for the service account. It will be returned only the first time after service account creation.", - "pattern" : "^mdb_sa_sk_[0-9a-zA-Z]{40}$", + "description" : "MongoDB process type to which your application connects.", + "enum" : [ "MONGOS" ], "readOnly" : true } }, - "required" : [ "createdAt", "expiresAt", "id" ] + "title" : "Serverless Instance Private Endpoint Connection String" }, - "ServiceAccountSecretRequest" : { - "type" : "object", - "properties" : { - "secretExpiresAfterHours" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of hours representing validity duration for secret." - } - }, - "required" : [ "secretExpiresAfterHours" ] + "ServerlessEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], + "example" : "OUTSIDE_SERVERLESS_METRIC_THRESHOLD", + "title" : "Serverless Event Types" }, - "ShardEntry" : { + "ServerlessInstanceDescription" : { "type" : "object", - "description" : "Sharding configuration for a collection to be sharded on the destination cluster.", + "description" : "Group of settings that configure a MongoDB serverless instance.", "properties" : { - "collection" : { + "connectionStrings" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescriptionConnectionStrings" + }, + "createDate" : { "type" : "string", - "description" : "Human-readable label that identifies the collection to be sharded on the destination cluster.", - "writeOnly" : true + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true }, - "database" : { + "groupId" : { "type" : "string", - "description" : "Human-readable label that identifies the database that contains the collection to be sharded on the destination cluster.", - "writeOnly" : true + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "shardCollection" : { - "$ref" : "#/components/schemas/ShardKeys" - } - }, - "required" : [ "collection", "database", "shardCollection" ] - }, - "ShardKeys" : { - "type" : "object", - "description" : "Document that configures the shard key on the destination cluster.", - "properties" : { - "key" : { - "type" : "array", - "description" : "List of fields to use for the shard key.", - "items" : { - "type" : "object", - "additionalProperties" : { - "type" : "object" - } - }, - "uniqueItems" : true, - "writeOnly" : true - } - }, - "writeOnly" : true - }, - "ShardingRequest" : { - "type" : "object", - "description" : "Document that configures sharding on the destination cluster when migrating from a replica set source to a sharded cluster destination on MongoDB 6.0 or higher. If you don't wish to shard any collections on the destination cluster, leave this empty.", - "properties" : { - "createSupportingIndexes" : { - "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 + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the serverless instance.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "shardingEntries" : { + "links" : { "type" : "array", - "description" : "List of shard configurations to shard destination collections. Atlas shards only those collections that you include in the sharding entries array.", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, "items" : { - "$ref" : "#/components/schemas/ShardEntry" + "$ref" : "#/components/schemas/Link" }, - "uniqueItems" : true, - "writeOnly" : true - } - }, - "required" : [ "createSupportingIndexes" ], - "writeOnly" : true - }, - "Slack" : { - "type" : "object", - "description" : "Details to integrate one Slack account with one MongoDB Cloud project.", - "properties" : { - "apiToken" : { + "readOnly" : true + }, + "mongoDBVersion" : { "type" : "string", - "description" : "Key that allows MongoDB Cloud to access your Slack account.\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.\n\n**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" + "description" : "Version of MongoDB that the serverless instance runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true }, - "channelName" : { + "name" : { "type" : "string", - "description" : "Name of the Slack channel to which MongoDB Cloud sends alert notifications.", - "example" : "alerts", - "maxLength" : 80, + "description" : "Human-readable label that identifies the serverless instance.", + "maxLength" : 64, "minLength" : 1, - "nullable" : true + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, - "id" : { - "type" : "string", - "description" : "Integration id.", - "nullable" : true + "providerSettings" : { + "$ref" : "#/components/schemas/ServerlessProviderSettings" }, - "teamName" : { - "type" : "string", - "description" : "Human-readable label that identifies your Slack team. Set this parameter when you configure a legacy Slack integration.", - "example" : "MongoDB" + "serverlessBackupOptions" : { + "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" }, - "type" : { + "stateName" : { "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" : "Human-readable label that indicates the current operating condition of the serverless instance.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." } }, - "required" : [ "apiToken", "channelName" ], - "title" : "SLACK" + "required" : [ "providerSettings" ], + "title" : "Serverless Instance Description" }, - "SlackNotification" : { + "ServerlessInstanceDescriptionConnectionStrings" : { "type" : "object", - "description" : "Slack notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, "properties" : { - "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", - "format" : "int32", - "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." - }, - "integrationId" : { - "type" : "string", - "description" : "The id of the associated integration, the credentials of which to use for requests.", - "example" : "32b6e34b3d91647abb20e7b8" - }, - "intervalMin" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", - "minimum" : 5 - }, - "notifierId" : { - "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" + "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.", + "items" : { + "$ref" : "#/components/schemas/ServerlessConnectionStringsPrivateEndpointList" + }, + "readOnly" : true }, - "typeName" : { + "standardSrv" : { "type" : "string", - "description" : "Human-readable label that displays the alert notification type.", - "enum" : [ "SLACK" ] + "description" : "Public connection string that you can use to connect to this serverless instance. This connection string uses the `mongodb+srv://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true } }, - "required" : [ "typeName" ], - "title" : "Slack Notification" + "readOnly" : true, + "title" : "Serverless Instance Connection Strings" }, - "Source" : { + "ServerlessInstanceDescriptionCreate" : { "type" : "object", - "description" : "Document that describes the source of the migration.", + "description" : "Settings that you can specify when you create a serverless instance.", "properties" : { - "caCertificatePath" : { + "name" : { "type" : "string", - "description" : "Path to the CA certificate that signed SSL certificates use to authenticate to the source cluster." + "description" : "Human-readable label that identifies the serverless instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "writeOnly" : true }, - "clusterName" : { - "type" : "string", - "description" : "Label that identifies the source cluster name." + "providerSettings" : { + "$ref" : "#/components/schemas/ServerlessProviderSettings" }, - "groupId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the source project.", - "example" : "9b43a5b329223c3a1591a678", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" + "serverlessBackupOptions" : { + "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" }, - "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." + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the serverless instance.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true }, - "password" : { - "type" : "string", - "description" : "Password that authenticates the username to the source cluster.", - "writeOnly" : true + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } }, - "ssl" : { + "terminationProtectionEnabled" : { "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 - } - }, - "required" : [ "clusterName", "groupId", "managedAuthentication", "ssl" ] - }, - "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/" + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." } }, - "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/" - } + "required" : [ "name", "providerSettings" ], + "title" : "Serverless Instance Description Create" }, - "StreamConfig" : { + "ServerlessInstanceDescriptionUpdate" : { "type" : "object", - "description" : "Configuration options for an Atlas Stream Processing Instance.", - "nullable" : true, + "description" : "Settings that you can update when you request a serverless cluster update.", "properties" : { - "links" : { + "serverlessBackupOptions" : { + "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" + }, + "tags" : { "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true + "$ref" : "#/components/schemas/ResourceTag" + } }, - "tier" : { - "type" : "string", - "description" : "Selected tier for the Stream Instance. Configures Memory / VCPU allowances.", - "enum" : [ "SP30", "SP10" ], - "title" : "Stream Instance Tier" + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." } - } + }, + "title" : "Serverless Instance Description Update" }, - "StreamProcessorAlertConfigViewForNdsGroup" : { + "ServerlessMetricAlertConfigViewForNdsGroup" : { "type" : "object", - "description" : "Host metric alert configuration allows to select which Atlas streams processors trigger alerts and how users are notified.", + "description" : "Serverless metric alert configuration allows to select which serverless database metrics trigger alerts and how users are notified.", "properties" : { "created" : { "type" : "string", @@ -45362,7 +46789,7 @@ "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." }, "eventTypeName" : { - "$ref" : "#/components/schemas/StreamProcessorEventTypeViewAlertable" + "$ref" : "#/components/schemas/ServerlessEventTypeViewAlertable" }, "groupId" : { "type" : "string", @@ -45396,11 +46823,14 @@ }, "matchers" : { "type" : "array", - "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration.", + "description" : "Matching conditions for target resources.", "items" : { - "$ref" : "#/components/schemas/StreamsMatcher" + "$ref" : "#/components/schemas/AlertMatcher" } }, + "metricThreshold" : { + "$ref" : "#/components/schemas/ServerlessMetricThreshold" + }, "notifications" : { "type" : "array", "description" : "List that contains the targets that MongoDB Cloud sends notifications.", @@ -45416,157 +46846,215 @@ } }, "required" : [ "eventTypeName", "notifications" ], - "title" : "Stream Processor Alert Configuration" + "title" : "Serverless Alert Configuration" }, - "StreamProcessorAlertViewForNdsGroup" : { + "ServerlessMetricThreshold" : { "type" : "object", - "description" : "Stream Processor alert notifies about activities on Stream Processor in AtlasStreams.", + "description" : "Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.", + "discriminator" : { + "mapping" : { + "SERVERLESS_AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_CONNECTIONS" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_BYTES_IN" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_CMD" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_QUERY" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_TOTAL_READ_UNITS" : "#/components/schemas/RPUMetricThresholdView", + "SERVERLESS_TOTAL_WRITE_UNITS" : "#/components/schemas/RPUMetricThresholdView" + }, + "propertyName" : "metricName" + }, "properties" : { - "acknowledgedUntil" : { + "metricName" : { "type" : "string", - "format" : "date-time", - "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.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." }, - "acknowledgementComment" : { + "mode" : { "type" : "string", - "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", - "example" : "Expiration on 3/19. Silencing for 7days.", - "maxLength" : 200 + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] }, - "acknowledgingUsername" : { + "operator" : { "type" : "string", - "format" : "email", - "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", - "readOnly" : true + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, - "alertConfigId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." }, - "created" : { + "units" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true - }, - "eventTypeName" : { - "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroupAlertable" - }, - "groupId" : { + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] + } + }, + "required" : [ "metricName" ], + "title" : "Serverless Metric Threshold" + }, + "ServerlessMetricUnits" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "RPU", "THOUSAND_RPU", "MILLION_RPU", "WPU", "THOUSAND_WPU", "MILLION_WPU" ], + "example" : "RPU", + "title" : "Serverless Metric Units" + }, + "ServerlessProviderSettings" : { + "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB serverless instance.", + "properties" : { + "backingProviderName" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "description" : "Cloud service provider on which MongoDB Cloud provisioned the serverless instance.", + "enum" : [ "AWS", "AZURE", "GCP" ] }, - "id" : { + "providerName" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies this alert.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "default" : "SERVERLESS", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "SERVERLESS" ] }, - "instanceName" : { + "regionName" : { "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.", - "example" : "foobar", - "readOnly" : true - }, - "lastNotified" : { + "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/)." + } + }, + "required" : [ "backingProviderName", "regionName" ], + "title" : "Cloud Service Provider Settings for a Serverless Instance" + }, + "ServerlessTenantCreateRequest" : { + "type" : "object", + "properties" : { + "comment" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", - "readOnly" : true - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - }, - "orgId" : { + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "writeOnly" : true + } + } + }, + "ServerlessTenantEndpoint" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/ServerlessAWSTenantEndpoint" + }, { + "$ref" : "#/components/schemas/ServerlessAzureTenantEndpoint" + } ], + "properties" : { + "_id" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "processorErrorMsg" : { + "cloudProviderEndpointId" : { "type" : "string", - "description" : "The error message associated with the Stream Processor to which this alert applies.", - "example" : "MongoServerError: Failed to start stream processor: (Location77175) Could not connect to the Kafka topic with kafka error code: -195, message: Local: Broker transport failure.: (Location77175)", + "description" : "Unique string that identifies the private endpoint's network interface.", "readOnly" : true }, - "processorName" : { + "comment" : { "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.", - "example" : "foobar", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, "readOnly" : true }, - "processorState" : { + "endpointServiceName" : { "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.", - "example" : "STARTED", + "description" : "Unique string that identifies the PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}|pls_[0-9a-f]{24}$", "readOnly" : true }, - "resolved" : { + "errorMessage" : { "type" : "string", - "format" : "date-time", - "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\"`.", + "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", "readOnly" : true }, "status" : { "type" : "string", - "description" : "State of this alert at the time you requested its details.", - "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], - "example" : "OPEN", + "description" : "Human-readable label that indicates the current operating status of the private endpoint.", + "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], "readOnly" : true + } + } + }, + "ServerlessTenantEndpointUpdate" : { + "type" : "object", + "description" : "Update view for a serverless tenant endpoint.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/ServerlessAWSTenantEndpointUpdate", + "AZURE" : "#/components/schemas/ServerlessAzureTenantEndpointUpdate" }, - "updated" : { + "propertyName" : "providerName" + }, + "properties" : { + "comment" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "writeOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider of the tenant endpoint.", + "enum" : [ "AWS", "AZURE" ], + "writeOnly" : true } }, - "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], - "title" : "Stream Processor Alerts" + "required" : [ "providerName" ] }, - "StreamProcessorEventTypeViewAlertable" : { + "ServiceAccountEventTypeViewForNdsGroup" : { "type" : "string", - "description" : "Event type that triggers an alert.", - "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], - "example" : "STREAM_PROCESSOR_STATE_IS_FAILED", - "title" : "Stream Processor Event Types" + "description" : "Unique identifier of event type.", + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" }, - "StreamProcessorEventTypeViewForNdsGroup" : { + "ServiceAccountEventTypeViewForOrg" : { "type" : "string", "description" : "Unique identifier of event type.", - "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], - "example" : "STREAM_PROCESSOR_STATE_IS_FAILED", - "title" : "Stream Processor Event Types" + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" }, - "StreamProcessorEventViewForNdsGroup" : { + "ServiceAccountGroup" : { "type" : "object", - "description" : "Stream Processor event identifies different activities about a stream processor in Atlas Streams.", "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies your project. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "ServiceAccountGroupEvents" : { + "type" : "object", + "description" : "Service Account event identifies different activities around user api keys.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, "created" : { "type" : "string", "format" : "date-time", @@ -45574,7 +47062,7 @@ "readOnly" : true }, "eventTypeName" : { - "$ref" : "#/components/schemas/StreamProcessorEventTypeViewForNdsGroup" + "$ref" : "#/components/schemas/ServiceAccountEventTypeViewForNdsGroup" }, "groupId" : { "type" : "string", @@ -45594,10 +47082,10 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "instanceName" : { - "type" : "string", - "description" : "Name of the stream processing instance associated with the event.", - "example" : "foobar", + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", "readOnly" : true }, "links" : { @@ -45621,159 +47109,96 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "processorErrorMsg" : { - "type" : "string", - "description" : "Error message linked to the stream processor associated with the event.", - "example" : "invalid auth", - "readOnly" : true - }, - "processorName" : { - "type" : "string", - "description" : "Name of the stream processor associated with the event.", - "example" : "foobar", - "readOnly" : true - }, - "processorState" : { + "publicKey" : { "type" : "string", - "description" : "State of the stream processor associated with the event.", - "example" : "FAILED", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true }, "raw" : { "$ref" : "#/components/schemas/raw" - } - }, - "required" : [ "created", "eventTypeName", "id" ], - "title" : "Stream Processor Events" - }, - "StreamsClusterConnection" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/StreamsConnection" - }, { - "type" : "object", - "properties" : { - "clusterName" : { - "type" : "string", - "description" : "Name of the cluster configured for this connection." - }, - "dbRoleToExecute" : { - "$ref" : "#/components/schemas/DBRoleToExecute" - } - } - } ] - }, - "StreamsConnection" : { - "type" : "object", - "description" : "Settings that define a connection to an external data store.", - "discriminator" : { - "mapping" : { - "Cluster" : "#/components/schemas/StreamsClusterConnection", - "Kafka" : "#/components/schemas/StreamsKafkaConnection", - "Sample" : "#/components/schemas/StreamsSampleConnection" }, - "propertyName" : "type" - }, - "oneOf" : [ { - "$ref" : "#/components/schemas/StreamsSampleConnection" - }, { - "$ref" : "#/components/schemas/StreamsClusterConnection" - }, { - "$ref" : "#/components/schemas/StreamsKafkaConnection" - } ], - "properties" : { - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", "readOnly" : true }, - "name" : { + "userId" : { "type" : "string", - "description" : "Human-readable label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source." + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "type" : { + "username" : { "type" : "string", - "description" : "Type of the connection. Can be either Cluster or Kafka.", - "enum" : [ "Kafka", "Cluster", "Sample" ] + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true } }, - "readOnly" : true + "required" : [ "created", "eventTypeName", "id" ], + "title" : "ServiceAccount Events" }, - "StreamsDLQ" : { + "ServiceAccountIPAccessListEntry" : { "type" : "object", - "description" : "Dead letter queue for the stream processor.", "properties" : { - "coll" : { + "cidrBlock" : { "type" : "string", - "description" : "Name of the collection that will be used for the DLQ." + "description" : "Range of network addresses in the access list for the Service Account. This parameter requires the range to be expressed in Classless Inter-Domain Routing (CIDR) notation of Internet Protocol version 4 or version 6 addresses. You can set a value for this parameter or **ipAddress**, but not for both in the same request.", + "example" : "203.0.113.0/24", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" }, - "connectionName" : { + "createdAt" : { "type" : "string", - "description" : "Connection name that will be used to write DLQ messages to. Has to be an Atlas connection." + "format" : "date-time", + "description" : "Date MongoDB Cloud added the entry was added to the Access List.", + "readOnly" : true }, - "db" : { + "ipAddress" : { "type" : "string", - "description" : "Name of the database that will be used for the DLQ." + "description" : "Network address in the access list for the Service Account. This parameter requires the address to be expressed as one Internet Protocol version 4 or version 6 address. You can set a value for this parameter or **cidrBlock**, but not for both in the same request.", + "example" : "203.0.113.10", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - } - } - }, - "StreamsDataProcessRegion" : { - "type" : "object", - "description" : "Information about the cloud provider region in which MongoDB Cloud processes the stream.", - "properties" : { - "cloudProvider" : { + "lastUsedAddress" : { "type" : "string", - "description" : "Label that identifies the cloud service provider where MongoDB Cloud performs stream processing. Currently, this parameter supports AWS only.", - "enum" : [ "AWS", "GCP", "AZURE", "TENANT", "SERVERLESS" ] + "description" : "Network address that issued the most recent request to the API. This parameter requires the address to be expressed as one Internet Protocol version 4 or version 6 address. The resource returns this parameter after this IP address makes at least one request.", + "readOnly" : true }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, + "lastUsedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date when MongoDB Cloud received the most recent request that originated from this Internet Protocol version 4 or version 6 address. The resource returns this parameter when at least one request originates from this IP address. MongoDB Cloud updates this parameter each time a client accesses the permitted resource, with a delay of up to 5 minutes.", "readOnly" : true }, - "region" : { - "$ref" : "#/components/schemas/BaseStreamsRegion" + "requestCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of requests that has originated from this network address.", + "readOnly" : true } - }, - "required" : [ "cloudProvider", "region" ] - }, - "StreamsEventTypeViewForNdsGroup" : { - "type" : "string", - "description" : "Unique identifier of event type.", - "enum" : [ "MAX_PROCESSOR_COUNT_REACHED" ], - "example" : "MAX_PROCESSOR_COUNT_REACHED", - "title" : "Streams Event Types" + } }, - "StreamsEventViewForNdsGroup" : { + "ServiceAccountOrgEvents" : { "type" : "object", - "description" : "Streams event identifies different activities about Atlas Streams.", + "description" : "Service Account event identifies different activities around user api keys.", "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, "created" : { "type" : "string", "format" : "date-time", @@ -45781,7 +47206,7 @@ "readOnly" : true }, "eventTypeName" : { - "$ref" : "#/components/schemas/StreamsEventTypeViewForNdsGroup" + "$ref" : "#/components/schemas/ServiceAccountEventTypeViewForOrg" }, "groupId" : { "type" : "string", @@ -45801,10 +47226,10 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "instanceName" : { - "type" : "string", - "description" : "Name of the stream processing instance associated with the event.", - "example" : "foobar", + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", "readOnly" : true }, "links" : { @@ -45828,387 +47253,217 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, "raw" : { "$ref" : "#/components/schemas/raw" - } - }, - "required" : [ "created", "eventTypeName", "id" ], - "title" : "Streams Events" - }, - "StreamsKafkaAuthentication" : { - "type" : "object", - "description" : "User credentials required to connect to a Kafka Cluster. Includes the authentication type, as well as the parameters for that authentication mode.", - "properties" : { - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true }, - "mechanism" : { + "remoteAddress" : { "type" : "string", - "description" : "Style of authentication. Can be one of PLAIN, SCRAM-256, or SCRAM-512." + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true }, - "password" : { + "userId" : { "type" : "string", - "format" : "password", - "description" : "Password of the account to connect to the Kafka cluster.", - "writeOnly" : true + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, "username" : { "type" : "string", - "description" : "Username of the account to connect to the Kafka cluster." - } - } - }, - "StreamsKafkaConnection" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/StreamsConnection" - }, { - "type" : "object", - "properties" : { - "authentication" : { - "$ref" : "#/components/schemas/StreamsKafkaAuthentication" - }, - "bootstrapServers" : { - "type" : "string", - "description" : "Comma separated list of server addresses." - }, - "config" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "description" : "A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.", - "example" : "{\"group.protocol.type\":\"consumer\",\"debug\":\"queue, msg, protocol\"}" - }, - "description" : "A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.", - "example" : { - "debug" : "queue, msg, protocol", - "group.protocol.type" : "consumer" - } - }, - "networking" : { - "$ref" : "#/components/schemas/StreamsKafkaNetworking" - }, - "proxyInfo" : { - "$ref" : "#/components/schemas/ProxyInfo" - }, - "security" : { - "$ref" : "#/components/schemas/StreamsKafkaSecurity" - } - } - } ] - }, - "StreamsKafkaNetworking" : { - "type" : "object", - "description" : "Networking Access Type can either be 'PUBLIC' (default) or VPC. VPC type is in public preview, please file a support ticket to enable VPC Network Access", - "properties" : { - "access" : { - "$ref" : "#/components/schemas/StreamsKafkaNetworkingAccess" - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true } - } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "ServiceAccount Events" }, - "StreamsKafkaNetworkingAccess" : { + "ServiceAccountSecret" : { "type" : "object", - "description" : "Information about the networking access.", "properties" : { - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "The date that the secret was created on.", "readOnly" : true }, - "name" : { + "expiresAt" : { "type" : "string", - "description" : "Id of the vpc peer when the type is VPC." + "format" : "date-time", + "description" : "The date for the expiration of the secret.", + "readOnly" : true }, - "type" : { + "id" : { "type" : "string", - "description" : "Selected networking type. Either PUBLIC or VPC. Defaults to PUBLIC", - "enum" : [ "PUBLIC", "VPC" ], - "title" : "Networking Access Type" - } - } - }, - "StreamsKafkaSecurity" : { - "type" : "object", - "description" : "Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use.", - "properties" : { - "brokerPublicCertificate" : { + "description" : "Unique 24-hexadecimal digit string that identifies the secret.", + "example" : "32b6e34b3d91647abb20e7b8", + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastUsedAt" : { "type" : "string", - "description" : "A trusted, public x509 certificate for connecting to Kafka over SSL." + "format" : "date-time", + "description" : "The last time the secret was used.", + "readOnly" : true }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, + "maskedSecretValue" : { + "type" : "string", + "description" : "The masked Service Account secret.", + "example" : "mdb_ic_sk_...12ce", "readOnly" : true }, - "protocol" : { + "secret" : { "type" : "string", - "description" : "Describes the transport type. Can be either PLAINTEXT or SSL." + "description" : "The secret for the Service Account. It will be returned only the first time after creation.", + "pattern" : "^mdb_sa_sk_[0-9a-zA-Z_-]{40}$", + "readOnly" : true } - } + }, + "required" : [ "createdAt", "expiresAt", "id" ] }, - "StreamsMatcher" : { + "ServiceAccountSecretRequest" : { "type" : "object", - "description" : "Rules to apply when comparing a stream processing instance or stream processor against this alert configuration.", "properties" : { - "fieldName" : { - "$ref" : "#/components/schemas/StreamsMatcherField" - }, - "operator" : { + "secretExpiresAfterHours" : { + "type" : "integer", + "format" : "int32", + "description" : "The expiration time of the new Service Account secret. The expiration is provided in hours." + } + }, + "required" : [ "secretExpiresAfterHours" ] + }, + "ShardEntry" : { + "type" : "object", + "description" : "Sharding configuration for a collection to be sharded on the destination cluster.", + "properties" : { + "collection" : { "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" ] + "description" : "Human-readable label that identifies the collection to be sharded on the destination cluster.", + "writeOnly" : true }, - "value" : { + "database" : { "type" : "string", - "description" : "Value to match or exceed using the specified **matchers.operator**.", - "example" : "event-replica-set" + "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" } }, - "required" : [ "fieldName", "operator", "value" ], - "title" : "Matchers" - }, - "StreamsMatcherField" : { - "type" : "string", - "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", - "enum" : [ "INSTANCE_NAME", "PROCESSOR_NAME" ], - "example" : "INSTANCE_NAME", - "title" : "Streams Matcher Fields" + "required" : [ "collection", "database", "shardCollection" ] }, - "StreamsOptions" : { + "ShardKeys" : { "type" : "object", - "description" : "Optional configuration for the stream processor.", + "description" : "Document that configures the shard key on the destination cluster.", "properties" : { - "dlq" : { - "$ref" : "#/components/schemas/StreamsDLQ" - }, - "links" : { + "key" : { "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, + "description" : "List of fields to use for the shard key.", "items" : { - "$ref" : "#/components/schemas/Link" + "type" : "object", + "additionalProperties" : { + "type" : "object" + } }, - "readOnly" : true + "uniqueItems" : true, + "writeOnly" : true } - } + }, + "writeOnly" : true }, - "StreamsProcessor" : { + "ShardingRequest" : { "type" : "object", - "description" : "An atlas stream processor.", + "description" : "Document that configures sharding on the destination cluster when migrating from a replica set source to a sharded cluster destination on MongoDB 6.0 or higher. If you don't wish to shard any collections on the destination cluster, leave this empty.", "properties" : { - "_id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the stream processor.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "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 }, - "links" : { + "shardingEntries" : { "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, + "description" : "List of shard configurations to shard destination collections. Atlas shards only those collections that you include in the sharding entries array.", "items" : { - "$ref" : "#/components/schemas/Link" + "$ref" : "#/components/schemas/ShardEntry" }, - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "Human-readable name of the stream processor." - }, - "options" : { - "$ref" : "#/components/schemas/StreamsOptions" - }, - "pipeline" : { - "type" : "array", - "description" : "Stream aggregation pipeline you want to apply to your streaming data.", - "items" : { - "$ref" : "#/components/schemas/Document" - } + "uniqueItems" : true, + "writeOnly" : true } - } + }, + "required" : [ "createSupportingIndexes" ], + "writeOnly" : true }, - "StreamsProcessorWithStats" : { + "Slack" : { "type" : "object", - "description" : "An atlas stream processor with optional stats.", + "description" : "Details to integrate one Slack account with one MongoDB Cloud project.", "properties" : { - "_id" : { + "apiToken" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the stream processor.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true + "description" : "Key that allows MongoDB Cloud to access your Slack account.\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.\n\n**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" }, - "name" : { + "channelName" : { "type" : "string", - "description" : "Human-readable name of the stream processor.", - "readOnly" : true + "description" : "Name of the Slack channel to which MongoDB Cloud sends alert notifications.", + "example" : "alerts", + "maxLength" : 80, + "minLength" : 1, + "nullable" : true }, - "pipeline" : { - "type" : "array", - "description" : "Stream aggregation pipeline you want to apply to your streaming data.", - "items" : { - "$ref" : "#/components/schemas/Document" - }, - "readOnly" : true + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true }, - "state" : { + "teamName" : { "type" : "string", - "description" : "The state of the stream processor.", - "readOnly" : true + "description" : "Human-readable label that identifies your Slack team. Set this parameter when you configure a legacy Slack integration.", + "example" : "MongoDB" }, - "stats" : { - "type" : "object", - "additionalProperties" : { - "type" : "object", - "description" : "The stats associated with the stream processor.", - "readOnly" : true - }, - "description" : "The stats associated with the stream processor.", - "readOnly" : 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" : [ "SLACK" ] } }, - "required" : [ "_id", "name", "pipeline", "state" ] - }, - "StreamsSampleConnection" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/StreamsConnection" - } ] + "required" : [ "apiToken", "channelName" ], + "title" : "SLACK" }, - "StreamsTenant" : { + "SlackNotification" : { "type" : "object", + "description" : "Slack notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", "properties" : { - "_id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the project.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "connections" : { - "type" : "array", - "description" : "List of connections configured in the stream instance.", - "items" : { - "$ref" : "#/components/schemas/StreamsConnection" - }, - "readOnly" : true - }, - "dataProcessRegion" : { - "$ref" : "#/components/schemas/StreamsDataProcessRegion" - }, - "groupId" : { + "apiToken" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the project.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "hostnames" : { - "type" : "array", - "description" : "List that contains the hostnames assigned to the stream instance.", - "items" : { - "type" : "string", - "description" : "Unique hostname assigned to the stream instance.", - "readOnly" : true - }, - "readOnly" : true - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true + "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" }, - "name" : { + "channelName" : { "type" : "string", - "description" : "Human-readable label that identifies the stream instance." + "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" }, - "streamConfig" : { - "$ref" : "#/components/schemas/StreamConfig" - } - } - }, - "SummaryNotification" : { - "type" : "object", - "description" : "Summary notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", - "properties" : { "delayMin" : { "type" : "integer", "format" : "int32", "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." }, - "emailAddress" : { + "integrationId" : { "type" : "string", - "format" : "email", - "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:\n\n- specific MongoDB Cloud users (`\"notifications.[n].typeName\" : \"USER\"`)\n- MongoDB Cloud users with specific project roles (`\"notifications.[n].typeName\" : \"GROUP\"`)\n- MongoDB Cloud users with specific organization roles (`\"notifications.[n].typeName\" : \"ORG\"`)\n- MongoDB Cloud teams (`\"notifications.[n].typeName\" : \"TEAM\"`)\n\nTo send emails to one MongoDB Cloud user or grouping of users, set the **notifications.[n].emailEnabled** parameter." + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" }, "intervalMin" : { "type" : "integer", @@ -46224,68 +47479,74 @@ "typeName" : { "type" : "string", "description" : "Human-readable label that displays the alert notification type.", - "enum" : [ "SUMMARY" ] + "enum" : [ "SLACK" ] } }, "required" : [ "typeName" ], - "title" : "Summary Notification" + "title" : "Slack Notification" }, - "SynonymMappingStatusDetail" : { + "Source" : { "type" : "object", - "description" : "Contains the status of the index's synonym mappings on each search host. This field (and its subfields) only appear if the index has synonyms defined.", + "description" : "Document that describes the source of the migration.", "properties" : { - "message" : { + "caCertificatePath" : { "type" : "string", - "description" : "Optional message describing an error." + "description" : "Path to the CA certificate that signed SSL certificates use to authenticate to the source cluster." }, - "queryable" : { + "clusterName" : { + "type" : "string", + "description" : "Label that identifies the source cluster name." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the source project.", + "example" : "9b43a5b329223c3a1591a678", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "managedAuthentication" : { "type" : "boolean", - "description" : "Flag that indicates whether the synonym mapping is queryable on a host." + "description" : "Flag that indicates whether MongoDB Automation manages authentication to the source cluster. If true, do not provide values for username and password." }, - "status" : { + "password" : { "type" : "string", - "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", - "enum" : [ "FAILED", "BUILDING", "READY" ] + "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 } }, - "title" : "Synonym Mapping Status Detail" + "required" : [ "clusterName", "groupId", "managedAuthentication", "ssl" ] }, - "SynonymMappingStatusDetailMap" : { + "StorageEngine" : { "type" : "object", "additionalProperties" : { - "$ref" : "#/components/schemas/SynonymMappingStatusDetail" - }, - "x-additionalPropertiesName" : "Synonym Mapping Name" - }, - "SynonymSource" : { - "type" : "object", - "description" : "Data set that stores words and their applicable synonyms.", - "properties" : { - "collection" : { - "type" : "string", - "description" : "Label that identifies the MongoDB collection that stores words and their applicable synonyms." + "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/" } }, - "required" : [ "collection" ] + "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/" + } }, - "SystemStatus" : { + "StreamConfig" : { "type" : "object", + "description" : "Configuration options for an Atlas Stream Processing Instance.", + "nullable" : true, "properties" : { - "apiKey" : { - "$ref" : "#/components/schemas/ApiKey" - }, - "appName" : { - "type" : "string", - "description" : "Human-readable label that identifies the service from which you requested this response.", - "enum" : [ "MongoDB Atlas" ], - "readOnly" : true - }, - "build" : { - "type" : "string", - "description" : "Unique 40-hexadecimal digit hash that identifies the latest git commit merged for this application.", - "example" : "83be55e140f493c88e7f578aae96548dd881587b", - "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.", @@ -46298,43 +47559,44 @@ }, "readOnly" : true }, - "throttling" : { - "type" : "boolean", - "description" : "Flag that indicates whether someone enabled throttling on this service.", - "readOnly" : true - } - }, - "required" : [ "apiKey", "appName", "build", "throttling" ] - }, - "TargetOrg" : { - "type" : "object", - "properties" : { - "linkToken" : { + "tier" : { "type" : "string", - "description" : "Link token that contains all the information required to complete the link." - } - }, - "required" : [ "linkToken" ] - }, - "TargetOrgRequest" : { - "type" : "object", - "properties" : { - "accessListIps" : { - "type" : "array", - "description" : "IP address access list entries associated with the API key.", - "items" : { - "type" : "string", - "description" : "One IP address access list entry associated with the API key." - } + "description" : "Selected tier for the Stream Instance. Configures Memory / VCPU allowances.", + "enum" : [ "SP30", "SP10" ], + "title" : "Stream Instance Tier" } } }, - "Team" : { + "StreamProcessorAlertConfigViewForNdsGroup" : { "type" : "object", + "description" : "Host metric alert configuration allows to select which Atlas streams processors trigger alerts and how users are notified.", "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/StreamProcessorEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies this team.", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -46353,30 +47615,54 @@ }, "readOnly" : true }, - "name" : { - "type" : "string", - "description" : "Human-readable label that identifies the team." + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration.", + "items" : { + "$ref" : "#/components/schemas/StreamsMatcher" + } }, - "usernames" : { + "notifications" : { "type" : "array", - "description" : "List that contains the MongoDB Cloud users in this team.", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", "items" : { - "type" : "string", - "format" : "email", - "description" : "List that contains email addresses that identify MongoDB Cloud users to in this team." - }, - "uniqueItems" : true + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true } }, - "required" : [ "name" ] + "required" : [ "eventTypeName", "notifications" ], + "title" : "Stream Processor Alert Configuration" }, - "TeamEvent" : { + "StreamProcessorAlertViewForNdsGroup" : { "type" : "object", - "description" : "Team event identifies different activities around organization teams.", + "description" : "Stream Processor alert notifies about activities on Stream Processor in AtlasStreams.", "properties" : { - "apiKeyId" : { + "acknowledgedUntil" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "format" : "date-time", + "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.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -46386,15 +47672,15 @@ "created" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, "eventTypeName" : { - "$ref" : "#/components/schemas/TeamEventTypeView" + "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroupAlertable" }, "groupId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -46403,17 +47689,23 @@ }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "isGlobalAdmin" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "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.", + "example" : "foobar", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", "readOnly" : true }, "links" : { @@ -46430,86 +47722,72 @@ }, "orgId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "publicKey" : { + "processorErrorMsg" : { "type" : "string", - "format" : "email", - "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "example" : "test.user@mongodb.com", + "description" : "The error message associated with the Stream Processor to which this alert applies.", + "example" : "MongoServerError: Failed to start stream processor: (Location77175) Could not connect to the Kafka topic with kafka error code: -195, message: Local: Broker transport failure.: (Location77175)", "readOnly" : true }, - "raw" : { - "$ref" : "#/components/schemas/raw" + "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.", + "example" : "foobar", + "readOnly" : true }, - "remoteAddress" : { + "processorState" : { "type" : "string", - "description" : "IPv4 or IPv6 address from which the user triggered this event.", - "example" : "216.172.40.186", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "description" : "The state of the Stream Processor to which this alert applies. The resource returns this parameter for alerts of events impacting Stream Processors.", + "example" : "STARTED", "readOnly" : true }, - "teamId" : { + "resolved" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization team associated with this event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "format" : "date-time", + "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\"`.", "readOnly" : true }, - "userId" : { + "status" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", "readOnly" : true }, - "username" : { + "updated" : { "type" : "string", - "format" : "email", - "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", - "example" : "test.user@mongodb.com", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true } }, - "required" : [ "created", "eventTypeName", "id" ], - "title" : "Team Events" + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Stream Processor Alerts" }, - "TeamEventTypeView" : { + "StreamProcessorEventTypeViewAlertable" : { "type" : "string", - "description" : "Unique identifier of event type.", - "enum" : [ "TEAM_CREATED", "TEAM_DELETED", "TEAM_UPDATED", "TEAM_NAME_CHANGED", "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], - "example" : "TEAM_ADDED_TO_GROUP", - "title" : "Team Event Types" + "description" : "Event type that triggers an alert.", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "example" : "STREAM_PROCESSOR_STATE_IS_FAILED", + "title" : "Stream Processor Event Types" }, - "TeamEventTypeViewForNdsGroup" : { + "StreamProcessorEventTypeViewForNdsGroup" : { "type" : "string", "description" : "Unique identifier of event type.", - "enum" : [ "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], - "example" : "TEAM_ADDED_TO_GROUP", - "title" : "Team Event Types" + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "example" : "STREAM_PROCESSOR_STATE_IS_FAILED", + "title" : "Stream Processor Event Types" }, - "TeamEventViewForNdsGroup" : { + "StreamProcessorEventViewForNdsGroup" : { "type" : "object", - "description" : "Team event identifies different activities around organization teams.", + "description" : "Stream Processor event identifies different activities about a stream processor in Atlas Streams.", "properties" : { - "apiKeyId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, "created" : { "type" : "string", "format" : "date-time", @@ -46517,7 +47795,7 @@ "readOnly" : true }, "eventTypeName" : { - "$ref" : "#/components/schemas/TeamEventTypeViewForNdsGroup" + "$ref" : "#/components/schemas/StreamProcessorEventTypeViewForNdsGroup" }, "groupId" : { "type" : "string", @@ -46537,10 +47815,10 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "isGlobalAdmin" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "instanceName" : { + "type" : "string", + "description" : "Name of the stream processing instance associated with the event.", + "example" : "foobar", "readOnly" : true }, "links" : { @@ -46564,113 +47842,297 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "publicKey" : { + "processorErrorMsg" : { "type" : "string", - "format" : "email", - "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "example" : "test.user@mongodb.com", + "description" : "Error message linked to the stream processor associated with the event.", + "example" : "invalid auth", + "readOnly" : true + }, + "processorName" : { + "type" : "string", + "description" : "Name of the stream processor associated with the event.", + "example" : "foobar", + "readOnly" : true + }, + "processorState" : { + "type" : "string", + "description" : "State of the stream processor associated with the event.", + "example" : "FAILED", "readOnly" : true }, "raw" : { "$ref" : "#/components/schemas/raw" + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Stream Processor Events" + }, + "StreamsClusterConnection" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/StreamsConnection" + }, { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Name of the cluster configured for this connection." + }, + "dbRoleToExecute" : { + "$ref" : "#/components/schemas/DBRoleToExecute" + } + } + } ] + }, + "StreamsConnection" : { + "type" : "object", + "description" : "Settings that define a connection to an external data store.", + "discriminator" : { + "mapping" : { + "Cluster" : "#/components/schemas/StreamsClusterConnection", + "Kafka" : "#/components/schemas/StreamsKafkaConnection", + "Sample" : "#/components/schemas/StreamsSampleConnection" }, - "remoteAddress" : { + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/StreamsSampleConnection" + }, { + "$ref" : "#/components/schemas/StreamsClusterConnection" + }, { + "$ref" : "#/components/schemas/StreamsKafkaConnection" + } ], + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { "type" : "string", - "description" : "IPv4 or IPv6 address from which the user triggered this event.", - "example" : "216.172.40.186", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "description" : "Human-readable label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source." + }, + "type" : { + "type" : "string", + "description" : "Type of the connection. Can be either Cluster or Kafka.", + "enum" : [ "Kafka", "Cluster", "Sample" ] + } + }, + "readOnly" : true + }, + "StreamsDLQ" : { + "type" : "object", + "description" : "Dead letter queue for the stream processor.", + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/reference/glossary/#std-term-dead-letter-queue" + }, + "properties" : { + "coll" : { + "type" : "string", + "description" : "Name of the collection to use for the DLQ." + }, + "connectionName" : { + "type" : "string", + "description" : "Name of the connection to write DLQ messages to. Must be an Atlas connection." + }, + "db" : { + "type" : "string", + "description" : "Name of the database to use for the DLQ." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, "readOnly" : true + } + } + }, + "StreamsDataProcessRegion" : { + "type" : "object", + "description" : "Information about the cloud provider region in which MongoDB Cloud processes the stream.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Label that identifies the cloud service provider where MongoDB Cloud performs stream processing. Currently, this parameter supports AWS only.", + "enum" : [ "AWS", "GCP", "AZURE", "TENANT", "SERVERLESS" ] }, - "teamId" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "region" : { + "$ref" : "#/components/schemas/BaseStreamsRegion" + } + }, + "required" : [ "cloudProvider", "region" ] + }, + "StreamsEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "MAX_PROCESSOR_COUNT_REACHED" ], + "example" : "MAX_PROCESSOR_COUNT_REACHED", + "title" : "Streams Event Types" + }, + "StreamsEventViewForNdsGroup" : { + "type" : "object", + "description" : "Streams event identifies different activities about Atlas Streams.", + "properties" : { + "created" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization team associated with this event.", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/StreamsEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "userId" : { + "id" : { "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.", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "username" : { + "instanceName" : { "type" : "string", - "format" : "email", - "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", - "example" : "test.user@mongodb.com", + "description" : "Name of the stream processing instance associated with the event.", + "example" : "foobar", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" } }, "required" : [ "created", "eventTypeName", "id" ], - "title" : "Team Events" + "title" : "Streams Events" }, - "TeamNotification" : { + "StreamsKafkaAuthentication" : { "type" : "object", - "description" : "Team notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "description" : "User credentials required to connect to a Kafka Cluster. Includes the authentication type, as well as the parameters for that authentication mode.", "properties" : { - "delayMin" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." - }, - "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:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" - }, - "intervalMin" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", - "minimum" : 5 - }, - "notifierId" : { - "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:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true }, - "teamId" : { + "mechanism" : { "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", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" + "description" : "Style of authentication. Can be one of PLAIN, SCRAM-256, or SCRAM-512." }, - "teamName" : { + "password" : { "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" + "format" : "password", + "description" : "Password of the account to connect to the Kafka cluster.", + "writeOnly" : true }, - "typeName" : { + "username" : { "type" : "string", - "description" : "Human-readable label that displays the alert notification type.", - "enum" : [ "TEAM" ] + "description" : "Username of the account to connect to the Kafka cluster." } - }, - "required" : [ "typeName" ], - "title" : "Team Notification" + } }, - "TeamResponse" : { + "StreamsKafkaConnection" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/StreamsConnection" + }, { + "type" : "object", + "properties" : { + "authentication" : { + "$ref" : "#/components/schemas/StreamsKafkaAuthentication" + }, + "bootstrapServers" : { + "type" : "string", + "description" : "Comma separated list of server addresses." + }, + "config" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.", + "example" : "{\"group.protocol.type\":\"consumer\",\"debug\":\"queue, msg, protocol\"}" + }, + "description" : "A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.", + "example" : { + "debug" : "queue, msg, protocol", + "group.protocol.type" : "consumer" + } + }, + "networking" : { + "$ref" : "#/components/schemas/StreamsKafkaNetworking" + }, + "security" : { + "$ref" : "#/components/schemas/StreamsKafkaSecurity" + } + } + } ] + }, + "StreamsKafkaNetworking" : { "type" : "object", + "description" : "Networking Access Type can either be 'PUBLIC' (default) or VPC. VPC type is in public preview, please file a support ticket to enable VPC Network Access", "properties" : { - "id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies this team.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "access" : { + "$ref" : "#/components/schemas/StreamsKafkaNetworkingAccess" }, "links" : { "type" : "array", @@ -46683,16 +48145,21 @@ "$ref" : "#/components/schemas/Link" }, "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "Human-readable label that identifies the team." } } }, - "TeamRole" : { + "StreamsKafkaNetworkingAccess" : { "type" : "object", + "description" : "Information about the networking access.", "properties" : { + "connectionId" : { + "type" : "string", + "description" : "Reserved. Will be used by PRIVATE_LINK connection type.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, "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.", @@ -46705,28 +48172,26 @@ }, "readOnly" : true }, - "roleNames" : { - "type" : "array", - "description" : "One or more organization- or project-level roles to assign to the MongoDB Cloud user.", - "items" : { - "type" : "string", - "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] - }, - "uniqueItems" : true + "name" : { + "type" : "string", + "description" : "Reserved. Will be used by PRIVATE_LINK connection type." }, - "teamId" : { + "type" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the team.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" + "description" : "Selected networking type. Either PUBLIC, VPC or PRIVATE_LINK. Defaults to PUBLIC. For VPC, ensure that VPC peering exists and connectivity has been established between Atlas VPC and the VPC where Kafka cluster is hosted for the connection to function properly. PRIVATE_LINK support is coming soon.", + "enum" : [ "PUBLIC", "VPC", "PRIVATE_LINK" ], + "title" : "Networking Access Type" } } }, - "TeamUpdate" : { + "StreamsKafkaSecurity" : { "type" : "object", + "description" : "Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use.", "properties" : { + "brokerPublicCertificate" : { + "type" : "string", + "description" : "A trusted, public x509 certificate for connecting to Kafka over SSL." + }, "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.", @@ -46739,108 +48204,83 @@ }, "readOnly" : true }, - "name" : { - "type" : "string", - "description" : "Human-readable label that identifies the team.", - "writeOnly" : true - } - }, - "required" : [ "name" ] - }, - "TenantHardwareSpec" : { - "type" : "object", - "properties" : { - "instanceSize" : { + "protocol" : { "type" : "string", - "description" : "Hardware specification for the instances in this M0/M2/M5 tier cluster.", - "enum" : [ "M0", "M2", "M5" ], - "title" : "Tenant Instance Sizes" + "description" : "Describes the transport type. Can be either PLAINTEXT or SSL." } } }, - "TenantHardwareSpec20240805" : { + "StreamsMatcher" : { "type" : "object", + "description" : "Rules to apply when comparing a stream processing instance or stream processor against this alert configuration.", "properties" : { - "diskSizeGB" : { - "type" : "number", - "format" : "double", - "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", - "maximum" : 4096, - "minimum" : 10 + "fieldName" : { + "$ref" : "#/components/schemas/StreamsMatcherField" }, - "instanceSize" : { + "operator" : { "type" : "string", - "description" : "Hardware specification for the instances in this M0/M2/M5 tier cluster.", - "enum" : [ "M0", "M2", "M5" ], - "title" : "Tenant Instance Sizes" + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" } - } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" }, - "TenantRegionConfig" : { - "type" : "object", - "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`.", - "enum" : [ "AWS", "GCP", "AZURE" ] - } - } - } ], - "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", - "title" : "Tenant Regional Replication Specifications" + "StreamsMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "INSTANCE_NAME", "PROCESSOR_NAME" ], + "example" : "INSTANCE_NAME", + "title" : "Streams Matcher Fields" }, - "TenantRegionConfig20240805" : { + "StreamsOptions" : { "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/CloudRegionConfig20240805" - }, { - "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`.", - "enum" : [ "AWS", "GCP", "AZURE" ] - } + "description" : "Optional configuration for the stream processor.", + "properties" : { + "dlq" : { + "$ref" : "#/components/schemas/StreamsDLQ" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true } - } ], - "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", - "title" : "Tenant Regional Replication Specifications" + } }, - "TenantRestore" : { + "StreamsPrivateLinkConnection" : { "type" : "object", + "description" : "Container for metadata needed to create a Private Link connection.", "properties" : { - "clusterName" : { + "_id" : { "type" : "string", - "description" : "Human-readable label that identifies the source cluster.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "readOnly" : true + "description" : "The ID of the Private Link connection." }, - "deliveryType" : { + "dnsDomain" : { "type" : "string", - "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", - "enum" : [ "RESTORE", "DOWNLOAD" ], - "readOnly" : true + "description" : "Domain name of Confluent cluster." }, - "expirationDate" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "dnsSubDomain" : { + "type" : "array", + "description" : "Sub-Domain name of Confluent cluster. These are typically your availability zones.", + "items" : { + "type" : "string" + } }, - "id" : { + "interfaceEndpointId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "description" : "Interface endpoint ID that is created from the service endpoint ID provided." }, "links" : { "type" : "array", @@ -46854,354 +48294,451 @@ }, "readOnly" : true }, - "projectId" : { + "provider" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "description" : "Provider where the Kafka cluster is deployed." }, - "restoreFinishedDate" : { + "region" : { "type" : "string", - "format" : "date-time", - "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.", - "readOnly" : true + "description" : "Domain name of Confluent cluster." }, - "restoreScheduledDate" : { + "serviceEndpointId" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "description" : "AWS Service Endpoint ID." }, - "snapshotFinishedDate" : { + "state" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "description" : "State the connection is in." }, - "snapshotId" : { + "vendor" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "description" : "Vendor who manages the Kafka cluster." + } + } + }, + "StreamsProcessor" : { + "type" : "object", + "description" : "An atlas stream processor.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the stream processor.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" - }, - "snapshotUrl" : { - "type" : "string", - "description" : "Internet address from which you can download the compressed snapshot files. The resource returns this parameter when `\"deliveryType\" : \"DOWNLOAD\"`.", + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "status" : { - "type" : "string", - "description" : "Phase of the restore workflow for this job at the time this resource made this request.", - "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, "readOnly" : true }, - "targetDeploymentItemName" : { + "name" : { "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.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + "description" : "Human-readable name of the stream processor." }, - "targetProjectId" : { - "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", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" + "options" : { + "$ref" : "#/components/schemas/StreamsOptions" + }, + "pipeline" : { + "type" : "array", + "description" : "Stream aggregation pipeline you want to apply to your streaming data.", + "externalDocs" : { + "description" : "Supported Aggregation Pipeline Stages", + "url" : "https://www.mongodb.com/docs/atlas/atlas-stream-processing/stream-aggregation/#std-label-stream-aggregation" + }, + "items" : { + "$ref" : "#/components/schemas/Document" + } } - }, - "required" : [ "snapshotId", "targetDeploymentItemName" ] + } }, - "TextSearchHostStatusDetail" : { + "StreamsProcessorWithStats" : { "type" : "object", + "description" : "An atlas stream processor with optional stats.", "properties" : { - "hostname" : { + "_id" : { "type" : "string", - "description" : "Hostname that corresponds to the status detail." + "description" : "Unique 24-hexadecimal character string that identifies the stream processor.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "mainIndex" : { - "$ref" : "#/components/schemas/TextSearchIndexStatusDetail" + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true }, - "queryable" : { - "type" : "boolean", - "description" : "Flag that indicates whether the index is queryable on the host." + "name" : { + "type" : "string", + "description" : "Human-readable name of the stream processor.", + "readOnly" : true }, - "stagedIndex" : { - "$ref" : "#/components/schemas/TextSearchIndexStatusDetail" + "options" : { + "$ref" : "#/components/schemas/StreamsOptions" }, - "status" : { + "pipeline" : { + "type" : "array", + "description" : "Stream aggregation pipeline you want to apply to your streaming data.", + "items" : { + "$ref" : "#/components/schemas/Document" + }, + "readOnly" : true + }, + "state" : { "type" : "string", - "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", - "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + "description" : "The state of the stream processor. Commonly occurring states are 'CREATED', 'STARTED', 'STOPPED' and 'FAILED'.", + "readOnly" : true + }, + "stats" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "The stats associated with the stream processor.", + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor" + }, + "readOnly" : true + }, + "description" : "The stats associated with the stream processor.", + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor" + }, + "readOnly" : true } }, - "title" : "Text Search Host Status Detail" + "required" : [ "_id", "name", "pipeline", "state" ] }, - "TextSearchIndexCreateRequest" : { + "StreamsSampleConnection" : { "type" : "object", "allOf" : [ { - "$ref" : "#/components/schemas/SearchIndexCreateRequest" - }, { - "type" : "object", - "properties" : { - "definition" : { - "$ref" : "#/components/schemas/TextSearchIndexDefinition" - } + "$ref" : "#/components/schemas/StreamsConnection" + } ] + }, + "StreamsSampleConnections" : { + "type" : "object", + "description" : "Sample connections to add to SPI.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "solar" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to add a 'sample_stream_solar' connection." } - } ], - "description" : "Text Search Index Create Request", - "required" : [ "collectionName", "database", "definition", "name" ] + } }, - "TextSearchIndexDefinition" : { + "StreamsTenant" : { "type" : "object", - "description" : "The text search index definition set by the user.", "properties" : { - "analyzer" : { + "_id" : { "type" : "string", - "default" : "lucene.standard", - "description" : "Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves making the following changes to the text in fields:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\n MongoDB Cloud uses the process you select to build the Atlas Search index.", - "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ], - "externalDocs" : { - "description" : "Atlas Search Analyzers", - "url" : "https://dochub.mongodb.org/core/analyzers--fts" - } + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "analyzers" : { + "connections" : { "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" - }, + "description" : "List of connections configured in the stream instance.", "items" : { - "$ref" : "#/components/schemas/AtlasSearchAnalyzer" - } + "$ref" : "#/components/schemas/StreamsConnection" + }, + "readOnly" : true }, - "mappings" : { - "$ref" : "#/components/schemas/SearchMappings" + "dataProcessRegion" : { + "$ref" : "#/components/schemas/StreamsDataProcessRegion" }, - "searchAnalyzer" : { + "groupId" : { "type" : "string", - "default" : "lucene.standard", - "description" : "Method applied to identify words when searching this index.", - "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "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 Stored Source Fields.", - "example" : { - "include | exclude" : [ "field1", "field2" ] + "hostnames" : { + "type" : "array", + "description" : "List that contains the hostnames assigned to the stream instance.", + "items" : { + "type" : "string", + "description" : "Unique hostname assigned to the stream instance.", + "readOnly" : true }, - "externalDocs" : { - "description" : "Stored Source Fields", - "url" : "https://dochub.mongodb.org/core/atlas-search-stored-source" - } + "readOnly" : true }, - "synonyms" : { + "links" : { "type" : "array", - "description" : "Rule sets that map words to their synonyms in this index.", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", "externalDocs" : { - "description" : "Synonym Mapping", - "url" : "https://dochub.mongodb.org/core/fts-synonym-mappings" + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" }, "items" : { - "$ref" : "#/components/schemas/SearchSynonymMappingDefinition" - } - } - }, - "required" : [ "mappings" ], - "title" : "Text Search Index Definition" - }, - "TextSearchIndexResponse" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/SearchIndexResponse" - }, { - "type" : "object", - "properties" : { - "latestDefinition" : { - "$ref" : "#/components/schemas/TextSearchIndexDefinition" - }, - "statusDetail" : { - "type" : "array", - "description" : "List of documents detailing index status on each host.", - "items" : { - "$ref" : "#/components/schemas/TextSearchHostStatusDetail" - } - }, - "synonymMappingStatus" : { - "type" : "string", - "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", - "enum" : [ "FAILED", "BUILDING", "READY" ] - }, - "synonymMappingStatusDetail" : { - "type" : "array", - "description" : "A list of documents describing the status of the index's synonym mappings on each search host. Only appears if the index has synonyms defined.", - "items" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/SynonymMappingStatusDetail" - } - } - } + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the stream instance." + }, + "sampleConnections" : { + "$ref" : "#/components/schemas/StreamsSampleConnections" + }, + "streamConfig" : { + "$ref" : "#/components/schemas/StreamConfig" } - } ], - "title" : "Text Search Index Response" + } }, - "TextSearchIndexStatusDetail" : { + "SummaryNotification" : { "type" : "object", - "description" : "Contains status information about a text search index.", + "description" : "Summary notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", "properties" : { - "definition" : { - "$ref" : "#/components/schemas/TextSearchIndexDefinition" + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." }, - "definitionVersion" : { - "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + "emailAddress" : { + "type" : "string", + "format" : "email", + "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:\n\n- specific MongoDB Cloud users (`\"notifications.[n].typeName\" : \"USER\"`)\n- MongoDB Cloud users with specific project roles (`\"notifications.[n].typeName\" : \"GROUP\"`)\n- MongoDB Cloud users with specific organization roles (`\"notifications.[n].typeName\" : \"ORG\"`)\n- MongoDB Cloud teams (`\"notifications.[n].typeName\" : \"TEAM\"`)\n\nTo send emails to one MongoDB Cloud user or grouping of users, set the **notifications.[n].emailEnabled** parameter." + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "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" ] + } + }, + "required" : [ "typeName" ], + "title" : "Summary Notification" + }, + "SynonymMappingStatusDetail" : { + "type" : "object", + "description" : "Contains the status of the index's synonym mappings on each search host. This field (and its subfields) only appear if the index has synonyms defined.", + "properties" : { "message" : { "type" : "string", "description" : "Optional message describing an error." }, "queryable" : { "type" : "boolean", - "description" : "Flag that indicates whether the index generation is queryable on the host." + "description" : "Flag that indicates whether the synonym mapping is queryable on a host." }, "status" : { - "type" : "string", - "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", - "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] - }, - "synonymMappingStatus" : { "type" : "string", "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", "enum" : [ "FAILED", "BUILDING", "READY" ] - }, - "synonymMappingStatusDetail" : { - "type" : "array", - "description" : "List of synonym statuses by mapping.", - "items" : { - "$ref" : "#/components/schemas/SynonymMappingStatusDetailMap" - } } }, - "title" : "Text Search Index Status Detail" + "title" : "Synonym Mapping Status Detail" }, - "ThirdPartyIntegration" : { + "SynonymMappingStatusDetailMap" : { "type" : "object", - "description" : "Collection of settings that describe third-party integrations.", - "discriminator" : { - "mapping" : { - "DATADOG" : "#/components/schemas/Datadog", - "MICROSOFT_TEAMS" : "#/components/schemas/MicrosoftTeams", - "NEW_RELIC" : "#/components/schemas/NewRelic", - "OPS_GENIE" : "#/components/schemas/OpsGenie", - "PAGER_DUTY" : "#/components/schemas/PagerDuty", - "PROMETHEUS" : "#/components/schemas/Prometheus", - "SLACK" : "#/components/schemas/Slack", - "VICTOR_OPS" : "#/components/schemas/VictorOps", - "WEBHOOK" : "#/components/schemas/Webhook" - }, - "propertyName" : "type" + "additionalProperties" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetail" }, + "x-additionalPropertiesName" : "Synonym Mapping Name" + }, + "SynonymSource" : { + "type" : "object", + "description" : "Data set that stores words and their applicable synonyms.", "properties" : { - "id" : { - "type" : "string", - "description" : "Integration id.", - "nullable" : true - }, - "type" : { + "collection" : { "type" : "string", - "description" : "Integration type", - "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], - "title" : "Integration Type" + "description" : "Label that identifies the MongoDB collection that stores words and their applicable synonyms." } }, - "title" : "Third-Party Integration" + "required" : [ "collection" ] }, - "TimeMetricAlertView" : { + "SystemStatus" : { "type" : "object", "properties" : { - "acknowledgedUntil" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + "apiKey" : { + "$ref" : "#/components/schemas/ApiKey" }, - "acknowledgementComment" : { + "appName" : { "type" : "string", - "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", - "example" : "Expiration on 3/19. Silencing for 7days.", - "maxLength" : 200 + "description" : "Human-readable label that identifies the service from which you requested this response.", + "enum" : [ "MongoDB Atlas" ], + "readOnly" : true }, - "acknowledgingUsername" : { + "build" : { "type" : "string", - "format" : "email", - "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "description" : "Unique 40-hexadecimal digit hash that identifies the latest git commit merged for this application.", + "example" : "83be55e140f493c88e7f578aae96548dd881587b", "readOnly" : true }, - "alertConfigId" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "throttling" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled throttling on this service.", + "readOnly" : true + } + }, + "required" : [ "apiKey", "appName", "build", "throttling" ] + }, + "TargetOrg" : { + "type" : "object", + "properties" : { + "linkToken" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "description" : "Link token that contains all the information required to complete the link." + } + }, + "required" : [ "linkToken" ] + }, + "TargetOrgRequest" : { + "type" : "object", + "properties" : { + "accessListIps" : { + "type" : "array", + "description" : "IP address access list entries associated with the API key.", + "items" : { + "type" : "string", + "description" : "One IP address access list entry associated with the API key." + } + } + } + }, + "Team" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this team.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "clusterName" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { "type" : "string", - "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", - "example" : "cluster1", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "description" : "Human-readable label that identifies the team." + }, + "usernames" : { + "type" : "array", + "description" : "List that contains the MongoDB Cloud users in this team.", + "items" : { + "type" : "string", + "format" : "email", + "description" : "List that contains email addresses that identify MongoDB Cloud users to in this team." + }, + "uniqueItems" : true + } + }, + "required" : [ "name" ] + }, + "TeamEvent" : { + "type" : "object", + "description" : "Team event identifies different activities around organization teams.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, "created" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "currentValue" : { - "$ref" : "#/components/schemas/TimeMetricValueView" - }, "eventTypeName" : { - "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + "$ref" : "#/components/schemas/TeamEventTypeView" }, "groupId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "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.", - "example" : "cloud-test.mongodb.com:27017", - "readOnly" : true - }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "lastNotified" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", "readOnly" : true }, "links" : { @@ -47216,51 +48753,78 @@ }, "readOnly" : true }, - "metricName" : { - "type" : "string", - "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", - "example" : "ASSERT_USER", - "readOnly" : true - }, "orgId" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "replicaSetName" : { + "publicKey" : { "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.", - "example" : "event-replica-set", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true }, - "resolved" : { + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { "type" : "string", - "format" : "date-time", - "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\"`.", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", "readOnly" : true }, - "status" : { + "teamId" : { "type" : "string", - "description" : "State of this alert at the time you requested its details.", - "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], - "example" : "OPEN", + "description" : "Unique 24-hexadecimal digit string that identifies the organization team associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "updated" : { + "userId" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true } }, - "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Team Events" }, - "TimeMetricEventView" : { + "TeamEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TEAM_CREATED", "TEAM_DELETED", "TEAM_UPDATED", "TEAM_NAME_CHANGED", "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "example" : "TEAM_ADDED_TO_GROUP", + "title" : "Team Event Types" + }, + "TeamEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "example" : "TEAM_ADDED_TO_GROUP", + "title" : "Team Event Types" + }, + "TeamEventViewForNdsGroup" : { "type" : "object", + "description" : "Team event identifies different activities around organization teams.", "properties" : { "apiKeyId" : { "type" : "string", @@ -47277,11 +48841,8 @@ "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "currentValue" : { - "$ref" : "#/components/schemas/TimeMetricValueView" - }, "eventTypeName" : { - "$ref" : "#/components/schemas/HostMetricEventTypeView" + "$ref" : "#/components/schemas/TeamEventTypeViewForNdsGroup" }, "groupId" : { "type" : "string", @@ -47319,11 +48880,6 @@ }, "readOnly" : true }, - "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" : { "type" : "string", "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", @@ -47333,13 +48889,6 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "port" : { - "type" : "integer", - "format" : "int32", - "description" : "IANA port on which the MongoDB process listens for requests.", - "example" : 27017, - "readOnly" : true - }, "publicKey" : { "type" : "string", "format" : "email", @@ -47357,16 +48906,13 @@ "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", "readOnly" : true }, - "replicaSetName" : { - "type" : "string", - "description" : "Human-readable label of the replica set associated with the event.", - "example" : "event-replica-set", - "readOnly" : true - }, - "shardName" : { + "teamId" : { "type" : "string", - "description" : "Human-readable label of the shard associated with the event.", - "example" : "event-sh-01", + "description" : "Unique 24-hexadecimal digit string that identifies the organization team associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, "userId" : { @@ -47386,250 +48932,220 @@ "readOnly" : true } }, - "required" : [ "created", "eventTypeName", "id" ] + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Team Events" }, - "TimeMetricThresholdView" : { + "TeamNotification" : { "type" : "object", + "description" : "Team notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", "properties" : { - "metricName" : { - "type" : "string", - "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." }, - "mode" : { + "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:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { "type" : "string", - "description" : "MongoDB Cloud computes the current metric value as an average.", - "enum" : [ "AVERAGE" ] + "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" }, - "operator" : { - "$ref" : "#/components/schemas/Operator" + "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:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" }, - "threshold" : { - "type" : "number", - "format" : "double", - "description" : "Value of metric that, when exceeded, triggers an alert." + "teamId" : { + "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", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" }, - "units" : { - "$ref" : "#/components/schemas/TimeMetricUnits" - } - }, - "required" : [ "metricName" ] - }, - "TimeMetricUnits" : { - "type" : "string", - "default" : "HOURS", - "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", - "enum" : [ "NANOSECONDS", "MILLISECONDS", "MILLION_MINUTES", "SECONDS", "MINUTES", "HOURS", "DAYS" ], - "title" : "Time Metric Units" - }, - "TimeMetricValueView" : { - "type" : "object", - "description" : "Measurement of the **metricName** recorded at the time of the event.", - "properties" : { - "number" : { - "type" : "number", - "format" : "double", - "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", - "readOnly" : true + "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" }, - "units" : { - "$ref" : "#/components/schemas/TimeMetricUnits" - } - }, - "readOnly" : true, - "title" : "Time Metric Value" - }, - "TokenFilterEnglishPossessive" : { - "type" : "object", - "description" : "Filter that removes possessives (trailing 's) from words.", - "properties" : { - "type" : { + "typeName" : { "type" : "string", - "description" : "Human-readable label that identifies this token filter type.", - "enum" : [ "englishPossessive" ] + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "TEAM" ] } }, - "required" : [ "type" ], - "title" : "englishPossessive" + "required" : [ "typeName" ], + "title" : "Team Notification" }, - "TokenFilterFlattenGraph" : { + "TeamResponse" : { "type" : "object", - "description" : "Filter that transforms a token filter graph, such as the token filter graph that the wordDelimiterGraph token filter produces, into a flat form suitable for indexing.", "properties" : { - "type" : { + "id" : { "type" : "string", - "description" : "Human-readable label that identifies this token filter type.", - "enum" : [ "flattenGraph" ] + "description" : "Unique 24-hexadecimal digit string that identifies this team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the team." } - }, - "required" : [ "type" ], - "title" : "flattenGraph" + } }, - "TokenFilterPorterStemming" : { + "TeamRole" : { "type" : "object", - "description" : "Filter that uses the porter stemming algorithm to remove the common morphological and inflectional suffixes from words in English. It expects lowercase text and doesn't work as expected for uppercase text.", "properties" : { - "type" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "roleNames" : { + "type" : "array", + "description" : "One or more organization- or project-level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "teamId" : { "type" : "string", - "description" : "Human-readable label that identifies this token filter type.", - "enum" : [ "porterStemming" ] + "description" : "Unique 24-hexadecimal character string that identifies the team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" } - }, - "required" : [ "type" ], - "title" : "porterStemming" + } }, - "TokenFilterSpanishPluralStemming" : { + "TeamUpdate" : { "type" : "object", - "description" : "Filter that stems Spanish plural words. It expects lowercase text.", "properties" : { - "type" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { "type" : "string", - "description" : "Human-readable label that identifies this token filter type.", - "enum" : [ "spanishPluralStemming" ] + "description" : "Human-readable label that identifies the team.", + "writeOnly" : true } }, - "required" : [ "type" ], - "title" : "spanishPluralStemming" + "required" : [ "name" ] }, - "TokenFilterStempel" : { + "TenantHardwareSpec" : { "type" : "object", - "description" : "Filter that uses Lucene's default Polish stemmer table to stem words in the Polish language. It expects lowercase text.", - "externalDocs" : { - "description" : "Default Polish stemmer table", - "url" : "https://lucene.apache.org/core/9_2_0/analysis/stempel/org/apache/lucene/analysis/pl/PolishAnalyzer.html#DEFAULT_STEMMER_FILE" - }, "properties" : { - "type" : { + "instanceSize" : { "type" : "string", - "description" : "Human-readable label that identifies this token filter type.", - "enum" : [ "stempel" ] + "description" : "Hardware specification for the instances in this M0/M2/M5 tier cluster.", + "enum" : [ "M0", "M2", "M5" ], + "title" : "Tenant Instance Sizes" } - }, - "required" : [ "type" ], - "title" : "stempel" + } }, - "TokenFilterWordDelimiterGraph" : { + "TenantHardwareSpec20240805" : { "type" : "object", - "description" : "Filter that splits tokens into sub-tokens based on configured rules.", "properties" : { - "delimiterOptions" : { - "type" : "object", - "description" : "Object that contains the rules that determine how to split words into sub-words.", - "properties" : { - "concatenateAll" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether to concatenate runs." - }, - "concatenateNumbers" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether to concatenate runs of sub-numbers." - }, - "concatenateWords" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether to concatenate runs of sub-words." - }, - "generateNumberParts" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether to split tokens based on sub-numbers. For example, if `true`, this option splits `100-2` into `100` and `2`." - }, - "generateWordParts" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether to split tokens based on sub-words." - }, - "ignoreKeywords" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether to skip tokens with the `keyword` attribute set to `true`" - }, - "preserveOriginal" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether to generate tokens of the original words." - }, - "splitOnCaseChange" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether to split tokens based on letter-case transitions." - }, - "splitOnNumerics" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether to split tokens based on letter-number transitions." - }, - "stemEnglishPossessive" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether to remove trailing possessives from each sub-word." - } - } - }, - "protectedWords" : { - "type" : "object", - "description" : "Object that contains options for protected words.", - "properties" : { - "ignoreCase" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether to ignore letter case sensitivity for protected words." - }, - "words" : { - "type" : "array", - "description" : "List that contains the tokens to protect from delimination.", - "items" : { - "type" : "string" - } - } - }, - "required" : [ "words" ] + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 }, - "type" : { + "instanceSize" : { "type" : "string", - "description" : "Human-readable label that identifies this token filter type.", - "enum" : [ "wordDelimiterGraph" ] + "description" : "Hardware specification for the instances in this M0/M2/M5 tier cluster.", + "enum" : [ "M0", "M2", "M5" ], + "title" : "Tenant Instance Sizes" } - }, - "required" : [ "type" ], - "title" : "wordDelimiterGraph" + } }, - "TokenFilterkStemming" : { + "TenantRegionConfig" : { "type" : "object", - "description" : "Filter that combines algorithmic stemming with a built-in dictionary for the English language to stem words.", - "properties" : { - "type" : { - "type" : "string", - "description" : "Human-readable label that identifies this token filter type.", - "enum" : [ "kStemming" ] + "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`.", + "enum" : [ "AWS", "GCP", "AZURE" ] + } } - }, - "required" : [ "type" ], - "title" : "kStemming" + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Tenant Regional Replication Specifications" }, - "TriggerIngestionPipelineRequest" : { + "TenantRegionConfig20240805" : { "type" : "object", - "properties" : { - "datasetRetentionPolicy" : { - "$ref" : "#/components/schemas/DatasetRetentionPolicy" - }, - "snapshotId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "writeOnly" : true + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20240805" + }, { + "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`.", + "enum" : [ "AWS", "GCP", "AZURE" ] + } } - }, - "required" : [ "snapshotId" ] + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Tenant Regional Replication Specifications" }, - "USSBackupRestoreJob20250101" : { + "TenantRestore" : { "type" : "object", - "description" : "Details for one restore job of a USS instance.", "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the source cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "readOnly" : true + }, "deliveryType" : { "type" : "string", "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", @@ -47651,14 +49167,6 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "instanceName" : { - "type" : "string", - "description" : "Human-readable label that identifies the source instance.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "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.", @@ -47704,8 +49212,7 @@ "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "pattern" : "^([a-f0-9]{24})$" }, "snapshotUrl" : { "type" : "string", @@ -47720,176 +49227,311 @@ }, "targetDeploymentItemName" : { "type" : "string", - "description" : "Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another USS instance or Dedicated cluster tier.", + "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.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", - "readOnly" : true + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" }, "targetProjectId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the cluster to which you want to restore the snapshot.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "pattern" : "^([a-f0-9]{24})$" } }, - "title" : "USS Backup Restore Job" + "required" : [ "snapshotId", "targetDeploymentItemName" ] + }, + "TenantWithSampleConnections" : { + "type" : "object" }, - "USSBackupRestoreJobCreate20250101" : { + "TextSearchHostStatusDetail" : { "type" : "object", - "description" : "Details to create one restore job of a USS instance.", "properties" : { - "_snapshotId" : { + "hostname" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "writeOnly" : true + "description" : "Hostname that corresponds to the status detail." }, - "_targetDeploymentItemName" : { - "type" : "string", - "description" : "Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another USS instance or Dedicated cluster tier.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", - "writeOnly" : true + "mainIndex" : { + "$ref" : "#/components/schemas/TextSearchIndexStatusDetail" }, - "_targetProjectId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "writeOnly" : true + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on the host." }, - "deliveryType" : { - "type" : "string", - "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", - "enum" : [ "RESTORE", "DOWNLOAD" ], - "readOnly" : true + "stagedIndex" : { + "$ref" : "#/components/schemas/TextSearchIndexStatusDetail" }, - "expirationDate" : { + "status" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true - }, - "id" : { + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Text Search Host Status Detail" + }, + "TextSearchIndexCreateRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexCreateRequest" + }, { + "type" : "object", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + } + } + } ], + "description" : "Text Search Index Create Request", + "required" : [ "collectionName", "database", "definition", "name" ] + }, + "TextSearchIndexDefinition" : { + "type" : "object", + "description" : "The text search index definition set by the user.", + "properties" : { + "analyzer" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "default" : "lucene.standard", + "description" : "Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves making the following changes to the text in fields:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\n MongoDB Cloud uses the process you select to build the Atlas Search index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ], + "externalDocs" : { + "description" : "Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/analyzers--fts" + } }, - "instanceName" : { + "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" + }, + "items" : { + "$ref" : "#/components/schemas/AtlasSearchAnalyzer" + } + }, + "mappings" : { + "$ref" : "#/components/schemas/SearchMappings" + }, + "searchAnalyzer" : { "type" : "string", - "description" : "Human-readable label that identifies the source instance.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "readOnly" : true + "default" : "lucene.standard", + "description" : "Method applied to identify words when searching this index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] }, - "links" : { + "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 Stored Source Fields.", + "example" : { + "include | exclude" : [ "field1", "field2" ] + }, + "externalDocs" : { + "description" : "Stored Source Fields", + "url" : "https://dochub.mongodb.org/core/atlas-search-stored-source" + } + }, + "synonyms" : { "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.", + "description" : "Rule sets that map words to their synonyms in this index.", "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + "description" : "Synonym Mapping", + "url" : "https://dochub.mongodb.org/core/fts-synonym-mappings" }, "items" : { - "$ref" : "#/components/schemas/Link" + "$ref" : "#/components/schemas/SearchSynonymMappingDefinition" + } + } + }, + "required" : [ "mappings" ], + "title" : "Text Search Index Definition" + }, + "TextSearchIndexResponse" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexResponse" + }, { + "type" : "object", + "properties" : { + "latestDefinition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" }, - "readOnly" : true + "statusDetail" : { + "type" : "array", + "description" : "List of documents detailing index status on each host.", + "items" : { + "$ref" : "#/components/schemas/TextSearchHostStatusDetail" + } + }, + "synonymMappingStatus" : { + "type" : "string", + "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", + "enum" : [ "FAILED", "BUILDING", "READY" ] + }, + "synonymMappingStatusDetail" : { + "type" : "array", + "description" : "A list of documents describing the status of the index's synonym mappings on each search host. Only appears if the index has synonyms defined.", + "items" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetail" + } + } + } + } + } ], + "title" : "Text Search Index Response" + }, + "TextSearchIndexStatusDetail" : { + "type" : "object", + "description" : "Contains status information about a text search index.", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" }, - "projectId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" }, - "restoreFinishedDate" : { + "message" : { "type" : "string", - "format" : "date-time", - "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.", - "readOnly" : true + "description" : "Optional message describing an error." }, - "restoreScheduledDate" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index generation is queryable on the host." }, - "snapshotFinishedDate" : { + "status" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] }, - "snapshotUrl" : { + "synonymMappingStatus" : { "type" : "string", - "description" : "Internet address from which you can download the compressed snapshot files. The resource returns this parameter when `\"deliveryType\" : \"DOWNLOAD\"`.", - "readOnly" : true + "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", + "enum" : [ "FAILED", "BUILDING", "READY" ] }, - "status" : { - "type" : "string", - "description" : "Phase of the restore workflow for this job at the time this resource made this request.", - "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], - "readOnly" : true + "synonymMappingStatusDetail" : { + "type" : "array", + "description" : "List of synonym statuses by mapping.", + "items" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetailMap" + } } }, - "required" : [ "_snapshotId", "_targetDeploymentItemName" ], - "title" : "Create USS Backup Restore Job" + "title" : "Text Search Index Status Detail" }, - "USSBackupSettings20250101" : { + "ThirdPartyIntegration" : { "type" : "object", - "description" : "USS backup configuration", + "description" : "Collection of settings that describe third-party integrations.", + "discriminator" : { + "mapping" : { + "DATADOG" : "#/components/schemas/Datadog", + "MICROSOFT_TEAMS" : "#/components/schemas/MicrosoftTeams", + "NEW_RELIC" : "#/components/schemas/NewRelic", + "OPS_GENIE" : "#/components/schemas/OpsGenie", + "PAGER_DUTY" : "#/components/schemas/PagerDuty", + "PROMETHEUS" : "#/components/schemas/Prometheus", + "SLACK" : "#/components/schemas/Slack", + "VICTOR_OPS" : "#/components/schemas/VictorOps", + "WEBHOOK" : "#/components/schemas/Webhook" + }, + "propertyName" : "type" + }, "properties" : { - "enabled" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether backups are performed for this USS instance. Backup uses [TODO](TODO) for USS instances.", - "readOnly" : true + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "type" : { + "type" : "string", + "description" : "Integration type", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" } }, - "readOnly" : true, - "title" : "USS backup configuration" + "title" : "Third-Party Integration" }, - "USSBackupSnapshot20250101" : { + "TimeMetricAlertView" : { "type" : "object", - "description" : "Details for one snapshot of a USS instance.", "properties" : { - "expiration" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "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.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "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.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "readOnly" : true + }, + "created" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "finishTime" : { + "currentValue" : { + "$ref" : "#/components/schemas/TimeMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "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.", + "example" : "cloud-test.mongodb.com:27017", "readOnly" : true }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, "links" : { "type" : "array", "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", @@ -47902,116 +49544,76 @@ }, "readOnly" : true }, - "mongoDBVersion" : { + "metricName" : { "type" : "string", - "description" : "MongoDB host version that the snapshot runs.", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", "readOnly" : true }, - "scheduledTime" : { + "orgId" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud will take the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "startTime" : { + "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.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when MongoDB Cloud began taking the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "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\"`.", "readOnly" : true }, "status" : { "type" : "string", - "description" : "Phase of the workflow for this snapshot at the time this resource made this request.", - "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true } }, - "title" : "USS Backup Snapshot" + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] }, - "USSBackupSnapshotDownloadCreate20250101" : { + "TimeMetricEventView" : { "type" : "object", - "description" : "Details for one backup snapshot download of a USS instance.", "properties" : { - "_snapshotId" : { + "apiKeyId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to download.", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", - "writeOnly" : true - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - } - }, - "required" : [ "_snapshotId" ], - "title" : "USS Backup Snapshot Download Create" - }, - "USSConnectionStrings20250101" : { - "type" : "object", - "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", - "externalDocs" : { - "description" : "Connection string URI format.", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, - "properties" : { - "standard" : { - "type" : "string", - "description" : "Public connection string that you can use to connect to this cluster. This connection string uses the mongodb:// protocol.", - "externalDocs" : { - "description" : "Connection String URI Format", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, - "readOnly" : true - }, - "standardSrv" : { - "type" : "string", - "description" : "Public connection string that you can use to connect to this USS instance. This connection string uses the `mongodb+srv://` protocol.", - "externalDocs" : { - "description" : "Connection String URI Format", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, "readOnly" : true - } - }, - "readOnly" : true, - "title" : "USS Instance Connection Strings" - }, - "USSInstanceDescription20250101" : { - "type" : "object", - "description" : "Group of settings that configure a MongoDB USS instance.", - "properties" : { - "backupSettings" : { - "$ref" : "#/components/schemas/USSBackupSettings20250101" }, - "clusterType" : { + "created" : { "type" : "string", - "description" : "USS instance topology.", - "enum" : [ "REPLICASET", "LOADBALANCED" ], + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "connectionStrings" : { - "$ref" : "#/components/schemas/USSConnectionStrings20250101" + "currentValue" : { + "$ref" : "#/components/schemas/TimeMetricValueView" }, - "createDate" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created this instance. This parameter expresses its value in ISO 8601 format in UTC.", - "readOnly" : true + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" }, "groupId" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the project.", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -48020,13 +49622,19 @@ }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the instance.", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, "links" : { "type" : "array", "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", @@ -48039,167 +49647,314 @@ }, "readOnly" : true }, - "mongoDBVersion" : { + "metricName" : { "type" : "string", - "description" : "Version of MongoDB that the instance runs.", - "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", "readOnly" : true }, - "name" : { + "orgId" : { "type" : "string", - "description" : "Human-readable label that identifies the instance.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "providerSettings" : { - "$ref" : "#/components/schemas/USSProviderSettings20250101" + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true }, - "stateName" : { + "publicKey" : { "type" : "string", - "description" : "Human-readable label that indicates the current operating condition of this instance.", - "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true }, - "tags" : { - "type" : "array", - "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.", - "externalDocs" : { - "description" : "Resource Tags", - "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" - }, - "items" : { - "$ref" : "#/components/schemas/ResourceTag" - } + "raw" : { + "$ref" : "#/components/schemas/raw" }, - "terminationProtectionEnabled" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true }, - "versionReleaseSystem" : { + "replicaSetName" : { "type" : "string", - "default" : "LTS", - "description" : "Method by which the cluster maintains the MongoDB versions.", - "enum" : [ "LTS" ], + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true } }, - "required" : [ "providerSettings" ], - "title" : "USS Instance Description" + "required" : [ "created", "eventTypeName", "id" ] }, - "USSInstanceDescriptionCreate20250101" : { + "TimeMetricThresholdView" : { "type" : "object", - "description" : "Settings that you can specify when you create a USS instance.", "properties" : { - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." }, - "name" : { + "mode" : { "type" : "string", - "description" : "Human-readable label that identifies the instance.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "writeOnly" : true + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] }, - "providerSettings" : { - "$ref" : "#/components/schemas/USSProviderSettingsCreate20250101" + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, - "tags" : { - "type" : "array", - "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.", - "externalDocs" : { - "description" : "Resource Tags", - "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" - }, - "items" : { - "$ref" : "#/components/schemas/ResourceTag" - } + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." }, - "terminationProtectionEnabled" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" } }, - "required" : [ "name", "providerSettings" ], - "title" : "USS Instance Description Create" + "required" : [ "metricName" ] + }, + "TimeMetricUnits" : { + "type" : "string", + "default" : "HOURS", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "NANOSECONDS", "MILLISECONDS", "MILLION_MINUTES", "SECONDS", "MINUTES", "HOURS", "DAYS" ], + "title" : "Time Metric Units" }, - "USSProviderSettings20250101" : { + "TimeMetricValueView" : { "type" : "object", - "description" : "Group of cloud provider settings that configure the provisioned MongoDB USS instance.", + "description" : "Measurement of the **metricName** recorded at the time of the event.", "properties" : { - "backingProviderName" : { - "type" : "string", - "description" : "Cloud service provider on which MongoDB Cloud provisioned the USS instance.", - "enum" : [ "AWS", "AZURE", "GCP" ], - "readOnly" : true - }, - "diskSizeGB" : { + "number" : { "type" : "number", "format" : "double", - "description" : "Storage capacity available to the USS instance expressed in gigabytes.", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", "readOnly" : true }, - "providerName" : { + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "readOnly" : true, + "title" : "Time Metric Value" + }, + "TokenFilterEnglishPossessive" : { + "type" : "object", + "description" : "Filter that removes possessives (trailing 's) from words.", + "properties" : { + "type" : { "type" : "string", - "default" : "USS", - "description" : "Human-readable label that identifies the cloud service provider.", - "enum" : [ "USS" ], - "readOnly" : true - }, - "regionName" : { + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "englishPossessive" ] + } + }, + "required" : [ "type" ], + "title" : "englishPossessive" + }, + "TokenFilterFlattenGraph" : { + "type" : "object", + "description" : "Filter that transforms a token filter graph, such as the token filter graph that the wordDelimiterGraph token filter produces, into a flat form suitable for indexing.", + "properties" : { + "type" : { "type" : "string", - "description" : "Human-readable label that identifies the geographic location of your MongoDB USS 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/).", - "readOnly" : true + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "flattenGraph" ] } }, - "readOnly" : true, - "title" : "Cloud Service Provider Settings for a USS Instance" + "required" : [ "type" ], + "title" : "flattenGraph" }, - "USSProviderSettingsCreate20250101" : { + "TokenFilterPorterStemming" : { "type" : "object", - "description" : "Group of cloud provider settings that configure the provisioned MongoDB USS instance.", + "description" : "Filter that uses the porter stemming algorithm to remove the common morphological and inflectional suffixes from words in English. It expects lowercase text and doesn't work as expected for uppercase text.", "properties" : { - "backingProviderName" : { + "type" : { "type" : "string", - "description" : "Cloud service provider on which MongoDB Cloud provisioned the serverless instance.", - "enum" : [ "AWS", "AZURE", "GCP" ], - "writeOnly" : true + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "porterStemming" ] + } + }, + "required" : [ "type" ], + "title" : "porterStemming" + }, + "TokenFilterSpanishPluralStemming" : { + "type" : "object", + "description" : "Filter that stems Spanish plural words. It expects lowercase text.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "spanishPluralStemming" ] + } + }, + "required" : [ "type" ], + "title" : "spanishPluralStemming" + }, + "TokenFilterStempel" : { + "type" : "object", + "description" : "Filter that uses Lucene's default Polish stemmer table to stem words in the Polish language. It expects lowercase text.", + "externalDocs" : { + "description" : "Default Polish stemmer table", + "url" : "https://lucene.apache.org/core/9_2_0/analysis/stempel/org/apache/lucene/analysis/pl/PolishAnalyzer.html#DEFAULT_STEMMER_FILE" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "stempel" ] + } + }, + "required" : [ "type" ], + "title" : "stempel" + }, + "TokenFilterWordDelimiterGraph" : { + "type" : "object", + "description" : "Filter that splits tokens into sub-tokens based on configured rules.", + "properties" : { + "delimiterOptions" : { + "type" : "object", + "description" : "Object that contains the rules that determine how to split words into sub-words.", + "properties" : { + "concatenateAll" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to concatenate runs." + }, + "concatenateNumbers" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to concatenate runs of sub-numbers." + }, + "concatenateWords" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to concatenate runs of sub-words." + }, + "generateNumberParts" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on sub-numbers. For example, if `true`, this option splits `100-2` into `100` and `2`." + }, + "generateWordParts" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on sub-words." + }, + "ignoreKeywords" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to skip tokens with the `keyword` attribute set to `true`" + }, + "preserveOriginal" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to generate tokens of the original words." + }, + "splitOnCaseChange" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on letter-case transitions." + }, + "splitOnNumerics" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on letter-number transitions." + }, + "stemEnglishPossessive" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to remove trailing possessives from each sub-word." + } + } }, - "diskSizeGB" : { - "type" : "number", - "format" : "double", - "description" : "Storage capacity available to the USS instance expressed in gigabytes.", - "readOnly" : true + "protectedWords" : { + "type" : "object", + "description" : "Object that contains options for protected words.", + "properties" : { + "ignoreCase" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to ignore letter case sensitivity for protected words." + }, + "words" : { + "type" : "array", + "description" : "List that contains the tokens to protect from delimination.", + "items" : { + "type" : "string" + } + } + }, + "required" : [ "words" ] }, - "providerName" : { + "type" : { "type" : "string", - "default" : "USS", - "description" : "Human-readable label that identifies the cloud service provider.", - "enum" : [ "USS" ], - "readOnly" : true + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "wordDelimiterGraph" ] + } + }, + "required" : [ "type" ], + "title" : "wordDelimiterGraph" + }, + "TokenFilterkStemming" : { + "type" : "object", + "description" : "Filter that combines algorithmic stemming with a built-in dictionary for the English language to stem words.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "kStemming" ] + } + }, + "required" : [ "type" ], + "title" : "kStemming" + }, + "TriggerIngestionPipelineRequest" : { + "type" : "object", + "properties" : { + "datasetRetentionPolicy" : { + "$ref" : "#/components/schemas/DatasetRetentionPolicy" }, - "regionName" : { + "snapshotId" : { "type" : "string", - "description" : "Human-readable label that identifies the geographic location of your MongoDB USS 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/).", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "writeOnly" : true } }, - "required" : [ "backingProviderName", "regionName" ], - "title" : "Cloud Service Provider Settings for a USS Instance", - "writeOnly" : true + "required" : [ "snapshotId" ] }, "UpdateAtlasOrganizationApiKey" : { "type" : "object", @@ -48837,7 +50592,7 @@ "description" : "Human-readable label that identifies the cluster or MongoDB Atlas Data Lake that this database user can access.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, "type" : { "type" : "string", @@ -48893,6 +50648,32 @@ "required" : [ "match" ], "title" : "User to Distinguished Name Mapping" }, + "VPCPeeringActionChallenge" : { + "type" : "object", + "description" : "Container for elements used to challenge the user before taking certain actions on VPC Peering connections.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "requesterAccountId" : { + "type" : "string", + "description" : "The AWS requester account ID." + }, + "requesterVpcId" : { + "type" : "string", + "description" : "The AWS requester VPC ID." + } + } + }, "VectorSearchHostStatusDetail" : { "type" : "object", "properties" : { diff --git a/tools/cli/test/data/split/dev/openapi-v2-2023-01-01.yaml b/tools/cli/test/data/split/dev/openapi-v2-2023-01-01.yaml index b0837c9499..dcb72a73d3 100644 --- a/tools/cli/test/data/split/dev/openapi-v2-2023-01-01.yaml +++ b/tools/cli/test/data/split/dev/openapi-v2-2023-01-01.yaml @@ -13,13 +13,15 @@ info: ``` To learn more, see [Get Started with the Atlas Administration API](https://www.mongodb.com/docs/atlas/configure-api-access/). For support, see [MongoDB Support](https://www.mongodb.com/support/get-started). + + You can also explore the various endpoints available through the Atlas Administration API in MongoDB's [Postman workspace](https://www.postman.com/mongodb-devrel/workspace/mongodb-atlas-administration-apis/). license: name: CC BY-NC-SA 3.0 US url: https://creativecommons.org/licenses/by-nc-sa/3.0/us/ termsOfService: https://www.mongodb.com/mongodb-management-service-terms-and-conditions title: MongoDB Atlas Administration API version: "2.0" - x-xgen-sha: 09d9d18db2111c955a8e01702a27ca2763417782 + x-xgen-sha: e6ba3136dbd0be2a81dd4ed21b9e6c470edd4420 servers: - url: https://cloud.mongodb.com tags: @@ -82,8 +84,12 @@ tags: \ resource requires your project ID. Changes to federated database instance configurations\ \ can affect costs." name: Data Federation -- description: "Returns, adds, edits, and removes Atlas Data Lake Pipelines and associated\ +- description: "Returns, edits, and removes Atlas Data Lake Pipelines and associated\ \ runs." + externalDocs: + description: Data Lake Pipelines are deprecated. Please see Data Lake Deprecation + Guide. + url: https://dochub.mongodb.org/core/data-lake-deprecation name: Data Lake Pipelines - description: "Returns, adds, edits, and removes database users." name: Database Users @@ -158,6 +164,8 @@ tags: - description: "You can continually push logs from mongod, mongos, and audit logs\ \ to an AWS S3 bucket. Atlas exports logs every 5 minutes." name: Push-Based Log Export +- description: Configure and manage Atlas Resource Policies within your organization. + name: Resource Policies - description: Creates one index to a database deployment in a rolling manner. You can't create a rolling index on an `M0` free cluster or `M2/M5` shared cluster. name: Rolling Index @@ -173,6 +181,13 @@ tags: description: Set Up a Private Endpoint for a Serverless Instance Tutorial url: https://dochub.mongodb.org/core/serverless-private-endpoint name: Serverless Private Endpoints +- description: Endpoints for managing Service Accounts and secrets. Service Accounts + are used for programmatic access to the Atlas Admin API through the OAuth 2.0 + Client Credentials flow. This feature is available as a Preview feature. + externalDocs: + description: Get Started with the Atlas Administration API + url: https://www.mongodb.com/docs/atlas/configure-api-access/ + name: Service Accounts - description: Returns and adds restore jobs for shared-tier database deployments. name: Shared-Tier Restore Jobs - description: Returns and requests to download shared-tier database deployment snapshots. @@ -2191,9 +2206,9 @@ paths: /api/atlas/v2/groups/{groupId}/backup/exportBuckets: get: deprecated: true - description: "Returns all AWS S3 buckets and Azure Blob Storage Containers associated\ - \ with the specified Project. To use this resource, the requesting API Key\ - \ must have the Project Read Only role." + description: "Returns all Export Buckets associated with the specified Project.\ + \ To use this resource, the requesting API Key must have the Project Read\ + \ Only role." operationId: listExportBuckets parameters: - $ref: "#/components/parameters/envelope" @@ -2216,17 +2231,17 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Return All AWS S3 Buckets and Azure Blob Storage Containers Used for - Cloud Backup Snapshot Exports + summary: Return All Snapshot Export Buckets tags: - Cloud Backups - x-sunset: 2025-05-30 + x-sunset: 2026-05-30 post: deprecated: true - description: "Grants MongoDB Cloud access to the specified AWS S3 Bucket or\ - \ Azure Blob Storage Container. This enables this Export Bucket to receive\ - \ Atlas Cloud Backup Snapshots. To use this resource, the requesting API Key\ - \ must have the Project Owner role." + description: "Creates a Snapshot Export Bucket for an AWS S3 Bucket or Azure\ + \ Blob Storage Container. Once created, an snapshots can be exported to the\ + \ Export Bucket and its referenced AWS S3 Bucket or Azure Blob Storage Container.\ + \ To use this resource, the requesting API Key must have the Project Owner\ + \ role." operationId: createExportBucket parameters: - $ref: "#/components/parameters/envelope" @@ -2239,8 +2254,8 @@ paths: $ref: "#/components/schemas/DiskBackupSnapshotAWSExportBucket" x-sunset: 2025-05-30 x-xgen-version: 2023-01-01 - description: Grants MongoDB Cloud access to the specified AWS S3 Bucket or - Azure Blob Storage Container. + description: Specifies the role and AWS S3 Bucket or Azure Blob Storage Container + that the Export Bucket should reference. required: true responses: "200": @@ -2260,25 +2275,22 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Grant Access to AWS S3 Bucket or Azure Blob Storage Container for Cloud - Backup Snapshot Exports + summary: Create One Snapshot Export Bucket tags: - Cloud Backups - x-sunset: 2025-05-30 + x-sunset: 2026-05-30 /api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}: delete: - description: "Revoke MongoDB Cloud access to the specified AWS S3 Bucket or\ - \ Azure Blob Storage Container. This prevents this Export Bucket from receiving\ - \ Atlas Cloud Backup Snapshots. 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 API Key must have the Project Owner\ - \ role." + 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 API Key must have the Project\ + \ Owner role." operationId: deleteExportBucket parameters: - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/groupId" - - description: Unique string that identifies the AWS S3 Bucket or Azure Blob - Storage Container to which you export your Snapshots. + - description: Unique 24-hexadecimal character string that identifies the Export + Bucket. in: path name: exportBucketId required: true @@ -2306,15 +2318,14 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Revoke Access to AWS S3 Bucket or Azure Blob Storage Container for - Cloud Backup Snapshot Exports + summary: Delete One Snapshot Export Bucket tags: - Cloud Backups get: deprecated: true - description: "Returns one AWS S3 Bucket or Azure Blob Storage Container associated\ - \ with the specified Project. To use this resource, the requesting API Key\ - \ must have the Project Read Only role." + description: "Returns one Export Bucket associated with the specified Project.\ + \ To use this resource, the requesting API Key must have the Project Read\ + \ Only role." operationId: getExportBucket parameters: - $ref: "#/components/parameters/envelope" @@ -2346,11 +2357,10 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Return One AWS S3 Bucket or Azure Blob Storage Container Used for Cloud - Backup Snapshot Exports + summary: Return One Snapshot Export Bucket tags: - Cloud Backups - x-sunset: 2025-05-30 + x-sunset: 2026-05-30 /api/atlas/v2/groups/{groupId}/backupCompliancePolicy: get: deprecated: true @@ -2381,7 +2391,7 @@ paths: summary: Return the Backup Compliance Policy settings tags: - Cloud Backups - x-sunset: 2024-10-01 + x-sunset: 2026-10-01 put: deprecated: true description: "Updates the Backup Compliance Policy settings for the specified\ @@ -2429,7 +2439,7 @@ paths: summary: Update or enable the Backup Compliance Policy settings tags: - Cloud Backups - x-sunset: 2024-10-01 + x-sunset: 2025-10-01 /api/atlas/v2/groups/{groupId}/cloudProviderAccess: get: description: "Returns all cloud provider access roles with access to the specified\ @@ -2474,7 +2484,7 @@ paths: content: application/vnd.atlas.2023-01-01+json: schema: - $ref: "#/components/schemas/CloudProviderAccessRole" + $ref: "#/components/schemas/CloudProviderAccessRoleRequest" description: Creates one role for the specified cloud provider. required: true responses: @@ -2513,6 +2523,8 @@ paths: type: string enum: - AWS + - AZURE + - GCP - description: Unique 24-hexadecimal digit string that identifies the role. in: path name: roleId @@ -2579,7 +2591,8 @@ paths: description: "Grants access to the specified project for the specified access\ \ role. To use this resource, the requesting API Key must have the Project\ \ Owner role. This API endpoint is one step in a procedure to create unified\ - \ access for MongoDB Cloud services." + \ 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/ @@ -2601,7 +2614,7 @@ paths: content: application/vnd.atlas.2023-01-01+json: schema: - $ref: "#/components/schemas/CloudProviderAccessRole" + $ref: "#/components/schemas/CloudProviderAccessRoleRequestUpdate" description: Grants access to the specified project for the specified access role. required: true @@ -2860,7 +2873,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster. in: query @@ -2909,7 +2922,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -2957,7 +2970,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -2991,7 +3004,7 @@ paths: x-sunset: 2025-06-01 /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports: get: - description: "Returns all Cloud Backup snapshot export jobs associated with\ + description: "Returns all Cloud Backup Snapshot Export Jobs associated with\ \ the specified Atlas cluster. To use this resource, the requesting API Key\ \ must have the Project Atlas Admin role." operationId: listBackupExportJobs @@ -3010,7 +3023,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -3025,11 +3038,11 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Return All Cloud Backup Snapshot Export Jobs + summary: Return All Snapshot Export Jobs tags: - Cloud Backups post: - description: "Exports one backup snapshot for dedicated Atlas cluster using\ + description: "Exports one backup Snapshot for dedicated Atlas cluster using\ \ Cloud Backups to an Export Bucket. To use this resource, the requesting\ \ API Key must have the Project Atlas Admin role." operationId: createBackupExportJob @@ -3044,7 +3057,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -3072,12 +3085,12 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Create One Cloud Backup Snapshot Export Job + summary: Create One Snapshot Export Job tags: - Cloud Backups /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}: get: - description: "Returns one Cloud Backup snapshot export job associated with the\ + description: "Returns one Cloud Backup Snapshot Export Job associated with the\ \ specified Atlas cluster. To use this resource, the requesting API Key must\ \ have the Project Atlas Admin role." operationId: getBackupExportJob @@ -3092,13 +3105,18 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - - description: Unique string that identifies the export job to return. + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + - description: Unique 24-hexadecimal character string that identifies the Export + Job. in: path name: exportId required: true schema: type: string + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" responses: "200": content: @@ -3113,7 +3131,7 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Return One Cloud Backup Snapshot Export Job + summary: Return One Snapshot Export Job tags: - Cloud Backups /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs: @@ -3138,7 +3156,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -3174,7 +3192,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -3223,7 +3241,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the restore job to remove. in: path @@ -3271,7 +3289,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the restore job to return. in: path @@ -3318,7 +3336,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -3338,7 +3356,7 @@ paths: summary: Remove All Cloud Backup Schedules tags: - Cloud Backups - x-sunset: 2025-08-05 + x-sunset: 2026-05-30 get: deprecated: true description: "Returns the cloud backup schedule for the specified cluster within\ @@ -3358,7 +3376,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -3376,7 +3394,7 @@ paths: summary: Return One Cloud Backup Schedule tags: - Cloud Backups - x-sunset: 2025-08-05 + x-sunset: 2026-05-30 patch: deprecated: true description: "Updates the cloud backup schedule for one cluster within the specified\ @@ -3396,7 +3414,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -3426,7 +3444,7 @@ paths: summary: Update Cloud Backup Schedule for One Cluster tags: - Cloud Backups - x-sunset: 2025-08-05 + x-sunset: 2026-05-30 /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots: get: description: "Returns all snapshots of one cluster from the specified project.\ @@ -3448,7 +3466,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -3486,7 +3504,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -3531,7 +3549,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -3576,7 +3594,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -3624,7 +3642,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -3661,7 +3679,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -3707,7 +3725,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -3753,7 +3771,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -3808,7 +3826,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/groupId" - $ref: "#/components/parameters/pretty" @@ -3862,7 +3880,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/groupId" - $ref: "#/components/parameters/pretty" @@ -3911,7 +3929,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/groupId" - $ref: "#/components/parameters/pretty" @@ -3948,7 +3966,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/groupId" - $ref: "#/components/parameters/pretty" @@ -3999,7 +4017,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -4037,7 +4055,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -4090,7 +4108,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -4137,7 +4155,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -4184,7 +4202,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -4238,7 +4256,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Name of the collection that contains one or more Atlas Search indexes. in: path @@ -4296,7 +4314,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: "Unique 24-hexadecimal digit string that identifies the Atlas\ \ Search index. Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/)\ \ endpoint to find the IDs of all Atlas Search indexes." @@ -4351,7 +4369,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - 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/)\ @@ -4405,7 +4423,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - 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/)\ @@ -4470,7 +4488,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -4514,7 +4532,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -4556,7 +4574,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -4607,7 +4625,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - $ref: "#/components/parameters/groupId" - description: Human-readable label that identifies the database that contains the collection. @@ -4663,7 +4681,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -4718,7 +4736,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -4833,7 +4851,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -4872,7 +4890,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -4950,7 +4968,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Flag that indicates whether to download logs for queries against your online archive only or both your online archive and cluster. in: query @@ -5017,7 +5035,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "204": content: @@ -5068,7 +5086,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5121,7 +5139,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -5172,7 +5190,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5213,7 +5231,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5254,7 +5272,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -5307,7 +5325,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5353,7 +5371,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -5407,7 +5425,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5461,7 +5479,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5511,7 +5529,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -5559,7 +5577,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the restore job. in: path @@ -5606,7 +5624,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5644,7 +5662,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5682,7 +5700,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -5728,7 +5746,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -5779,7 +5797,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5817,7 +5835,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -5871,7 +5889,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: "Human-readable label that specifies whether to return only completed,\ \ incomplete, or all snapshots. By default, MongoDB Cloud only returns completed\ \ snapshots." @@ -5926,7 +5944,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -5980,7 +5998,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -6033,7 +6051,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -6088,7 +6106,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -6150,18 +6168,22 @@ paths: externalDocs: description: Set up Database Auditing url: https://docs.atlas.mongodb.com/database-auditing/ - - description: Date and time when the period specifies the inclusive ending - point for the range of log messages to retrieve. This parameter expresses - its value in the number of seconds that have elapsed since the UNIX epoch. + - description: "Specifies the date and time for the ending point of the range\ + \ of log messages to retrieve, in the number of seconds that have elapsed\ + \ since the UNIX epoch. This value will default to 24 hours after the start\ + \ date. If the start date is also unspecified, the value will default to\ + \ the time of the request." in: query name: endDate schema: type: integer format: int64 minimum: 1199145600 - - description: Date and time when the period specifies the inclusive starting - point for the range of log messages to retrieve. This parameter expresses - its value in the number of seconds that have elapsed since the UNIX epoch. + - description: "Specifies the date and time for the starting point of the range\ + \ of log messages to retrieve, in the number of seconds that have elapsed\ + \ since the UNIX epoch. This value will default to 24 hours prior to the\ + \ end date. If the end date is also unspecified, the value will default\ + \ to 24 hours prior to the time of the request." in: query name: startDate schema: @@ -7599,7 +7621,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: "Date and time when to stop retrieving database history. If you\ \ specify **end**, you must also specify **start**. This parameter uses\ \ UNIX epoch time in milliseconds." @@ -7818,6 +7840,9 @@ paths: - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/pretty" - $ref: "#/components/parameters/groupId" + - $ref: "#/components/parameters/includeCount" + - $ref: "#/components/parameters/itemsPerPage" + - $ref: "#/components/parameters/pageNum" - description: Human-readable label that identifies the cloud provider for the private endpoints to return. in: path @@ -7915,14 +7940,6 @@ paths: maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" - requestBody: - content: - application/vnd.atlas.2023-01-01+json: - schema: - $ref: "#/components/schemas/EncryptionAtRestPrivateEndpointRequest" - description: Cloud provider of the private endpoints to delete and the list - of cloud provider regions in which to delete the private endpoints. - required: true responses: "204": content: @@ -7977,6 +7994,8 @@ paths: description: OK "403": $ref: "#/components/responses/forbidden" + "404": + $ref: "#/components/responses/notFound" "500": $ref: "#/components/responses/internalServerError" security: @@ -8008,7 +8027,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" style: form - description: |- Category of incident recorded at this moment in time. @@ -8635,7 +8654,7 @@ paths: summary: Return All Project Invitations tags: - Projects - x-sunset: 2024-10-04 + x-sunset: 2024-11-04 patch: deprecated: true description: "Updates the details of one pending invitation to the specified\ @@ -8676,7 +8695,7 @@ paths: summary: Update One Project Invitation tags: - Projects - x-sunset: 2024-10-04 + x-sunset: 2024-11-04 post: deprecated: true description: "Invites one MongoDB Cloud user to join the specified project.\ @@ -8712,7 +8731,7 @@ paths: summary: Invite One MongoDB Cloud User to Join One Project tags: - Projects - x-sunset: 2024-10-04 + x-sunset: 2024-11-04 /api/atlas/v2/groups/{groupId}/invites/{invitationId}: delete: deprecated: true @@ -8750,7 +8769,7 @@ paths: summary: Cancel One Project Invitation tags: - Projects - x-sunset: 2024-10-04 + x-sunset: 2024-11-04 get: deprecated: true description: "Returns the details of one pending invitation to the specified\ @@ -8789,7 +8808,7 @@ paths: summary: Return One Project Invitation tags: - Projects - x-sunset: 2024-10-04 + x-sunset: 2024-11-04 patch: deprecated: true description: "Updates the details of one pending invitation to the specified\ @@ -8839,7 +8858,7 @@ paths: summary: Update One Project Invitation by Invitation ID tags: - Projects - x-sunset: 2024-10-04 + x-sunset: 2024-11-04 /api/atlas/v2/groups/{groupId}/ipAddresses: get: description: "Returns all IP addresses for this project. To use this resource,\ @@ -8915,7 +8934,7 @@ paths: | Limit Name | Description | Default | API Override Limit | | --- | --- | --- | --- | - | atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 | + | atlas.project.deployment.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 | @@ -8927,6 +8946,7 @@ paths: | 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 | in: path name: limitName required: true @@ -8946,6 +8966,7 @@ paths: - 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" @@ -8980,7 +9001,7 @@ paths: | Limit Name | Description | Default | API Override Limit | | --- | --- | --- | --- | - | atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 | + | atlas.project.deployment.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 | @@ -8992,6 +9013,7 @@ paths: | 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 | in: path name: limitName required: true @@ -9011,6 +9033,7 @@ paths: - 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" @@ -9049,7 +9072,7 @@ paths: | Limit Name | Description | Default | API Override Limit | | --- | --- | --- | --- | - | atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 | + | atlas.project.deployment.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 | @@ -9061,6 +9084,7 @@ paths: | 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 | in: path name: limitName required: true @@ -9080,6 +9104,7 @@ paths: - 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" @@ -9857,6 +9882,7 @@ paths: - Network Peering /api/atlas/v2/groups/{groupId}/pipelines: get: + deprecated: true description: "Returns a list of Data Lake Pipelines. To use this resource, the\ \ requesting API Key must have the Project Read Only role." operationId: listPipelines @@ -9884,8 +9910,14 @@ paths: summary: Return All Data Lake Pipelines from One Project tags: - Data Lake Pipelines + x-sunset: 2025-09-09 post: + deprecated: true description: Creates one Data Lake Pipeline. + externalDocs: + description: Data Lake Pipelines are deprecated. Please see Data Lake Deprecation + Guide. + url: https://dochub.mongodb.org/core/data-lake-deprecation operationId: createPipeline parameters: - $ref: "#/components/parameters/envelope" @@ -9918,8 +9950,10 @@ paths: summary: Create One Data Lake Pipeline tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}: delete: + deprecated: true description: Removes one Data Lake Pipeline. operationId: deletePipeline parameters: @@ -9953,7 +9987,9 @@ paths: summary: Remove One Data Lake Pipeline tags: - Data Lake Pipelines + x-sunset: 2025-09-09 get: + deprecated: true description: "Returns the details of one Data Lake Pipeline within the specified\ \ project. To use this resource, the requesting API Key must have the Project\ \ Read Only role." @@ -9990,7 +10026,9 @@ paths: summary: Return One Data Lake Pipeline tags: - Data Lake Pipelines + x-sunset: 2025-09-09 patch: + deprecated: true description: Updates one Data Lake Pipeline. operationId: updatePipeline parameters: @@ -10035,8 +10073,10 @@ paths: summary: Update One Data Lake Pipeline tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules: get: + deprecated: true description: "Returns a list of backup schedule policy items that you can use\ \ as a Data Lake Pipeline source. To use this resource, the requesting API\ \ Key must have the Project Read Only role." @@ -10075,8 +10115,10 @@ paths: summary: Return Available Ingestion Schedules for One Data Lake Pipeline tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots: get: + deprecated: true description: "Returns a list of backup snapshots that you can use to trigger\ \ an on demand pipeline run. To use this resource, the requesting API Key\ \ must have the Project Read Only role." @@ -10126,8 +10168,10 @@ paths: summary: Return Available Backup Snapshots for One Data Lake Pipeline tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause: post: + deprecated: true description: "Pauses ingestion for a Data Lake Pipeline within the specified\ \ project. To use this resource, the requesting API Key must have the Project\ \ Read Only role." @@ -10164,8 +10208,10 @@ paths: summary: Pause One Data Lake Pipeline tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume: post: + deprecated: true description: "Resumes ingestion for a Data Lake Pipeline within the specified\ \ project. To use this resource, the requesting API Key must have the Project\ \ Read Only role." @@ -10202,8 +10248,10 @@ paths: summary: Resume One Data Lake Pipeline tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs: get: + deprecated: true description: "Returns a list of past Data Lake Pipeline runs. To use this resource,\ \ the requesting API Key must have the Project Read Only role." operationId: listPipelineRuns @@ -10250,8 +10298,10 @@ paths: summary: Return All Data Lake Pipeline Runs from One Project tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}: delete: + deprecated: true description: Deletes dataset that Atlas generated during the specified pipeline run. operationId: deletePipelineRunDataset @@ -10298,7 +10348,9 @@ paths: summary: Delete Pipeline Run Dataset tags: - Data Lake Pipelines + x-sunset: 2025-09-09 get: + deprecated: true description: "Returns the details of one Data Lake Pipeline run within the specified\ \ project. To use this resource, the requesting API Key must have the Project\ \ Read Only role." @@ -10346,8 +10398,10 @@ paths: summary: Return One Data Lake Pipeline Run tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger: post: + deprecated: true description: Triggers a Data Lake Pipeline ingestion of a specified snapshot. operationId: triggerSnapshotIngestion parameters: @@ -10389,6 +10443,7 @@ paths: summary: Trigger on demand snapshot ingestion tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService: post: description: "Creates one private endpoint service for the specified cloud service\ @@ -10520,7 +10575,7 @@ paths: schema: type: string maxLength: 64 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -10562,7 +10617,7 @@ paths: schema: type: string maxLength: 64 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -10606,7 +10661,7 @@ paths: schema: type: string maxLength: 64 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be removed. in: path @@ -10652,7 +10707,7 @@ paths: schema: type: string maxLength: 64 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the tenant endpoint. in: path @@ -10697,7 +10752,7 @@ paths: schema: type: string maxLength: 64 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be updated. in: path @@ -11690,6 +11745,8 @@ paths: - 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 maxItems: 10 minItems: 1 uniqueItems: true @@ -11774,6 +11831,8 @@ paths: - CACHE_BYTES_WRITTEN_FROM - CACHE_DIRTY_BYTES - CACHE_USED_BYTES + - CACHE_FILL_RATIO + - DIRTY_FILL_RATIO - COMPUTED_MEMORY - CONNECTIONS - CURSORS_TOTAL_OPEN @@ -11855,6 +11914,7 @@ paths: - 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 @@ -12326,7 +12386,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "201": content: @@ -12471,7 +12531,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -12509,7 +12569,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -12559,7 +12619,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the restore job to return. in: path @@ -12610,7 +12670,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -12647,7 +12707,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -12692,7 +12752,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/pretty" responses: @@ -12725,7 +12785,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Value that we want to set for the Serverless Auto Indexing toggle. in: query name: enable @@ -12769,15 +12829,15 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: - "204": + "202": content: application/vnd.atlas.2023-01-01+json: schema: - $ref: "#/components/schemas/NoBody" + $ref: "#/components/schemas/RequestAccepted" x-xgen-version: 2023-01-01 - description: This endpoint does not return a response body. + description: Accepted "400": $ref: "#/components/responses/badRequest" "404": @@ -12808,7 +12868,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -12846,7 +12906,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -14946,6 +15006,8 @@ paths: $ref: "#/components/schemas/OrganizationSettings" x-xgen-version: 2023-01-01 description: OK + "400": + $ref: "#/components/responses/badRequest" "401": $ref: "#/components/responses/unauthorized" "403": @@ -15420,6 +15482,7 @@ paths: - Organizations /api/atlas/v2/orgs/{orgId}/users/{userId}: delete: + deprecated: true description: "Removes one MongoDB Cloud user from the specified organization.\ \ To use this resource, the requesting API Key must have the Organization\ \ User Admin role." @@ -15427,6 +15490,7 @@ paths: parameters: - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/orgId" + - $ref: "#/components/parameters/pretty" - description: Unique 24-hexadecimal digit string that identifies the user to be deleted. in: path @@ -15457,9 +15521,10 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Remove One MongoDB Cloud User from One Organization + summary: Remove One MongoDB Cloud User From One Organization tags: - Organizations + x-sunset: 2026-01-01 /api/atlas/v2/orgs/{orgId}/users/{userId}/roles: put: description: "Updates the roles of the specified user in the specified organization.\ @@ -16264,7 +16329,7 @@ components: description: |- Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. - Change this parameter only if you: + 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). @@ -16340,7 +16405,7 @@ components: You can set different IOPS values on different shards when provisioned IOPS are supported. - Change this parameter only if you: + 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). @@ -16771,6 +16836,31 @@ components: - REPLICASET - SHARDED - GEOSHARDED + configServerManagementMode: + type: string + default: ATLAS_MANAGED + description: |- + Config Server Management Mode for creating or updating a sharded cluster. + + When configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings. + + When configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server. + enum: + - ATLAS_MANAGED + - FIXED_TO_DEDICATED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + configServerType: + type: string + description: Describes a sharded cluster's config server type. + enum: + - DEDICATED + - EMBEDDED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + readOnly: true connectionStrings: $ref: "#/components/schemas/ClusterConnectionStrings" createDate: @@ -16818,6 +16908,15 @@ components: externalDocs: description: Encryption at Rest using Customer Key Management url: https://www.mongodb.com/docs/atlas/security-kms-encryption/ + featureCompatibilityVersion: + type: string + description: Feature compatibility version of the cluster. + readOnly: true + featureCompatibilityVersionExpirationDate: + type: string + format: date-time + description: Feature compatibility version expiration date. + readOnly: true globalClusterSelfManagedSharding: type: boolean description: |- @@ -16868,6 +16967,8 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true + mongoDBEmployeeAccessGrant: + $ref: "#/components/schemas/EmployeeAccessGrantView" mongoDBMajorVersion: type: string description: |- @@ -16889,7 +16990,7 @@ components: description: Human-readable label that identifies the advanced cluster. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" paused: type: boolean description: Flag that indicates whether the cluster is paused. @@ -16900,6 +17001,24 @@ components: externalDocs: description: Continuous Cloud Backups url: https://docs.atlas.mongodb.com/backup/cloud-backup/overview/ + replicaSetScalingStrategy: + type: string + default: WORKLOAD_TYPE + description: |- + Set this field to configure the replica set scaling mode for your cluster. + + By default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes. + + When configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads. + + When configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads. + enum: + - SEQUENTIAL + - WORKLOAD_TYPE + - NODE_TYPE + externalDocs: + description: Modify the Replica Set Scaling Mode + url: https://dochub.mongodb.org/core/scale-nodes replicationSpecs: type: array description: "List of settings that configure your cluster regions. For\ @@ -17778,6 +17897,246 @@ components: description: Atlas Search Index url: https://dochub.mongodb.org/core/index-definitions-fts title: mappings + ApiAtlasInvalidPolicyErrorDetailView: + type: object + properties: + detail: + type: string + description: A string that provides a detailed description of a validation + error. + readOnly: true + ApiAtlasInvalidPolicyView: + type: object + properties: + body: + type: string + description: A string that defines the permissions for the policy. The syntax + used is the Cedar Policy language. + example: |2 + forbid ( + principal, + action == cloud::Action::"cluster.createEdit", + resource + ) when { + context.cluster.regions.contains(cloud::region::"aws:us-east-1") + }; + readOnly: true + errors: + type: array + description: List of validation errors. + items: + $ref: "#/components/schemas/ApiAtlasInvalidPolicyErrorDetailView" + readOnly: true + ApiAtlasInvalidResourcePolicyCreateErrorView: + type: object + properties: + errorType: + type: string + description: Human-readable label that displays the type of an error. + enum: + - POLICY_PARSING_ERROR + - POLICY_HAS_FAILED_VALIDATIONS + - POLICY_HAS_INVALID_PRINCIPAL + - POLICY_HAS_BODY_EXCEEDING_MAX_SIZE + - POLICY_HAS_UNEXPECTED_ENTITIES + invalidPolicies: + type: array + description: List of invalid policies containing details of their validation + errors. + items: + $ref: "#/components/schemas/ApiAtlasInvalidPolicyView" + readOnly: true + ApiAtlasNonCompliantResourceView: + type: object + properties: + orgId: + type: string + description: Unique 24-hexadecimal character string that identifies the + organization the resource belongs to. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + resourceId: + type: string + description: Unique 24-hexadecimal character string that identifies the + non-compliant resource. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + resourcePoliciesCausingNonCompliance: + type: array + description: List of resource policies causing the resource to be considered + non-compliant. + items: + $ref: "#/components/schemas/ApiAtlasResourcePolicyMetadataView" + readOnly: true + resourceType: + type: string + description: Human-readable label that displays the type of a resource. + enum: + - PROJECT + - CLUSTER + readOnly: true + ApiAtlasPolicyCreateView: + type: object + properties: + body: + type: string + description: A string that defines the permissions for the policy. The syntax + used is the Cedar Policy language. + example: |2 + forbid ( + principal, + action == cloud::Action::"cluster.createEdit", + resource + ) when { + context.cluster.regions.contains(cloud::region::"aws:us-east-1") + }; + required: + - body + ApiAtlasPolicyMetadataView: + type: object + properties: + policyId: + type: string + description: Unique 24-hexadecimal character string that identifies the + policy. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + ApiAtlasPolicyView: + type: object + properties: + body: + type: string + description: A string that defines the permissions for the policy. The syntax + used is the Cedar Policy language. + example: |2 + forbid ( + principal, + action == cloud::Action::"cluster.createEdit", + resource + ) when { + context.cluster.regions.contains(cloud::region::"aws:us-east-1") + }; + readOnly: true + id: + type: string + description: Unique 24-hexadecimal character string that identifies the + policy. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + ApiAtlasResourcePolicyCreateView: + type: object + properties: + name: + type: string + description: Human-readable label that describes the atlas resource policy. + policies: + type: array + description: List of policies that make up the atlas resource policy. + items: + $ref: "#/components/schemas/ApiAtlasPolicyCreateView" + required: + - name + - policies + ApiAtlasResourcePolicyEditView: + type: object + properties: + name: + type: string + description: Human-readable label that describes the atlas resource policy. + policies: + type: array + description: List of policies that make up the atlas resource policy. + items: + $ref: "#/components/schemas/ApiAtlasPolicyCreateView" + ApiAtlasResourcePolicyMetadataView: + type: object + properties: + policiesCausingNonCompliance: + type: array + description: List of policies that are in conflict with the current state + of the resource. + items: + $ref: "#/components/schemas/ApiAtlasPolicyMetadataView" + readOnly: true + resourcePolicyId: + type: string + description: Unique 24-hexadecimal character string that identifies the + atlas resource policy. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + resourcePolicyName: + type: string + description: Human-readable label that describes the atlas resource policy. + readOnly: true + ApiAtlasResourcePolicyView: + type: object + properties: + createdByUser: + $ref: "#/components/schemas/ApiAtlasUserMetadataView" + createdDate: + type: string + format: date-time + description: Date and time in UTC when the atlas resource policy was created. + example: 2022-01-01T00:00:00Z + readOnly: true + id: + type: string + description: Unique 24-hexadecimal character string that identifies the + atlas resource policy. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + lastUpdatedByUser: + $ref: "#/components/schemas/ApiAtlasUserMetadataView" + lastUpdatedDate: + type: string + format: date-time + description: Date and time in UTC when the atlas resource policy was last + updated. + example: 2022-01-01T00:00:00Z + readOnly: true + name: + type: string + description: Human-readable label that describes the atlas resource policy. + readOnly: true + orgId: + type: string + description: Unique 24-hexadecimal character string that identifies the + organization the atlas resource policy belongs to. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + policies: + type: array + description: List of policies that make up the atlas resource policy. + items: + $ref: "#/components/schemas/ApiAtlasPolicyView" + readOnly: true + version: + type: string + description: A string that identifies the version of the atlas resource + policy. + example: v1 + readOnly: true ApiAtlasSnapshotScheduleView: type: object properties: @@ -17914,6 +18273,23 @@ components: - snapshotIntervalHours - snapshotRetentionDays - weeklySnapshotRetentionWeeks + ApiAtlasUserMetadataView: + type: object + description: The user that last updated the atlas resource policy. + properties: + id: + type: string + description: Unique 24-hexadecimal character string that identifies a user. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + name: + type: string + description: Human-readable label that describes a user. + readOnly: true + readOnly: true ApiBSONTimestampView: type: object description: BSON timestamp that indicates when the checkpoint token entry in @@ -17970,6 +18346,8 @@ components: ApiError: type: object properties: + badRequestDetail: + $ref: "#/components/schemas/BadRequestDetail" detail: type: string description: Describes the specific conditions or reasons that cause each @@ -17980,17 +18358,25 @@ components: description: HTTP status code returned with this error. externalDocs: url: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status + readOnly: true 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. items: type: object + readOnly: true + readOnly: true reason: type: string description: Application error message returned with this error. + readOnly: true + required: + - error + - errorCode ApiHostView_Atlas: type: object properties: @@ -18279,6 +18665,23 @@ components: \ and **period** in the same request. This parameter expresses its value\ \ in the ISO 8601 timestamp format in UTC." readOnly: true + ApiPrivateDownloadDeliveryUrl: + type: object + description: One Uniform Resource Locator (URL) that points to the compressed + snapshot files for manual download and the corresponding private endpoint. + properties: + deliveryUrl: + type: string + description: One Uniform Resource Locator that points to the compressed + snapshot files for manual download. + endpointId: + type: string + description: Unique 22-character alphanumeric string that identifies the + private endpoint. + example: vpce-3bf78b0ddee411ba1 + maxLength: 22 + minLength: 22 + pattern: "^vpce-[0-9a-f]{17}$" ApiPublicUsageDetailsQueryRequest: type: object description: "Request body for an Invoice Usage Details query with filtering,\ @@ -18390,7 +18793,23 @@ components: type: string description: Atlas Streams AWS Regions. enum: + - SYDNEY_AUS + - MUMBAI_IND + - FRANKFURT_DEU + - DUBLIN_IRL + - LONDON_GBR - VIRGINIA_USA + - OREGON_USA + - SAOPAULO_BRA + - MONTREAL_CAN + - TOKYO_JPN + - SINGAPORE_SGP + ApiStreamsAzureRegionView: + type: string + description: Atlas Streams Azure Regions. + enum: + - VIRGINIA_USA + - AMSTERDAM_NLD ApiUserEventTypeViewForNdsGroup: type: string description: Unique identifier of event type. @@ -18637,6 +19056,12 @@ components: - eventTypeName - id title: API User Events + ApiVersion: + type: object + properties: + version: + type: string + description: Object representing a version of the Atlas Admin API. AppServiceAlertConfigViewForNdsGroup: type: object description: App Services metric alert configuration allows to select which @@ -19118,7 +19543,12 @@ components: enum: - AVERAGE operator: - $ref: "#/components/schemas/Operator" + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - LESS_THAN + - GREATER_THAN threshold: type: number format: double @@ -19196,6 +19626,12 @@ components: enum: - VIRGINIA_USA - AMSTERDAM_NLD + AtlasDataFederationGCPRegion: + type: string + description: Atlas Data Federation GCP Regions. + enum: + - IOWA_USA + - BELGIUM_EU AtlasOrganization: type: object description: Details that describe the organization. @@ -19231,6 +19667,128 @@ components: pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" required: - name + AtlasResourcePolicyAuditForOrg: + type: object + description: Atlas resource policy audits indicate org level changes to resource + policies + properties: + apiKeyId: + type: string + description: "Unique 24-hexadecimal digit string that identifies the [API\ + \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\ + \ triggered the event. If this resource returns this parameter, it doesn't\ + \ return the **userId** parameter." + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + created: + type: string + format: date-time + description: Date and time when this event occurred. This parameter expresses + its value in the ISO 8601 timestamp format in UTC. + readOnly: true + eventTypeName: + type: string + description: Unique identifier of event type. + enum: + - RESOURCE_POLICY_CREATED + - RESOURCE_POLICY_MODIFIED + - RESOURCE_POLICY_DELETED + example: RESOURCE_POLICY_CREATED + title: Atlas Resource Policy Audit Types + groupId: + type: string + description: Unique 24-hexadecimal digit string that identifies the project + in which the event occurred. The **eventId** identifies the specific event. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + id: + type: string + description: Unique 24-hexadecimal digit string that identifies the event. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + isGlobalAdmin: + type: boolean + default: false + description: Flag that indicates whether a MongoDB employee triggered the + specified event. + readOnly: true + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + orgId: + type: string + description: Unique 24-hexadecimal digit string that identifies the organization + to which these events apply. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + publicKey: + type: string + format: email + description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\ + \ that triggered the event. If this resource returns this parameter, it\ + \ doesn't return the **username** parameter." + readOnly: true + raw: + $ref: "#/components/schemas/raw" + remoteAddress: + type: string + description: IPv4 or IPv6 address from which the user triggered this event. + example: 216.172.40.186 + pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + readOnly: true + resourcePolicyId: + type: string + description: Unique 24-hexadecimal character string that identifies the + resource policy. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + userId: + type: string + description: "Unique 24-hexadecimal digit string that identifies the console\ + \ user who triggered the event. If this resource returns this parameter,\ + \ it doesn't return the **apiKeyId** parameter." + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + username: + type: string + format: email + description: "Email address for the user who triggered this event. If this\ + \ resource returns this parameter, it doesn't return the **publicApiKey**\ + \ parameter." + example: test.user@mongodb.com + readOnly: true + required: + - created + - eventTypeName + - id + title: Atlas Resource Policy Audits AtlasSearchAnalyzer: type: object properties: @@ -19952,6 +20510,21 @@ components: AzureHardwareSpec: type: object properties: + diskIOPS: + type: integer + format: int32 + description: |- + Target throughput desired for storage attached to your Azure-provisioned cluster. Change this parameter if you: + + - set `"replicationSpecs[n].regionConfigs[m].providerName" : "Azure"`. + - set `"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize" : "M40"` or greater not including `Mxx_NVME` tiers. + + The maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**. + This parameter defaults to the cluster tier's standard IOPS value. + Changing this value impacts cluster cost. + externalDocs: + description: Programmatic API Keys + url: https://www.mongodb.com/docs/atlas/customize-storage/#extend-iops-on-azure instanceSize: type: string description: Hardware specification for the instance sizes in this region. @@ -19989,6 +20562,21 @@ components: AzureHardwareSpec20240805: type: object properties: + diskIOPS: + type: integer + format: int32 + description: |- + Target throughput desired for storage attached to your Azure-provisioned cluster. Change this parameter if you: + + - set `"replicationSpecs[n].regionConfigs[m].providerName" : "Azure"`. + - set `"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize" : "M40"` or greater not including `Mxx_NVME` tiers. + + The maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**. + This parameter defaults to the cluster tier's standard IOPS value. + Changing this value impacts cluster cost. + externalDocs: + description: Programmatic API Keys + url: https://www.mongodb.com/docs/atlas/customize-storage/#extend-iops-on-azure diskSizeGB: type: number format: double @@ -20204,6 +20792,8 @@ components: - PENDING_ACCEPTANCE - ACTIVE - FAILED + - PENDING_RECREATION + - DELETING readOnly: true title: Azure Key Vault EAR Private Endpoint AzureNetworkPeeringConnectionSettings: @@ -20638,7 +21228,7 @@ components: the collection for which you want to create an online archive. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true collName: type: string @@ -20750,7 +21340,7 @@ components: the collection for which you want to create an online archive. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true collName: type: string @@ -20889,7 +21479,7 @@ components: the snapshots you want to retrieve. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -21102,7 +21692,7 @@ components: To return a response with the **clusterId** parameter, either use the **delivery.targetClusterName** parameter or enable backup on the target cluster. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" targetGroupId: type: string description: "Unique 24-hexadecimal digit string that identifies the project\ @@ -21374,12 +21964,23 @@ components: - FAILED - COMPLETED readOnly: true + BadRequestDetail: + type: object + description: Bad request detail. + properties: + fields: + type: array + description: Describes all violations in a client request. + items: + $ref: "#/components/schemas/FieldViolation" + readOnly: true BaseAtlasDataLakeRegion: type: object description: Name of the region to which the data lake routes client connections. oneOf: - $ref: "#/components/schemas/ApiAtlasDataLakeAWSRegionView" - $ref: "#/components/schemas/AtlasDataFederationAzureRegion" + - $ref: "#/components/schemas/AtlasDataFederationGCPRegion" BaseCloudProviderInstanceSize: type: object description: "Minimum instance size to which your cluster can automatically\ @@ -21507,6 +22108,7 @@ components: description: Name of the cloud provider region hosting Atlas Stream Processing. oneOf: - $ref: "#/components/schemas/ApiStreamsAWSRegionView" + - $ref: "#/components/schemas/ApiStreamsAzureRegionView" BasicBSONList: type: array description: "List that contains the search criteria that the query uses. To\ @@ -22594,7 +23196,7 @@ components: description: Human-readable label that identifies the cluster. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true nodeCount: type: integer @@ -22655,6 +23257,10 @@ components: 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. + description: + type: string + description: Description of this database user. + maxLength: 100 groupId: type: string description: Unique 24-hexadecimal digit string that identifies the project. @@ -22922,6 +23528,127 @@ components: (AWS) Identity and Access Management (IAM) role. required: - providerName + CloudProviderAccessAWSIAMRoleRequest: + type: object + description: Details that describe the features linked to the Amazon Web Services + (AWS) Identity and Access Management (IAM) role. + properties: + atlasAWSAccountArn: + 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. + example: arn:aws:iam::772401394250:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + readOnly: true + atlasAssumedRoleExternalId: + type: string + format: uuid + description: Unique external ID that MongoDB Cloud uses when it assumes + the IAM role in your Amazon Web Services (AWS) account. + readOnly: true + authorizedDate: + type: string + format: date-time + 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. + readOnly: true + createdDate: + type: string + format: date-time + 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. + readOnly: true + featureUsages: + type: array + description: List that contains application features associated with this + Amazon Web Services (AWS) Identity and Access Management (IAM) role. + items: + $ref: "#/components/schemas/CloudProviderAccessFeatureUsage" + readOnly: true + providerName: + type: string + description: Human-readable label that identifies the cloud provider of + the role. + enum: + - AWS + - AZURE + - GCP + roleId: + type: string + description: Unique 24-hexadecimal digit string that identifies the role. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + required: + - providerName + CloudProviderAccessAWSIAMRoleRequestUpdate: + type: object + allOf: + - $ref: "#/components/schemas/CloudProviderAccessRoleRequestUpdate" + - type: object + properties: + atlasAWSAccountArn: + 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. + example: arn:aws:iam::772401394250:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + readOnly: true + atlasAssumedRoleExternalId: + type: string + format: uuid + description: Unique external ID that MongoDB Cloud uses when it assumes + the IAM role in your Amazon Web Services (AWS) account. + readOnly: true + authorizedDate: + type: string + format: date-time + 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. + readOnly: true + createdDate: + type: string + format: date-time + 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. + readOnly: true + featureUsages: + type: array + description: List that contains application features associated with this + Amazon Web Services (AWS) Identity and Access Management (IAM) role. + items: + $ref: "#/components/schemas/CloudProviderAccessFeatureUsage" + readOnly: true + iamAssumedRoleArn: + 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 + maxLength: 2048 + minLength: 20 + roleId: + type: string + description: Unique 24-hexadecimal digit string that identifies the role. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + description: Details that describe the features linked to the Amazon Web Services + (AWS) Identity and Access Management (IAM) role. + required: + - providerName CloudProviderAccessAzureServicePrincipal: type: object allOf: @@ -22983,6 +23710,133 @@ components: Principal. required: - providerName + CloudProviderAccessAzureServicePrincipalRequest: + type: object + description: Details that describe the features linked to the Azure Service + Principal. + properties: + _id: + type: string + description: Unique 24-hexadecimal digit string that identifies the role. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + atlasAzureAppId: + type: string + description: Azure Active Directory Application ID of Atlas. + maxLength: 36 + minLength: 32 + pattern: "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\\ + b-[0-9a-fA-F]{12}$" + createdDate: + type: string + format: date-time + description: Date and time when this Azure Service Principal was created. + This parameter expresses its value in the ISO 8601 timestamp format in + UTC. + readOnly: true + featureUsages: + type: array + description: List that contains application features associated with this + Azure Service Principal. + items: + $ref: "#/components/schemas/CloudProviderAccessFeatureUsage" + readOnly: true + lastUpdatedDate: + type: string + format: date-time + 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. + 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. + maxLength: 36 + minLength: 32 + pattern: "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\\ + b-[0-9a-fA-F]{12}$" + tenantId: + type: string + description: UUID String that identifies the Azure Active Directory Tenant + ID. + maxLength: 36 + minLength: 32 + pattern: "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\\ + b-[0-9a-fA-F]{12}$" + required: + - providerName + CloudProviderAccessAzureServicePrincipalRequestUpdate: + type: object + allOf: + - $ref: "#/components/schemas/CloudProviderAccessRoleRequestUpdate" + - type: object + properties: + _id: + type: string + description: Unique 24-hexadecimal digit string that identifies the role. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + atlasAzureAppId: + type: string + description: Azure Active Directory Application ID of Atlas. + maxLength: 36 + minLength: 32 + pattern: "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\\ + b-[0-9a-fA-F]{12}$" + createdDate: + type: string + format: date-time + description: Date and time when this Azure Service Principal was created. + This parameter expresses its value in the ISO 8601 timestamp format + in UTC. + readOnly: true + featureUsages: + type: array + description: List that contains application features associated with this + Azure Service Principal. + items: + $ref: "#/components/schemas/CloudProviderAccessFeatureUsage" + readOnly: true + lastUpdatedDate: + type: string + format: date-time + 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. + readOnly: true + servicePrincipalId: + type: string + description: UUID string that identifies the Azure Service Principal. + maxLength: 36 + minLength: 32 + pattern: "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\\ + b-[0-9a-fA-F]{12}$" + tenantId: + type: string + description: UUID String that identifies the Azure Active Directory Tenant + ID. + maxLength: 36 + minLength: 32 + pattern: "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\\ + b-[0-9a-fA-F]{12}$" + description: Details that describe the features linked to the Azure Service + Principal. + required: + - providerName CloudProviderAccessDataLakeFeatureUsage: type: object allOf: @@ -23095,6 +23949,85 @@ components: minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true + CloudProviderAccessGCPServiceAccount: + type: object + allOf: + - $ref: "#/components/schemas/CloudProviderAccessRole" + - type: object + properties: + createdDate: + type: string + format: date-time + description: Date and time when this Google Service Account was created. + This parameter expresses its value in the ISO 8601 timestamp format + in UTC. + readOnly: true + featureUsages: + type: array + description: List that contains application features associated with this + Google Service Account. + items: + $ref: "#/components/schemas/CloudProviderAccessFeatureUsage" + readOnly: true + gcpServiceAccountForAtlas: + type: string + description: Email address for the Google Service Account created by Atlas. + maxLength: 82 + minLength: 57 + pattern: "^mongodb-atlas-[0-9a-z]{16}@p-[0-9a-z]{24}.iam.gserviceaccount.com$" + roleId: + type: string + description: Unique 24-hexadecimal digit string that identifies the role. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + description: Details that describe the features linked to the GCP Service Account. + required: + - providerName + CloudProviderAccessGCPServiceAccountRequest: + type: object + description: Details that describe the features linked to the GCP Service Account. + properties: + createdDate: + type: string + format: date-time + description: Date and time when this GCP Service Account was created. This + parameter expresses its value in the ISO 8601 timestamp format in UTC. + readOnly: true + featureUsages: + type: array + description: List that contains application features associated with this + GCP Service Account. + items: + $ref: "#/components/schemas/CloudProviderAccessFeatureUsage" + readOnly: true + 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: + type: string + description: Unique 24-hexadecimal digit string that identifies the role. + readOnly: true + required: + - providerName + CloudProviderAccessGCPServiceAccountRequestUpdate: + type: object + allOf: + - $ref: "#/components/schemas/CloudProviderAccessRoleRequestUpdate" + description: Details that describe the features linked to the GCP Service Account. + required: + - providerName CloudProviderAccessPushBasedLogExportFeatureUsage: type: object allOf: @@ -23113,10 +24046,32 @@ components: mapping: AWS: "#/components/schemas/CloudProviderAccessAWSIAMRole" AZURE: "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + GCP: "#/components/schemas/CloudProviderAccessGCPServiceAccount" + propertyName: providerName + properties: + providerName: + type: string + description: Human-readable label that identifies the cloud provider of + the role. + enum: + - AWS + - AZURE + - GCP + required: + - providerName + CloudProviderAccessRoleRequest: + type: object + description: Cloud provider access role. + discriminator: + mapping: + AWS: "#/components/schemas/CloudProviderAccessAWSIAMRoleRequest" + AZURE: "#/components/schemas/CloudProviderAccessAzureServicePrincipalRequest" + GCP: "#/components/schemas/CloudProviderAccessGCPServiceAccountRequest" propertyName: providerName oneOf: - - $ref: "#/components/schemas/CloudProviderAccessAWSIAMRole" - - $ref: "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + - $ref: "#/components/schemas/CloudProviderAccessAWSIAMRoleRequest" + - $ref: "#/components/schemas/CloudProviderAccessAzureServicePrincipalRequest" + - $ref: "#/components/schemas/CloudProviderAccessGCPServiceAccountRequest" properties: providerName: type: string @@ -23125,6 +24080,27 @@ components: enum: - AWS - AZURE + - GCP + required: + - providerName + CloudProviderAccessRoleRequestUpdate: + type: object + description: Cloud provider access role. + discriminator: + mapping: + AWS: "#/components/schemas/CloudProviderAccessAWSIAMRoleRequestUpdate" + AZURE: "#/components/schemas/CloudProviderAccessAzureServicePrincipalRequestUpdate" + GCP: "#/components/schemas/CloudProviderAccessGCPServiceAccountRequestUpdate" + propertyName: providerName + properties: + providerName: + type: string + description: Human-readable label that identifies the cloud provider of + the role. + enum: + - AWS + - AZURE + - GCP required: - providerName CloudProviderAccessRoles: @@ -23136,6 +24112,12 @@ components: registered and authorized with MongoDB Cloud. items: $ref: "#/components/schemas/CloudProviderAccessAWSIAMRole" + azureServicePrincipals: + type: array + description: List that contains the Azure Service Principals registered + with MongoDB Cloud. + items: + $ref: "#/components/schemas/CloudProviderAccessAzureServicePrincipal" CloudProviderAzureAutoScaling: type: object description: Range of instance sizes to which your cluster can scale. @@ -23804,7 +24786,7 @@ components: example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -23908,6 +24890,7 @@ components: $ref: "#/components/schemas/ClusterComputeAutoScaling" diskGBEnabled: type: boolean + default: false description: Flag that indicates whether someone enabled disk auto-scaling for this cluster. title: Automatic Cluster Scaling Settings @@ -23934,12 +24917,14 @@ components: properties: enabled: type: boolean + default: false description: "Flag that indicates whether cluster tier auto-scaling is enabled.\ \ Set to `true` to enable cluster tier auto-scaling. If enabled, you must\ \ specify a value for **providerSettings.autoScaling.compute.maxInstanceSize**\ \ also. Set to `false` to disable cluster tier auto-scaling." scaleDownEnabled: type: boolean + default: false description: "Flag that indicates whether the cluster tier can scale down.\ \ This is required if **autoScaling.compute.enabled** is `true`. If you\ \ enable this option, specify a value for **providerSettings.autoScaling.compute.minInstanceSize**." @@ -23977,20 +24962,28 @@ components: 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. + description: "Private endpoint-aware connection strings that use AWS-hosted\ + \ clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies\ + \ an Amazon Web Services (AWS) interface endpoint. Each value identifies\ + \ the related `mongodb://` connection string that you use to connect\ + \ to Atlas through the interface endpoint that the key names. If the\ + \ cluster uses an optimized connection string, `awsPrivateLinkSrv` contains\ + \ the optimized connection string. If the cluster has the non-optimized\ + \ (legacy) connection string, `awsPrivateLinkSrv` contains the non-optimized\ + \ connection string even if an optimized connection string is also present." externalDocs: description: Network Peering Connection url: https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/ readOnly: true - 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. + description: "Private endpoint-aware connection strings that use AWS-hosted\ + \ clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies\ + \ an Amazon Web Services (AWS) interface endpoint. Each value identifies\ + \ the related `mongodb://` connection string that you use to connect to\ + \ Atlas through the interface endpoint that the key names. If the cluster\ + \ uses an optimized connection string, `awsPrivateLinkSrv` contains the\ + \ optimized connection string. If the cluster has the non-optimized (legacy)\ + \ connection string, `awsPrivateLinkSrv` contains the non-optimized connection\ + \ string even if an optimized connection string is also present." externalDocs: description: Network Peering Connection url: https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/ @@ -24092,6 +25085,31 @@ components: - REPLICASET - SHARDED - GEOSHARDED + configServerManagementMode: + type: string + default: ATLAS_MANAGED + description: |- + Config Server Management Mode for creating or updating a sharded cluster. + + When configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings. + + When configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server. + enum: + - ATLAS_MANAGED + - FIXED_TO_DEDICATED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + configServerType: + type: string + description: Describes a sharded cluster's config server type. + enum: + - DEDICATED + - EMBEDDED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + readOnly: true connectionStrings: $ref: "#/components/schemas/ClusterConnectionStrings" createDate: @@ -24125,6 +25143,15 @@ components: externalDocs: description: Encryption at Rest using Customer Key Management url: https://www.mongodb.com/docs/atlas/security-kms-encryption/ + featureCompatibilityVersion: + type: string + description: Feature compatibility version of the cluster. + readOnly: true + featureCompatibilityVersionExpirationDate: + type: string + format: date-time + description: Feature compatibility version expiration date. + readOnly: true globalClusterSelfManagedSharding: type: boolean description: |- @@ -24175,6 +25202,8 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true + mongoDBEmployeeAccessGrant: + $ref: "#/components/schemas/EmployeeAccessGrantView" mongoDBMajorVersion: type: string description: |- @@ -24196,7 +25225,7 @@ components: description: Human-readable label that identifies the cluster. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" paused: type: boolean description: Flag that indicates whether the cluster is paused. @@ -24207,6 +25236,35 @@ components: externalDocs: description: Continuous Cloud Backups url: https://docs.atlas.mongodb.com/backup/cloud-backup/overview/ + redactClientLogData: + type: boolean + description: Enable or disable log redaction. + externalDocs: + description: |- + This options corresponds to the ``security.redactClientLogData`` cluster parameter. + + This setting configures the ``mongod`` or ``mongos`` to redact any message accompanying a given log event before logging. This prevents the program from writing potentially sensitive data stored on the database to the diagnostic log. Metadata such as error or operation codes, line numbers, and source file names are still visible in the logs. + + Use ``redactClientLogData`` in conjunction with Encryption at Rest and TLS/SSL (Transport Encryption) to assist compliance with regulatory requirements. + url: https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.redactClientLogData + replicaSetScalingStrategy: + type: string + default: WORKLOAD_TYPE + description: |- + Set this field to configure the replica set scaling mode for your cluster. + + By default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes. + + When configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads. + + When configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads. + enum: + - SEQUENTIAL + - WORKLOAD_TYPE + - NODE_TYPE + externalDocs: + description: Modify the Replica Set Scaling Mode + url: https://dochub.mongodb.org/core/scale-nodes replicationSpecs: type: array description: List of settings that configure your cluster regions. This @@ -24332,6 +25390,24 @@ components: ClusterDescriptionProcessArgs: type: object properties: + changeStreamOptionsPreAndPostImagesExpireAfterSeconds: + type: integer + format: int32 + default: -1 + description: The minimum pre- and post-image retention time in seconds. + externalDocs: + description: "This option corresponds to the ``changeStreamOptions.preAndPostImages.expireAfterSeconds``\ + \ cluster parameter. This setting controls the retention policy of change\ + \ stream pre- and post-images. Pre- and post-images are the versions\ + \ of a document before and after document modification, respectively.\ + \ ``expireAfterSeconds`` controls how long MongoDB retains pre- and\ + \ post-images. When set to -1 (off), MongoDB uses the default retention\ + \ policy: pre- and post-images are retained until the corresponding\ + \ change stream events are removed from the oplog. To set the minimum\ + \ pre- and post-image retention time, specify an integer value greater\ + \ than zero. Setting this too low could increase the risk of interrupting\ + \ Realm sync or triggers processing. The default value is -1 (off)." + url: https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/changeStreamOptions/#mongodb-parameter-param.changeStreamOptions.preAndPostImages.expireAfterSeconds chunkMigrationConcurrency: type: integer format: int32 @@ -24342,6 +25418,14 @@ components: description: This option corresponds to the `chunkMigrationConcurrency` `mongod` configuration file option. url: https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.chunkMigrationConcurrency + defaultMaxTimeMS: + type: integer + format: int32 + description: Default time limit in milliseconds for individual read operations + to complete. + externalDocs: + description: This option corresponds to the defaultMaxTimeMS cluster parameter. + url: https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/defaultMaxTimeMS/ defaultReadConcern: type: string default: available @@ -24378,8 +25462,10 @@ components: url: https://docs.mongodb.com/upcoming/reference/parameters/#mongodb-parameter-param.failIndexKeyTooLong javascriptEnabled: type: boolean - description: Flag that indicates whether the cluster allows execution of - operations that perform server-side executions of JavaScript. + 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. @@ -24472,6 +25558,24 @@ components: ClusterDescriptionProcessArgs20240805: type: object properties: + changeStreamOptionsPreAndPostImagesExpireAfterSeconds: + type: integer + format: int32 + default: -1 + description: The minimum pre- and post-image retention time in seconds. + externalDocs: + description: "This option corresponds to the ``changeStreamOptions.preAndPostImages.expireAfterSeconds``\ + \ cluster parameter. This setting controls the retention policy of change\ + \ stream pre- and post-images. Pre- and post-images are the versions\ + \ of a document before and after document modification, respectively.\ + \ ``expireAfterSeconds`` controls how long MongoDB retains pre- and\ + \ post-images. When set to -1 (off), MongoDB uses the default retention\ + \ policy: pre- and post-images are retained until the corresponding\ + \ change stream events are removed from the oplog. To set the minimum\ + \ pre- and post-image retention time, specify an integer value greater\ + \ than zero. Setting this too low could increase the risk of interrupting\ + \ Realm sync or triggers processing. The default value is -1 (off)." + url: https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/changeStreamOptions/#mongodb-parameter-param.changeStreamOptions.preAndPostImages.expireAfterSeconds chunkMigrationConcurrency: type: integer format: int32 @@ -24482,6 +25586,14 @@ components: description: This option corresponds to the `chunkMigrationConcurrency` `mongod` configuration file option. url: https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.chunkMigrationConcurrency + defaultMaxTimeMS: + type: integer + format: int32 + description: Default time limit in milliseconds for individual read operations + to complete. + externalDocs: + description: This option corresponds to the defaultMaxTimeMS cluster parameter. + url: https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/defaultMaxTimeMS/ defaultWriteConcern: type: string description: Default level of acknowledgment requested from MongoDB for @@ -24492,8 +25604,10 @@ components: url: https://docs.mongodb.com/manual/reference/write-concern/ javascriptEnabled: type: boolean - description: Flag that indicates whether the cluster allows execution of - operations that perform server-side executions of JavaScript. + 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. @@ -24778,7 +25892,7 @@ components: outage simulation. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true groupId: type: string @@ -25593,6 +26707,7 @@ components: mapping: AWS: "#/components/schemas/AWSCreateDataProcessRegionView" AZURE: "#/components/schemas/AzureCreateDataProcessRegionView" + GCP: "#/components/schemas/GCPCreateDataProcessRegionView" propertyName: cloudProvider properties: cloudProvider: @@ -26075,11 +27190,11 @@ components: roleId: type: string description: Unique identifier of the role that Data Federation can use - to access the data stores.Required if specifying cloudProviderConfig. + to access the data stores. Required if specifying cloudProviderConfig. servicePrincipalId: type: string description: The ID of the Service Principal for which there is an access - policyfor Atlas to access Azure resources. + policy for Atlas to access Azure resources. readOnly: true tenantId: type: string @@ -26088,6 +27203,22 @@ components: readOnly: true required: - roleId + DataFederationGCPCloudProviderConfig: + type: object + description: Configuration for running Data Federation in GCP. + 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: + type: string + description: Unique identifier of the role that Data Federation can use + to access the data stores. Required if specifying cloudProviderConfig. + required: + - roleId DataFederationLimit: type: object description: Details of user managed limits. @@ -26095,6 +27226,7 @@ components: mapping: atlas.project.deployment.clusters: "#/components/schemas/DefaultLimit" atlas.project.deployment.nodesPerPrivateLinkRegion: "#/components/schemas/DefaultLimit" + atlas.project.deployment.salesSoldM0s: "#/components/schemas/DefaultLimit" atlas.project.deployment.serverlessMTMs: "#/components/schemas/DefaultLimit" atlas.project.security.databaseAccess.customRoles: "#/components/schemas/DefaultLimit" atlas.project.security.databaseAccess.users: "#/components/schemas/DefaultLimit" @@ -26465,7 +27597,9 @@ components: $ref: "#/components/schemas/DataLakeAWSCloudProviderConfig" azure: $ref: "#/components/schemas/DataFederationAzureCloudProviderConfig" - title: Data Lake Cloud Provider + gcp: + $ref: "#/components/schemas/DataFederationGCPCloudProviderConfig" + title: Data Federation Cloud Provider DataLakeDLSAWSStore: type: object allOf: @@ -26590,6 +27724,7 @@ components: enum: - AWS - AZURE + - GCP region: $ref: "#/components/schemas/BaseAtlasDataLakeRegion" required: @@ -27066,7 +28201,7 @@ components: example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -27325,7 +28460,12 @@ components: enum: - AVERAGE operator: - $ref: "#/components/schemas/Operator" + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - LESS_THAN + - GREATER_THAN threshold: type: number format: double @@ -27373,6 +28513,7 @@ components: mapping: AWS: "#/components/schemas/AWSDataProcessRegionView" AZURE: "#/components/schemas/AzureDataProcessRegionView" + GCP: "#/components/schemas/GCPDataProcessRegionView" propertyName: cloudProvider properties: cloudProvider: @@ -27382,6 +28523,7 @@ components: enum: - AWS - AZURE + - GCP readOnly: true readOnly: true DataProtectionSettings: @@ -27673,6 +28815,8 @@ components: - SQL_SET_SCHEMA - VIEW_ALL_HISTORY - OUT_TO_S3 + - OUT_TO_AZURE + - OUT_TO_GCS - STORAGE_GET_CONFIG - STORAGE_SET_CONFIG - FLUSH_ROUTER_CONFIG @@ -28032,6 +29176,7 @@ components: - FTS_INDEX_BUILD_COMPLETE - FTS_INDEX_BUILD_FAILED - FTS_INDEXES_RESTORE_FAILED + - FTS_INDEXES_SYNONYM_MAPPING_INVALID title: FTS Index Audit Types - type: string enum: @@ -28232,6 +29377,7 @@ components: - FTS_INDEX_BUILD_COMPLETE - FTS_INDEX_BUILD_FAILED - FTS_INDEXES_RESTORE_FAILED + - FTS_INDEXES_SYNONYM_MAPPING_INVALID title: FTS Index Audit Types - type: string enum: @@ -28687,11 +29833,14 @@ components: - CLUSTER_VERSION_UNFIXED - CLUSTER_FCV_FIXED - CLUSTER_FCV_UNFIXED + - CLUSTER_FCV_EXPIRATION_DATE_UPDATED - AGENT_VERSION_FIXED - AGENT_VERSION_UNFIXED - FIXED_VERSION_UPDATED - FIXED_AGENT_VERSION_UPDATED - CLUSTER_FCV_DOWNGRADED + - CLUSTER_BINARY_VERSION_DOWNGRADED + - CLUSTER_BINARY_VERSION_UPGRADED title: Version Audit Types groupId: type: string @@ -29079,7 +30228,6 @@ components: pattern: "^([a-f0-9]{24})$" hostnameSchemaType: type: string - default: PUBLIC description: The network type to use between the migration host and the destination cluster. enum: @@ -29280,30 +30428,19 @@ components: createdAt: type: string format: date-time - description: Date and time when someone created this export job. MongoDB - Cloud represents this timestamp in ISO 8601 format in UTC. + description: Date and time when a user or Atlas created the Export Job. + MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. readOnly: true customData: type: array description: Collection of key-value pairs that represent custom data for - the metadata file that MongoDB Cloud uploads to the bucket when the export - job finishes. + the metadata file that MongoDB Cloud uploads when the Export Job finishes. items: $ref: "#/components/schemas/BackupLabel" - 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\"`." - items: - type: string - description: One Uniform Resource Locator that point to the compressed - snapshot files for manual download. - readOnly: true exportBucketId: type: string description: Unique 24-hexadecimal character string that identifies the - Export Bucket to export to. + Export Bucket. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 @@ -29314,7 +30451,7 @@ components: finishedAt: type: string format: date-time - description: Date and time when this export job completed. MongoDB Cloud + description: Date and time when this Export Job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. readOnly: true id: @@ -29339,8 +30476,8 @@ components: readOnly: true prefix: type: string - description: Full path on the cloud provider bucket to the folder where - the snapshot is exported. + description: Prefix used for all blob storage objects uploaded as part of + the Export Job. pattern: "/exported_snapshots/\\{ORG-NAME\\}/\\{PROJECT-NAME\\}/\\{CLUSTER-NAME\\\ }/\\{SNAPSHOT-INITIATION-DATE\\}/\\{TIMESTAMP\\}" readOnly: true @@ -29354,7 +30491,7 @@ components: pattern: "^([a-f0-9]{24})$" state: type: string - description: State of the export job. + description: State of the Export Job. enum: - Cancelled - Failed @@ -29377,7 +30514,7 @@ components: exportBucketId: type: string description: Unique 24-hexadecimal character string that identifies the - Export Bucket to export to. + Export Bucket. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 @@ -29584,10 +30721,19 @@ components: properties: downloadUrl: type: string - description: "One Uniform Resource Locator that point to the compressed\ + 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." + items: + $ref: "#/components/schemas/ApiPrivateDownloadDeliveryUrl" + readOnly: true replicaSetName: type: string description: Human-readable label that identifies the replica set on the @@ -30039,7 +31185,7 @@ components: \ this parameter when `\"deliveryType\" : \"download\"`." items: type: string - description: One Uniform Resource Locator that point to the compressed + description: One Uniform Resource Locator that points to the compressed snapshot files for manual download. readOnly: true desiredTimestamp: @@ -30111,6 +31257,15 @@ components: \ when `\"deliveryType\" : \"pointInTime\"` and **pointInTimeUTCSeconds**\ \ exceeds `0`." minimum: 1199145600 + 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." + items: + $ref: "#/components/schemas/ApiPrivateDownloadDeliveryUrl" + readOnly: true snapshotId: type: string description: Unique 24-hexadecimal character string that identifies the @@ -30127,7 +31282,7 @@ components: and `pointInTime` restore types. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" targetGroupId: type: string description: Unique 24-hexadecimal digit string that identifies the target @@ -30168,7 +31323,7 @@ components: you want to return. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true copySettings: type: array @@ -30262,7 +31417,7 @@ components: you want to return. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true copySettings: type: array @@ -30348,8 +31503,12 @@ components: additionalProperties: type: object description: The stats associated with the stream processor. + externalDocs: + url: https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor readOnly: true description: The stats associated with the stream processor. + externalDocs: + url: https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor readOnly: true EARPrivateEndpoint: type: object @@ -30444,6 +31603,8 @@ components: - PENDING_ACCEPTANCE - ACTIVE - FAILED + - PENDING_RECREATION + - DELETING readOnly: true title: Encryption At Rest Private Endpoint EmailNotification: @@ -30490,6 +31651,36 @@ components: required: - typeName title: Email Notification + EmployeeAccessGrantView: + type: object + description: MongoDB employee granted access level and expiration for a cluster. + properties: + expirationTime: + type: string + format: date-time + description: Expiration date for the employee access grant. + 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." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + readOnly: true + required: + - expirationTime + - grantType EncryptionAtRest: type: object properties: @@ -30499,24 +31690,6 @@ components: $ref: "#/components/schemas/AzureKeyVault" googleCloudKms: $ref: "#/components/schemas/GoogleCloudKMS" - EncryptionAtRestPrivateEndpointRequest: - type: object - description: Create or delete private endpoints from the specified regions list. - properties: - cloudProvider: - type: string - description: Cloud service provider name. - enum: - - AZURE - regions: - type: array - description: List of regions. - items: - type: string - uniqueItems: true - required: - - cloudProvider - title: Encryption At Rest Private Endpoints setup. EncryptionKeyAlertConfigViewForNdsGroup: type: object description: Encryption key alert configuration allows to select thresholds which @@ -30863,6 +32036,7 @@ components: - FTS_INDEX_CLEANED_UP - FTS_INDEXES_RESTORED - FTS_INDEXES_RESTORE_FAILED + - FTS_INDEXES_SYNONYM_MAPPING_INVALID title: FTS Index Audit Types - type: string enum: @@ -30916,6 +32090,8 @@ components: - HOST_HAS_INDEX_SUGGESTIONS - HOST_MONGOT_RECOVERED_OOM - HOST_MONGOT_CRASHING_OOM + - HOST_MONGOT_RESUME_REPLICATION + - HOST_MONGOT_STOP_REPLICATION - HOST_ENOUGH_DISK_SPACE - HOST_NOT_ENOUGH_DISK_SPACE title: Host Event Types @@ -30953,6 +32129,7 @@ components: - 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 @@ -31030,6 +32207,8 @@ components: - 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 @@ -31059,6 +32238,9 @@ components: - 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 @@ -31117,9 +32299,13 @@ components: - 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 title: NDS Audit Types - type: string enum: @@ -31316,11 +32502,14 @@ components: - CLUSTER_VERSION_UNFIXED - CLUSTER_FCV_FIXED - CLUSTER_FCV_UNFIXED + - CLUSTER_FCV_EXPIRATION_DATE_UPDATED - AGENT_VERSION_FIXED - AGENT_VERSION_UNFIXED - FIXED_VERSION_UPDATED - FIXED_AGENT_VERSION_UPDATED - CLUSTER_FCV_DOWNGRADED + - CLUSTER_BINARY_VERSION_DOWNGRADED + - CLUSTER_BINARY_VERSION_UPGRADED title: Version Audit Types - type: string enum: @@ -31596,6 +32785,12 @@ components: enum: - GROUP_TAGS_MODIFIED title: Resource Event Types + - type: string + enum: + - RESOURCE_POLICY_CREATED + - RESOURCE_POLICY_MODIFIED + - RESOURCE_POLICY_DELETED + title: Atlas Resource Policy Audit Types EventViewForNdsGroup: type: object oneOf: @@ -31637,6 +32832,7 @@ components: - $ref: "#/components/schemas/TeamEvent" - $ref: "#/components/schemas/UserEventViewForOrg" - $ref: "#/components/schemas/ResourceEventViewForOrg" + - $ref: "#/components/schemas/AtlasResourcePolicyAuditForOrg" ExampleResourceResponse20230101: type: object properties: @@ -31686,8 +32882,7 @@ components: - description ExportStatus: type: object - description: State of the export job for the collections on the replica set - only. + description: State of the Export Job. properties: exportedCollections: type: integer @@ -31733,6 +32928,7 @@ components: - FTS_INDEX_CLEANED_UP - FTS_INDEXES_RESTORED - FTS_INDEXES_RESTORE_FAILED + - FTS_INDEXES_SYNONYM_MAPPING_INVALID example: FTS_INDEX_CREATED title: FTS Index Audit Types FTSIndexAuditView: @@ -32660,37 +33856,52 @@ components: enum: - EXCLUDE title: Field Transformation - ForNdsGroup: + FieldViolation: type: object - description: ReplicaSet Event identifies different activities about replica - set of mongod instances. properties: - created: + description: type: string - format: date-time - description: Date and time when this event occurred. This parameter expresses - its value in the ISO 8601 timestamp format in UTC. + 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. + required: + - description + - field + FlexBackupRestoreJob20250101: + type: object + description: Details for one restore job of a flex cluster. + properties: + deliveryType: + type: string + description: Means by which this resource returns the snapshot to the requesting + MongoDB Cloud user. + enum: + - RESTORE + - DOWNLOAD readOnly: true - eventTypeName: - $ref: "#/components/schemas/ReplicaSetEventTypeViewForNdsGroup" - groupId: + expirationDate: type: string - description: Unique 24-hexadecimal digit string that identifies the project - in which the event occurred. The **eventId** identifies the specific event. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" + format: date-time + description: Date and time when the download link no longer works. This + parameter expresses its value in the ISO 8601 timestamp format in UTC. readOnly: true id: type: string - description: Unique 24-hexadecimal digit string that identifies the event. + description: Unique 24-hexadecimal digit string that identifies the restore + job. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true + instanceName: + type: string + description: Human-readable label that identifies the source instance. + maxLength: 64 + minLength: 1 + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + readOnly: true links: type: array description: "List of one or more Uniform Resource Locators (URLs) that\ @@ -32702,296 +33913,914 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true - orgId: + projectId: type: string - description: Unique 24-hexadecimal digit string that identifies the organization - to which these events apply. + description: Unique 24-hexadecimal digit string that identifies the project + from which the restore job originated. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true - port: - type: integer - format: int32 - description: IANA port on which the MongoDB process listens for requests. - example: 27017 - readOnly: true - raw: - $ref: "#/components/schemas/raw" - replicaSetName: + restoreFinishedDate: type: string - description: Human-readable label of the replica set associated with the - event. - example: event-replica-set + format: date-time + 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. readOnly: true - shardName: + restoreScheduledDate: type: string - description: Human-readable label of the shard associated with the event. - example: event-sh-01 + format: date-time + description: Date and time when MongoDB Cloud will restore this snapshot. + This parameter expresses its value in the ISO 8601 timestamp format in + UTC. readOnly: true - required: - - created - - eventTypeName - - id - title: ReplicaSet Events - GCPCloudProviderContainer: - type: object - allOf: - - $ref: "#/components/schemas/CloudProviderContainer" - - type: object - properties: - atlasCidrBlock: - type: string - description: |- - IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project. - - These CIDR blocks must fall within the ranges reserved per RFC 1918. GCP further limits the block to a lower bound of the `/18` range. - - To modify the CIDR block, the target project cannot have: - - - Any M10 or greater clusters - - Any other VPC peering connections - - You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project. - - **Example:** A project in an Google Cloud (GCP) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets. - pattern: "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" - gcpProjectId: - 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. - maxLength: 26 - minLength: 26 - pattern: "^p-[0-9a-z]{24}$" - readOnly: true - networkName: - 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. - maxLength: 36 - minLength: 36 - pattern: "^nt-[0-9a-f]{24}-[0-9a-z]{8}$" - 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." - 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." - 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 - description: Collection of settings that configures the network container for - a virtual private connection on Amazon Web Services. - required: - - atlasCidrBlock - title: GCP - GCPComputeAutoScaling: - type: object - description: Collection of settings that configures how a cluster might scale - its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling - is unavailable for clusters using Low CPU or NVME storage classes. - properties: - maxInstanceSize: - type: string - description: Maximum instance size to which your cluster can automatically - scale. - enum: - - M10 - - M20 - - M30 - - M40 - - M50 - - M60 - - M80 - - M140 - - M200 - - M250 - - M300 - - M400 - - R40 - - R50 - - R60 - - R80 - - R200 - - R300 - - R400 - - R600 - title: GCP Instance Sizes - minInstanceSize: + snapshotFinishedDate: 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 - title: GCP Instance Sizes - title: GCP - GCPConsumerForwardingRule: - type: object - properties: - endpointName: + format: date-time + description: Date and time when MongoDB Cloud completed writing this snapshot. + This parameter expresses its value in the ISO 8601 timestamp format in + UTC. + readOnly: true + snapshotId: type: string - description: Human-readable label that identifies the Google Cloud consumer - forwarding rule that you created. - externalDocs: - description: Google Cloud Forwarding Rule Concepts - url: https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts + description: Unique 24-hexadecimal digit string that identifies the snapshot + to restore. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" readOnly: true - ipAddress: + snapshotUrl: type: string - description: One Private Internet Protocol version 4 (IPv4) address to which - this Google Cloud consumer forwarding rule resolves. - pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + 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: State of the MongoDB Cloud endpoint group when MongoDB Cloud - received this request. + description: Phase of the restore workflow for this job at the time this + resource made this request. enum: - - INITIATING - - AVAILABLE + - PENDING + - QUEUED + - RUNNING - FAILED - - DELETING + - COMPLETED readOnly: true - GCPEndpointService: + targetDeploymentItemName: + type: string + description: Human-readable label that identifies the instance or cluster + on the target project to which you want to restore the snapshot. You can + restore the snapshot to another USS instance or Dedicated cluster tier. + maxLength: 64 + minLength: 1 + pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + readOnly: true + targetProjectId: + type: string + description: Unique 24-hexadecimal digit string that identifies the project + that contains the instance or cluster to which you want to restore the + snapshot. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + title: Flex Backup Restore Job + FlexBackupRestoreJobCreate20250101: type: object - description: Group of Private Endpoint Service settings. + description: Details to create one restore job of a flex cluster. properties: - cloudProvider: + _snapshotId: type: string - description: Cloud service provider that serves the requested endpoint service. + description: Unique 24-hexadecimal digit string that identifies the snapshot + to restore. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + writeOnly: true + _targetDeploymentItemName: + type: string + description: Human-readable label that identifies the instance or cluster + on the target project to which you want to restore the snapshot. You can + restore the snapshot to another flex cluster or dedicated cluster tier. + maxLength: 64 + minLength: 1 + pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + writeOnly: true + _targetProjectId: + type: string + description: Unique 24-hexadecimal digit string that identifies the project + that contains the instance or cluster to which you want to restore the + snapshot. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + writeOnly: true + deliveryType: + type: string + description: Means by which this resource returns the snapshot to the requesting + MongoDB Cloud user. enum: - - AWS - - AZURE - - GCP + - RESTORE + - DOWNLOAD readOnly: true - 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 - items: - type: string - description: One Google Cloud network endpoint group that corresponds - to the Private Service Connect endpoint service. - errorMessage: + expirationDate: type: string - description: Error message returned when requesting private connection resource. - The resource returns `null` if the request succeeded. + format: date-time + description: Date and time when the download link no longer works. This + parameter expresses its value in the ISO 8601 timestamp format in UTC. readOnly: true id: type: string - description: Unique 24-hexadecimal digit string that identifies the Private - Endpoint Service. + description: Unique 24-hexadecimal digit string that identifies the restore + job. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true - regionName: + instanceName: type: string - description: Cloud provider region that manages this Private Endpoint Service. + description: Human-readable label that identifies the source instance. + maxLength: 64 + minLength: 1 + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true - serviceAttachmentNames: + links: 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. + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." externalDocs: - description: Google Cloud Private Service Connect Service Attachments - url: https://cloud.google.com/vpc/docs/private-service-connect#service-attachments + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 items: - 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. - 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\\-]+" + $ref: "#/components/schemas/Link" + readOnly: true + projectId: + type: string + description: Unique 24-hexadecimal digit string that identifies the project + from which the restore job originated. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + restoreFinishedDate: + type: string + format: date-time + 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. + readOnly: true + restoreScheduledDate: + type: string + format: date-time + description: Date and time when MongoDB Cloud will restore this snapshot. + This parameter expresses its value in the ISO 8601 timestamp format in + UTC. + readOnly: true + snapshotFinishedDate: + type: string + format: date-time + description: Date and time when MongoDB Cloud completed writing this snapshot. + This parameter expresses its value in the ISO 8601 timestamp format in + UTC. + readOnly: true + 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: State of the Private Endpoint Service connection when MongoDB - Cloud received this request. + description: Phase of the restore workflow for this job at the time this + resource made this request. enum: - - INITIATING - - AVAILABLE - - WAITING_FOR_USER + - PENDING + - QUEUED + - RUNNING - FAILED - - DELETING + - COMPLETED readOnly: true required: - - cloudProvider - title: GCP - GCPHardwareSpec: + - _snapshotId + - _targetDeploymentItemName + title: Create Flex Backup Restore Job + FlexBackupSettings20250101: type: object + description: Flex backup configuration properties: - instanceSize: + enabled: + type: boolean + default: true + description: "Flag that indicates whether backups are performed for this\ + \ flex cluster. Backup uses [TODO](TODO) for flex clusters." + readOnly: true + readOnly: true + title: Flex Backup Configuration + FlexBackupSnapshot20250101: + type: object + description: Details for one snapshot of a flex cluster. + properties: + expiration: + type: string + format: date-time + description: Date and time when the download link no longer works. This + parameter expresses its value in the ISO 8601 timestamp format in UTC. + readOnly: true + finishTime: + type: string + format: date-time + description: Date and time when MongoDB Cloud completed writing this snapshot. + This parameter expresses its value in the ISO 8601 timestamp format in + UTC. + readOnly: true + id: + type: string + description: Unique 24-hexadecimal digit string that identifies the snapshot. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + mongoDBVersion: + type: string + description: MongoDB host version that the snapshot runs. + readOnly: true + scheduledTime: + type: string + format: date-time + description: Date and time when MongoDB Cloud will take the snapshot. This + parameter expresses its value in the ISO 8601 timestamp format in UTC. + readOnly: true + startTime: + type: string + format: date-time + description: Date and time when MongoDB Cloud began taking the snapshot. + This parameter expresses its value in the ISO 8601 timestamp format in + UTC. + readOnly: true + status: + type: string + description: Phase of the workflow for this snapshot at the time this resource + made this request. + enum: + - PENDING + - QUEUED + - RUNNING + - FAILED + - COMPLETED + readOnly: true + title: Flex Backup Snapshot + FlexBackupSnapshotDownloadCreate20250101: + type: object + description: Details for one backup snapshot download of a flex cluster. + properties: + _snapshotId: + type: string + description: Unique 24-hexadecimal digit string that identifies the snapshot + to download. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + writeOnly: true + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + required: + - _snapshotId + title: Flex Backup Snapshot Download Create + FlexClusterDescription20250101: + type: object + description: Group of settings that configure a MongoDB Flex cluster. + properties: + backupSettings: + $ref: "#/components/schemas/FlexBackupSettings20250101" + clusterType: + type: string + description: Flex cluster topology. + enum: + - REPLICASET + - LOADBALANCED + readOnly: true + connectionStrings: + $ref: "#/components/schemas/FlexConnectionStrings20250101" + createDate: + type: string + format: date-time + description: Date and time when MongoDB Cloud created this instance. This + parameter expresses its value in ISO 8601 format in UTC. + readOnly: true + groupId: + type: string + description: Unique 24-hexadecimal character string that identifies the + project. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + id: + type: string + description: Unique 24-hexadecimal digit string that identifies the instance. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + mongoDBVersion: + type: string + description: Version of MongoDB that the instance runs. + pattern: "([\\d]+\\.[\\d]+\\.[\\d]+)" + readOnly: true + name: + type: string + description: Human-readable label that identifies the instance. + maxLength: 64 + minLength: 1 + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + readOnly: true + providerSettings: + $ref: "#/components/schemas/FlexProviderSettings20250101" + stateName: + type: string + description: Human-readable label that indicates the current operating condition + of this instance. + enum: + - IDLE + - CREATING + - UPDATING + - DELETING + - REPAIRING + readOnly: true + tags: + type: array + description: List that contains key-value pairs between 1 to 255 characters + in length for tagging and categorizing the instance. + externalDocs: + description: Resource Tags + url: https://dochub.mongodb.org/core/add-cluster-tag-atlas + items: + $ref: "#/components/schemas/ResourceTag" + terminationProtectionEnabled: + type: boolean + default: false + description: "Flag that indicates whether termination protection is enabled\ + \ on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster.\ + \ If set to `false`, MongoDB Cloud will delete the cluster." + versionReleaseSystem: + type: string + default: LTS + description: Method by which the cluster maintains the MongoDB versions. + enum: + - LTS + readOnly: true + required: + - providerSettings + title: Flex Cluster Description + FlexClusterDescriptionCreate20250101: + type: object + description: Settings that you can specify when you create a flex cluster. + properties: + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + name: + type: string + description: Human-readable label that identifies the instance. + maxLength: 64 + minLength: 1 + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + writeOnly: true + providerSettings: + $ref: "#/components/schemas/FlexProviderSettingsCreate20250101" + tags: + type: array + description: List that contains key-value pairs between 1 to 255 characters + in length for tagging and categorizing the instance. + externalDocs: + description: Resource Tags + url: https://dochub.mongodb.org/core/add-cluster-tag-atlas + items: + $ref: "#/components/schemas/ResourceTag" + terminationProtectionEnabled: + type: boolean + default: false + description: "Flag that indicates whether termination protection is enabled\ + \ on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster.\ + \ If set to `false`, MongoDB Cloud will delete the cluster." + required: + - name + - providerSettings + title: Flex Cluster Description Create + FlexConnectionStrings20250101: + type: object + description: Collection of Uniform Resource Locators that point to the MongoDB + database. + externalDocs: + description: Connection string URI format. + url: https://docs.mongodb.com/manual/reference/connection-string/ + properties: + standard: + type: string + description: Public connection string that you can use to connect to this + cluster. This connection string uses the mongodb:// protocol. + externalDocs: + description: Connection String URI Format + url: https://docs.mongodb.com/manual/reference/connection-string/ + readOnly: true + standardSrv: + type: string + description: Public connection string that you can use to connect to this + flex cluster. This connection string uses the `mongodb+srv://` protocol. + externalDocs: + description: Connection String URI Format + url: https://docs.mongodb.com/manual/reference/connection-string/ + readOnly: true + readOnly: true + title: Flex Cluster Connection Strings + FlexProviderSettings20250101: + type: object + description: Group of cloud provider settings that configure the provisioned + MongoDB flex cluster. + properties: + backingProviderName: + type: string + description: Cloud service provider on which MongoDB Cloud provisioned the + flex cluster. + enum: + - AWS + - AZURE + - GCP + readOnly: true + diskSizeGB: + type: number + format: double + description: Storage capacity available to the flex cluster expressed in + gigabytes. + readOnly: true + providerName: + type: string + default: FLEX + description: Human-readable label that identifies the cloud service provider. + enum: + - FLEX + readOnly: true + regionName: + type: string + description: "Human-readable label that identifies the geographic location\ + \ of your MongoDB flex cluster. The region you choose can affect network\ + \ latency for clients accessing your databases. For a complete list of\ + \ region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws),\ + \ [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/)." + readOnly: true + readOnly: true + title: Cloud Service Provider Settings for a Flex Cluster + FlexProviderSettingsCreate20250101: + type: object + description: Group of cloud provider settings that configure the provisioned + MongoDB flex cluster. + properties: + backingProviderName: + type: string + description: Cloud service provider on which MongoDB Cloud provisioned the + flex cluster. + enum: + - AWS + - AZURE + - GCP + writeOnly: true + diskSizeGB: + type: number + format: double + description: Storage capacity available to the flex cluster expressed in + gigabytes. + readOnly: true + providerName: + type: string + default: FLEX + description: Human-readable label that identifies the cloud service provider. + enum: + - FLEX + readOnly: true + regionName: + type: string + description: "Human-readable label that identifies the geographic location\ + \ of your MongoDB flex cluster. The region you choose can affect network\ + \ latency for clients accessing your databases. For a complete list of\ + \ region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws),\ + \ [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/)." + writeOnly: true + required: + - backingProviderName + - regionName + title: Cloud Service Provider Settings for a Flex Cluster + writeOnly: true + ForNdsGroup: + type: object + description: ReplicaSet Event identifies different activities about replica + set of mongod instances. + properties: + created: + type: string + format: date-time + description: Date and time when this event occurred. This parameter expresses + its value in the ISO 8601 timestamp format in UTC. + readOnly: true + eventTypeName: + $ref: "#/components/schemas/ReplicaSetEventTypeViewForNdsGroup" + groupId: + type: string + description: Unique 24-hexadecimal digit string that identifies the project + in which the event occurred. The **eventId** identifies the specific event. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + id: + type: string + description: Unique 24-hexadecimal digit string that identifies the event. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + orgId: + type: string + description: Unique 24-hexadecimal digit string that identifies the organization + to which these events apply. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + port: + type: integer + format: int32 + description: IANA port on which the MongoDB process listens for requests. + example: 27017 + readOnly: true + raw: + $ref: "#/components/schemas/raw" + replicaSetName: + type: string + description: Human-readable label of the replica set associated with the + event. + example: event-replica-set + readOnly: true + shardName: + type: string + description: Human-readable label of the shard associated with the event. + example: event-sh-01 + readOnly: true + required: + - created + - eventTypeName + - id + title: ReplicaSet Events + GCPCloudProviderContainer: + type: object + allOf: + - $ref: "#/components/schemas/CloudProviderContainer" + - type: object + properties: + atlasCidrBlock: + type: string + description: |- + IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project. + + These CIDR blocks must fall within the ranges reserved per RFC 1918. GCP further limits the block to a lower bound of the `/18` range. + + To modify the CIDR block, the target project cannot have: + + - Any M10 or greater clusters + - Any other VPC peering connections + + You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project. + + **Example:** A project in an Google Cloud (GCP) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets. + pattern: "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + gcpProjectId: + 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. + maxLength: 26 + minLength: 26 + pattern: "^p-[0-9a-z]{24}$" + readOnly: true + networkName: + 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. + maxLength: 36 + minLength: 36 + pattern: "^nt-[0-9a-f]{24}-[0-9a-z]{8}$" + 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." + 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." + 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 + description: Collection of settings that configures the network container for + a virtual private connection on Amazon Web Services. + required: + - atlasCidrBlock + title: GCP + GCPComputeAutoScaling: + type: object + description: Collection of settings that configures how a cluster might scale + its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling + is unavailable for clusters using Low CPU or NVME storage classes. + properties: + maxInstanceSize: + type: string + description: Maximum instance size to which your cluster can automatically + scale. + enum: + - M10 + - M20 + - M30 + - M40 + - M50 + - M60 + - M80 + - M140 + - M200 + - M250 + - M300 + - M400 + - R40 + - R50 + - R60 + - R80 + - R200 + - R300 + - R400 + - R600 + title: GCP Instance Sizes + minInstanceSize: + 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 + title: GCP Instance Sizes + title: GCP + GCPConsumerForwardingRule: + type: object + properties: + endpointName: + type: string + description: Human-readable label that identifies the Google Cloud consumer + forwarding rule that you created. + externalDocs: + description: Google Cloud Forwarding Rule Concepts + url: https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts + readOnly: true + ipAddress: + type: string + description: One Private Internet Protocol version 4 (IPv4) address to which + this Google Cloud consumer forwarding rule resolves. + pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + readOnly: true + status: + type: string + description: State of the MongoDB Cloud endpoint group when MongoDB Cloud + received this request. + enum: + - INITIATING + - AVAILABLE + - FAILED + - DELETING + readOnly: true + 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 + 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. + enum: + - CENTRAL_US + - WESTERN_EUROPE + readOnly: true + GCPEndpointService: + type: object + description: Group of Private Endpoint Service settings. + properties: + cloudProvider: + type: string + description: Cloud service provider that serves the requested endpoint service. + enum: + - AWS + - AZURE + - GCP + readOnly: true + 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 + 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: + type: string + description: Unique 24-hexadecimal digit string that identifies the Private + Endpoint Service. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + 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 + items: + 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. + 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\\-]+" + status: + type: string + description: State of the Private Endpoint Service connection when MongoDB + Cloud received this request. + enum: + - INITIATING + - AVAILABLE + - WAITING_FOR_USER + - FAILED + - DELETING + readOnly: true + required: + - cloudProvider + title: GCP + GCPHardwareSpec: + type: object + properties: + instanceSize: type: string description: Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance @@ -33700,25 +35529,26 @@ components: maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" - readOnly: true destinationOrgPrivateApiKey: type: string - description: "Unique string that identifies the private part of the [API\ - \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) used\ - \ to verify access to the destination organization. This parameter is\ - \ required only when you authenticate with Programmatic API Keys." + description: Unique string that identifies the private part of the API Key + used to verify access to the destination organization. This parameter + is required only when you authenticate with Programmatic API Keys. example: 55c3bbb6-b4bb-0be1-e66d20841f3e - readOnly: true + externalDocs: + description: Grant Programmatic Access to Atlas + url: https://dochub.mongodb.org/core/atlas-create-prog-api-key destinationOrgPublicApiKey: type: string - description: "Unique string that identifies the public part of the [API\ - \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) used\ - \ to verify access to the destination organization. This parameter is\ - \ required only when you authenticate with Programmatic API Keys." + description: Unique string that identifies the public part of the API Key + used to verify access to the destination organization. This parameter + is required only when you authenticate with Programmatic API Keys. example: zmmrboas + externalDocs: + description: Grant Programmatic Access to Atlas + url: https://dochub.mongodb.org/core/atlas-create-prog-api-key maxLength: 8 minLength: 8 - readOnly: true GroupNotification: type: object description: Group notification configuration for MongoDB Cloud to send information @@ -33808,7 +35638,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/EventViewForNdsGroup" @@ -33856,6 +35686,33 @@ components: - GROUP_READ_ONLY - GROUP_SEARCH_INDEX_EDITOR - GROUP_STREAM_PROCESSING_OWNER + GroupRoleAssignment: + type: object + properties: + groupId: + type: string + description: Unique 24-hexadecimal digit string that identifies the project + to which these roles belong. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + groupRoles: + type: array + description: One or more project level roles assigned to the MongoDB Cloud + user. + items: + type: string + enum: + - GROUP_OWNER + - GROUP_CLUSTER_MANAGER + - GROUP_STREAM_PROCESSING_OWNER + - GROUP_DATA_ACCESS_ADMIN + - GROUP_DATA_ACCESS_READ_WRITE + - GROUP_DATA_ACCESS_READ_ONLY + - GROUP_READ_ONLY + - GROUP_SEARCH_INDEX_EDITOR + uniqueItems: true GroupService: type: object description: List of IP addresses in a project categorized by services. @@ -33871,26 +35728,26 @@ components: GroupServiceAccount: type: object properties: + clientId: + type: string + description: The Client ID of the Service Account. + pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" createdAt: type: string format: date-time - description: Service account creation time. + description: The date that the Service Account was created on. description: type: string - description: Description of the service account. - id: - type: string - description: ID for the service account. - pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" + description: Human readable description for the Service Account. name: type: string - description: Name for service account. + description: Human-readable name for the Service Account. roles: type: array - description: Roles assigned to the Service Account group. + description: A list of Project roles associated with the Service Account. items: type: string - description: Project roles associated with the service account. + description: Project roles available for Service Accounts. enum: - GROUP_OWNER - GROUP_READ_ONLY @@ -33903,7 +35760,7 @@ components: uniqueItems: true secrets: type: array - description: List of secrets. + description: A list of secrets associated with the specified Service Account. items: $ref: "#/components/schemas/ServiceAccountSecret" uniqueItems: true @@ -33912,23 +35769,23 @@ components: properties: description: type: string - description: Human readable description for the service account. + description: Human readable description for the Service Account. maxLength: 250 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" name: type: string - description: Human-readable name for the service account. The name is modifiable + description: Human-readable name for the Service Account. The name is modifiable and does not have to be unique. maxLength: 64 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" roles: type: array - description: Project roles associated with the service account. + description: A list of project-level roles for the Service Account. items: type: string - description: Project roles associated with the service account. + description: Project roles available for Service Accounts. enum: - GROUP_OWNER - GROUP_READ_ONLY @@ -33941,20 +35798,23 @@ components: secretExpiresAfterHours: type: integer format: int32 - description: Secret expiration time. + description: The expiration time of the new Service Account secret. The + expiration is provided in hours. required: - description - name + - roles - secretExpiresAfterHours GroupServiceAccountRoleAssignment: type: object properties: roles: type: array - description: Group access roles. + description: The Project permissions for the Service Account in the specified + Project. items: type: string - description: Project roles associated with the service account. + description: Project roles available for Service Accounts. enum: - GROUP_OWNER - GROUP_READ_ONLY @@ -33965,28 +35825,30 @@ components: - GROUP_SEARCH_INDEX_EDITOR - GROUP_STREAM_PROCESSING_OWNER uniqueItems: true + required: + - roles GroupServiceAccountUpdateRequest: type: object properties: description: type: string - description: Human readable description for the service account. + description: Human readable description for the Service Account. maxLength: 250 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" name: type: string - description: Human-readable name for the service account. The name is modifiable + description: Human-readable name for the Service Account. The name is modifiable and does not have to be unique. maxLength: 64 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" roles: type: array - description: Project roles associated with the service account. + description: A list of Project roles associated with the Service Account. items: type: string - description: Project roles associated with the service account. + description: Project roles available for Service Accounts. enum: - GROUP_OWNER - GROUP_READ_ONLY @@ -34250,7 +36112,7 @@ components: example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -34369,6 +36231,8 @@ components: - HOST_HAS_INDEX_SUGGESTIONS - HOST_MONGOT_RECOVERED_OOM - HOST_MONGOT_CRASHING_OOM + - HOST_MONGOT_RESUME_REPLICATION + - HOST_MONGOT_STOP_REPLICATION - HOST_ENOUGH_DISK_SPACE - HOST_NOT_ENOUGH_DISK_SPACE example: HOST_DOWN @@ -34380,6 +36244,7 @@ components: - HOST_DOWN - HOST_HAS_INDEX_SUGGESTIONS - HOST_MONGOT_CRASHING_OOM + - HOST_MONGOT_STOP_REPLICATION - HOST_NOT_ENOUGH_DISK_SPACE example: HOST_DOWN title: Host Event Types @@ -34676,6 +36541,7 @@ components: OPCOUNTER_REPL_INSERT: "#/components/schemas/RawMetricAlertView" OPCOUNTER_REPL_UPDATE: "#/components/schemas/RawMetricAlertView" OPCOUNTER_UPDATE: "#/components/schemas/RawMetricAlertView" + OPERATIONS_QUERIES_KILLED: "#/components/schemas/RawMetricAlertView" OPERATIONS_SCAN_AND_ORDER: "#/components/schemas/RawMetricAlertView" OPERATION_THROTTLING_REJECTED_OPERATIONS: "#/components/schemas/RawMetricAlertView" OPLOG_MASTER_LAG_TIME_DIFF: "#/components/schemas/TimeMetricAlertView" @@ -34750,7 +36616,7 @@ components: example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -35079,6 +36945,7 @@ components: OPCOUNTER_REPL_INSERT: "#/components/schemas/RawMetricEventView" OPCOUNTER_REPL_UPDATE: "#/components/schemas/RawMetricEventView" OPCOUNTER_UPDATE: "#/components/schemas/RawMetricEventView" + OPERATIONS_QUERIES_KILLED: "#/components/schemas/RawMetricEventView" OPERATIONS_SCAN_AND_ORDER: "#/components/schemas/RawMetricEventView" OPERATION_THROTTLING_REJECTED_OPERATIONS: "#/components/schemas/RawMetricEventView" OPLOG_MASTER_LAG_TIME_DIFF: "#/components/schemas/TimeMetricEventView" @@ -35384,6 +37251,7 @@ components: OPCOUNTER_REPL_INSERT: "#/components/schemas/RawMetricThresholdView" OPCOUNTER_REPL_UPDATE: "#/components/schemas/RawMetricThresholdView" OPCOUNTER_UPDATE: "#/components/schemas/RawMetricThresholdView" + OPERATIONS_QUERIES_KILLED: "#/components/schemas/RawMetricThresholdView" OPERATIONS_SCAN_AND_ORDER: "#/components/schemas/RawMetricThresholdView" OPERATION_THROTTLING_REJECTED_OPERATIONS: "#/components/schemas/RawMetricThresholdView" OPLOG_MASTER_LAG_TIME_DIFF: "#/components/schemas/TimeMetricThresholdView" @@ -35428,7 +37296,12 @@ components: enum: - AVERAGE operator: - $ref: "#/components/schemas/Operator" + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - LESS_THAN + - GREATER_THAN threshold: type: number format: double @@ -35905,7 +37778,7 @@ components: the charge. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -36341,6 +38214,21 @@ components: - ATLAS_AWS_STREAM_PROCESSING_DATA_TRANSFER - ATLAS_AZURE_STREAM_PROCESSING_DATA_TRANSFER - ATLAS_AWS_STREAM_PROCESSING_VPC_PEERING + - 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 readOnly: true startDate: type: string @@ -36666,6 +38554,371 @@ components: - REPLICASET - SHARDED - GEOSHARDED + configServerManagementMode: + type: string + default: ATLAS_MANAGED + description: |- + Config Server Management Mode for creating or updating a sharded cluster. + + When configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings. + + When configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server. + enum: + - ATLAS_MANAGED + - FIXED_TO_DEDICATED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + configServerType: + type: string + description: Describes a sharded cluster's config server type. + enum: + - DEDICATED + - EMBEDDED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + readOnly: true + connectionStrings: + $ref: "#/components/schemas/ClusterConnectionStrings" + createDate: + type: string + format: date-time + description: Date and time when MongoDB Cloud created this serverless instance. + MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. + readOnly: true + diskSizeGB: + type: number + format: double + 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." + maximum: 4096 + minimum: 10 + diskWarmingMode: + type: string + default: FULLY_WARMED + description: Disk warming mode selection. + enum: + - FULLY_WARMED + - VISIBLE_EARLIER + externalDocs: + description: Reduce Secondary Disk Warming Impact + url: https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact + encryptionAtRestProvider: + type: string + description: Cloud service provider that manages your customer keys to provide + an additional layer of Encryption at Rest for the cluster. + enum: + - NONE + - AWS + - AZURE + - GCP + externalDocs: + description: Encryption at Rest using Customer Key Management + url: https://www.mongodb.com/docs/atlas/security-kms-encryption/ + featureCompatibilityVersion: + type: string + description: Feature compatibility version of the cluster. + readOnly: true + featureCompatibilityVersionExpirationDate: + type: string + format: date-time + description: Feature compatibility version expiration date. + 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: + type: string + description: Unique 24-hexadecimal character string that identifies the + project. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + id: + type: string + description: Unique 24-hexadecimal digit string that identifies the cluster. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + labels: + type: array + deprecated: true + description: |- + Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels. + + Cluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead. + items: + $ref: "#/components/schemas/ComponentLabel" + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + 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- + mongoDBVersion: + type: string + description: Version of MongoDB that the cluster runs. + pattern: "([\\d]+\\.[\\d]+\\.[\\d]+)" + 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." + externalDocs: + description: Connection string URI format. + url: https://docs.mongodb.com/manual/reference/connection-string/ + readOnly: true + mongoURIUpdated: + type: string + format: date-time + description: Date and time when someone last updated the connection string. + MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. + readOnly: true + 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." + externalDocs: + description: Connection string URI format. + url: https://docs.mongodb.com/manual/reference/connection-string/ + readOnly: true + name: + type: string + description: Human-readable label that identifies the cluster. + maxLength: 64 + minLength: 1 + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + numShards: + type: integer + format: int32 + default: 1 + description: Number of shards up to 50 to deploy for a sharded cluster. + The resource returns `1` to indicate a replica set and values of `2` and + higher to indicate a sharded cluster. The returned value equals the number + of shards in the cluster. + externalDocs: + description: Sharding + url: https://docs.mongodb.com/manual/sharding/ + maximum: 50 + minimum: 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 + default: WORKLOAD_TYPE + description: |- + Set this field to configure the replica set scaling mode for your cluster. + + By default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes. + + When configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads. + + When configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads. + enum: + - SEQUENTIAL + - WORKLOAD_TYPE + - NODE_TYPE + externalDocs: + description: Modify the Replica Set Scaling Mode + url: https://dochub.mongodb.org/core/scale-nodes + replicationFactor: + type: integer + format: int32 + default: 3 + deprecated: true + description: "Number of members that belong to the replica set. Each member\ + \ retains a copy of your databases, providing high availability and data\ + \ redundancy. Use **replicationSpecs** instead." + enum: + - 3 + - 5 + - 7 + replicationSpec: + type: object + additionalProperties: + $ref: "#/components/schemas/RegionSpec" + description: Physical location where MongoDB Cloud provisions cluster nodes. + title: Region Configuration + 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. + items: + $ref: "#/components/schemas/LegacyReplicationSpec" + rootCertType: + type: string + default: ISRGROOTX1 + description: Root Certificate Authority that MongoDB Atlas clusters uses. + MongoDB Cloud supports Internet Security Research Group. + 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. + externalDocs: + description: Connection string URI format. + url: https://docs.mongodb.com/manual/reference/connection-string/ + readOnly: true + stateName: + type: string + description: Human-readable label that indicates the current operating condition + of the cluster. + enum: + - IDLE + - CREATING + - UPDATING + - DELETING + - REPAIRING + readOnly: true + tags: + type: array + description: List that contains key-value pairs between 1 to 255 characters + in length for tagging and categorizing the cluster. + externalDocs: + description: Resource Tags + url: https://dochub.mongodb.org/core/add-cluster-tag-atlas + items: + $ref: "#/components/schemas/ResourceTag" + terminationProtectionEnabled: + type: boolean + default: false + description: "Flag that indicates whether termination protection is enabled\ + \ on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster.\ + \ If set to `false`, MongoDB Cloud will delete the cluster." + versionReleaseSystem: + type: string + default: LTS + description: "Method by which the cluster maintains the MongoDB versions.\ + \ If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**." + enum: + - LTS + - CONTINUOUS + title: Cluster Description + LegacyAtlasTenantClusterUpgradeRequest: + type: object + description: Request containing target state of tenant cluster to be upgraded + properties: + acceptDataRisksAndForceReplicaSetReconfig: + type: string + format: date-time + description: "If reconfiguration is necessary to regain a primary due to\ + \ a regional outage, submit this field alongside your topology reconfiguration\ + \ to request a new regional outage resistant topology. Forced reconfigurations\ + \ during an outage of the majority of electable nodes carry a risk of\ + \ data loss if replicated writes (even majority committed writes) have\ + \ not been replicated to the new primary node. MongoDB Atlas docs contain\ + \ more information. To proceed with an operation which carries that risk,\ + \ set **acceptDataRisksAndForceReplicaSetReconfig** to the current date." + externalDocs: + description: Reconfiguring a Replica Set during a regional outage + url: https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set + 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 + default: ATLAS_MANAGED + description: |- + Config Server Management Mode for creating or updating a sharded cluster. + + When configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings. + + When configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server. + enum: + - ATLAS_MANAGED + - FIXED_TO_DEDICATED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + configServerType: + type: string + description: Describes a sharded cluster's config server type. + enum: + - DEDICATED + - EMBEDDED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + readOnly: true connectionStrings: $ref: "#/components/schemas/ClusterConnectionStrings" createDate: @@ -36710,6 +38963,15 @@ components: externalDocs: description: Encryption at Rest using Customer Key Management url: https://www.mongodb.com/docs/atlas/security-kms-encryption/ + featureCompatibilityVersion: + type: string + description: Feature compatibility version of the cluster. + readOnly: true + featureCompatibilityVersionExpirationDate: + type: string + format: date-time + description: Feature compatibility version expiration date. + readOnly: true globalClusterSelfManagedSharding: type: boolean description: |- @@ -36760,6 +39022,8 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true + mongoDBEmployeeAccessGrant: + $ref: "#/components/schemas/EmployeeAccessGrantView" mongoDBMajorVersion: type: string description: |- @@ -36806,7 +39070,7 @@ components: description: Human-readable label that identifies the cluster. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" numShards: type: integer format: int32 @@ -36838,292 +39102,24 @@ components: \ use MongoDB Cloud backups." providerSettings: $ref: "#/components/schemas/ClusterProviderSettings" - replicationFactor: - type: integer - format: int32 - default: 3 - deprecated: true - description: "Number of members that belong to the replica set. Each member\ - \ retains a copy of your databases, providing high availability and data\ - \ redundancy. Use **replicationSpecs** instead." - enum: - - 3 - - 5 - - 7 - replicationSpec: - type: object - additionalProperties: - $ref: "#/components/schemas/RegionSpec" - description: Physical location where MongoDB Cloud provisions cluster nodes. - title: Region Configuration - 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. - items: - $ref: "#/components/schemas/LegacyReplicationSpec" - rootCertType: - type: string - default: ISRGROOTX1 - description: Root Certificate Authority that MongoDB Atlas clusters uses. - MongoDB Cloud supports Internet Security Research Group. - 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. - externalDocs: - description: Connection string URI format. - url: https://docs.mongodb.com/manual/reference/connection-string/ - readOnly: true - stateName: - type: string - description: Human-readable label that indicates the current operating condition - of the cluster. - enum: - - IDLE - - CREATING - - UPDATING - - DELETING - - REPAIRING - readOnly: true - tags: - type: array - description: List that contains key-value pairs between 1 to 255 characters - in length for tagging and categorizing the cluster. - externalDocs: - description: Resource Tags - url: https://dochub.mongodb.org/core/add-cluster-tag-atlas - items: - $ref: "#/components/schemas/ResourceTag" - terminationProtectionEnabled: - type: boolean - default: false - description: "Flag that indicates whether termination protection is enabled\ - \ on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster.\ - \ If set to `false`, MongoDB Cloud will delete the cluster." - versionReleaseSystem: - type: string - default: LTS - description: "Method by which the cluster maintains the MongoDB versions.\ - \ If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**." - enum: - - LTS - - CONTINUOUS - title: Cluster Description - LegacyAtlasTenantClusterUpgradeRequest: - type: object - description: Request containing target state of tenant cluster to be upgraded - properties: - acceptDataRisksAndForceReplicaSetReconfig: - type: string - format: date-time - description: "If reconfiguration is necessary to regain a primary due to\ - \ a regional outage, submit this field alongside your topology reconfiguration\ - \ to request a new regional outage resistant topology. Forced reconfigurations\ - \ during an outage of the majority of electable nodes carry a risk of\ - \ data loss if replicated writes (even majority committed writes) have\ - \ not been replicated to the new primary node. MongoDB Atlas docs contain\ - \ more information. To proceed with an operation which carries that risk,\ - \ set **acceptDataRisksAndForceReplicaSetReconfig** to the current date." - externalDocs: - description: Reconfiguring a Replica Set during a regional outage - url: https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set - 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 - connectionStrings: - $ref: "#/components/schemas/ClusterConnectionStrings" - createDate: - type: string - format: date-time - description: Date and time when MongoDB Cloud created this serverless instance. - MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. - readOnly: true - diskSizeGB: - type: number - format: double - 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." - maximum: 4096 - minimum: 10 - diskWarmingMode: - type: string - default: FULLY_WARMED - description: Disk warming mode selection. - enum: - - FULLY_WARMED - - VISIBLE_EARLIER - externalDocs: - description: Reduce Secondary Disk Warming Impact - url: https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact - encryptionAtRestProvider: - type: string - description: Cloud service provider that manages your customer keys to provide - an additional layer of Encryption at Rest for the cluster. - enum: - - NONE - - AWS - - AZURE - - GCP - externalDocs: - description: Encryption at Rest using Customer Key Management - url: https://www.mongodb.com/docs/atlas/security-kms-encryption/ - 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: - type: string - description: Unique 24-hexadecimal character string that identifies the - project. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - id: + replicaSetScalingStrategy: type: string - description: Unique 24-hexadecimal digit string that identifies the cluster. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - labels: - type: array - deprecated: true + default: WORKLOAD_TYPE 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. + Set this field to configure the replica set scaling mode for your cluster. - Cluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead. - items: - $ref: "#/components/schemas/ComponentLabel" - links: - type: array - description: "List of one or more Uniform Resource Locators (URLs) that\ - \ point to API sub-resources, related API resources, or both. RFC 5988\ - \ outlines these relationships." - externalDocs: - description: Web Linking Specification (RFC 5988) - url: https://datatracker.ietf.org/doc/html/rfc5988 - items: - $ref: "#/components/schemas/Link" - readOnly: true - mongoDBMajorVersion: - type: string - description: |- - MongoDB major version of the cluster. + By default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes. - 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). + When configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads. - 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- - mongoDBVersion: - type: string - description: Version of MongoDB that the cluster runs. - pattern: "([\\d]+\\.[\\d]+\\.[\\d]+)" - 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." - externalDocs: - description: Connection string URI format. - url: https://docs.mongodb.com/manual/reference/connection-string/ - readOnly: true - mongoURIUpdated: - type: string - format: date-time - description: Date and time when someone last updated the connection string. - MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. - readOnly: true - 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." - externalDocs: - description: Connection string URI format. - url: https://docs.mongodb.com/manual/reference/connection-string/ - readOnly: true - name: - type: string - description: Human-readable label that identifies the cluster. - maxLength: 64 - minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - numShards: - type: integer - format: int32 - default: 1 - description: Number of shards up to 50 to deploy for a sharded cluster. - The resource returns `1` to indicate a replica set and values of `2` and - higher to indicate a sharded cluster. The returned value equals the number - of shards in the cluster. - externalDocs: - description: Sharding - url: https://docs.mongodb.com/manual/sharding/ - maximum: 50 - minimum: 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. + When configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads. + enum: + - SEQUENTIAL + - WORKLOAD_TYPE + - NODE_TYPE externalDocs: - description: 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" + description: Modify the Replica Set Scaling Mode + url: https://dochub.mongodb.org/core/scale-nodes replicationFactor: type: integer format: int32 @@ -37686,6 +39682,10 @@ components: - INSTANCE_NAME - PROCESSOR_NAME title: Streams Matcher Fields + - type: string + enum: + - RULE_ID + title: Log Ingestion Matcher Fields MatcherHostType: type: string description: Value to match or exceed using the specified **matchers.operator**. @@ -38400,6 +40400,7 @@ components: - 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 @@ -38477,6 +40478,8 @@ components: - 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 @@ -38506,6 +40509,9 @@ components: - 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 @@ -38564,9 +40570,13 @@ components: - 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 example: CLUSTER_CREATED title: NDS Audit Types NDSAuditTypeViewForOrg: @@ -39542,7 +41552,7 @@ components: example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -39801,7 +41811,12 @@ components: enum: - AVERAGE operator: - $ref: "#/components/schemas/Operator" + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - LESS_THAN + - GREATER_THAN threshold: type: number format: double @@ -39991,6 +42006,57 @@ components: required: - typeName title: OpsGenie Notification + OrgActiveUserResponse: + type: object + allOf: + - $ref: "#/components/schemas/OrgUserResponse" + - type: object + properties: + country: + type: string + description: Two alphabet characters that identifies MongoDB Cloud user's + geographic location. This parameter uses the ISO 3166-1a2 code format. + example: US + pattern: "^([A-Z]{2})$" + readOnly: true + createdAt: + type: string + format: date-time + description: Date and time when MongoDB Cloud created the current account. + This value is in the ISO 8601 timestamp format in UTC. + readOnly: true + firstName: + type: string + description: First or given name that belongs to the MongoDB Cloud user. + example: John + readOnly: true + lastAuth: + type: string + format: date-time + description: Date and time when the current account last authenticated. + This value is in the ISO 8601 timestamp format in UTC. + readOnly: true + lastName: + type: string + description: "Last name, family name, or surname that belongs to the MongoDB\ + \ Cloud user." + example: Doe + readOnly: true + mobileNumber: + type: string + description: Mobile phone number that belongs to the MongoDB Cloud user. + pattern: "(?:(?:\\\\+?1\\\\s*(?:[.-]\\\\s*)?)?(?:(\\\\s*([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9])\\\ + \\s*)|([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9]))\\\\s*(?:[.-]\\\\\ + s*)?)([2-9]1[02-9]|[2-9][02-9]1|[2-9][02-9]{2})\\\\s*(?:[.-]\\\\s*)?([0-9]{4})$" + readOnly: true + required: + - createdAt + - firstName + - id + - lastName + - orgMembershipStatus + - roles + - username OrgEventTypeViewForOrg: type: string description: Unique identifier of event type. @@ -40341,7 +42407,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/EventViewForOrg" @@ -40353,29 +42419,61 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true + OrgPendingUserResponse: + type: object + allOf: + - $ref: "#/components/schemas/OrgUserResponse" + - type: object + properties: + invitationCreatedAt: + type: string + format: date-time + description: Date and time when MongoDB Cloud sent the invitation. MongoDB + Cloud represents this timestamp in ISO 8601 format in UTC. + readOnly: true + invitationExpiresAt: + type: string + format: date-time + description: Date and time when the invitation from MongoDB Cloud expires. + MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. + readOnly: true + inviterUsername: + type: string + format: email + description: Username of the MongoDB Cloud user who sent the invitation + to join the organization. + readOnly: true + required: + - id + - invitationCreatedAt + - invitationExpiresAt + - inviterUsername + - orgMembershipStatus + - roles + - username OrgServiceAccount: type: object properties: + clientId: + type: string + description: The Client ID of the Service Account. + pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" createdAt: type: string format: date-time - description: Service account creation time. + description: The date that the Service Account was created on. description: type: string - description: Description of the service account. - id: - type: string - description: ID for the service account. - pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" + description: Human readable description for the Service Account. name: type: string - description: Name for service account. + description: Human-readable name for the Service Account. roles: type: array - description: Organization roles assigned to the Service Account. + description: A list of Organization roles associated with the Service Account. items: type: string - description: Organization roles associated with the service account. + description: Organization roles available for Service Accounts. enum: - ORG_MEMBER - ORG_READ_ONLY @@ -40386,7 +42484,7 @@ components: uniqueItems: true secrets: type: array - description: List of secrets. + description: A list of secrets associated with the specified Service Account. items: $ref: "#/components/schemas/ServiceAccountSecret" uniqueItems: true @@ -40395,23 +42493,23 @@ components: properties: description: type: string - description: Human readable description for the service account. + description: Human readable description for the Service Account. maxLength: 250 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" name: type: string - description: Human-readable name for the service account. The name is modifiable + description: Human-readable name for the Service Account. The name is modifiable and does not have to be unique. maxLength: 64 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" roles: type: array - description: Organization roles associated with the service account. + description: A list of organization-level roles for the Service Account. items: type: string - description: Organization roles associated with the service account. + description: Organization roles available for Service Accounts. enum: - ORG_MEMBER - ORG_READ_ONLY @@ -40422,33 +42520,35 @@ components: secretExpiresAfterHours: type: integer format: int32 - description: Secret expiration time. + description: The expiration time of the new Service Account secret. The + expiration is provided in hours. required: - description - name + - roles - secretExpiresAfterHours OrgServiceAccountUpdateRequest: type: object properties: description: type: string - description: Human readable description for the service account. + description: Human readable description for the Service Account. maxLength: 250 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" name: type: string - description: Human-readable name for the service account. The name is modifiable + description: Human-readable name for the Service Account. The name is modifiable and does not have to be unique. maxLength: 64 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" roles: type: array - description: Organization roles associated with the Service account. + description: A list of organization-level roles for the Service Account. items: type: string - description: Organization roles associated with the service account. + description: Organization roles available for Service Accounts. enum: - ORG_MEMBER - ORG_READ_ONLY @@ -40456,6 +42556,158 @@ components: - ORG_BILLING_READ_ONLY - ORG_GROUP_CREATOR - ORG_OWNER + OrgUserRequest: + type: object + properties: + roles: + $ref: "#/components/schemas/OrgUserRolesRequest" + teamIds: + type: array + description: List of unique 24-hexadecimal digit strings that identifies + the teams to which this MongoDB Cloud user belongs. + items: + type: string + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + uniqueItems: true + writeOnly: true + username: + type: string + format: email + description: Email address that represents the username of the MongoDB Cloud + user. + writeOnly: true + required: + - roles + - username + OrgUserResponse: + type: object + discriminator: + mapping: + ACTIVE: "#/components/schemas/OrgActiveUserResponse" + PENDING: "#/components/schemas/OrgPendingUserResponse" + propertyName: orgMembershipStatus + oneOf: + - $ref: "#/components/schemas/OrgPendingUserResponse" + - $ref: "#/components/schemas/OrgActiveUserResponse" + properties: + id: + type: string + description: Unique 24-hexadecimal digit string that identifies the MongoDB + Cloud user. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + orgMembershipStatus: + type: string + description: String enum that indicates whether the MongoDB Cloud user has + a pending invitation to join the organization or they are already active + in the organization. + enum: + - PENDING + - ACTIVE + readOnly: true + roles: + $ref: "#/components/schemas/OrgUserRolesResponse" + teamIds: + type: array + description: List of unique 24-hexadecimal digit strings that identifies + the teams to which this MongoDB Cloud user belongs. + items: + type: string + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + uniqueItems: true + username: + type: string + format: email + description: Email address that represents the username of the MongoDB Cloud + user. + readOnly: true + required: + - id + - orgMembershipStatus + - roles + - username + OrgUserRolesRequest: + type: object + description: Organization and project level roles to assign the MongoDB Cloud + user within one organization. + properties: + groupRoleAssignments: + type: array + description: List of project level role assignments to assign the MongoDB + Cloud user. + items: + $ref: "#/components/schemas/GroupRoleAssignment" + orgRoles: + type: array + description: One or more organization level roles to assign the MongoDB + Cloud user. + items: + type: string + enum: + - ORG_OWNER + - ORG_GROUP_CREATOR + - ORG_BILLING_ADMIN + - ORG_BILLING_READ_ONLY + - ORG_READ_ONLY + - ORG_MEMBER + minItems: 1 + uniqueItems: true + required: + - orgRoles + writeOnly: true + OrgUserRolesResponse: + type: object + description: Organization and project level roles assigned to one MongoDB Cloud + user within one organization. + properties: + groupRoleAssignments: + type: array + description: List of project level role assignments assigned to the MongoDB + Cloud user. + items: + $ref: "#/components/schemas/GroupRoleAssignment" + orgRoles: + type: array + description: One or more organization level roles assigned to the MongoDB + Cloud user. + items: + type: string + enum: + - ORG_OWNER + - ORG_GROUP_CREATOR + - ORG_BILLING_ADMIN + - ORG_BILLING_READ_ONLY + - ORG_READ_ONLY + - ORG_MEMBER + uniqueItems: true + readOnly: true + OrgUserUpdateRequest: + type: object + properties: + roles: + $ref: "#/components/schemas/OrgUserRolesRequest" + teamIds: + type: array + description: List of unique 24-hexadecimal digit strings that identifies + the teams to assign the MongoDB Cloud user. + items: + type: string + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + uniqueItems: true + writeOnly: true OrganizationInvitation: type: object properties: @@ -40667,10 +42919,11 @@ components: restrictEmployeeAccess: type: boolean description: "Flag that indicates whether to block MongoDB Support from\ - \ accessing Atlas infrastructure 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/." + \ 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/." OutboundControlPlaneCloudProviderIPAddresses: type: object description: "List of outbound IP addresses from the Atlas control plane, categorized\ @@ -40843,7 +43096,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/AdvancedClusterDescription" @@ -40871,7 +43124,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/GroupAlertsConfig" @@ -40899,7 +43152,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/AlertViewForNdsGroup" @@ -40927,7 +43180,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ApiKeyUserDetails" @@ -40955,7 +43208,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/CloudAppUser" @@ -40983,7 +43236,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ApiAtlasCheckpointView" @@ -41013,7 +43266,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/CloudDatabaseUser" @@ -41041,7 +43294,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/DiskBackupExportJob" @@ -41069,7 +43322,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/EARPrivateEndpoint" @@ -41081,7 +43334,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedApiAtlasProviderRegionsView: + PaginatedApiAtlasFlexBackupRestoreJob20250101View: type: object properties: links: @@ -41097,10 +43350,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/CloudProviderRegions" + $ref: "#/components/schemas/FlexBackupRestoreJob20250101" readOnly: true totalCount: type: integer @@ -41109,7 +43362,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedApiAtlasServerlessBackupRestoreJobView: + PaginatedApiAtlasFlexBackupSnapshot20240710View: type: object properties: links: @@ -41125,10 +43378,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/ServerlessBackupRestoreJob" + $ref: "#/components/schemas/FlexBackupSnapshot20250101" readOnly: true totalCount: type: integer @@ -41137,7 +43390,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedApiAtlasServerlessBackupSnapshotView: + PaginatedApiAtlasProviderRegionsView: type: object properties: links: @@ -41153,10 +43406,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/ServerlessBackupSnapshot" + $ref: "#/components/schemas/CloudProviderRegions" readOnly: true totalCount: type: integer @@ -41165,7 +43418,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedApiAtlasUSSBackupRestoreJob20250101View: + PaginatedApiAtlasServerlessBackupRestoreJobView: type: object properties: links: @@ -41181,10 +43434,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/USSBackupRestoreJob20250101" + $ref: "#/components/schemas/ServerlessBackupRestoreJob" readOnly: true totalCount: type: integer @@ -41193,7 +43446,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedApiAtlasUSSBackupSnapshot20240710View: + PaginatedApiAtlasServerlessBackupSnapshotView: type: object properties: links: @@ -41209,10 +43462,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/USSBackupSnapshot20250101" + $ref: "#/components/schemas/ServerlessBackupSnapshot" readOnly: true totalCount: type: integer @@ -41237,7 +43490,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/BillingInvoiceMetadata" @@ -41265,7 +43518,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/BillingInvoice" @@ -41293,7 +43546,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/StreamsConnection" @@ -41305,6 +43558,34 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true + PaginatedApiStreamsPrivateLinkView: + type: object + properties: + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + results: + type: array + description: List of returned documents that MongoDB Cloud provides when + completing this request. + items: + $ref: "#/components/schemas/StreamsPrivateLinkConnection" + readOnly: true + totalCount: + type: integer + format: int32 + description: Total number of documents available. MongoDB Cloud omits this + value if `includeCount` is set to `false`. + minimum: 0 + readOnly: true PaginatedApiStreamsStreamProcessorWithStatsView: type: object properties: @@ -41321,7 +43602,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/StreamsProcessorWithStats" @@ -41349,7 +43630,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/StreamsTenant" @@ -41377,7 +43658,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/UserAccessListResponse" @@ -41389,6 +43670,34 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true + PaginatedApiVersions: + type: object + properties: + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + results: + type: array + description: List of returned documents that MongoDB Cloud provides when + completing this request. + items: + $ref: "#/components/schemas/ApiVersion" + readOnly: true + totalCount: + type: integer + format: int32 + description: Total number of documents available. MongoDB Cloud omits this + value if `includeCount` is set to `false`. + minimum: 0 + readOnly: true PaginatedAppUserView: type: object properties: @@ -41405,7 +43714,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/CloudAppUser" @@ -41433,7 +43742,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/Group" @@ -41461,7 +43770,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/MdbAvailableVersion" @@ -41489,7 +43798,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/DiskBackupSnapshotAWSExportBucket" @@ -41517,7 +43826,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/DiskBackupSnapshotExportBucket" @@ -41545,7 +43854,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/DiskBackupSnapshot" @@ -41573,7 +43882,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/DiskBackupReplicaSet" @@ -41601,7 +43910,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/DiskBackupSnapshotRestoreJob" @@ -41629,7 +43938,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/DiskBackupShardedClusterSnapshot" @@ -41658,7 +43967,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/CloudProviderContainer" @@ -41687,7 +43996,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ClusterDescription20240805" @@ -41715,7 +44024,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ConnectedOrgConfig" @@ -41744,7 +44053,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/BaseNetworkPeeringConnectionSettings" @@ -41772,7 +44081,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/MesurementsDatabase" @@ -41800,7 +44109,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/MeasurementDiskPartition" @@ -41828,7 +44137,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/EventTypeDetails" @@ -41856,7 +44165,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/FederationIdentityProvider" @@ -41868,9 +44177,37 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true + PaginatedFlexClusters20250101: + type: object + properties: + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + results: + type: array + description: List of returned documents that MongoDB Cloud provides when + completing this request. + items: + type: object + readOnly: true + totalCount: + type: integer + format: int32 + description: Total number of documents available. MongoDB Cloud omits this + value if `includeCount` is set to `false`. + minimum: 0 + readOnly: true PaginatedGroupServiceAccounts: type: object - description: List of Service Accounts + description: A list of Project Service Accounts. properties: links: type: array @@ -41885,7 +44222,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/GroupServiceAccount" @@ -41913,7 +44250,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ApiHostView_Atlas" @@ -41941,7 +44278,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ThirdPartyIntegration" @@ -41969,7 +44306,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/LegacyAtlasCluster" @@ -41997,7 +44334,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/NetworkPermissionEntry" @@ -42025,7 +44362,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/BackupOnlineArchive" @@ -42053,7 +44390,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/OrgGroup" @@ -42067,7 +44404,7 @@ components: readOnly: true PaginatedOrgServiceAccounts: type: object - description: List of Service Accounts + description: A list of Organization Service Accounts. properties: links: type: array @@ -42082,7 +44419,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/OrgServiceAccount" @@ -42110,7 +44447,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/AtlasOrganization" @@ -42138,7 +44475,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/IngestionPipelineRun" @@ -42166,7 +44503,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/PrivateNetworkEndpointIdEntry" @@ -42194,7 +44531,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/PublicApiUsageDetailsLineItemView" @@ -42222,7 +44559,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/BackupRestoreJob" @@ -42252,7 +44589,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/AuthFederationRoleMapping" @@ -42280,7 +44617,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ServerlessInstanceDescription" @@ -42294,7 +44631,7 @@ components: readOnly: true PaginatedServiceAccountGroup: type: object - description: List of Service Account projects. + description: A list of projects associated with the Service Account. properties: links: type: array @@ -42309,7 +44646,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ServiceAccountGroup" @@ -42321,7 +44658,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedSnapshotView: + PaginatedServiceAccountIPAccessEntryView: type: object properties: links: @@ -42337,10 +44674,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/BackupSnapshot" + $ref: "#/components/schemas/ServiceAccountIPAccessListEntry" readOnly: true totalCount: type: integer @@ -42349,7 +44686,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedTeamRoleView: + PaginatedSnapshotView: type: object properties: links: @@ -42365,10 +44702,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/TeamRole" + $ref: "#/components/schemas/BackupSnapshot" readOnly: true totalCount: type: integer @@ -42377,7 +44714,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedTeamView: + PaginatedTeamRoleView: type: object properties: links: @@ -42393,10 +44730,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/TeamResponse" + $ref: "#/components/schemas/TeamRole" readOnly: true totalCount: type: integer @@ -42405,7 +44742,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedTenantRestoreView: + PaginatedTeamView: type: object properties: links: @@ -42421,10 +44758,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/TenantRestore" + $ref: "#/components/schemas/TeamResponse" readOnly: true totalCount: type: integer @@ -42433,7 +44770,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedTenantSnapshotView: + PaginatedTenantRestoreView: type: object properties: links: @@ -42449,10 +44786,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/BackupTenantSnapshot" + $ref: "#/components/schemas/TenantRestore" readOnly: true totalCount: type: integer @@ -42461,7 +44798,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedUSSInstance20250101: + PaginatedTenantSnapshotView: type: object properties: links: @@ -42477,10 +44814,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - type: object + $ref: "#/components/schemas/BackupTenantSnapshot" readOnly: true totalCount: type: integer @@ -42505,7 +44842,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/UserCert" @@ -42993,6 +45330,13 @@ components: PrivateNetworkEndpointIdEntry: type: object properties: + azureConnectionName: + type: string + description: Connection name that identifies the Azure private endpoint + connection. + 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. @@ -43000,6 +45344,10 @@ components: type: string description: Human-readable label to identify customer's VPC endpoint DNS name. + customerEndpointIPAddress: + type: string + description: IP address used to connect to the Azure private endpoint. + pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" endpointId: type: string description: Unique 22-character alphanumeric string that identifies the @@ -43012,6 +45360,10 @@ components: maxLength: 22 minLength: 22 pattern: "^vpce-[0-9a-f]{17}$" + errorMessage: + type: string + description: Error message describing a failure approving the private endpoint + request. provider: type: string default: AWS @@ -43023,6 +45375,14 @@ components: type: string description: Human-readable label to identify the region of customer's VPC endpoint. + status: + type: string + description: Status of the private endpoint connection request. + enum: + - PENDING + - OK + - FAILED + - DELETING type: type: string default: DATA_LAKE @@ -43092,16 +45452,6 @@ components: - serviceDiscovery - username title: PROMETHEUS - ProxyInfo: - type: object - description: VPC Proxy Information. - properties: - authKey: - type: string - description: Authentication key for the proxy. - dnsName: - type: string - description: DNS name to use to reach the proxy/s. PublicApiUsageDetailsLineItemView: type: object properties: @@ -43193,7 +45543,12 @@ components: enum: - AVERAGE operator: - $ref: "#/components/schemas/Operator" + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - LESS_THAN + - GREATER_THAN threshold: type: number format: double @@ -43244,7 +45599,7 @@ components: example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -43503,7 +45858,12 @@ components: enum: - AVERAGE operator: - $ref: "#/components/schemas/Operator" + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - LESS_THAN + - GREATER_THAN threshold: type: number format: double @@ -43693,7 +46053,7 @@ components: example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -44494,7 +46854,7 @@ components: you loaded the sample dataset. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true completeDate: type: string @@ -45308,7 +47668,7 @@ components: \ this parameter when `\"deliveryType\" : \"download\"`." items: type: string - description: One Uniform Resource Locator that point to the compressed + description: One Uniform Resource Locator that points to the compressed snapshot files for manual download. readOnly: true desiredTimestamp: @@ -45395,7 +47755,7 @@ components: parameter when `"deliveryType":` `"automated"`. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" targetGroupId: type: string description: Unique 24-hexadecimal digit string that identifies the target @@ -45470,7 +47830,7 @@ components: which MongoDB Cloud took this snapshot. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true snapshotType: type: string @@ -45602,7 +47962,7 @@ components: description: Human-readable label that identifies the serverless instance. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" providerSettings: $ref: "#/components/schemas/ServerlessProviderSettings" serverlessBackupOptions: @@ -45671,7 +48031,7 @@ components: description: Human-readable label that identifies the serverless instance. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" writeOnly: true providerSettings: $ref: "#/components/schemas/ServerlessProviderSettings" @@ -45835,7 +48195,12 @@ components: enum: - AVERAGE operator: - $ref: "#/components/schemas/Operator" + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - LESS_THAN + - GREATER_THAN threshold: type: number format: double @@ -46045,7 +48410,11 @@ components: properties: groupId: type: string - description: Unique 24-hexadecimal digit string that identifies the project. + description: "Unique 24-hexadecimal digit string that identifies your project.\ + \ **NOTE**: Groups and projects are synonymous terms. Your group id is\ + \ the same as your project id. For existing groups, your group/project\ + \ id remains the same. The resource and corresponding endpoints use the\ + \ term groups." example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 @@ -46158,6 +48527,54 @@ components: - eventTypeName - id title: ServiceAccount Events + ServiceAccountIPAccessListEntry: + type: object + properties: + cidrBlock: + type: string + description: "Range of network addresses in the access list for the Service\ + \ Account. This parameter requires the range to be expressed in Classless\ + \ Inter-Domain Routing (CIDR) notation of Internet Protocol version 4\ + \ or version 6 addresses. You can set a value for this parameter or **ipAddress**,\ + \ but not for both in the same request." + example: 203.0.113.0/24 + pattern: "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + createdAt: + type: string + format: date-time + description: Date MongoDB Cloud added the entry was added to the Access + List. + readOnly: true + ipAddress: + type: string + description: "Network address in the access list for the Service Account.\ + \ This parameter requires the address to be expressed as one Internet\ + \ Protocol version 4 or version 6 address. You can set a value for this\ + \ parameter or **cidrBlock**, but not for both in the same request." + example: 203.0.113.10 + pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + 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 makes at least one request. + readOnly: true + lastUsedAt: + type: string + format: date-time + description: "Date when MongoDB Cloud received the most recent request that\ + \ originated from this Internet Protocol version 4 or version 6 address.\ + \ The resource returns this parameter when at least one request originates\ + \ from this IP address. MongoDB Cloud updates this parameter each time\ + \ a client accesses the permitted resource, with a delay of up to 5 minutes." + readOnly: true + requestCount: + type: integer + format: int32 + description: The number of requests that has originated from this network + address. + readOnly: true ServiceAccountOrgEvents: type: object description: Service Account event identifies different activities around user @@ -46271,35 +48688,34 @@ components: createdAt: type: string format: date-time - description: Timestamp representing creation time. + description: The date that the secret was created on. readOnly: true expiresAt: type: string format: date-time - description: Timestamp representing secret expiration time. + description: The date for the expiration of the secret. readOnly: true id: type: string - description: Unique 24-hexadecimal character string that identifies the - secret. + description: Unique 24-hexadecimal digit string that identifies the secret. example: 32b6e34b3d91647abb20e7b8 pattern: "^([a-f0-9]{24})$" readOnly: true lastUsedAt: type: string format: date-time - description: Timestamp representing last secret usage. + description: The last time the secret was used. readOnly: true maskedSecretValue: type: string - description: Service Account secret with masked values of the first 20 characters. + description: The masked Service Account secret. example: mdb_ic_sk_...12ce readOnly: true secret: type: string - description: Secret for the service account. It will be returned only the - first time after service account creation. - pattern: "^mdb_sa_sk_[0-9a-zA-Z]{40}$" + description: The secret for the Service Account. It will be returned only + the first time after creation. + pattern: "^mdb_sa_sk_[0-9a-zA-Z_-]{40}$" readOnly: true required: - createdAt @@ -46311,7 +48727,8 @@ components: secretExpiresAfterHours: type: integer format: int32 - description: Number of hours representing validity duration for secret. + description: The expiration time of the new Service Account secret. The + expiration is provided in hours. required: - secretExpiresAfterHours ShardEntry: @@ -46934,17 +49351,19 @@ components: StreamsDLQ: type: object description: Dead letter queue for the stream processor. + externalDocs: + url: https://www.mongodb.com/docs/atlas/reference/glossary/#std-term-dead-letter-queue properties: coll: type: string - description: Name of the collection that will be used for the DLQ. + description: Name of the collection to use for the DLQ. connectionName: type: string - description: Connection name that will be used to write DLQ messages to. - Has to be an Atlas connection. + description: Name of the connection to write DLQ messages to. Must be an + Atlas connection. db: type: string - description: Name of the database that will be used for the DLQ. + description: Name of the database to use for the DLQ. links: type: array description: "List of one or more Uniform Resource Locators (URLs) that\ @@ -47113,8 +49532,6 @@ components: group.protocol.type: consumer networking: $ref: "#/components/schemas/StreamsKafkaNetworking" - proxyInfo: - $ref: "#/components/schemas/ProxyInfo" security: $ref: "#/components/schemas/StreamsKafkaSecurity" StreamsKafkaNetworking: @@ -47140,6 +49557,13 @@ components: type: object description: Information about the networking access. properties: + connectionId: + type: string + description: Reserved. Will be used by PRIVATE_LINK connection type. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" links: type: array description: "List of one or more Uniform Resource Locators (URLs) that\ @@ -47153,14 +49577,18 @@ components: readOnly: true name: type: string - description: Id of the vpc peer when the type is VPC. + description: Reserved. Will be used by PRIVATE_LINK connection type. type: type: string - description: Selected networking type. Either PUBLIC or VPC. Defaults to - PUBLIC + description: "Selected networking type. Either PUBLIC, VPC or PRIVATE_LINK.\ + \ Defaults to PUBLIC. For VPC, ensure that VPC peering exists and connectivity\ + \ has been established between Atlas VPC and the VPC where Kafka cluster\ + \ is hosted for the connection to function properly. PRIVATE_LINK support\ + \ is coming soon." enum: - PUBLIC - VPC + - PRIVATE_LINK title: Networking Access Type StreamsKafkaSecurity: type: object @@ -47239,6 +49667,52 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true + StreamsPrivateLinkConnection: + type: object + description: Container for metadata needed to create a Private Link connection. + properties: + _id: + type: string + description: The ID of the Private Link connection. + dnsDomain: + type: string + description: Domain name of Confluent cluster. + dnsSubDomain: + type: array + description: Sub-Domain name of Confluent cluster. These are typically your + availability zones. + items: + type: string + interfaceEndpointId: + type: string + description: Interface endpoint ID that is created from the service endpoint + ID provided. + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + provider: + type: string + description: Provider where the Kafka cluster is deployed. + region: + type: string + description: Domain name of Confluent cluster. + serviceEndpointId: + type: string + description: AWS Service Endpoint ID. + state: + type: string + description: State the connection is in. + vendor: + type: string + description: Vendor who manages the Kafka cluster. StreamsProcessor: type: object description: An atlas stream processor. @@ -47272,6 +49746,9 @@ components: type: array description: Stream aggregation pipeline you want to apply to your streaming data. + externalDocs: + description: Supported Aggregation Pipeline Stages + url: https://www.mongodb.com/docs/atlas/atlas-stream-processing/stream-aggregation/#std-label-stream-aggregation items: $ref: "#/components/schemas/Document" StreamsProcessorWithStats: @@ -47302,6 +49779,8 @@ components: type: string description: Human-readable name of the stream processor. readOnly: true + options: + $ref: "#/components/schemas/StreamsOptions" pipeline: type: array description: Stream aggregation pipeline you want to apply to your streaming @@ -47311,15 +49790,20 @@ components: readOnly: true state: type: string - description: The state of the stream processor. + description: "The state of the stream processor. Commonly occurring states\ + \ are 'CREATED', 'STARTED', 'STOPPED' and 'FAILED'." readOnly: true stats: type: object additionalProperties: type: object description: The stats associated with the stream processor. + externalDocs: + url: https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor readOnly: true description: The stats associated with the stream processor. + externalDocs: + url: https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor readOnly: true required: - _id @@ -47330,6 +49814,26 @@ components: type: object allOf: - $ref: "#/components/schemas/StreamsConnection" + StreamsSampleConnections: + type: object + description: Sample connections to add to SPI. + properties: + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + solar: + type: boolean + default: false + description: Flag that indicates whether to add a 'sample_stream_solar' + connection. StreamsTenant: type: object properties: @@ -47381,6 +49885,8 @@ components: name: type: string description: Human-readable label that identifies the stream instance. + sampleConnections: + $ref: "#/components/schemas/StreamsSampleConnections" streamConfig: $ref: "#/components/schemas/StreamConfig" SummaryNotification: @@ -48041,7 +50547,7 @@ components: description: Human-readable label that identifies the source cluster. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true deliveryType: type: string @@ -48151,6 +50657,8 @@ components: required: - snapshotId - targetDeploymentItemName + TenantWithSampleConnections: + type: object TextSearchHostStatusDetail: type: object properties: @@ -48367,808 +50875,199 @@ components: type: array description: List of documents detailing index status on each host. items: - $ref: "#/components/schemas/TextSearchHostStatusDetail" - synonymMappingStatus: - type: string - description: Status that describes this index's synonym mappings. This - status appears only if the index has synonyms defined. - enum: - - FAILED - - BUILDING - - READY - synonymMappingStatusDetail: - type: array - description: A list of documents describing the status of the index's - synonym mappings on each search host. Only appears if the index has - synonyms defined. - items: - type: object - additionalProperties: - $ref: "#/components/schemas/SynonymMappingStatusDetail" - title: Text Search Index Response - TextSearchIndexStatusDetail: - type: object - description: Contains status information about a text search index. - properties: - definition: - $ref: "#/components/schemas/TextSearchIndexDefinition" - definitionVersion: - $ref: "#/components/schemas/SearchIndexDefinitionVersion" - message: - type: string - description: Optional message describing an error. - queryable: - type: boolean - description: Flag that indicates whether the index generation is queryable - on the host. - status: - type: string - description: | - Condition of the search index when you made this request. - - | Status | Index Condition | - |---|---| - | DELETING | The index is being deleted. | - | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. | - | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. | - | PENDING | Atlas has not yet started building the index. | - | BUILDING | Atlas is building or re-building the index after an edit. | - | READY | The index is ready and can support queries. | - enum: - - DELETING - - FAILED - - STALE - - PENDING - - BUILDING - - READY - - DOES_NOT_EXIST - synonymMappingStatus: - type: string - description: Status that describes this index's synonym mappings. This status - appears only if the index has synonyms defined. - enum: - - FAILED - - BUILDING - - READY - synonymMappingStatusDetail: - type: array - description: List of synonym statuses by mapping. - items: - $ref: "#/components/schemas/SynonymMappingStatusDetailMap" - title: Text Search Index Status Detail - ThirdPartyIntegration: - type: object - description: Collection of settings that describe third-party integrations. - discriminator: - mapping: - DATADOG: "#/components/schemas/Datadog" - MICROSOFT_TEAMS: "#/components/schemas/MicrosoftTeams" - NEW_RELIC: "#/components/schemas/NewRelic" - OPS_GENIE: "#/components/schemas/OpsGenie" - PAGER_DUTY: "#/components/schemas/PagerDuty" - PROMETHEUS: "#/components/schemas/Prometheus" - SLACK: "#/components/schemas/Slack" - VICTOR_OPS: "#/components/schemas/VictorOps" - WEBHOOK: "#/components/schemas/Webhook" - propertyName: type - properties: - id: - type: string - description: Integration id. - nullable: true - type: - type: string - description: Integration type - enum: - - PAGER_DUTY - - SLACK - - DATADOG - - NEW_RELIC - - OPS_GENIE - - VICTOR_OPS - - WEBHOOK - - HIP_CHAT - - PROMETHEUS - - MICROSOFT_TEAMS - title: Integration Type - title: Third-Party Integration - TimeMetricAlertView: - type: object - properties: - acknowledgedUntil: - type: string - format: date-time - description: |- - Date and time until which this alert has been acknowledged. This parameter expresses its value in the 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. - acknowledgementComment: - type: string - description: Comment that a MongoDB Cloud user submitted when acknowledging - the alert. - example: Expiration on 3/19. Silencing for 7days. - maxLength: 200 - acknowledgingUsername: - type: string - format: email - description: MongoDB Cloud username of the person who acknowledged the alert. - The response returns this parameter if a MongoDB Cloud user previously - acknowledged this alert. - readOnly: true - alertConfigId: - type: string - description: Unique 24-hexadecimal digit string that identifies the alert - configuration that sets this alert. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - clusterName: - 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." - example: cluster1 - maxLength: 64 - minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - readOnly: true - created: - type: string - format: date-time - description: Date and time when MongoDB Cloud created this alert. This parameter - expresses its value in the ISO 8601 timestamp format - in UTC. - readOnly: true - currentValue: - $ref: "#/components/schemas/TimeMetricValueView" - eventTypeName: - $ref: "#/components/schemas/HostMetricEventTypeViewAlertable" - groupId: - type: string - description: Unique 24-hexadecimal digit string that identifies the project - that owns this alert. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - 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. - example: cloud-test.mongodb.com:27017 - readOnly: true - id: - type: string - description: Unique 24-hexadecimal digit string that identifies this alert. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - lastNotified: - type: string - format: date-time - description: Date and time that any notifications were last sent for this - alert. This parameter expresses its value in the ISO 8601 timestamp format - in UTC. The resource returns this parameter if MongoDB Cloud has sent - notifications for this alert. - readOnly: true - links: - type: array - description: "List of one or more Uniform Resource Locators (URLs) that\ - \ point to API sub-resources, related API resources, or both. RFC 5988\ - \ outlines these relationships." - externalDocs: - description: Web Linking Specification (RFC 5988) - url: https://datatracker.ietf.org/doc/html/rfc5988 - items: - $ref: "#/components/schemas/Link" - readOnly: true - 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. - example: ASSERT_USER - readOnly: true - orgId: - type: string - description: Unique 24-hexadecimal character string that identifies the - organization that owns the project to which this alert applies. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - 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." - example: event-replica-set - readOnly: true - resolved: - type: string - format: date-time - description: "Date and time that this alert changed to `\"status\" : \"\ - CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp\ - \ format in UTC. The resource returns this parameter once `\"status\"\ - \ : \"CLOSED\"`." - readOnly: true - status: - type: string - description: State of this alert at the time you requested its details. - enum: - - CANCELLED - - CLOSED - - OPEN - - TRACKING - example: OPEN - readOnly: true - updated: - type: string - format: date-time - description: Date and time when someone last updated this alert. This parameter - expresses its value in the ISO 8601 timestamp format - in UTC. - readOnly: true - required: - - alertConfigId - - created - - eventTypeName - - id - - status - - updated - TimeMetricEventView: - type: object - properties: - apiKeyId: - type: string - description: "Unique 24-hexadecimal digit string that identifies the [API\ - \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\ - \ triggered the event. If this resource returns this parameter, it doesn't\ - \ return the **userId** parameter." - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - created: - type: string - format: date-time - description: Date and time when this event occurred. This parameter expresses - its value in the ISO 8601 timestamp format in UTC. - readOnly: true - currentValue: - $ref: "#/components/schemas/TimeMetricValueView" - eventTypeName: - $ref: "#/components/schemas/HostMetricEventTypeView" - groupId: - type: string - description: Unique 24-hexadecimal digit string that identifies the project - in which the event occurred. The **eventId** identifies the specific event. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - id: - type: string - description: Unique 24-hexadecimal digit string that identifies the event. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - isGlobalAdmin: - type: boolean - default: false - description: Flag that indicates whether a MongoDB employee triggered the - specified event. - readOnly: true - links: - type: array - description: "List of one or more Uniform Resource Locators (URLs) that\ - \ point to API sub-resources, related API resources, or both. RFC 5988\ - \ outlines these relationships." - externalDocs: - description: Web Linking Specification (RFC 5988) - url: https://datatracker.ietf.org/doc/html/rfc5988 - items: - $ref: "#/components/schemas/Link" - readOnly: true - 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: - type: string - description: Unique 24-hexadecimal digit string that identifies the organization - to which these events apply. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - port: - type: integer - format: int32 - description: IANA port on which the MongoDB process listens for requests. - example: 27017 - readOnly: true - publicKey: - type: string - format: email - description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\ - \ that triggered the event. If this resource returns this parameter, it\ - \ doesn't return the **username** parameter." - example: test.user@mongodb.com - readOnly: true - raw: - $ref: "#/components/schemas/raw" - remoteAddress: - type: string - description: IPv4 or IPv6 address from which the user triggered this event. - example: 216.172.40.186 - pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" - readOnly: true - replicaSetName: - type: string - description: Human-readable label of the replica set associated with the - event. - example: event-replica-set - readOnly: true - shardName: - type: string - description: Human-readable label of the shard associated with the event. - example: event-sh-01 - readOnly: true - userId: - type: string - description: "Unique 24-hexadecimal digit string that identifies the console\ - \ user who triggered the event. If this resource returns this parameter,\ - \ it doesn't return the **apiKeyId** parameter." - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - username: - type: string - format: email - description: "Email address for the user who triggered this event. If this\ - \ resource returns this parameter, it doesn't return the **publicApiKey**\ - \ parameter." - example: test.user@mongodb.com - readOnly: true - required: - - created - - eventTypeName - - id - TimeMetricThresholdView: - 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: - $ref: "#/components/schemas/Operator" - threshold: - type: number - format: double - description: "Value of metric that, when exceeded, triggers an alert." - units: - $ref: "#/components/schemas/TimeMetricUnits" - required: - - metricName - TimeMetricUnits: - type: string - default: HOURS - description: "Element used to express the quantity. This can be an element of\ - \ time, storage capacity, and the like." - enum: - - NANOSECONDS - - MILLISECONDS - - MILLION_MINUTES - - SECONDS - - MINUTES - - HOURS - - DAYS - title: Time Metric Units - TimeMetricValueView: - type: object - description: Measurement of the **metricName** recorded at the time of the event. - properties: - number: - type: number - format: double - description: Amount of the **metricName** recorded at the time of the event. - This value triggered the alert. - readOnly: true - units: - $ref: "#/components/schemas/TimeMetricUnits" - readOnly: true - title: Time Metric Value - TokenFilterEnglishPossessive: - type: object - description: Filter that removes possessives (trailing 's) from words. - properties: - type: - type: string - description: Human-readable label that identifies this token filter type. - enum: - - englishPossessive - required: - - type - title: englishPossessive - TokenFilterFlattenGraph: - type: object - description: "Filter that transforms a token filter graph, such as the token\ - \ filter graph that the wordDelimiterGraph token filter produces, into a flat\ - \ form suitable for indexing." - properties: - type: - type: string - description: Human-readable label that identifies this token filter type. - enum: - - flattenGraph - required: - - type - title: flattenGraph - TokenFilterPorterStemming: + $ref: "#/components/schemas/TextSearchHostStatusDetail" + synonymMappingStatus: + type: string + description: Status that describes this index's synonym mappings. This + status appears only if the index has synonyms defined. + enum: + - FAILED + - BUILDING + - READY + synonymMappingStatusDetail: + type: array + description: A list of documents describing the status of the index's + synonym mappings on each search host. Only appears if the index has + synonyms defined. + items: + type: object + additionalProperties: + $ref: "#/components/schemas/SynonymMappingStatusDetail" + title: Text Search Index Response + TextSearchIndexStatusDetail: type: object - 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. + description: Contains status information about a text search index. properties: - type: + definition: + $ref: "#/components/schemas/TextSearchIndexDefinition" + definitionVersion: + $ref: "#/components/schemas/SearchIndexDefinitionVersion" + message: type: string - description: Human-readable label that identifies this token filter type. - enum: - - porterStemming - required: - - type - title: porterStemming - TokenFilterSpanishPluralStemming: - type: object - description: Filter that stems Spanish plural words. It expects lowercase text. - properties: - type: + description: Optional message describing an error. + queryable: + type: boolean + description: Flag that indicates whether the index generation is queryable + on the host. + status: type: string - description: Human-readable label that identifies this token filter type. + description: | + Condition of the search index when you made this request. + + | Status | Index Condition | + |---|---| + | DELETING | The index is being deleted. | + | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. | + | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. | + | PENDING | Atlas has not yet started building the index. | + | BUILDING | Atlas is building or re-building the index after an edit. | + | READY | The index is ready and can support queries. | enum: - - spanishPluralStemming - required: - - type - title: spanishPluralStemming - TokenFilterStempel: - type: object - description: Filter that uses Lucene's default Polish stemmer table to stem - words in the Polish language. It expects lowercase text. - externalDocs: - description: Default Polish stemmer table - url: https://lucene.apache.org/core/9_2_0/analysis/stempel/org/apache/lucene/analysis/pl/PolishAnalyzer.html#DEFAULT_STEMMER_FILE - properties: - type: + - DELETING + - FAILED + - STALE + - PENDING + - BUILDING + - READY + - DOES_NOT_EXIST + synonymMappingStatus: type: string - description: Human-readable label that identifies this token filter type. + description: Status that describes this index's synonym mappings. This status + appears only if the index has synonyms defined. enum: - - stempel - required: - - type - title: stempel - TokenFilterWordDelimiterGraph: + - FAILED + - BUILDING + - READY + synonymMappingStatusDetail: + type: array + description: List of synonym statuses by mapping. + items: + $ref: "#/components/schemas/SynonymMappingStatusDetailMap" + title: Text Search Index Status Detail + ThirdPartyIntegration: type: object - description: Filter that splits tokens into sub-tokens based on configured rules. + description: Collection of settings that describe third-party integrations. + discriminator: + mapping: + DATADOG: "#/components/schemas/Datadog" + MICROSOFT_TEAMS: "#/components/schemas/MicrosoftTeams" + NEW_RELIC: "#/components/schemas/NewRelic" + OPS_GENIE: "#/components/schemas/OpsGenie" + PAGER_DUTY: "#/components/schemas/PagerDuty" + PROMETHEUS: "#/components/schemas/Prometheus" + SLACK: "#/components/schemas/Slack" + VICTOR_OPS: "#/components/schemas/VictorOps" + WEBHOOK: "#/components/schemas/Webhook" + propertyName: type properties: - delimiterOptions: - type: object - description: Object that contains the rules that determine how to split - words into sub-words. - properties: - concatenateAll: - type: boolean - default: false - description: Flag that indicates whether to concatenate runs. - concatenateNumbers: - type: boolean - default: false - description: Flag that indicates whether to concatenate runs of sub-numbers. - concatenateWords: - type: boolean - default: false - description: Flag that indicates whether to concatenate runs of sub-words. - generateNumberParts: - type: boolean - default: true - description: "Flag that indicates whether to split tokens based on sub-numbers.\ - \ For example, if `true`, this option splits `100-2` into `100` and\ - \ `2`." - generateWordParts: - type: boolean - default: true - description: Flag that indicates whether to split tokens based on sub-words. - ignoreKeywords: - type: boolean - default: false - description: Flag that indicates whether to skip tokens with the `keyword` - attribute set to `true` - preserveOriginal: - type: boolean - default: true - description: Flag that indicates whether to generate tokens of the original - words. - splitOnCaseChange: - type: boolean - default: true - description: Flag that indicates whether to split tokens based on letter-case - transitions. - splitOnNumerics: - type: boolean - default: true - description: Flag that indicates whether to split tokens based on letter-number - transitions. - stemEnglishPossessive: - type: boolean - default: true - description: Flag that indicates whether to remove trailing possessives - from each sub-word. - protectedWords: - type: object - description: Object that contains options for protected words. - properties: - ignoreCase: - type: boolean - default: true - description: Flag that indicates whether to ignore letter case sensitivity - for protected words. - words: - type: array - description: List that contains the tokens to protect from delimination. - items: - type: string - required: - - words - type: + id: type: string - description: Human-readable label that identifies this token filter type. - enum: - - wordDelimiterGraph - required: - - type - title: wordDelimiterGraph - TokenFilterkStemming: - type: object - description: Filter that combines algorithmic stemming with a built-in dictionary - for the English language to stem words. - properties: + description: Integration id. + nullable: true type: type: string - description: Human-readable label that identifies this token filter type. + description: Integration type enum: - - kStemming - required: - - type - title: kStemming - TriggerIngestionPipelineRequest: - type: object - properties: - datasetRetentionPolicy: - $ref: "#/components/schemas/DatasetRetentionPolicy" - snapshotId: - type: string - description: Unique 24-hexadecimal character string that identifies the - snapshot. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - writeOnly: true - required: - - snapshotId - USSBackupRestoreJob20250101: + - PAGER_DUTY + - SLACK + - DATADOG + - NEW_RELIC + - OPS_GENIE + - VICTOR_OPS + - WEBHOOK + - HIP_CHAT + - PROMETHEUS + - MICROSOFT_TEAMS + title: Integration Type + title: Third-Party Integration + TimeMetricAlertView: type: object - description: Details for one restore job of a USS instance. properties: - deliveryType: - type: string - description: Means by which this resource returns the snapshot to the requesting - MongoDB Cloud user. - enum: - - RESTORE - - DOWNLOAD - readOnly: true - expirationDate: - type: string - format: date-time - description: Date and time when the download link no longer works. This - parameter expresses its value in the ISO 8601 timestamp format in UTC. - readOnly: true - id: - type: string - description: Unique 24-hexadecimal digit string that identifies the restore - job. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - instanceName: - type: string - description: Human-readable label that identifies the source instance. - maxLength: 64 - minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - readOnly: true - links: - type: array - description: "List of one or more Uniform Resource Locators (URLs) that\ - \ point to API sub-resources, related API resources, or both. RFC 5988\ - \ outlines these relationships." - externalDocs: - description: Web Linking Specification (RFC 5988) - url: https://datatracker.ietf.org/doc/html/rfc5988 - items: - $ref: "#/components/schemas/Link" - readOnly: true - projectId: - type: string - description: Unique 24-hexadecimal digit string that identifies the project - from which the restore job originated. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - restoreFinishedDate: + acknowledgedUntil: type: string format: date-time - 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. - readOnly: true - restoreScheduledDate: + 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. + acknowledgementComment: type: string - format: date-time - description: Date and time when MongoDB Cloud will restore this snapshot. - This parameter expresses its value in the ISO 8601 timestamp format in - UTC. - readOnly: true - snapshotFinishedDate: + description: Comment that a MongoDB Cloud user submitted when acknowledging + the alert. + example: Expiration on 3/19. Silencing for 7days. + maxLength: 200 + acknowledgingUsername: type: string - format: date-time - description: Date and time when MongoDB Cloud completed writing this snapshot. - This parameter expresses its value in the ISO 8601 timestamp format in - UTC. + format: email + description: MongoDB Cloud username of the person who acknowledged the alert. + The response returns this parameter if a MongoDB Cloud user previously + acknowledged this alert. readOnly: true - snapshotId: + alertConfigId: type: string - description: Unique 24-hexadecimal digit string that identifies the snapshot - to restore. + description: Unique 24-hexadecimal digit string that identifies the alert + configuration that sets this alert. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true - 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. - enum: - - PENDING - - QUEUED - - RUNNING - - FAILED - - COMPLETED - readOnly: true - targetDeploymentItemName: + clusterName: type: string - description: Human-readable label that identifies the instance or cluster - on the target project to which you want to restore the snapshot. You can - restore the snapshot to another USS instance or Dedicated cluster tier. + description: "Human-readable label that identifies the cluster to which\ + \ this alert applies. This resource returns this parameter for alerts\ + \ of events impacting backups, replica sets, or sharded clusters." + example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true - targetProjectId: + created: type: string - description: Unique 24-hexadecimal digit string that identifies the project - that contains the instance or cluster to which you want to restore the - snapshot. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" + format: date-time + description: Date and time when MongoDB Cloud created this alert. This parameter + expresses its value in the ISO 8601 timestamp format + in UTC. readOnly: true - title: USS Backup Restore Job - USSBackupRestoreJobCreate20250101: - type: object - description: Details to create one restore job of a USS instance. - properties: - _snapshotId: - type: string - description: Unique 24-hexadecimal digit string that identifies the snapshot - to restore. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - writeOnly: true - _targetDeploymentItemName: - type: string - description: Human-readable label that identifies the instance or cluster - on the target project to which you want to restore the snapshot. You can - restore the snapshot to another USS instance or Dedicated cluster tier. - maxLength: 64 - minLength: 1 - pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" - writeOnly: true - _targetProjectId: + currentValue: + $ref: "#/components/schemas/TimeMetricValueView" + eventTypeName: + $ref: "#/components/schemas/HostMetricEventTypeViewAlertable" + groupId: type: string description: Unique 24-hexadecimal digit string that identifies the project - that contains the instance or cluster to which you want to restore the - snapshot. + that owns this alert. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" - writeOnly: true - deliveryType: - type: string - description: Means by which this resource returns the snapshot to the requesting - MongoDB Cloud user. - enum: - - RESTORE - - DOWNLOAD readOnly: true - expirationDate: + hostnameAndPort: type: string - format: date-time - description: Date and time when the download link no longer works. This - parameter expresses its value in the ISO 8601 timestamp format in UTC. + description: Hostname and port of the host to which this alert applies. + The resource returns this parameter for alerts of events impacting hosts + or replica sets. + example: cloud-test.mongodb.com:27017 readOnly: true id: type: string - description: Unique 24-hexadecimal digit string that identifies the restore - job. + description: Unique 24-hexadecimal digit string that identifies this alert. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true - instanceName: + lastNotified: type: string - description: Human-readable label that identifies the source instance. - maxLength: 64 - minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + format: date-time + 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. readOnly: true links: type: array @@ -49181,94 +51080,114 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true - projectId: + metricName: type: string - description: Unique 24-hexadecimal digit string that identifies the project - from which the restore job originated. + 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. + example: ASSERT_USER + readOnly: true + orgId: + type: string + description: Unique 24-hexadecimal character string that identifies the + organization that owns the project to which this alert applies. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true - restoreFinishedDate: - type: string - format: date-time - 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. - readOnly: true - restoreScheduledDate: + replicaSetName: type: string - format: date-time - description: Date and time when MongoDB Cloud will restore this snapshot. - This parameter expresses its value in the ISO 8601 timestamp format in - UTC. + description: "Name of the replica set to which this alert applies. The response\ + \ returns this parameter for alerts of events impacting backups, hosts,\ + \ or replica sets." + example: event-replica-set readOnly: true - snapshotFinishedDate: + resolved: type: string format: date-time - description: Date and time when MongoDB Cloud completed writing this snapshot. - This parameter expresses its value in the ISO 8601 timestamp format in - UTC. - readOnly: true - snapshotUrl: - type: string - description: "Internet address from which you can download the compressed\ - \ snapshot files. The resource returns this parameter when `\"deliveryType\"\ - \ : \"DOWNLOAD\"`." + 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\"`." readOnly: true status: type: string - description: Phase of the restore workflow for this job at the time this - resource made this request. + description: State of this alert at the time you requested its details. enum: - - PENDING - - QUEUED - - RUNNING - - FAILED - - COMPLETED + - CANCELLED + - CLOSED + - OPEN + - TRACKING + example: OPEN + readOnly: true + updated: + type: string + format: date-time + description: Date and time when someone last updated this alert. This parameter + expresses its value in the ISO 8601 timestamp format + in UTC. readOnly: true required: - - _snapshotId - - _targetDeploymentItemName - title: Create USS Backup Restore Job - USSBackupSettings20250101: + - alertConfigId + - created + - eventTypeName + - id + - status + - updated + TimeMetricEventView: type: object - description: USS backup configuration properties: - enabled: - type: boolean - default: true - description: "Flag that indicates whether backups are performed for this\ - \ USS instance. Backup uses [TODO](TODO) for USS instances." + apiKeyId: + type: string + description: "Unique 24-hexadecimal digit string that identifies the [API\ + \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\ + \ triggered the event. If this resource returns this parameter, it doesn't\ + \ return the **userId** parameter." + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" readOnly: true - readOnly: true - title: USS backup configuration - USSBackupSnapshot20250101: - type: object - description: Details for one snapshot of a USS instance. - properties: - expiration: + created: type: string format: date-time - description: Date and time when the download link no longer works. This - parameter expresses its value in the ISO 8601 timestamp format in UTC. + description: Date and time when this event occurred. This parameter expresses + its value in the ISO 8601 timestamp format in UTC. readOnly: true - finishTime: + currentValue: + $ref: "#/components/schemas/TimeMetricValueView" + eventTypeName: + $ref: "#/components/schemas/HostMetricEventTypeView" + groupId: type: string - format: date-time - description: Date and time when MongoDB Cloud completed writing this snapshot. - This parameter expresses its value in the ISO 8601 timestamp format in - UTC. + description: Unique 24-hexadecimal digit string that identifies the project + in which the event occurred. The **eventId** identifies the specific event. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" readOnly: true id: type: string - description: Unique 24-hexadecimal digit string that identifies the snapshot. + description: Unique 24-hexadecimal digit string that identifies the event. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true + isGlobalAdmin: + type: boolean + default: false + description: Flag that indicates whether a MongoDB employee triggered the + specified event. + readOnly: true links: type: array description: "List of one or more Uniform Resource Locators (URLs) that\ @@ -49280,307 +51199,307 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true - mongoDBVersion: - type: string - description: MongoDB host version that the snapshot runs. - readOnly: true - scheduledTime: - type: string - format: date-time - description: Date and time when MongoDB Cloud will take the snapshot. This - parameter expresses its value in the ISO 8601 timestamp format in UTC. - readOnly: true - startTime: - type: string - format: date-time - description: Date and time when MongoDB Cloud began taking the snapshot. - This parameter expresses its value in the ISO 8601 timestamp format in - UTC. - readOnly: true - status: + metricName: type: string - description: Phase of the workflow for this snapshot at the time this resource - made this request. - enum: - - PENDING - - QUEUED - - RUNNING - - FAILED - - COMPLETED + description: Human-readable label of the metric associated with the **alertId**. + This field may change type of **currentValue** field. readOnly: true - title: USS Backup Snapshot - USSBackupSnapshotDownloadCreate20250101: - type: object - description: Details for one backup snapshot download of a USS instance. - properties: - _snapshotId: + orgId: type: string - description: Unique 24-hexadecimal digit string that identifies the snapshot - to download. + description: Unique 24-hexadecimal digit string that identifies the organization + to which these events apply. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" - writeOnly: true - links: - type: array - description: "List of one or more Uniform Resource Locators (URLs) that\ - \ point to API sub-resources, related API resources, or both. RFC 5988\ - \ outlines these relationships." - externalDocs: - description: Web Linking Specification (RFC 5988) - url: https://datatracker.ietf.org/doc/html/rfc5988 - items: - $ref: "#/components/schemas/Link" readOnly: true - required: - - _snapshotId - title: USS Backup Snapshot Download Create - USSConnectionStrings20250101: - type: object - description: Collection of Uniform Resource Locators that point to the MongoDB - database. - externalDocs: - description: Connection string URI format. - url: https://docs.mongodb.com/manual/reference/connection-string/ - properties: - standard: - type: string - description: Public connection string that you can use to connect to this - cluster. This connection string uses the mongodb:// protocol. - externalDocs: - description: Connection String URI Format - url: https://docs.mongodb.com/manual/reference/connection-string/ + port: + type: integer + format: int32 + description: IANA port on which the MongoDB process listens for requests. + example: 27017 readOnly: true - standardSrv: + publicKey: type: string - description: Public connection string that you can use to connect to this - USS instance. This connection string uses the `mongodb+srv://` protocol. - externalDocs: - description: Connection String URI Format - url: https://docs.mongodb.com/manual/reference/connection-string/ + format: email + description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\ + \ that triggered the event. If this resource returns this parameter, it\ + \ doesn't return the **username** parameter." + example: test.user@mongodb.com readOnly: true - readOnly: true - title: USS Instance Connection Strings - USSInstanceDescription20250101: - type: object - description: Group of settings that configure a MongoDB USS instance. - properties: - backupSettings: - $ref: "#/components/schemas/USSBackupSettings20250101" - clusterType: + raw: + $ref: "#/components/schemas/raw" + remoteAddress: type: string - description: USS instance topology. - enum: - - REPLICASET - - LOADBALANCED + description: IPv4 or IPv6 address from which the user triggered this event. + example: 216.172.40.186 + pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" readOnly: true - connectionStrings: - $ref: "#/components/schemas/USSConnectionStrings20250101" - createDate: + replicaSetName: type: string - format: date-time - description: Date and time when MongoDB Cloud created this instance. This - parameter expresses its value in ISO 8601 format in UTC. + description: Human-readable label of the replica set associated with the + event. + example: event-replica-set readOnly: true - groupId: + shardName: type: string - description: Unique 24-hexadecimal character string that identifies the - project. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" + description: Human-readable label of the shard associated with the event. + example: event-sh-01 readOnly: true - id: + userId: type: string - description: Unique 24-hexadecimal digit string that identifies the instance. + description: "Unique 24-hexadecimal digit string that identifies the console\ + \ user who triggered the event. If this resource returns this parameter,\ + \ it doesn't return the **apiKeyId** parameter." example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true - links: - type: array - description: "List of one or more Uniform Resource Locators (URLs) that\ - \ point to API sub-resources, related API resources, or both. RFC 5988\ - \ outlines these relationships." - externalDocs: - description: Web Linking Specification (RFC 5988) - url: https://datatracker.ietf.org/doc/html/rfc5988 - items: - $ref: "#/components/schemas/Link" - readOnly: true - mongoDBVersion: + username: type: string - description: Version of MongoDB that the instance runs. - pattern: "([\\d]+\\.[\\d]+\\.[\\d]+)" + format: email + description: "Email address for the user who triggered this event. If this\ + \ resource returns this parameter, it doesn't return the **publicApiKey**\ + \ parameter." + example: test.user@mongodb.com readOnly: true - name: + required: + - created + - eventTypeName + - id + TimeMetricThresholdView: + type: object + properties: + metricName: type: string - description: Human-readable label that identifies the instance. - maxLength: 64 - minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - readOnly: true - providerSettings: - $ref: "#/components/schemas/USSProviderSettings20250101" - stateName: + description: Human-readable label that identifies the metric against which + MongoDB Cloud checks the configured **metricThreshold.threshold**. + mode: type: string - description: Human-readable label that indicates the current operating condition - of this instance. + description: MongoDB Cloud computes the current metric value as an average. enum: - - IDLE - - CREATING - - UPDATING - - DELETING - - REPAIRING - readOnly: true - tags: - type: array - description: List that contains key-value pairs between 1 to 255 characters - in length for tagging and categorizing the instance. - externalDocs: - description: Resource Tags - url: https://dochub.mongodb.org/core/add-cluster-tag-atlas - items: - $ref: "#/components/schemas/ResourceTag" - terminationProtectionEnabled: - type: boolean - default: false - description: "Flag that indicates whether termination protection is enabled\ - \ on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster.\ - \ If set to `false`, MongoDB Cloud will delete the cluster." - versionReleaseSystem: + - AVERAGE + operator: type: string - default: LTS - description: Method by which the cluster maintains the MongoDB versions. + description: Comparison operator to apply when checking the current metric + value. enum: - - LTS - readOnly: true + - LESS_THAN + - GREATER_THAN + threshold: + type: number + format: double + description: "Value of metric that, when exceeded, triggers an alert." + units: + $ref: "#/components/schemas/TimeMetricUnits" required: - - providerSettings - title: USS Instance Description - USSInstanceDescriptionCreate20250101: + - metricName + TimeMetricUnits: + type: string + default: HOURS + description: "Element used to express the quantity. This can be an element of\ + \ time, storage capacity, and the like." + enum: + - NANOSECONDS + - MILLISECONDS + - MILLION_MINUTES + - SECONDS + - MINUTES + - HOURS + - DAYS + title: Time Metric Units + TimeMetricValueView: type: object - description: Settings that you can specify when you create a USS instance. + description: Measurement of the **metricName** recorded at the time of the event. properties: - links: - type: array - description: "List of one or more Uniform Resource Locators (URLs) that\ - \ point to API sub-resources, related API resources, or both. RFC 5988\ - \ outlines these relationships." - externalDocs: - description: Web Linking Specification (RFC 5988) - url: https://datatracker.ietf.org/doc/html/rfc5988 - items: - $ref: "#/components/schemas/Link" + number: + type: number + format: double + description: Amount of the **metricName** recorded at the time of the event. + This value triggered the alert. readOnly: true - name: + units: + $ref: "#/components/schemas/TimeMetricUnits" + readOnly: true + title: Time Metric Value + TokenFilterEnglishPossessive: + type: object + description: Filter that removes possessives (trailing 's) from words. + properties: + type: type: string - description: Human-readable label that identifies the instance. - maxLength: 64 - minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - writeOnly: true - providerSettings: - $ref: "#/components/schemas/USSProviderSettingsCreate20250101" - tags: - type: array - description: List that contains key-value pairs between 1 to 255 characters - in length for tagging and categorizing the instance. - externalDocs: - description: Resource Tags - url: https://dochub.mongodb.org/core/add-cluster-tag-atlas - items: - $ref: "#/components/schemas/ResourceTag" - terminationProtectionEnabled: - type: boolean - default: false - description: "Flag that indicates whether termination protection is enabled\ - \ on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster.\ - \ If set to `false`, MongoDB Cloud will delete the cluster." + description: Human-readable label that identifies this token filter type. + enum: + - englishPossessive required: - - name - - providerSettings - title: USS Instance Description Create - USSProviderSettings20250101: + - type + title: englishPossessive + TokenFilterFlattenGraph: type: object - description: Group of cloud provider settings that configure the provisioned - MongoDB USS instance. + description: "Filter that transforms a token filter graph, such as the token\ + \ filter graph that the wordDelimiterGraph token filter produces, into a flat\ + \ form suitable for indexing." properties: - backingProviderName: + type: type: string - description: Cloud service provider on which MongoDB Cloud provisioned the - USS instance. + description: Human-readable label that identifies this token filter type. enum: - - AWS - - AZURE - - GCP - readOnly: true - diskSizeGB: - type: number - format: double - description: Storage capacity available to the USS instance expressed in - gigabytes. - readOnly: true - providerName: + - flattenGraph + required: + - type + title: flattenGraph + TokenFilterPorterStemming: + type: object + description: Filter that uses the porter stemming algorithm to remove the common + morphological and inflectional suffixes from words in English. It expects + lowercase text and doesn't work as expected for uppercase text. + properties: + type: type: string - default: USS - description: Human-readable label that identifies the cloud service provider. + description: Human-readable label that identifies this token filter type. enum: - - USS - readOnly: true - regionName: + - porterStemming + required: + - type + title: porterStemming + TokenFilterSpanishPluralStemming: + type: object + description: Filter that stems Spanish plural words. It expects lowercase text. + properties: + type: type: string - description: "Human-readable label that identifies the geographic location\ - \ of your MongoDB USS 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/)." - readOnly: true - readOnly: true - title: Cloud Service Provider Settings for a USS Instance - USSProviderSettingsCreate20250101: + description: Human-readable label that identifies this token filter type. + enum: + - spanishPluralStemming + required: + - type + title: spanishPluralStemming + TokenFilterStempel: type: object - description: Group of cloud provider settings that configure the provisioned - MongoDB USS instance. + description: Filter that uses Lucene's default Polish stemmer table to stem + words in the Polish language. It expects lowercase text. + externalDocs: + description: Default Polish stemmer table + url: https://lucene.apache.org/core/9_2_0/analysis/stempel/org/apache/lucene/analysis/pl/PolishAnalyzer.html#DEFAULT_STEMMER_FILE properties: - backingProviderName: + type: type: string - description: Cloud service provider on which MongoDB Cloud provisioned the - serverless instance. + description: Human-readable label that identifies this token filter type. enum: - - AWS - - AZURE - - GCP - writeOnly: true - diskSizeGB: - type: number - format: double - description: Storage capacity available to the USS instance expressed in - gigabytes. - readOnly: true - providerName: + - stempel + required: + - type + title: stempel + TokenFilterWordDelimiterGraph: + type: object + description: Filter that splits tokens into sub-tokens based on configured rules. + properties: + delimiterOptions: + type: object + description: Object that contains the rules that determine how to split + words into sub-words. + properties: + concatenateAll: + type: boolean + default: false + description: Flag that indicates whether to concatenate runs. + concatenateNumbers: + type: boolean + default: false + description: Flag that indicates whether to concatenate runs of sub-numbers. + concatenateWords: + type: boolean + default: false + description: Flag that indicates whether to concatenate runs of sub-words. + generateNumberParts: + type: boolean + default: true + description: "Flag that indicates whether to split tokens based on sub-numbers.\ + \ For example, if `true`, this option splits `100-2` into `100` and\ + \ `2`." + generateWordParts: + type: boolean + default: true + description: Flag that indicates whether to split tokens based on sub-words. + ignoreKeywords: + type: boolean + default: false + description: Flag that indicates whether to skip tokens with the `keyword` + attribute set to `true` + preserveOriginal: + type: boolean + default: true + description: Flag that indicates whether to generate tokens of the original + words. + splitOnCaseChange: + type: boolean + default: true + description: Flag that indicates whether to split tokens based on letter-case + transitions. + splitOnNumerics: + type: boolean + default: true + description: Flag that indicates whether to split tokens based on letter-number + transitions. + stemEnglishPossessive: + type: boolean + default: true + description: Flag that indicates whether to remove trailing possessives + from each sub-word. + protectedWords: + type: object + description: Object that contains options for protected words. + properties: + ignoreCase: + type: boolean + default: true + description: Flag that indicates whether to ignore letter case sensitivity + for protected words. + words: + type: array + description: List that contains the tokens to protect from delimination. + items: + type: string + required: + - words + type: type: string - default: USS - description: Human-readable label that identifies the cloud service provider. + description: Human-readable label that identifies this token filter type. enum: - - USS - readOnly: true - regionName: + - wordDelimiterGraph + required: + - type + title: wordDelimiterGraph + TokenFilterkStemming: + type: object + description: Filter that combines algorithmic stemming with a built-in dictionary + for the English language to stem words. + properties: + type: type: string - description: "Human-readable label that identifies the geographic location\ - \ of your MongoDB USS 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/)." + description: Human-readable label that identifies this token filter type. + enum: + - kStemming + required: + - type + title: kStemming + TriggerIngestionPipelineRequest: + type: object + properties: + datasetRetentionPolicy: + $ref: "#/components/schemas/DatasetRetentionPolicy" + snapshotId: + type: string + description: Unique 24-hexadecimal character string that identifies the + snapshot. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" writeOnly: true required: - - backingProviderName - - regionName - title: Cloud Service Provider Settings for a USS Instance - writeOnly: true + - snapshotId UpdateAtlasOrganizationApiKey: type: object properties: @@ -50295,7 +52214,7 @@ components: Atlas Data Lake that this database user can access. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" type: type: string description: Category of resource that this database user can access. @@ -50354,6 +52273,28 @@ components: required: - match title: User to Distinguished Name Mapping + VPCPeeringActionChallenge: + type: object + description: Container for elements used to challenge the user before taking + certain actions on VPC Peering connections. + properties: + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + requesterAccountId: + type: string + description: The AWS requester account ID. + requesterVpcId: + type: string + description: The AWS requester VPC ID. VectorSearchHostStatusDetail: type: object properties: diff --git a/tools/cli/test/data/split/dev/openapi-v2-2023-02-01.json b/tools/cli/test/data/split/dev/openapi-v2-2023-02-01.json index 08daed6a24..2984309ea3 100644 --- a/tools/cli/test/data/split/dev/openapi-v2-2023-02-01.json +++ b/tools/cli/test/data/split/dev/openapi-v2-2023-02-01.json @@ -1,7 +1,7 @@ { "openapi" : "3.0.1", "info" : { - "description" : "The MongoDB Atlas Administration API allows developers to manage all components in MongoDB Atlas.\n\nThe Atlas Administration API uses HTTP Digest Authentication to authenticate requests. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request. For example, to [return database access history](#tag/Access-Tracking/operation/listAccessLogsByClusterName) with [cURL](https://en.wikipedia.org/wiki/CURL), run the following command in the terminal:\n\n```\ncurl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true\"\n```\n\nTo learn more, see [Get Started with the Atlas Administration API](https://www.mongodb.com/docs/atlas/configure-api-access/). For support, see [MongoDB Support](https://www.mongodb.com/support/get-started).", + "description" : "The MongoDB Atlas Administration API allows developers to manage all components in MongoDB Atlas.\n\nThe Atlas Administration API uses HTTP Digest Authentication to authenticate requests. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request. For example, to [return database access history](#tag/Access-Tracking/operation/listAccessLogsByClusterName) with [cURL](https://en.wikipedia.org/wiki/CURL), run the following command in the terminal:\n\n```\ncurl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-02-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true\"\n```\n\nTo learn more, see [Get Started with the Atlas Administration API](https://www.mongodb.com/docs/atlas/configure-api-access/). For support, see [MongoDB Support](https://www.mongodb.com/support/get-started).\n\nYou can also explore the various endpoints available through the Atlas Administration API in MongoDB's [Postman workspace](https://www.postman.com/mongodb-devrel/workspace/mongodb-atlas-administration-apis/).", "license" : { "name" : "CC BY-NC-SA 3.0 US", "url" : "https://creativecommons.org/licenses/by-nc-sa/3.0/us/" @@ -9,7 +9,7 @@ "termsOfService" : "https://www.mongodb.com/mongodb-management-service-terms-and-conditions", "title" : "MongoDB Atlas Administration API", "version" : "2.0", - "x-xgen-sha" : "09d9d18db2111c955a8e01702a27ca2763417782" + "x-xgen-sha" : "e6ba3136dbd0be2a81dd4ed21b9e6c470edd4420" }, "servers" : [ { "url" : "https://cloud.mongodb.com" @@ -57,7 +57,11 @@ "description" : "Returns, adds, edits, and removes Federated Database Instances. This resource requires your project ID. Changes to federated database instance configurations can affect costs.", "name" : "Data Federation" }, { - "description" : "Returns, adds, edits, and removes Atlas Data Lake Pipelines and associated runs.", + "description" : "Returns, edits, and removes Atlas Data Lake Pipelines and associated runs.", + "externalDocs" : { + "description" : "Data Lake Pipelines are deprecated. Please see Data Lake Deprecation Guide.", + "url" : "https://dochub.mongodb.org/core/data-lake-deprecation" + }, "name" : "Data Lake Pipelines" }, { "description" : "Returns, adds, edits, and removes database users.", @@ -119,6 +123,9 @@ }, { "description" : "You can continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket. Atlas exports logs every 5 minutes.", "name" : "Push-Based Log Export" + }, { + "description" : "Configure and manage Atlas Resource Policies within your organization.", + "name" : "Resource Policies" }, { "description" : "Creates one index to a database deployment in a rolling manner. You can't create a rolling index on an `M0` free cluster or `M2/M5` shared cluster.", "name" : "Rolling Index" @@ -135,6 +142,13 @@ "url" : "https://dochub.mongodb.org/core/serverless-private-endpoint" }, "name" : "Serverless Private Endpoints" + }, { + "description" : "Endpoints for managing Service Accounts and secrets. Service Accounts are used for programmatic access to the Atlas Admin API through the OAuth 2.0 Client Credentials flow. This feature is available as a Preview feature.", + "externalDocs" : { + "description" : "Get Started with the Atlas Administration API", + "url" : "https://www.mongodb.com/docs/atlas/configure-api-access/" + }, + "name" : "Service Accounts" }, { "description" : "Returns and adds restore jobs for shared-tier database deployments.", "name" : "Shared-Tier Restore Jobs" @@ -2728,7 +2742,7 @@ "/api/atlas/v2/groups/{groupId}/backup/exportBuckets" : { "get" : { "deprecated" : true, - "description" : "Returns all AWS S3 buckets and Azure Blob Storage Containers associated with the specified Project. To use this resource, the requesting API Key must have the Project Read Only role.", + "description" : "Returns all Export Buckets associated with the specified Project. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "listExportBuckets", "parameters" : [ { "$ref" : "#/components/parameters/envelope" @@ -2765,13 +2779,13 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Return All AWS S3 Buckets and Azure Blob Storage Containers Used for Cloud Backup Snapshot Exports", + "summary" : "Return All Snapshot Export Buckets", "tags" : [ "Cloud Backups" ], - "x-sunset" : "2025-05-30" + "x-sunset" : "2026-05-30" }, "post" : { "deprecated" : true, - "description" : "Grants MongoDB Cloud access to the specified AWS S3 Bucket or Azure Blob Storage Container. This enables this Export Bucket to receive Atlas Cloud Backup Snapshots. To use this resource, the requesting API Key must have the Project Owner role.", + "description" : "Creates a Snapshot Export Bucket for an AWS S3 Bucket or Azure Blob Storage Container. Once created, an snapshots can be exported to the Export Bucket and its referenced AWS S3 Bucket or Azure Blob Storage Container. To use this resource, the requesting API Key must have the Project Owner role.", "operationId" : "createExportBucket", "parameters" : [ { "$ref" : "#/components/parameters/envelope" @@ -2790,7 +2804,7 @@ "x-xgen-version" : "2023-01-01" } }, - "description" : "Grants MongoDB Cloud access to the specified AWS S3 Bucket or Azure Blob Storage Container.", + "description" : "Specifies the role and AWS S3 Bucket or Azure Blob Storage Container that the Export Bucket should reference.", "required" : true }, "responses" : { @@ -2821,21 +2835,21 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Grant Access to AWS S3 Bucket or Azure Blob Storage Container for Cloud Backup Snapshot Exports", + "summary" : "Create One Snapshot Export Bucket", "tags" : [ "Cloud Backups" ], - "x-sunset" : "2025-05-30" + "x-sunset" : "2026-05-30" } }, "/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}" : { "delete" : { - "description" : "Revoke MongoDB Cloud access to the specified AWS S3 Bucket or Azure Blob Storage Container. This prevents this Export Bucket from receiving Atlas Cloud Backup Snapshots. 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 API Key must have the Project Owner role.", + "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 API Key must have the Project Owner role.", "operationId" : "deleteExportBucket", "parameters" : [ { "$ref" : "#/components/parameters/envelope" }, { "$ref" : "#/components/parameters/groupId" }, { - "description" : "Unique string that identifies the AWS S3 Bucket or Azure Blob Storage Container to which you export your Snapshots.", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", "in" : "path", "name" : "exportBucketId", "required" : true, @@ -2875,12 +2889,12 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Revoke Access to AWS S3 Bucket or Azure Blob Storage Container for Cloud Backup Snapshot Exports", + "summary" : "Delete One Snapshot Export Bucket", "tags" : [ "Cloud Backups" ] }, "get" : { "deprecated" : true, - "description" : "Returns one AWS S3 Bucket or Azure Blob Storage Container associated with the specified Project. To use this resource, the requesting API Key must have the Project Read Only role.", + "description" : "Returns one Export Bucket associated with the specified Project. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "getExportBucket", "parameters" : [ { "$ref" : "#/components/parameters/envelope" @@ -2924,9 +2938,9 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Return One AWS S3 Bucket or Azure Blob Storage Container Used for Cloud Backup Snapshot Exports", + "summary" : "Return One Snapshot Export Bucket", "tags" : [ "Cloud Backups" ], - "x-sunset" : "2025-05-30" + "x-sunset" : "2026-05-30" } }, "/api/atlas/v2/groups/{groupId}/backupCompliancePolicy" : { @@ -2968,7 +2982,7 @@ } ], "summary" : "Return the Backup Compliance Policy settings", "tags" : [ "Cloud Backups" ], - "x-sunset" : "2024-10-01" + "x-sunset" : "2026-10-01" }, "put" : { "deprecated" : true, @@ -3032,7 +3046,7 @@ } ], "summary" : "Update or enable the Backup Compliance Policy settings", "tags" : [ "Cloud Backups" ], - "x-sunset" : "2024-10-01" + "x-sunset" : "2025-10-01" } }, "/api/atlas/v2/groups/{groupId}/cloudProviderAccess" : { @@ -3089,7 +3103,7 @@ "content" : { "application/vnd.atlas.2023-01-01+json" : { "schema" : { - "$ref" : "#/components/schemas/CloudProviderAccessRole" + "$ref" : "#/components/schemas/CloudProviderAccessRoleRequest" } } }, @@ -3139,7 +3153,7 @@ "required" : true, "schema" : { "type" : "string", - "enum" : [ "AWS" ] + "enum" : [ "AWS", "AZURE", "GCP" ] } }, { "description" : "Unique 24-hexadecimal digit string that identifies the role.", @@ -3227,7 +3241,7 @@ "tags" : [ "Cloud Provider Access" ] }, "patch" : { - "description" : "Grants access to the specified project for the specified access role. To use this resource, the requesting API Key must have the Project Owner role. This API endpoint is one step in a procedure to create unified access for MongoDB Cloud services.", + "description" : "Grants access to the specified project for the specified access role. To use this resource, the requesting API Key must have the Project Owner role. This API endpoint is one step in a procedure to create unified access for MongoDB Cloud services. 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/" @@ -3255,7 +3269,7 @@ "content" : { "application/vnd.atlas.2023-01-01+json" : { "schema" : { - "$ref" : "#/components/schemas/CloudProviderAccessRole" + "$ref" : "#/components/schemas/CloudProviderAccessRoleRequestUpdate" } } }, @@ -3606,7 +3620,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster.", @@ -3666,7 +3680,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -3720,7 +3734,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -3772,7 +3786,7 @@ }, "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports" : { "get" : { - "description" : "Returns all Cloud Backup snapshot export jobs associated with the specified Atlas cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role.", + "description" : "Returns all Cloud Backup Snapshot Export Jobs associated with the specified Atlas cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role.", "operationId" : "listBackupExportJobs", "parameters" : [ { "$ref" : "#/components/parameters/envelope" @@ -3795,7 +3809,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -3820,11 +3834,11 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Return All Cloud Backup Snapshot Export Jobs", + "summary" : "Return All Snapshot Export Jobs", "tags" : [ "Cloud Backups" ] }, "post" : { - "description" : "Exports one backup snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. To use this resource, the requesting API Key must have the Project Atlas Admin role.", + "description" : "Exports one backup Snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. To use this resource, the requesting API Key must have the Project Atlas Admin role.", "operationId" : "createBackupExportJob", "parameters" : [ { "$ref" : "#/components/parameters/envelope" @@ -3839,7 +3853,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -3884,13 +3898,13 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Create One Cloud Backup Snapshot Export Job", + "summary" : "Create One Snapshot Export Job", "tags" : [ "Cloud Backups" ] } }, "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}" : { "get" : { - "description" : "Returns one Cloud Backup snapshot export job associated with the specified Atlas cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role.", + "description" : "Returns one Cloud Backup Snapshot Export Job associated with the specified Atlas cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role.", "operationId" : "getBackupExportJob", "parameters" : [ { "$ref" : "#/components/parameters/envelope" @@ -3905,15 +3919,19 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { - "description" : "Unique string that identifies the export job to return.", + "description" : "Unique 24-hexadecimal character string that identifies the Export Job.", "in" : "path", "name" : "exportId", "required" : true, "schema" : { - "type" : "string" + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" } } ], "responses" : { @@ -3938,7 +3956,7 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Return One Cloud Backup Snapshot Export Job", + "summary" : "Return One Snapshot Export Job", "tags" : [ "Cloud Backups" ] } }, @@ -3967,7 +3985,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -4013,7 +4031,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -4081,7 +4099,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the restore job to remove.", @@ -4141,7 +4159,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the restore job to return.", @@ -4199,7 +4217,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -4229,7 +4247,7 @@ } ], "summary" : "Remove All Cloud Backup Schedules", "tags" : [ "Cloud Backups" ], - "x-sunset" : "2025-08-05" + "x-sunset" : "2026-05-30" }, "get" : { "deprecated" : true, @@ -4250,7 +4268,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -4277,7 +4295,7 @@ } ], "summary" : "Return One Cloud Backup Schedule", "tags" : [ "Cloud Backups" ], - "x-sunset" : "2025-08-05" + "x-sunset" : "2026-05-30" }, "patch" : { "deprecated" : true, @@ -4298,7 +4316,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -4339,7 +4357,7 @@ } ], "summary" : "Update Cloud Backup Schedule for One Cluster", "tags" : [ "Cloud Backups" ], - "x-sunset" : "2025-08-05" + "x-sunset" : "2026-05-30" } }, "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots" : { @@ -4367,7 +4385,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -4416,7 +4434,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -4478,7 +4496,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -4535,7 +4553,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -4597,7 +4615,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -4648,7 +4666,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -4708,7 +4726,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -4768,7 +4786,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -4835,7 +4853,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "$ref" : "#/components/parameters/envelope" @@ -4906,7 +4924,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "$ref" : "#/components/parameters/envelope" @@ -4974,7 +4992,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "$ref" : "#/components/parameters/envelope" @@ -5025,7 +5043,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "$ref" : "#/components/parameters/envelope" @@ -5093,7 +5111,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -5144,7 +5162,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -5213,7 +5231,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -5273,7 +5291,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -5332,7 +5350,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -5403,7 +5421,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Name of the collection that contains one or more Atlas Search indexes.", @@ -5476,7 +5494,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the Atlas Search index. Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes.", @@ -5542,7 +5560,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "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.", @@ -5605,7 +5623,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "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.", @@ -5687,7 +5705,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -5741,7 +5759,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -5793,7 +5811,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -5859,7 +5877,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "$ref" : "#/components/parameters/groupId" @@ -5930,7 +5948,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -6000,7 +6018,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -6154,7 +6172,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -6204,7 +6222,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -6297,7 +6315,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Flag that indicates whether to download logs for queries against your online archive only or both your online archive and cluster.", @@ -6376,7 +6394,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -6440,7 +6458,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -6507,7 +6525,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -6579,7 +6597,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -6635,7 +6653,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -6691,7 +6709,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -6758,7 +6776,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -6813,7 +6831,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -6880,7 +6898,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -6942,7 +6960,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -6992,7 +7010,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -7055,7 +7073,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", @@ -7118,7 +7136,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -7169,7 +7187,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -7220,7 +7238,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -7285,7 +7303,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -7352,7 +7370,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -7399,7 +7417,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -7465,7 +7483,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Human-readable label that specifies whether to return only completed, incomplete, or all snapshots. By default, MongoDB Cloud only returns completed snapshots.", @@ -7523,7 +7541,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -7584,7 +7602,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -7642,7 +7660,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -7712,7 +7730,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -7772,7 +7790,7 @@ } } }, { - "description" : "Date and time when the period specifies the inclusive ending point for the range of log messages to retrieve. This parameter expresses its value in the number of seconds that have elapsed since the UNIX epoch.", + "description" : "Specifies the date and time for the ending point of the range of log messages to retrieve, in the number of seconds that have elapsed since the UNIX epoch. This value will default to 24 hours after the start date. If the start date is also unspecified, the value will default to the time of the request.", "in" : "query", "name" : "endDate", "schema" : { @@ -7781,7 +7799,7 @@ "minimum" : 1199145600 } }, { - "description" : "Date and time when the period specifies the inclusive starting point for the range of log messages to retrieve. This parameter expresses its value in the number of seconds that have elapsed since the UNIX epoch.", + "description" : "Specifies the date and time for the starting point of the range of log messages to retrieve, in the number of seconds that have elapsed since the UNIX epoch. This value will default to 24 hours prior to the end date. If the end date is also unspecified, the value will default to 24 hours prior to the time of the request.", "in" : "query", "name" : "startDate", "schema" : { @@ -9548,7 +9566,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Date and time when to stop retrieving database history. If you specify **end**, you must also specify **start**. This parameter uses UNIX epoch time in milliseconds.", @@ -9811,6 +9829,12 @@ "$ref" : "#/components/parameters/pretty" }, { "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" }, { "description" : "Human-readable label that identifies the cloud provider for the private endpoints to return.", "in" : "path", @@ -9933,17 +9957,6 @@ "pattern" : "^([a-f0-9]{24})$" } } ], - "requestBody" : { - "content" : { - "application/vnd.atlas.2023-01-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/EncryptionAtRestPrivateEndpointRequest" - } - } - }, - "description" : "Cloud provider of the private endpoints to delete and the list of cloud provider regions in which to delete the private endpoints.", - "required" : true - }, "responses" : { "204" : { "content" : { @@ -10014,6 +10027,9 @@ "403" : { "$ref" : "#/components/responses/forbidden" }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, "500" : { "$ref" : "#/components/responses/internalServerError" } @@ -10051,7 +10067,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, "style" : "form" @@ -10769,7 +10785,7 @@ } ], "summary" : "Return All Project Invitations", "tags" : [ "Projects" ], - "x-sunset" : "2024-10-04" + "x-sunset" : "2024-11-04" }, "patch" : { "deprecated" : true, @@ -10823,7 +10839,7 @@ } ], "summary" : "Update One Project Invitation", "tags" : [ "Projects" ], - "x-sunset" : "2024-10-04" + "x-sunset" : "2024-11-04" }, "post" : { "deprecated" : true, @@ -10871,7 +10887,7 @@ } ], "summary" : "Invite One MongoDB Cloud User to Join One Project", "tags" : [ "Projects" ], - "x-sunset" : "2024-10-04" + "x-sunset" : "2024-11-04" } }, "/api/atlas/v2/groups/{groupId}/invites/{invitationId}" : { @@ -10919,7 +10935,7 @@ } ], "summary" : "Cancel One Project Invitation", "tags" : [ "Projects" ], - "x-sunset" : "2024-10-04" + "x-sunset" : "2024-11-04" }, "get" : { "deprecated" : true, @@ -10970,7 +10986,7 @@ } ], "summary" : "Return One Project Invitation", "tags" : [ "Projects" ], - "x-sunset" : "2024-10-04" + "x-sunset" : "2024-11-04" }, "patch" : { "deprecated" : true, @@ -11033,7 +11049,7 @@ } ], "summary" : "Update One Project Invitation by Invitation ID", "tags" : [ "Projects" ], - "x-sunset" : "2024-10-04" + "x-sunset" : "2024-11-04" } }, "/api/atlas/v2/groups/{groupId}/ipAddresses" : { @@ -11130,13 +11146,13 @@ "description" : "Removes the specified project limit. Depending on the limit, Atlas either resets the limit to its default value or removes the limit entirely. To use this resource, the requesting API Key must have the Project Owner role.", "operationId" : "deleteProjectLimit", "parameters" : [ { - "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", + "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| 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 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n| atlas.project.deployment.salesSoldM0s | Limit on the number of M0 clusters in this project if the org is sales-sold | 100 | 100 |\n", "in" : "path", "name" : "limitName", "required" : true, "schema" : { "type" : "string", - "enum" : [ "atlas.project.security.databaseAccess.users", "atlas.project.deployment.clusters", "atlas.project.deployment.serverlessMTMs", "atlas.project.security.databaseAccess.customRoles", "atlas.project.security.networkAccess.entries", "atlas.project.security.networkAccess.crossRegionEntries", "atlas.project.deployment.nodesPerPrivateLinkRegion", "dataFederation.bytesProcessed.query", "dataFederation.bytesProcessed.daily", "dataFederation.bytesProcessed.weekly", "dataFederation.bytesProcessed.monthly", "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", "atlas.project.deployment.privateServiceConnectionsSubnetMask" ] + "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" @@ -11180,13 +11196,13 @@ "description" : "Returns the specified limit for the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "getProjectLimit", "parameters" : [ { - "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", + "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| 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 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n| atlas.project.deployment.salesSoldM0s | Limit on the number of M0 clusters in this project if the org is sales-sold | 100 | 100 |\n", "in" : "path", "name" : "limitName", "required" : true, "schema" : { "type" : "string", - "enum" : [ "atlas.project.security.databaseAccess.users", "atlas.project.deployment.clusters", "atlas.project.deployment.serverlessMTMs", "atlas.project.security.databaseAccess.customRoles", "atlas.project.security.networkAccess.entries", "atlas.project.security.networkAccess.crossRegionEntries", "atlas.project.deployment.nodesPerPrivateLinkRegion", "dataFederation.bytesProcessed.query", "dataFederation.bytesProcessed.daily", "dataFederation.bytesProcessed.weekly", "dataFederation.bytesProcessed.monthly", "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", "atlas.project.deployment.privateServiceConnectionsSubnetMask" ] + "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" @@ -11233,13 +11249,13 @@ "description" : "Sets the specified project limit. To use this resource, the requesting API Key must have the Project Owner role.\n\n**NOTE**: Increasing the following configuration limits might lead to slower response times in the MongoDB Cloud UI or increased user management overhead leading to authentication or authorization re-architecture. If possible, we recommend that you create additional projects to gain access to more of these resources for a more sustainable growth pattern.", "operationId" : "setProjectLimit", "parameters" : [ { - "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", + "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| 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 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n| atlas.project.deployment.salesSoldM0s | Limit on the number of M0 clusters in this project if the org is sales-sold | 100 | 100 |\n", "in" : "path", "name" : "limitName", "required" : true, "schema" : { "type" : "string", - "enum" : [ "atlas.project.security.databaseAccess.users", "atlas.project.deployment.clusters", "atlas.project.deployment.serverlessMTMs", "atlas.project.security.databaseAccess.customRoles", "atlas.project.security.networkAccess.entries", "atlas.project.security.networkAccess.crossRegionEntries", "atlas.project.deployment.nodesPerPrivateLinkRegion", "dataFederation.bytesProcessed.query", "dataFederation.bytesProcessed.daily", "dataFederation.bytesProcessed.weekly", "dataFederation.bytesProcessed.monthly", "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", "atlas.project.deployment.privateServiceConnectionsSubnetMask" ] + "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" @@ -12228,6 +12244,7 @@ }, "/api/atlas/v2/groups/{groupId}/pipelines" : { "get" : { + "deprecated" : true, "description" : "Returns a list of Data Lake Pipelines. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "listPipelines", "parameters" : [ { @@ -12264,10 +12281,16 @@ "DigestAuth" : [ ] } ], "summary" : "Return All Data Lake Pipelines from One Project", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" }, "post" : { + "deprecated" : true, "description" : "Creates one Data Lake Pipeline.", + "externalDocs" : { + "description" : "Data Lake Pipelines are deprecated. Please see Data Lake Deprecation Guide.", + "url" : "https://dochub.mongodb.org/core/data-lake-deprecation" + }, "operationId" : "createPipeline", "parameters" : [ { "$ref" : "#/components/parameters/envelope" @@ -12314,11 +12337,13 @@ "DigestAuth" : [ ] } ], "summary" : "Create One Data Lake Pipeline", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}" : { "delete" : { + "deprecated" : true, "description" : "Removes one Data Lake Pipeline.", "operationId" : "deletePipeline", "parameters" : [ { @@ -12363,9 +12388,11 @@ "DigestAuth" : [ ] } ], "summary" : "Remove One Data Lake Pipeline", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" }, "get" : { + "deprecated" : true, "description" : "Returns the details of one Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "getPipeline", "parameters" : [ { @@ -12412,9 +12439,11 @@ "DigestAuth" : [ ] } ], "summary" : "Return One Data Lake Pipeline", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" }, "patch" : { + "deprecated" : true, "description" : "Updates one Data Lake Pipeline.", "operationId" : "updatePipeline", "parameters" : [ { @@ -12476,11 +12505,13 @@ "DigestAuth" : [ ] } ], "summary" : "Update One Data Lake Pipeline", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules" : { "get" : { + "deprecated" : true, "description" : "Returns a list of backup schedule policy items that you can use as a Data Lake Pipeline source. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "listPipelineSchedules", "parameters" : [ { @@ -12530,11 +12561,13 @@ "DigestAuth" : [ ] } ], "summary" : "Return Available Ingestion Schedules for One Data Lake Pipeline", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots" : { "get" : { + "deprecated" : true, "description" : "Returns a list of backup snapshots that you can use to trigger an on demand pipeline run. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "listPipelineSnapshots", "parameters" : [ { @@ -12596,11 +12629,13 @@ "DigestAuth" : [ ] } ], "summary" : "Return Available Backup Snapshots for One Data Lake Pipeline", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause" : { "post" : { + "deprecated" : true, "description" : "Pauses ingestion for a Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "pausePipeline", "parameters" : [ { @@ -12647,11 +12682,13 @@ "DigestAuth" : [ ] } ], "summary" : "Pause One Data Lake Pipeline", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume" : { "post" : { + "deprecated" : true, "description" : "Resumes ingestion for a Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "resumePipeline", "parameters" : [ { @@ -12698,11 +12735,13 @@ "DigestAuth" : [ ] } ], "summary" : "Resume One Data Lake Pipeline", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs" : { "get" : { + "deprecated" : true, "description" : "Returns a list of past Data Lake Pipeline runs. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "listPipelineRuns", "parameters" : [ { @@ -12764,11 +12803,13 @@ "DigestAuth" : [ ] } ], "summary" : "Return All Data Lake Pipeline Runs from One Project", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}" : { "delete" : { + "deprecated" : true, "description" : "Deletes dataset that Atlas generated during the specified pipeline run.", "operationId" : "deletePipelineRunDataset", "parameters" : [ { @@ -12827,9 +12868,11 @@ "DigestAuth" : [ ] } ], "summary" : "Delete Pipeline Run Dataset", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" }, "get" : { + "deprecated" : true, "description" : "Returns the details of one Data Lake Pipeline run within the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "getPipelineRun", "parameters" : [ { @@ -12888,11 +12931,13 @@ "DigestAuth" : [ ] } ], "summary" : "Return One Data Lake Pipeline Run", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger" : { "post" : { + "deprecated" : true, "description" : "Triggers a Data Lake Pipeline ingestion of a specified snapshot.", "operationId" : "triggerSnapshotIngestion", "parameters" : [ { @@ -12950,7 +12995,8 @@ "DigestAuth" : [ ] } ], "summary" : "Trigger on demand snapshot ingestion", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService" : { @@ -13110,7 +13156,7 @@ "schema" : { "type" : "string", "maxLength" : 64, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -13163,7 +13209,7 @@ "schema" : { "type" : "string", "maxLength" : 64, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -13222,7 +13268,7 @@ "schema" : { "type" : "string", "maxLength" : 64, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be removed.", @@ -13279,7 +13325,7 @@ "schema" : { "type" : "string", "maxLength" : 64, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the tenant endpoint.", @@ -13336,7 +13382,7 @@ "schema" : { "type" : "string", "maxLength" : 64, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be updated.", @@ -14469,7 +14515,7 @@ "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" ] + "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" ] }, "maxItems" : 10, "minItems" : 1, @@ -14548,7 +14594,7 @@ "items" : { "type" : "string", "description" : "One measurement requested for this MongoDB process.", - "enum" : [ "ASSERT_MSG", "ASSERT_REGULAR", "ASSERT_USER", "ASSERT_WARNING", "BACKGROUND_FLUSH_AVG", "CACHE_BYTES_READ_INTO", "CACHE_BYTES_WRITTEN_FROM", "CACHE_DIRTY_BYTES", "CACHE_USED_BYTES", "COMPUTED_MEMORY", "CONNECTIONS", "CURSORS_TOTAL_OPEN", "CURSORS_TOTAL_TIMED_OUT", "DB_DATA_SIZE_TOTAL", "DB_STORAGE_TOTAL", "DOCUMENT_METRICS_DELETED", "DOCUMENT_METRICS_INSERTED", "DOCUMENT_METRICS_RETURNED", "DOCUMENT_METRICS_UPDATED", "EXTRA_INFO_PAGE_FAULTS", "FTS_DISK_UTILIZATION", "FTS_MEMORY_MAPPED", "FTS_MEMORY_RESIDENT", "FTS_MEMORY_VIRTUAL", "FTS_PROCESS_CPU_KERNEL", "FTS_PROCESS_CPU_USER", "FTS_PROCESS_NORMALIZED_CPU_KERNEL", "FTS_PROCESS_NORMALIZED_CPU_USER", "GLOBAL_ACCESSES_NOT_IN_MEMORY", "GLOBAL_LOCK_CURRENT_QUEUE_READERS", "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL", "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS", "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN", "INDEX_COUNTERS_BTREE_ACCESSES", "INDEX_COUNTERS_BTREE_HITS", "INDEX_COUNTERS_BTREE_MISS_RATIO", "INDEX_COUNTERS_BTREE_MISSES", "JOURNALING_COMMITS_IN_WRITE_LOCK", "JOURNALING_MB", "JOURNALING_WRITE_DATA_FILES_MB", "MAX_PROCESS_CPU_CHILDREN_KERNEL", "MAX_PROCESS_CPU_CHILDREN_USER", "MAX_PROCESS_CPU_KERNEL", "MAX_PROCESS_CPU_USER", "MAX_PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL", "MAX_PROCESS_NORMALIZED_CPU_CHILDREN_USER", "MAX_PROCESS_NORMALIZED_CPU_KERNEL", "MAX_PROCESS_NORMALIZED_CPU_USER", "MAX_SWAP_USAGE_FREE", "MAX_SWAP_USAGE_USED ", "MAX_SYSTEM_CPU_GUEST", "MAX_SYSTEM_CPU_IOWAIT", "MAX_SYSTEM_CPU_IRQ", "MAX_SYSTEM_CPU_KERNEL", "MAX_SYSTEM_CPU_SOFTIRQ", "MAX_SYSTEM_CPU_STEAL", "MAX_SYSTEM_CPU_USER", "MAX_SYSTEM_MEMORY_AVAILABLE", "MAX_SYSTEM_MEMORY_FREE", "MAX_SYSTEM_MEMORY_USED", "MAX_SYSTEM_NETWORK_IN", "MAX_SYSTEM_NETWORK_OUT", "MAX_SYSTEM_NORMALIZED_CPU_GUEST", "MAX_SYSTEM_NORMALIZED_CPU_IOWAIT", "MAX_SYSTEM_NORMALIZED_CPU_IRQ", "MAX_SYSTEM_NORMALIZED_CPU_KERNEL", "MAX_SYSTEM_NORMALIZED_CPU_NICE", "MAX_SYSTEM_NORMALIZED_CPU_SOFTIRQ", "MAX_SYSTEM_NORMALIZED_CPU_STEAL", "MAX_SYSTEM_NORMALIZED_CPU_USER", "MEMORY_MAPPED", "MEMORY_RESIDENT", "MEMORY_VIRTUAL", "NETWORK_BYTES_IN", "NETWORK_BYTES_OUT", "NETWORK_NUM_REQUESTS", "OP_EXECUTION_TIME_COMMANDS", "OP_EXECUTION_TIME_READS", "OP_EXECUTION_TIME_WRITES", "OPCOUNTER_CMD", "OPCOUNTER_DELETE", "OPCOUNTER_GETMORE", "OPCOUNTER_INSERT", "OPCOUNTER_QUERY", "OPCOUNTER_REPL_CMD", "OPCOUNTER_REPL_DELETE", "OPCOUNTER_REPL_INSERT", "OPCOUNTER_REPL_UPDATE", "OPCOUNTER_UPDATE", "OPERATIONS_SCAN_AND_ORDER", "OPLOG_MASTER_LAG_TIME_DIFF", "OPLOG_MASTER_TIME", "OPLOG_RATE_GB_PER_HOUR", "OPLOG_SLAVE_LAG_MASTER_TIME", "OPLOG_REPLICATION_LAG", "PROCESS_CPU_CHILDREN_KERNEL", "PROCESS_CPU_CHILDREN_USER", "PROCESS_CPU_KERNEL", "PROCESS_CPU_USER", "PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL", "PROCESS_NORMALIZED_CPU_CHILDREN_USER", "PROCESS_NORMALIZED_CPU_KERNEL", "PROCESS_NORMALIZED_CPU_USER", "QUERY_EXECUTOR_SCANNED", "QUERY_EXECUTOR_SCANNED_OBJECTS", "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED", "QUERY_TARGETING_SCANNED_PER_RETURNED", "RESTARTS_IN_LAST_HOUR", "SWAP_USAGE_FREE", "SWAP_USAGE_USED", "SYSTEM_CPU_GUEST", "SYSTEM_CPU_IOWAIT", "SYSTEM_CPU_IRQ", "SYSTEM_CPU_KERNEL", "SYSTEM_CPU_NICE", "SYSTEM_CPU_SOFTIRQ", "SYSTEM_CPU_STEAL", "SYSTEM_CPU_USER", "SYSTEM_MEMORY_AVAILABLE", "SYSTEM_MEMORY_FREE", "SYSTEM_MEMORY_USED", "SYSTEM_NETWORK_IN", "SYSTEM_NETWORK_OUT", "SYSTEM_NORMALIZED_CPU_GUEST", "SYSTEM_NORMALIZED_CPU_IOWAIT", "SYSTEM_NORMALIZED_CPU_IRQ", "SYSTEM_NORMALIZED_CPU_KERNEL", "SYSTEM_NORMALIZED_CPU_NICE", "SYSTEM_NORMALIZED_CPU_SOFTIRQ", "SYSTEM_NORMALIZED_CPU_STEAL", "SYSTEM_NORMALIZED_CPU_USER", "TICKETS_AVAILABLE_READS", "TICKETS_AVAILABLE_WRITE", "OPERATION_THROTTLING_REJECTED_OPERATIONS" ] + "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_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" ] }, "maxItems" : 10, "minItems" : 1, @@ -15052,7 +15098,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -15253,7 +15299,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -15302,7 +15348,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -15370,7 +15416,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the restore job to return.", @@ -15438,7 +15484,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -15487,7 +15533,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -15546,7 +15592,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "$ref" : "#/components/parameters/envelope" @@ -15592,7 +15638,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Value that we want to set for the Serverless Auto Indexing toggle.", @@ -15650,20 +15696,20 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { - "204" : { + "202" : { "content" : { "application/vnd.atlas.2023-01-01+json" : { "schema" : { - "$ref" : "#/components/schemas/NoBody" + "$ref" : "#/components/schemas/RequestAccepted" }, "x-xgen-version" : "2023-01-01" } }, - "description" : "This endpoint does not return a response body." + "description" : "Accepted" }, "400" : { "$ref" : "#/components/responses/badRequest" @@ -15702,7 +15748,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -15754,7 +15800,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -15988,97 +16034,33 @@ } } }, - "/api/atlas/v2/groups/{groupId}/streams/{tenantName}" : { - "delete" : { - "description" : "Delete one stream instance in the specified project. To use this resource, the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role.", - "operationId" : "deleteStreamInstance", + "/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections" : { + "get" : { + "description" : "Returns all Private Link connections for the specified project.To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role.", + "operationId" : "listPrivateLinkConnections", "parameters" : [ { - "$ref" : "#/components/parameters/envelope" - }, { - "$ref" : "#/components/parameters/pretty" - }, { "$ref" : "#/components/parameters/groupId" }, { - "description" : "Human-readable label that identifies the stream instance to delete.", - "in" : "path", - "name" : "tenantName", - "required" : true, - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "202" : { - "content" : { - "application/vnd.atlas.2023-02-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/NoBody" - }, - "x-xgen-version" : "2023-02-01" - } - }, - "description" : "Accepted" - }, - "401" : { - "$ref" : "#/components/responses/unauthorized" - }, - "403" : { - "$ref" : "#/components/responses/forbidden" - }, - "404" : { - "$ref" : "#/components/responses/notFound" - }, - "500" : { - "$ref" : "#/components/responses/internalServerError" - } - }, - "security" : [ { - "DigestAuth" : [ ] - } ], - "summary" : "Delete One Stream Instance", - "tags" : [ "Streams" ], - "x-xgen-changelog" : { - "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." - } - }, - "get" : { - "description" : "Returns the details of one stream instance within the specified project. To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role.", - "operationId" : "getStreamInstance", - "parameters" : [ { "$ref" : "#/components/parameters/envelope" }, { - "$ref" : "#/components/parameters/groupId" + "$ref" : "#/components/parameters/itemsPerPage" }, { - "description" : "Human-readable label that identifies the stream instance to return.", - "in" : "path", - "name" : "tenantName", - "required" : true, - "schema" : { - "type" : "string" - } + "$ref" : "#/components/parameters/pageNum" }, { - "description" : "Flag to indicate whether connections information should be included in the stream instance.", - "in" : "query", - "name" : "includeConnections", - "schema" : { - "type" : "boolean" - } + "$ref" : "#/components/parameters/pretty" } ], "responses" : { "200" : { "content" : { "application/vnd.atlas.2023-02-01+json" : { "schema" : { - "$ref" : "#/components/schemas/StreamsTenant" + "$ref" : "#/components/schemas/PaginatedApiStreamsPrivateLinkView" }, "x-xgen-version" : "2023-02-01" } }, "description" : "OK" }, - "400" : { - "$ref" : "#/components/responses/badRequest" - }, "401" : { "$ref" : "#/components/responses/unauthorized" }, @@ -16092,39 +16074,31 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Return One Stream Instance", + "summary" : "Return All Private Link", "tags" : [ "Streams" ], "x-xgen-changelog" : { - "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + "2024-10-02" : "The MongoDB Atlas Streams Processing Private Link API is now exposed as part of private preview, but is subject to change until GA." } }, - "patch" : { - "description" : "Update one stream instance in the specified project. To use this resource, the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role.", - "operationId" : "updateStreamInstance", + "post" : { + "description" : "Creates one Private Link in the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Stream Processing Owner role.", + "operationId" : "createPrivateLinkConnection", "parameters" : [ { "$ref" : "#/components/parameters/envelope" }, { "$ref" : "#/components/parameters/pretty" }, { "$ref" : "#/components/parameters/groupId" - }, { - "description" : "Human-readable label that identifies the stream instance to update.", - "in" : "path", - "name" : "tenantName", - "required" : true, - "schema" : { - "type" : "string" - } } ], "requestBody" : { "content" : { "application/vnd.atlas.2023-02-01+json" : { "schema" : { - "$ref" : "#/components/schemas/StreamsDataProcessRegion" + "$ref" : "#/components/schemas/StreamsPrivateLinkConnection" } } }, - "description" : "Details of the new data process region to update in the streams instance.", + "description" : "Details to create one Private Link connection for a project. project.", "required" : true }, "responses" : { @@ -16132,7 +16106,7 @@ "content" : { "application/vnd.atlas.2023-02-01+json" : { "schema" : { - "$ref" : "#/components/schemas/StreamsTenant" + "$ref" : "#/components/schemas/StreamsPrivateLinkConnection" }, "x-xgen-version" : "2023-02-01" } @@ -16145,11 +16119,8 @@ "401" : { "$ref" : "#/components/responses/unauthorized" }, - "403" : { - "$ref" : "#/components/responses/forbidden" - }, - "404" : { - "$ref" : "#/components/responses/notFound" + "409" : { + "$ref" : "#/components/responses/unauthorized" }, "500" : { "$ref" : "#/components/responses/internalServerError" @@ -16158,66 +16129,43 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Update One Stream Instance", + "summary" : "Create One Private Link connection", "tags" : [ "Streams" ], "x-xgen-changelog" : { - "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + "2024-10-02" : "The MongoDB Atlas Streams Processing Private Link API is now exposed as part of private preview, but is subject to change until GA." } } }, - "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs" : { - "get" : { - "description" : "Downloads the audit logs for the specified Atlas Streams Processing instance. By default, logs cover periods of 30 days. To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: \"Accept: application/vnd.atlas.YYYY-MM-DD+gzip\".", - "operationId" : "downloadStreamTenantAuditLogs", + "/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections/{connectionId}" : { + "delete" : { + "description" : "Deletes one Private Link in the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Stream Processing Owner role.", + "operationId" : "deletePrivateLinkConnection", "parameters" : [ { "$ref" : "#/components/parameters/envelope" }, { - "$ref" : "#/components/parameters/groupId" - }, { - "description" : "Timestamp that specifies the end point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.", - "in" : "query", - "name" : "endDate", - "schema" : { - "type" : "integer", - "format" : "int64", - "example" : 1636481348, - "pattern" : "1199145600" - } + "$ref" : "#/components/parameters/pretty" }, { - "description" : "Timestamp that specifies the starting point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.", - "in" : "query", - "name" : "startDate", - "schema" : { - "type" : "integer", - "format" : "int64", - "example" : 1636466948, - "pattern" : "1199145600" - } + "$ref" : "#/components/parameters/groupId" }, { - "description" : "Human-readable label that identifies the stream instance.", + "description" : "Unique ID that identifies the Private Link connection.", "in" : "path", - "name" : "tenantName", + "name" : "connectionId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { - "200" : { + "202" : { "content" : { - "application/vnd.atlas.2023-02-01+gzip" : { + "application/vnd.atlas.2023-02-01+json" : { "schema" : { - "type" : "string", - "format" : "binary", - "description" : "Compressed archive labeled `auditLogs.gz` downloads" + "$ref" : "#/components/schemas/NoBody" }, "x-xgen-version" : "2023-02-01" } }, - "description" : "OK" - }, - "400" : { - "$ref" : "#/components/responses/badRequest" + "description" : "Accepted" }, "401" : { "$ref" : "#/components/responses/unauthorized" @@ -16228,9 +16176,6 @@ "404" : { "$ref" : "#/components/responses/notFound" }, - "409" : { - "$ref" : "#/components/responses/conflict" - }, "500" : { "$ref" : "#/components/responses/internalServerError" } @@ -16238,28 +16183,23 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Download Audit Logs for One Atlas Stream Processing Instance", - "tags" : [ "Streams" ] - } - }, - "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections" : { + "summary" : "Delete One Private Link connection", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2024-10-02" : "The MongoDB Atlas Streams Processing Private Link API is now exposed as part of private preview, but is subject to change until GA." + } + }, "get" : { - "description" : "Returns all connections of the stream instance for the specified project.To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role.", - "operationId" : "listStreamConnections", + "description" : "Returns the details of one Private Link connection within the project. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "getPrivateLinkConnection", "parameters" : [ { - "$ref" : "#/components/parameters/groupId" - }, { "$ref" : "#/components/parameters/envelope" }, { - "$ref" : "#/components/parameters/itemsPerPage" - }, { - "$ref" : "#/components/parameters/pageNum" - }, { - "$ref" : "#/components/parameters/pretty" + "$ref" : "#/components/parameters/groupId" }, { - "description" : "Human-readable label that identifies the stream instance.", + "description" : "Unique ID that identifies the Private Link connection.", "in" : "path", - "name" : "tenantName", + "name" : "connectionId", "required" : true, "schema" : { "type" : "string" @@ -16270,7 +16210,7 @@ "content" : { "application/vnd.atlas.2023-02-01+json" : { "schema" : { - "$ref" : "#/components/schemas/PaginatedApiStreamsConnectionView" + "$ref" : "#/components/schemas/StreamsPrivateLinkConnection" }, "x-xgen-version" : "2023-02-01" } @@ -16290,62 +16230,40 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Return All Connections Of The Stream Instances", + "summary" : "Return One PrivateLink Connection", "tags" : [ "Streams" ], "x-xgen-changelog" : { - "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + "2024-10-02" : "The MongoDB Atlas Streams Processing Private Link API is now exposed as part of private preview, but is subject to change until GA." } - }, - "post" : { - "description" : "Creates one connection for a stream instance in the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Stream Processing Owner role.", - "operationId" : "createStreamConnection", + } + }, + "/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections" : { + "get" : { + "description" : "Returns a list of incoming VPC Peering Connections.", + "operationId" : "getVPCPeeringConnections", "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { "$ref" : "#/components/parameters/envelope" }, { - "$ref" : "#/components/parameters/pretty" + "$ref" : "#/components/parameters/itemsPerPage" }, { - "$ref" : "#/components/parameters/groupId" + "$ref" : "#/components/parameters/pageNum" }, { - "description" : "Human-readable label that identifies the stream instance.", - "in" : "path", - "name" : "tenantName", - "required" : true, - "schema" : { - "type" : "string" - } + "$ref" : "#/components/parameters/pretty" } ], - "requestBody" : { - "content" : { - "application/vnd.atlas.2023-02-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/StreamsConnection" - } - } - }, - "description" : "Details to create one connection for a streams instance in the specified project.", - "required" : true - }, "responses" : { "200" : { "content" : { "application/vnd.atlas.2023-02-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/StreamsConnection" - }, "x-xgen-version" : "2023-02-01" } }, "description" : "OK" }, - "400" : { - "$ref" : "#/components/responses/badRequest" - }, "401" : { "$ref" : "#/components/responses/unauthorized" }, - "409" : { - "$ref" : "#/components/responses/unauthorized" - }, "500" : { "$ref" : "#/components/responses/internalServerError" } @@ -16353,35 +16271,22 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Create One Connection", - "tags" : [ "Streams" ], - "x-xgen-changelog" : { - "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." - } + "summary" : "Return All VPC Peering Connections.", + "tags" : [ "Streams" ] } }, - "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}" : { + "/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}" : { "delete" : { - "description" : "Delete one connection of the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role.", - "operationId" : "deleteStreamConnection", + "description" : "Deletes an incoming VPC Peering connection.", + "operationId" : "deleteVPCPeeringConnection", "parameters" : [ { "$ref" : "#/components/parameters/envelope" - }, { - "$ref" : "#/components/parameters/pretty" }, { "$ref" : "#/components/parameters/groupId" }, { - "description" : "Human-readable label that identifies the stream instance.", - "in" : "path", - "name" : "tenantName", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "description" : "Human-readable label that identifies the stream connection.", + "description" : "The VPC Peering Connection id.", "in" : "path", - "name" : "connectionName", + "name" : "id", "required" : true, "schema" : { "type" : "string" @@ -16415,51 +16320,56 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Delete One Stream Connection", - "tags" : [ "Streams" ], - "x-xgen-changelog" : { - "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." - } - }, - "get" : { - "description" : "Returns the details of one stream connection within the specified stream instance. To use this resource, the requesting API Key must have the Project Read Only role.", - "operationId" : "getStreamConnection", + "summary" : "Deletes an incoming VPC Peering connection.", + "tags" : [ "Streams" ] + } + }, + "/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:accept" : { + "post" : { + "description" : "Requests the acceptance of an incoming VPC Peering connection.", + "operationId" : "acceptVPCPeeringConnection", "parameters" : [ { "$ref" : "#/components/parameters/envelope" }, { "$ref" : "#/components/parameters/groupId" }, { - "description" : "Human-readable label that identifies the stream instance to return.", - "in" : "path", - "name" : "tenantName", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "description" : "Human-readable label that identifies the stream connection to return.", + "description" : "The VPC Peering Connection id.", "in" : "path", - "name" : "connectionName", + "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/VPCPeeringActionChallenge" + } + } + }, + "description" : "Challenge values for VPC Peering requester account ID, and requester VPC ID.", + "required" : true + }, "responses" : { - "200" : { + "202" : { "content" : { "application/vnd.atlas.2023-02-01+json" : { "schema" : { - "$ref" : "#/components/schemas/StreamsConnection" + "$ref" : "#/components/schemas/NoBody" }, "x-xgen-version" : "2023-02-01" } }, - "description" : "OK" + "description" : "Accepted" }, "401" : { "$ref" : "#/components/responses/unauthorized" }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, "404" : { "$ref" : "#/components/responses/notFound" }, @@ -16470,63 +16380,38 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Return One Stream Connection", - "tags" : [ "Streams" ], - "x-xgen-changelog" : { - "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." - } - }, - "patch" : { - "description" : "Update one connection for the specified stream instance in the specified project. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role.", - "operationId" : "updateStreamConnection", + "summary" : "Requests the acceptance of an incoming VPC Peering connection.", + "tags" : [ "Streams" ] + } + }, + "/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:reject" : { + "post" : { + "description" : "Requests the rejection of an incoming VPC Peering connection.", + "operationId" : "rejectVPCPeeringConnection", "parameters" : [ { "$ref" : "#/components/parameters/envelope" - }, { - "$ref" : "#/components/parameters/pretty" }, { "$ref" : "#/components/parameters/groupId" }, { - "description" : "Human-readable label that identifies the stream instance.", - "in" : "path", - "name" : "tenantName", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "description" : "Human-readable label that identifies the stream connection.", + "description" : "The VPC Peering Connection id.", "in" : "path", - "name" : "connectionName", + "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], - "requestBody" : { - "content" : { - "application/vnd.atlas.2023-02-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/StreamsConnection" - } - } - }, - "description" : "Details to update one connection for a streams instance in the specified project.", - "required" : true - }, "responses" : { - "200" : { + "202" : { "content" : { "application/vnd.atlas.2023-02-01+json" : { "schema" : { - "$ref" : "#/components/schemas/StreamsConnection" + "$ref" : "#/components/schemas/NoBody" }, "x-xgen-version" : "2023-02-01" } }, - "description" : "OK" - }, - "400" : { - "$ref" : "#/components/responses/badRequest" + "description" : "Accepted" }, "401" : { "$ref" : "#/components/responses/unauthorized" @@ -16544,44 +16429,40 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Update One Stream Connection", - "tags" : [ "Streams" ], - "x-xgen-changelog" : { - "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." - } + "summary" : "Requests the rejection of an incoming VPC Peering connection.", + "tags" : [ "Streams" ] } }, - "/api/atlas/v2/groups/{groupId}/teams" : { - "get" : { - "description" : "Returns all teams to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. All members of the team share the same project access. To use this resource, the requesting API Key must have the Project Read Only role.", - "operationId" : "listProjectTeams", + "/api/atlas/v2/groups/{groupId}/streams/{tenantName}" : { + "delete" : { + "description" : "Delete one stream instance in the specified project. To use this resource, the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role.", + "operationId" : "deleteStreamInstance", "parameters" : [ { "$ref" : "#/components/parameters/envelope" - }, { - "$ref" : "#/components/parameters/groupId" }, { "$ref" : "#/components/parameters/pretty" }, { - "$ref" : "#/components/parameters/includeCount" - }, { - "$ref" : "#/components/parameters/itemsPerPage" + "$ref" : "#/components/parameters/groupId" }, { - "$ref" : "#/components/parameters/pageNum" + "description" : "Human-readable label that identifies the stream instance to delete.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } } ], "responses" : { - "200" : { + "202" : { "content" : { - "application/vnd.atlas.2023-01-01+json" : { + "application/vnd.atlas.2023-02-01+json" : { "schema" : { - "$ref" : "#/components/schemas/PaginatedTeamRoleView" + "$ref" : "#/components/schemas/NoBody" }, - "x-xgen-version" : "2023-01-01" + "x-xgen-version" : "2023-02-01" } }, - "description" : "OK" - }, - "400" : { - "$ref" : "#/components/responses/badRequest" + "description" : "Accepted" }, "401" : { "$ref" : "#/components/responses/unauthorized" @@ -16599,45 +16480,43 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Return All Teams in One Project", - "tags" : [ "Teams" ] + "summary" : "Delete One Stream Instance", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } }, - "post" : { - "description" : "Adds one team to the specified project. All members of the team share the same project access. MongoDB Cloud limits the number of users to a maximum of 100 teams per project and a maximum of 250 teams per organization. To use this resource, the requesting API Key must have the Project Owner role.", - "externalDocs" : { - "description" : "Manage Organization Teams", - "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" - }, - "operationId" : "addAllTeamsToProject", + "get" : { + "description" : "Returns the details of one stream instance within the specified project. To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role.", + "operationId" : "getStreamInstance", "parameters" : [ { "$ref" : "#/components/parameters/envelope" - }, { - "$ref" : "#/components/parameters/pretty" }, { "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance to return.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Flag to indicate whether connections information should be included in the stream instance.", + "in" : "query", + "name" : "includeConnections", + "schema" : { + "type" : "boolean" + } } ], - "requestBody" : { - "content" : { - "application/vnd.atlas.2023-01-01+json" : { - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/TeamRole" - } - } - } - }, - "description" : "Team to add to the specified project.", - "required" : true - }, "responses" : { "200" : { "content" : { - "application/vnd.atlas.2023-01-01+json" : { + "application/vnd.atlas.2023-02-01+json" : { "schema" : { - "$ref" : "#/components/schemas/PaginatedTeamRoleView" + "$ref" : "#/components/schemas/StreamsTenant" }, - "x-xgen-version" : "2023-01-01" + "x-xgen-version" : "2023-02-01" } }, "description" : "OK" @@ -16648,9 +16527,6 @@ "401" : { "$ref" : "#/components/responses/unauthorized" }, - "403" : { - "$ref" : "#/components/responses/forbidden" - }, "404" : { "$ref" : "#/components/responses/notFound" }, @@ -16661,42 +16537,52 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Add One or More Teams to One Project", - "tags" : [ "Teams" ] - } - }, - "/api/atlas/v2/groups/{groupId}/teams/{teamId}" : { - "delete" : { - "description" : "Removes one team specified using its unique 24-hexadecimal digit identifier from the project specified using its unique 24-hexadecimal digit identifier. To use this resource, the requesting API Key must have the Project Owner role.", - "externalDocs" : { - "description" : "Manage Organization Teams", - "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" - }, - "operationId" : "removeProjectTeam", + "summary" : "Return One Stream Instance", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "patch" : { + "description" : "Update one stream instance in the specified project. To use this resource, the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role.", + "operationId" : "updateStreamInstance", "parameters" : [ { "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" }, { "$ref" : "#/components/parameters/groupId" }, { - "description" : "Unique 24-hexadecimal digit string that identifies the team that you want to remove from the specified project.", + "description" : "Human-readable label that identifies the stream instance to update.", "in" : "path", - "name" : "teamId", + "name" : "tenantName", "required" : true, "schema" : { - "type" : "string", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" + "type" : "string" } } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsDataProcessRegion" + } + } + }, + "description" : "Details of the new data process region to update in the streams instance.", + "required" : true + }, "responses" : { - "204" : { + "200" : { "content" : { - "application/vnd.atlas.2023-01-01+json" : { - "x-xgen-version" : "2023-01-01" + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsTenant" + }, + "x-xgen-version" : "2023-02-01" } }, - "description" : "This endpoint does not return a response body." + "description" : "OK" }, "400" : { "$ref" : "#/components/responses/badRequest" @@ -16717,53 +16603,60 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Remove One Team from One Project", - "tags" : [ "Teams" ] - }, - "patch" : { - "description" : "Updates the project roles assigned to the specified team. You can grant team roles for specific projects and grant project access roles to users in the team. All members of the team share the same project access. To use this resource, the requesting API Key must have the Project Owner role.", - "externalDocs" : { - "description" : "Manage Organization Teams", - "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" - }, - "operationId" : "updateTeamRoles", + "summary" : "Update One Stream Instance", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + } + }, + "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/auditLogs" : { + "get" : { + "description" : "Downloads the audit logs for the specified Atlas Streams Processing instance. By default, logs cover periods of 30 days. To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: \"Accept: application/vnd.atlas.YYYY-MM-DD+gzip\".", + "operationId" : "downloadStreamTenantAuditLogs", "parameters" : [ { "$ref" : "#/components/parameters/envelope" }, { "$ref" : "#/components/parameters/groupId" }, { - "$ref" : "#/components/parameters/pretty" + "description" : "Timestamp that specifies the end point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "endDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636481348, + "pattern" : "1199145600" + } }, { - "description" : "Unique 24-hexadecimal digit string that identifies the team for which you want to update roles.", + "description" : "Timestamp that specifies the starting point for the range of log messages to download. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch.", + "in" : "query", + "name" : "startDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "example" : 1636466948, + "pattern" : "1199145600" + } + }, { + "description" : "Human-readable label that identifies the stream instance.", "in" : "path", - "name" : "teamId", + "name" : "tenantName", "required" : true, "schema" : { - "type" : "string", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" + "type" : "string" } } ], - "requestBody" : { - "content" : { - "application/vnd.atlas.2023-01-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/TeamRole" - } - } - }, - "description" : "The project roles assigned to the specified team.", - "required" : true - }, "responses" : { "200" : { "content" : { - "application/vnd.atlas.2023-01-01+json" : { + "application/vnd.atlas.2023-02-01+gzip" : { "schema" : { - "$ref" : "#/components/schemas/PaginatedTeamRoleView" + "type" : "string", + "format" : "binary", + "description" : "Compressed archive labeled `auditLogs.gz` downloads" }, - "x-xgen-version" : "2023-01-01" + "x-xgen-version" : "2023-02-01" } }, "description" : "OK" @@ -16780,6 +16673,9 @@ "404" : { "$ref" : "#/components/responses/notFound" }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, "500" : { "$ref" : "#/components/responses/internalServerError" } @@ -16787,33 +16683,48 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Update Team Roles in One Project", - "tags" : [ "Teams" ] + "summary" : "Download Audit Logs for One Atlas Stream Processing Instance", + "tags" : [ "Streams" ] } }, - "/api/atlas/v2/groups/{groupId}/userSecurity" : { + "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections" : { "get" : { - "description" : "Returns the current LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role.", - "operationId" : "getLDAPConfiguration", + "description" : "Returns all connections of the stream instance for the specified project.To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role.", + "operationId" : "listStreamConnections", "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { "$ref" : "#/components/parameters/envelope" }, { - "$ref" : "#/components/parameters/groupId" + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" }, { "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } } ], "responses" : { "200" : { "content" : { - "application/vnd.atlas.2023-01-01+json" : { + "application/vnd.atlas.2023-02-01+json" : { "schema" : { - "$ref" : "#/components/schemas/UserSecurity" + "$ref" : "#/components/schemas/PaginatedApiStreamsConnectionView" }, - "x-xgen-version" : "2023-01-01" + "x-xgen-version" : "2023-02-01" } }, "description" : "OK" }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, "404" : { "$ref" : "#/components/responses/notFound" }, @@ -16824,47 +16735,61 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Return the Current LDAP or X.509 Configuration", - "tags" : [ "LDAP Configuration" ] + "summary" : "Return All Connections Of The Stream Instances", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } }, - "patch" : { - "description" : "Edits the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role.\n\nUpdating this configuration triggers a rolling restart of the database.", - "operationId" : "saveLDAPConfiguration", + "post" : { + "description" : "Creates one connection for a stream instance in the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Stream Processing Owner role.", + "operationId" : "createStreamConnection", "parameters" : [ { "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" }, { "$ref" : "#/components/parameters/groupId" }, { - "$ref" : "#/components/parameters/pretty" + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } } ], "requestBody" : { "content" : { - "application/vnd.atlas.2023-01-01+json" : { + "application/vnd.atlas.2023-02-01+json" : { "schema" : { - "$ref" : "#/components/schemas/UserSecurity" + "$ref" : "#/components/schemas/StreamsConnection" } } }, - "description" : "Updates the LDAP configuration for the specified project.", + "description" : "Details to create one connection for a streams instance in the specified project.", "required" : true }, "responses" : { - "202" : { + "200" : { "content" : { - "application/vnd.atlas.2023-01-01+json" : { + "application/vnd.atlas.2023-02-01+json" : { "schema" : { - "$ref" : "#/components/schemas/UserSecurity" + "$ref" : "#/components/schemas/StreamsConnection" }, - "x-xgen-version" : "2023-01-01" + "x-xgen-version" : "2023-02-01" } }, - "description" : "Accepted" + "description" : "OK" }, "400" : { "$ref" : "#/components/responses/badRequest" }, - "404" : { - "$ref" : "#/components/responses/notFound" + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "409" : { + "$ref" : "#/components/responses/unauthorized" }, "500" : { "$ref" : "#/components/responses/internalServerError" @@ -16873,31 +16798,58 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Edit the LDAP or X.509 Configuration", - "tags" : [ "LDAP Configuration" ] + "summary" : "Create One Connection", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } } }, - "/api/atlas/v2/groups/{groupId}/userSecurity/customerX509" : { + "/api/atlas/v2/groups/{groupId}/streams/{tenantName}/connections/{connectionName}" : { "delete" : { - "description" : "Clears the customer-managed X.509 settings on a project, including the uploaded Certificate Authority, which disables self-managed X.509.\n\n Updating this configuration triggers a rolling restart of the database. You must have the Project Owner role to use this endpoint.", - "operationId" : "disableCustomerManagedX509", + "description" : "Delete one connection of the specified stream instance. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role.", + "operationId" : "deleteStreamConnection", "parameters" : [ { "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" }, { "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the stream connection.", + "in" : "path", + "name" : "connectionName", + "required" : true, + "schema" : { + "type" : "string" + } } ], "responses" : { "202" : { "content" : { - "application/vnd.atlas.2023-01-01+json" : { + "application/vnd.atlas.2023-02-01+json" : { "schema" : { - "$ref" : "#/components/schemas/UserSecurity" + "$ref" : "#/components/schemas/NoBody" }, - "x-xgen-version" : "2023-01-01" + "x-xgen-version" : "2023-02-01" } }, "description" : "Accepted" }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, "404" : { "$ref" : "#/components/responses/notFound" }, @@ -16908,32 +16860,50 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Disable Customer-Managed X.509", - "tags" : [ "X.509 Authentication" ] - } - }, - "/api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping" : { - "delete" : { - "description" : "Removes the current LDAP Distinguished Name mapping captured in the ``userToDNMapping`` document from the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role.", - "operationId" : "deleteLDAPConfiguration", + "summary" : "Delete One Stream Connection", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "get" : { + "description" : "Returns the details of one stream connection within the specified stream instance. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "getStreamConnection", "parameters" : [ { "$ref" : "#/components/parameters/envelope" }, { "$ref" : "#/components/parameters/groupId" }, { - "$ref" : "#/components/parameters/pretty" + "description" : "Human-readable label that identifies the stream instance to return.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the stream connection to return.", + "in" : "path", + "name" : "connectionName", + "required" : true, + "schema" : { + "type" : "string" + } } ], "responses" : { - "202" : { + "200" : { "content" : { - "application/vnd.atlas.2023-01-01+json" : { + "application/vnd.atlas.2023-02-01+json" : { "schema" : { - "$ref" : "#/components/schemas/UserSecurity" + "$ref" : "#/components/schemas/StreamsConnection" }, - "x-xgen-version" : "2023-01-01" + "x-xgen-version" : "2023-02-01" } }, - "description" : "Accepted" + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" }, "404" : { "$ref" : "#/components/responses/notFound" @@ -16945,32 +16915,507 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Remove the Current LDAP User to DN Mapping", - "tags" : [ "LDAP Configuration" ] - } - }, - "/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify" : { - "post" : { - "description" : "Verifies the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role.", - "operationId" : "verifyLDAPConfiguration", + "summary" : "Return One Stream Connection", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "patch" : { + "description" : "Update one connection for the specified stream instance in the specified project. To use this resource, the requesting API Key must have the Project Owner role or Project Stream Processing Owner role.", + "operationId" : "updateStreamConnection", "parameters" : [ { "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" }, { "$ref" : "#/components/parameters/groupId" }, { - "$ref" : "#/components/parameters/pretty" - } ], - "requestBody" : { - "content" : { - "application/vnd.atlas.2023-01-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequestParams" - } - } - }, - "description" : "The LDAP configuration for the specified project that you want to verify.", - "required" : true - }, + "description" : "Human-readable label that identifies the stream instance.", + "in" : "path", + "name" : "tenantName", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "description" : "Human-readable label that identifies the stream connection.", + "in" : "path", + "name" : "connectionName", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsConnection" + } + } + }, + "description" : "Details to update one connection for a streams instance in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsConnection" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Stream Connection", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + } + }, + "/api/atlas/v2/groups/{groupId}/teams" : { + "get" : { + "description" : "Returns all teams to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. All members of the team share the same project access. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "listProjectTeams", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTeamRoleView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Teams in One Project", + "tags" : [ "Teams" ] + }, + "post" : { + "description" : "Adds one team to the specified project. All members of the team share the same project access. MongoDB Cloud limits the number of users to a maximum of 100 teams per project and a maximum of 250 teams per organization. To use this resource, the requesting API Key must have the Project Owner role.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "addAllTeamsToProject", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/TeamRole" + } + } + } + }, + "description" : "Team to add to the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTeamRoleView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add One or More Teams to One Project", + "tags" : [ "Teams" ] + } + }, + "/api/atlas/v2/groups/{groupId}/teams/{teamId}" : { + "delete" : { + "description" : "Removes one team specified using its unique 24-hexadecimal digit identifier from the project specified using its unique 24-hexadecimal digit identifier. To use this resource, the requesting API Key must have the Project Owner role.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "removeProjectTeam", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team that you want to remove from the specified project.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Team from One Project", + "tags" : [ "Teams" ] + }, + "patch" : { + "description" : "Updates the project roles assigned to the specified team. You can grant team roles for specific projects and grant project access roles to users in the team. All members of the team share the same project access. To use this resource, the requesting API Key must have the Project Owner role.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "updateTeamRoles", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the team for which you want to update roles.", + "in" : "path", + "name" : "teamId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/TeamRole" + } + } + }, + "description" : "The project roles assigned to the specified team.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTeamRoleView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Team Roles in One Project", + "tags" : [ "Teams" ] + } + }, + "/api/atlas/v2/groups/{groupId}/userSecurity" : { + "get" : { + "description" : "Returns the current LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "getLDAPConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return the Current LDAP or X.509 Configuration", + "tags" : [ "LDAP Configuration" ] + }, + "patch" : { + "description" : "Edits the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role.\n\nUpdating this configuration triggers a rolling restart of the database.", + "operationId" : "saveLDAPConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + } + } + }, + "description" : "Updates the LDAP configuration for the specified project.", + "required" : true + }, + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Edit the LDAP or X.509 Configuration", + "tags" : [ "LDAP Configuration" ] + } + }, + "/api/atlas/v2/groups/{groupId}/userSecurity/customerX509" : { + "delete" : { + "description" : "Clears the customer-managed X.509 settings on a project, including the uploaded Certificate Authority, which disables self-managed X.509.\n\n Updating this configuration triggers a rolling restart of the database. You must have the Project Owner role to use this endpoint.", + "operationId" : "disableCustomerManagedX509", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Disable Customer-Managed X.509", + "tags" : [ "X.509 Authentication" ] + } + }, + "/api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping" : { + "delete" : { + "description" : "Removes the current LDAP Distinguished Name mapping captured in the ``userToDNMapping`` document from the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "deleteLDAPConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/UserSecurity" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "Accepted" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove the Current LDAP User to DN Mapping", + "tags" : [ "LDAP Configuration" ] + } + }, + "/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify" : { + "post" : { + "description" : "Verifies the LDAP configuration for the specified project. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "verifyLDAPConfiguration", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/LDAPVerifyConnectivityJobRequestParams" + } + } + }, + "description" : "The LDAP configuration for the specified project that you want to verify.", + "required" : true + }, "responses" : { "200" : { "content" : { @@ -19130,6 +19575,9 @@ }, "description" : "OK" }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, "401" : { "$ref" : "#/components/responses/unauthorized" }, @@ -19756,12 +20204,15 @@ }, "/api/atlas/v2/orgs/{orgId}/users/{userId}" : { "delete" : { + "deprecated" : true, "description" : "Removes one MongoDB Cloud user from the specified organization. To use this resource, the requesting API Key must have the Organization User Admin role.", "operationId" : "removeOrganizationUser", "parameters" : [ { "$ref" : "#/components/parameters/envelope" }, { "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" }, { "description" : "Unique 24-hexadecimal digit string that identifies the user to be deleted.", "in" : "path", @@ -19805,8 +20256,9 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Remove One MongoDB Cloud User from One Organization", - "tags" : [ "Organizations" ] + "summary" : "Remove One MongoDB Cloud User From One Organization", + "tags" : [ "Organizations" ], + "x-sunset" : "2026-01-01" } }, "/api/atlas/v2/orgs/{orgId}/users/{userId}/roles" : { @@ -20527,7 +20979,7 @@ "diskIOPS" : { "type" : "integer", "format" : "int32", - "description" : "Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.\n\n Change this parameter only if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" to \"AWS\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" to \"M30\"` or greater (not including `Mxx_NVME` tiers).\n\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType\" to \"PROVISIONED\"`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1." + "description" : "Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.\n\n Change this parameter if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" to \"AWS\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" to \"M30\"` or greater (not including `Mxx_NVME` tiers).\n\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType\" to \"PROVISIONED\"`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1." }, "ebsVolumeType" : { "type" : "string", @@ -20556,7 +21008,7 @@ "diskIOPS" : { "type" : "integer", "format" : "int32", - "description" : "Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.\n\n You can set different IOPS values on different shards when provisioned IOPS are supported.\n\n Change this parameter only if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" to \"AWS\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" to \"M30\"` or greater (not including `Mxx_NVME` tiers).\n\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType\" to \"PROVISIONED\"`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1." + "description" : "Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.\n\n You can set different IOPS values on different shards when provisioned IOPS are supported.\n\n Change this parameter if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" to \"AWS\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" to \"M30\"` or greater (not including `Mxx_NVME` tiers).\n\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType\" to \"PROVISIONED\"`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1." }, "diskSizeGB" : { "type" : "number", @@ -20887,6 +21339,26 @@ "description" : "Configuration of nodes that comprise the cluster.", "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] }, + "configServerManagementMode" : { + "type" : "string", + "default" : "ATLAS_MANAGED", + "description" : "Config Server Management Mode for creating or updating a sharded cluster.\n\nWhen configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings.\n\nWhen configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server.", + "enum" : [ "ATLAS_MANAGED", "FIXED_TO_DEDICATED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + } + }, + "configServerType" : { + "type" : "string", + "description" : "Describes a sharded cluster's config server type.", + "enum" : [ "DEDICATED", "EMBEDDED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + }, + "readOnly" : true + }, "connectionStrings" : { "$ref" : "#/components/schemas/ClusterConnectionStrings" }, @@ -20922,6 +21394,17 @@ "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" } }, + "featureCompatibilityVersion" : { + "type" : "string", + "description" : "Feature compatibility version of the cluster.", + "readOnly" : true + }, + "featureCompatibilityVersionExpirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Feature compatibility version expiration date.", + "readOnly" : true + }, "globalClusterSelfManagedSharding" : { "type" : "boolean", "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen 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.\n\nWhen 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.\n\nThis setting cannot be changed once the cluster is deployed.", @@ -20968,6 +21451,9 @@ }, "readOnly" : true }, + "mongoDBEmployeeAccessGrant" : { + "$ref" : "#/components/schemas/EmployeeAccessGrantView" + }, "mongoDBMajorVersion" : { "type" : "string", "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", @@ -20987,7 +21473,7 @@ "description" : "Human-readable label that identifies the advanced cluster.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, "paused" : { "type" : "boolean", @@ -21001,6 +21487,16 @@ "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" } }, + "replicaSetScalingStrategy" : { + "type" : "string", + "default" : "WORKLOAD_TYPE", + "description" : "Set this field to configure the replica set scaling mode for your cluster.\n\nBy default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes.\n\nWhen configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads.\n\nWhen configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads.", + "enum" : [ "SEQUENTIAL", "WORKLOAD_TYPE", "NODE_TYPE" ], + "externalDocs" : { + "description" : "Modify the Replica Set Scaling Mode", + "url" : "https://dochub.mongodb.org/core/scale-nodes" + } + }, "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.", @@ -21871,6 +22367,257 @@ }, "title" : "mappings" }, + "ApiAtlasInvalidPolicyErrorDetailView" : { + "type" : "object", + "properties" : { + "detail" : { + "type" : "string", + "description" : "A string that provides a detailed description of a validation error.", + "readOnly" : true + } + } + }, + "ApiAtlasInvalidPolicyView" : { + "type" : "object", + "properties" : { + "body" : { + "type" : "string", + "description" : "A string that defines the permissions for the policy. The syntax used is the Cedar Policy language.", + "example" : " forbid (\n principal,\n action == cloud::Action::\"cluster.createEdit\",\n resource\n ) when {\n context.cluster.regions.contains(cloud::region::\"aws:us-east-1\")\n };\n", + "readOnly" : true + }, + "errors" : { + "type" : "array", + "description" : "List of validation errors.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasInvalidPolicyErrorDetailView" + }, + "readOnly" : true + } + } + }, + "ApiAtlasInvalidResourcePolicyCreateErrorView" : { + "type" : "object", + "properties" : { + "errorType" : { + "type" : "string", + "description" : "Human-readable label that displays the type of an error.", + "enum" : [ "POLICY_PARSING_ERROR", "POLICY_HAS_FAILED_VALIDATIONS", "POLICY_HAS_INVALID_PRINCIPAL", "POLICY_HAS_BODY_EXCEEDING_MAX_SIZE", "POLICY_HAS_UNEXPECTED_ENTITIES" ] + }, + "invalidPolicies" : { + "type" : "array", + "description" : "List of invalid policies containing details of their validation errors.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasInvalidPolicyView" + }, + "readOnly" : true + } + } + }, + "ApiAtlasNonCompliantResourceView" : { + "type" : "object", + "properties" : { + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization the resource belongs to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resourceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the non-compliant resource.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resourcePoliciesCausingNonCompliance" : { + "type" : "array", + "description" : "List of resource policies causing the resource to be considered non-compliant.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasResourcePolicyMetadataView" + }, + "readOnly" : true + }, + "resourceType" : { + "type" : "string", + "description" : "Human-readable label that displays the type of a resource.", + "enum" : [ "PROJECT", "CLUSTER" ], + "readOnly" : true + } + } + }, + "ApiAtlasPolicyCreateView" : { + "type" : "object", + "properties" : { + "body" : { + "type" : "string", + "description" : "A string that defines the permissions for the policy. The syntax used is the Cedar Policy language.", + "example" : " forbid (\n principal,\n action == cloud::Action::\"cluster.createEdit\",\n resource\n ) when {\n context.cluster.regions.contains(cloud::region::\"aws:us-east-1\")\n };\n" + } + }, + "required" : [ "body" ] + }, + "ApiAtlasPolicyMetadataView" : { + "type" : "object", + "properties" : { + "policyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "ApiAtlasPolicyView" : { + "type" : "object", + "properties" : { + "body" : { + "type" : "string", + "description" : "A string that defines the permissions for the policy. The syntax used is the Cedar Policy language.", + "example" : " forbid (\n principal,\n action == cloud::Action::\"cluster.createEdit\",\n resource\n ) when {\n context.cluster.regions.contains(cloud::region::\"aws:us-east-1\")\n };\n", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "ApiAtlasResourcePolicyCreateView" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that describes the atlas resource policy." + }, + "policies" : { + "type" : "array", + "description" : "List of policies that make up the atlas resource policy.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasPolicyCreateView" + } + } + }, + "required" : [ "name", "policies" ] + }, + "ApiAtlasResourcePolicyEditView" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that describes the atlas resource policy." + }, + "policies" : { + "type" : "array", + "description" : "List of policies that make up the atlas resource policy.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasPolicyCreateView" + } + } + } + }, + "ApiAtlasResourcePolicyMetadataView" : { + "type" : "object", + "properties" : { + "policiesCausingNonCompliance" : { + "type" : "array", + "description" : "List of policies that are in conflict with the current state of the resource.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasPolicyMetadataView" + }, + "readOnly" : true + }, + "resourcePolicyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the atlas resource policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resourcePolicyName" : { + "type" : "string", + "description" : "Human-readable label that describes the atlas resource policy.", + "readOnly" : true + } + } + }, + "ApiAtlasResourcePolicyView" : { + "type" : "object", + "properties" : { + "createdByUser" : { + "$ref" : "#/components/schemas/ApiAtlasUserMetadataView" + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time in UTC when the atlas resource policy was created.", + "example" : "2022-01-01T00:00:00Z", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the atlas resource policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastUpdatedByUser" : { + "$ref" : "#/components/schemas/ApiAtlasUserMetadataView" + }, + "lastUpdatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time in UTC when the atlas resource policy was last updated.", + "example" : "2022-01-01T00:00:00Z", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that describes the atlas resource policy.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization the atlas resource policy belongs to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "policies" : { + "type" : "array", + "description" : "List of policies that make up the atlas resource policy.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasPolicyView" + }, + "readOnly" : true + }, + "version" : { + "type" : "string", + "description" : "A string that identifies the version of the atlas resource policy.", + "example" : "v1", + "readOnly" : true + } + } + }, "ApiAtlasSnapshotScheduleView" : { "type" : "object", "properties" : { @@ -21947,6 +22694,27 @@ }, "required" : [ "clusterCheckpointIntervalMin", "clusterId", "dailySnapshotRetentionDays", "groupId", "monthlySnapshotRetentionMonths", "pointInTimeWindowHours", "snapshotIntervalHours", "snapshotRetentionDays", "weeklySnapshotRetentionWeeks" ] }, + "ApiAtlasUserMetadataView" : { + "type" : "object", + "description" : "The user that last updated the atlas resource policy.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies a user.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that describes a user.", + "readOnly" : true + } + }, + "readOnly" : true + }, "ApiBSONTimestampView" : { "type" : "object", "description" : "BSON timestamp that indicates when the checkpoint token entry in the oplog occurred.", @@ -22003,6 +22771,9 @@ "ApiError" : { "type" : "object", "properties" : { + "badRequestDetail" : { + "$ref" : "#/components/schemas/BadRequestDetail" + }, "detail" : { "type" : "string", "description" : "Describes the specific conditions or reasons that cause each type of error." @@ -22013,24 +22784,30 @@ "description" : "HTTP status code returned with this error.", "externalDocs" : { "url" : "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status" - } + }, + "readOnly" : true }, "errorCode" : { "type" : "string", - "description" : "Application error code returned with this error." + "description" : "Application error code returned with this error.", + "readOnly" : true }, "parameters" : { "type" : "array", "description" : "Parameters used to give more information about the error.", "items" : { - "type" : "object" - } + "type" : "object", + "readOnly" : true + }, + "readOnly" : true }, "reason" : { "type" : "string", - "description" : "Application error message returned with this error." + "description" : "Application error message returned with this error.", + "readOnly" : true } - } + }, + "required" : [ "error", "errorCode" ] }, "ApiHostView_Atlas" : { "type" : "object", @@ -22286,6 +23063,24 @@ } } }, + "ApiPrivateDownloadDeliveryUrl" : { + "type" : "object", + "description" : "One Uniform Resource Locator (URL) that points to the compressed snapshot files for manual download and the corresponding private endpoint.", + "properties" : { + "deliveryUrl" : { + "type" : "string", + "description" : "One Uniform Resource Locator that points to the compressed snapshot files for manual download." + }, + "endpointId" : { + "type" : "string", + "description" : "Unique 22-character alphanumeric string that identifies the private endpoint.", + "example" : "vpce-3bf78b0ddee411ba1", + "maxLength" : 22, + "minLength" : 22, + "pattern" : "^vpce-[0-9a-f]{17}$" + } + } + }, "ApiPublicUsageDetailsQueryRequest" : { "type" : "object", "description" : "Request body for an Invoice Usage Details query with filtering, pagination, and sort.", @@ -22379,7 +23174,12 @@ "ApiStreamsAWSRegionView" : { "type" : "string", "description" : "Atlas Streams AWS Regions.", - "enum" : [ "VIRGINIA_USA" ] + "enum" : [ "SYDNEY_AUS", "MUMBAI_IND", "FRANKFURT_DEU", "DUBLIN_IRL", "LONDON_GBR", "VIRGINIA_USA", "OREGON_USA", "SAOPAULO_BRA", "MONTREAL_CAN", "TOKYO_JPN", "SINGAPORE_SGP" ] + }, + "ApiStreamsAzureRegionView" : { + "type" : "string", + "description" : "Atlas Streams Azure Regions.", + "enum" : [ "VIRGINIA_USA", "AMSTERDAM_NLD" ] }, "ApiUserEventTypeViewForNdsGroup" : { "type" : "string", @@ -22603,6 +23403,15 @@ "required" : [ "created", "eventTypeName", "id" ], "title" : "API User Events" }, + "ApiVersion" : { + "type" : "object", + "properties" : { + "version" : { + "type" : "string", + "description" : "Object representing a version of the Atlas Admin API." + } + } + }, "AppServiceAlertConfigViewForNdsGroup" : { "type" : "object", "description" : "App Services metric alert configuration allows to select which app service conditions and events trigger alerts and how users are notified.", @@ -23025,7 +23834,9 @@ "enum" : [ "AVERAGE" ] }, "operator" : { - "$ref" : "#/components/schemas/Operator" + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, "threshold" : { "type" : "number", @@ -23065,6 +23876,11 @@ "description" : "Atlas Data Federation Azure Regions.", "enum" : [ "VIRGINIA_USA", "AMSTERDAM_NLD" ] }, + "AtlasDataFederationGCPRegion" : { + "type" : "string", + "description" : "Atlas Data Federation GCP Regions.", + "enum" : [ "IOWA_USA", "BELGIUM_EU" ] + }, "AtlasOrganization" : { "type" : "object", "description" : "Details that describe the organization.", @@ -23105,6 +23921,122 @@ }, "required" : [ "name" ] }, + "AtlasResourcePolicyAuditForOrg" : { + "type" : "object", + "description" : "Atlas resource policy audits indicate org level changes to resource policies", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "RESOURCE_POLICY_CREATED", "RESOURCE_POLICY_MODIFIED", "RESOURCE_POLICY_DELETED" ], + "example" : "RESOURCE_POLICY_CREATED", + "title" : "Atlas Resource Policy Audit Types" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "resourcePolicyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the resource policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Atlas Resource Policy Audits" + }, "AtlasSearchAnalyzer" : { "type" : "object", "properties" : { @@ -23620,6 +24552,15 @@ "AzureHardwareSpec" : { "type" : "object", "properties" : { + "diskIOPS" : { + "type" : "integer", + "format" : "int32", + "description" : "Target throughput desired for storage attached to your Azure-provisioned cluster. Change this parameter if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" : \"Azure\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : \"M40\"` or greater not including `Mxx_NVME` tiers.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://www.mongodb.com/docs/atlas/customize-storage/#extend-iops-on-azure" + } + }, "instanceSize" : { "type" : "string", "description" : "Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts of the node type.", @@ -23636,6 +24577,15 @@ "AzureHardwareSpec20240805" : { "type" : "object", "properties" : { + "diskIOPS" : { + "type" : "integer", + "format" : "int32", + "description" : "Target throughput desired for storage attached to your Azure-provisioned cluster. Change this parameter if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" : \"Azure\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : \"M40\"` or greater not including `Mxx_NVME` tiers.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://www.mongodb.com/docs/atlas/customize-storage/#extend-iops-on-azure" + } + }, "diskSizeGB" : { "type" : "number", "format" : "double", @@ -23763,7 +24713,7 @@ "status" : { "type" : "string", "description" : "State of the Encryption At Rest private endpoint.", - "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "ACTIVE", "FAILED" ], + "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "ACTIVE", "FAILED", "PENDING_RECREATION", "DELETING" ], "readOnly" : true } }, @@ -24096,7 +25046,7 @@ "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to create an online archive.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "collName" : { @@ -24180,7 +25130,7 @@ "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to create an online archive.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "collName" : { @@ -24283,7 +25233,7 @@ "description" : "Human-readable label that identifies the cluster containing the snapshots you want to retrieve.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -24440,7 +25390,7 @@ "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\"`.\n\nIf the target cluster doesn't have backup enabled, two resources return parameters with empty values:\n\n- **Get All Snapshots** endpoint returns an empty results array without **clusterId** elements\n- **Get a Snapshot** endpoint doesn't return a **clusterId** parameter.\n\nTo return a response with the **clusterId** parameter, either use the **delivery.targetClusterName** parameter or enable backup on the target cluster.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, "targetGroupId" : { "type" : "string", @@ -24701,6 +25651,20 @@ } } }, + "BadRequestDetail" : { + "type" : "object", + "description" : "Bad request detail.", + "properties" : { + "fields" : { + "type" : "array", + "description" : "Describes all violations in a client request.", + "items" : { + "$ref" : "#/components/schemas/FieldViolation" + } + } + }, + "readOnly" : true + }, "BaseAtlasDataLakeRegion" : { "type" : "object", "description" : "Name of the region to which the data lake routes client connections.", @@ -24708,6 +25672,8 @@ "$ref" : "#/components/schemas/ApiAtlasDataLakeAWSRegionView" }, { "$ref" : "#/components/schemas/AtlasDataFederationAzureRegion" + }, { + "$ref" : "#/components/schemas/AtlasDataFederationGCPRegion" } ] }, "BaseCloudProviderInstanceSize" : { @@ -24775,6 +25741,8 @@ "description" : "Name of the cloud provider region hosting Atlas Stream Processing.", "oneOf" : [ { "$ref" : "#/components/schemas/ApiStreamsAWSRegionView" + }, { + "$ref" : "#/components/schemas/ApiStreamsAzureRegionView" } ] }, "BasicBSONList" : { @@ -25664,7 +26632,7 @@ "description" : "Human-readable label that identifies the cluster.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "nodeCount" : { @@ -25716,6 +26684,11 @@ "format" : "date-time", "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." }, + "description" : { + "type" : "string", + "description" : "Description of this database user.", + "maxLength" : 100 + }, "groupId" : { "type" : "string", "description" : "Unique 24-hexadecimal digit string that identifies the project.", @@ -25894,6 +26867,123 @@ "description" : "Details that describe the features linked to the Amazon Web Services (AWS) Identity and Access Management (IAM) role.", "required" : [ "providerName" ] }, + "CloudProviderAccessAWSIAMRoleRequest" : { + "type" : "object", + "description" : "Details that describe the features linked to the Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "properties" : { + "atlasAWSAccountArn" : { + "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.", + "example" : "arn:aws:iam::772401394250:role/my-test-aws-role", + "maxLength" : 2048, + "minLength" : 20, + "readOnly" : true + }, + "atlasAssumedRoleExternalId" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique external ID that MongoDB Cloud uses when it assumes the IAM role in your Amazon Web Services (AWS) account.", + "readOnly" : true + }, + "authorizedDate" : { + "type" : "string", + "format" : "date-time", + "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.", + "readOnly" : true + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "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.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider of the role.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "roleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + }, + "required" : [ "providerName" ] + }, + "CloudProviderAccessAWSIAMRoleRequestUpdate" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessRoleRequestUpdate" + }, { + "type" : "object", + "properties" : { + "atlasAWSAccountArn" : { + "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.", + "example" : "arn:aws:iam::772401394250:role/my-test-aws-role", + "maxLength" : 2048, + "minLength" : 20, + "readOnly" : true + }, + "atlasAssumedRoleExternalId" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique external ID that MongoDB Cloud uses when it assumes the IAM role in your Amazon Web Services (AWS) account.", + "readOnly" : true + }, + "authorizedDate" : { + "type" : "string", + "format" : "date-time", + "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.", + "readOnly" : true + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "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.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "iamAssumedRoleArn" : { + "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", + "maxLength" : 2048, + "minLength" : 20 + }, + "roleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + } ], + "description" : "Details that describe the features linked to the Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "required" : [ "providerName" ] + }, "CloudProviderAccessAzureServicePrincipal" : { "type" : "object", "allOf" : [ { @@ -25956,6 +27046,130 @@ "description" : "Details that describe the features linked to the Azure Service Principal.", "required" : [ "providerName" ] }, + "CloudProviderAccessAzureServicePrincipalRequest" : { + "type" : "object", + "description" : "Details that describe the features linked to the Azure Service Principal.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "atlasAzureAppId" : { + "type" : "string", + "description" : "Azure Active Directory Application ID of Atlas.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this Azure Service Principal was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Azure Service Principal.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "lastUpdatedDate" : { + "type" : "string", + "format" : "date-time", + "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.", + "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.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "tenantId" : { + "type" : "string", + "description" : "UUID String that identifies the Azure Active Directory Tenant ID.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + } + }, + "required" : [ "providerName" ] + }, + "CloudProviderAccessAzureServicePrincipalRequestUpdate" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessRoleRequestUpdate" + }, { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "atlasAzureAppId" : { + "type" : "string", + "description" : "Azure Active Directory Application ID of Atlas.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this Azure Service Principal was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Azure Service Principal.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "lastUpdatedDate" : { + "type" : "string", + "format" : "date-time", + "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.", + "readOnly" : true + }, + "servicePrincipalId" : { + "type" : "string", + "description" : "UUID string that identifies the Azure Service Principal.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "tenantId" : { + "type" : "string", + "description" : "UUID String that identifies the Azure Active Directory Tenant ID.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + } + } + } ], + "description" : "Details that describe the features linked to the Azure Service Principal.", + "required" : [ "providerName" ] + }, "CloudProviderAccessDataLakeFeatureUsage" : { "type" : "object", "allOf" : [ { @@ -26082,6 +27296,92 @@ } } }, + "CloudProviderAccessGCPServiceAccount" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, { + "type" : "object", + "properties" : { + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this Google Service Account was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Google Service Account.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "gcpServiceAccountForAtlas" : { + "type" : "string", + "description" : "Email address for the Google Service Account created by Atlas.", + "maxLength" : 82, + "minLength" : 57, + "pattern" : "^mongodb-atlas-[0-9a-z]{16}@p-[0-9a-z]{24}.iam.gserviceaccount.com$" + }, + "roleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + } ], + "description" : "Details that describe the features linked to the GCP Service Account.", + "required" : [ "providerName" ] + }, + "CloudProviderAccessGCPServiceAccountRequest" : { + "type" : "object", + "description" : "Details that describe the features linked to the GCP Service Account.", + "properties" : { + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this GCP Service Account was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this GCP Service Account.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "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" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "readOnly" : true + } + }, + "required" : [ "providerName" ] + }, + "CloudProviderAccessGCPServiceAccountRequestUpdate" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessRoleRequestUpdate" + } ], + "description" : "Details that describe the features linked to the GCP Service Account.", + "required" : [ "providerName" ] + }, "CloudProviderAccessPushBasedLogExportFeatureUsage" : { "type" : "object", "allOf" : [ { @@ -26102,20 +27402,63 @@ "discriminator" : { "mapping" : { "AWS" : "#/components/schemas/CloudProviderAccessAWSIAMRole", - "AZURE" : "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + "AZURE" : "#/components/schemas/CloudProviderAccessAzureServicePrincipal", + "GCP" : "#/components/schemas/CloudProviderAccessGCPServiceAccount" + }, + "propertyName" : "providerName" + }, + "properties" : { + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider of the role.", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, + "required" : [ "providerName" ] + }, + "CloudProviderAccessRoleRequest" : { + "type" : "object", + "description" : "Cloud provider access role.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/CloudProviderAccessAWSIAMRoleRequest", + "AZURE" : "#/components/schemas/CloudProviderAccessAzureServicePrincipalRequest", + "GCP" : "#/components/schemas/CloudProviderAccessGCPServiceAccountRequest" }, "propertyName" : "providerName" }, "oneOf" : [ { - "$ref" : "#/components/schemas/CloudProviderAccessAWSIAMRole" + "$ref" : "#/components/schemas/CloudProviderAccessAWSIAMRoleRequest" + }, { + "$ref" : "#/components/schemas/CloudProviderAccessAzureServicePrincipalRequest" }, { - "$ref" : "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + "$ref" : "#/components/schemas/CloudProviderAccessGCPServiceAccountRequest" } ], "properties" : { "providerName" : { "type" : "string", "description" : "Human-readable label that identifies the cloud provider of the role.", - "enum" : [ "AWS", "AZURE" ] + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, + "required" : [ "providerName" ] + }, + "CloudProviderAccessRoleRequestUpdate" : { + "type" : "object", + "description" : "Cloud provider access role.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/CloudProviderAccessAWSIAMRoleRequestUpdate", + "AZURE" : "#/components/schemas/CloudProviderAccessAzureServicePrincipalRequestUpdate", + "GCP" : "#/components/schemas/CloudProviderAccessGCPServiceAccountRequestUpdate" + }, + "propertyName" : "providerName" + }, + "properties" : { + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider of the role.", + "enum" : [ "AWS", "AZURE", "GCP" ] } }, "required" : [ "providerName" ] @@ -26129,6 +27472,13 @@ "items" : { "$ref" : "#/components/schemas/CloudProviderAccessAWSIAMRole" } + }, + "azureServicePrincipals" : { + "type" : "array", + "description" : "List that contains the Azure Service Principals registered with MongoDB Cloud.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + } } } }, @@ -26511,7 +27861,7 @@ "example" : "cluster1", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -26604,6 +27954,7 @@ }, "diskGBEnabled" : { "type" : "boolean", + "default" : false, "description" : "Flag that indicates whether someone enabled disk auto-scaling for this cluster." } }, @@ -26633,10 +27984,12 @@ "properties" : { "enabled" : { "type" : "boolean", + "default" : false, "description" : "Flag that indicates whether cluster tier auto-scaling is enabled. Set to `true` to enable cluster tier auto-scaling. If enabled, you must specify a value for **providerSettings.autoScaling.compute.maxInstanceSize** also. Set to `false` to disable cluster tier auto-scaling." }, "scaleDownEnabled" : { "type" : "boolean", + "default" : false, "description" : "Flag that indicates whether the cluster tier can scale down. This is required if **autoScaling.compute.enabled** is `true`. If you enable this option, specify a value for **providerSettings.autoScaling.compute.minInstanceSize**." } } @@ -26671,14 +28024,14 @@ "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.", + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to Atlas through the interface endpoint that the key names. If the cluster uses an optimized connection string, `awsPrivateLinkSrv` contains the optimized connection string. If the cluster has the non-optimized (legacy) connection string, `awsPrivateLinkSrv` contains the non-optimized connection string even if an optimized connection string is also present.", "externalDocs" : { "description" : "Network Peering Connection", "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" }, "readOnly" : true }, - "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.", + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to Atlas through the interface endpoint that the key names. If the cluster uses an optimized connection string, `awsPrivateLinkSrv` contains the optimized connection string. If the cluster has the non-optimized (legacy) connection string, `awsPrivateLinkSrv` contains the non-optimized connection string even if an optimized connection string is also present.", "externalDocs" : { "description" : "Network Peering Connection", "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" @@ -26758,6 +28111,26 @@ "description" : "Configuration of nodes that comprise the cluster.", "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] }, + "configServerManagementMode" : { + "type" : "string", + "default" : "ATLAS_MANAGED", + "description" : "Config Server Management Mode for creating or updating a sharded cluster.\n\nWhen configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings.\n\nWhen configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server.", + "enum" : [ "ATLAS_MANAGED", "FIXED_TO_DEDICATED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + } + }, + "configServerType" : { + "type" : "string", + "description" : "Describes a sharded cluster's config server type.", + "enum" : [ "DEDICATED", "EMBEDDED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + }, + "readOnly" : true + }, "connectionStrings" : { "$ref" : "#/components/schemas/ClusterConnectionStrings" }, @@ -26786,6 +28159,17 @@ "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" } }, + "featureCompatibilityVersion" : { + "type" : "string", + "description" : "Feature compatibility version of the cluster.", + "readOnly" : true + }, + "featureCompatibilityVersionExpirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Feature compatibility version expiration date.", + "readOnly" : true + }, "globalClusterSelfManagedSharding" : { "type" : "boolean", "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen 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.\n\nWhen 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.\n\nThis setting cannot be changed once the cluster is deployed.", @@ -26832,6 +28216,9 @@ }, "readOnly" : true }, + "mongoDBEmployeeAccessGrant" : { + "$ref" : "#/components/schemas/EmployeeAccessGrantView" + }, "mongoDBMajorVersion" : { "type" : "string", "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", @@ -26851,7 +28238,7 @@ "description" : "Human-readable label that identifies the cluster.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, "paused" : { "type" : "boolean", @@ -26865,6 +28252,24 @@ "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" } }, + "redactClientLogData" : { + "type" : "boolean", + "description" : "Enable or disable log redaction.", + "externalDocs" : { + "description" : "This options corresponds to the ``security.redactClientLogData`` cluster parameter.\n\nThis setting configures the ``mongod`` or ``mongos`` to redact any message accompanying a given log event before logging. This prevents the program from writing potentially sensitive data stored on the database to the diagnostic log. Metadata such as error or operation codes, line numbers, and source file names are still visible in the logs.\n\nUse ``redactClientLogData`` in conjunction with Encryption at Rest and TLS/SSL (Transport Encryption) to assist compliance with regulatory requirements.", + "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.redactClientLogData" + } + }, + "replicaSetScalingStrategy" : { + "type" : "string", + "default" : "WORKLOAD_TYPE", + "description" : "Set this field to configure the replica set scaling mode for your cluster.\n\nBy default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes.\n\nWhen configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads.\n\nWhen configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads.", + "enum" : [ "SEQUENTIAL", "WORKLOAD_TYPE", "NODE_TYPE" ], + "externalDocs" : { + "description" : "Modify the Replica Set Scaling Mode", + "url" : "https://dochub.mongodb.org/core/scale-nodes" + } + }, "replicationSpecs" : { "type" : "array", "description" : "List of settings that configure your cluster regions. This array has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations.", @@ -26974,6 +28379,16 @@ "ClusterDescriptionProcessArgs" : { "type" : "object", "properties" : { + "changeStreamOptionsPreAndPostImagesExpireAfterSeconds" : { + "type" : "integer", + "format" : "int32", + "default" : -1, + "description" : "The minimum pre- and post-image retention time in seconds.", + "externalDocs" : { + "description" : "This option corresponds to the ``changeStreamOptions.preAndPostImages.expireAfterSeconds`` cluster parameter. This setting controls the retention policy of change stream pre- and post-images. Pre- and post-images are the versions of a document before and after document modification, respectively. ``expireAfterSeconds`` controls how long MongoDB retains pre- and post-images. When set to -1 (off), MongoDB uses the default retention policy: pre- and post-images are retained until the corresponding change stream events are removed from the oplog. To set the minimum pre- and post-image retention time, specify an integer value greater than zero. Setting this too low could increase the risk of interrupting Realm sync or triggers processing. The default value is -1 (off).", + "url" : "https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/changeStreamOptions/#mongodb-parameter-param.changeStreamOptions.preAndPostImages.expireAfterSeconds" + } + }, "chunkMigrationConcurrency" : { "type" : "integer", "format" : "int32", @@ -26983,6 +28398,15 @@ "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.chunkMigrationConcurrency" } }, + "defaultMaxTimeMS" : { + "type" : "integer", + "format" : "int32", + "description" : "Default time limit in milliseconds for individual read operations to complete.", + "externalDocs" : { + "description" : "This option corresponds to the defaultMaxTimeMS cluster parameter.", + "url" : "https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/defaultMaxTimeMS/" + } + }, "defaultReadConcern" : { "type" : "string", "default" : "available", @@ -27013,7 +28437,7 @@ }, "javascriptEnabled" : { "type" : "boolean", - "description" : "Flag that indicates whether the cluster allows execution of operations that perform server-side executions of JavaScript.", + "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" @@ -27101,6 +28525,16 @@ "ClusterDescriptionProcessArgs20240805" : { "type" : "object", "properties" : { + "changeStreamOptionsPreAndPostImagesExpireAfterSeconds" : { + "type" : "integer", + "format" : "int32", + "default" : -1, + "description" : "The minimum pre- and post-image retention time in seconds.", + "externalDocs" : { + "description" : "This option corresponds to the ``changeStreamOptions.preAndPostImages.expireAfterSeconds`` cluster parameter. This setting controls the retention policy of change stream pre- and post-images. Pre- and post-images are the versions of a document before and after document modification, respectively. ``expireAfterSeconds`` controls how long MongoDB retains pre- and post-images. When set to -1 (off), MongoDB uses the default retention policy: pre- and post-images are retained until the corresponding change stream events are removed from the oplog. To set the minimum pre- and post-image retention time, specify an integer value greater than zero. Setting this too low could increase the risk of interrupting Realm sync or triggers processing. The default value is -1 (off).", + "url" : "https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/changeStreamOptions/#mongodb-parameter-param.changeStreamOptions.preAndPostImages.expireAfterSeconds" + } + }, "chunkMigrationConcurrency" : { "type" : "integer", "format" : "int32", @@ -27110,6 +28544,15 @@ "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.chunkMigrationConcurrency" } }, + "defaultMaxTimeMS" : { + "type" : "integer", + "format" : "int32", + "description" : "Default time limit in milliseconds for individual read operations to complete.", + "externalDocs" : { + "description" : "This option corresponds to the defaultMaxTimeMS cluster parameter.", + "url" : "https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/defaultMaxTimeMS/" + } + }, "defaultWriteConcern" : { "type" : "string", "description" : "Default level of acknowledgment requested from MongoDB for write operations when none is specified by the driver.", @@ -27120,7 +28563,7 @@ }, "javascriptEnabled" : { "type" : "boolean", - "description" : "Flag that indicates whether the cluster allows execution of operations that perform server-side executions of JavaScript.", + "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" @@ -27387,7 +28830,7 @@ "description" : "Human-readable label that identifies the cluster that undergoes outage simulation.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "groupId" : { @@ -27981,7 +29424,8 @@ "discriminator" : { "mapping" : { "AWS" : "#/components/schemas/AWSCreateDataProcessRegionView", - "AZURE" : "#/components/schemas/AzureCreateDataProcessRegionView" + "AZURE" : "#/components/schemas/AzureCreateDataProcessRegionView", + "GCP" : "#/components/schemas/GCPCreateDataProcessRegionView" }, "propertyName" : "cloudProvider" }, @@ -28478,11 +29922,11 @@ }, "roleId" : { "type" : "string", - "description" : "Unique identifier of the role that Data Federation can use to access the data stores.Required if specifying cloudProviderConfig." + "description" : "Unique identifier of the role that Data Federation can use to access the data stores. Required if specifying cloudProviderConfig." }, "servicePrincipalId" : { "type" : "string", - "description" : "The ID of the Service Principal for which there is an access policyfor Atlas to access Azure resources.", + "description" : "The ID of the Service Principal for which there is an access policy for Atlas to access Azure resources.", "readOnly" : true }, "tenantId" : { @@ -28493,6 +29937,22 @@ }, "required" : [ "roleId" ] }, + "DataFederationGCPCloudProviderConfig" : { + "type" : "object", + "description" : "Configuration for running Data Federation in GCP.", + "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" : { + "type" : "string", + "description" : "Unique identifier of the role that Data Federation can use to access the data stores. Required if specifying cloudProviderConfig." + } + }, + "required" : [ "roleId" ] + }, "DataFederationLimit" : { "type" : "object", "description" : "Details of user managed limits.", @@ -28500,6 +29960,7 @@ "mapping" : { "atlas.project.deployment.clusters" : "#/components/schemas/DefaultLimit", "atlas.project.deployment.nodesPerPrivateLinkRegion" : "#/components/schemas/DefaultLimit", + "atlas.project.deployment.salesSoldM0s" : "#/components/schemas/DefaultLimit", "atlas.project.deployment.serverlessMTMs" : "#/components/schemas/DefaultLimit", "atlas.project.security.databaseAccess.customRoles" : "#/components/schemas/DefaultLimit", "atlas.project.security.databaseAccess.users" : "#/components/schemas/DefaultLimit", @@ -28840,9 +30301,12 @@ }, "azure" : { "$ref" : "#/components/schemas/DataFederationAzureCloudProviderConfig" + }, + "gcp" : { + "$ref" : "#/components/schemas/DataFederationGCPCloudProviderConfig" } }, - "title" : "Data Lake Cloud Provider" + "title" : "Data Federation Cloud Provider" }, "DataLakeDLSAWSStore" : { "type" : "object", @@ -28883,7 +30347,7 @@ "cloudProvider" : { "type" : "string", "description" : "Name of the cloud service that hosts the Federated Database Instance's infrastructure.", - "enum" : [ "AWS", "AZURE" ] + "enum" : [ "AWS", "AZURE", "GCP" ] }, "region" : { "$ref" : "#/components/schemas/BaseAtlasDataLakeRegion" @@ -29305,7 +30769,7 @@ "example" : "cluster1", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -29547,7 +31011,9 @@ "enum" : [ "AVERAGE" ] }, "operator" : { - "$ref" : "#/components/schemas/Operator" + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, "threshold" : { "type" : "number", @@ -29590,7 +31056,8 @@ "discriminator" : { "mapping" : { "AWS" : "#/components/schemas/AWSDataProcessRegionView", - "AZURE" : "#/components/schemas/AzureDataProcessRegionView" + "AZURE" : "#/components/schemas/AzureDataProcessRegionView", + "GCP" : "#/components/schemas/GCPDataProcessRegionView" }, "propertyName" : "cloudProvider" }, @@ -29598,7 +31065,7 @@ "cloudProvider" : { "type" : "string", "description" : "Human-readable label that identifies the Cloud service provider where you store your archived data.", - "enum" : [ "AWS", "AZURE" ], + "enum" : [ "AWS", "AZURE", "GCP" ], "readOnly" : true } }, @@ -29825,7 +31292,7 @@ "action" : { "type" : "string", "description" : "Human-readable label that identifies the privilege action.", - "enum" : [ "FIND", "INSERT", "REMOVE", "UPDATE", "BYPASS_DOCUMENT_VALIDATION", "USE_UUID", "KILL_OP", "CREATE_COLLECTION", "CREATE_INDEX", "DROP_COLLECTION", "ENABLE_PROFILER", "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", "STORAGE_GET_CONFIG", "STORAGE_SET_CONFIG", "FLUSH_ROUTER_CONFIG", "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" ] + "enum" : [ "FIND", "INSERT", "REMOVE", "UPDATE", "BYPASS_DOCUMENT_VALIDATION", "USE_UUID", "KILL_OP", "CREATE_COLLECTION", "CREATE_INDEX", "DROP_COLLECTION", "ENABLE_PROFILER", "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", "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", @@ -30104,7 +31571,7 @@ "title" : "Cps Backup Event Types" }, { "type" : "string", - "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEXES_RESTORE_FAILED" ], + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEXES_RESTORE_FAILED", "FTS_INDEXES_SYNONYM_MAPPING_INVALID" ], "title" : "FTS Index Audit Types" }, { "type" : "string", @@ -30247,7 +31714,7 @@ "title" : "Encryption Event Types" }, { "type" : "string", - "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEXES_RESTORE_FAILED" ], + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEXES_RESTORE_FAILED", "FTS_INDEXES_SYNONYM_MAPPING_INVALID" ], "title" : "FTS Index Audit Types" }, { "type" : "string", @@ -30512,7 +31979,7 @@ "title" : "Tenant Backup Event Types" }, { "type" : "string", - "enum" : [ "CLUSTER_VERSION_FIXED", "CLUSTER_VERSION_UNFIXED", "CLUSTER_FCV_FIXED", "CLUSTER_FCV_UNFIXED", "AGENT_VERSION_FIXED", "AGENT_VERSION_UNFIXED", "FIXED_VERSION_UPDATED", "FIXED_AGENT_VERSION_UPDATED", "CLUSTER_FCV_DOWNGRADED" ], + "enum" : [ "CLUSTER_VERSION_FIXED", "CLUSTER_VERSION_UNFIXED", "CLUSTER_FCV_FIXED", "CLUSTER_FCV_UNFIXED", "CLUSTER_FCV_EXPIRATION_DATE_UPDATED", "AGENT_VERSION_FIXED", "AGENT_VERSION_UNFIXED", "FIXED_VERSION_UPDATED", "FIXED_AGENT_VERSION_UPDATED", "CLUSTER_FCV_DOWNGRADED", "CLUSTER_BINARY_VERSION_DOWNGRADED", "CLUSTER_BINARY_VERSION_UPGRADED" ], "title" : "Version Audit Types" } ] }, @@ -30836,7 +32303,6 @@ }, "hostnameSchemaType" : { "type" : "string", - "default" : "PUBLIC", "description" : "The network type to use between the migration host and the destination cluster.", "enum" : [ "PUBLIC", "PRIVATE_LINK", "VPC_PEERING" ] }, @@ -30960,28 +32426,19 @@ "createdAt" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when someone created this export job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "description" : "Date and time when a user or Atlas created the Export Job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", "readOnly" : true }, "customData" : { "type" : "array", - "description" : "Collection of key-value pairs that represent custom data for the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes.", + "description" : "Collection of key-value pairs that represent custom data for the metadata file that MongoDB Cloud uploads when the Export Job finishes.", "items" : { "$ref" : "#/components/schemas/BackupLabel" } }, - "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\"`.", - "items" : { - "type" : "string", - "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download." - }, - "readOnly" : true - }, "exportBucketId" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket to export to.", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -30994,7 +32451,7 @@ "finishedAt" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when this export job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "description" : "Date and time when this Export Job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", "readOnly" : true }, "id" : { @@ -31020,7 +32477,7 @@ }, "prefix" : { "type" : "string", - "description" : "Full path on the cloud provider bucket to the folder where the snapshot is exported.", + "description" : "Prefix used for all blob storage objects uploaded as part of the Export Job.", "pattern" : "/exported_snapshots/\\{ORG-NAME\\}/\\{PROJECT-NAME\\}/\\{CLUSTER-NAME\\}/\\{SNAPSHOT-INITIATION-DATE\\}/\\{TIMESTAMP\\}", "readOnly" : true }, @@ -31034,7 +32491,7 @@ }, "state" : { "type" : "string", - "description" : "State of the export job.", + "description" : "State of the Export Job.", "enum" : [ "Cancelled", "Failed", "InProgress", "Queued", "Successful" ], "readOnly" : true } @@ -31053,7 +32510,7 @@ }, "exportBucketId" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket to export to.", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -31254,7 +32711,15 @@ "properties" : { "downloadUrl" : { "type" : "string", - "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", + "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.", + "items" : { + "$ref" : "#/components/schemas/ApiPrivateDownloadDeliveryUrl" + }, "readOnly" : true }, "replicaSetName" : { @@ -31682,7 +33147,7 @@ "description" : "One or more Uniform Resource Locators (URLs) that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", "items" : { "type" : "string", - "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download." + "description" : "One Uniform Resource Locator that points to the compressed snapshot files for manual download." }, "readOnly" : true }, @@ -31751,6 +33216,14 @@ "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`.", "minimum" : 1199145600 }, + "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.", + "items" : { + "$ref" : "#/components/schemas/ApiPrivateDownloadDeliveryUrl" + }, + "readOnly" : true + }, "snapshotId" : { "type" : "string", "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", @@ -31764,7 +33237,7 @@ "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.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, "targetGroupId" : { "type" : "string", @@ -31804,7 +33277,7 @@ "description" : "Human-readable label that identifies the cluster with the Snapshot you want to return.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "copySettings" : { @@ -31905,7 +33378,7 @@ "description" : "Human-readable label that identifies the cluster with the Snapshot you want to return.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "copySettings" : { @@ -32000,9 +33473,15 @@ "additionalProperties" : { "type" : "object", "description" : "The stats associated with the stream processor.", + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor" + }, "readOnly" : true }, "description" : "The stats associated with the stream processor.", + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor" + }, "readOnly" : true }, "EARPrivateEndpoint" : { @@ -32045,7 +33524,7 @@ "status" : { "type" : "string", "description" : "State of the Encryption At Rest private endpoint.", - "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "ACTIVE", "FAILED" ], + "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "ACTIVE", "FAILED", "PENDING_RECREATION", "DELETING" ], "readOnly" : true } }, @@ -32085,6 +33564,36 @@ "required" : [ "typeName" ], "title" : "Email Notification" }, + "EmployeeAccessGrantView" : { + "type" : "object", + "description" : "MongoDB employee granted access level and expiration for a cluster.", + "properties" : { + "expirationTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Expiration date for the employee access grant." + }, + "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.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "required" : [ "expirationTime", "grantType" ] + }, "EncryptionAtRest" : { "type" : "object", "properties" : { @@ -32099,27 +33608,6 @@ } } }, - "EncryptionAtRestPrivateEndpointRequest" : { - "type" : "object", - "description" : "Create or delete private endpoints from the specified regions list.", - "properties" : { - "cloudProvider" : { - "type" : "string", - "description" : "Cloud service provider name.", - "enum" : [ "AZURE" ] - }, - "regions" : { - "type" : "array", - "description" : "List of regions.", - "items" : { - "type" : "string" - }, - "uniqueItems" : true - } - }, - "required" : [ "cloudProvider" ], - "title" : "Encryption At Rest Private Endpoints setup." - }, "EncryptionKeyAlertConfigViewForNdsGroup" : { "type" : "object", "description" : "Encryption key alert configuration allows to select thresholds which trigger alerts and how users are notified.", @@ -32345,7 +33833,7 @@ "title" : "Export Bucket Audit Types" }, { "type" : "string", - "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEX_CREATED", "FTS_INDEX_UPDATED", "FTS_INDEX_DELETED", "FTS_INDEX_CLEANED_UP", "FTS_INDEXES_RESTORED", "FTS_INDEXES_RESTORE_FAILED" ], + "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" : "FTS Index Audit Types" }, { "type" : "string", @@ -32365,7 +33853,7 @@ "title" : "Group Integration 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_ENOUGH_DISK_SPACE", "HOST_NOT_ENOUGH_DISK_SPACE" ], + "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_ENOUGH_DISK_SPACE", "HOST_NOT_ENOUGH_DISK_SPACE" ], "title" : "Host Event Types" }, { "type" : "string", @@ -32377,7 +33865,7 @@ "title" : "Index Build 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_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_SSL_ROTATED", "CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER", "CLUSTER_INSTANCE_SSL_REVOKED", "RELOAD_SSL_ON_PROCESSES", "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", "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", "MOVE_SKIPPED", "PROXY_RESTARTED", "PROXY_PANICKED", "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", "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", "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", "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", "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", "PENDING_INDEXES_DELETED", "PENDING_INDEXES_CANCELED", "PROCESS_RESTART_REQUESTED", "AUTO_HEALING_ACTION", "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", "CLUSTER_FORCE_RECONFIG_REQUESTED", "PROJECT_BYPASSED_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", "ATLAS_SQL_SCHEDULED_UPDATE_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_MODIFIED", "ATLAS_SQL_SCHEDULED_UPDATE_REMOVED" ], + "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_SSL_ROTATED", "CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER", "CLUSTER_INSTANCE_SSL_REVOKED", "RELOAD_SSL_ON_PROCESSES", "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", "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", "MOVE_SKIPPED", "PROXY_RESTARTED", "PROXY_PANICKED", "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", "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", "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", "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", "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", "CLUSTER_FORCE_RECONFIG_REQUESTED", "PROJECT_BYPASSED_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" ], "title" : "NDS Audit Types" }, { "type" : "string", @@ -32477,7 +33965,7 @@ "title" : "User Event Types" }, { "type" : "string", - "enum" : [ "CLUSTER_VERSION_FIXED", "CLUSTER_VERSION_UNFIXED", "CLUSTER_FCV_FIXED", "CLUSTER_FCV_UNFIXED", "AGENT_VERSION_FIXED", "AGENT_VERSION_UNFIXED", "FIXED_VERSION_UPDATED", "FIXED_AGENT_VERSION_UPDATED", "CLUSTER_FCV_DOWNGRADED" ], + "enum" : [ "CLUSTER_VERSION_FIXED", "CLUSTER_VERSION_UNFIXED", "CLUSTER_FCV_FIXED", "CLUSTER_FCV_UNFIXED", "CLUSTER_FCV_EXPIRATION_DATE_UPDATED", "AGENT_VERSION_FIXED", "AGENT_VERSION_UNFIXED", "FIXED_VERSION_UPDATED", "FIXED_AGENT_VERSION_UPDATED", "CLUSTER_FCV_DOWNGRADED", "CLUSTER_BINARY_VERSION_DOWNGRADED", "CLUSTER_BINARY_VERSION_UPGRADED" ], "title" : "Version Audit Types" }, { "type" : "string", @@ -32547,6 +34035,10 @@ "type" : "string", "enum" : [ "GROUP_TAGS_MODIFIED" ], "title" : "Resource Event Types" + }, { + "type" : "string", + "enum" : [ "RESOURCE_POLICY_CREATED", "RESOURCE_POLICY_MODIFIED", "RESOURCE_POLICY_DELETED" ], + "title" : "Atlas Resource Policy Audit Types" } ] }, "EventViewForNdsGroup" : { @@ -32625,6 +34117,8 @@ "$ref" : "#/components/schemas/UserEventViewForOrg" }, { "$ref" : "#/components/schemas/ResourceEventViewForOrg" + }, { + "$ref" : "#/components/schemas/AtlasResourcePolicyAuditForOrg" } ] }, "ExampleResourceResponse20230101" : { @@ -32685,7 +34179,7 @@ }, "ExportStatus" : { "type" : "object", - "description" : "State of the export job for the collections on the replica set only.", + "description" : "State of the Export Job.", "properties" : { "exportedCollections" : { "type" : "integer", @@ -32720,7 +34214,7 @@ "FTSIndexAuditTypeView" : { "type" : "string", "description" : "Unique identifier of event type.", - "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEX_CREATED", "FTS_INDEX_UPDATED", "FTS_INDEX_DELETED", "FTS_INDEX_CLEANED_UP", "FTS_INDEXES_RESTORED", "FTS_INDEXES_RESTORE_FAILED" ], + "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" ], "example" : "FTS_INDEX_CREATED", "title" : "FTS Index Audit Types" }, @@ -33626,37 +35120,53 @@ }, "title" : "Field Transformation" }, - "ForNdsGroup" : { + "FieldViolation" : { "type" : "object", - "description" : "ReplicaSet Event identifies different activities about replica set of mongod instances.", "properties" : { - "created" : { + "description" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "description" : "A description of why the request element is bad." }, - "eventTypeName" : { - "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroup" + "field" : { + "type" : "string", + "description" : "A path that leads to a field in the request body." + } + }, + "required" : [ "description", "field" ] + }, + "FlexBackupRestoreJob20250101" : { + "type" : "object", + "description" : "Details for one restore job of a flex cluster.", + "properties" : { + "deliveryType" : { + "type" : "string", + "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", + "enum" : [ "RESTORE", "DOWNLOAD" ], + "readOnly" : true }, - "groupId" : { + "expirationDate" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, + "instanceName" : { + "type" : "string", + "description" : "Human-readable label that identifies the source instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "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.", @@ -33669,485 +35179,317 @@ }, "readOnly" : true }, - "orgId" : { + "projectId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "port" : { - "type" : "integer", - "format" : "int32", - "description" : "IANA port on which the MongoDB process listens for requests.", - "example" : 27017, + "restoreFinishedDate" : { + "type" : "string", + "format" : "date-time", + "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.", "readOnly" : true }, - "raw" : { - "$ref" : "#/components/schemas/raw" - }, - "replicaSetName" : { + "restoreScheduledDate" : { "type" : "string", - "description" : "Human-readable label of the replica set associated with the event.", - "example" : "event-replica-set", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "shardName" : { + "snapshotFinishedDate" : { "type" : "string", - "description" : "Human-readable label of the shard associated with the event.", - "example" : "event-sh-01", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true - } - }, - "required" : [ "created", "eventTypeName", "id" ], - "title" : "ReplicaSet Events" - }, - "GCPCloudProviderContainer" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/CloudProviderContainer" - }, { - "type" : "object", - "properties" : { - "atlasCidrBlock" : { - "type" : "string", - "description" : "IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.\n\nThese CIDR blocks must fall within the ranges reserved per RFC 1918. GCP further limits the block to a lower bound of the `/18` range.\n\nTo modify the CIDR block, the target project cannot have:\n\n- Any M10 or greater clusters\n- Any other VPC peering connections\n\n 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.\n\n **Example:** A project in an Google Cloud (GCP) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets.", - "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" - }, - "gcpProjectId" : { - "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.", - "maxLength" : 26, - "minLength" : 26, - "pattern" : "^p-[0-9a-z]{24}$", - "readOnly" : true - }, - "networkName" : { - "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.", - "maxLength" : 36, - "minLength" : 36, - "pattern" : "^nt-[0-9a-f]{24}-[0-9a-z]{8}$", - "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.", - "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.", - "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" ] - } - } - } - } ], - "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", - "required" : [ "atlasCidrBlock" ], - "title" : "GCP" - }, - "GCPComputeAutoScaling" : { - "type" : "object", - "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", - "properties" : { - "maxInstanceSize" : { + }, + "snapshotId" : { "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" ], - "title" : "GCP Instance Sizes" + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "minInstanceSize" : { + "snapshotUrl" : { "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" ], - "title" : "GCP Instance Sizes" - } - }, - "title" : "GCP" - }, - "GCPConsumerForwardingRule" : { - "type" : "object", - "properties" : { - "endpointName" : { + "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" : "Human-readable label that identifies the Google Cloud consumer forwarding rule that you created.", - "externalDocs" : { - "description" : "Google Cloud Forwarding Rule Concepts", - "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" - }, + "description" : "Phase of the restore workflow for this job at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], "readOnly" : true }, - "ipAddress" : { + "targetDeploymentItemName" : { "type" : "string", - "description" : "One Private Internet Protocol version 4 (IPv4) address to which this Google Cloud consumer forwarding rule resolves.", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "description" : "Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another USS instance or Dedicated cluster tier.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", "readOnly" : true }, - "status" : { + "targetProjectId" : { "type" : "string", - "description" : "State of the MongoDB Cloud endpoint group when MongoDB Cloud received this request.", - "enum" : [ "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true } - } + }, + "title" : "Flex Backup Restore Job" }, - "GCPEndpointService" : { + "FlexBackupRestoreJobCreate20250101" : { "type" : "object", - "description" : "Group of Private Endpoint Service settings.", + "description" : "Details to create one restore job of a flex cluster.", "properties" : { - "cloudProvider" : { + "_snapshotId" : { "type" : "string", - "description" : "Cloud service provider that serves the requested endpoint service.", - "enum" : [ "AWS", "AZURE", "GCP" ], - "readOnly" : true + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true }, - "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" - }, - "items" : { - "type" : "string", - "description" : "One Google Cloud network endpoint group that corresponds to the Private Service Connect endpoint service." - } + "_targetDeploymentItemName" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another flex cluster or dedicated cluster tier.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", + "writeOnly" : true }, - "errorMessage" : { + "_targetProjectId" : { "type" : "string", - "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "deliveryType" : { + "type" : "string", + "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", + "enum" : [ "RESTORE", "DOWNLOAD" ], + "readOnly" : true + }, + "expirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "regionName" : { + "instanceName" : { "type" : "string", - "description" : "Cloud provider region that manages this Private Endpoint Service.", + "description" : "Human-readable label that identifies the source instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, - "serviceAttachmentNames" : { + "links" : { "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.", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", "externalDocs" : { - "description" : "Google Cloud Private Service Connect Service Attachments", - "url" : "https://cloud.google.com/vpc/docs/private-service-connect#service-attachments" + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" }, "items" : { - "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.", - "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\\-]+" - } + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true }, - "status" : { + "projectId" : { "type" : "string", - "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", - "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true - } - }, - "required" : [ "cloudProvider" ], - "title" : "GCP" - }, - "GCPHardwareSpec" : { - "type" : "object", - "properties" : { - "instanceSize" : { + }, + "restoreFinishedDate" : { "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" ], - "title" : "GCP Instance Sizes" + "format" : "date-time", + "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.", + "readOnly" : true }, - "nodeCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." - } - } - }, - "GCPHardwareSpec20240805" : { - "type" : "object", - "properties" : { - "diskSizeGB" : { - "type" : "number", - "format" : "double", - "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", - "maximum" : 4096, - "minimum" : 10 - }, - "instanceSize" : { - "type" : "string", - "description" : "Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as \"base nodes\") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.", - "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], - "title" : "GCP Instance Sizes" - }, - "nodeCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." - } - } - }, - "GCPNetworkPeeringConnectionSettings" : { - "type" : "object", - "description" : "Group of Network Peering connection settings.", - "properties" : { - "containerId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" - }, - "errorMessage" : { + "restoreScheduledDate" : { "type" : "string", - "description" : "Details of the error returned when requesting a GCP network peering resource. The resource returns `null` if the request succeeded.", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "gcpProjectId" : { - "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.", - "maxLength" : 30, - "minLength" : 6, - "pattern" : "^[a-z][0-9a-z-]{4,28}[0-9a-z]{1}" - }, - "id" : { + "snapshotFinishedDate" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "networkName" : { - "type" : "string", - "description" : "Human-readable label that identifies the network to peer with the MongoDB Cloud VPC.", - "maxLength" : 63, - "minLength" : 1, - "pattern" : "[a-z]([-a-z0-9]{0,62}[a-z0-9]{0,1})?" - }, - "providerName" : { + "snapshotUrl" : { "type" : "string", - "description" : "Cloud service provider that serves the requested network peering connection.", - "enum" : [ "AWS", "AZURE", "GCP" ] + "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" : "State of the network peering connection at the time you made the request.", - "enum" : [ "ADDING_PEER", "WAITING_FOR_USER", "AVAILABLE", "FAILED", "DELETING" ], + "description" : "Phase of the restore workflow for this job at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], "readOnly" : true } }, - "required" : [ "containerId", "gcpProjectId", "networkName" ], - "title" : "GCP" - }, - "GCPRegionConfig" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/CloudRegionConfig" - }, { - "type" : "object", - "properties" : { - "analyticsAutoScaling" : { - "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" - }, - "analyticsSpecs" : { - "$ref" : "#/components/schemas/DedicatedHardwareSpec" - }, - "autoScaling" : { - "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" - }, - "readOnlySpecs" : { - "$ref" : "#/components/schemas/DedicatedHardwareSpec" - } - } - } ], - "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", - "title" : "GCP Regional Replication Specifications" + "required" : [ "_snapshotId", "_targetDeploymentItemName" ], + "title" : "Create Flex Backup Restore Job" }, - "GCPRegionConfig20240805" : { + "FlexBackupSettings20250101" : { "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/CloudRegionConfig20240805" - }, { - "type" : "object", - "properties" : { - "analyticsAutoScaling" : { - "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" - }, - "analyticsSpecs" : { - "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" - }, - "autoScaling" : { - "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" - }, - "readOnlySpecs" : { - "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" - } + "description" : "Flex backup configuration", + "properties" : { + "enabled" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether backups are performed for this flex cluster. Backup uses [TODO](TODO) for flex clusters.", + "readOnly" : true } - } ], - "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", - "title" : "GCP Regional Replication Specifications" + }, + "readOnly" : true, + "title" : "Flex Backup Configuration" }, - "GeoSharding" : { + "FlexBackupSnapshot20250101" : { "type" : "object", + "description" : "Details for one snapshot of a flex cluster.", "properties" : { - "customZoneMapping" : { - "type" : "object", - "additionalProperties" : { - "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `id` property.\n\nThis parameter returns an empty object if no custom zones exist.", - "readOnly" : true - }, - "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `id` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "expiration" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "managedNamespaces" : { - "type" : "array", - "description" : "List that contains a namespace for a Global Cluster. MongoDB Cloud manages this cluster.", - "items" : { - "$ref" : "#/components/schemas/ManagedNamespaces" - }, + "finishTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "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 - } - } - }, - "GeoSharding20240805" : { - "type" : "object", - "properties" : { - "customZoneMapping" : { - "type" : "object", - "additionalProperties" : { - "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.\n\nThis parameter returns an empty object if no custom zones exist.", - "readOnly" : true - }, - "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "managedNamespaces" : { + "links" : { "type" : "array", - "description" : "List that contains a namespace for a Global Cluster. MongoDB Cloud manages this cluster.", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, "items" : { - "$ref" : "#/components/schemas/ManagedNamespaces" + "$ref" : "#/components/schemas/Link" }, "readOnly" : true }, - "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.", + "mongoDBVersion" : { + "type" : "string", + "description" : "MongoDB host version that the snapshot runs.", "readOnly" : true - } - } - }, - "GoogleCloudKMS" : { - "type" : "object", - "description" : "Details that define the configuration of Encryption at Rest using Google Cloud Key Management Service (KMS).", - "externalDocs" : { - "description" : "Google Cloud Key Management Service", - "url" : "https://www.mongodb.com/docs/atlas/security-gcp-kms/" - }, - "properties" : { - "enabled" : { - "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" : { + "scheduledTime" : { "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" + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will take the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true }, - "serviceAccountKey" : { + "startTime" : { "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.", - "externalDocs" : { - "description" : "Google Cloud Authentication", - "url" : "https://cloud.google.com/docs/authentication/getting-started" - }, - "writeOnly" : true - }, - "valid" : { - "type" : "boolean", - "description" : "Flag that indicates whether the Google Cloud Key Management Service (KMS) encryption key can encrypt and decrypt data.", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began taking the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true - } - } - }, - "GreaterThanDaysThresholdView" : { - "type" : "object", - "description" : "Threshold value that triggers an alert.", - "properties" : { - "operator" : { - "type" : "string", - "description" : "Comparison operator to apply when checking the current metric value.", - "enum" : [ "GREATER_THAN" ] - }, - "threshold" : { - "type" : "integer", - "format" : "int32", - "description" : "Value of metric that, when exceeded, triggers an alert." }, - "units" : { + "status" : { "type" : "string", - "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", - "enum" : [ "DAYS" ] + "description" : "Phase of the workflow for this snapshot at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true } - } + }, + "title" : "Flex Backup Snapshot" }, - "GreaterThanRawThreshold" : { + "FlexBackupSnapshotDownloadCreate20250101" : { "type" : "object", - "description" : "A Limit that triggers an alert when greater than a number.", + "description" : "Details for one backup snapshot download of a flex cluster.", "properties" : { - "operator" : { + "_snapshotId" : { "type" : "string", - "description" : "Comparison operator to apply when checking the current metric value.", - "enum" : [ "GREATER_THAN" ] - }, - "threshold" : { - "type" : "integer", - "format" : "int32", - "description" : "Value of metric that, when exceeded, triggers an alert." + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to download.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true }, - "units" : { - "$ref" : "#/components/schemas/RawMetricUnits" + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true } }, - "title" : "Greater Than Raw Threshold" + "required" : [ "_snapshotId" ], + "title" : "Flex Backup Snapshot Download Create" }, - "GreaterThanRawThresholdAlertConfigViewForNdsGroup" : { + "FlexClusterDescription20250101" : { "type" : "object", + "description" : "Group of settings that configure a MongoDB Flex cluster.", "properties" : { - "created" : { + "backupSettings" : { + "$ref" : "#/components/schemas/FlexBackupSettings20250101" + }, + "clusterType" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Flex cluster topology.", + "enum" : [ "REPLICASET", "LOADBALANCED" ], "readOnly" : true }, - "enabled" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + "connectionStrings" : { + "$ref" : "#/components/schemas/FlexConnectionStrings20250101" }, - "eventTypeName" : { - "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this instance. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true }, "groupId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "description" : "Unique 24-hexadecimal character string that identifies the project.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -34156,7 +35498,7 @@ }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "description" : "Unique 24-hexadecimal digit string that identifies the instance.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -34175,76 +35517,60 @@ }, "readOnly" : true }, - "matchers" : { - "type" : "array", - "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", - "items" : { - "$ref" : "#/components/schemas/ReplicaSetMatcher" - } + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the instance runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true }, - "notifications" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "readOnly" : true + }, + "providerSettings" : { + "$ref" : "#/components/schemas/FlexProviderSettings20250101" + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of this instance.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { "type" : "array", - "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, "items" : { - "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + "$ref" : "#/components/schemas/ResourceTag" } }, - "threshold" : { - "$ref" : "#/components/schemas/GreaterThanRawThreshold" + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." }, - "updated" : { + "versionReleaseSystem" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions.", + "enum" : [ "LTS" ], "readOnly" : true } }, - "required" : [ "eventTypeName", "notifications" ] - }, - "GreaterThanTimeThreshold" : { - "type" : "object", - "description" : "A Limit that triggers an alert when greater than a time period.", - "properties" : { - "operator" : { - "type" : "string", - "description" : "Comparison operator to apply when checking the current metric value.", - "enum" : [ "GREATER_THAN" ] - }, - "threshold" : { - "type" : "integer", - "format" : "int32", - "description" : "Value of metric that, when exceeded, triggers an alert." - }, - "units" : { - "$ref" : "#/components/schemas/TimeMetricUnits" - } - }, - "title" : "Greater Than Time Threshold" + "required" : [ "providerSettings" ], + "title" : "Flex Cluster Description" }, - "Group" : { + "FlexClusterDescriptionCreate20250101" : { "type" : "object", + "description" : "Settings that you can specify when you create a flex cluster.", "properties" : { - "clusterCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Quantity of MongoDB Cloud clusters deployed in this project.", - "readOnly" : true - }, - "created" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created this project. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true - }, - "id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, "links" : { "type" : "array", "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", @@ -34259,111 +35585,899 @@ }, "name" : { "type" : "string", - "description" : "Human-readable label that identifies the project included in the MongoDB Cloud organization.", + "description" : "Human-readable label that identifies the instance.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" - }, - "orgId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud organization to which the project belongs.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "writeOnly" : true }, - "regionUsageRestrictions" : { - "type" : "string", - "default" : "COMMERCIAL_FEDRAMP_REGIONS_ONLY", - "description" : "Applies to Atlas for Government only.\n\nIn Commercial Atlas, this field will be rejected in requests and missing in responses.\n\nThis field sets restrictions on available regions in the project.\n\n| Value | Available Regions |\n|-----------------------------------|------------|\n| `COMMERCIAL_FEDRAMP_REGIONS_ONLY` | Only allows deployments in FedRAMP Moderate regions.|\n| `GOV_REGIONS_ONLY` | Only allows deployments in GovCloud regions.|", - "enum" : [ "COMMERCIAL_FEDRAMP_REGIONS_ONLY", "GOV_REGIONS_ONLY" ], - "externalDocs" : { - "url" : "https://www.mongodb.com/docs/atlas/government/overview/supported-regions/#supported-cloud-providers-and-regions" - } + "providerSettings" : { + "$ref" : "#/components/schemas/FlexProviderSettingsCreate20250101" }, "tags" : { "type" : "array", - "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the project.", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.", "externalDocs" : { "description" : "Resource Tags", - "url" : "https://www.mongodb.com/docs/atlas/tags" + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" }, "items" : { "$ref" : "#/components/schemas/ResourceTag" } }, - "withDefaultAlertsSettings" : { + "terminationProtectionEnabled" : { "type" : "boolean", - "description" : "Flag that indicates whether to create the project with default alert settings.", - "writeOnly" : true + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." } }, - "required" : [ "clusterCount", "created", "name", "orgId" ] - }, - "GroupAlertsConfig" : { - "type" : "object", - "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/StreamProcessorAlertConfigViewForNdsGroup" - } ] + "required" : [ "name", "providerSettings" ], + "title" : "Flex Cluster Description Create" }, - "GroupIPAddresses" : { + "FlexConnectionStrings20250101" : { "type" : "object", - "description" : "List of IP addresses in a project.", + "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, "properties" : { - "groupId" : { + "standard" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "description" : "Public connection string that you can use to connect to this cluster. This connection string uses the mongodb:// protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, "readOnly" : true }, - "services" : { - "$ref" : "#/components/schemas/GroupService" + "standardSrv" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this flex cluster. This connection string uses the `mongodb+srv://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true } }, - "title" : "Group IP Address" + "readOnly" : true, + "title" : "Flex Cluster Connection Strings" }, - "GroupInvitation" : { + "FlexProviderSettings20250101" : { "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB flex cluster.", "properties" : { - "createdAt" : { + "backingProviderName" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud sent the invitation. This parameter expresses its value in ISO 8601 format in UTC.", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the flex cluster.", + "enum" : [ "AWS", "AZURE", "GCP" ], "readOnly" : true }, - "expiresAt" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud expires the invitation. This parameter expresses its value in ISO 8601 format in UTC.", + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity available to the flex cluster expressed in gigabytes.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "default" : "FLEX", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "FLEX" ], + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB flex cluster. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Cloud Service Provider Settings for a Flex Cluster" + }, + "FlexProviderSettingsCreate20250101" : { + "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB flex cluster.", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the flex cluster.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "writeOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity available to the flex cluster expressed in gigabytes.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "default" : "FLEX", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "FLEX" ], + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB flex cluster. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).", + "writeOnly" : true + } + }, + "required" : [ "backingProviderName", "regionName" ], + "title" : "Cloud Service Provider Settings for a Flex Cluster", + "writeOnly" : true + }, + "ForNdsGroup" : { + "type" : "object", + "description" : "ReplicaSet Event identifies different activities about replica set of mongod instances.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "ReplicaSet Events" + }, + "GCPCloudProviderContainer" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, { + "type" : "object", + "properties" : { + "atlasCidrBlock" : { + "type" : "string", + "description" : "IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.\n\nThese CIDR blocks must fall within the ranges reserved per RFC 1918. GCP further limits the block to a lower bound of the `/18` range.\n\nTo modify the CIDR block, the target project cannot have:\n\n- Any M10 or greater clusters\n- Any other VPC peering connections\n\n 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.\n\n **Example:** A project in an Google Cloud (GCP) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets.", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + }, + "gcpProjectId" : { + "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.", + "maxLength" : 26, + "minLength" : 26, + "pattern" : "^p-[0-9a-z]{24}$", + "readOnly" : true + }, + "networkName" : { + "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.", + "maxLength" : 36, + "minLength" : 36, + "pattern" : "^nt-[0-9a-f]{24}-[0-9a-z]{8}$", + "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.", + "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.", + "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" ] + } + } + } + } ], + "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", + "required" : [ "atlasCidrBlock" ], + "title" : "GCP" + }, + "GCPComputeAutoScaling" : { + "type" : "object", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", + "properties" : { + "maxInstanceSize" : { + "type" : "string", + "description" : "Maximum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "minInstanceSize" : { + "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" ], + "title" : "GCP Instance Sizes" + } + }, + "title" : "GCP" + }, + "GCPConsumerForwardingRule" : { + "type" : "object", + "properties" : { + "endpointName" : { + "type" : "string", + "description" : "Human-readable label that identifies the Google Cloud consumer forwarding rule that you created.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "One Private Internet Protocol version 4 (IPv4) address to which this Google Cloud consumer forwarding rule resolves.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the MongoDB Cloud endpoint group when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + } + }, + "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" ] + } + } + } ] + }, + "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.", + "enum" : [ "CENTRAL_US", "WESTERN_EUROPE" ], + "readOnly" : true + } + } + } ] + }, + "GCPEndpointService" : { + "type" : "object", + "description" : "Group of Private Endpoint Service settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "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" + }, + "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" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "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" + }, + "items" : { + "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.", + "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\\-]+" + } + }, + "status" : { + "type" : "string", + "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "GCP" + }, + "GCPHardwareSpec" : { + "type" : "object", + "properties" : { + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts 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" ], + "title" : "GCP Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "GCPHardwareSpec20240805" : { + "type" : "object", + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as \"base nodes\") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "GCPNetworkPeeringConnectionSettings" : { + "type" : "object", + "description" : "Group of Network Peering connection settings.", + "properties" : { + "containerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "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" : { + "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.", + "maxLength" : 30, + "minLength" : 6, + "pattern" : "^[a-z][0-9a-z-]{4,28}[0-9a-z]{1}" + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "networkName" : { + "type" : "string", + "description" : "Human-readable label that identifies the network to peer with the MongoDB Cloud VPC.", + "maxLength" : 63, + "minLength" : 1, + "pattern" : "[a-z]([-a-z0-9]{0,62}[a-z0-9]{0,1})?" + }, + "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.", + "enum" : [ "ADDING_PEER", "WAITING_FOR_USER", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "containerId", "gcpProjectId", "networkName" ], + "title" : "GCP" + }, + "GCPRegionConfig" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "GCP Regional Replication Specifications" + }, + "GCPRegionConfig20240805" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20240805" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "GCP Regional Replication Specifications" + }, + "GeoSharding" : { + "type" : "object", + "properties" : { + "customZoneMapping" : { + "type" : "object", + "additionalProperties" : { + "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `id` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `id` property.\n\nThis 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.", + "items" : { + "$ref" : "#/components/schemas/ManagedNamespaces" + }, + "readOnly" : true + }, + "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 + } + } + }, + "GeoSharding20240805" : { + "type" : "object", + "properties" : { + "customZoneMapping" : { + "type" : "object", + "additionalProperties" : { + "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.\n\nThis 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.", + "items" : { + "$ref" : "#/components/schemas/ManagedNamespaces" + }, + "readOnly" : true + }, + "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 + } + } + }, + "GoogleCloudKMS" : { + "type" : "object", + "description" : "Details that define the configuration of Encryption at Rest using Google Cloud Key Management Service (KMS).", + "externalDocs" : { + "description" : "Google Cloud Key Management Service", + "url" : "https://www.mongodb.com/docs/atlas/security-gcp-kms/" + }, + "properties" : { + "enabled" : { + "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" + }, + "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.", + "externalDocs" : { + "description" : "Google Cloud Authentication", + "url" : "https://cloud.google.com/docs/authentication/getting-started" + }, + "writeOnly" : true + }, + "valid" : { + "type" : "boolean", + "description" : "Flag that indicates whether the Google Cloud Key Management Service (KMS) encryption key can encrypt and decrypt data.", + "readOnly" : true + } + } + }, + "GreaterThanDaysThresholdView" : { + "type" : "object", + "description" : "Threshold value that triggers an alert.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "GREATER_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "DAYS" ] + } + } + }, + "GreaterThanRawThreshold" : { + "type" : "object", + "description" : "A Limit that triggers an alert when greater than a number.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "GREATER_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/RawMetricUnits" + } + }, + "title" : "Greater Than Raw Threshold" + }, + "GreaterThanRawThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ReplicaSetMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/GreaterThanRawThreshold" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ] + }, + "GreaterThanTimeThreshold" : { + "type" : "object", + "description" : "A Limit that triggers an alert when greater than a time period.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "GREATER_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "title" : "Greater Than Time Threshold" + }, + "Group" : { + "type" : "object", + "properties" : { + "clusterCount" : { + "type" : "integer", + "format" : "int64", + "description" : "Quantity of MongoDB Cloud clusters deployed in this project.", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this project. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the project included in the MongoDB Cloud organization.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud organization to which the project belongs.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "regionUsageRestrictions" : { + "type" : "string", + "default" : "COMMERCIAL_FEDRAMP_REGIONS_ONLY", + "description" : "Applies to Atlas for Government only.\n\nIn Commercial Atlas, this field will be rejected in requests and missing in responses.\n\nThis field sets restrictions on available regions in the project.\n\n| Value | Available Regions |\n|-----------------------------------|------------|\n| `COMMERCIAL_FEDRAMP_REGIONS_ONLY` | Only allows deployments in FedRAMP Moderate regions.|\n| `GOV_REGIONS_ONLY` | Only allows deployments in GovCloud regions.|", + "enum" : [ "COMMERCIAL_FEDRAMP_REGIONS_ONLY", "GOV_REGIONS_ONLY" ], + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/government/overview/supported-regions/#supported-cloud-providers-and-regions" + } + }, + "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" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "withDefaultAlertsSettings" : { + "type" : "boolean", + "description" : "Flag that indicates whether to create the project with default alert settings.", + "writeOnly" : true + } + }, + "required" : [ "clusterCount", "created", "name", "orgId" ] + }, + "GroupAlertsConfig" : { + "type" : "object", + "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/StreamProcessorAlertConfigViewForNdsGroup" + } ] + }, + "GroupIPAddresses" : { + "type" : "object", + "description" : "List of IP addresses in a project.", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "services" : { + "$ref" : "#/components/schemas/GroupService" + } + }, + "title" : "Group IP Address" + }, + "GroupInvitation" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud sent the invitation. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud expires the invitation. This parameter expresses its value in ISO 8601 format in UTC.", "readOnly" : true }, "groupId" : { @@ -34503,22 +36617,27 @@ "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "pattern" : "^([a-f0-9]{24})$" }, "destinationOrgPrivateApiKey" : { "type" : "string", - "description" : "Unique string that identifies the private part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.", + "description" : "Unique string that identifies the private part of the API Key used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.", "example" : "55c3bbb6-b4bb-0be1-e66d20841f3e", - "readOnly" : true + "externalDocs" : { + "description" : "Grant Programmatic Access to Atlas", + "url" : "https://dochub.mongodb.org/core/atlas-create-prog-api-key" + } }, "destinationOrgPublicApiKey" : { "type" : "string", - "description" : "Unique string that identifies the public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.", + "description" : "Unique string that identifies the public part of the API Key used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.", "example" : "zmmrboas", + "externalDocs" : { + "description" : "Grant Programmatic Access to Atlas", + "url" : "https://dochub.mongodb.org/core/atlas-create-prog-api-key" + }, "maxLength" : 8, - "minLength" : 8, - "readOnly" : true + "minLength" : 8 } } }, @@ -34585,7 +36704,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/EventViewForNdsGroup" }, @@ -34618,6 +36737,28 @@ } } }, + "GroupRoleAssignment" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to which these roles belong.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "groupRoles" : { + "type" : "array", + "description" : "One or more project level roles assigned to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_OWNER", "GROUP_CLUSTER_MANAGER", "GROUP_STREAM_PROCESSING_OWNER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR" ] + }, + "uniqueItems" : true + } + } + }, "GroupService" : { "type" : "object", "description" : "List of IP addresses in a project categorized by services.", @@ -34637,37 +36778,37 @@ "GroupServiceAccount" : { "type" : "object", "properties" : { + "clientId" : { + "type" : "string", + "description" : "The Client ID of the Service Account.", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + }, "createdAt" : { "type" : "string", "format" : "date-time", - "description" : "Service account creation time." + "description" : "The date that the Service Account was created on." }, "description" : { "type" : "string", - "description" : "Description of the service account." - }, - "id" : { - "type" : "string", - "description" : "ID for the service account.", - "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + "description" : "Human readable description for the Service Account." }, "name" : { "type" : "string", - "description" : "Name for service account." + "description" : "Human-readable name for the Service Account." }, "roles" : { "type" : "array", - "description" : "Roles assigned to the Service Account group.", + "description" : "A list of Project roles associated with the Service Account.", "items" : { "type" : "string", - "description" : "Project roles associated with the service account.", + "description" : "Project roles available for Service Accounts.", "enum" : [ "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" ] }, "uniqueItems" : true }, "secrets" : { "type" : "array", - "description" : "List of secrets.", + "description" : "A list of secrets associated with the specified Service Account.", "items" : { "$ref" : "#/components/schemas/ServiceAccountSecret" }, @@ -34680,73 +36821,74 @@ "properties" : { "description" : { "type" : "string", - "description" : "Human readable description for the service account.", + "description" : "Human readable description for the Service Account.", "maxLength" : 250, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "name" : { "type" : "string", - "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "description" : "Human-readable name for the Service Account. The name is modifiable and does not have to be unique.", "maxLength" : 64, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "roles" : { "type" : "array", - "description" : "Project roles associated with the service account.", + "description" : "A list of project-level roles for the Service Account.", "items" : { "type" : "string", - "description" : "Project roles associated with the service account.", + "description" : "Project roles available for Service Accounts.", "enum" : [ "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" ] } }, "secretExpiresAfterHours" : { "type" : "integer", "format" : "int32", - "description" : "Secret expiration time." + "description" : "The expiration time of the new Service Account secret. The expiration is provided in hours." } }, - "required" : [ "description", "name", "secretExpiresAfterHours" ] + "required" : [ "description", "name", "roles", "secretExpiresAfterHours" ] }, "GroupServiceAccountRoleAssignment" : { "type" : "object", "properties" : { "roles" : { "type" : "array", - "description" : "Group access roles.", + "description" : "The Project permissions for the Service Account in the specified Project.", "items" : { "type" : "string", - "description" : "Project roles associated with the service account.", + "description" : "Project roles available for Service Accounts.", "enum" : [ "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" ] }, "uniqueItems" : true } - } + }, + "required" : [ "roles" ] }, "GroupServiceAccountUpdateRequest" : { "type" : "object", "properties" : { "description" : { "type" : "string", - "description" : "Human readable description for the service account.", + "description" : "Human readable description for the Service Account.", "maxLength" : 250, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "name" : { "type" : "string", - "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "description" : "Human-readable name for the Service Account. The name is modifiable and does not have to be unique.", "maxLength" : 64, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "roles" : { "type" : "array", - "description" : "Project roles associated with the service account.", + "description" : "A list of Project roles associated with the Service Account.", "items" : { "type" : "string", - "description" : "Project roles associated with the service account.", + "description" : "Project roles available for Service Accounts.", "enum" : [ "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" ] } } @@ -34990,7 +37132,7 @@ "example" : "cluster1", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -35085,14 +37227,14 @@ "HostEventTypeViewForNdsGroup" : { "type" : "string", "description" : "Unique identifier of event type.", - "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_ENOUGH_DISK_SPACE", "HOST_NOT_ENOUGH_DISK_SPACE" ], + "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_ENOUGH_DISK_SPACE", "HOST_NOT_ENOUGH_DISK_SPACE" ], "example" : "HOST_DOWN", "title" : "Host Event Types" }, "HostEventTypeViewForNdsGroupAlertable" : { "type" : "string", "description" : "Event type that triggers an alert.", - "enum" : [ "HOST_DOWN", "HOST_HAS_INDEX_SUGGESTIONS", "HOST_MONGOT_CRASHING_OOM", "HOST_NOT_ENOUGH_DISK_SPACE" ], + "enum" : [ "HOST_DOWN", "HOST_HAS_INDEX_SUGGESTIONS", "HOST_MONGOT_CRASHING_OOM", "HOST_MONGOT_STOP_REPLICATION", "HOST_NOT_ENOUGH_DISK_SPACE" ], "example" : "HOST_DOWN", "title" : "Host Event Types" }, @@ -35378,6 +37520,7 @@ "OPCOUNTER_REPL_INSERT" : "#/components/schemas/RawMetricAlertView", "OPCOUNTER_REPL_UPDATE" : "#/components/schemas/RawMetricAlertView", "OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricAlertView", + "OPERATIONS_QUERIES_KILLED" : "#/components/schemas/RawMetricAlertView", "OPERATIONS_SCAN_AND_ORDER" : "#/components/schemas/RawMetricAlertView", "OPERATION_THROTTLING_REJECTED_OPERATIONS" : "#/components/schemas/RawMetricAlertView", "OPLOG_MASTER_LAG_TIME_DIFF" : "#/components/schemas/TimeMetricAlertView", @@ -35447,7 +37590,7 @@ "example" : "cluster1", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -35756,6 +37899,7 @@ "OPCOUNTER_REPL_INSERT" : "#/components/schemas/RawMetricEventView", "OPCOUNTER_REPL_UPDATE" : "#/components/schemas/RawMetricEventView", "OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricEventView", + "OPERATIONS_QUERIES_KILLED" : "#/components/schemas/RawMetricEventView", "OPERATIONS_SCAN_AND_ORDER" : "#/components/schemas/RawMetricEventView", "OPERATION_THROTTLING_REJECTED_OPERATIONS" : "#/components/schemas/RawMetricEventView", "OPLOG_MASTER_LAG_TIME_DIFF" : "#/components/schemas/TimeMetricEventView", @@ -36061,6 +38205,7 @@ "OPCOUNTER_REPL_INSERT" : "#/components/schemas/RawMetricThresholdView", "OPCOUNTER_REPL_UPDATE" : "#/components/schemas/RawMetricThresholdView", "OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "OPERATIONS_QUERIES_KILLED" : "#/components/schemas/RawMetricThresholdView", "OPERATIONS_SCAN_AND_ORDER" : "#/components/schemas/RawMetricThresholdView", "OPERATION_THROTTLING_REJECTED_OPERATIONS" : "#/components/schemas/RawMetricThresholdView", "OPLOG_MASTER_LAG_TIME_DIFF" : "#/components/schemas/TimeMetricThresholdView", @@ -36107,7 +38252,9 @@ "enum" : [ "AVERAGE" ] }, "operator" : { - "$ref" : "#/components/schemas/Operator" + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, "threshold" : { "type" : "number", @@ -36459,7 +38606,7 @@ "description" : "Human-readable label that identifies the cluster that incurred the charge.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -36513,7 +38660,7 @@ "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.", - "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_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", "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_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_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" ], + "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_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", "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_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_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_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" ], "readOnly" : true }, "startDate" : { @@ -36803,6 +38950,323 @@ "description" : "Configuration of nodes that comprise the cluster.", "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] }, + "configServerManagementMode" : { + "type" : "string", + "default" : "ATLAS_MANAGED", + "description" : "Config Server Management Mode for creating or updating a sharded cluster.\n\nWhen configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings.\n\nWhen configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server.", + "enum" : [ "ATLAS_MANAGED", "FIXED_TO_DEDICATED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + } + }, + "configServerType" : { + "type" : "string", + "description" : "Describes a sharded cluster's config server type.", + "enum" : [ "DEDICATED", "EMBEDDED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + }, + "readOnly" : true + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/ClusterConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "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.", + "maximum" : 4096, + "minimum" : 10 + }, + "diskWarmingMode" : { + "type" : "string", + "default" : "FULLY_WARMED", + "description" : "Disk warming mode selection.", + "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], + "externalDocs" : { + "description" : "Reduce Secondary Disk Warming Impact", + "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" + } + }, + "encryptionAtRestProvider" : { + "type" : "string", + "description" : "Cloud service provider that manages your customer keys to provide an additional layer of Encryption at Rest for the cluster.", + "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "featureCompatibilityVersion" : { + "type" : "string", + "description" : "Feature compatibility version of the cluster.", + "readOnly" : true + }, + "featureCompatibilityVersionExpirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Feature compatibility version expiration date.", + "readOnly" : true + }, + "globalClusterSelfManagedSharding" : { + "type" : "boolean", + "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen 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.\n\nWhen 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.\n\nThis 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" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "labels" : { + "type" : "array", + "deprecated" : true, + "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBEmployeeAccessGrant" : { + "$ref" : "#/components/schemas/EmployeeAccessGrantView" + }, + "mongoDBMajorVersion" : { + "type" : "string", + "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", + "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-" + } + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the cluster runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)" + }, + "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.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "mongoURIUpdated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated the connection string. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "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.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + }, + "numShards" : { + "type" : "integer", + "format" : "int32", + "default" : 1, + "description" : "Number of shards up to 50 to deploy for a sharded cluster. The resource returns `1` to indicate a replica set and values of `2` and higher to indicate a sharded cluster. The returned value equals the number of shards in the cluster.", + "externalDocs" : { + "description" : "Sharding", + "url" : "https://docs.mongodb.com/manual/sharding/" + }, + "maximum" : 50, + "minimum" : 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", + "default" : "WORKLOAD_TYPE", + "description" : "Set this field to configure the replica set scaling mode for your cluster.\n\nBy default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes.\n\nWhen configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads.\n\nWhen configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads.", + "enum" : [ "SEQUENTIAL", "WORKLOAD_TYPE", "NODE_TYPE" ], + "externalDocs" : { + "description" : "Modify the Replica Set Scaling Mode", + "url" : "https://dochub.mongodb.org/core/scale-nodes" + } + }, + "replicationFactor" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "deprecated" : true, + "description" : "Number of members that belong to the replica set. Each member retains a copy of your databases, providing high availability and data redundancy. Use **replicationSpecs** instead.", + "enum" : [ 3, 5, 7 ] + }, + "replicationSpec" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RegionSpec" + }, + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "title" : "Region Configuration" + }, + "replicationSpecs" : { + "type" : "array", + "description" : "List of settings that configure your cluster regions.\n\n- For Global Clusters, each object in the array represents one zone where MongoDB Cloud deploys your clusters nodes.\n- For non-Global sharded clusters and replica sets, the single object represents where MongoDB Cloud deploys your clusters nodes.", + "items" : { + "$ref" : "#/components/schemas/LegacyReplicationSpec" + } + }, + "rootCertType" : { + "type" : "string", + "default" : "ISRGROOTX1", + "description" : "Root Certificate Authority that MongoDB Atlas clusters uses. MongoDB Cloud supports Internet Security Research Group.", + "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.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the cluster.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", + "enum" : [ "LTS", "CONTINUOUS" ] + } + }, + "title" : "Cluster Description" + }, + "LegacyAtlasTenantClusterUpgradeRequest" : { + "type" : "object", + "description" : "Request containing target state of tenant cluster to be upgraded", + "properties" : { + "acceptDataRisksAndForceReplicaSetReconfig" : { + "type" : "string", + "format" : "date-time", + "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", + "externalDocs" : { + "description" : "Reconfiguring a Replica Set during a regional outage", + "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + } + }, + "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", + "default" : "ATLAS_MANAGED", + "description" : "Config Server Management Mode for creating or updating a sharded cluster.\n\nWhen configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings.\n\nWhen configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server.", + "enum" : [ "ATLAS_MANAGED", "FIXED_TO_DEDICATED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + } + }, + "configServerType" : { + "type" : "string", + "description" : "Describes a sharded cluster's config server type.", + "enum" : [ "DEDICATED", "EMBEDDED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + }, + "readOnly" : true + }, "connectionStrings" : { "$ref" : "#/components/schemas/ClusterConnectionStrings" }, @@ -36838,6 +39302,17 @@ "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" } }, + "featureCompatibilityVersion" : { + "type" : "string", + "description" : "Feature compatibility version of the cluster.", + "readOnly" : true + }, + "featureCompatibilityVersionExpirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Feature compatibility version expiration date.", + "readOnly" : true + }, "globalClusterSelfManagedSharding" : { "type" : "boolean", "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen 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.\n\nWhen 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.\n\nThis setting cannot be changed once the cluster is deployed.", @@ -36884,6 +39359,9 @@ }, "readOnly" : true }, + "mongoDBEmployeeAccessGrant" : { + "$ref" : "#/components/schemas/EmployeeAccessGrantView" + }, "mongoDBMajorVersion" : { "type" : "string", "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", @@ -36926,7 +39404,7 @@ "description" : "Human-readable label that identifies the cluster.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, "numShards" : { "type" : "integer", @@ -36959,259 +39437,16 @@ "providerSettings" : { "$ref" : "#/components/schemas/ClusterProviderSettings" }, - "replicationFactor" : { - "type" : "integer", - "format" : "int32", - "default" : 3, - "deprecated" : true, - "description" : "Number of members that belong to the replica set. Each member retains a copy of your databases, providing high availability and data redundancy. Use **replicationSpecs** instead.", - "enum" : [ 3, 5, 7 ] - }, - "replicationSpec" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/RegionSpec" - }, - "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", - "title" : "Region Configuration" - }, - "replicationSpecs" : { - "type" : "array", - "description" : "List of settings that configure your cluster regions.\n\n- For Global Clusters, each object in the array represents one zone where MongoDB Cloud deploys your clusters nodes.\n- For non-Global sharded clusters and replica sets, the single object represents where MongoDB Cloud deploys your clusters nodes.", - "items" : { - "$ref" : "#/components/schemas/LegacyReplicationSpec" - } - }, - "rootCertType" : { - "type" : "string", - "default" : "ISRGROOTX1", - "description" : "Root Certificate Authority that MongoDB Atlas clusters uses. MongoDB Cloud supports Internet Security Research Group.", - "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.", - "externalDocs" : { - "description" : "Connection string URI format.", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, - "readOnly" : true - }, - "stateName" : { + "replicaSetScalingStrategy" : { "type" : "string", - "description" : "Human-readable label that indicates the current operating condition of the cluster.", - "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], - "readOnly" : true - }, - "tags" : { - "type" : "array", - "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "default" : "WORKLOAD_TYPE", + "description" : "Set this field to configure the replica set scaling mode for your cluster.\n\nBy default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes.\n\nWhen configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads.\n\nWhen configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads.", + "enum" : [ "SEQUENTIAL", "WORKLOAD_TYPE", "NODE_TYPE" ], "externalDocs" : { - "description" : "Resource Tags", - "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" - }, - "items" : { - "$ref" : "#/components/schemas/ResourceTag" - } - }, - "terminationProtectionEnabled" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." - }, - "versionReleaseSystem" : { - "type" : "string", - "default" : "LTS", - "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", - "enum" : [ "LTS", "CONTINUOUS" ] - } - }, - "title" : "Cluster Description" - }, - "LegacyAtlasTenantClusterUpgradeRequest" : { - "type" : "object", - "description" : "Request containing target state of tenant cluster to be upgraded", - "properties" : { - "acceptDataRisksAndForceReplicaSetReconfig" : { - "type" : "string", - "format" : "date-time", - "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", - "externalDocs" : { - "description" : "Reconfiguring a Replica Set during a regional outage", - "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + "description" : "Modify the Replica Set Scaling Mode", + "url" : "https://dochub.mongodb.org/core/scale-nodes" } }, - "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" ] - }, - "connectionStrings" : { - "$ref" : "#/components/schemas/ClusterConnectionStrings" - }, - "createDate" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", - "readOnly" : true - }, - "diskSizeGB" : { - "type" : "number", - "format" : "double", - "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.", - "maximum" : 4096, - "minimum" : 10 - }, - "diskWarmingMode" : { - "type" : "string", - "default" : "FULLY_WARMED", - "description" : "Disk warming mode selection.", - "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], - "externalDocs" : { - "description" : "Reduce Secondary Disk Warming Impact", - "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" - } - }, - "encryptionAtRestProvider" : { - "type" : "string", - "description" : "Cloud service provider that manages your customer keys to provide an additional layer of Encryption at Rest for the cluster.", - "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], - "externalDocs" : { - "description" : "Encryption at Rest using Customer Key Management", - "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" - } - }, - "globalClusterSelfManagedSharding" : { - "type" : "boolean", - "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen 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.\n\nWhen 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.\n\nThis 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" : { - "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the project.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "labels" : { - "type" : "array", - "deprecated" : true, - "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", - "items" : { - "$ref" : "#/components/schemas/ComponentLabel" - } - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - }, - "mongoDBMajorVersion" : { - "type" : "string", - "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", - "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-" - } - }, - "mongoDBVersion" : { - "type" : "string", - "description" : "Version of MongoDB that the cluster runs.", - "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)" - }, - "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.", - "externalDocs" : { - "description" : "Connection string URI format.", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, - "readOnly" : true - }, - "mongoURIUpdated" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when someone last updated the connection string. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", - "readOnly" : true - }, - "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.", - "externalDocs" : { - "description" : "Connection string URI format.", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "Human-readable label that identifies the cluster.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - }, - "numShards" : { - "type" : "integer", - "format" : "int32", - "default" : 1, - "description" : "Number of shards up to 50 to deploy for a sharded cluster. The resource returns `1` to indicate a replica set and values of `2` and higher to indicate a sharded cluster. The returned value equals the number of shards in the cluster.", - "externalDocs" : { - "description" : "Sharding", - "url" : "https://docs.mongodb.com/manual/sharding/" - }, - "maximum" : 50, - "minimum" : 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" - }, "replicationFactor" : { "type" : "integer", "format" : "int32", @@ -37758,6 +39993,10 @@ "type" : "string", "enum" : [ "INSTANCE_NAME", "PROCESSOR_NAME" ], "title" : "Streams Matcher Fields" + }, { + "type" : "string", + "enum" : [ "RULE_ID" ], + "title" : "Log Ingestion Matcher Fields" } ] }, "MatcherHostType" : { @@ -38408,7 +40647,7 @@ "NDSAuditTypeViewForNdsGroup" : { "type" : "string", "description" : "Unique identifier of event type.", - "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_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_SSL_ROTATED", "CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER", "CLUSTER_INSTANCE_SSL_REVOKED", "RELOAD_SSL_ON_PROCESSES", "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", "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", "MOVE_SKIPPED", "PROXY_RESTARTED", "PROXY_PANICKED", "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", "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", "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", "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", "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", "PENDING_INDEXES_DELETED", "PENDING_INDEXES_CANCELED", "PROCESS_RESTART_REQUESTED", "AUTO_HEALING_ACTION", "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", "CLUSTER_FORCE_RECONFIG_REQUESTED", "PROJECT_BYPASSED_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", "ATLAS_SQL_SCHEDULED_UPDATE_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_MODIFIED", "ATLAS_SQL_SCHEDULED_UPDATE_REMOVED" ], + "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_SSL_ROTATED", "CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER", "CLUSTER_INSTANCE_SSL_REVOKED", "RELOAD_SSL_ON_PROCESSES", "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", "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", "MOVE_SKIPPED", "PROXY_RESTARTED", "PROXY_PANICKED", "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", "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", "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", "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", "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", "CLUSTER_FORCE_RECONFIG_REQUESTED", "PROJECT_BYPASSED_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" ], "example" : "CLUSTER_CREATED", "title" : "NDS Audit Types" }, @@ -39305,7 +41544,7 @@ "example" : "cluster1", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -39547,7 +41786,9 @@ "enum" : [ "AVERAGE" ] }, "operator" : { - "$ref" : "#/components/schemas/Operator" + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, "threshold" : { "type" : "number", @@ -39731,6 +41972,54 @@ "required" : [ "typeName" ], "title" : "OpsGenie Notification" }, + "OrgActiveUserResponse" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OrgUserResponse" + }, { + "type" : "object", + "properties" : { + "country" : { + "type" : "string", + "description" : "Two alphabet characters that identifies MongoDB Cloud user's geographic location. This parameter uses the ISO 3166-1a2 code format.", + "example" : "US", + "pattern" : "^([A-Z]{2})$", + "readOnly" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the current account. This value is in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "firstName" : { + "type" : "string", + "description" : "First or given name that belongs to the MongoDB Cloud user.", + "example" : "John", + "readOnly" : true + }, + "lastAuth" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the current account last authenticated. This value is in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "lastName" : { + "type" : "string", + "description" : "Last name, family name, or surname that belongs to the MongoDB Cloud user.", + "example" : "Doe", + "readOnly" : true + }, + "mobileNumber" : { + "type" : "string", + "description" : "Mobile phone number that belongs to the MongoDB Cloud user.", + "pattern" : "(?:(?:\\\\+?1\\\\s*(?:[.-]\\\\s*)?)?(?:(\\\\s*([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9])\\\\s*)|([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9]))\\\\s*(?:[.-]\\\\s*)?)([2-9]1[02-9]|[2-9][02-9]1|[2-9][02-9]{2})\\\\s*(?:[.-]\\\\s*)?([0-9]{4})$", + "readOnly" : true + } + } + } ], + "required" : [ "createdAt", "firstName", "id", "lastName", "orgMembershipStatus", "roles", "username" ] + }, "OrgEventTypeViewForOrg" : { "type" : "string", "description" : "Unique identifier of event type.", @@ -40012,7 +42301,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/EventViewForOrg" }, @@ -40027,40 +42316,69 @@ } } }, + "OrgPendingUserResponse" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OrgUserResponse" + }, { + "type" : "object", + "properties" : { + "invitationCreatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud sent the invitation. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "invitationExpiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the invitation from MongoDB Cloud expires. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "inviterUsername" : { + "type" : "string", + "format" : "email", + "description" : "Username of the MongoDB Cloud user who sent the invitation to join the organization.", + "readOnly" : true + } + } + } ], + "required" : [ "id", "invitationCreatedAt", "invitationExpiresAt", "inviterUsername", "orgMembershipStatus", "roles", "username" ] + }, "OrgServiceAccount" : { "type" : "object", "properties" : { + "clientId" : { + "type" : "string", + "description" : "The Client ID of the Service Account.", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + }, "createdAt" : { "type" : "string", "format" : "date-time", - "description" : "Service account creation time." + "description" : "The date that the Service Account was created on." }, "description" : { "type" : "string", - "description" : "Description of the service account." - }, - "id" : { - "type" : "string", - "description" : "ID for the service account.", - "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + "description" : "Human readable description for the Service Account." }, "name" : { "type" : "string", - "description" : "Name for service account." + "description" : "Human-readable name for the Service Account." }, "roles" : { "type" : "array", - "description" : "Organization roles assigned to the Service Account.", + "description" : "A list of Organization roles associated with the Service Account.", "items" : { "type" : "string", - "description" : "Organization roles associated with the service account.", + "description" : "Organization roles available for Service Accounts.", "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] }, "uniqueItems" : true }, "secrets" : { "type" : "array", - "description" : "List of secrets.", + "description" : "A list of secrets associated with the specified Service Account.", "items" : { "$ref" : "#/components/schemas/ServiceAccountSecret" }, @@ -40073,63 +42391,215 @@ "properties" : { "description" : { "type" : "string", - "description" : "Human readable description for the service account.", + "description" : "Human readable description for the Service Account.", "maxLength" : 250, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "name" : { "type" : "string", - "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "description" : "Human-readable name for the Service Account. The name is modifiable and does not have to be unique.", "maxLength" : 64, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "roles" : { "type" : "array", - "description" : "Organization roles associated with the service account.", + "description" : "A list of organization-level roles for the Service Account.", "items" : { "type" : "string", - "description" : "Organization roles associated with the service account.", + "description" : "Organization roles available for Service Accounts.", "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] } }, "secretExpiresAfterHours" : { "type" : "integer", "format" : "int32", - "description" : "Secret expiration time." + "description" : "The expiration time of the new Service Account secret. The expiration is provided in hours." } }, - "required" : [ "description", "name", "secretExpiresAfterHours" ] + "required" : [ "description", "name", "roles", "secretExpiresAfterHours" ] }, "OrgServiceAccountUpdateRequest" : { "type" : "object", "properties" : { "description" : { "type" : "string", - "description" : "Human readable description for the service account.", + "description" : "Human readable description for the Service Account.", "maxLength" : 250, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "name" : { "type" : "string", - "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "description" : "Human-readable name for the Service Account. The name is modifiable and does not have to be unique.", "maxLength" : 64, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "roles" : { "type" : "array", - "description" : "Organization roles associated with the Service account.", + "description" : "A list of organization-level roles for the Service Account.", "items" : { "type" : "string", - "description" : "Organization roles associated with the service account.", + "description" : "Organization roles available for Service Accounts.", "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] } } } }, + "OrgUserRequest" : { + "type" : "object", + "properties" : { + "roles" : { + "$ref" : "#/components/schemas/OrgUserRolesRequest" + }, + "teamIds" : { + "type" : "array", + "description" : "List of unique 24-hexadecimal digit strings that identifies the teams to which this MongoDB Cloud user belongs.", + "items" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "uniqueItems" : true, + "writeOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address that represents the username of the MongoDB Cloud user.", + "writeOnly" : true + } + }, + "required" : [ "roles", "username" ] + }, + "OrgUserResponse" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "ACTIVE" : "#/components/schemas/OrgActiveUserResponse", + "PENDING" : "#/components/schemas/OrgPendingUserResponse" + }, + "propertyName" : "orgMembershipStatus" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/OrgPendingUserResponse" + }, { + "$ref" : "#/components/schemas/OrgActiveUserResponse" + } ], + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgMembershipStatus" : { + "type" : "string", + "description" : "String enum that indicates whether the MongoDB Cloud user has a pending invitation to join the organization or they are already active in the organization.", + "enum" : [ "PENDING", "ACTIVE" ], + "readOnly" : true + }, + "roles" : { + "$ref" : "#/components/schemas/OrgUserRolesResponse" + }, + "teamIds" : { + "type" : "array", + "description" : "List of unique 24-hexadecimal digit strings that identifies the teams to which this MongoDB Cloud user belongs.", + "items" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address that represents the username of the MongoDB Cloud user.", + "readOnly" : true + } + }, + "required" : [ "id", "orgMembershipStatus", "roles", "username" ] + }, + "OrgUserRolesRequest" : { + "type" : "object", + "description" : "Organization and project level roles to assign the MongoDB Cloud user within one organization.", + "properties" : { + "groupRoleAssignments" : { + "type" : "array", + "description" : "List of project level role assignments to assign the MongoDB Cloud user.", + "items" : { + "$ref" : "#/components/schemas/GroupRoleAssignment" + } + }, + "orgRoles" : { + "type" : "array", + "description" : "One or more organization level roles to assign the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_READ_ONLY", "ORG_MEMBER" ] + }, + "minItems" : 1, + "uniqueItems" : true + } + }, + "required" : [ "orgRoles" ], + "writeOnly" : true + }, + "OrgUserRolesResponse" : { + "type" : "object", + "description" : "Organization and project level roles assigned to one MongoDB Cloud user within one organization.", + "properties" : { + "groupRoleAssignments" : { + "type" : "array", + "description" : "List of project level role assignments assigned to the MongoDB Cloud user.", + "items" : { + "$ref" : "#/components/schemas/GroupRoleAssignment" + } + }, + "orgRoles" : { + "type" : "array", + "description" : "One or more organization level roles assigned to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_READ_ONLY", "ORG_MEMBER" ] + }, + "uniqueItems" : true + } + }, + "readOnly" : true + }, + "OrgUserUpdateRequest" : { + "type" : "object", + "properties" : { + "roles" : { + "$ref" : "#/components/schemas/OrgUserRolesRequest" + }, + "teamIds" : { + "type" : "array", + "description" : "List of unique 24-hexadecimal digit strings that identifies the teams to assign the MongoDB Cloud user.", + "items" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "uniqueItems" : true, + "writeOnly" : true + } + } + }, "OrganizationInvitation" : { "type" : "object", "properties" : { @@ -40334,7 +42804,7 @@ }, "restrictEmployeeAccess" : { "type" : "boolean", - "description" : "Flag that indicates whether to block MongoDB Support from accessing Atlas infrastructure 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/." + "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/." } } }, @@ -40481,7 +42951,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/AdvancedClusterDescription" }, @@ -40513,7 +42983,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/GroupAlertsConfig" }, @@ -40545,7 +43015,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/AlertViewForNdsGroup" }, @@ -40577,7 +43047,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ApiKeyUserDetails" }, @@ -40609,7 +43079,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/CloudAppUser" }, @@ -40641,7 +43111,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ApiAtlasCheckpointView" }, @@ -40674,7 +43144,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/CloudDatabaseUser" }, @@ -40706,7 +43176,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/DiskBackupExportJob" }, @@ -40738,7 +43208,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/EARPrivateEndpoint" }, @@ -40753,7 +43223,7 @@ } } }, - "PaginatedApiAtlasProviderRegionsView" : { + "PaginatedApiAtlasFlexBackupRestoreJob20250101View" : { "type" : "object", "properties" : { "links" : { @@ -40770,9 +43240,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/CloudProviderRegions" + "$ref" : "#/components/schemas/FlexBackupRestoreJob20250101" }, "readOnly" : true }, @@ -40785,7 +43255,7 @@ } } }, - "PaginatedApiAtlasServerlessBackupRestoreJobView" : { + "PaginatedApiAtlasFlexBackupSnapshot20240710View" : { "type" : "object", "properties" : { "links" : { @@ -40802,9 +43272,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" + "$ref" : "#/components/schemas/FlexBackupSnapshot20250101" }, "readOnly" : true }, @@ -40817,7 +43287,7 @@ } } }, - "PaginatedApiAtlasServerlessBackupSnapshotView" : { + "PaginatedApiAtlasProviderRegionsView" : { "type" : "object", "properties" : { "links" : { @@ -40834,9 +43304,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/ServerlessBackupSnapshot" + "$ref" : "#/components/schemas/CloudProviderRegions" }, "readOnly" : true }, @@ -40849,7 +43319,7 @@ } } }, - "PaginatedApiAtlasUSSBackupRestoreJob20250101View" : { + "PaginatedApiAtlasServerlessBackupRestoreJobView" : { "type" : "object", "properties" : { "links" : { @@ -40866,9 +43336,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/USSBackupRestoreJob20250101" + "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" }, "readOnly" : true }, @@ -40881,7 +43351,7 @@ } } }, - "PaginatedApiAtlasUSSBackupSnapshot20240710View" : { + "PaginatedApiAtlasServerlessBackupSnapshotView" : { "type" : "object", "properties" : { "links" : { @@ -40898,9 +43368,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/USSBackupSnapshot20250101" + "$ref" : "#/components/schemas/ServerlessBackupSnapshot" }, "readOnly" : true }, @@ -40930,7 +43400,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/BillingInvoiceMetadata" }, @@ -40962,7 +43432,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/BillingInvoice" }, @@ -40994,7 +43464,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/StreamsConnection" }, @@ -41009,6 +43479,38 @@ } } }, + "PaginatedApiStreamsPrivateLinkView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", + "items" : { + "$ref" : "#/components/schemas/StreamsPrivateLinkConnection" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, "PaginatedApiStreamsStreamProcessorWithStatsView" : { "type" : "object", "properties" : { @@ -41026,7 +43528,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/StreamsProcessorWithStats" }, @@ -41058,7 +43560,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/StreamsTenant" }, @@ -41090,7 +43592,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/UserAccessListResponse" }, @@ -41105,6 +43607,38 @@ } } }, + "PaginatedApiVersions" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ApiVersion" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, "PaginatedAppUserView" : { "type" : "object", "properties" : { @@ -41122,7 +43656,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/CloudAppUser" }, @@ -41154,7 +43688,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/Group" }, @@ -41186,7 +43720,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/MdbAvailableVersion" }, @@ -41218,7 +43752,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" }, @@ -41250,7 +43784,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/DiskBackupSnapshotExportBucket" }, @@ -41282,7 +43816,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/DiskBackupSnapshot" }, @@ -41314,7 +43848,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/DiskBackupReplicaSet" }, @@ -41346,7 +43880,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/DiskBackupSnapshotRestoreJob" }, @@ -41378,7 +43912,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/DiskBackupShardedClusterSnapshot" }, @@ -41411,7 +43945,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/CloudProviderContainer" }, @@ -41444,7 +43978,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ClusterDescription20240805" }, @@ -41476,7 +44010,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ConnectedOrgConfig" }, @@ -41509,7 +44043,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" }, @@ -41541,7 +44075,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/MesurementsDatabase" }, @@ -41573,7 +44107,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/MeasurementDiskPartition" }, @@ -41605,7 +44139,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/EventTypeDetails" }, @@ -41637,7 +44171,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/FederationIdentityProvider" }, @@ -41652,9 +44186,41 @@ } } }, + "PaginatedFlexClusters20250101" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", + "items" : { + "type" : "object" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, "PaginatedGroupServiceAccounts" : { "type" : "object", - "description" : "List of Service Accounts", + "description" : "A list of Project Service Accounts.", "properties" : { "links" : { "type" : "array", @@ -41670,7 +44236,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/GroupServiceAccount" }, @@ -41702,7 +44268,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ApiHostView_Atlas" }, @@ -41734,7 +44300,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ThirdPartyIntegration" }, @@ -41766,7 +44332,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/LegacyAtlasCluster" }, @@ -41798,7 +44364,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/NetworkPermissionEntry" }, @@ -41830,7 +44396,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/BackupOnlineArchive" }, @@ -41862,7 +44428,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/OrgGroup" }, @@ -41879,7 +44445,7 @@ }, "PaginatedOrgServiceAccounts" : { "type" : "object", - "description" : "List of Service Accounts", + "description" : "A list of Organization Service Accounts.", "properties" : { "links" : { "type" : "array", @@ -41895,7 +44461,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/OrgServiceAccount" }, @@ -41927,7 +44493,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/AtlasOrganization" }, @@ -41959,7 +44525,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/IngestionPipelineRun" }, @@ -41991,7 +44557,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/PrivateNetworkEndpointIdEntry" }, @@ -42023,7 +44589,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/PublicApiUsageDetailsLineItemView" }, @@ -42055,7 +44621,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/BackupRestoreJob" }, @@ -42088,7 +44654,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/AuthFederationRoleMapping" }, @@ -42120,7 +44686,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ServerlessInstanceDescription" }, @@ -42137,7 +44703,7 @@ }, "PaginatedServiceAccountGroup" : { "type" : "object", - "description" : "List of Service Account projects.", + "description" : "A list of projects associated with the Service Account.", "properties" : { "links" : { "type" : "array", @@ -42153,7 +44719,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ServiceAccountGroup" }, @@ -42168,7 +44734,7 @@ } } }, - "PaginatedSnapshotView" : { + "PaginatedServiceAccountIPAccessEntryView" : { "type" : "object", "properties" : { "links" : { @@ -42185,9 +44751,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/BackupSnapshot" + "$ref" : "#/components/schemas/ServiceAccountIPAccessListEntry" }, "readOnly" : true }, @@ -42200,7 +44766,7 @@ } } }, - "PaginatedTeamRoleView" : { + "PaginatedSnapshotView" : { "type" : "object", "properties" : { "links" : { @@ -42217,9 +44783,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/TeamRole" + "$ref" : "#/components/schemas/BackupSnapshot" }, "readOnly" : true }, @@ -42232,7 +44798,7 @@ } } }, - "PaginatedTeamView" : { + "PaginatedTeamRoleView" : { "type" : "object", "properties" : { "links" : { @@ -42249,9 +44815,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/TeamResponse" + "$ref" : "#/components/schemas/TeamRole" }, "readOnly" : true }, @@ -42264,7 +44830,7 @@ } } }, - "PaginatedTenantRestoreView" : { + "PaginatedTeamView" : { "type" : "object", "properties" : { "links" : { @@ -42281,9 +44847,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/TenantRestore" + "$ref" : "#/components/schemas/TeamResponse" }, "readOnly" : true }, @@ -42296,7 +44862,7 @@ } } }, - "PaginatedTenantSnapshotView" : { + "PaginatedTenantRestoreView" : { "type" : "object", "properties" : { "links" : { @@ -42313,9 +44879,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/BackupTenantSnapshot" + "$ref" : "#/components/schemas/TenantRestore" }, "readOnly" : true }, @@ -42328,7 +44894,7 @@ } } }, - "PaginatedUSSInstance20250101" : { + "PaginatedTenantSnapshotView" : { "type" : "object", "properties" : { "links" : { @@ -42345,9 +44911,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "type" : "object" + "$ref" : "#/components/schemas/BackupTenantSnapshot" }, "readOnly" : true }, @@ -42377,7 +44943,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/UserCert" }, @@ -42884,6 +45450,14 @@ "PrivateNetworkEndpointIdEntry" : { "type" : "object", "properties" : { + "azureConnectionName" : { + "type" : "string", + "description" : "Connection name that identifies the Azure private endpoint connection." + }, + "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." @@ -42892,6 +45466,11 @@ "type" : "string", "description" : "Human-readable label to identify customer's VPC endpoint DNS name." }, + "customerEndpointIPAddress" : { + "type" : "string", + "description" : "IP address used to connect to the Azure private endpoint.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + }, "endpointId" : { "type" : "string", "description" : "Unique 22-character alphanumeric string that identifies the private endpoint.", @@ -42904,6 +45483,10 @@ "minLength" : 22, "pattern" : "^vpce-[0-9a-f]{17}$" }, + "errorMessage" : { + "type" : "string", + "description" : "Error message describing a failure approving the private endpoint request." + }, "provider" : { "type" : "string", "default" : "AWS", @@ -42914,6 +45497,11 @@ "type" : "string", "description" : "Human-readable label to identify the region of customer's VPC endpoint." }, + "status" : { + "type" : "string", + "description" : "Status of the private endpoint connection request.", + "enum" : [ "PENDING", "OK", "FAILED", "DELETING" ] + }, "type" : { "type" : "string", "default" : "DATA_LAKE", @@ -42970,20 +45558,6 @@ "required" : [ "enabled", "serviceDiscovery", "username" ], "title" : "PROMETHEUS" }, - "ProxyInfo" : { - "type" : "object", - "description" : "VPC Proxy Information.", - "properties" : { - "authKey" : { - "type" : "string", - "description" : "Authentication key for the proxy." - }, - "dnsName" : { - "type" : "string", - "description" : "DNS name to use to reach the proxy/s." - } - } - }, "PublicApiUsageDetailsLineItemView" : { "type" : "object", "properties" : { @@ -43081,7 +45655,9 @@ "enum" : [ "AVERAGE" ] }, "operator" : { - "$ref" : "#/components/schemas/Operator" + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, "threshold" : { "type" : "number", @@ -43129,7 +45705,7 @@ "example" : "cluster1", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -43371,7 +45947,9 @@ "enum" : [ "AVERAGE" ] }, "operator" : { - "$ref" : "#/components/schemas/Operator" + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, "threshold" : { "type" : "number", @@ -43549,7 +46127,7 @@ "example" : "cluster1", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -43829,472 +46407,69 @@ } }, "zoneName" : { - "type" : "string", - "description" : "Human-readable label that identifies the zone in a Global Cluster. Provide this value only if `\"clusterType\" : \"GEOSHARDED\"`." - } - }, - "title" : "Replication Specifications" - }, - "ReplicationSpec20240805" : { - "type" : "object", - "description" : "Details that explain how MongoDB Cloud replicates data on the specified MongoDB database.", - "properties" : { - "id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a shard in a Cluster. If you include existing shard replication configurations in the request, you must specify this parameter. If you add a new shard to an existing Cluster, you may specify this parameter. The request deletes any existing shards in the Cluster that you exclude from the request.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "regionConfigs" : { - "type" : "array", - "description" : "Hardware specifications for nodes set for a given region. 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**.\n\n**Example:**\n\nIf you set `\"replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize\" : \"M30\"`, set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : `\"M30\"` if you have electable nodes and `\"replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize\" : `\"M30\"` if you have read-only nodes.", - "items" : { - "$ref" : "#/components/schemas/CloudRegionConfig20240805" - } - }, - "zoneId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the zone in a Global Cluster. This value can be used to configure Global Cluster backup policies.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "zoneName" : { - "type" : "string", - "description" : "Human-readable label that describes the zone this shard belongs to in a Global Cluster. Provide this value only if \"clusterType\" : \"GEOSHARDED\" but not \"selfManagedSharding\" : true." - } - }, - "title" : "Replication Specifications" - }, - "RequestAccepted" : { - "type" : "object", - "description" : "Accepted" - }, - "ResourceEventTypeView" : { - "type" : "string", - "description" : "Unique identifier of event type.", - "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], - "example" : "TAGS_MODIFIED", - "title" : "Resource Event Types" - }, - "ResourceEventTypeViewForOrg" : { - "type" : "string", - "description" : "Unique identifier of event type.", - "enum" : [ "GROUP_TAGS_MODIFIED" ], - "example" : "GROUP_TAGS_MODIFIED", - "title" : "Resource Event Types" - }, - "ResourceEventViewForNdsGroup" : { - "type" : "object", - "description" : "Resource event reflects different activities about resources.", - "properties" : { - "apiKeyId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "created" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true - }, - "eventTypeName" : { - "$ref" : "#/components/schemas/ResourceEventTypeView" - }, - "groupId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "isGlobalAdmin" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", - "readOnly" : true - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - }, - "orgId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "publicKey" : { - "type" : "string", - "format" : "email", - "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "example" : "test.user@mongodb.com", - "readOnly" : true - }, - "raw" : { - "$ref" : "#/components/schemas/raw" - }, - "remoteAddress" : { - "type" : "string", - "description" : "IPv4 or IPv6 address from which the user triggered this event.", - "example" : "216.172.40.186", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", - "readOnly" : true - }, - "resourceId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the resource associated with the event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "resourceType" : { - "type" : "string", - "description" : "Unique identifier of resource type.", - "example" : "cluster" - }, - "userId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "username" : { - "type" : "string", - "format" : "email", - "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", - "example" : "test.user@mongodb.com", - "readOnly" : true - } - }, - "required" : [ "created", "eventTypeName", "id", "resourceType" ], - "title" : "Resource Events" - }, - "ResourceEventViewForOrg" : { - "type" : "object", - "description" : "Resource event reflects different activities about resources.", - "properties" : { - "apiKeyId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "created" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true - }, - "eventTypeName" : { - "$ref" : "#/components/schemas/ResourceEventTypeViewForOrg" - }, - "groupId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "isGlobalAdmin" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", - "readOnly" : true - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - }, - "orgId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "publicKey" : { - "type" : "string", - "format" : "email", - "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "example" : "test.user@mongodb.com", - "readOnly" : true - }, - "raw" : { - "$ref" : "#/components/schemas/raw" - }, - "remoteAddress" : { - "type" : "string", - "description" : "IPv4 or IPv6 address from which the user triggered this event.", - "example" : "216.172.40.186", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", - "readOnly" : true - }, - "resourceId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the resource associated with the event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "resourceType" : { - "type" : "string", - "description" : "Unique identifier of resource type.", - "example" : "cluster" - }, - "userId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "username" : { - "type" : "string", - "format" : "email", - "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", - "example" : "test.user@mongodb.com", - "readOnly" : true - } - }, - "required" : [ "created", "eventTypeName", "id", "resourceType" ], - "title" : "Resource Events" - }, - "ResourceTag" : { - "type" : "object", - "description" : "Key-value pair that tags and categorizes a MongoDB Cloud organization, project, or cluster. For example, `environment : production`.", - "properties" : { - "key" : { - "type" : "string", - "description" : "Constant that defines the set of the tag. For example, `environment` in the `environment : production` tag.", - "maxLength" : 255, - "minLength" : 1 - }, - "value" : { - "type" : "string", - "description" : "Variable that belongs to the set of the tag. For example, `production` in the `environment : production` tag.", - "maxLength" : 255, - "minLength" : 1 - } - }, - "required" : [ "key", "value" ], - "title" : "Resource Tag" - }, - "RestoreJobFileHash" : { - "type" : "object", - "description" : "Key and value pair that map one restore file to one hashed checksum. This parameter applies after you download the corresponding **delivery.url**.", - "properties" : { - "fileName" : { - "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.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - }, - "typeName" : { - "type" : "string", - "description" : "Human-readable label that identifies the hashing algorithm used to compute the hash value.", - "enum" : [ "SHA1" ], - "readOnly" : true - } - }, - "readOnly" : true - }, - "RoleAssignment" : { - "type" : "object", - "properties" : { - "groupId" : { - "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", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" - }, - "orgId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization to which this role belongs. Each element within **roleAssignments** can have a value for **orgId** or **groupId**, but not both.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" - }, - "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.\n\nOrganization Roles\n\n* ORG_OWNER\n* ORG_MEMBER\n* ORG_GROUP_CREATOR\n* ORG_BILLING_ADMIN\n* ORG_READ_ONLY\n\nProject Roles\n\n* GROUP_CLUSTER_MANAGER\n* GROUP_DATA_ACCESS_ADMIN\n* GROUP_DATA_ACCESS_READ_ONLY\n* GROUP_DATA_ACCESS_READ_WRITE\n* GROUP_OWNER\n* GROUP_READ_ONLY\n* GROUP_SEARCH_INDEX_EDITOR\n* GROUP_STREAM_PROCESSING_OWNER\n\n", - "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] - } - } - }, - "SMSNotification" : { - "type" : "object", - "description" : "SMS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", - "properties" : { - "delayMin" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." - }, - "intervalMin" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", - "minimum" : 5 - }, - "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" : { - "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" ] + "type" : "string", + "description" : "Human-readable label that identifies the zone in a Global Cluster. Provide this value only if `\"clusterType\" : \"GEOSHARDED\"`." } }, - "required" : [ "typeName" ], - "title" : "SMS Notification" + "title" : "Replication Specifications" }, - "SampleDatasetStatus" : { + "ReplicationSpec20240805" : { "type" : "object", + "description" : "Details that explain how MongoDB Cloud replicates data on the specified MongoDB database.", "properties" : { - "_id" : { + "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies this sample dataset.", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a shard in a Cluster. If you include existing shard replication configurations in the request, you must specify this parameter. If you add a new shard to an existing Cluster, you may specify this parameter. The request deletes any existing shards in the Cluster that you exclude from the request.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "clusterName" : { - "type" : "string", - "description" : "Human-readable label that identifies the cluster into which you loaded the sample dataset.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "readOnly" : true - }, - "completeDate" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when the sample dataset load job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", - "readOnly" : true - }, - "createDate" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when you started the sample dataset load job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", - "readOnly" : true + "regionConfigs" : { + "type" : "array", + "description" : "Hardware specifications for nodes set for a given region. 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**.\n\n**Example:**\n\nIf you set `\"replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize\" : \"M30\"`, set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : `\"M30\"` if you have electable nodes and `\"replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize\" : `\"M30\"` if you have read-only nodes.", + "items" : { + "$ref" : "#/components/schemas/CloudRegionConfig20240805" + } }, - "errorMessage" : { + "zoneId" : { "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.", + "description" : "Unique 24-hexadecimal digit string that identifies the zone in a Global Cluster. This value can be used to configure Global Cluster backup policies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "state" : { + "zoneName" : { "type" : "string", - "description" : "Status of the sample dataset load job.", - "enum" : [ "WORKING", "FAILED", "COMPLETED" ], - "readOnly" : true + "description" : "Human-readable label that describes the zone this shard belongs to in a Global Cluster. Provide this value only if \"clusterType\" : \"GEOSHARDED\" but not \"selfManagedSharding\" : true." } - } + }, + "title" : "Replication Specifications" }, - "SearchDeploymentAuditTypeView" : { + "RequestAccepted" : { + "type" : "object", + "description" : "Accepted" + }, + "ResourceEventTypeView" : { "type" : "string", "description" : "Unique identifier of event type.", - "enum" : [ "SEARCH_DEPLOYMENT_CREATED", "SEARCH_DEPLOYMENT_UPDATED", "SEARCH_DEPLOYMENT_DELETED" ], - "example" : "SEARCH_DEPLOYMENT_CREATED", - "title" : "Search Deployment Audit Types" + "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], + "example" : "TAGS_MODIFIED", + "title" : "Resource Event Types" }, - "SearchDeploymentAuditView" : { + "ResourceEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "GROUP_TAGS_MODIFIED" ], + "example" : "GROUP_TAGS_MODIFIED", + "title" : "Resource Event Types" + }, + "ResourceEventViewForNdsGroup" : { "type" : "object", - "description" : "Indicates activities on decoupled search nodes.", + "description" : "Resource event reflects different activities about resources.", "properties" : { "apiKeyId" : { "type" : "string", @@ -44312,7 +46487,7 @@ "readOnly" : true }, "eventTypeName" : { - "$ref" : "#/components/schemas/SearchDeploymentAuditTypeView" + "$ref" : "#/components/schemas/ResourceEventTypeView" }, "groupId" : { "type" : "string", @@ -44363,6 +46538,7 @@ "type" : "string", "format" : "email", "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true }, "raw" : { @@ -44375,6 +46551,20 @@ "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", "readOnly" : true }, + "resourceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the resource associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resourceType" : { + "type" : "string", + "description" : "Unique identifier of resource type.", + "example" : "cluster" + }, "userId" : { "type" : "string", "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", @@ -44392,541 +46582,159 @@ "readOnly" : true } }, - "required" : [ "created", "eventTypeName", "id" ], - "title" : "Search Deployment Audits" - }, - "SearchHostStatusDetail" : { - "type" : "object", - "properties" : { - "hostname" : { - "type" : "string", - "description" : "Hostname that corresponds to the status detail." - }, - "mainIndex" : { - "$ref" : "#/components/schemas/SearchMainIndexStatusDetail" - }, - "queryable" : { - "type" : "boolean", - "description" : "Flag that indicates whether the index is queryable on the host." - }, - "stagedIndex" : { - "$ref" : "#/components/schemas/SearchStagedIndexStatusDetail" - }, - "status" : { - "type" : "string", - "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", - "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] - } - }, - "title" : "Search Host Status Detail" - }, - "SearchIndex" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/ClusterSearchIndex" - }, { - "type" : "object", - "properties" : { - "analyzer" : { - "type" : "string", - "default" : "lucene.standard", - "description" : "Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves a variety of changes made to the text in fields:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\n MongoDB Cloud uses the selected process to build the Atlas Search index.", - "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ], - "externalDocs" : { - "description" : "Atlas Search Analyzers", - "url" : "https://dochub.mongodb.org/core/analyzers--fts" - } - }, - "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" - }, - "items" : { - "$ref" : "#/components/schemas/ApiAtlasFTSAnalyzersViewManual" - } - }, - "mappings" : { - "$ref" : "#/components/schemas/ApiAtlasFTSMappingsViewManual" - }, - "searchAnalyzer" : { - "type" : "string", - "default" : "lucene.standard", - "description" : "Method applied to identify words when searching this index.", - "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] - }, - "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" - }, - "items" : { - "$ref" : "#/components/schemas/SearchSynonymMappingDefinition" - } - } - } - } ], - "required" : [ "collectionName", "database", "name" ] - }, - "SearchIndexCreateRequest" : { - "type" : "object", - "discriminator" : { - "mapping" : { - "search" : "#/components/schemas/TextSearchIndexCreateRequest", - "vectorSearch" : "#/components/schemas/VectorSearchIndexCreateRequest" - }, - "propertyName" : "type" - }, - "properties" : { - "collectionName" : { - "type" : "string", - "description" : "Label that identifies the collection to create an Atlas Search index in." - }, - "database" : { - "type" : "string", - "description" : "Label that identifies the database that contains the collection to create an Atlas Search index in." - }, - "name" : { - "type" : "string", - "description" : "Label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique." - }, - "type" : { - "type" : "string", - "description" : "Type of the index. The default type is search.", - "enum" : [ "search", "vectorSearch" ] - } - }, - "required" : [ "collectionName", "database", "name" ] - }, - "SearchIndexDefinition" : { - "type" : "object", - "description" : "The search index definition set by the user.", - "title" : "Search Index Definition" - }, - "SearchIndexDefinitionVersion" : { - "type" : "object", - "description" : "Object which includes the version number of the index definition and the time that the index definition was created.", - "properties" : { - "createdAt" : { - "type" : "string", - "format" : "date-time", - "description" : "The time at which this index definition was created." - }, - "version" : { - "type" : "integer", - "format" : "int64", - "description" : "The version number associated with this index definition when it was created." - } - }, - "title" : "Search Index Definition Version" + "required" : [ "created", "eventTypeName", "id", "resourceType" ], + "title" : "Resource Events" }, - "SearchIndexResponse" : { + "ResourceEventViewForOrg" : { "type" : "object", - "discriminator" : { - "mapping" : { - "search" : "#/components/schemas/TextSearchIndexResponse", - "vectorSearch" : "#/components/schemas/VectorSearchIndexResponse" - }, - "propertyName" : "type" - }, + "description" : "Resource event reflects different activities about resources.", "properties" : { - "collectionName" : { - "type" : "string", - "description" : "Label that identifies the collection that contains one or more Atlas Search indexes." - }, - "database" : { - "type" : "string", - "description" : "Label that identifies the database that contains the collection with one or more Atlas Search indexes." - }, - "indexID" : { + "apiKeyId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies this Atlas Search index.", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" - }, - "latestDefinition" : { - "$ref" : "#/components/schemas/SearchIndexDefinition" - }, - "latestDefinitionVersion" : { - "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" - }, - "name" : { - "type" : "string", - "description" : "Label that identifies this index. Within each namespace, the names of all indexes must be unique." - }, - "queryable" : { - "type" : "boolean", - "description" : "Flag that indicates whether the index is queryable on all hosts." - }, - "status" : { - "type" : "string", - "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", - "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] - }, - "statusDetail" : { - "type" : "array", - "description" : "List of documents detailing index status on each host.", - "items" : { - "$ref" : "#/components/schemas/SearchHostStatusDetail" - } - }, - "type" : { - "type" : "string", - "description" : "Type of the index. The default type is search.", - "enum" : [ "search", "vectorSearch" ] - } - }, - "title" : "Search Index Response" - }, - "SearchIndexUpdateRequest" : { - "type" : "object", - "properties" : { - "definition" : { - "type" : "object", - "description" : "The index definition to update the search index to.", - "oneOf" : [ { - "$ref" : "#/components/schemas/TextSearchIndexDefinition" - }, { - "$ref" : "#/components/schemas/VectorSearchIndexDefinition" - } ] - } - }, - "required" : [ "definition" ], - "title" : "Search Index Update Request" - }, - "SearchMainIndexStatusDetail" : { - "type" : "object", - "description" : "Contains status information about the active index.", - "properties" : { - "definition" : { - "$ref" : "#/components/schemas/SearchIndexDefinition" - }, - "definitionVersion" : { - "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" - }, - "message" : { - "type" : "string", - "description" : "Optional message describing an error." - }, - "queryable" : { - "type" : "boolean", - "description" : "Flag that indicates whether the index generation is queryable on the host." - }, - "status" : { - "type" : "string", - "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", - "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] - } - }, - "title" : "Search Main Index Status Detail" - }, - "SearchMappings" : { - "type" : "object", - "description" : "Index specifications for the collection's fields.", - "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/field-mapping-definition-fts#static-and-dynamic-mappings" - } - }, - "fields" : { - "type" : "object", - "additionalProperties" : { - "type" : "object", - "description" : "One or more field specifications for the Atlas Search index. Required if **mappings.dynamic** is omitted or set to **false**.", - "externalDocs" : { - "description" : "Atlas Search Index", - "url" : "https://dochub.mongodb.org/core/index-definitions-fts" - }, - "x-additionalPropertiesName" : "Field Name" - }, - "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" - }, - "x-additionalPropertiesName" : "Field Name" - } - }, - "title" : "Mappings" - }, - "SearchStagedIndexStatusDetail" : { - "type" : "object", - "description" : "Contains status information about an index building in the background.", - "properties" : { - "definition" : { - "$ref" : "#/components/schemas/SearchIndexDefinition" - }, - "definitionVersion" : { - "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" - }, - "message" : { - "type" : "string", - "description" : "Optional message describing an error." - }, - "queryable" : { - "type" : "boolean", - "description" : "Flag that indicates whether the index generation is queryable on the host." + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "status" : { - "type" : "string", - "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", - "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] - } - }, - "title" : "Search Staged Index Status Detail" - }, - "SearchSynonymMappingDefinition" : { - "type" : "object", - "description" : "Synonyms used for this full text index.", - "properties" : { - "analyzer" : { + "created" : { "type" : "string", - "description" : "Specific pre-defined method chosen to apply to the synonyms to be searched.", - "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true }, - "name" : { - "type" : "string", - "description" : "Label that identifies the synonym definition. Each **synonym.name** must be unique within the same index definition." + "eventTypeName" : { + "$ref" : "#/components/schemas/ResourceEventTypeViewForOrg" }, - "source" : { - "$ref" : "#/components/schemas/SynonymSource" - } - }, - "required" : [ "analyzer", "name", "source" ], - "title" : "Synonym Mapping Definition" - }, - "ServerlessAWSTenantEndpoint" : { - "type" : "object", - "description" : "View for a serverless AWS tenant endpoint.", - "properties" : { - "_id" : { + "groupId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "cloudProviderEndpointId" : { - "type" : "string", - "description" : "Unique string that identifies the private endpoint's network interface.", - "pattern" : "^vpce-[0-9a-f]{17}$", - "readOnly" : true - }, - "comment" : { - "type" : "string", - "description" : "Human-readable comment associated with the private endpoint.", - "maxLength" : 80, - "readOnly" : true - }, - "endpointServiceName" : { + "id" : { "type" : "string", - "description" : "Unique string that identifies the Amazon Web Services (AWS) PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", - "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "errorMessage" : { - "type" : "string", - "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", "readOnly" : true }, - "providerName" : { - "type" : "string", - "description" : "Human-readable label that identifies the cloud service provider.", - "enum" : [ "AWS" ], + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, "readOnly" : true }, - "status" : { - "type" : "string", - "description" : "Human-readable label that indicates the current operating status of the private endpoint.", - "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], - "readOnly" : true - } - }, - "title" : "AWS" - }, - "ServerlessAWSTenantEndpointUpdate" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" - }, { - "type" : "object", - "properties" : { - "cloudProviderEndpointId" : { - "type" : "string", - "description" : "Unique string that identifies the private endpoint's network interface.", - "pattern" : "^vpce-[0-9a-f]{17}$", - "writeOnly" : true - } - } - } ], - "description" : "Updates to a serverless AWS tenant endpoint.", - "required" : [ "providerName" ], - "title" : "AWS" - }, - "ServerlessAzureTenantEndpoint" : { - "type" : "object", - "description" : "View for a serverless Azure tenant endpoint.", - "properties" : { - "_id" : { + "orgId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "cloudProviderEndpointId" : { - "type" : "string", - "description" : "Unique string that identifies the Azure private endpoint's network interface that someone added to this private endpoint service.", - "pattern" : "^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\\.Network/privateEndpoints/[-\\w._()]+$", - "readOnly" : true - }, - "comment" : { + "publicKey" : { "type" : "string", - "description" : "Human-readable comment associated with the private endpoint.", - "maxLength" : 80, + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true }, - "endpointServiceName" : { - "type" : "string", - "description" : "Unique string that identifies the Azure private endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", - "pattern" : "^pls_[0-9a-f]{24}$", - "readOnly" : true + "raw" : { + "$ref" : "#/components/schemas/raw" }, - "errorMessage" : { + "remoteAddress" : { "type" : "string", - "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", "readOnly" : true }, - "privateEndpointIpAddress" : { + "resourceId" : { "type" : "string", - "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "description" : "Unique 24-hexadecimal digit string that identifies the resource associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "privateLinkServiceResourceId" : { + "resourceType" : { "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 + "description" : "Unique identifier of resource type.", + "example" : "cluster" }, - "providerName" : { + "userId" : { "type" : "string", - "description" : "Human-readable label that identifies the cloud service provider.", - "enum" : [ "AZURE" ], + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "status" : { + "username" : { "type" : "string", - "description" : "Human-readable label that indicates the current operating status of the private endpoint.", - "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true } }, - "title" : "Azure" - }, - "ServerlessAzureTenantEndpointUpdate" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" - }, { - "type" : "object", - "properties" : { - "cloudProviderEndpointId" : { - "type" : "string", - "description" : "Unique string that identifies the Azure private endpoint's network interface for this private endpoint service.", - "pattern" : "^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\\.Network/privateEndpoints/[-\\w._()]+$", - "writeOnly" : true - }, - "privateEndpointIpAddress" : { - "type" : "string", - "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", - "writeOnly" : true - } - } - } ], - "description" : "Updates to a serverless Azure tenant endpoint.", - "required" : [ "providerName" ], - "title" : "AZURE" + "required" : [ "created", "eventTypeName", "id", "resourceType" ], + "title" : "Resource Events" }, - "ServerlessBackupRestoreJob" : { + "ResourceTag" : { "type" : "object", + "description" : "Key-value pair that tags and categorizes a MongoDB Cloud organization, project, or cluster. For example, `environment : production`.", "properties" : { - "cancelled" : { - "type" : "boolean", - "description" : "Flag that indicates whether someone canceled this restore job.", - "readOnly" : true - }, - "deliveryType" : { + "key" : { "type" : "string", - "description" : "Human-readable label that categorizes the restore job to create.", - "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\"`.", - "items" : { - "type" : "string", - "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download." - }, - "readOnly" : true - }, - "desiredTimestamp" : { - "$ref" : "#/components/schemas/ApiBSONTimestampView" - }, - "expired" : { - "type" : "boolean", - "description" : "Flag that indicates whether the restore job expired.", - "readOnly" : true + "description" : "Constant that defines the set of the tag. For example, `environment` in the `environment : production` tag.", + "maxLength" : 255, + "minLength" : 1 }, - "expiresAt" : { + "value" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when the restore job expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true - }, - "failed" : { - "type" : "boolean", - "description" : "Flag that indicates whether the restore job failed.", - "readOnly" : true - }, - "finishedAt" : { + "description" : "Variable that belongs to the set of the tag. For example, `production` in the `environment : production` tag.", + "maxLength" : 255, + "minLength" : 1 + } + }, + "required" : [ "key", "value" ], + "title" : "Resource Tag" + }, + "RestoreJobFileHash" : { + "type" : "object", + "description" : "Key and value pair that map one restore file to one hashed checksum. This parameter applies after you download the corresponding **delivery.url**.", + "properties" : { + "fileName" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when the restore job completed. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Human-readable label that identifies the hashed file.", "readOnly" : true }, - "id" : { + "hash" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the restore job.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "description" : "Hashed checksum that maps to the restore file.", "readOnly" : true }, "links" : { @@ -44941,87 +46749,173 @@ }, "readOnly" : true }, - "oplogInc" : { - "type" : "integer", - "format" : "int32", - "description" : "Oplog operation number from which you want to restore this snapshot. This number represents the second part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", - "example" : 1, - "minimum" : 1 + "typeName" : { + "type" : "string", + "description" : "Human-readable label that identifies the hashing algorithm used to compute the hash value.", + "enum" : [ "SHA1" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "RoleAssignment" : { + "type" : "object", + "properties" : { + "groupId" : { + "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", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" }, - "oplogTs" : { + "orgId" : { + "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", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "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.\n\nOrganization Roles\n\n* ORG_OWNER\n* ORG_MEMBER\n* ORG_GROUP_CREATOR\n* ORG_BILLING_ADMIN\n* ORG_READ_ONLY\n\nProject Roles\n\n* GROUP_CLUSTER_MANAGER\n* GROUP_DATA_ACCESS_ADMIN\n* GROUP_DATA_ACCESS_READ_ONLY\n* GROUP_DATA_ACCESS_READ_WRITE\n* GROUP_OWNER\n* GROUP_READ_ONLY\n* GROUP_SEARCH_INDEX_EDITOR\n* GROUP_STREAM_PROCESSING_OWNER\n\n", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + } + }, + "SMSNotification" : { + "type" : "object", + "description" : "SMS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { "type" : "integer", "format" : "int32", - "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`.", - "minimum" : 1199145600 + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." }, - "pointInTimeUTCSeconds" : { + "intervalMin" : { "type" : "integer", "format" : "int32", - "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`.", - "minimum" : 1199145600 + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 }, - "snapshotId" : { + "mobileNumber" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "description" : "Mobile phone number to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"SMS\"`.", + "example" : "1233337892" + }, + "notifierId" : { + "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" ] + } + }, + "required" : [ "typeName" ], + "title" : "SMS Notification" + }, + "SampleDatasetStatus" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies this sample dataset.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "targetClusterName" : { + "clusterName" : { "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\"`.", + "description" : "Human-readable label that identifies the cluster into which you loaded the sample dataset.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "readOnly" : true }, - "targetGroupId" : { + "completeDate" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the target project for the specified **targetClusterName**.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" + "format" : "date-time", + "description" : "Date and time when the sample dataset load job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true }, - "timestamp" : { + "createDate" : { "type" : "string", "format" : "date-time", - "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.", + "description" : "Date and time when you started the sample dataset load job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "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.", + "enum" : [ "WORKING", "FAILED", "COMPLETED" ], "readOnly" : true } - }, - "required" : [ "deliveryType", "targetClusterName", "targetGroupId" ] + } }, - "ServerlessBackupSnapshot" : { + "SearchDeploymentAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "SEARCH_DEPLOYMENT_CREATED", "SEARCH_DEPLOYMENT_UPDATED", "SEARCH_DEPLOYMENT_DELETED" ], + "example" : "SEARCH_DEPLOYMENT_CREATED", + "title" : "Search Deployment Audit Types" + }, + "SearchDeploymentAuditView" : { "type" : "object", + "description" : "Indicates activities on decoupled search nodes.", "properties" : { - "createdAt" : { + "apiKeyId" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "expiresAt" : { + "created" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "frequencyType" : { + "eventTypeName" : { + "$ref" : "#/components/schemas/SearchDeploymentAuditTypeView" + }, + "groupId" : { "type" : "string", - "description" : "Human-readable label that identifies how often this snapshot triggers.", - "enum" : [ "hourly", "daily", "weekly", "monthly" ], + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, "links" : { "type" : "array", "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", @@ -45034,450 +46928,445 @@ }, "readOnly" : true }, - "mongodVersion" : { + "orgId" : { "type" : "string", - "description" : "Version of the MongoDB host that this snapshot backs up.", - "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "serverlessInstanceName" : { + "publicKey" : { "type" : "string", - "description" : "Human-readable label given to the serverless instance from which MongoDB Cloud took this snapshot.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", "readOnly" : true }, - "snapshotType" : { + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { "type" : "string", - "description" : "Human-readable label that identifies when this snapshot triggers.", - "enum" : [ "onDemand", "scheduled" ], + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", "readOnly" : true }, - "status" : { + "userId" : { "type" : "string", - "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", - "enum" : [ "queued", "inProgress", "completed", "failed" ], + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "storageSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "Number of bytes taken to store the backup snapshot.", + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true } - } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Search Deployment Audits" }, - "ServerlessConnectionStringsPrivateEndpointItem" : { + "SearchHostStatusDetail" : { "type" : "object", - "description" : "Details of a private endpoint deployed for this serverless instance.", "properties" : { - "endpointId" : { + "hostname" : { "type" : "string", - "description" : "Unique string that the cloud provider uses to identify the private endpoint.", - "readOnly" : true + "description" : "Hostname that corresponds to the status detail." }, - "providerName" : { - "type" : "string", - "description" : "Cloud provider where the private endpoint is deployed.", - "enum" : [ "AWS", "AZURE" ], - "readOnly" : true + "mainIndex" : { + "$ref" : "#/components/schemas/SearchMainIndexStatusDetail" }, - "region" : { + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on the host." + }, + "stagedIndex" : { + "$ref" : "#/components/schemas/SearchStagedIndexStatusDetail" + }, + "status" : { "type" : "string", - "description" : "Region where the private endpoint is deployed.", - "readOnly" : true + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] } }, - "title" : "Serverless Instance Private Endpoint Connection Strings Endpoint" + "title" : "Search Host Status Detail" }, - "ServerlessConnectionStringsPrivateEndpointList" : { + "SearchIndex" : { "type" : "object", - "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/" + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, { + "type" : "object", + "properties" : { + "analyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves a variety of changes made to the text in fields:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\n MongoDB Cloud uses the selected process to build the Atlas Search index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ], + "externalDocs" : { + "description" : "Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/analyzers--fts" + } + }, + "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" + }, + "items" : { + "$ref" : "#/components/schemas/ApiAtlasFTSAnalyzersViewManual" + } + }, + "mappings" : { + "$ref" : "#/components/schemas/ApiAtlasFTSMappingsViewManual" + }, + "searchAnalyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Method applied to identify words when searching this index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] + }, + "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" + }, + "items" : { + "$ref" : "#/components/schemas/SearchSynonymMappingDefinition" + } + } + } + } ], + "required" : [ "collectionName", "database", "name" ] + }, + "SearchIndexCreateRequest" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "search" : "#/components/schemas/TextSearchIndexCreateRequest", + "vectorSearch" : "#/components/schemas/VectorSearchIndexCreateRequest" + }, + "propertyName" : "type" }, "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**.", - "items" : { - "$ref" : "#/components/schemas/ServerlessConnectionStringsPrivateEndpointItem" - }, - "readOnly" : true + "collectionName" : { + "type" : "string", + "description" : "Label that identifies the collection to create an Atlas Search index in." }, - "srvConnectionString" : { + "database" : { "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 + "description" : "Label that identifies the database that contains the collection to create an Atlas Search index in." + }, + "name" : { + "type" : "string", + "description" : "Label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique." }, "type" : { "type" : "string", - "description" : "MongoDB process type to which your application connects.", - "enum" : [ "MONGOS" ], - "readOnly" : true + "description" : "Type of the index. The default type is search.", + "enum" : [ "search", "vectorSearch" ] } }, - "title" : "Serverless Instance Private Endpoint Connection String" + "required" : [ "collectionName", "database", "name" ] }, - "ServerlessEventTypeViewAlertable" : { - "type" : "string", - "description" : "Event type that triggers an alert.", - "enum" : [ "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], - "example" : "OUTSIDE_SERVERLESS_METRIC_THRESHOLD", - "title" : "Serverless Event Types" + "SearchIndexDefinition" : { + "type" : "object", + "description" : "The search index definition set by the user.", + "title" : "Search Index Definition" + }, + "SearchIndexDefinitionVersion" : { + "type" : "object", + "description" : "Object which includes the version number of the index definition and the time that the index definition was created.", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "The time at which this index definition was created." + }, + "version" : { + "type" : "integer", + "format" : "int64", + "description" : "The version number associated with this index definition when it was created." + } + }, + "title" : "Search Index Definition Version" }, - "ServerlessInstanceDescription" : { + "SearchIndexResponse" : { "type" : "object", - "description" : "Group of settings that configure a MongoDB serverless instance.", - "properties" : { - "connectionStrings" : { - "$ref" : "#/components/schemas/ServerlessInstanceDescriptionConnectionStrings" + "discriminator" : { + "mapping" : { + "search" : "#/components/schemas/TextSearchIndexResponse", + "vectorSearch" : "#/components/schemas/VectorSearchIndexResponse" }, - "createDate" : { + "propertyName" : "type" + }, + "properties" : { + "collectionName" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", - "readOnly" : true + "description" : "Label that identifies the collection that contains one or more Atlas Search indexes." }, - "groupId" : { + "database" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the project.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "description" : "Label that identifies the database that contains the collection with one or more Atlas Search indexes." }, - "id" : { + "indexID" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the serverless instance.", + "description" : "Unique 24-hexadecimal digit string that identifies this Atlas Search index.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "pattern" : "^([a-f0-9]{24})$" }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true + "latestDefinition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" }, - "mongoDBVersion" : { - "type" : "string", - "description" : "Version of MongoDB that the serverless instance runs.", - "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", - "readOnly" : true + "latestDefinitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" }, "name" : { "type" : "string", - "description" : "Human-readable label that identifies the serverless instance.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - }, - "providerSettings" : { - "$ref" : "#/components/schemas/ServerlessProviderSettings" + "description" : "Label that identifies this index. Within each namespace, the names of all indexes must be unique." }, - "serverlessBackupOptions" : { - "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on all hosts." }, - "stateName" : { + "status" : { "type" : "string", - "description" : "Human-readable label that indicates the current operating condition of the serverless instance.", - "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], - "readOnly" : true + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] }, - "tags" : { + "statusDetail" : { "type" : "array", - "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", + "description" : "List of documents detailing index status on each host.", "items" : { - "$ref" : "#/components/schemas/ResourceTag" + "$ref" : "#/components/schemas/SearchHostStatusDetail" } }, - "terminationProtectionEnabled" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." + "type" : { + "type" : "string", + "description" : "Type of the index. The default type is search.", + "enum" : [ "search", "vectorSearch" ] } }, - "required" : [ "providerSettings" ], - "title" : "Serverless Instance Description" + "title" : "Search Index Response" }, - "ServerlessInstanceDescriptionConnectionStrings" : { + "SearchIndexUpdateRequest" : { "type" : "object", - "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", - "externalDocs" : { - "description" : "Connection string URI format.", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, "properties" : { - "privateEndpoint" : { - "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.", - "items" : { - "$ref" : "#/components/schemas/ServerlessConnectionStringsPrivateEndpointList" - }, - "readOnly" : true - }, - "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.", - "externalDocs" : { - "description" : "Connection String URI Format", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, - "readOnly" : true + "definition" : { + "type" : "object", + "description" : "The index definition to update the search index to.", + "oneOf" : [ { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + }, { + "$ref" : "#/components/schemas/VectorSearchIndexDefinition" + } ] } }, - "readOnly" : true, - "title" : "Serverless Instance Connection Strings" + "required" : [ "definition" ], + "title" : "Search Index Update Request" }, - "ServerlessInstanceDescriptionCreate" : { + "SearchMainIndexStatusDetail" : { "type" : "object", - "description" : "Settings that you can specify when you create a serverless instance.", + "description" : "Contains status information about the active index.", "properties" : { - "name" : { - "type" : "string", - "description" : "Human-readable label that identifies the serverless instance.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "writeOnly" : true - }, - "providerSettings" : { - "$ref" : "#/components/schemas/ServerlessProviderSettings" + "definition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" }, - "serverlessBackupOptions" : { - "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" }, - "stateName" : { + "message" : { "type" : "string", - "description" : "Human-readable label that indicates the current operating condition of the serverless instance.", - "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], - "readOnly" : true - }, - "tags" : { - "type" : "array", - "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", - "items" : { - "$ref" : "#/components/schemas/ResourceTag" - } + "description" : "Optional message describing an error." }, - "terminationProtectionEnabled" : { + "queryable" : { "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." + "description" : "Flag that indicates whether the index generation is queryable on the host." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] } }, - "required" : [ "name", "providerSettings" ], - "title" : "Serverless Instance Description Create" + "title" : "Search Main Index Status Detail" }, - "ServerlessInstanceDescriptionUpdate" : { + "SearchMappings" : { "type" : "object", - "description" : "Settings that you can update when you request a serverless cluster update.", + "description" : "Index specifications for the collection's fields.", "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.", - "items" : { - "$ref" : "#/components/schemas/ResourceTag" + "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/field-mapping-definition-fts#static-and-dynamic-mappings" } }, - "terminationProtectionEnabled" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." + "fields" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "One or more field specifications for the Atlas Search index. Required if **mappings.dynamic** is omitted or set to **false**.", + "externalDocs" : { + "description" : "Atlas Search Index", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "x-additionalPropertiesName" : "Field Name" + }, + "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" + }, + "x-additionalPropertiesName" : "Field Name" } }, - "title" : "Serverless Instance Description Update" + "title" : "Mappings" }, - "ServerlessMetricAlertConfigViewForNdsGroup" : { + "SearchStagedIndexStatusDetail" : { "type" : "object", - "description" : "Serverless metric alert configuration allows to select which serverless database metrics trigger alerts and how users are notified.", + "description" : "Contains status information about an index building in the background.", "properties" : { - "created" : { + "definition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" + }, + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "message" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "description" : "Optional message describing an error." }, - "enabled" : { + "queryable" : { "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + "description" : "Flag that indicates whether the index generation is queryable on the host." }, - "eventTypeName" : { - "$ref" : "#/components/schemas/ServerlessEventTypeViewAlertable" + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Search Staged Index Status Detail" + }, + "SearchSynonymMappingDefinition" : { + "type" : "object", + "description" : "Synonyms used for this full text index.", + "properties" : { + "analyzer" : { + "type" : "string", + "description" : "Specific pre-defined method chosen to apply to the synonyms to be searched.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] }, - "groupId" : { + "name" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "description" : "Label that identifies the synonym definition. Each **synonym.name** must be unique within the same index definition." }, - "id" : { + "source" : { + "$ref" : "#/components/schemas/SynonymSource" + } + }, + "required" : [ "analyzer", "name", "source" ], + "title" : "Synonym Mapping Definition" + }, + "ServerlessAWSTenantEndpoint" : { + "type" : "object", + "description" : "View for a serverless AWS tenant endpoint.", + "properties" : { + "_id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - }, - "matchers" : { - "type" : "array", - "description" : "Matching conditions for target resources.", - "items" : { - "$ref" : "#/components/schemas/AlertMatcher" - } - }, - "metricThreshold" : { - "$ref" : "#/components/schemas/ServerlessMetricThreshold" - }, - "notifications" : { - "type" : "array", - "description" : "List that contains the targets that MongoDB Cloud sends notifications.", - "items" : { - "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" - } - }, - "updated" : { + "cloudProviderEndpointId" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Unique string that identifies the private endpoint's network interface.", + "pattern" : "^vpce-[0-9a-f]{17}$", "readOnly" : true - } - }, - "required" : [ "eventTypeName", "notifications" ], - "title" : "Serverless Alert Configuration" - }, - "ServerlessMetricThreshold" : { - "type" : "object", - "description" : "Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.", - "discriminator" : { - "mapping" : { - "SERVERLESS_AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", - "SERVERLESS_AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", - "SERVERLESS_AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", - "SERVERLESS_CONNECTIONS" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricThresholdView", - "SERVERLESS_NETWORK_BYTES_IN" : "#/components/schemas/DataMetricThresholdView", - "SERVERLESS_NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricThresholdView", - "SERVERLESS_NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_OPCOUNTER_CMD" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_OPCOUNTER_QUERY" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_TOTAL_READ_UNITS" : "#/components/schemas/RPUMetricThresholdView", - "SERVERLESS_TOTAL_WRITE_UNITS" : "#/components/schemas/RPUMetricThresholdView" }, - "propertyName" : "metricName" - }, - "properties" : { - "metricName" : { + "comment" : { "type" : "string", - "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "readOnly" : true }, - "mode" : { + "endpointServiceName" : { "type" : "string", - "description" : "MongoDB Cloud computes the current metric value as an average.", - "enum" : [ "AVERAGE" ] - }, - "operator" : { - "$ref" : "#/components/schemas/Operator" - }, - "threshold" : { - "type" : "number", - "format" : "double", - "description" : "Value of metric that, when exceeded, triggers an alert." + "description" : "Unique string that identifies the Amazon Web Services (AWS) PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}", + "readOnly" : true }, - "units" : { - "type" : "string", - "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", - "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] - } - }, - "required" : [ "metricName" ], - "title" : "Serverless Metric Threshold" - }, - "ServerlessMetricUnits" : { - "type" : "string", - "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", - "enum" : [ "RPU", "THOUSAND_RPU", "MILLION_RPU", "WPU", "THOUSAND_WPU", "MILLION_WPU" ], - "example" : "RPU", - "title" : "Serverless Metric Units" - }, - "ServerlessProviderSettings" : { - "type" : "object", - "description" : "Group of cloud provider settings that configure the provisioned MongoDB serverless instance.", - "properties" : { - "backingProviderName" : { + "errorMessage" : { "type" : "string", - "description" : "Cloud service provider on which MongoDB Cloud provisioned the serverless instance.", - "enum" : [ "AWS", "AZURE", "GCP" ] + "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", + "readOnly" : true }, "providerName" : { "type" : "string", - "default" : "SERVERLESS", "description" : "Human-readable label that identifies the cloud service provider.", - "enum" : [ "SERVERLESS" ] + "enum" : [ "AWS" ], + "readOnly" : true }, - "regionName" : { + "status" : { "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/)." + "description" : "Human-readable label that indicates the current operating status of the private endpoint.", + "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true } }, - "required" : [ "backingProviderName", "regionName" ], - "title" : "Cloud Service Provider Settings for a Serverless Instance" + "title" : "AWS" }, - "ServerlessTenantCreateRequest" : { + "ServerlessAWSTenantEndpointUpdate" : { "type" : "object", - "properties" : { - "comment" : { - "type" : "string", - "description" : "Human-readable comment associated with the private endpoint.", - "maxLength" : 80, - "writeOnly" : true + "allOf" : [ { + "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" + }, { + "type" : "object", + "properties" : { + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface.", + "pattern" : "^vpce-[0-9a-f]{17}$", + "writeOnly" : true + } } - } + } ], + "description" : "Updates to a serverless AWS tenant endpoint.", + "required" : [ "providerName" ], + "title" : "AWS" }, - "ServerlessTenantEndpoint" : { + "ServerlessAzureTenantEndpoint" : { "type" : "object", - "oneOf" : [ { - "$ref" : "#/components/schemas/ServerlessAWSTenantEndpoint" - }, { - "$ref" : "#/components/schemas/ServerlessAzureTenantEndpoint" - } ], + "description" : "View for a serverless Azure tenant endpoint.", "properties" : { "_id" : { "type" : "string", @@ -45490,7 +47379,8 @@ }, "cloudProviderEndpointId" : { "type" : "string", - "description" : "Unique string that identifies the private endpoint's network interface.", + "description" : "Unique string that identifies the Azure private endpoint's network interface that someone added to this private endpoint service.", + "pattern" : "^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\\.Network/privateEndpoints/[-\\w._()]+$", "readOnly" : true }, "comment" : { @@ -45501,8 +47391,8 @@ }, "endpointServiceName" : { "type" : "string", - "description" : "Unique string that identifies the PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", - "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}|pls_[0-9a-f]{24}$", + "description" : "Unique string that identifies the Azure private endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^pls_[0-9a-f]{24}$", "readOnly" : true }, "errorMessage" : { @@ -45510,112 +47400,113 @@ "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", "readOnly" : true }, - "status" : { + "privateEndpointIpAddress" : { "type" : "string", - "description" : "Human-readable label that indicates the current operating status of the private endpoint.", - "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", "readOnly" : true - } - } - }, - "ServerlessTenantEndpointUpdate" : { - "type" : "object", - "description" : "Update view for a serverless tenant endpoint.", - "discriminator" : { - "mapping" : { - "AWS" : "#/components/schemas/ServerlessAWSTenantEndpointUpdate", - "AZURE" : "#/components/schemas/ServerlessAzureTenantEndpointUpdate" }, - "propertyName" : "providerName" - }, - "properties" : { - "comment" : { + "privateLinkServiceResourceId" : { "type" : "string", - "description" : "Human-readable comment associated with the private endpoint.", - "maxLength" : 80, - "writeOnly" : true + "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 provider of the tenant endpoint.", - "enum" : [ "AWS", "AZURE" ], - "writeOnly" : true + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "AZURE" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating status of the private endpoint.", + "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true } }, - "required" : [ "providerName" ] - }, - "ServiceAccountEventTypeViewForNdsGroup" : { - "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" ], - "title" : "Service Account Event Types" - }, - "ServiceAccountEventTypeViewForOrg" : { - "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" ], - "title" : "Service Account Event Types" + "title" : "Azure" }, - "ServiceAccountGroup" : { + "ServerlessAzureTenantEndpointUpdate" : { "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "allOf" : [ { + "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" + }, { + "type" : "object", + "properties" : { + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure private endpoint's network interface for this private endpoint service.", + "pattern" : "^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\\.Network/privateEndpoints/[-\\w._()]+$", + "writeOnly" : true + }, + "privateEndpointIpAddress" : { + "type" : "string", + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "writeOnly" : true + } } - } + } ], + "description" : "Updates to a serverless Azure tenant endpoint.", + "required" : [ "providerName" ], + "title" : "AZURE" }, - "ServiceAccountGroupEvents" : { + "ServerlessBackupRestoreJob" : { "type" : "object", - "description" : "Service Account event identifies different activities around user api keys.", "properties" : { - "apiKeyId" : { + "cancelled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone canceled this restore job.", + "readOnly" : true + }, + "deliveryType" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "description" : "Human-readable label that categorizes the restore job to create.", + "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\"`.", + "items" : { + "type" : "string", + "description" : "One Uniform Resource Locator that points to the compressed snapshot files for manual download." + }, "readOnly" : true }, - "created" : { + "desiredTimestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "expired" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job expired.", + "readOnly" : true + }, + "expiresAt" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Date and time when the restore job expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "eventTypeName" : { - "$ref" : "#/components/schemas/ServiceAccountEventTypeViewForNdsGroup" + "failed" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job failed.", + "readOnly" : true }, - "groupId" : { + "finishedAt" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "format" : "date-time", + "description" : "Date and time when the restore job completed. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "description" : "Unique 24-hexadecimal character string that identifies the restore job.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "isGlobalAdmin" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", - "readOnly" : true - }, "links" : { "type" : "array", "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", @@ -45628,98 +47519,87 @@ }, "readOnly" : true }, - "orgId" : { + "oplogInc" : { + "type" : "integer", + "format" : "int32", + "description" : "Oplog operation number from which you want to restore this snapshot. This number represents the second part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", + "example" : 1, + "minimum" : 1 + }, + "oplogTs" : { + "type" : "integer", + "format" : "int32", + "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`.", + "minimum" : 1199145600 + }, + "pointInTimeUTCSeconds" : { + "type" : "integer", + "format" : "int32", + "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`.", + "minimum" : 1199145600 + }, + "snapshotId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "publicKey" : { - "type" : "string", - "format" : "email", - "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "example" : "test.user@mongodb.com", - "readOnly" : true - }, - "raw" : { - "$ref" : "#/components/schemas/raw" + "pattern" : "^([a-f0-9]{24})$" }, - "remoteAddress" : { + "targetClusterName" : { "type" : "string", - "description" : "IPv4 or IPv6 address from which the user triggered this event.", - "example" : "216.172.40.186", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", - "readOnly" : true + "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\"`.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, - "userId" : { + "targetGroupId" : { "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.", + "description" : "Unique 24-hexadecimal digit string that identifies the target project for the specified **targetClusterName**.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "pattern" : "^([a-f0-9]{24})$" }, - "username" : { + "timestamp" : { "type" : "string", - "format" : "email", - "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", - "example" : "test.user@mongodb.com", + "format" : "date-time", + "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.", "readOnly" : true } }, - "required" : [ "created", "eventTypeName", "id" ], - "title" : "ServiceAccount Events" + "required" : [ "deliveryType", "targetClusterName", "targetGroupId" ] }, - "ServiceAccountOrgEvents" : { + "ServerlessBackupSnapshot" : { "type" : "object", - "description" : "Service Account event identifies different activities around user api keys.", "properties" : { - "apiKeyId" : { + "createdAt" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "created" : { + "expiresAt" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "eventTypeName" : { - "$ref" : "#/components/schemas/ServiceAccountEventTypeViewForOrg" - }, - "groupId" : { + "frequencyType" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "description" : "Human-readable label that identifies how often this snapshot triggers.", + "enum" : [ "hourly", "daily", "weekly", "monthly" ], "readOnly" : true }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "isGlobalAdmin" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", - "readOnly" : true - }, "links" : { "type" : "array", "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", @@ -45732,332 +47612,278 @@ }, "readOnly" : true }, - "orgId" : { + "mongodVersion" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "description" : "Version of the MongoDB host that this snapshot backs up.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", "readOnly" : true }, - "publicKey" : { + "serverlessInstanceName" : { "type" : "string", - "format" : "email", - "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "example" : "test.user@mongodb.com", + "description" : "Human-readable label given to the serverless instance from which MongoDB Cloud took this snapshot.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, - "raw" : { - "$ref" : "#/components/schemas/raw" - }, - "remoteAddress" : { + "snapshotType" : { "type" : "string", - "description" : "IPv4 or IPv6 address from which the user triggered this event.", - "example" : "216.172.40.186", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "description" : "Human-readable label that identifies when this snapshot triggers.", + "enum" : [ "onDemand", "scheduled" ], "readOnly" : true }, - "userId" : { + "status" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", + "enum" : [ "queued", "inProgress", "completed", "failed" ], "readOnly" : true }, - "username" : { - "type" : "string", - "format" : "email", - "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", - "example" : "test.user@mongodb.com", + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of bytes taken to store the backup snapshot.", "readOnly" : true } - }, - "required" : [ "created", "eventTypeName", "id" ], - "title" : "ServiceAccount Events" + } }, - "ServiceAccountSecret" : { + "ServerlessConnectionStringsPrivateEndpointItem" : { "type" : "object", + "description" : "Details of a private endpoint deployed for this serverless instance.", "properties" : { - "createdAt" : { + "endpointId" : { "type" : "string", - "format" : "date-time", - "description" : "Timestamp representing creation time.", + "description" : "Unique string that the cloud provider uses to identify the private endpoint.", "readOnly" : true }, - "expiresAt" : { + "providerName" : { "type" : "string", - "format" : "date-time", - "description" : "Timestamp representing secret expiration time.", + "description" : "Cloud provider where the private endpoint is deployed.", + "enum" : [ "AWS", "AZURE" ], "readOnly" : true }, - "id" : { + "region" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the secret.", - "example" : "32b6e34b3d91647abb20e7b8", - "pattern" : "^([a-f0-9]{24})$", + "description" : "Region where the private endpoint is deployed.", "readOnly" : true - }, - "lastUsedAt" : { - "type" : "string", - "format" : "date-time", - "description" : "Timestamp representing last secret usage.", + } + }, + "title" : "Serverless Instance Private Endpoint Connection Strings Endpoint" + }, + "ServerlessConnectionStringsPrivateEndpointList" : { + "type" : "object", + "description" : "Private endpoint connection string that you can use to connect to this serverless instance through a private endpoint.", + "externalDocs" : { + "description" : "Private Endpoint for Serverless Instance", + "url" : "https://docs.atlas.mongodb.com/security-serverless-private-endpoint/" + }, + "properties" : { + "endpoints" : { + "type" : "array", + "description" : "List that contains the private endpoints through which you connect to MongoDB Cloud when you use **connectionStrings.privateEndpoint[n].srvConnectionString**.", + "items" : { + "$ref" : "#/components/schemas/ServerlessConnectionStringsPrivateEndpointItem" + }, "readOnly" : true }, - "maskedSecretValue" : { + "srvConnectionString" : { "type" : "string", - "description" : "Service Account secret with masked values of the first 20 characters.", - "example" : "mdb_ic_sk_...12ce", + "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 }, - "secret" : { + "type" : { "type" : "string", - "description" : "Secret for the service account. It will be returned only the first time after service account creation.", - "pattern" : "^mdb_sa_sk_[0-9a-zA-Z]{40}$", + "description" : "MongoDB process type to which your application connects.", + "enum" : [ "MONGOS" ], "readOnly" : true } }, - "required" : [ "createdAt", "expiresAt", "id" ] + "title" : "Serverless Instance Private Endpoint Connection String" }, - "ServiceAccountSecretRequest" : { - "type" : "object", - "properties" : { - "secretExpiresAfterHours" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of hours representing validity duration for secret." - } - }, - "required" : [ "secretExpiresAfterHours" ] + "ServerlessEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], + "example" : "OUTSIDE_SERVERLESS_METRIC_THRESHOLD", + "title" : "Serverless Event Types" }, - "ShardEntry" : { + "ServerlessInstanceDescription" : { "type" : "object", - "description" : "Sharding configuration for a collection to be sharded on the destination cluster.", + "description" : "Group of settings that configure a MongoDB serverless instance.", "properties" : { - "collection" : { + "connectionStrings" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescriptionConnectionStrings" + }, + "createDate" : { "type" : "string", - "description" : "Human-readable label that identifies the collection to be sharded on the destination cluster.", - "writeOnly" : true + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true }, - "database" : { + "groupId" : { "type" : "string", - "description" : "Human-readable label that identifies the database that contains the collection to be sharded on the destination cluster.", - "writeOnly" : true + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "shardCollection" : { - "$ref" : "#/components/schemas/ShardKeys" - } - }, - "required" : [ "collection", "database", "shardCollection" ] - }, - "ShardKeys" : { - "type" : "object", - "description" : "Document that configures the shard key on the destination cluster.", - "properties" : { - "key" : { - "type" : "array", - "description" : "List of fields to use for the shard key.", - "items" : { - "type" : "object", - "additionalProperties" : { - "type" : "object" - } - }, - "uniqueItems" : true, - "writeOnly" : true - } - }, - "writeOnly" : true - }, - "ShardingRequest" : { - "type" : "object", - "description" : "Document that configures sharding on the destination cluster when migrating from a replica set source to a sharded cluster destination on MongoDB 6.0 or higher. If you don't wish to shard any collections on the destination cluster, leave this empty.", - "properties" : { - "createSupportingIndexes" : { - "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 + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the serverless instance.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "shardingEntries" : { + "links" : { "type" : "array", - "description" : "List of shard configurations to shard destination collections. Atlas shards only those collections that you include in the sharding entries array.", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, "items" : { - "$ref" : "#/components/schemas/ShardEntry" + "$ref" : "#/components/schemas/Link" }, - "uniqueItems" : true, - "writeOnly" : true - } - }, - "required" : [ "createSupportingIndexes" ], - "writeOnly" : true - }, - "Slack" : { - "type" : "object", - "description" : "Details to integrate one Slack account with one MongoDB Cloud project.", - "properties" : { - "apiToken" : { + "readOnly" : true + }, + "mongoDBVersion" : { "type" : "string", - "description" : "Key that allows MongoDB Cloud to access your Slack account.\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.\n\n**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" + "description" : "Version of MongoDB that the serverless instance runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true }, - "channelName" : { + "name" : { "type" : "string", - "description" : "Name of the Slack channel to which MongoDB Cloud sends alert notifications.", - "example" : "alerts", - "maxLength" : 80, + "description" : "Human-readable label that identifies the serverless instance.", + "maxLength" : 64, "minLength" : 1, - "nullable" : true + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, - "id" : { - "type" : "string", - "description" : "Integration id.", - "nullable" : true + "providerSettings" : { + "$ref" : "#/components/schemas/ServerlessProviderSettings" }, - "teamName" : { - "type" : "string", - "description" : "Human-readable label that identifies your Slack team. Set this parameter when you configure a legacy Slack integration.", - "example" : "MongoDB" + "serverlessBackupOptions" : { + "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" }, - "type" : { + "stateName" : { "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" : "Human-readable label that indicates the current operating condition of the serverless instance.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." } }, - "required" : [ "apiToken", "channelName" ], - "title" : "SLACK" + "required" : [ "providerSettings" ], + "title" : "Serverless Instance Description" }, - "SlackNotification" : { + "ServerlessInstanceDescriptionConnectionStrings" : { "type" : "object", - "description" : "Slack notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, "properties" : { - "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", - "format" : "int32", - "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." - }, - "integrationId" : { - "type" : "string", - "description" : "The id of the associated integration, the credentials of which to use for requests.", - "example" : "32b6e34b3d91647abb20e7b8" - }, - "intervalMin" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", - "minimum" : 5 - }, - "notifierId" : { - "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" + "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.", + "items" : { + "$ref" : "#/components/schemas/ServerlessConnectionStringsPrivateEndpointList" + }, + "readOnly" : true }, - "typeName" : { + "standardSrv" : { "type" : "string", - "description" : "Human-readable label that displays the alert notification type.", - "enum" : [ "SLACK" ] + "description" : "Public connection string that you can use to connect to this serverless instance. This connection string uses the `mongodb+srv://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true } }, - "required" : [ "typeName" ], - "title" : "Slack Notification" + "readOnly" : true, + "title" : "Serverless Instance Connection Strings" }, - "Source" : { + "ServerlessInstanceDescriptionCreate" : { "type" : "object", - "description" : "Document that describes the source of the migration.", + "description" : "Settings that you can specify when you create a serverless instance.", "properties" : { - "caCertificatePath" : { + "name" : { "type" : "string", - "description" : "Path to the CA certificate that signed SSL certificates use to authenticate to the source cluster." + "description" : "Human-readable label that identifies the serverless instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "writeOnly" : true }, - "clusterName" : { - "type" : "string", - "description" : "Label that identifies the source cluster name." + "providerSettings" : { + "$ref" : "#/components/schemas/ServerlessProviderSettings" }, - "groupId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the source project.", - "example" : "9b43a5b329223c3a1591a678", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" + "serverlessBackupOptions" : { + "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" }, - "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." + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the serverless instance.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true }, - "password" : { - "type" : "string", - "description" : "Password that authenticates the username to the source cluster.", - "writeOnly" : true + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } }, - "ssl" : { + "terminationProtectionEnabled" : { "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 - } - }, - "required" : [ "clusterName", "groupId", "managedAuthentication", "ssl" ] - }, - "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/" + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." } }, - "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/" - } + "required" : [ "name", "providerSettings" ], + "title" : "Serverless Instance Description Create" }, - "StreamConfig" : { + "ServerlessInstanceDescriptionUpdate" : { "type" : "object", - "description" : "Configuration options for an Atlas Stream Processing Instance.", - "nullable" : true, + "description" : "Settings that you can update when you request a serverless cluster update.", "properties" : { - "links" : { + "serverlessBackupOptions" : { + "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" + }, + "tags" : { "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true + "$ref" : "#/components/schemas/ResourceTag" + } }, - "tier" : { - "type" : "string", - "description" : "Selected tier for the Stream Instance. Configures Memory / VCPU allowances.", - "enum" : [ "SP30", "SP10" ], - "title" : "Stream Instance Tier" + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." } - } + }, + "title" : "Serverless Instance Description Update" }, - "StreamProcessorAlertConfigViewForNdsGroup" : { + "ServerlessMetricAlertConfigViewForNdsGroup" : { "type" : "object", - "description" : "Host metric alert configuration allows to select which Atlas streams processors trigger alerts and how users are notified.", + "description" : "Serverless metric alert configuration allows to select which serverless database metrics trigger alerts and how users are notified.", "properties" : { "created" : { "type" : "string", @@ -46071,7 +47897,7 @@ "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." }, "eventTypeName" : { - "$ref" : "#/components/schemas/StreamProcessorEventTypeViewAlertable" + "$ref" : "#/components/schemas/ServerlessEventTypeViewAlertable" }, "groupId" : { "type" : "string", @@ -46105,11 +47931,14 @@ }, "matchers" : { "type" : "array", - "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration.", + "description" : "Matching conditions for target resources.", "items" : { - "$ref" : "#/components/schemas/StreamsMatcher" + "$ref" : "#/components/schemas/AlertMatcher" } }, + "metricThreshold" : { + "$ref" : "#/components/schemas/ServerlessMetricThreshold" + }, "notifications" : { "type" : "array", "description" : "List that contains the targets that MongoDB Cloud sends notifications.", @@ -46125,157 +47954,215 @@ } }, "required" : [ "eventTypeName", "notifications" ], - "title" : "Stream Processor Alert Configuration" + "title" : "Serverless Alert Configuration" }, - "StreamProcessorAlertViewForNdsGroup" : { + "ServerlessMetricThreshold" : { "type" : "object", - "description" : "Stream Processor alert notifies about activities on Stream Processor in AtlasStreams.", + "description" : "Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.", + "discriminator" : { + "mapping" : { + "SERVERLESS_AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_CONNECTIONS" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_BYTES_IN" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_CMD" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_QUERY" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_TOTAL_READ_UNITS" : "#/components/schemas/RPUMetricThresholdView", + "SERVERLESS_TOTAL_WRITE_UNITS" : "#/components/schemas/RPUMetricThresholdView" + }, + "propertyName" : "metricName" + }, "properties" : { - "acknowledgedUntil" : { + "metricName" : { "type" : "string", - "format" : "date-time", - "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.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." }, - "acknowledgementComment" : { + "mode" : { "type" : "string", - "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", - "example" : "Expiration on 3/19. Silencing for 7days.", - "maxLength" : 200 + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] }, - "acknowledgingUsername" : { + "operator" : { "type" : "string", - "format" : "email", - "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", - "readOnly" : true + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, - "alertConfigId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." }, - "created" : { + "units" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true - }, - "eventTypeName" : { - "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroupAlertable" - }, - "groupId" : { + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] + } + }, + "required" : [ "metricName" ], + "title" : "Serverless Metric Threshold" + }, + "ServerlessMetricUnits" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "RPU", "THOUSAND_RPU", "MILLION_RPU", "WPU", "THOUSAND_WPU", "MILLION_WPU" ], + "example" : "RPU", + "title" : "Serverless Metric Units" + }, + "ServerlessProviderSettings" : { + "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB serverless instance.", + "properties" : { + "backingProviderName" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "description" : "Cloud service provider on which MongoDB Cloud provisioned the serverless instance.", + "enum" : [ "AWS", "AZURE", "GCP" ] }, - "id" : { + "providerName" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies this alert.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "default" : "SERVERLESS", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "SERVERLESS" ] }, - "instanceName" : { + "regionName" : { "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.", - "example" : "foobar", - "readOnly" : true - }, - "lastNotified" : { + "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/)." + } + }, + "required" : [ "backingProviderName", "regionName" ], + "title" : "Cloud Service Provider Settings for a Serverless Instance" + }, + "ServerlessTenantCreateRequest" : { + "type" : "object", + "properties" : { + "comment" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", - "readOnly" : true - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - }, - "orgId" : { + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "writeOnly" : true + } + } + }, + "ServerlessTenantEndpoint" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/ServerlessAWSTenantEndpoint" + }, { + "$ref" : "#/components/schemas/ServerlessAzureTenantEndpoint" + } ], + "properties" : { + "_id" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "processorErrorMsg" : { + "cloudProviderEndpointId" : { "type" : "string", - "description" : "The error message associated with the Stream Processor to which this alert applies.", - "example" : "MongoServerError: Failed to start stream processor: (Location77175) Could not connect to the Kafka topic with kafka error code: -195, message: Local: Broker transport failure.: (Location77175)", + "description" : "Unique string that identifies the private endpoint's network interface.", "readOnly" : true }, - "processorName" : { + "comment" : { "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.", - "example" : "foobar", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, "readOnly" : true }, - "processorState" : { + "endpointServiceName" : { "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.", - "example" : "STARTED", + "description" : "Unique string that identifies the PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}|pls_[0-9a-f]{24}$", "readOnly" : true }, - "resolved" : { + "errorMessage" : { "type" : "string", - "format" : "date-time", - "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\"`.", + "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", "readOnly" : true }, "status" : { "type" : "string", - "description" : "State of this alert at the time you requested its details.", - "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], - "example" : "OPEN", + "description" : "Human-readable label that indicates the current operating status of the private endpoint.", + "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], "readOnly" : true + } + } + }, + "ServerlessTenantEndpointUpdate" : { + "type" : "object", + "description" : "Update view for a serverless tenant endpoint.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/ServerlessAWSTenantEndpointUpdate", + "AZURE" : "#/components/schemas/ServerlessAzureTenantEndpointUpdate" }, - "updated" : { + "propertyName" : "providerName" + }, + "properties" : { + "comment" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "writeOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider of the tenant endpoint.", + "enum" : [ "AWS", "AZURE" ], + "writeOnly" : true } }, - "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], - "title" : "Stream Processor Alerts" + "required" : [ "providerName" ] }, - "StreamProcessorEventTypeViewAlertable" : { + "ServiceAccountEventTypeViewForNdsGroup" : { "type" : "string", - "description" : "Event type that triggers an alert.", - "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], - "example" : "STREAM_PROCESSOR_STATE_IS_FAILED", - "title" : "Stream Processor Event Types" + "description" : "Unique identifier of event type.", + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" }, - "StreamProcessorEventTypeViewForNdsGroup" : { + "ServiceAccountEventTypeViewForOrg" : { "type" : "string", "description" : "Unique identifier of event type.", - "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], - "example" : "STREAM_PROCESSOR_STATE_IS_FAILED", - "title" : "Stream Processor Event Types" + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" }, - "StreamProcessorEventViewForNdsGroup" : { + "ServiceAccountGroup" : { "type" : "object", - "description" : "Stream Processor event identifies different activities about a stream processor in Atlas Streams.", "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies your project. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "ServiceAccountGroupEvents" : { + "type" : "object", + "description" : "Service Account event identifies different activities around user api keys.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, "created" : { "type" : "string", "format" : "date-time", @@ -46283,7 +48170,7 @@ "readOnly" : true }, "eventTypeName" : { - "$ref" : "#/components/schemas/StreamProcessorEventTypeViewForNdsGroup" + "$ref" : "#/components/schemas/ServiceAccountEventTypeViewForNdsGroup" }, "groupId" : { "type" : "string", @@ -46303,10 +48190,10 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "instanceName" : { - "type" : "string", - "description" : "Name of the stream processing instance associated with the event.", - "example" : "foobar", + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", "readOnly" : true }, "links" : { @@ -46330,159 +48217,96 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "processorErrorMsg" : { - "type" : "string", - "description" : "Error message linked to the stream processor associated with the event.", - "example" : "invalid auth", - "readOnly" : true - }, - "processorName" : { - "type" : "string", - "description" : "Name of the stream processor associated with the event.", - "example" : "foobar", - "readOnly" : true - }, - "processorState" : { + "publicKey" : { "type" : "string", - "description" : "State of the stream processor associated with the event.", - "example" : "FAILED", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true }, "raw" : { "$ref" : "#/components/schemas/raw" - } - }, - "required" : [ "created", "eventTypeName", "id" ], - "title" : "Stream Processor Events" - }, - "StreamsClusterConnection" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/StreamsConnection" - }, { - "type" : "object", - "properties" : { - "clusterName" : { - "type" : "string", - "description" : "Name of the cluster configured for this connection." - }, - "dbRoleToExecute" : { - "$ref" : "#/components/schemas/DBRoleToExecute" - } - } - } ] - }, - "StreamsConnection" : { - "type" : "object", - "description" : "Settings that define a connection to an external data store.", - "discriminator" : { - "mapping" : { - "Cluster" : "#/components/schemas/StreamsClusterConnection", - "Kafka" : "#/components/schemas/StreamsKafkaConnection", - "Sample" : "#/components/schemas/StreamsSampleConnection" }, - "propertyName" : "type" - }, - "oneOf" : [ { - "$ref" : "#/components/schemas/StreamsSampleConnection" - }, { - "$ref" : "#/components/schemas/StreamsClusterConnection" - }, { - "$ref" : "#/components/schemas/StreamsKafkaConnection" - } ], - "properties" : { - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", "readOnly" : true }, - "name" : { + "userId" : { "type" : "string", - "description" : "Human-readable label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source." + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "type" : { + "username" : { "type" : "string", - "description" : "Type of the connection. Can be either Cluster or Kafka.", - "enum" : [ "Kafka", "Cluster", "Sample" ] + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true } }, - "readOnly" : true + "required" : [ "created", "eventTypeName", "id" ], + "title" : "ServiceAccount Events" }, - "StreamsDLQ" : { + "ServiceAccountIPAccessListEntry" : { "type" : "object", - "description" : "Dead letter queue for the stream processor.", "properties" : { - "coll" : { + "cidrBlock" : { "type" : "string", - "description" : "Name of the collection that will be used for the DLQ." + "description" : "Range of network addresses in the access list for the Service Account. This parameter requires the range to be expressed in Classless Inter-Domain Routing (CIDR) notation of Internet Protocol version 4 or version 6 addresses. You can set a value for this parameter or **ipAddress**, but not for both in the same request.", + "example" : "203.0.113.0/24", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" }, - "connectionName" : { + "createdAt" : { "type" : "string", - "description" : "Connection name that will be used to write DLQ messages to. Has to be an Atlas connection." + "format" : "date-time", + "description" : "Date MongoDB Cloud added the entry was added to the Access List.", + "readOnly" : true }, - "db" : { + "ipAddress" : { "type" : "string", - "description" : "Name of the database that will be used for the DLQ." + "description" : "Network address in the access list for the Service Account. This parameter requires the address to be expressed as one Internet Protocol version 4 or version 6 address. You can set a value for this parameter or **cidrBlock**, but not for both in the same request.", + "example" : "203.0.113.10", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - } - } - }, - "StreamsDataProcessRegion" : { - "type" : "object", - "description" : "Information about the cloud provider region in which MongoDB Cloud processes the stream.", - "properties" : { - "cloudProvider" : { + "lastUsedAddress" : { "type" : "string", - "description" : "Label that identifies the cloud service provider where MongoDB Cloud performs stream processing. Currently, this parameter supports AWS only.", - "enum" : [ "AWS", "GCP", "AZURE", "TENANT", "SERVERLESS" ] + "description" : "Network address that issued the most recent request to the API. This parameter requires the address to be expressed as one Internet Protocol version 4 or version 6 address. The resource returns this parameter after this IP address makes at least one request.", + "readOnly" : true }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, + "lastUsedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date when MongoDB Cloud received the most recent request that originated from this Internet Protocol version 4 or version 6 address. The resource returns this parameter when at least one request originates from this IP address. MongoDB Cloud updates this parameter each time a client accesses the permitted resource, with a delay of up to 5 minutes.", "readOnly" : true }, - "region" : { - "$ref" : "#/components/schemas/BaseStreamsRegion" + "requestCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of requests that has originated from this network address.", + "readOnly" : true } - }, - "required" : [ "cloudProvider", "region" ] - }, - "StreamsEventTypeViewForNdsGroup" : { - "type" : "string", - "description" : "Unique identifier of event type.", - "enum" : [ "MAX_PROCESSOR_COUNT_REACHED" ], - "example" : "MAX_PROCESSOR_COUNT_REACHED", - "title" : "Streams Event Types" + } }, - "StreamsEventViewForNdsGroup" : { + "ServiceAccountOrgEvents" : { "type" : "object", - "description" : "Streams event identifies different activities about Atlas Streams.", + "description" : "Service Account event identifies different activities around user api keys.", "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, "created" : { "type" : "string", "format" : "date-time", @@ -46490,7 +48314,7 @@ "readOnly" : true }, "eventTypeName" : { - "$ref" : "#/components/schemas/StreamsEventTypeViewForNdsGroup" + "$ref" : "#/components/schemas/ServiceAccountEventTypeViewForOrg" }, "groupId" : { "type" : "string", @@ -46510,10 +48334,10 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "instanceName" : { - "type" : "string", - "description" : "Name of the stream processing instance associated with the event.", - "example" : "foobar", + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", "readOnly" : true }, "links" : { @@ -46537,387 +48361,217 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, "raw" : { "$ref" : "#/components/schemas/raw" - } - }, - "required" : [ "created", "eventTypeName", "id" ], - "title" : "Streams Events" - }, - "StreamsKafkaAuthentication" : { - "type" : "object", - "description" : "User credentials required to connect to a Kafka Cluster. Includes the authentication type, as well as the parameters for that authentication mode.", - "properties" : { - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true }, - "mechanism" : { + "remoteAddress" : { "type" : "string", - "description" : "Style of authentication. Can be one of PLAIN, SCRAM-256, or SCRAM-512." + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true }, - "password" : { + "userId" : { "type" : "string", - "format" : "password", - "description" : "Password of the account to connect to the Kafka cluster.", - "writeOnly" : true + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, "username" : { "type" : "string", - "description" : "Username of the account to connect to the Kafka cluster." - } - } - }, - "StreamsKafkaConnection" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/StreamsConnection" - }, { - "type" : "object", - "properties" : { - "authentication" : { - "$ref" : "#/components/schemas/StreamsKafkaAuthentication" - }, - "bootstrapServers" : { - "type" : "string", - "description" : "Comma separated list of server addresses." - }, - "config" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "description" : "A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.", - "example" : "{\"group.protocol.type\":\"consumer\",\"debug\":\"queue, msg, protocol\"}" - }, - "description" : "A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.", - "example" : { - "debug" : "queue, msg, protocol", - "group.protocol.type" : "consumer" - } - }, - "networking" : { - "$ref" : "#/components/schemas/StreamsKafkaNetworking" - }, - "proxyInfo" : { - "$ref" : "#/components/schemas/ProxyInfo" - }, - "security" : { - "$ref" : "#/components/schemas/StreamsKafkaSecurity" - } - } - } ] - }, - "StreamsKafkaNetworking" : { - "type" : "object", - "description" : "Networking Access Type can either be 'PUBLIC' (default) or VPC. VPC type is in public preview, please file a support ticket to enable VPC Network Access", - "properties" : { - "access" : { - "$ref" : "#/components/schemas/StreamsKafkaNetworkingAccess" - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true } - } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "ServiceAccount Events" }, - "StreamsKafkaNetworkingAccess" : { + "ServiceAccountSecret" : { "type" : "object", - "description" : "Information about the networking access.", "properties" : { - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "The date that the secret was created on.", "readOnly" : true }, - "name" : { + "expiresAt" : { "type" : "string", - "description" : "Id of the vpc peer when the type is VPC." + "format" : "date-time", + "description" : "The date for the expiration of the secret.", + "readOnly" : true }, - "type" : { + "id" : { "type" : "string", - "description" : "Selected networking type. Either PUBLIC or VPC. Defaults to PUBLIC", - "enum" : [ "PUBLIC", "VPC" ], - "title" : "Networking Access Type" - } - } - }, - "StreamsKafkaSecurity" : { - "type" : "object", - "description" : "Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use.", - "properties" : { - "brokerPublicCertificate" : { + "description" : "Unique 24-hexadecimal digit string that identifies the secret.", + "example" : "32b6e34b3d91647abb20e7b8", + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastUsedAt" : { "type" : "string", - "description" : "A trusted, public x509 certificate for connecting to Kafka over SSL." + "format" : "date-time", + "description" : "The last time the secret was used.", + "readOnly" : true }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, + "maskedSecretValue" : { + "type" : "string", + "description" : "The masked Service Account secret.", + "example" : "mdb_ic_sk_...12ce", "readOnly" : true }, - "protocol" : { + "secret" : { "type" : "string", - "description" : "Describes the transport type. Can be either PLAINTEXT or SSL." + "description" : "The secret for the Service Account. It will be returned only the first time after creation.", + "pattern" : "^mdb_sa_sk_[0-9a-zA-Z_-]{40}$", + "readOnly" : true } - } + }, + "required" : [ "createdAt", "expiresAt", "id" ] }, - "StreamsMatcher" : { + "ServiceAccountSecretRequest" : { "type" : "object", - "description" : "Rules to apply when comparing a stream processing instance or stream processor against this alert configuration.", "properties" : { - "fieldName" : { - "$ref" : "#/components/schemas/StreamsMatcherField" - }, - "operator" : { + "secretExpiresAfterHours" : { + "type" : "integer", + "format" : "int32", + "description" : "The expiration time of the new Service Account secret. The expiration is provided in hours." + } + }, + "required" : [ "secretExpiresAfterHours" ] + }, + "ShardEntry" : { + "type" : "object", + "description" : "Sharding configuration for a collection to be sharded on the destination cluster.", + "properties" : { + "collection" : { "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" ] + "description" : "Human-readable label that identifies the collection to be sharded on the destination cluster.", + "writeOnly" : true }, - "value" : { + "database" : { "type" : "string", - "description" : "Value to match or exceed using the specified **matchers.operator**.", - "example" : "event-replica-set" + "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" } }, - "required" : [ "fieldName", "operator", "value" ], - "title" : "Matchers" - }, - "StreamsMatcherField" : { - "type" : "string", - "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", - "enum" : [ "INSTANCE_NAME", "PROCESSOR_NAME" ], - "example" : "INSTANCE_NAME", - "title" : "Streams Matcher Fields" + "required" : [ "collection", "database", "shardCollection" ] }, - "StreamsOptions" : { + "ShardKeys" : { "type" : "object", - "description" : "Optional configuration for the stream processor.", + "description" : "Document that configures the shard key on the destination cluster.", "properties" : { - "dlq" : { - "$ref" : "#/components/schemas/StreamsDLQ" - }, - "links" : { + "key" : { "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, + "description" : "List of fields to use for the shard key.", "items" : { - "$ref" : "#/components/schemas/Link" + "type" : "object", + "additionalProperties" : { + "type" : "object" + } }, - "readOnly" : true + "uniqueItems" : true, + "writeOnly" : true } - } + }, + "writeOnly" : true }, - "StreamsProcessor" : { + "ShardingRequest" : { "type" : "object", - "description" : "An atlas stream processor.", + "description" : "Document that configures sharding on the destination cluster when migrating from a replica set source to a sharded cluster destination on MongoDB 6.0 or higher. If you don't wish to shard any collections on the destination cluster, leave this empty.", "properties" : { - "_id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the stream processor.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "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 }, - "links" : { + "shardingEntries" : { "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, + "description" : "List of shard configurations to shard destination collections. Atlas shards only those collections that you include in the sharding entries array.", "items" : { - "$ref" : "#/components/schemas/Link" + "$ref" : "#/components/schemas/ShardEntry" }, - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "Human-readable name of the stream processor." - }, - "options" : { - "$ref" : "#/components/schemas/StreamsOptions" - }, - "pipeline" : { - "type" : "array", - "description" : "Stream aggregation pipeline you want to apply to your streaming data.", - "items" : { - "$ref" : "#/components/schemas/Document" - } + "uniqueItems" : true, + "writeOnly" : true } - } + }, + "required" : [ "createSupportingIndexes" ], + "writeOnly" : true }, - "StreamsProcessorWithStats" : { + "Slack" : { "type" : "object", - "description" : "An atlas stream processor with optional stats.", + "description" : "Details to integrate one Slack account with one MongoDB Cloud project.", "properties" : { - "_id" : { + "apiToken" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the stream processor.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true + "description" : "Key that allows MongoDB Cloud to access your Slack account.\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.\n\n**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" }, - "name" : { + "channelName" : { "type" : "string", - "description" : "Human-readable name of the stream processor.", - "readOnly" : true + "description" : "Name of the Slack channel to which MongoDB Cloud sends alert notifications.", + "example" : "alerts", + "maxLength" : 80, + "minLength" : 1, + "nullable" : true }, - "pipeline" : { - "type" : "array", - "description" : "Stream aggregation pipeline you want to apply to your streaming data.", - "items" : { - "$ref" : "#/components/schemas/Document" - }, - "readOnly" : true + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true }, - "state" : { + "teamName" : { "type" : "string", - "description" : "The state of the stream processor.", - "readOnly" : true + "description" : "Human-readable label that identifies your Slack team. Set this parameter when you configure a legacy Slack integration.", + "example" : "MongoDB" }, - "stats" : { - "type" : "object", - "additionalProperties" : { - "type" : "object", - "description" : "The stats associated with the stream processor.", - "readOnly" : true - }, - "description" : "The stats associated with the stream processor.", - "readOnly" : 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" : [ "SLACK" ] } }, - "required" : [ "_id", "name", "pipeline", "state" ] - }, - "StreamsSampleConnection" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/StreamsConnection" - } ] + "required" : [ "apiToken", "channelName" ], + "title" : "SLACK" }, - "StreamsTenant" : { + "SlackNotification" : { "type" : "object", + "description" : "Slack notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", "properties" : { - "_id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the project.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "connections" : { - "type" : "array", - "description" : "List of connections configured in the stream instance.", - "items" : { - "$ref" : "#/components/schemas/StreamsConnection" - }, - "readOnly" : true - }, - "dataProcessRegion" : { - "$ref" : "#/components/schemas/StreamsDataProcessRegion" - }, - "groupId" : { + "apiToken" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the project.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "hostnames" : { - "type" : "array", - "description" : "List that contains the hostnames assigned to the stream instance.", - "items" : { - "type" : "string", - "description" : "Unique hostname assigned to the stream instance.", - "readOnly" : true - }, - "readOnly" : true - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true + "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" }, - "name" : { + "channelName" : { "type" : "string", - "description" : "Human-readable label that identifies the stream instance." + "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" }, - "streamConfig" : { - "$ref" : "#/components/schemas/StreamConfig" - } - } - }, - "SummaryNotification" : { - "type" : "object", - "description" : "Summary notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", - "properties" : { "delayMin" : { "type" : "integer", "format" : "int32", "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." }, - "emailAddress" : { + "integrationId" : { "type" : "string", - "format" : "email", - "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:\n\n- specific MongoDB Cloud users (`\"notifications.[n].typeName\" : \"USER\"`)\n- MongoDB Cloud users with specific project roles (`\"notifications.[n].typeName\" : \"GROUP\"`)\n- MongoDB Cloud users with specific organization roles (`\"notifications.[n].typeName\" : \"ORG\"`)\n- MongoDB Cloud teams (`\"notifications.[n].typeName\" : \"TEAM\"`)\n\nTo send emails to one MongoDB Cloud user or grouping of users, set the **notifications.[n].emailEnabled** parameter." + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" }, "intervalMin" : { "type" : "integer", @@ -46933,68 +48587,74 @@ "typeName" : { "type" : "string", "description" : "Human-readable label that displays the alert notification type.", - "enum" : [ "SUMMARY" ] + "enum" : [ "SLACK" ] } }, "required" : [ "typeName" ], - "title" : "Summary Notification" + "title" : "Slack Notification" }, - "SynonymMappingStatusDetail" : { + "Source" : { "type" : "object", - "description" : "Contains the status of the index's synonym mappings on each search host. This field (and its subfields) only appear if the index has synonyms defined.", + "description" : "Document that describes the source of the migration.", "properties" : { - "message" : { + "caCertificatePath" : { "type" : "string", - "description" : "Optional message describing an error." + "description" : "Path to the CA certificate that signed SSL certificates use to authenticate to the source cluster." }, - "queryable" : { + "clusterName" : { + "type" : "string", + "description" : "Label that identifies the source cluster name." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the source project.", + "example" : "9b43a5b329223c3a1591a678", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "managedAuthentication" : { "type" : "boolean", - "description" : "Flag that indicates whether the synonym mapping is queryable on a host." + "description" : "Flag that indicates whether MongoDB Automation manages authentication to the source cluster. If true, do not provide values for username and password." }, - "status" : { + "password" : { "type" : "string", - "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", - "enum" : [ "FAILED", "BUILDING", "READY" ] + "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 } }, - "title" : "Synonym Mapping Status Detail" + "required" : [ "clusterName", "groupId", "managedAuthentication", "ssl" ] }, - "SynonymMappingStatusDetailMap" : { + "StorageEngine" : { "type" : "object", "additionalProperties" : { - "$ref" : "#/components/schemas/SynonymMappingStatusDetail" - }, - "x-additionalPropertiesName" : "Synonym Mapping Name" - }, - "SynonymSource" : { - "type" : "object", - "description" : "Data set that stores words and their applicable synonyms.", - "properties" : { - "collection" : { - "type" : "string", - "description" : "Label that identifies the MongoDB collection that stores words and their applicable synonyms." + "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/" } }, - "required" : [ "collection" ] + "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/" + } }, - "SystemStatus" : { + "StreamConfig" : { "type" : "object", + "description" : "Configuration options for an Atlas Stream Processing Instance.", + "nullable" : true, "properties" : { - "apiKey" : { - "$ref" : "#/components/schemas/ApiKey" - }, - "appName" : { - "type" : "string", - "description" : "Human-readable label that identifies the service from which you requested this response.", - "enum" : [ "MongoDB Atlas" ], - "readOnly" : true - }, - "build" : { - "type" : "string", - "description" : "Unique 40-hexadecimal digit hash that identifies the latest git commit merged for this application.", - "example" : "83be55e140f493c88e7f578aae96548dd881587b", - "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.", @@ -47007,43 +48667,44 @@ }, "readOnly" : true }, - "throttling" : { - "type" : "boolean", - "description" : "Flag that indicates whether someone enabled throttling on this service.", - "readOnly" : true - } - }, - "required" : [ "apiKey", "appName", "build", "throttling" ] - }, - "TargetOrg" : { - "type" : "object", - "properties" : { - "linkToken" : { + "tier" : { "type" : "string", - "description" : "Link token that contains all the information required to complete the link." - } - }, - "required" : [ "linkToken" ] - }, - "TargetOrgRequest" : { - "type" : "object", - "properties" : { - "accessListIps" : { - "type" : "array", - "description" : "IP address access list entries associated with the API key.", - "items" : { - "type" : "string", - "description" : "One IP address access list entry associated with the API key." - } + "description" : "Selected tier for the Stream Instance. Configures Memory / VCPU allowances.", + "enum" : [ "SP30", "SP10" ], + "title" : "Stream Instance Tier" } } }, - "Team" : { + "StreamProcessorAlertConfigViewForNdsGroup" : { "type" : "object", + "description" : "Host metric alert configuration allows to select which Atlas streams processors trigger alerts and how users are notified.", "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/StreamProcessorEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies this team.", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -47062,30 +48723,54 @@ }, "readOnly" : true }, - "name" : { - "type" : "string", - "description" : "Human-readable label that identifies the team." + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration.", + "items" : { + "$ref" : "#/components/schemas/StreamsMatcher" + } }, - "usernames" : { + "notifications" : { "type" : "array", - "description" : "List that contains the MongoDB Cloud users in this team.", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", "items" : { - "type" : "string", - "format" : "email", - "description" : "List that contains email addresses that identify MongoDB Cloud users to in this team." - }, - "uniqueItems" : true + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true } }, - "required" : [ "name" ] + "required" : [ "eventTypeName", "notifications" ], + "title" : "Stream Processor Alert Configuration" }, - "TeamEvent" : { + "StreamProcessorAlertViewForNdsGroup" : { "type" : "object", - "description" : "Team event identifies different activities around organization teams.", + "description" : "Stream Processor alert notifies about activities on Stream Processor in AtlasStreams.", "properties" : { - "apiKeyId" : { + "acknowledgedUntil" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "format" : "date-time", + "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.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -47095,15 +48780,15 @@ "created" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, "eventTypeName" : { - "$ref" : "#/components/schemas/TeamEventTypeView" + "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroupAlertable" }, "groupId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -47112,17 +48797,23 @@ }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "isGlobalAdmin" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "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.", + "example" : "foobar", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", "readOnly" : true }, "links" : { @@ -47139,86 +48830,72 @@ }, "orgId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "publicKey" : { + "processorErrorMsg" : { "type" : "string", - "format" : "email", - "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "example" : "test.user@mongodb.com", + "description" : "The error message associated with the Stream Processor to which this alert applies.", + "example" : "MongoServerError: Failed to start stream processor: (Location77175) Could not connect to the Kafka topic with kafka error code: -195, message: Local: Broker transport failure.: (Location77175)", "readOnly" : true }, - "raw" : { - "$ref" : "#/components/schemas/raw" + "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.", + "example" : "foobar", + "readOnly" : true }, - "remoteAddress" : { + "processorState" : { "type" : "string", - "description" : "IPv4 or IPv6 address from which the user triggered this event.", - "example" : "216.172.40.186", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "description" : "The state of the Stream Processor to which this alert applies. The resource returns this parameter for alerts of events impacting Stream Processors.", + "example" : "STARTED", "readOnly" : true }, - "teamId" : { + "resolved" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization team associated with this event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "format" : "date-time", + "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\"`.", "readOnly" : true }, - "userId" : { + "status" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", "readOnly" : true }, - "username" : { + "updated" : { "type" : "string", - "format" : "email", - "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", - "example" : "test.user@mongodb.com", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true } }, - "required" : [ "created", "eventTypeName", "id" ], - "title" : "Team Events" + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Stream Processor Alerts" }, - "TeamEventTypeView" : { + "StreamProcessorEventTypeViewAlertable" : { "type" : "string", - "description" : "Unique identifier of event type.", - "enum" : [ "TEAM_CREATED", "TEAM_DELETED", "TEAM_UPDATED", "TEAM_NAME_CHANGED", "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], - "example" : "TEAM_ADDED_TO_GROUP", - "title" : "Team Event Types" + "description" : "Event type that triggers an alert.", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "example" : "STREAM_PROCESSOR_STATE_IS_FAILED", + "title" : "Stream Processor Event Types" }, - "TeamEventTypeViewForNdsGroup" : { + "StreamProcessorEventTypeViewForNdsGroup" : { "type" : "string", "description" : "Unique identifier of event type.", - "enum" : [ "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], - "example" : "TEAM_ADDED_TO_GROUP", - "title" : "Team Event Types" + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "example" : "STREAM_PROCESSOR_STATE_IS_FAILED", + "title" : "Stream Processor Event Types" }, - "TeamEventViewForNdsGroup" : { + "StreamProcessorEventViewForNdsGroup" : { "type" : "object", - "description" : "Team event identifies different activities around organization teams.", + "description" : "Stream Processor event identifies different activities about a stream processor in Atlas Streams.", "properties" : { - "apiKeyId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, "created" : { "type" : "string", "format" : "date-time", @@ -47226,7 +48903,7 @@ "readOnly" : true }, "eventTypeName" : { - "$ref" : "#/components/schemas/TeamEventTypeViewForNdsGroup" + "$ref" : "#/components/schemas/StreamProcessorEventTypeViewForNdsGroup" }, "groupId" : { "type" : "string", @@ -47246,10 +48923,10 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "isGlobalAdmin" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "instanceName" : { + "type" : "string", + "description" : "Name of the stream processing instance associated with the event.", + "example" : "foobar", "readOnly" : true }, "links" : { @@ -47273,113 +48950,297 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "publicKey" : { + "processorErrorMsg" : { "type" : "string", - "format" : "email", - "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "example" : "test.user@mongodb.com", + "description" : "Error message linked to the stream processor associated with the event.", + "example" : "invalid auth", + "readOnly" : true + }, + "processorName" : { + "type" : "string", + "description" : "Name of the stream processor associated with the event.", + "example" : "foobar", + "readOnly" : true + }, + "processorState" : { + "type" : "string", + "description" : "State of the stream processor associated with the event.", + "example" : "FAILED", "readOnly" : true }, "raw" : { "$ref" : "#/components/schemas/raw" + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Stream Processor Events" + }, + "StreamsClusterConnection" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/StreamsConnection" + }, { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Name of the cluster configured for this connection." + }, + "dbRoleToExecute" : { + "$ref" : "#/components/schemas/DBRoleToExecute" + } + } + } ] + }, + "StreamsConnection" : { + "type" : "object", + "description" : "Settings that define a connection to an external data store.", + "discriminator" : { + "mapping" : { + "Cluster" : "#/components/schemas/StreamsClusterConnection", + "Kafka" : "#/components/schemas/StreamsKafkaConnection", + "Sample" : "#/components/schemas/StreamsSampleConnection" }, - "remoteAddress" : { + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/StreamsSampleConnection" + }, { + "$ref" : "#/components/schemas/StreamsClusterConnection" + }, { + "$ref" : "#/components/schemas/StreamsKafkaConnection" + } ], + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { "type" : "string", - "description" : "IPv4 or IPv6 address from which the user triggered this event.", - "example" : "216.172.40.186", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "description" : "Human-readable label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source." + }, + "type" : { + "type" : "string", + "description" : "Type of the connection. Can be either Cluster or Kafka.", + "enum" : [ "Kafka", "Cluster", "Sample" ] + } + }, + "readOnly" : true + }, + "StreamsDLQ" : { + "type" : "object", + "description" : "Dead letter queue for the stream processor.", + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/reference/glossary/#std-term-dead-letter-queue" + }, + "properties" : { + "coll" : { + "type" : "string", + "description" : "Name of the collection to use for the DLQ." + }, + "connectionName" : { + "type" : "string", + "description" : "Name of the connection to write DLQ messages to. Must be an Atlas connection." + }, + "db" : { + "type" : "string", + "description" : "Name of the database to use for the DLQ." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, "readOnly" : true + } + } + }, + "StreamsDataProcessRegion" : { + "type" : "object", + "description" : "Information about the cloud provider region in which MongoDB Cloud processes the stream.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Label that identifies the cloud service provider where MongoDB Cloud performs stream processing. Currently, this parameter supports AWS only.", + "enum" : [ "AWS", "GCP", "AZURE", "TENANT", "SERVERLESS" ] }, - "teamId" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "region" : { + "$ref" : "#/components/schemas/BaseStreamsRegion" + } + }, + "required" : [ "cloudProvider", "region" ] + }, + "StreamsEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "MAX_PROCESSOR_COUNT_REACHED" ], + "example" : "MAX_PROCESSOR_COUNT_REACHED", + "title" : "Streams Event Types" + }, + "StreamsEventViewForNdsGroup" : { + "type" : "object", + "description" : "Streams event identifies different activities about Atlas Streams.", + "properties" : { + "created" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization team associated with this event.", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/StreamsEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "userId" : { + "id" : { "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.", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "username" : { + "instanceName" : { "type" : "string", - "format" : "email", - "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", - "example" : "test.user@mongodb.com", + "description" : "Name of the stream processing instance associated with the event.", + "example" : "foobar", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" } }, "required" : [ "created", "eventTypeName", "id" ], - "title" : "Team Events" + "title" : "Streams Events" }, - "TeamNotification" : { + "StreamsKafkaAuthentication" : { "type" : "object", - "description" : "Team notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "description" : "User credentials required to connect to a Kafka Cluster. Includes the authentication type, as well as the parameters for that authentication mode.", "properties" : { - "delayMin" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." - }, - "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:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" - }, - "intervalMin" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", - "minimum" : 5 - }, - "notifierId" : { - "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:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true }, - "teamId" : { + "mechanism" : { "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", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" + "description" : "Style of authentication. Can be one of PLAIN, SCRAM-256, or SCRAM-512." }, - "teamName" : { + "password" : { "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" + "format" : "password", + "description" : "Password of the account to connect to the Kafka cluster.", + "writeOnly" : true }, - "typeName" : { + "username" : { "type" : "string", - "description" : "Human-readable label that displays the alert notification type.", - "enum" : [ "TEAM" ] + "description" : "Username of the account to connect to the Kafka cluster." } - }, - "required" : [ "typeName" ], - "title" : "Team Notification" + } }, - "TeamResponse" : { + "StreamsKafkaConnection" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/StreamsConnection" + }, { + "type" : "object", + "properties" : { + "authentication" : { + "$ref" : "#/components/schemas/StreamsKafkaAuthentication" + }, + "bootstrapServers" : { + "type" : "string", + "description" : "Comma separated list of server addresses." + }, + "config" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.", + "example" : "{\"group.protocol.type\":\"consumer\",\"debug\":\"queue, msg, protocol\"}" + }, + "description" : "A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.", + "example" : { + "debug" : "queue, msg, protocol", + "group.protocol.type" : "consumer" + } + }, + "networking" : { + "$ref" : "#/components/schemas/StreamsKafkaNetworking" + }, + "security" : { + "$ref" : "#/components/schemas/StreamsKafkaSecurity" + } + } + } ] + }, + "StreamsKafkaNetworking" : { "type" : "object", + "description" : "Networking Access Type can either be 'PUBLIC' (default) or VPC. VPC type is in public preview, please file a support ticket to enable VPC Network Access", "properties" : { - "id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies this team.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "access" : { + "$ref" : "#/components/schemas/StreamsKafkaNetworkingAccess" }, "links" : { "type" : "array", @@ -47392,16 +49253,21 @@ "$ref" : "#/components/schemas/Link" }, "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "Human-readable label that identifies the team." } } }, - "TeamRole" : { + "StreamsKafkaNetworkingAccess" : { "type" : "object", + "description" : "Information about the networking access.", "properties" : { + "connectionId" : { + "type" : "string", + "description" : "Reserved. Will be used by PRIVATE_LINK connection type.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, "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.", @@ -47414,28 +49280,26 @@ }, "readOnly" : true }, - "roleNames" : { - "type" : "array", - "description" : "One or more organization- or project-level roles to assign to the MongoDB Cloud user.", - "items" : { - "type" : "string", - "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] - }, - "uniqueItems" : true + "name" : { + "type" : "string", + "description" : "Reserved. Will be used by PRIVATE_LINK connection type." }, - "teamId" : { + "type" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the team.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" + "description" : "Selected networking type. Either PUBLIC, VPC or PRIVATE_LINK. Defaults to PUBLIC. For VPC, ensure that VPC peering exists and connectivity has been established between Atlas VPC and the VPC where Kafka cluster is hosted for the connection to function properly. PRIVATE_LINK support is coming soon.", + "enum" : [ "PUBLIC", "VPC", "PRIVATE_LINK" ], + "title" : "Networking Access Type" } } }, - "TeamUpdate" : { + "StreamsKafkaSecurity" : { "type" : "object", + "description" : "Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use.", "properties" : { + "brokerPublicCertificate" : { + "type" : "string", + "description" : "A trusted, public x509 certificate for connecting to Kafka over SSL." + }, "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.", @@ -47448,108 +49312,83 @@ }, "readOnly" : true }, - "name" : { - "type" : "string", - "description" : "Human-readable label that identifies the team.", - "writeOnly" : true - } - }, - "required" : [ "name" ] - }, - "TenantHardwareSpec" : { - "type" : "object", - "properties" : { - "instanceSize" : { + "protocol" : { "type" : "string", - "description" : "Hardware specification for the instances in this M0/M2/M5 tier cluster.", - "enum" : [ "M0", "M2", "M5" ], - "title" : "Tenant Instance Sizes" + "description" : "Describes the transport type. Can be either PLAINTEXT or SSL." } } }, - "TenantHardwareSpec20240805" : { + "StreamsMatcher" : { "type" : "object", + "description" : "Rules to apply when comparing a stream processing instance or stream processor against this alert configuration.", "properties" : { - "diskSizeGB" : { - "type" : "number", - "format" : "double", - "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", - "maximum" : 4096, - "minimum" : 10 + "fieldName" : { + "$ref" : "#/components/schemas/StreamsMatcherField" }, - "instanceSize" : { + "operator" : { "type" : "string", - "description" : "Hardware specification for the instances in this M0/M2/M5 tier cluster.", - "enum" : [ "M0", "M2", "M5" ], - "title" : "Tenant Instance Sizes" + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" } - } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" }, - "TenantRegionConfig" : { - "type" : "object", - "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`.", - "enum" : [ "AWS", "GCP", "AZURE" ] - } - } - } ], - "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", - "title" : "Tenant Regional Replication Specifications" + "StreamsMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "INSTANCE_NAME", "PROCESSOR_NAME" ], + "example" : "INSTANCE_NAME", + "title" : "Streams Matcher Fields" }, - "TenantRegionConfig20240805" : { + "StreamsOptions" : { "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/CloudRegionConfig20240805" - }, { - "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`.", - "enum" : [ "AWS", "GCP", "AZURE" ] - } + "description" : "Optional configuration for the stream processor.", + "properties" : { + "dlq" : { + "$ref" : "#/components/schemas/StreamsDLQ" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true } - } ], - "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", - "title" : "Tenant Regional Replication Specifications" + } }, - "TenantRestore" : { + "StreamsPrivateLinkConnection" : { "type" : "object", + "description" : "Container for metadata needed to create a Private Link connection.", "properties" : { - "clusterName" : { + "_id" : { "type" : "string", - "description" : "Human-readable label that identifies the source cluster.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "readOnly" : true + "description" : "The ID of the Private Link connection." }, - "deliveryType" : { + "dnsDomain" : { "type" : "string", - "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", - "enum" : [ "RESTORE", "DOWNLOAD" ], - "readOnly" : true + "description" : "Domain name of Confluent cluster." }, - "expirationDate" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "dnsSubDomain" : { + "type" : "array", + "description" : "Sub-Domain name of Confluent cluster. These are typically your availability zones.", + "items" : { + "type" : "string" + } }, - "id" : { + "interfaceEndpointId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "description" : "Interface endpoint ID that is created from the service endpoint ID provided." }, "links" : { "type" : "array", @@ -47563,354 +49402,451 @@ }, "readOnly" : true }, - "projectId" : { + "provider" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "description" : "Provider where the Kafka cluster is deployed." }, - "restoreFinishedDate" : { + "region" : { "type" : "string", - "format" : "date-time", - "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.", - "readOnly" : true + "description" : "Domain name of Confluent cluster." }, - "restoreScheduledDate" : { + "serviceEndpointId" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "description" : "AWS Service Endpoint ID." }, - "snapshotFinishedDate" : { + "state" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "description" : "State the connection is in." }, - "snapshotId" : { + "vendor" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "description" : "Vendor who manages the Kafka cluster." + } + } + }, + "StreamsProcessor" : { + "type" : "object", + "description" : "An atlas stream processor.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the stream processor.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" - }, - "snapshotUrl" : { - "type" : "string", - "description" : "Internet address from which you can download the compressed snapshot files. The resource returns this parameter when `\"deliveryType\" : \"DOWNLOAD\"`.", + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "status" : { - "type" : "string", - "description" : "Phase of the restore workflow for this job at the time this resource made this request.", - "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, "readOnly" : true }, - "targetDeploymentItemName" : { + "name" : { "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.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + "description" : "Human-readable name of the stream processor." }, - "targetProjectId" : { - "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", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" + "options" : { + "$ref" : "#/components/schemas/StreamsOptions" + }, + "pipeline" : { + "type" : "array", + "description" : "Stream aggregation pipeline you want to apply to your streaming data.", + "externalDocs" : { + "description" : "Supported Aggregation Pipeline Stages", + "url" : "https://www.mongodb.com/docs/atlas/atlas-stream-processing/stream-aggregation/#std-label-stream-aggregation" + }, + "items" : { + "$ref" : "#/components/schemas/Document" + } } - }, - "required" : [ "snapshotId", "targetDeploymentItemName" ] + } }, - "TextSearchHostStatusDetail" : { + "StreamsProcessorWithStats" : { "type" : "object", + "description" : "An atlas stream processor with optional stats.", "properties" : { - "hostname" : { + "_id" : { "type" : "string", - "description" : "Hostname that corresponds to the status detail." + "description" : "Unique 24-hexadecimal character string that identifies the stream processor.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "mainIndex" : { - "$ref" : "#/components/schemas/TextSearchIndexStatusDetail" + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true }, - "queryable" : { - "type" : "boolean", - "description" : "Flag that indicates whether the index is queryable on the host." + "name" : { + "type" : "string", + "description" : "Human-readable name of the stream processor.", + "readOnly" : true }, - "stagedIndex" : { - "$ref" : "#/components/schemas/TextSearchIndexStatusDetail" + "options" : { + "$ref" : "#/components/schemas/StreamsOptions" }, - "status" : { + "pipeline" : { + "type" : "array", + "description" : "Stream aggregation pipeline you want to apply to your streaming data.", + "items" : { + "$ref" : "#/components/schemas/Document" + }, + "readOnly" : true + }, + "state" : { "type" : "string", - "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", - "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + "description" : "The state of the stream processor. Commonly occurring states are 'CREATED', 'STARTED', 'STOPPED' and 'FAILED'.", + "readOnly" : true + }, + "stats" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "The stats associated with the stream processor.", + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor" + }, + "readOnly" : true + }, + "description" : "The stats associated with the stream processor.", + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor" + }, + "readOnly" : true } }, - "title" : "Text Search Host Status Detail" + "required" : [ "_id", "name", "pipeline", "state" ] }, - "TextSearchIndexCreateRequest" : { + "StreamsSampleConnection" : { "type" : "object", "allOf" : [ { - "$ref" : "#/components/schemas/SearchIndexCreateRequest" - }, { - "type" : "object", - "properties" : { - "definition" : { - "$ref" : "#/components/schemas/TextSearchIndexDefinition" - } + "$ref" : "#/components/schemas/StreamsConnection" + } ] + }, + "StreamsSampleConnections" : { + "type" : "object", + "description" : "Sample connections to add to SPI.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "solar" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to add a 'sample_stream_solar' connection." } - } ], - "description" : "Text Search Index Create Request", - "required" : [ "collectionName", "database", "definition", "name" ] + } }, - "TextSearchIndexDefinition" : { + "StreamsTenant" : { "type" : "object", - "description" : "The text search index definition set by the user.", "properties" : { - "analyzer" : { + "_id" : { "type" : "string", - "default" : "lucene.standard", - "description" : "Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves making the following changes to the text in fields:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\n MongoDB Cloud uses the process you select to build the Atlas Search index.", - "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ], - "externalDocs" : { - "description" : "Atlas Search Analyzers", - "url" : "https://dochub.mongodb.org/core/analyzers--fts" - } + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "analyzers" : { + "connections" : { "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" - }, + "description" : "List of connections configured in the stream instance.", "items" : { - "$ref" : "#/components/schemas/AtlasSearchAnalyzer" - } + "$ref" : "#/components/schemas/StreamsConnection" + }, + "readOnly" : true }, - "mappings" : { - "$ref" : "#/components/schemas/SearchMappings" + "dataProcessRegion" : { + "$ref" : "#/components/schemas/StreamsDataProcessRegion" }, - "searchAnalyzer" : { + "groupId" : { "type" : "string", - "default" : "lucene.standard", - "description" : "Method applied to identify words when searching this index.", - "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "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 Stored Source Fields.", - "example" : { - "include | exclude" : [ "field1", "field2" ] + "hostnames" : { + "type" : "array", + "description" : "List that contains the hostnames assigned to the stream instance.", + "items" : { + "type" : "string", + "description" : "Unique hostname assigned to the stream instance.", + "readOnly" : true }, - "externalDocs" : { - "description" : "Stored Source Fields", - "url" : "https://dochub.mongodb.org/core/atlas-search-stored-source" - } + "readOnly" : true }, - "synonyms" : { + "links" : { "type" : "array", - "description" : "Rule sets that map words to their synonyms in this index.", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", "externalDocs" : { - "description" : "Synonym Mapping", - "url" : "https://dochub.mongodb.org/core/fts-synonym-mappings" + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" }, "items" : { - "$ref" : "#/components/schemas/SearchSynonymMappingDefinition" - } - } - }, - "required" : [ "mappings" ], - "title" : "Text Search Index Definition" - }, - "TextSearchIndexResponse" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/SearchIndexResponse" - }, { - "type" : "object", - "properties" : { - "latestDefinition" : { - "$ref" : "#/components/schemas/TextSearchIndexDefinition" - }, - "statusDetail" : { - "type" : "array", - "description" : "List of documents detailing index status on each host.", - "items" : { - "$ref" : "#/components/schemas/TextSearchHostStatusDetail" - } - }, - "synonymMappingStatus" : { - "type" : "string", - "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", - "enum" : [ "FAILED", "BUILDING", "READY" ] - }, - "synonymMappingStatusDetail" : { - "type" : "array", - "description" : "A list of documents describing the status of the index's synonym mappings on each search host. Only appears if the index has synonyms defined.", - "items" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/SynonymMappingStatusDetail" - } - } - } + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the stream instance." + }, + "sampleConnections" : { + "$ref" : "#/components/schemas/StreamsSampleConnections" + }, + "streamConfig" : { + "$ref" : "#/components/schemas/StreamConfig" } - } ], - "title" : "Text Search Index Response" + } }, - "TextSearchIndexStatusDetail" : { + "SummaryNotification" : { "type" : "object", - "description" : "Contains status information about a text search index.", + "description" : "Summary notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", "properties" : { - "definition" : { - "$ref" : "#/components/schemas/TextSearchIndexDefinition" + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." }, - "definitionVersion" : { - "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + "emailAddress" : { + "type" : "string", + "format" : "email", + "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:\n\n- specific MongoDB Cloud users (`\"notifications.[n].typeName\" : \"USER\"`)\n- MongoDB Cloud users with specific project roles (`\"notifications.[n].typeName\" : \"GROUP\"`)\n- MongoDB Cloud users with specific organization roles (`\"notifications.[n].typeName\" : \"ORG\"`)\n- MongoDB Cloud teams (`\"notifications.[n].typeName\" : \"TEAM\"`)\n\nTo send emails to one MongoDB Cloud user or grouping of users, set the **notifications.[n].emailEnabled** parameter." + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "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" ] + } + }, + "required" : [ "typeName" ], + "title" : "Summary Notification" + }, + "SynonymMappingStatusDetail" : { + "type" : "object", + "description" : "Contains the status of the index's synonym mappings on each search host. This field (and its subfields) only appear if the index has synonyms defined.", + "properties" : { "message" : { "type" : "string", "description" : "Optional message describing an error." }, "queryable" : { "type" : "boolean", - "description" : "Flag that indicates whether the index generation is queryable on the host." + "description" : "Flag that indicates whether the synonym mapping is queryable on a host." }, "status" : { - "type" : "string", - "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", - "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] - }, - "synonymMappingStatus" : { "type" : "string", "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", "enum" : [ "FAILED", "BUILDING", "READY" ] - }, - "synonymMappingStatusDetail" : { - "type" : "array", - "description" : "List of synonym statuses by mapping.", - "items" : { - "$ref" : "#/components/schemas/SynonymMappingStatusDetailMap" - } } }, - "title" : "Text Search Index Status Detail" + "title" : "Synonym Mapping Status Detail" }, - "ThirdPartyIntegration" : { + "SynonymMappingStatusDetailMap" : { "type" : "object", - "description" : "Collection of settings that describe third-party integrations.", - "discriminator" : { - "mapping" : { - "DATADOG" : "#/components/schemas/Datadog", - "MICROSOFT_TEAMS" : "#/components/schemas/MicrosoftTeams", - "NEW_RELIC" : "#/components/schemas/NewRelic", - "OPS_GENIE" : "#/components/schemas/OpsGenie", - "PAGER_DUTY" : "#/components/schemas/PagerDuty", - "PROMETHEUS" : "#/components/schemas/Prometheus", - "SLACK" : "#/components/schemas/Slack", - "VICTOR_OPS" : "#/components/schemas/VictorOps", - "WEBHOOK" : "#/components/schemas/Webhook" - }, - "propertyName" : "type" + "additionalProperties" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetail" }, + "x-additionalPropertiesName" : "Synonym Mapping Name" + }, + "SynonymSource" : { + "type" : "object", + "description" : "Data set that stores words and their applicable synonyms.", "properties" : { - "id" : { - "type" : "string", - "description" : "Integration id.", - "nullable" : true - }, - "type" : { + "collection" : { "type" : "string", - "description" : "Integration type", - "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], - "title" : "Integration Type" + "description" : "Label that identifies the MongoDB collection that stores words and their applicable synonyms." } }, - "title" : "Third-Party Integration" + "required" : [ "collection" ] }, - "TimeMetricAlertView" : { + "SystemStatus" : { "type" : "object", "properties" : { - "acknowledgedUntil" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + "apiKey" : { + "$ref" : "#/components/schemas/ApiKey" }, - "acknowledgementComment" : { + "appName" : { "type" : "string", - "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", - "example" : "Expiration on 3/19. Silencing for 7days.", - "maxLength" : 200 + "description" : "Human-readable label that identifies the service from which you requested this response.", + "enum" : [ "MongoDB Atlas" ], + "readOnly" : true }, - "acknowledgingUsername" : { + "build" : { "type" : "string", - "format" : "email", - "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "description" : "Unique 40-hexadecimal digit hash that identifies the latest git commit merged for this application.", + "example" : "83be55e140f493c88e7f578aae96548dd881587b", "readOnly" : true }, - "alertConfigId" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "throttling" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled throttling on this service.", + "readOnly" : true + } + }, + "required" : [ "apiKey", "appName", "build", "throttling" ] + }, + "TargetOrg" : { + "type" : "object", + "properties" : { + "linkToken" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "description" : "Link token that contains all the information required to complete the link." + } + }, + "required" : [ "linkToken" ] + }, + "TargetOrgRequest" : { + "type" : "object", + "properties" : { + "accessListIps" : { + "type" : "array", + "description" : "IP address access list entries associated with the API key.", + "items" : { + "type" : "string", + "description" : "One IP address access list entry associated with the API key." + } + } + } + }, + "Team" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this team.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "clusterName" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { "type" : "string", - "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", - "example" : "cluster1", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "description" : "Human-readable label that identifies the team." + }, + "usernames" : { + "type" : "array", + "description" : "List that contains the MongoDB Cloud users in this team.", + "items" : { + "type" : "string", + "format" : "email", + "description" : "List that contains email addresses that identify MongoDB Cloud users to in this team." + }, + "uniqueItems" : true + } + }, + "required" : [ "name" ] + }, + "TeamEvent" : { + "type" : "object", + "description" : "Team event identifies different activities around organization teams.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, "created" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "currentValue" : { - "$ref" : "#/components/schemas/TimeMetricValueView" - }, "eventTypeName" : { - "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + "$ref" : "#/components/schemas/TeamEventTypeView" }, "groupId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "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.", - "example" : "cloud-test.mongodb.com:27017", - "readOnly" : true - }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "lastNotified" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", "readOnly" : true }, "links" : { @@ -47925,51 +49861,78 @@ }, "readOnly" : true }, - "metricName" : { - "type" : "string", - "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", - "example" : "ASSERT_USER", - "readOnly" : true - }, "orgId" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "replicaSetName" : { + "publicKey" : { "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.", - "example" : "event-replica-set", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true }, - "resolved" : { + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { "type" : "string", - "format" : "date-time", - "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\"`.", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", "readOnly" : true }, - "status" : { + "teamId" : { "type" : "string", - "description" : "State of this alert at the time you requested its details.", - "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], - "example" : "OPEN", + "description" : "Unique 24-hexadecimal digit string that identifies the organization team associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "updated" : { + "userId" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true } }, - "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Team Events" }, - "TimeMetricEventView" : { + "TeamEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TEAM_CREATED", "TEAM_DELETED", "TEAM_UPDATED", "TEAM_NAME_CHANGED", "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "example" : "TEAM_ADDED_TO_GROUP", + "title" : "Team Event Types" + }, + "TeamEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "example" : "TEAM_ADDED_TO_GROUP", + "title" : "Team Event Types" + }, + "TeamEventViewForNdsGroup" : { "type" : "object", + "description" : "Team event identifies different activities around organization teams.", "properties" : { "apiKeyId" : { "type" : "string", @@ -47986,11 +49949,8 @@ "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "currentValue" : { - "$ref" : "#/components/schemas/TimeMetricValueView" - }, "eventTypeName" : { - "$ref" : "#/components/schemas/HostMetricEventTypeView" + "$ref" : "#/components/schemas/TeamEventTypeViewForNdsGroup" }, "groupId" : { "type" : "string", @@ -48028,11 +49988,6 @@ }, "readOnly" : true }, - "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" : { "type" : "string", "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", @@ -48042,13 +49997,6 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "port" : { - "type" : "integer", - "format" : "int32", - "description" : "IANA port on which the MongoDB process listens for requests.", - "example" : 27017, - "readOnly" : true - }, "publicKey" : { "type" : "string", "format" : "email", @@ -48066,16 +50014,13 @@ "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", "readOnly" : true }, - "replicaSetName" : { - "type" : "string", - "description" : "Human-readable label of the replica set associated with the event.", - "example" : "event-replica-set", - "readOnly" : true - }, - "shardName" : { + "teamId" : { "type" : "string", - "description" : "Human-readable label of the shard associated with the event.", - "example" : "event-sh-01", + "description" : "Unique 24-hexadecimal digit string that identifies the organization team associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, "userId" : { @@ -48095,250 +50040,220 @@ "readOnly" : true } }, - "required" : [ "created", "eventTypeName", "id" ] + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Team Events" }, - "TimeMetricThresholdView" : { + "TeamNotification" : { "type" : "object", + "description" : "Team notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", "properties" : { - "metricName" : { - "type" : "string", - "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." }, - "mode" : { + "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:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { "type" : "string", - "description" : "MongoDB Cloud computes the current metric value as an average.", - "enum" : [ "AVERAGE" ] + "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" }, - "operator" : { - "$ref" : "#/components/schemas/Operator" + "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:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" }, - "threshold" : { - "type" : "number", - "format" : "double", - "description" : "Value of metric that, when exceeded, triggers an alert." + "teamId" : { + "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", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" }, - "units" : { - "$ref" : "#/components/schemas/TimeMetricUnits" - } - }, - "required" : [ "metricName" ] - }, - "TimeMetricUnits" : { - "type" : "string", - "default" : "HOURS", - "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", - "enum" : [ "NANOSECONDS", "MILLISECONDS", "MILLION_MINUTES", "SECONDS", "MINUTES", "HOURS", "DAYS" ], - "title" : "Time Metric Units" - }, - "TimeMetricValueView" : { - "type" : "object", - "description" : "Measurement of the **metricName** recorded at the time of the event.", - "properties" : { - "number" : { - "type" : "number", - "format" : "double", - "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", - "readOnly" : true + "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" }, - "units" : { - "$ref" : "#/components/schemas/TimeMetricUnits" - } - }, - "readOnly" : true, - "title" : "Time Metric Value" - }, - "TokenFilterEnglishPossessive" : { - "type" : "object", - "description" : "Filter that removes possessives (trailing 's) from words.", - "properties" : { - "type" : { + "typeName" : { "type" : "string", - "description" : "Human-readable label that identifies this token filter type.", - "enum" : [ "englishPossessive" ] + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "TEAM" ] } }, - "required" : [ "type" ], - "title" : "englishPossessive" + "required" : [ "typeName" ], + "title" : "Team Notification" }, - "TokenFilterFlattenGraph" : { + "TeamResponse" : { "type" : "object", - "description" : "Filter that transforms a token filter graph, such as the token filter graph that the wordDelimiterGraph token filter produces, into a flat form suitable for indexing.", "properties" : { - "type" : { + "id" : { "type" : "string", - "description" : "Human-readable label that identifies this token filter type.", - "enum" : [ "flattenGraph" ] + "description" : "Unique 24-hexadecimal digit string that identifies this team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the team." } - }, - "required" : [ "type" ], - "title" : "flattenGraph" + } }, - "TokenFilterPorterStemming" : { + "TeamRole" : { "type" : "object", - "description" : "Filter that uses the porter stemming algorithm to remove the common morphological and inflectional suffixes from words in English. It expects lowercase text and doesn't work as expected for uppercase text.", "properties" : { - "type" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "roleNames" : { + "type" : "array", + "description" : "One or more organization- or project-level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "teamId" : { "type" : "string", - "description" : "Human-readable label that identifies this token filter type.", - "enum" : [ "porterStemming" ] + "description" : "Unique 24-hexadecimal character string that identifies the team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" } - }, - "required" : [ "type" ], - "title" : "porterStemming" + } }, - "TokenFilterSpanishPluralStemming" : { + "TeamUpdate" : { "type" : "object", - "description" : "Filter that stems Spanish plural words. It expects lowercase text.", "properties" : { - "type" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { "type" : "string", - "description" : "Human-readable label that identifies this token filter type.", - "enum" : [ "spanishPluralStemming" ] + "description" : "Human-readable label that identifies the team.", + "writeOnly" : true } }, - "required" : [ "type" ], - "title" : "spanishPluralStemming" + "required" : [ "name" ] }, - "TokenFilterStempel" : { + "TenantHardwareSpec" : { "type" : "object", - "description" : "Filter that uses Lucene's default Polish stemmer table to stem words in the Polish language. It expects lowercase text.", - "externalDocs" : { - "description" : "Default Polish stemmer table", - "url" : "https://lucene.apache.org/core/9_2_0/analysis/stempel/org/apache/lucene/analysis/pl/PolishAnalyzer.html#DEFAULT_STEMMER_FILE" - }, "properties" : { - "type" : { + "instanceSize" : { "type" : "string", - "description" : "Human-readable label that identifies this token filter type.", - "enum" : [ "stempel" ] + "description" : "Hardware specification for the instances in this M0/M2/M5 tier cluster.", + "enum" : [ "M0", "M2", "M5" ], + "title" : "Tenant Instance Sizes" } - }, - "required" : [ "type" ], - "title" : "stempel" + } }, - "TokenFilterWordDelimiterGraph" : { + "TenantHardwareSpec20240805" : { "type" : "object", - "description" : "Filter that splits tokens into sub-tokens based on configured rules.", "properties" : { - "delimiterOptions" : { - "type" : "object", - "description" : "Object that contains the rules that determine how to split words into sub-words.", - "properties" : { - "concatenateAll" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether to concatenate runs." - }, - "concatenateNumbers" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether to concatenate runs of sub-numbers." - }, - "concatenateWords" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether to concatenate runs of sub-words." - }, - "generateNumberParts" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether to split tokens based on sub-numbers. For example, if `true`, this option splits `100-2` into `100` and `2`." - }, - "generateWordParts" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether to split tokens based on sub-words." - }, - "ignoreKeywords" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether to skip tokens with the `keyword` attribute set to `true`" - }, - "preserveOriginal" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether to generate tokens of the original words." - }, - "splitOnCaseChange" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether to split tokens based on letter-case transitions." - }, - "splitOnNumerics" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether to split tokens based on letter-number transitions." - }, - "stemEnglishPossessive" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether to remove trailing possessives from each sub-word." - } - } - }, - "protectedWords" : { - "type" : "object", - "description" : "Object that contains options for protected words.", - "properties" : { - "ignoreCase" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether to ignore letter case sensitivity for protected words." - }, - "words" : { - "type" : "array", - "description" : "List that contains the tokens to protect from delimination.", - "items" : { - "type" : "string" - } - } - }, - "required" : [ "words" ] + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 }, - "type" : { + "instanceSize" : { "type" : "string", - "description" : "Human-readable label that identifies this token filter type.", - "enum" : [ "wordDelimiterGraph" ] + "description" : "Hardware specification for the instances in this M0/M2/M5 tier cluster.", + "enum" : [ "M0", "M2", "M5" ], + "title" : "Tenant Instance Sizes" } - }, - "required" : [ "type" ], - "title" : "wordDelimiterGraph" + } }, - "TokenFilterkStemming" : { + "TenantRegionConfig" : { "type" : "object", - "description" : "Filter that combines algorithmic stemming with a built-in dictionary for the English language to stem words.", - "properties" : { - "type" : { - "type" : "string", - "description" : "Human-readable label that identifies this token filter type.", - "enum" : [ "kStemming" ] + "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`.", + "enum" : [ "AWS", "GCP", "AZURE" ] + } } - }, - "required" : [ "type" ], - "title" : "kStemming" + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Tenant Regional Replication Specifications" }, - "TriggerIngestionPipelineRequest" : { + "TenantRegionConfig20240805" : { "type" : "object", - "properties" : { - "datasetRetentionPolicy" : { - "$ref" : "#/components/schemas/DatasetRetentionPolicy" - }, - "snapshotId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "writeOnly" : true + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20240805" + }, { + "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`.", + "enum" : [ "AWS", "GCP", "AZURE" ] + } } - }, - "required" : [ "snapshotId" ] + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Tenant Regional Replication Specifications" }, - "USSBackupRestoreJob20250101" : { + "TenantRestore" : { "type" : "object", - "description" : "Details for one restore job of a USS instance.", "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the source cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "readOnly" : true + }, "deliveryType" : { "type" : "string", "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", @@ -48360,14 +50275,6 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "instanceName" : { - "type" : "string", - "description" : "Human-readable label that identifies the source instance.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "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.", @@ -48413,8 +50320,7 @@ "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "pattern" : "^([a-f0-9]{24})$" }, "snapshotUrl" : { "type" : "string", @@ -48429,176 +50335,311 @@ }, "targetDeploymentItemName" : { "type" : "string", - "description" : "Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another USS instance or Dedicated cluster tier.", + "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.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", - "readOnly" : true + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" }, "targetProjectId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the cluster to which you want to restore the snapshot.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "pattern" : "^([a-f0-9]{24})$" } }, - "title" : "USS Backup Restore Job" + "required" : [ "snapshotId", "targetDeploymentItemName" ] + }, + "TenantWithSampleConnections" : { + "type" : "object" }, - "USSBackupRestoreJobCreate20250101" : { + "TextSearchHostStatusDetail" : { "type" : "object", - "description" : "Details to create one restore job of a USS instance.", "properties" : { - "_snapshotId" : { + "hostname" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "writeOnly" : true + "description" : "Hostname that corresponds to the status detail." }, - "_targetDeploymentItemName" : { - "type" : "string", - "description" : "Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another USS instance or Dedicated cluster tier.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", - "writeOnly" : true + "mainIndex" : { + "$ref" : "#/components/schemas/TextSearchIndexStatusDetail" }, - "_targetProjectId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "writeOnly" : true + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on the host." }, - "deliveryType" : { - "type" : "string", - "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", - "enum" : [ "RESTORE", "DOWNLOAD" ], - "readOnly" : true + "stagedIndex" : { + "$ref" : "#/components/schemas/TextSearchIndexStatusDetail" }, - "expirationDate" : { + "status" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true - }, - "id" : { + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Text Search Host Status Detail" + }, + "TextSearchIndexCreateRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexCreateRequest" + }, { + "type" : "object", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + } + } + } ], + "description" : "Text Search Index Create Request", + "required" : [ "collectionName", "database", "definition", "name" ] + }, + "TextSearchIndexDefinition" : { + "type" : "object", + "description" : "The text search index definition set by the user.", + "properties" : { + "analyzer" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "default" : "lucene.standard", + "description" : "Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves making the following changes to the text in fields:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\n MongoDB Cloud uses the process you select to build the Atlas Search index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ], + "externalDocs" : { + "description" : "Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/analyzers--fts" + } }, - "instanceName" : { + "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" + }, + "items" : { + "$ref" : "#/components/schemas/AtlasSearchAnalyzer" + } + }, + "mappings" : { + "$ref" : "#/components/schemas/SearchMappings" + }, + "searchAnalyzer" : { "type" : "string", - "description" : "Human-readable label that identifies the source instance.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "readOnly" : true + "default" : "lucene.standard", + "description" : "Method applied to identify words when searching this index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] }, - "links" : { + "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 Stored Source Fields.", + "example" : { + "include | exclude" : [ "field1", "field2" ] + }, + "externalDocs" : { + "description" : "Stored Source Fields", + "url" : "https://dochub.mongodb.org/core/atlas-search-stored-source" + } + }, + "synonyms" : { "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.", + "description" : "Rule sets that map words to their synonyms in this index.", "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + "description" : "Synonym Mapping", + "url" : "https://dochub.mongodb.org/core/fts-synonym-mappings" }, "items" : { - "$ref" : "#/components/schemas/Link" + "$ref" : "#/components/schemas/SearchSynonymMappingDefinition" + } + } + }, + "required" : [ "mappings" ], + "title" : "Text Search Index Definition" + }, + "TextSearchIndexResponse" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexResponse" + }, { + "type" : "object", + "properties" : { + "latestDefinition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" }, - "readOnly" : true + "statusDetail" : { + "type" : "array", + "description" : "List of documents detailing index status on each host.", + "items" : { + "$ref" : "#/components/schemas/TextSearchHostStatusDetail" + } + }, + "synonymMappingStatus" : { + "type" : "string", + "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", + "enum" : [ "FAILED", "BUILDING", "READY" ] + }, + "synonymMappingStatusDetail" : { + "type" : "array", + "description" : "A list of documents describing the status of the index's synonym mappings on each search host. Only appears if the index has synonyms defined.", + "items" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetail" + } + } + } + } + } ], + "title" : "Text Search Index Response" + }, + "TextSearchIndexStatusDetail" : { + "type" : "object", + "description" : "Contains status information about a text search index.", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" }, - "projectId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" }, - "restoreFinishedDate" : { + "message" : { "type" : "string", - "format" : "date-time", - "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.", - "readOnly" : true + "description" : "Optional message describing an error." }, - "restoreScheduledDate" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index generation is queryable on the host." }, - "snapshotFinishedDate" : { + "status" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] }, - "snapshotUrl" : { + "synonymMappingStatus" : { "type" : "string", - "description" : "Internet address from which you can download the compressed snapshot files. The resource returns this parameter when `\"deliveryType\" : \"DOWNLOAD\"`.", - "readOnly" : true + "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", + "enum" : [ "FAILED", "BUILDING", "READY" ] }, - "status" : { - "type" : "string", - "description" : "Phase of the restore workflow for this job at the time this resource made this request.", - "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], - "readOnly" : true + "synonymMappingStatusDetail" : { + "type" : "array", + "description" : "List of synonym statuses by mapping.", + "items" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetailMap" + } } }, - "required" : [ "_snapshotId", "_targetDeploymentItemName" ], - "title" : "Create USS Backup Restore Job" + "title" : "Text Search Index Status Detail" }, - "USSBackupSettings20250101" : { + "ThirdPartyIntegration" : { "type" : "object", - "description" : "USS backup configuration", + "description" : "Collection of settings that describe third-party integrations.", + "discriminator" : { + "mapping" : { + "DATADOG" : "#/components/schemas/Datadog", + "MICROSOFT_TEAMS" : "#/components/schemas/MicrosoftTeams", + "NEW_RELIC" : "#/components/schemas/NewRelic", + "OPS_GENIE" : "#/components/schemas/OpsGenie", + "PAGER_DUTY" : "#/components/schemas/PagerDuty", + "PROMETHEUS" : "#/components/schemas/Prometheus", + "SLACK" : "#/components/schemas/Slack", + "VICTOR_OPS" : "#/components/schemas/VictorOps", + "WEBHOOK" : "#/components/schemas/Webhook" + }, + "propertyName" : "type" + }, "properties" : { - "enabled" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether backups are performed for this USS instance. Backup uses [TODO](TODO) for USS instances.", - "readOnly" : true + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "type" : { + "type" : "string", + "description" : "Integration type", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" } }, - "readOnly" : true, - "title" : "USS backup configuration" + "title" : "Third-Party Integration" }, - "USSBackupSnapshot20250101" : { + "TimeMetricAlertView" : { "type" : "object", - "description" : "Details for one snapshot of a USS instance.", "properties" : { - "expiration" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "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.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "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.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "readOnly" : true + }, + "created" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "finishTime" : { + "currentValue" : { + "$ref" : "#/components/schemas/TimeMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "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.", + "example" : "cloud-test.mongodb.com:27017", "readOnly" : true }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, "links" : { "type" : "array", "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", @@ -48611,116 +50652,76 @@ }, "readOnly" : true }, - "mongoDBVersion" : { + "metricName" : { "type" : "string", - "description" : "MongoDB host version that the snapshot runs.", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", "readOnly" : true }, - "scheduledTime" : { + "orgId" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud will take the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "startTime" : { + "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.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when MongoDB Cloud began taking the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "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\"`.", "readOnly" : true }, "status" : { "type" : "string", - "description" : "Phase of the workflow for this snapshot at the time this resource made this request.", - "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true } }, - "title" : "USS Backup Snapshot" + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] }, - "USSBackupSnapshotDownloadCreate20250101" : { + "TimeMetricEventView" : { "type" : "object", - "description" : "Details for one backup snapshot download of a USS instance.", "properties" : { - "_snapshotId" : { + "apiKeyId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to download.", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", - "writeOnly" : true - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - } - }, - "required" : [ "_snapshotId" ], - "title" : "USS Backup Snapshot Download Create" - }, - "USSConnectionStrings20250101" : { - "type" : "object", - "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", - "externalDocs" : { - "description" : "Connection string URI format.", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, - "properties" : { - "standard" : { - "type" : "string", - "description" : "Public connection string that you can use to connect to this cluster. This connection string uses the mongodb:// protocol.", - "externalDocs" : { - "description" : "Connection String URI Format", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, - "readOnly" : true - }, - "standardSrv" : { - "type" : "string", - "description" : "Public connection string that you can use to connect to this USS instance. This connection string uses the `mongodb+srv://` protocol.", - "externalDocs" : { - "description" : "Connection String URI Format", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, "readOnly" : true - } - }, - "readOnly" : true, - "title" : "USS Instance Connection Strings" - }, - "USSInstanceDescription20250101" : { - "type" : "object", - "description" : "Group of settings that configure a MongoDB USS instance.", - "properties" : { - "backupSettings" : { - "$ref" : "#/components/schemas/USSBackupSettings20250101" }, - "clusterType" : { + "created" : { "type" : "string", - "description" : "USS instance topology.", - "enum" : [ "REPLICASET", "LOADBALANCED" ], + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "connectionStrings" : { - "$ref" : "#/components/schemas/USSConnectionStrings20250101" + "currentValue" : { + "$ref" : "#/components/schemas/TimeMetricValueView" }, - "createDate" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created this instance. This parameter expresses its value in ISO 8601 format in UTC.", - "readOnly" : true + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" }, "groupId" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the project.", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -48729,13 +50730,19 @@ }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the instance.", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, "links" : { "type" : "array", "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", @@ -48748,167 +50755,314 @@ }, "readOnly" : true }, - "mongoDBVersion" : { + "metricName" : { "type" : "string", - "description" : "Version of MongoDB that the instance runs.", - "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", "readOnly" : true }, - "name" : { + "orgId" : { "type" : "string", - "description" : "Human-readable label that identifies the instance.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "providerSettings" : { - "$ref" : "#/components/schemas/USSProviderSettings20250101" + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true }, - "stateName" : { + "publicKey" : { "type" : "string", - "description" : "Human-readable label that indicates the current operating condition of this instance.", - "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true }, - "tags" : { - "type" : "array", - "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.", - "externalDocs" : { - "description" : "Resource Tags", - "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" - }, - "items" : { - "$ref" : "#/components/schemas/ResourceTag" - } + "raw" : { + "$ref" : "#/components/schemas/raw" }, - "terminationProtectionEnabled" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true }, - "versionReleaseSystem" : { + "replicaSetName" : { "type" : "string", - "default" : "LTS", - "description" : "Method by which the cluster maintains the MongoDB versions.", - "enum" : [ "LTS" ], + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true } }, - "required" : [ "providerSettings" ], - "title" : "USS Instance Description" + "required" : [ "created", "eventTypeName", "id" ] }, - "USSInstanceDescriptionCreate20250101" : { + "TimeMetricThresholdView" : { "type" : "object", - "description" : "Settings that you can specify when you create a USS instance.", "properties" : { - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." }, - "name" : { + "mode" : { "type" : "string", - "description" : "Human-readable label that identifies the instance.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "writeOnly" : true + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] }, - "providerSettings" : { - "$ref" : "#/components/schemas/USSProviderSettingsCreate20250101" + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, - "tags" : { - "type" : "array", - "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.", - "externalDocs" : { - "description" : "Resource Tags", - "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" - }, - "items" : { - "$ref" : "#/components/schemas/ResourceTag" - } + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." }, - "terminationProtectionEnabled" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" } }, - "required" : [ "name", "providerSettings" ], - "title" : "USS Instance Description Create" + "required" : [ "metricName" ] + }, + "TimeMetricUnits" : { + "type" : "string", + "default" : "HOURS", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "NANOSECONDS", "MILLISECONDS", "MILLION_MINUTES", "SECONDS", "MINUTES", "HOURS", "DAYS" ], + "title" : "Time Metric Units" }, - "USSProviderSettings20250101" : { + "TimeMetricValueView" : { "type" : "object", - "description" : "Group of cloud provider settings that configure the provisioned MongoDB USS instance.", + "description" : "Measurement of the **metricName** recorded at the time of the event.", "properties" : { - "backingProviderName" : { - "type" : "string", - "description" : "Cloud service provider on which MongoDB Cloud provisioned the USS instance.", - "enum" : [ "AWS", "AZURE", "GCP" ], - "readOnly" : true - }, - "diskSizeGB" : { + "number" : { "type" : "number", "format" : "double", - "description" : "Storage capacity available to the USS instance expressed in gigabytes.", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", "readOnly" : true }, - "providerName" : { + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "readOnly" : true, + "title" : "Time Metric Value" + }, + "TokenFilterEnglishPossessive" : { + "type" : "object", + "description" : "Filter that removes possessives (trailing 's) from words.", + "properties" : { + "type" : { "type" : "string", - "default" : "USS", - "description" : "Human-readable label that identifies the cloud service provider.", - "enum" : [ "USS" ], - "readOnly" : true - }, - "regionName" : { + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "englishPossessive" ] + } + }, + "required" : [ "type" ], + "title" : "englishPossessive" + }, + "TokenFilterFlattenGraph" : { + "type" : "object", + "description" : "Filter that transforms a token filter graph, such as the token filter graph that the wordDelimiterGraph token filter produces, into a flat form suitable for indexing.", + "properties" : { + "type" : { "type" : "string", - "description" : "Human-readable label that identifies the geographic location of your MongoDB USS 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/).", - "readOnly" : true + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "flattenGraph" ] } }, - "readOnly" : true, - "title" : "Cloud Service Provider Settings for a USS Instance" + "required" : [ "type" ], + "title" : "flattenGraph" }, - "USSProviderSettingsCreate20250101" : { + "TokenFilterPorterStemming" : { "type" : "object", - "description" : "Group of cloud provider settings that configure the provisioned MongoDB USS instance.", + "description" : "Filter that uses the porter stemming algorithm to remove the common morphological and inflectional suffixes from words in English. It expects lowercase text and doesn't work as expected for uppercase text.", "properties" : { - "backingProviderName" : { + "type" : { "type" : "string", - "description" : "Cloud service provider on which MongoDB Cloud provisioned the serverless instance.", - "enum" : [ "AWS", "AZURE", "GCP" ], - "writeOnly" : true + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "porterStemming" ] + } + }, + "required" : [ "type" ], + "title" : "porterStemming" + }, + "TokenFilterSpanishPluralStemming" : { + "type" : "object", + "description" : "Filter that stems Spanish plural words. It expects lowercase text.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "spanishPluralStemming" ] + } + }, + "required" : [ "type" ], + "title" : "spanishPluralStemming" + }, + "TokenFilterStempel" : { + "type" : "object", + "description" : "Filter that uses Lucene's default Polish stemmer table to stem words in the Polish language. It expects lowercase text.", + "externalDocs" : { + "description" : "Default Polish stemmer table", + "url" : "https://lucene.apache.org/core/9_2_0/analysis/stempel/org/apache/lucene/analysis/pl/PolishAnalyzer.html#DEFAULT_STEMMER_FILE" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "stempel" ] + } + }, + "required" : [ "type" ], + "title" : "stempel" + }, + "TokenFilterWordDelimiterGraph" : { + "type" : "object", + "description" : "Filter that splits tokens into sub-tokens based on configured rules.", + "properties" : { + "delimiterOptions" : { + "type" : "object", + "description" : "Object that contains the rules that determine how to split words into sub-words.", + "properties" : { + "concatenateAll" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to concatenate runs." + }, + "concatenateNumbers" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to concatenate runs of sub-numbers." + }, + "concatenateWords" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to concatenate runs of sub-words." + }, + "generateNumberParts" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on sub-numbers. For example, if `true`, this option splits `100-2` into `100` and `2`." + }, + "generateWordParts" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on sub-words." + }, + "ignoreKeywords" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to skip tokens with the `keyword` attribute set to `true`" + }, + "preserveOriginal" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to generate tokens of the original words." + }, + "splitOnCaseChange" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on letter-case transitions." + }, + "splitOnNumerics" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on letter-number transitions." + }, + "stemEnglishPossessive" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to remove trailing possessives from each sub-word." + } + } }, - "diskSizeGB" : { - "type" : "number", - "format" : "double", - "description" : "Storage capacity available to the USS instance expressed in gigabytes.", - "readOnly" : true + "protectedWords" : { + "type" : "object", + "description" : "Object that contains options for protected words.", + "properties" : { + "ignoreCase" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to ignore letter case sensitivity for protected words." + }, + "words" : { + "type" : "array", + "description" : "List that contains the tokens to protect from delimination.", + "items" : { + "type" : "string" + } + } + }, + "required" : [ "words" ] }, - "providerName" : { + "type" : { "type" : "string", - "default" : "USS", - "description" : "Human-readable label that identifies the cloud service provider.", - "enum" : [ "USS" ], - "readOnly" : true + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "wordDelimiterGraph" ] + } + }, + "required" : [ "type" ], + "title" : "wordDelimiterGraph" + }, + "TokenFilterkStemming" : { + "type" : "object", + "description" : "Filter that combines algorithmic stemming with a built-in dictionary for the English language to stem words.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "kStemming" ] + } + }, + "required" : [ "type" ], + "title" : "kStemming" + }, + "TriggerIngestionPipelineRequest" : { + "type" : "object", + "properties" : { + "datasetRetentionPolicy" : { + "$ref" : "#/components/schemas/DatasetRetentionPolicy" }, - "regionName" : { + "snapshotId" : { "type" : "string", - "description" : "Human-readable label that identifies the geographic location of your MongoDB USS 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/).", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "writeOnly" : true } }, - "required" : [ "backingProviderName", "regionName" ], - "title" : "Cloud Service Provider Settings for a USS Instance", - "writeOnly" : true + "required" : [ "snapshotId" ] }, "UpdateAtlasOrganizationApiKey" : { "type" : "object", @@ -49546,7 +51700,7 @@ "description" : "Human-readable label that identifies the cluster or MongoDB Atlas Data Lake that this database user can access.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, "type" : { "type" : "string", @@ -49602,6 +51756,32 @@ "required" : [ "match" ], "title" : "User to Distinguished Name Mapping" }, + "VPCPeeringActionChallenge" : { + "type" : "object", + "description" : "Container for elements used to challenge the user before taking certain actions on VPC Peering connections.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "requesterAccountId" : { + "type" : "string", + "description" : "The AWS requester account ID." + }, + "requesterVpcId" : { + "type" : "string", + "description" : "The AWS requester VPC ID." + } + } + }, "VectorSearchHostStatusDetail" : { "type" : "object", "properties" : { diff --git a/tools/cli/test/data/split/dev/openapi-v2-2023-02-01.yaml b/tools/cli/test/data/split/dev/openapi-v2-2023-02-01.yaml index 0c96378625..1637f1bae9 100644 --- a/tools/cli/test/data/split/dev/openapi-v2-2023-02-01.yaml +++ b/tools/cli/test/data/split/dev/openapi-v2-2023-02-01.yaml @@ -13,13 +13,15 @@ info: ``` To learn more, see [Get Started with the Atlas Administration API](https://www.mongodb.com/docs/atlas/configure-api-access/). For support, see [MongoDB Support](https://www.mongodb.com/support/get-started). + + You can also explore the various endpoints available through the Atlas Administration API in MongoDB's [Postman workspace](https://www.postman.com/mongodb-devrel/workspace/mongodb-atlas-administration-apis/). license: name: CC BY-NC-SA 3.0 US url: https://creativecommons.org/licenses/by-nc-sa/3.0/us/ termsOfService: https://www.mongodb.com/mongodb-management-service-terms-and-conditions title: MongoDB Atlas Administration API version: "2.0" - x-xgen-sha: 09d9d18db2111c955a8e01702a27ca2763417782 + x-xgen-sha: e6ba3136dbd0be2a81dd4ed21b9e6c470edd4420 servers: - url: https://cloud.mongodb.com tags: @@ -82,8 +84,12 @@ tags: \ resource requires your project ID. Changes to federated database instance configurations\ \ can affect costs." name: Data Federation -- description: "Returns, adds, edits, and removes Atlas Data Lake Pipelines and associated\ +- description: "Returns, edits, and removes Atlas Data Lake Pipelines and associated\ \ runs." + externalDocs: + description: Data Lake Pipelines are deprecated. Please see Data Lake Deprecation + Guide. + url: https://dochub.mongodb.org/core/data-lake-deprecation name: Data Lake Pipelines - description: "Returns, adds, edits, and removes database users." name: Database Users @@ -158,6 +164,8 @@ tags: - description: "You can continually push logs from mongod, mongos, and audit logs\ \ to an AWS S3 bucket. Atlas exports logs every 5 minutes." name: Push-Based Log Export +- description: Configure and manage Atlas Resource Policies within your organization. + name: Resource Policies - description: Creates one index to a database deployment in a rolling manner. You can't create a rolling index on an `M0` free cluster or `M2/M5` shared cluster. name: Rolling Index @@ -173,6 +181,13 @@ tags: description: Set Up a Private Endpoint for a Serverless Instance Tutorial url: https://dochub.mongodb.org/core/serverless-private-endpoint name: Serverless Private Endpoints +- description: Endpoints for managing Service Accounts and secrets. Service Accounts + are used for programmatic access to the Atlas Admin API through the OAuth 2.0 + Client Credentials flow. This feature is available as a Preview feature. + externalDocs: + description: Get Started with the Atlas Administration API + url: https://www.mongodb.com/docs/atlas/configure-api-access/ + name: Service Accounts - description: Returns and adds restore jobs for shared-tier database deployments. name: Shared-Tier Restore Jobs - description: Returns and requests to download shared-tier database deployment snapshots. @@ -2234,9 +2249,9 @@ paths: /api/atlas/v2/groups/{groupId}/backup/exportBuckets: get: deprecated: true - description: "Returns all AWS S3 buckets and Azure Blob Storage Containers associated\ - \ with the specified Project. To use this resource, the requesting API Key\ - \ must have the Project Read Only role." + description: "Returns all Export Buckets associated with the specified Project.\ + \ To use this resource, the requesting API Key must have the Project Read\ + \ Only role." operationId: listExportBuckets parameters: - $ref: "#/components/parameters/envelope" @@ -2259,17 +2274,17 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Return All AWS S3 Buckets and Azure Blob Storage Containers Used for - Cloud Backup Snapshot Exports + summary: Return All Snapshot Export Buckets tags: - Cloud Backups - x-sunset: 2025-05-30 + x-sunset: 2026-05-30 post: deprecated: true - description: "Grants MongoDB Cloud access to the specified AWS S3 Bucket or\ - \ Azure Blob Storage Container. This enables this Export Bucket to receive\ - \ Atlas Cloud Backup Snapshots. To use this resource, the requesting API Key\ - \ must have the Project Owner role." + description: "Creates a Snapshot Export Bucket for an AWS S3 Bucket or Azure\ + \ Blob Storage Container. Once created, an snapshots can be exported to the\ + \ Export Bucket and its referenced AWS S3 Bucket or Azure Blob Storage Container.\ + \ To use this resource, the requesting API Key must have the Project Owner\ + \ role." operationId: createExportBucket parameters: - $ref: "#/components/parameters/envelope" @@ -2282,8 +2297,8 @@ paths: $ref: "#/components/schemas/DiskBackupSnapshotAWSExportBucket" x-sunset: 2025-05-30 x-xgen-version: 2023-01-01 - description: Grants MongoDB Cloud access to the specified AWS S3 Bucket or - Azure Blob Storage Container. + description: Specifies the role and AWS S3 Bucket or Azure Blob Storage Container + that the Export Bucket should reference. required: true responses: "200": @@ -2303,25 +2318,22 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Grant Access to AWS S3 Bucket or Azure Blob Storage Container for Cloud - Backup Snapshot Exports + summary: Create One Snapshot Export Bucket tags: - Cloud Backups - x-sunset: 2025-05-30 + x-sunset: 2026-05-30 /api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}: delete: - description: "Revoke MongoDB Cloud access to the specified AWS S3 Bucket or\ - \ Azure Blob Storage Container. This prevents this Export Bucket from receiving\ - \ Atlas Cloud Backup Snapshots. 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 API Key must have the Project Owner\ - \ role." + 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 API Key must have the Project\ + \ Owner role." operationId: deleteExportBucket parameters: - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/groupId" - - description: Unique string that identifies the AWS S3 Bucket or Azure Blob - Storage Container to which you export your Snapshots. + - description: Unique 24-hexadecimal character string that identifies the Export + Bucket. in: path name: exportBucketId required: true @@ -2349,15 +2361,14 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Revoke Access to AWS S3 Bucket or Azure Blob Storage Container for - Cloud Backup Snapshot Exports + summary: Delete One Snapshot Export Bucket tags: - Cloud Backups get: deprecated: true - description: "Returns one AWS S3 Bucket or Azure Blob Storage Container associated\ - \ with the specified Project. To use this resource, the requesting API Key\ - \ must have the Project Read Only role." + description: "Returns one Export Bucket associated with the specified Project.\ + \ To use this resource, the requesting API Key must have the Project Read\ + \ Only role." operationId: getExportBucket parameters: - $ref: "#/components/parameters/envelope" @@ -2389,11 +2400,10 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Return One AWS S3 Bucket or Azure Blob Storage Container Used for Cloud - Backup Snapshot Exports + summary: Return One Snapshot Export Bucket tags: - Cloud Backups - x-sunset: 2025-05-30 + x-sunset: 2026-05-30 /api/atlas/v2/groups/{groupId}/backupCompliancePolicy: get: deprecated: true @@ -2424,7 +2434,7 @@ paths: summary: Return the Backup Compliance Policy settings tags: - Cloud Backups - x-sunset: 2024-10-01 + x-sunset: 2026-10-01 put: deprecated: true description: "Updates the Backup Compliance Policy settings for the specified\ @@ -2472,7 +2482,7 @@ paths: summary: Update or enable the Backup Compliance Policy settings tags: - Cloud Backups - x-sunset: 2024-10-01 + x-sunset: 2025-10-01 /api/atlas/v2/groups/{groupId}/cloudProviderAccess: get: description: "Returns all cloud provider access roles with access to the specified\ @@ -2517,7 +2527,7 @@ paths: content: application/vnd.atlas.2023-01-01+json: schema: - $ref: "#/components/schemas/CloudProviderAccessRole" + $ref: "#/components/schemas/CloudProviderAccessRoleRequest" description: Creates one role for the specified cloud provider. required: true responses: @@ -2556,6 +2566,8 @@ paths: type: string enum: - AWS + - AZURE + - GCP - description: Unique 24-hexadecimal digit string that identifies the role. in: path name: roleId @@ -2622,7 +2634,8 @@ paths: description: "Grants access to the specified project for the specified access\ \ role. To use this resource, the requesting API Key must have the Project\ \ Owner role. This API endpoint is one step in a procedure to create unified\ - \ access for MongoDB Cloud services." + \ 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/ @@ -2644,7 +2657,7 @@ paths: content: application/vnd.atlas.2023-01-01+json: schema: - $ref: "#/components/schemas/CloudProviderAccessRole" + $ref: "#/components/schemas/CloudProviderAccessRoleRequestUpdate" description: Grants access to the specified project for the specified access role. required: true @@ -2903,7 +2916,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster. in: query @@ -2951,7 +2964,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -2999,7 +3012,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-02-01+json: @@ -3033,7 +3046,7 @@ paths: x-sunset: 2026-03-01 /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports: get: - description: "Returns all Cloud Backup snapshot export jobs associated with\ + description: "Returns all Cloud Backup Snapshot Export Jobs associated with\ \ the specified Atlas cluster. To use this resource, the requesting API Key\ \ must have the Project Atlas Admin role." operationId: listBackupExportJobs @@ -3052,7 +3065,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -3067,11 +3080,11 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Return All Cloud Backup Snapshot Export Jobs + summary: Return All Snapshot Export Jobs tags: - Cloud Backups post: - description: "Exports one backup snapshot for dedicated Atlas cluster using\ + description: "Exports one backup Snapshot for dedicated Atlas cluster using\ \ Cloud Backups to an Export Bucket. To use this resource, the requesting\ \ API Key must have the Project Atlas Admin role." operationId: createBackupExportJob @@ -3086,7 +3099,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -3114,12 +3127,12 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Create One Cloud Backup Snapshot Export Job + summary: Create One Snapshot Export Job tags: - Cloud Backups /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}: get: - description: "Returns one Cloud Backup snapshot export job associated with the\ + description: "Returns one Cloud Backup Snapshot Export Job associated with the\ \ specified Atlas cluster. To use this resource, the requesting API Key must\ \ have the Project Atlas Admin role." operationId: getBackupExportJob @@ -3134,13 +3147,18 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - - description: Unique string that identifies the export job to return. + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + - description: Unique 24-hexadecimal character string that identifies the Export + Job. in: path name: exportId required: true schema: type: string + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" responses: "200": content: @@ -3155,7 +3173,7 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Return One Cloud Backup Snapshot Export Job + summary: Return One Snapshot Export Job tags: - Cloud Backups /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs: @@ -3180,7 +3198,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -3216,7 +3234,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -3265,7 +3283,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the restore job to remove. in: path @@ -3313,7 +3331,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the restore job to return. in: path @@ -3360,7 +3378,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -3380,7 +3398,7 @@ paths: summary: Remove All Cloud Backup Schedules tags: - Cloud Backups - x-sunset: 2025-08-05 + x-sunset: 2026-05-30 get: deprecated: true description: "Returns the cloud backup schedule for the specified cluster within\ @@ -3400,7 +3418,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -3418,7 +3436,7 @@ paths: summary: Return One Cloud Backup Schedule tags: - Cloud Backups - x-sunset: 2025-08-05 + x-sunset: 2026-05-30 patch: deprecated: true description: "Updates the cloud backup schedule for one cluster within the specified\ @@ -3438,7 +3456,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -3468,7 +3486,7 @@ paths: summary: Update Cloud Backup Schedule for One Cluster tags: - Cloud Backups - x-sunset: 2025-08-05 + x-sunset: 2026-05-30 /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots: get: description: "Returns all snapshots of one cluster from the specified project.\ @@ -3490,7 +3508,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -3528,7 +3546,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -3573,7 +3591,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -3618,7 +3636,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -3666,7 +3684,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -3703,7 +3721,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -3749,7 +3767,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -3795,7 +3813,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -3850,7 +3868,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/groupId" - $ref: "#/components/parameters/pretty" @@ -3904,7 +3922,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/groupId" - $ref: "#/components/parameters/pretty" @@ -3953,7 +3971,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/groupId" - $ref: "#/components/parameters/pretty" @@ -3990,7 +4008,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/groupId" - $ref: "#/components/parameters/pretty" @@ -4041,7 +4059,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -4079,7 +4097,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -4132,7 +4150,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -4179,7 +4197,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -4226,7 +4244,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -4280,7 +4298,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Name of the collection that contains one or more Atlas Search indexes. in: path @@ -4338,7 +4356,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: "Unique 24-hexadecimal digit string that identifies the Atlas\ \ Search index. Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/)\ \ endpoint to find the IDs of all Atlas Search indexes." @@ -4393,7 +4411,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - 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/)\ @@ -4447,7 +4465,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - 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/)\ @@ -4512,7 +4530,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -4556,7 +4574,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -4598,7 +4616,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-02-01+json: @@ -4650,7 +4668,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - $ref: "#/components/parameters/groupId" - description: Human-readable label that identifies the database that contains the collection. @@ -4707,7 +4725,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-02-01+json: @@ -4762,7 +4780,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -4877,7 +4895,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -4916,7 +4934,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -4994,7 +5012,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Flag that indicates whether to download logs for queries against your online archive only or both your online archive and cluster. in: query @@ -5061,7 +5079,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "204": content: @@ -5112,7 +5130,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5165,7 +5183,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -5216,7 +5234,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5257,7 +5275,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5298,7 +5316,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -5351,7 +5369,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5397,7 +5415,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -5450,7 +5468,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5503,7 +5521,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5553,7 +5571,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -5601,7 +5619,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the restore job. in: path @@ -5648,7 +5666,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5686,7 +5704,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5724,7 +5742,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -5770,7 +5788,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -5821,7 +5839,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5859,7 +5877,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -5913,7 +5931,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: "Human-readable label that specifies whether to return only completed,\ \ incomplete, or all snapshots. By default, MongoDB Cloud only returns completed\ \ snapshots." @@ -5968,7 +5986,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -6022,7 +6040,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -6075,7 +6093,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -6130,7 +6148,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -6192,18 +6210,22 @@ paths: externalDocs: description: Set up Database Auditing url: https://docs.atlas.mongodb.com/database-auditing/ - - description: Date and time when the period specifies the inclusive ending - point for the range of log messages to retrieve. This parameter expresses - its value in the number of seconds that have elapsed since the UNIX epoch. + - description: "Specifies the date and time for the ending point of the range\ + \ of log messages to retrieve, in the number of seconds that have elapsed\ + \ since the UNIX epoch. This value will default to 24 hours after the start\ + \ date. If the start date is also unspecified, the value will default to\ + \ the time of the request." in: query name: endDate schema: type: integer format: int64 minimum: 1199145600 - - description: Date and time when the period specifies the inclusive starting - point for the range of log messages to retrieve. This parameter expresses - its value in the number of seconds that have elapsed since the UNIX epoch. + - description: "Specifies the date and time for the starting point of the range\ + \ of log messages to retrieve, in the number of seconds that have elapsed\ + \ since the UNIX epoch. This value will default to 24 hours prior to the\ + \ end date. If the end date is also unspecified, the value will default\ + \ to 24 hours prior to the time of the request." in: query name: startDate schema: @@ -7640,7 +7662,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: "Date and time when to stop retrieving database history. If you\ \ specify **end**, you must also specify **start**. This parameter uses\ \ UNIX epoch time in milliseconds." @@ -7859,6 +7881,9 @@ paths: - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/pretty" - $ref: "#/components/parameters/groupId" + - $ref: "#/components/parameters/includeCount" + - $ref: "#/components/parameters/itemsPerPage" + - $ref: "#/components/parameters/pageNum" - description: Human-readable label that identifies the cloud provider for the private endpoints to return. in: path @@ -7956,14 +7981,6 @@ paths: maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" - requestBody: - content: - application/vnd.atlas.2023-01-01+json: - schema: - $ref: "#/components/schemas/EncryptionAtRestPrivateEndpointRequest" - description: Cloud provider of the private endpoints to delete and the list - of cloud provider regions in which to delete the private endpoints. - required: true responses: "204": content: @@ -8018,6 +8035,8 @@ paths: description: OK "403": $ref: "#/components/responses/forbidden" + "404": + $ref: "#/components/responses/notFound" "500": $ref: "#/components/responses/internalServerError" security: @@ -8049,7 +8068,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" style: form - description: |- Category of incident recorded at this moment in time. @@ -8676,7 +8695,7 @@ paths: summary: Return All Project Invitations tags: - Projects - x-sunset: 2024-10-04 + x-sunset: 2024-11-04 patch: deprecated: true description: "Updates the details of one pending invitation to the specified\ @@ -8717,7 +8736,7 @@ paths: summary: Update One Project Invitation tags: - Projects - x-sunset: 2024-10-04 + x-sunset: 2024-11-04 post: deprecated: true description: "Invites one MongoDB Cloud user to join the specified project.\ @@ -8753,7 +8772,7 @@ paths: summary: Invite One MongoDB Cloud User to Join One Project tags: - Projects - x-sunset: 2024-10-04 + x-sunset: 2024-11-04 /api/atlas/v2/groups/{groupId}/invites/{invitationId}: delete: deprecated: true @@ -8791,7 +8810,7 @@ paths: summary: Cancel One Project Invitation tags: - Projects - x-sunset: 2024-10-04 + x-sunset: 2024-11-04 get: deprecated: true description: "Returns the details of one pending invitation to the specified\ @@ -8830,7 +8849,7 @@ paths: summary: Return One Project Invitation tags: - Projects - x-sunset: 2024-10-04 + x-sunset: 2024-11-04 patch: deprecated: true description: "Updates the details of one pending invitation to the specified\ @@ -8880,7 +8899,7 @@ paths: summary: Update One Project Invitation by Invitation ID tags: - Projects - x-sunset: 2024-10-04 + x-sunset: 2024-11-04 /api/atlas/v2/groups/{groupId}/ipAddresses: get: description: "Returns all IP addresses for this project. To use this resource,\ @@ -8956,7 +8975,7 @@ paths: | Limit Name | Description | Default | API Override Limit | | --- | --- | --- | --- | - | atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 | + | atlas.project.deployment.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 | @@ -8968,6 +8987,7 @@ paths: | 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 | in: path name: limitName required: true @@ -8987,6 +9007,7 @@ paths: - 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" @@ -9021,7 +9042,7 @@ paths: | Limit Name | Description | Default | API Override Limit | | --- | --- | --- | --- | - | atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 | + | atlas.project.deployment.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 | @@ -9033,6 +9054,7 @@ paths: | 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 | in: path name: limitName required: true @@ -9052,6 +9074,7 @@ paths: - 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" @@ -9090,7 +9113,7 @@ paths: | Limit Name | Description | Default | API Override Limit | | --- | --- | --- | --- | - | atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 | + | atlas.project.deployment.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 | @@ -9102,6 +9125,7 @@ paths: | 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 | in: path name: limitName required: true @@ -9121,6 +9145,7 @@ paths: - 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" @@ -9898,6 +9923,7 @@ paths: - Network Peering /api/atlas/v2/groups/{groupId}/pipelines: get: + deprecated: true description: "Returns a list of Data Lake Pipelines. To use this resource, the\ \ requesting API Key must have the Project Read Only role." operationId: listPipelines @@ -9925,8 +9951,14 @@ paths: summary: Return All Data Lake Pipelines from One Project tags: - Data Lake Pipelines + x-sunset: 2025-09-09 post: + deprecated: true description: Creates one Data Lake Pipeline. + externalDocs: + description: Data Lake Pipelines are deprecated. Please see Data Lake Deprecation + Guide. + url: https://dochub.mongodb.org/core/data-lake-deprecation operationId: createPipeline parameters: - $ref: "#/components/parameters/envelope" @@ -9959,8 +9991,10 @@ paths: summary: Create One Data Lake Pipeline tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}: delete: + deprecated: true description: Removes one Data Lake Pipeline. operationId: deletePipeline parameters: @@ -9994,7 +10028,9 @@ paths: summary: Remove One Data Lake Pipeline tags: - Data Lake Pipelines + x-sunset: 2025-09-09 get: + deprecated: true description: "Returns the details of one Data Lake Pipeline within the specified\ \ project. To use this resource, the requesting API Key must have the Project\ \ Read Only role." @@ -10031,7 +10067,9 @@ paths: summary: Return One Data Lake Pipeline tags: - Data Lake Pipelines + x-sunset: 2025-09-09 patch: + deprecated: true description: Updates one Data Lake Pipeline. operationId: updatePipeline parameters: @@ -10076,8 +10114,10 @@ paths: summary: Update One Data Lake Pipeline tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules: get: + deprecated: true description: "Returns a list of backup schedule policy items that you can use\ \ as a Data Lake Pipeline source. To use this resource, the requesting API\ \ Key must have the Project Read Only role." @@ -10116,8 +10156,10 @@ paths: summary: Return Available Ingestion Schedules for One Data Lake Pipeline tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots: get: + deprecated: true description: "Returns a list of backup snapshots that you can use to trigger\ \ an on demand pipeline run. To use this resource, the requesting API Key\ \ must have the Project Read Only role." @@ -10167,8 +10209,10 @@ paths: summary: Return Available Backup Snapshots for One Data Lake Pipeline tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause: post: + deprecated: true description: "Pauses ingestion for a Data Lake Pipeline within the specified\ \ project. To use this resource, the requesting API Key must have the Project\ \ Read Only role." @@ -10205,8 +10249,10 @@ paths: summary: Pause One Data Lake Pipeline tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume: post: + deprecated: true description: "Resumes ingestion for a Data Lake Pipeline within the specified\ \ project. To use this resource, the requesting API Key must have the Project\ \ Read Only role." @@ -10243,8 +10289,10 @@ paths: summary: Resume One Data Lake Pipeline tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs: get: + deprecated: true description: "Returns a list of past Data Lake Pipeline runs. To use this resource,\ \ the requesting API Key must have the Project Read Only role." operationId: listPipelineRuns @@ -10291,8 +10339,10 @@ paths: summary: Return All Data Lake Pipeline Runs from One Project tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}: delete: + deprecated: true description: Deletes dataset that Atlas generated during the specified pipeline run. operationId: deletePipelineRunDataset @@ -10339,7 +10389,9 @@ paths: summary: Delete Pipeline Run Dataset tags: - Data Lake Pipelines + x-sunset: 2025-09-09 get: + deprecated: true description: "Returns the details of one Data Lake Pipeline run within the specified\ \ project. To use this resource, the requesting API Key must have the Project\ \ Read Only role." @@ -10387,8 +10439,10 @@ paths: summary: Return One Data Lake Pipeline Run tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger: post: + deprecated: true description: Triggers a Data Lake Pipeline ingestion of a specified snapshot. operationId: triggerSnapshotIngestion parameters: @@ -10430,6 +10484,7 @@ paths: summary: Trigger on demand snapshot ingestion tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService: post: description: "Creates one private endpoint service for the specified cloud service\ @@ -10561,7 +10616,7 @@ paths: schema: type: string maxLength: 64 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -10603,7 +10658,7 @@ paths: schema: type: string maxLength: 64 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -10647,7 +10702,7 @@ paths: schema: type: string maxLength: 64 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be removed. in: path @@ -10693,7 +10748,7 @@ paths: schema: type: string maxLength: 64 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the tenant endpoint. in: path @@ -10738,7 +10793,7 @@ paths: schema: type: string maxLength: 64 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be updated. in: path @@ -11731,6 +11786,8 @@ paths: - 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 maxItems: 10 minItems: 1 uniqueItems: true @@ -11815,6 +11872,8 @@ paths: - CACHE_BYTES_WRITTEN_FROM - CACHE_DIRTY_BYTES - CACHE_USED_BYTES + - CACHE_FILL_RATIO + - DIRTY_FILL_RATIO - COMPUTED_MEMORY - CONNECTIONS - CURSORS_TOTAL_OPEN @@ -11896,6 +11955,7 @@ paths: - 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 @@ -12367,7 +12427,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "201": content: @@ -12512,7 +12572,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -12550,7 +12610,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -12600,7 +12660,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the restore job to return. in: path @@ -12651,7 +12711,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -12688,7 +12748,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -12733,7 +12793,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/pretty" responses: @@ -12766,7 +12826,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Value that we want to set for the Serverless Auto Indexing toggle. in: query name: enable @@ -12810,15 +12870,15 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: - "204": + "202": content: application/vnd.atlas.2023-01-01+json: schema: - $ref: "#/components/schemas/NoBody" + $ref: "#/components/schemas/RequestAccepted" x-xgen-version: 2023-01-01 - description: This endpoint does not return a response body. + description: Accepted "400": $ref: "#/components/responses/badRequest" "404": @@ -12849,7 +12909,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -12887,7 +12947,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -13050,6 +13110,292 @@ paths: x-xgen-changelog: "2023-09-11": "The MongoDB Atlas Streams Processing API is now exposed as\ \ part of private preview, but is subject to change until GA." + /api/atlas/v2/groups/{groupId}/streams/privateLinkConnections: + get: + description: "Returns all Private Link connections for the specified project.To\ + \ use this resource, the requesting API Key must have the Project Data Access\ + \ roles, Project Owner role or Project Stream Processing Owner role." + operationId: listPrivateLinkConnections + parameters: + - $ref: "#/components/parameters/groupId" + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/itemsPerPage" + - $ref: "#/components/parameters/pageNum" + - $ref: "#/components/parameters/pretty" + responses: + "200": + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/PaginatedApiStreamsPrivateLinkView" + x-xgen-version: 2023-02-01 + description: OK + "401": + $ref: "#/components/responses/unauthorized" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Return All Private Link + tags: + - Streams + x-xgen-changelog: + "2024-10-02": "The MongoDB Atlas Streams Processing Private Link API is now\ + \ exposed as part of private preview, but is subject to change until GA." + post: + description: "Creates one Private Link in the specified project. To use this\ + \ resource, the requesting API Key must have the Project Owner or Project\ + \ Stream Processing Owner role." + operationId: createPrivateLinkConnection + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/pretty" + - $ref: "#/components/parameters/groupId" + requestBody: + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/StreamsPrivateLinkConnection" + description: Details to create one Private Link connection for a project. + project. + required: true + responses: + "200": + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/StreamsPrivateLinkConnection" + x-xgen-version: 2023-02-01 + description: OK + "400": + $ref: "#/components/responses/badRequest" + "401": + $ref: "#/components/responses/unauthorized" + "409": + $ref: "#/components/responses/unauthorized" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Create One Private Link connection + tags: + - Streams + x-xgen-changelog: + "2024-10-02": "The MongoDB Atlas Streams Processing Private Link API is now\ + \ exposed as part of private preview, but is subject to change until GA." + /api/atlas/v2/groups/{groupId}/streams/privateLinkConnections/{connectionId}: + delete: + description: "Deletes one Private Link in the specified project. To use this\ + \ resource, the requesting API Key must have the Project Owner or Project\ + \ Stream Processing Owner role." + operationId: deletePrivateLinkConnection + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/pretty" + - $ref: "#/components/parameters/groupId" + - description: Unique ID that identifies the Private Link connection. + in: path + name: connectionId + required: true + schema: + type: string + responses: + "202": + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/NoBody" + x-xgen-version: 2023-02-01 + description: Accepted + "401": + $ref: "#/components/responses/unauthorized" + "403": + $ref: "#/components/responses/forbidden" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Delete One Private Link connection + tags: + - Streams + x-xgen-changelog: + "2024-10-02": "The MongoDB Atlas Streams Processing Private Link API is now\ + \ exposed as part of private preview, but is subject to change until GA." + get: + description: "Returns the details of one Private Link connection within the\ + \ project. To use this resource, the requesting API Key must have the Project\ + \ Read Only role." + operationId: getPrivateLinkConnection + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/groupId" + - description: Unique ID that identifies the Private Link connection. + in: path + name: connectionId + required: true + schema: + type: string + responses: + "200": + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/StreamsPrivateLinkConnection" + x-xgen-version: 2023-02-01 + description: OK + "401": + $ref: "#/components/responses/unauthorized" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Return One PrivateLink Connection + tags: + - Streams + x-xgen-changelog: + "2024-10-02": "The MongoDB Atlas Streams Processing Private Link API is now\ + \ exposed as part of private preview, but is subject to change until GA." + /api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections: + get: + description: Returns a list of incoming VPC Peering Connections. + operationId: getVPCPeeringConnections + parameters: + - $ref: "#/components/parameters/groupId" + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/itemsPerPage" + - $ref: "#/components/parameters/pageNum" + - $ref: "#/components/parameters/pretty" + responses: + "200": + content: + application/vnd.atlas.2023-02-01+json: + x-xgen-version: 2023-02-01 + description: OK + "401": + $ref: "#/components/responses/unauthorized" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Return All VPC Peering Connections. + tags: + - Streams + /api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}: + delete: + description: Deletes an incoming VPC Peering connection. + operationId: deleteVPCPeeringConnection + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/groupId" + - description: The VPC Peering Connection id. + in: path + name: id + required: true + schema: + type: string + responses: + "202": + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/NoBody" + x-xgen-version: 2023-02-01 + description: Accepted + "401": + $ref: "#/components/responses/unauthorized" + "403": + $ref: "#/components/responses/forbidden" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Deletes an incoming VPC Peering connection. + tags: + - Streams + /api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:accept: + post: + description: Requests the acceptance of an incoming VPC Peering connection. + operationId: acceptVPCPeeringConnection + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/groupId" + - description: The VPC Peering Connection id. + in: path + name: id + required: true + schema: + type: string + requestBody: + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/VPCPeeringActionChallenge" + description: "Challenge values for VPC Peering requester account ID, and requester\ + \ VPC ID." + required: true + responses: + "202": + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/NoBody" + x-xgen-version: 2023-02-01 + description: Accepted + "401": + $ref: "#/components/responses/unauthorized" + "403": + $ref: "#/components/responses/forbidden" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Requests the acceptance of an incoming VPC Peering connection. + tags: + - Streams + /api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:reject: + post: + description: Requests the rejection of an incoming VPC Peering connection. + operationId: rejectVPCPeeringConnection + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/groupId" + - description: The VPC Peering Connection id. + in: path + name: id + required: true + schema: + type: string + responses: + "202": + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/NoBody" + x-xgen-version: 2023-02-01 + description: Accepted + "401": + $ref: "#/components/responses/unauthorized" + "403": + $ref: "#/components/responses/forbidden" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Requests the rejection of an incoming VPC Peering connection. + tags: + - Streams /api/atlas/v2/groups/{groupId}/streams/{tenantName}: delete: description: "Delete one stream instance in the specified project. To use this\ @@ -15487,6 +15833,8 @@ paths: $ref: "#/components/schemas/OrganizationSettings" x-xgen-version: 2023-01-01 description: OK + "400": + $ref: "#/components/responses/badRequest" "401": $ref: "#/components/responses/unauthorized" "403": @@ -15961,6 +16309,7 @@ paths: - Organizations /api/atlas/v2/orgs/{orgId}/users/{userId}: delete: + deprecated: true description: "Removes one MongoDB Cloud user from the specified organization.\ \ To use this resource, the requesting API Key must have the Organization\ \ User Admin role." @@ -15968,6 +16317,7 @@ paths: parameters: - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/orgId" + - $ref: "#/components/parameters/pretty" - description: Unique 24-hexadecimal digit string that identifies the user to be deleted. in: path @@ -15998,9 +16348,10 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Remove One MongoDB Cloud User from One Organization + summary: Remove One MongoDB Cloud User From One Organization tags: - Organizations + x-sunset: 2026-01-01 /api/atlas/v2/orgs/{orgId}/users/{userId}/roles: put: description: "Updates the roles of the specified user in the specified organization.\ @@ -16805,7 +17156,7 @@ components: description: |- Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. - Change this parameter only if you: + 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). @@ -16881,7 +17232,7 @@ components: You can set different IOPS values on different shards when provisioned IOPS are supported. - Change this parameter only if you: + 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). @@ -17312,6 +17663,31 @@ components: - REPLICASET - SHARDED - GEOSHARDED + configServerManagementMode: + type: string + default: ATLAS_MANAGED + description: |- + Config Server Management Mode for creating or updating a sharded cluster. + + When configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings. + + When configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server. + enum: + - ATLAS_MANAGED + - FIXED_TO_DEDICATED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + configServerType: + type: string + description: Describes a sharded cluster's config server type. + enum: + - DEDICATED + - EMBEDDED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + readOnly: true connectionStrings: $ref: "#/components/schemas/ClusterConnectionStrings" createDate: @@ -17359,6 +17735,15 @@ components: externalDocs: description: Encryption at Rest using Customer Key Management url: https://www.mongodb.com/docs/atlas/security-kms-encryption/ + featureCompatibilityVersion: + type: string + description: Feature compatibility version of the cluster. + readOnly: true + featureCompatibilityVersionExpirationDate: + type: string + format: date-time + description: Feature compatibility version expiration date. + readOnly: true globalClusterSelfManagedSharding: type: boolean description: |- @@ -17409,6 +17794,8 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true + mongoDBEmployeeAccessGrant: + $ref: "#/components/schemas/EmployeeAccessGrantView" mongoDBMajorVersion: type: string description: |- @@ -17430,7 +17817,7 @@ components: description: Human-readable label that identifies the advanced cluster. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" paused: type: boolean description: Flag that indicates whether the cluster is paused. @@ -17441,6 +17828,24 @@ components: externalDocs: description: Continuous Cloud Backups url: https://docs.atlas.mongodb.com/backup/cloud-backup/overview/ + replicaSetScalingStrategy: + type: string + default: WORKLOAD_TYPE + description: |- + Set this field to configure the replica set scaling mode for your cluster. + + By default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes. + + When configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads. + + When configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads. + enum: + - SEQUENTIAL + - WORKLOAD_TYPE + - NODE_TYPE + externalDocs: + description: Modify the Replica Set Scaling Mode + url: https://dochub.mongodb.org/core/scale-nodes replicationSpecs: type: array description: "List of settings that configure your cluster regions. For\ @@ -18319,6 +18724,246 @@ components: description: Atlas Search Index url: https://dochub.mongodb.org/core/index-definitions-fts title: mappings + ApiAtlasInvalidPolicyErrorDetailView: + type: object + properties: + detail: + type: string + description: A string that provides a detailed description of a validation + error. + readOnly: true + ApiAtlasInvalidPolicyView: + type: object + properties: + body: + type: string + description: A string that defines the permissions for the policy. The syntax + used is the Cedar Policy language. + example: |2 + forbid ( + principal, + action == cloud::Action::"cluster.createEdit", + resource + ) when { + context.cluster.regions.contains(cloud::region::"aws:us-east-1") + }; + readOnly: true + errors: + type: array + description: List of validation errors. + items: + $ref: "#/components/schemas/ApiAtlasInvalidPolicyErrorDetailView" + readOnly: true + ApiAtlasInvalidResourcePolicyCreateErrorView: + type: object + properties: + errorType: + type: string + description: Human-readable label that displays the type of an error. + enum: + - POLICY_PARSING_ERROR + - POLICY_HAS_FAILED_VALIDATIONS + - POLICY_HAS_INVALID_PRINCIPAL + - POLICY_HAS_BODY_EXCEEDING_MAX_SIZE + - POLICY_HAS_UNEXPECTED_ENTITIES + invalidPolicies: + type: array + description: List of invalid policies containing details of their validation + errors. + items: + $ref: "#/components/schemas/ApiAtlasInvalidPolicyView" + readOnly: true + ApiAtlasNonCompliantResourceView: + type: object + properties: + orgId: + type: string + description: Unique 24-hexadecimal character string that identifies the + organization the resource belongs to. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + resourceId: + type: string + description: Unique 24-hexadecimal character string that identifies the + non-compliant resource. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + resourcePoliciesCausingNonCompliance: + type: array + description: List of resource policies causing the resource to be considered + non-compliant. + items: + $ref: "#/components/schemas/ApiAtlasResourcePolicyMetadataView" + readOnly: true + resourceType: + type: string + description: Human-readable label that displays the type of a resource. + enum: + - PROJECT + - CLUSTER + readOnly: true + ApiAtlasPolicyCreateView: + type: object + properties: + body: + type: string + description: A string that defines the permissions for the policy. The syntax + used is the Cedar Policy language. + example: |2 + forbid ( + principal, + action == cloud::Action::"cluster.createEdit", + resource + ) when { + context.cluster.regions.contains(cloud::region::"aws:us-east-1") + }; + required: + - body + ApiAtlasPolicyMetadataView: + type: object + properties: + policyId: + type: string + description: Unique 24-hexadecimal character string that identifies the + policy. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + ApiAtlasPolicyView: + type: object + properties: + body: + type: string + description: A string that defines the permissions for the policy. The syntax + used is the Cedar Policy language. + example: |2 + forbid ( + principal, + action == cloud::Action::"cluster.createEdit", + resource + ) when { + context.cluster.regions.contains(cloud::region::"aws:us-east-1") + }; + readOnly: true + id: + type: string + description: Unique 24-hexadecimal character string that identifies the + policy. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + ApiAtlasResourcePolicyCreateView: + type: object + properties: + name: + type: string + description: Human-readable label that describes the atlas resource policy. + policies: + type: array + description: List of policies that make up the atlas resource policy. + items: + $ref: "#/components/schemas/ApiAtlasPolicyCreateView" + required: + - name + - policies + ApiAtlasResourcePolicyEditView: + type: object + properties: + name: + type: string + description: Human-readable label that describes the atlas resource policy. + policies: + type: array + description: List of policies that make up the atlas resource policy. + items: + $ref: "#/components/schemas/ApiAtlasPolicyCreateView" + ApiAtlasResourcePolicyMetadataView: + type: object + properties: + policiesCausingNonCompliance: + type: array + description: List of policies that are in conflict with the current state + of the resource. + items: + $ref: "#/components/schemas/ApiAtlasPolicyMetadataView" + readOnly: true + resourcePolicyId: + type: string + description: Unique 24-hexadecimal character string that identifies the + atlas resource policy. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + resourcePolicyName: + type: string + description: Human-readable label that describes the atlas resource policy. + readOnly: true + ApiAtlasResourcePolicyView: + type: object + properties: + createdByUser: + $ref: "#/components/schemas/ApiAtlasUserMetadataView" + createdDate: + type: string + format: date-time + description: Date and time in UTC when the atlas resource policy was created. + example: 2022-01-01T00:00:00Z + readOnly: true + id: + type: string + description: Unique 24-hexadecimal character string that identifies the + atlas resource policy. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + lastUpdatedByUser: + $ref: "#/components/schemas/ApiAtlasUserMetadataView" + lastUpdatedDate: + type: string + format: date-time + description: Date and time in UTC when the atlas resource policy was last + updated. + example: 2022-01-01T00:00:00Z + readOnly: true + name: + type: string + description: Human-readable label that describes the atlas resource policy. + readOnly: true + orgId: + type: string + description: Unique 24-hexadecimal character string that identifies the + organization the atlas resource policy belongs to. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + policies: + type: array + description: List of policies that make up the atlas resource policy. + items: + $ref: "#/components/schemas/ApiAtlasPolicyView" + readOnly: true + version: + type: string + description: A string that identifies the version of the atlas resource + policy. + example: v1 + readOnly: true ApiAtlasSnapshotScheduleView: type: object properties: @@ -18455,6 +19100,23 @@ components: - snapshotIntervalHours - snapshotRetentionDays - weeklySnapshotRetentionWeeks + ApiAtlasUserMetadataView: + type: object + description: The user that last updated the atlas resource policy. + properties: + id: + type: string + description: Unique 24-hexadecimal character string that identifies a user. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + name: + type: string + description: Human-readable label that describes a user. + readOnly: true + readOnly: true ApiBSONTimestampView: type: object description: BSON timestamp that indicates when the checkpoint token entry in @@ -18511,6 +19173,8 @@ components: ApiError: type: object properties: + badRequestDetail: + $ref: "#/components/schemas/BadRequestDetail" detail: type: string description: Describes the specific conditions or reasons that cause each @@ -18521,17 +19185,25 @@ components: description: HTTP status code returned with this error. externalDocs: url: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status + readOnly: true 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. items: type: object + readOnly: true + readOnly: true reason: type: string description: Application error message returned with this error. + readOnly: true + required: + - error + - errorCode ApiHostView_Atlas: type: object properties: @@ -18820,6 +19492,23 @@ components: \ and **period** in the same request. This parameter expresses its value\ \ in the ISO 8601 timestamp format in UTC." readOnly: true + ApiPrivateDownloadDeliveryUrl: + type: object + description: One Uniform Resource Locator (URL) that points to the compressed + snapshot files for manual download and the corresponding private endpoint. + properties: + deliveryUrl: + type: string + description: One Uniform Resource Locator that points to the compressed + snapshot files for manual download. + endpointId: + type: string + description: Unique 22-character alphanumeric string that identifies the + private endpoint. + example: vpce-3bf78b0ddee411ba1 + maxLength: 22 + minLength: 22 + pattern: "^vpce-[0-9a-f]{17}$" ApiPublicUsageDetailsQueryRequest: type: object description: "Request body for an Invoice Usage Details query with filtering,\ @@ -18931,7 +19620,23 @@ components: type: string description: Atlas Streams AWS Regions. enum: + - SYDNEY_AUS + - MUMBAI_IND + - FRANKFURT_DEU + - DUBLIN_IRL + - LONDON_GBR - VIRGINIA_USA + - OREGON_USA + - SAOPAULO_BRA + - MONTREAL_CAN + - TOKYO_JPN + - SINGAPORE_SGP + ApiStreamsAzureRegionView: + type: string + description: Atlas Streams Azure Regions. + enum: + - VIRGINIA_USA + - AMSTERDAM_NLD ApiUserEventTypeViewForNdsGroup: type: string description: Unique identifier of event type. @@ -19178,6 +19883,12 @@ components: - eventTypeName - id title: API User Events + ApiVersion: + type: object + properties: + version: + type: string + description: Object representing a version of the Atlas Admin API. AppServiceAlertConfigViewForNdsGroup: type: object description: App Services metric alert configuration allows to select which @@ -19659,7 +20370,12 @@ components: enum: - AVERAGE operator: - $ref: "#/components/schemas/Operator" + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - LESS_THAN + - GREATER_THAN threshold: type: number format: double @@ -19737,6 +20453,12 @@ components: enum: - VIRGINIA_USA - AMSTERDAM_NLD + AtlasDataFederationGCPRegion: + type: string + description: Atlas Data Federation GCP Regions. + enum: + - IOWA_USA + - BELGIUM_EU AtlasOrganization: type: object description: Details that describe the organization. @@ -19772,6 +20494,128 @@ components: pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" required: - name + AtlasResourcePolicyAuditForOrg: + type: object + description: Atlas resource policy audits indicate org level changes to resource + policies + properties: + apiKeyId: + type: string + description: "Unique 24-hexadecimal digit string that identifies the [API\ + \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\ + \ triggered the event. If this resource returns this parameter, it doesn't\ + \ return the **userId** parameter." + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + created: + type: string + format: date-time + description: Date and time when this event occurred. This parameter expresses + its value in the ISO 8601 timestamp format in UTC. + readOnly: true + eventTypeName: + type: string + description: Unique identifier of event type. + enum: + - RESOURCE_POLICY_CREATED + - RESOURCE_POLICY_MODIFIED + - RESOURCE_POLICY_DELETED + example: RESOURCE_POLICY_CREATED + title: Atlas Resource Policy Audit Types + groupId: + type: string + description: Unique 24-hexadecimal digit string that identifies the project + in which the event occurred. The **eventId** identifies the specific event. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + id: + type: string + description: Unique 24-hexadecimal digit string that identifies the event. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + isGlobalAdmin: + type: boolean + default: false + description: Flag that indicates whether a MongoDB employee triggered the + specified event. + readOnly: true + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + orgId: + type: string + description: Unique 24-hexadecimal digit string that identifies the organization + to which these events apply. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + publicKey: + type: string + format: email + description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\ + \ that triggered the event. If this resource returns this parameter, it\ + \ doesn't return the **username** parameter." + readOnly: true + raw: + $ref: "#/components/schemas/raw" + remoteAddress: + type: string + description: IPv4 or IPv6 address from which the user triggered this event. + example: 216.172.40.186 + pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + readOnly: true + resourcePolicyId: + type: string + description: Unique 24-hexadecimal character string that identifies the + resource policy. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + userId: + type: string + description: "Unique 24-hexadecimal digit string that identifies the console\ + \ user who triggered the event. If this resource returns this parameter,\ + \ it doesn't return the **apiKeyId** parameter." + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + username: + type: string + format: email + description: "Email address for the user who triggered this event. If this\ + \ resource returns this parameter, it doesn't return the **publicApiKey**\ + \ parameter." + example: test.user@mongodb.com + readOnly: true + required: + - created + - eventTypeName + - id + title: Atlas Resource Policy Audits AtlasSearchAnalyzer: type: object properties: @@ -20493,6 +21337,21 @@ components: AzureHardwareSpec: type: object properties: + diskIOPS: + type: integer + format: int32 + description: |- + Target throughput desired for storage attached to your Azure-provisioned cluster. Change this parameter if you: + + - set `"replicationSpecs[n].regionConfigs[m].providerName" : "Azure"`. + - set `"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize" : "M40"` or greater not including `Mxx_NVME` tiers. + + The maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**. + This parameter defaults to the cluster tier's standard IOPS value. + Changing this value impacts cluster cost. + externalDocs: + description: Programmatic API Keys + url: https://www.mongodb.com/docs/atlas/customize-storage/#extend-iops-on-azure instanceSize: type: string description: Hardware specification for the instance sizes in this region. @@ -20530,6 +21389,21 @@ components: AzureHardwareSpec20240805: type: object properties: + diskIOPS: + type: integer + format: int32 + description: |- + Target throughput desired for storage attached to your Azure-provisioned cluster. Change this parameter if you: + + - set `"replicationSpecs[n].regionConfigs[m].providerName" : "Azure"`. + - set `"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize" : "M40"` or greater not including `Mxx_NVME` tiers. + + The maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**. + This parameter defaults to the cluster tier's standard IOPS value. + Changing this value impacts cluster cost. + externalDocs: + description: Programmatic API Keys + url: https://www.mongodb.com/docs/atlas/customize-storage/#extend-iops-on-azure diskSizeGB: type: number format: double @@ -20745,6 +21619,8 @@ components: - PENDING_ACCEPTANCE - ACTIVE - FAILED + - PENDING_RECREATION + - DELETING readOnly: true title: Azure Key Vault EAR Private Endpoint AzureNetworkPeeringConnectionSettings: @@ -21179,7 +22055,7 @@ components: the collection for which you want to create an online archive. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true collName: type: string @@ -21291,7 +22167,7 @@ components: the collection for which you want to create an online archive. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true collName: type: string @@ -21430,7 +22306,7 @@ components: the snapshots you want to retrieve. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -21643,7 +22519,7 @@ components: To return a response with the **clusterId** parameter, either use the **delivery.targetClusterName** parameter or enable backup on the target cluster. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" targetGroupId: type: string description: "Unique 24-hexadecimal digit string that identifies the project\ @@ -21915,12 +22791,23 @@ components: - FAILED - COMPLETED readOnly: true + BadRequestDetail: + type: object + description: Bad request detail. + properties: + fields: + type: array + description: Describes all violations in a client request. + items: + $ref: "#/components/schemas/FieldViolation" + readOnly: true BaseAtlasDataLakeRegion: type: object description: Name of the region to which the data lake routes client connections. oneOf: - $ref: "#/components/schemas/ApiAtlasDataLakeAWSRegionView" - $ref: "#/components/schemas/AtlasDataFederationAzureRegion" + - $ref: "#/components/schemas/AtlasDataFederationGCPRegion" BaseCloudProviderInstanceSize: type: object description: "Minimum instance size to which your cluster can automatically\ @@ -22048,6 +22935,7 @@ components: description: Name of the cloud provider region hosting Atlas Stream Processing. oneOf: - $ref: "#/components/schemas/ApiStreamsAWSRegionView" + - $ref: "#/components/schemas/ApiStreamsAzureRegionView" BasicBSONList: type: array description: "List that contains the search criteria that the query uses. To\ @@ -23135,7 +24023,7 @@ components: description: Human-readable label that identifies the cluster. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true nodeCount: type: integer @@ -23196,6 +24084,10 @@ components: 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. + description: + type: string + description: Description of this database user. + maxLength: 100 groupId: type: string description: Unique 24-hexadecimal digit string that identifies the project. @@ -23463,6 +24355,127 @@ components: (AWS) Identity and Access Management (IAM) role. required: - providerName + CloudProviderAccessAWSIAMRoleRequest: + type: object + description: Details that describe the features linked to the Amazon Web Services + (AWS) Identity and Access Management (IAM) role. + properties: + atlasAWSAccountArn: + 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. + example: arn:aws:iam::772401394250:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + readOnly: true + atlasAssumedRoleExternalId: + type: string + format: uuid + description: Unique external ID that MongoDB Cloud uses when it assumes + the IAM role in your Amazon Web Services (AWS) account. + readOnly: true + authorizedDate: + type: string + format: date-time + 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. + readOnly: true + createdDate: + type: string + format: date-time + 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. + readOnly: true + featureUsages: + type: array + description: List that contains application features associated with this + Amazon Web Services (AWS) Identity and Access Management (IAM) role. + items: + $ref: "#/components/schemas/CloudProviderAccessFeatureUsage" + readOnly: true + providerName: + type: string + description: Human-readable label that identifies the cloud provider of + the role. + enum: + - AWS + - AZURE + - GCP + roleId: + type: string + description: Unique 24-hexadecimal digit string that identifies the role. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + required: + - providerName + CloudProviderAccessAWSIAMRoleRequestUpdate: + type: object + allOf: + - $ref: "#/components/schemas/CloudProviderAccessRoleRequestUpdate" + - type: object + properties: + atlasAWSAccountArn: + 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. + example: arn:aws:iam::772401394250:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + readOnly: true + atlasAssumedRoleExternalId: + type: string + format: uuid + description: Unique external ID that MongoDB Cloud uses when it assumes + the IAM role in your Amazon Web Services (AWS) account. + readOnly: true + authorizedDate: + type: string + format: date-time + 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. + readOnly: true + createdDate: + type: string + format: date-time + 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. + readOnly: true + featureUsages: + type: array + description: List that contains application features associated with this + Amazon Web Services (AWS) Identity and Access Management (IAM) role. + items: + $ref: "#/components/schemas/CloudProviderAccessFeatureUsage" + readOnly: true + iamAssumedRoleArn: + 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 + maxLength: 2048 + minLength: 20 + roleId: + type: string + description: Unique 24-hexadecimal digit string that identifies the role. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + description: Details that describe the features linked to the Amazon Web Services + (AWS) Identity and Access Management (IAM) role. + required: + - providerName CloudProviderAccessAzureServicePrincipal: type: object allOf: @@ -23524,6 +24537,133 @@ components: Principal. required: - providerName + CloudProviderAccessAzureServicePrincipalRequest: + type: object + description: Details that describe the features linked to the Azure Service + Principal. + properties: + _id: + type: string + description: Unique 24-hexadecimal digit string that identifies the role. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + atlasAzureAppId: + type: string + description: Azure Active Directory Application ID of Atlas. + maxLength: 36 + minLength: 32 + pattern: "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\\ + b-[0-9a-fA-F]{12}$" + createdDate: + type: string + format: date-time + description: Date and time when this Azure Service Principal was created. + This parameter expresses its value in the ISO 8601 timestamp format in + UTC. + readOnly: true + featureUsages: + type: array + description: List that contains application features associated with this + Azure Service Principal. + items: + $ref: "#/components/schemas/CloudProviderAccessFeatureUsage" + readOnly: true + lastUpdatedDate: + type: string + format: date-time + 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. + 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. + maxLength: 36 + minLength: 32 + pattern: "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\\ + b-[0-9a-fA-F]{12}$" + tenantId: + type: string + description: UUID String that identifies the Azure Active Directory Tenant + ID. + maxLength: 36 + minLength: 32 + pattern: "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\\ + b-[0-9a-fA-F]{12}$" + required: + - providerName + CloudProviderAccessAzureServicePrincipalRequestUpdate: + type: object + allOf: + - $ref: "#/components/schemas/CloudProviderAccessRoleRequestUpdate" + - type: object + properties: + _id: + type: string + description: Unique 24-hexadecimal digit string that identifies the role. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + atlasAzureAppId: + type: string + description: Azure Active Directory Application ID of Atlas. + maxLength: 36 + minLength: 32 + pattern: "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\\ + b-[0-9a-fA-F]{12}$" + createdDate: + type: string + format: date-time + description: Date and time when this Azure Service Principal was created. + This parameter expresses its value in the ISO 8601 timestamp format + in UTC. + readOnly: true + featureUsages: + type: array + description: List that contains application features associated with this + Azure Service Principal. + items: + $ref: "#/components/schemas/CloudProviderAccessFeatureUsage" + readOnly: true + lastUpdatedDate: + type: string + format: date-time + 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. + readOnly: true + servicePrincipalId: + type: string + description: UUID string that identifies the Azure Service Principal. + maxLength: 36 + minLength: 32 + pattern: "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\\ + b-[0-9a-fA-F]{12}$" + tenantId: + type: string + description: UUID String that identifies the Azure Active Directory Tenant + ID. + maxLength: 36 + minLength: 32 + pattern: "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\\ + b-[0-9a-fA-F]{12}$" + description: Details that describe the features linked to the Azure Service + Principal. + required: + - providerName CloudProviderAccessDataLakeFeatureUsage: type: object allOf: @@ -23636,6 +24776,85 @@ components: minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true + CloudProviderAccessGCPServiceAccount: + type: object + allOf: + - $ref: "#/components/schemas/CloudProviderAccessRole" + - type: object + properties: + createdDate: + type: string + format: date-time + description: Date and time when this Google Service Account was created. + This parameter expresses its value in the ISO 8601 timestamp format + in UTC. + readOnly: true + featureUsages: + type: array + description: List that contains application features associated with this + Google Service Account. + items: + $ref: "#/components/schemas/CloudProviderAccessFeatureUsage" + readOnly: true + gcpServiceAccountForAtlas: + type: string + description: Email address for the Google Service Account created by Atlas. + maxLength: 82 + minLength: 57 + pattern: "^mongodb-atlas-[0-9a-z]{16}@p-[0-9a-z]{24}.iam.gserviceaccount.com$" + roleId: + type: string + description: Unique 24-hexadecimal digit string that identifies the role. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + description: Details that describe the features linked to the GCP Service Account. + required: + - providerName + CloudProviderAccessGCPServiceAccountRequest: + type: object + description: Details that describe the features linked to the GCP Service Account. + properties: + createdDate: + type: string + format: date-time + description: Date and time when this GCP Service Account was created. This + parameter expresses its value in the ISO 8601 timestamp format in UTC. + readOnly: true + featureUsages: + type: array + description: List that contains application features associated with this + GCP Service Account. + items: + $ref: "#/components/schemas/CloudProviderAccessFeatureUsage" + readOnly: true + 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: + type: string + description: Unique 24-hexadecimal digit string that identifies the role. + readOnly: true + required: + - providerName + CloudProviderAccessGCPServiceAccountRequestUpdate: + type: object + allOf: + - $ref: "#/components/schemas/CloudProviderAccessRoleRequestUpdate" + description: Details that describe the features linked to the GCP Service Account. + required: + - providerName CloudProviderAccessPushBasedLogExportFeatureUsage: type: object allOf: @@ -23654,10 +24873,52 @@ components: mapping: AWS: "#/components/schemas/CloudProviderAccessAWSIAMRole" AZURE: "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + GCP: "#/components/schemas/CloudProviderAccessGCPServiceAccount" + propertyName: providerName + properties: + providerName: + type: string + description: Human-readable label that identifies the cloud provider of + the role. + enum: + - AWS + - AZURE + - GCP + required: + - providerName + CloudProviderAccessRoleRequest: + type: object + description: Cloud provider access role. + discriminator: + mapping: + AWS: "#/components/schemas/CloudProviderAccessAWSIAMRoleRequest" + AZURE: "#/components/schemas/CloudProviderAccessAzureServicePrincipalRequest" + GCP: "#/components/schemas/CloudProviderAccessGCPServiceAccountRequest" propertyName: providerName oneOf: - - $ref: "#/components/schemas/CloudProviderAccessAWSIAMRole" - - $ref: "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + - $ref: "#/components/schemas/CloudProviderAccessAWSIAMRoleRequest" + - $ref: "#/components/schemas/CloudProviderAccessAzureServicePrincipalRequest" + - $ref: "#/components/schemas/CloudProviderAccessGCPServiceAccountRequest" + properties: + providerName: + type: string + description: Human-readable label that identifies the cloud provider of + the role. + enum: + - AWS + - AZURE + - GCP + required: + - providerName + CloudProviderAccessRoleRequestUpdate: + type: object + description: Cloud provider access role. + discriminator: + mapping: + AWS: "#/components/schemas/CloudProviderAccessAWSIAMRoleRequestUpdate" + AZURE: "#/components/schemas/CloudProviderAccessAzureServicePrincipalRequestUpdate" + GCP: "#/components/schemas/CloudProviderAccessGCPServiceAccountRequestUpdate" + propertyName: providerName properties: providerName: type: string @@ -23666,6 +24927,7 @@ components: enum: - AWS - AZURE + - GCP required: - providerName CloudProviderAccessRoles: @@ -23677,6 +24939,12 @@ components: registered and authorized with MongoDB Cloud. items: $ref: "#/components/schemas/CloudProviderAccessAWSIAMRole" + azureServicePrincipals: + type: array + description: List that contains the Azure Service Principals registered + with MongoDB Cloud. + items: + $ref: "#/components/schemas/CloudProviderAccessAzureServicePrincipal" CloudProviderAzureAutoScaling: type: object description: Range of instance sizes to which your cluster can scale. @@ -24345,7 +25613,7 @@ components: example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -24449,6 +25717,7 @@ components: $ref: "#/components/schemas/ClusterComputeAutoScaling" diskGBEnabled: type: boolean + default: false description: Flag that indicates whether someone enabled disk auto-scaling for this cluster. title: Automatic Cluster Scaling Settings @@ -24475,12 +25744,14 @@ components: properties: enabled: type: boolean + default: false description: "Flag that indicates whether cluster tier auto-scaling is enabled.\ \ Set to `true` to enable cluster tier auto-scaling. If enabled, you must\ \ specify a value for **providerSettings.autoScaling.compute.maxInstanceSize**\ \ also. Set to `false` to disable cluster tier auto-scaling." scaleDownEnabled: type: boolean + default: false description: "Flag that indicates whether the cluster tier can scale down.\ \ This is required if **autoScaling.compute.enabled** is `true`. If you\ \ enable this option, specify a value for **providerSettings.autoScaling.compute.minInstanceSize**." @@ -24518,20 +25789,28 @@ components: 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. + description: "Private endpoint-aware connection strings that use AWS-hosted\ + \ clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies\ + \ an Amazon Web Services (AWS) interface endpoint. Each value identifies\ + \ the related `mongodb://` connection string that you use to connect\ + \ to Atlas through the interface endpoint that the key names. If the\ + \ cluster uses an optimized connection string, `awsPrivateLinkSrv` contains\ + \ the optimized connection string. If the cluster has the non-optimized\ + \ (legacy) connection string, `awsPrivateLinkSrv` contains the non-optimized\ + \ connection string even if an optimized connection string is also present." externalDocs: description: Network Peering Connection url: https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/ readOnly: true - 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. + description: "Private endpoint-aware connection strings that use AWS-hosted\ + \ clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies\ + \ an Amazon Web Services (AWS) interface endpoint. Each value identifies\ + \ the related `mongodb://` connection string that you use to connect to\ + \ Atlas through the interface endpoint that the key names. If the cluster\ + \ uses an optimized connection string, `awsPrivateLinkSrv` contains the\ + \ optimized connection string. If the cluster has the non-optimized (legacy)\ + \ connection string, `awsPrivateLinkSrv` contains the non-optimized connection\ + \ string even if an optimized connection string is also present." externalDocs: description: Network Peering Connection url: https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/ @@ -24633,6 +25912,31 @@ components: - REPLICASET - SHARDED - GEOSHARDED + configServerManagementMode: + type: string + default: ATLAS_MANAGED + description: |- + Config Server Management Mode for creating or updating a sharded cluster. + + When configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings. + + When configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server. + enum: + - ATLAS_MANAGED + - FIXED_TO_DEDICATED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + configServerType: + type: string + description: Describes a sharded cluster's config server type. + enum: + - DEDICATED + - EMBEDDED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + readOnly: true connectionStrings: $ref: "#/components/schemas/ClusterConnectionStrings" createDate: @@ -24666,6 +25970,15 @@ components: externalDocs: description: Encryption at Rest using Customer Key Management url: https://www.mongodb.com/docs/atlas/security-kms-encryption/ + featureCompatibilityVersion: + type: string + description: Feature compatibility version of the cluster. + readOnly: true + featureCompatibilityVersionExpirationDate: + type: string + format: date-time + description: Feature compatibility version expiration date. + readOnly: true globalClusterSelfManagedSharding: type: boolean description: |- @@ -24716,6 +26029,8 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true + mongoDBEmployeeAccessGrant: + $ref: "#/components/schemas/EmployeeAccessGrantView" mongoDBMajorVersion: type: string description: |- @@ -24737,7 +26052,7 @@ components: description: Human-readable label that identifies the cluster. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" paused: type: boolean description: Flag that indicates whether the cluster is paused. @@ -24748,6 +26063,35 @@ components: externalDocs: description: Continuous Cloud Backups url: https://docs.atlas.mongodb.com/backup/cloud-backup/overview/ + redactClientLogData: + type: boolean + description: Enable or disable log redaction. + externalDocs: + description: |- + This options corresponds to the ``security.redactClientLogData`` cluster parameter. + + This setting configures the ``mongod`` or ``mongos`` to redact any message accompanying a given log event before logging. This prevents the program from writing potentially sensitive data stored on the database to the diagnostic log. Metadata such as error or operation codes, line numbers, and source file names are still visible in the logs. + + Use ``redactClientLogData`` in conjunction with Encryption at Rest and TLS/SSL (Transport Encryption) to assist compliance with regulatory requirements. + url: https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.redactClientLogData + replicaSetScalingStrategy: + type: string + default: WORKLOAD_TYPE + description: |- + Set this field to configure the replica set scaling mode for your cluster. + + By default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes. + + When configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads. + + When configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads. + enum: + - SEQUENTIAL + - WORKLOAD_TYPE + - NODE_TYPE + externalDocs: + description: Modify the Replica Set Scaling Mode + url: https://dochub.mongodb.org/core/scale-nodes replicationSpecs: type: array description: List of settings that configure your cluster regions. This @@ -24873,6 +26217,24 @@ components: ClusterDescriptionProcessArgs: type: object properties: + changeStreamOptionsPreAndPostImagesExpireAfterSeconds: + type: integer + format: int32 + default: -1 + description: The minimum pre- and post-image retention time in seconds. + externalDocs: + description: "This option corresponds to the ``changeStreamOptions.preAndPostImages.expireAfterSeconds``\ + \ cluster parameter. This setting controls the retention policy of change\ + \ stream pre- and post-images. Pre- and post-images are the versions\ + \ of a document before and after document modification, respectively.\ + \ ``expireAfterSeconds`` controls how long MongoDB retains pre- and\ + \ post-images. When set to -1 (off), MongoDB uses the default retention\ + \ policy: pre- and post-images are retained until the corresponding\ + \ change stream events are removed from the oplog. To set the minimum\ + \ pre- and post-image retention time, specify an integer value greater\ + \ than zero. Setting this too low could increase the risk of interrupting\ + \ Realm sync or triggers processing. The default value is -1 (off)." + url: https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/changeStreamOptions/#mongodb-parameter-param.changeStreamOptions.preAndPostImages.expireAfterSeconds chunkMigrationConcurrency: type: integer format: int32 @@ -24883,6 +26245,14 @@ components: description: This option corresponds to the `chunkMigrationConcurrency` `mongod` configuration file option. url: https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.chunkMigrationConcurrency + defaultMaxTimeMS: + type: integer + format: int32 + description: Default time limit in milliseconds for individual read operations + to complete. + externalDocs: + description: This option corresponds to the defaultMaxTimeMS cluster parameter. + url: https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/defaultMaxTimeMS/ defaultReadConcern: type: string default: available @@ -24919,8 +26289,10 @@ components: url: https://docs.mongodb.com/upcoming/reference/parameters/#mongodb-parameter-param.failIndexKeyTooLong javascriptEnabled: type: boolean - description: Flag that indicates whether the cluster allows execution of - operations that perform server-side executions of JavaScript. + 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. @@ -25013,6 +26385,24 @@ components: ClusterDescriptionProcessArgs20240805: type: object properties: + changeStreamOptionsPreAndPostImagesExpireAfterSeconds: + type: integer + format: int32 + default: -1 + description: The minimum pre- and post-image retention time in seconds. + externalDocs: + description: "This option corresponds to the ``changeStreamOptions.preAndPostImages.expireAfterSeconds``\ + \ cluster parameter. This setting controls the retention policy of change\ + \ stream pre- and post-images. Pre- and post-images are the versions\ + \ of a document before and after document modification, respectively.\ + \ ``expireAfterSeconds`` controls how long MongoDB retains pre- and\ + \ post-images. When set to -1 (off), MongoDB uses the default retention\ + \ policy: pre- and post-images are retained until the corresponding\ + \ change stream events are removed from the oplog. To set the minimum\ + \ pre- and post-image retention time, specify an integer value greater\ + \ than zero. Setting this too low could increase the risk of interrupting\ + \ Realm sync or triggers processing. The default value is -1 (off)." + url: https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/changeStreamOptions/#mongodb-parameter-param.changeStreamOptions.preAndPostImages.expireAfterSeconds chunkMigrationConcurrency: type: integer format: int32 @@ -25023,6 +26413,14 @@ components: description: This option corresponds to the `chunkMigrationConcurrency` `mongod` configuration file option. url: https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.chunkMigrationConcurrency + defaultMaxTimeMS: + type: integer + format: int32 + description: Default time limit in milliseconds for individual read operations + to complete. + externalDocs: + description: This option corresponds to the defaultMaxTimeMS cluster parameter. + url: https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/defaultMaxTimeMS/ defaultWriteConcern: type: string description: Default level of acknowledgment requested from MongoDB for @@ -25033,8 +26431,10 @@ components: url: https://docs.mongodb.com/manual/reference/write-concern/ javascriptEnabled: type: boolean - description: Flag that indicates whether the cluster allows execution of - operations that perform server-side executions of JavaScript. + 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. @@ -25319,7 +26719,7 @@ components: outage simulation. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true groupId: type: string @@ -26134,6 +27534,7 @@ components: mapping: AWS: "#/components/schemas/AWSCreateDataProcessRegionView" AZURE: "#/components/schemas/AzureCreateDataProcessRegionView" + GCP: "#/components/schemas/GCPCreateDataProcessRegionView" propertyName: cloudProvider properties: cloudProvider: @@ -26616,11 +28017,11 @@ components: roleId: type: string description: Unique identifier of the role that Data Federation can use - to access the data stores.Required if specifying cloudProviderConfig. + to access the data stores. Required if specifying cloudProviderConfig. servicePrincipalId: type: string description: The ID of the Service Principal for which there is an access - policyfor Atlas to access Azure resources. + policy for Atlas to access Azure resources. readOnly: true tenantId: type: string @@ -26629,6 +28030,22 @@ components: readOnly: true required: - roleId + DataFederationGCPCloudProviderConfig: + type: object + description: Configuration for running Data Federation in GCP. + 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: + type: string + description: Unique identifier of the role that Data Federation can use + to access the data stores. Required if specifying cloudProviderConfig. + required: + - roleId DataFederationLimit: type: object description: Details of user managed limits. @@ -26636,6 +28053,7 @@ components: mapping: atlas.project.deployment.clusters: "#/components/schemas/DefaultLimit" atlas.project.deployment.nodesPerPrivateLinkRegion: "#/components/schemas/DefaultLimit" + atlas.project.deployment.salesSoldM0s: "#/components/schemas/DefaultLimit" atlas.project.deployment.serverlessMTMs: "#/components/schemas/DefaultLimit" atlas.project.security.databaseAccess.customRoles: "#/components/schemas/DefaultLimit" atlas.project.security.databaseAccess.users: "#/components/schemas/DefaultLimit" @@ -27006,7 +28424,9 @@ components: $ref: "#/components/schemas/DataLakeAWSCloudProviderConfig" azure: $ref: "#/components/schemas/DataFederationAzureCloudProviderConfig" - title: Data Lake Cloud Provider + gcp: + $ref: "#/components/schemas/DataFederationGCPCloudProviderConfig" + title: Data Federation Cloud Provider DataLakeDLSAWSStore: type: object allOf: @@ -27131,6 +28551,7 @@ components: enum: - AWS - AZURE + - GCP region: $ref: "#/components/schemas/BaseAtlasDataLakeRegion" required: @@ -27607,7 +29028,7 @@ components: example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -27866,7 +29287,12 @@ components: enum: - AVERAGE operator: - $ref: "#/components/schemas/Operator" + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - LESS_THAN + - GREATER_THAN threshold: type: number format: double @@ -27914,6 +29340,7 @@ components: mapping: AWS: "#/components/schemas/AWSDataProcessRegionView" AZURE: "#/components/schemas/AzureDataProcessRegionView" + GCP: "#/components/schemas/GCPDataProcessRegionView" propertyName: cloudProvider properties: cloudProvider: @@ -27923,6 +29350,7 @@ components: enum: - AWS - AZURE + - GCP readOnly: true readOnly: true DataProtectionSettings: @@ -28214,6 +29642,8 @@ components: - SQL_SET_SCHEMA - VIEW_ALL_HISTORY - OUT_TO_S3 + - OUT_TO_AZURE + - OUT_TO_GCS - STORAGE_GET_CONFIG - STORAGE_SET_CONFIG - FLUSH_ROUTER_CONFIG @@ -28573,6 +30003,7 @@ components: - FTS_INDEX_BUILD_COMPLETE - FTS_INDEX_BUILD_FAILED - FTS_INDEXES_RESTORE_FAILED + - FTS_INDEXES_SYNONYM_MAPPING_INVALID title: FTS Index Audit Types - type: string enum: @@ -28773,6 +30204,7 @@ components: - FTS_INDEX_BUILD_COMPLETE - FTS_INDEX_BUILD_FAILED - FTS_INDEXES_RESTORE_FAILED + - FTS_INDEXES_SYNONYM_MAPPING_INVALID title: FTS Index Audit Types - type: string enum: @@ -29228,11 +30660,14 @@ components: - CLUSTER_VERSION_UNFIXED - CLUSTER_FCV_FIXED - CLUSTER_FCV_UNFIXED + - CLUSTER_FCV_EXPIRATION_DATE_UPDATED - AGENT_VERSION_FIXED - AGENT_VERSION_UNFIXED - FIXED_VERSION_UPDATED - FIXED_AGENT_VERSION_UPDATED - CLUSTER_FCV_DOWNGRADED + - CLUSTER_BINARY_VERSION_DOWNGRADED + - CLUSTER_BINARY_VERSION_UPGRADED title: Version Audit Types groupId: type: string @@ -29620,7 +31055,6 @@ components: pattern: "^([a-f0-9]{24})$" hostnameSchemaType: type: string - default: PUBLIC description: The network type to use between the migration host and the destination cluster. enum: @@ -29821,30 +31255,19 @@ components: createdAt: type: string format: date-time - description: Date and time when someone created this export job. MongoDB - Cloud represents this timestamp in ISO 8601 format in UTC. + description: Date and time when a user or Atlas created the Export Job. + MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. readOnly: true customData: type: array description: Collection of key-value pairs that represent custom data for - the metadata file that MongoDB Cloud uploads to the bucket when the export - job finishes. + the metadata file that MongoDB Cloud uploads when the Export Job finishes. items: $ref: "#/components/schemas/BackupLabel" - 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\"`." - items: - type: string - description: One Uniform Resource Locator that point to the compressed - snapshot files for manual download. - readOnly: true exportBucketId: type: string description: Unique 24-hexadecimal character string that identifies the - Export Bucket to export to. + Export Bucket. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 @@ -29855,7 +31278,7 @@ components: finishedAt: type: string format: date-time - description: Date and time when this export job completed. MongoDB Cloud + description: Date and time when this Export Job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. readOnly: true id: @@ -29880,8 +31303,8 @@ components: readOnly: true prefix: type: string - description: Full path on the cloud provider bucket to the folder where - the snapshot is exported. + description: Prefix used for all blob storage objects uploaded as part of + the Export Job. pattern: "/exported_snapshots/\\{ORG-NAME\\}/\\{PROJECT-NAME\\}/\\{CLUSTER-NAME\\\ }/\\{SNAPSHOT-INITIATION-DATE\\}/\\{TIMESTAMP\\}" readOnly: true @@ -29895,7 +31318,7 @@ components: pattern: "^([a-f0-9]{24})$" state: type: string - description: State of the export job. + description: State of the Export Job. enum: - Cancelled - Failed @@ -29918,7 +31341,7 @@ components: exportBucketId: type: string description: Unique 24-hexadecimal character string that identifies the - Export Bucket to export to. + Export Bucket. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 @@ -30125,10 +31548,19 @@ components: properties: downloadUrl: type: string - description: "One Uniform Resource Locator that point to the compressed\ + 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." + items: + $ref: "#/components/schemas/ApiPrivateDownloadDeliveryUrl" + readOnly: true replicaSetName: type: string description: Human-readable label that identifies the replica set on the @@ -30580,7 +32012,7 @@ components: \ this parameter when `\"deliveryType\" : \"download\"`." items: type: string - description: One Uniform Resource Locator that point to the compressed + description: One Uniform Resource Locator that points to the compressed snapshot files for manual download. readOnly: true desiredTimestamp: @@ -30652,6 +32084,15 @@ components: \ when `\"deliveryType\" : \"pointInTime\"` and **pointInTimeUTCSeconds**\ \ exceeds `0`." minimum: 1199145600 + 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." + items: + $ref: "#/components/schemas/ApiPrivateDownloadDeliveryUrl" + readOnly: true snapshotId: type: string description: Unique 24-hexadecimal character string that identifies the @@ -30668,7 +32109,7 @@ components: and `pointInTime` restore types. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" targetGroupId: type: string description: Unique 24-hexadecimal digit string that identifies the target @@ -30709,7 +32150,7 @@ components: you want to return. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true copySettings: type: array @@ -30803,7 +32244,7 @@ components: you want to return. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true copySettings: type: array @@ -30889,8 +32330,12 @@ components: additionalProperties: type: object description: The stats associated with the stream processor. + externalDocs: + url: https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor readOnly: true description: The stats associated with the stream processor. + externalDocs: + url: https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor readOnly: true EARPrivateEndpoint: type: object @@ -30985,6 +32430,8 @@ components: - PENDING_ACCEPTANCE - ACTIVE - FAILED + - PENDING_RECREATION + - DELETING readOnly: true title: Encryption At Rest Private Endpoint EmailNotification: @@ -31031,6 +32478,36 @@ components: required: - typeName title: Email Notification + EmployeeAccessGrantView: + type: object + description: MongoDB employee granted access level and expiration for a cluster. + properties: + expirationTime: + type: string + format: date-time + description: Expiration date for the employee access grant. + 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." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + readOnly: true + required: + - expirationTime + - grantType EncryptionAtRest: type: object properties: @@ -31040,24 +32517,6 @@ components: $ref: "#/components/schemas/AzureKeyVault" googleCloudKms: $ref: "#/components/schemas/GoogleCloudKMS" - EncryptionAtRestPrivateEndpointRequest: - type: object - description: Create or delete private endpoints from the specified regions list. - properties: - cloudProvider: - type: string - description: Cloud service provider name. - enum: - - AZURE - regions: - type: array - description: List of regions. - items: - type: string - uniqueItems: true - required: - - cloudProvider - title: Encryption At Rest Private Endpoints setup. EncryptionKeyAlertConfigViewForNdsGroup: type: object description: Encryption key alert configuration allows to select thresholds which @@ -31404,6 +32863,7 @@ components: - FTS_INDEX_CLEANED_UP - FTS_INDEXES_RESTORED - FTS_INDEXES_RESTORE_FAILED + - FTS_INDEXES_SYNONYM_MAPPING_INVALID title: FTS Index Audit Types - type: string enum: @@ -31457,6 +32917,8 @@ components: - HOST_HAS_INDEX_SUGGESTIONS - HOST_MONGOT_RECOVERED_OOM - HOST_MONGOT_CRASHING_OOM + - HOST_MONGOT_RESUME_REPLICATION + - HOST_MONGOT_STOP_REPLICATION - HOST_ENOUGH_DISK_SPACE - HOST_NOT_ENOUGH_DISK_SPACE title: Host Event Types @@ -31494,6 +32956,7 @@ components: - 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 @@ -31571,6 +33034,8 @@ components: - 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 @@ -31600,6 +33065,9 @@ components: - 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 @@ -31658,9 +33126,13 @@ components: - 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 title: NDS Audit Types - type: string enum: @@ -31857,11 +33329,14 @@ components: - CLUSTER_VERSION_UNFIXED - CLUSTER_FCV_FIXED - CLUSTER_FCV_UNFIXED + - CLUSTER_FCV_EXPIRATION_DATE_UPDATED - AGENT_VERSION_FIXED - AGENT_VERSION_UNFIXED - FIXED_VERSION_UPDATED - FIXED_AGENT_VERSION_UPDATED - CLUSTER_FCV_DOWNGRADED + - CLUSTER_BINARY_VERSION_DOWNGRADED + - CLUSTER_BINARY_VERSION_UPGRADED title: Version Audit Types - type: string enum: @@ -32137,6 +33612,12 @@ components: enum: - GROUP_TAGS_MODIFIED title: Resource Event Types + - type: string + enum: + - RESOURCE_POLICY_CREATED + - RESOURCE_POLICY_MODIFIED + - RESOURCE_POLICY_DELETED + title: Atlas Resource Policy Audit Types EventViewForNdsGroup: type: object oneOf: @@ -32178,6 +33659,7 @@ components: - $ref: "#/components/schemas/TeamEvent" - $ref: "#/components/schemas/UserEventViewForOrg" - $ref: "#/components/schemas/ResourceEventViewForOrg" + - $ref: "#/components/schemas/AtlasResourcePolicyAuditForOrg" ExampleResourceResponse20230101: type: object properties: @@ -32227,8 +33709,7 @@ components: - description ExportStatus: type: object - description: State of the export job for the collections on the replica set - only. + description: State of the Export Job. properties: exportedCollections: type: integer @@ -32274,6 +33755,7 @@ components: - FTS_INDEX_CLEANED_UP - FTS_INDEXES_RESTORED - FTS_INDEXES_RESTORE_FAILED + - FTS_INDEXES_SYNONYM_MAPPING_INVALID example: FTS_INDEX_CREATED title: FTS Index Audit Types FTSIndexAuditView: @@ -33201,37 +34683,52 @@ components: enum: - EXCLUDE title: Field Transformation - ForNdsGroup: + FieldViolation: type: object - description: ReplicaSet Event identifies different activities about replica - set of mongod instances. properties: - created: + description: type: string - format: date-time - description: Date and time when this event occurred. This parameter expresses - its value in the ISO 8601 timestamp format in UTC. + 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. + required: + - description + - field + FlexBackupRestoreJob20250101: + type: object + description: Details for one restore job of a flex cluster. + properties: + deliveryType: + type: string + description: Means by which this resource returns the snapshot to the requesting + MongoDB Cloud user. + enum: + - RESTORE + - DOWNLOAD readOnly: true - eventTypeName: - $ref: "#/components/schemas/ReplicaSetEventTypeViewForNdsGroup" - groupId: + expirationDate: type: string - description: Unique 24-hexadecimal digit string that identifies the project - in which the event occurred. The **eventId** identifies the specific event. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" + format: date-time + description: Date and time when the download link no longer works. This + parameter expresses its value in the ISO 8601 timestamp format in UTC. readOnly: true id: type: string - description: Unique 24-hexadecimal digit string that identifies the event. + description: Unique 24-hexadecimal digit string that identifies the restore + job. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true + instanceName: + type: string + description: Human-readable label that identifies the source instance. + maxLength: 64 + minLength: 1 + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + readOnly: true links: type: array description: "List of one or more Uniform Resource Locators (URLs) that\ @@ -33243,656 +34740,296 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true - orgId: + projectId: type: string - description: Unique 24-hexadecimal digit string that identifies the organization - to which these events apply. + description: Unique 24-hexadecimal digit string that identifies the project + from which the restore job originated. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true - port: - type: integer - format: int32 - description: IANA port on which the MongoDB process listens for requests. - example: 27017 - readOnly: true - raw: - $ref: "#/components/schemas/raw" - replicaSetName: + restoreFinishedDate: type: string - description: Human-readable label of the replica set associated with the - event. - example: event-replica-set + format: date-time + 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. readOnly: true - shardName: + restoreScheduledDate: type: string - description: Human-readable label of the shard associated with the event. - example: event-sh-01 + format: date-time + description: Date and time when MongoDB Cloud will restore this snapshot. + This parameter expresses its value in the ISO 8601 timestamp format in + UTC. readOnly: true - required: - - created - - eventTypeName - - id - title: ReplicaSet Events - GCPCloudProviderContainer: - type: object - allOf: - - $ref: "#/components/schemas/CloudProviderContainer" - - type: object - properties: - atlasCidrBlock: - type: string - description: |- - IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project. - - These CIDR blocks must fall within the ranges reserved per RFC 1918. GCP further limits the block to a lower bound of the `/18` range. - - To modify the CIDR block, the target project cannot have: - - - Any M10 or greater clusters - - Any other VPC peering connections - - You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project. - - **Example:** A project in an Google Cloud (GCP) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets. - pattern: "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" - gcpProjectId: - 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. - maxLength: 26 - minLength: 26 - pattern: "^p-[0-9a-z]{24}$" - readOnly: true - networkName: - 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. - maxLength: 36 - minLength: 36 - pattern: "^nt-[0-9a-f]{24}-[0-9a-z]{8}$" - 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." - 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." - 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 - description: Collection of settings that configures the network container for - a virtual private connection on Amazon Web Services. - required: - - atlasCidrBlock - title: GCP - GCPComputeAutoScaling: - type: object - description: Collection of settings that configures how a cluster might scale - its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling - is unavailable for clusters using Low CPU or NVME storage classes. - properties: - maxInstanceSize: - type: string - description: Maximum instance size to which your cluster can automatically - scale. - enum: - - M10 - - M20 - - M30 - - M40 - - M50 - - M60 - - M80 - - M140 - - M200 - - M250 - - M300 - - M400 - - R40 - - R50 - - R60 - - R80 - - R200 - - R300 - - R400 - - R600 - title: GCP Instance Sizes - minInstanceSize: + snapshotFinishedDate: 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 - title: GCP Instance Sizes - title: GCP - GCPConsumerForwardingRule: - type: object - properties: - endpointName: + format: date-time + description: Date and time when MongoDB Cloud completed writing this snapshot. + This parameter expresses its value in the ISO 8601 timestamp format in + UTC. + readOnly: true + snapshotId: type: string - description: Human-readable label that identifies the Google Cloud consumer - forwarding rule that you created. - externalDocs: - description: Google Cloud Forwarding Rule Concepts - url: https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts + description: Unique 24-hexadecimal digit string that identifies the snapshot + to restore. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" readOnly: true - ipAddress: + snapshotUrl: type: string - description: One Private Internet Protocol version 4 (IPv4) address to which - this Google Cloud consumer forwarding rule resolves. - pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + 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: State of the MongoDB Cloud endpoint group when MongoDB Cloud - received this request. + description: Phase of the restore workflow for this job at the time this + resource made this request. enum: - - INITIATING - - AVAILABLE + - PENDING + - QUEUED + - RUNNING - FAILED - - DELETING + - COMPLETED readOnly: true - GCPEndpointService: + targetDeploymentItemName: + type: string + description: Human-readable label that identifies the instance or cluster + on the target project to which you want to restore the snapshot. You can + restore the snapshot to another USS instance or Dedicated cluster tier. + maxLength: 64 + minLength: 1 + pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + readOnly: true + targetProjectId: + type: string + description: Unique 24-hexadecimal digit string that identifies the project + that contains the instance or cluster to which you want to restore the + snapshot. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + title: Flex Backup Restore Job + FlexBackupRestoreJobCreate20250101: type: object - description: Group of Private Endpoint Service settings. + description: Details to create one restore job of a flex cluster. properties: - cloudProvider: + _snapshotId: type: string - description: Cloud service provider that serves the requested endpoint service. + description: Unique 24-hexadecimal digit string that identifies the snapshot + to restore. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + writeOnly: true + _targetDeploymentItemName: + type: string + description: Human-readable label that identifies the instance or cluster + on the target project to which you want to restore the snapshot. You can + restore the snapshot to another flex cluster or dedicated cluster tier. + maxLength: 64 + minLength: 1 + pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + writeOnly: true + _targetProjectId: + type: string + description: Unique 24-hexadecimal digit string that identifies the project + that contains the instance or cluster to which you want to restore the + snapshot. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + writeOnly: true + deliveryType: + type: string + description: Means by which this resource returns the snapshot to the requesting + MongoDB Cloud user. enum: - - AWS - - AZURE - - GCP + - RESTORE + - DOWNLOAD readOnly: true - 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 - items: - type: string - description: One Google Cloud network endpoint group that corresponds - to the Private Service Connect endpoint service. - errorMessage: + expirationDate: type: string - description: Error message returned when requesting private connection resource. - The resource returns `null` if the request succeeded. + format: date-time + description: Date and time when the download link no longer works. This + parameter expresses its value in the ISO 8601 timestamp format in UTC. readOnly: true id: type: string - description: Unique 24-hexadecimal digit string that identifies the Private - Endpoint Service. + description: Unique 24-hexadecimal digit string that identifies the restore + job. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true - regionName: + instanceName: type: string - description: Cloud provider region that manages this Private Endpoint Service. + description: Human-readable label that identifies the source instance. + maxLength: 64 + minLength: 1 + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true - serviceAttachmentNames: + links: 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. + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." externalDocs: - description: Google Cloud Private Service Connect Service Attachments - url: https://cloud.google.com/vpc/docs/private-service-connect#service-attachments + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 items: - 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. - 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\\-]+" - status: + $ref: "#/components/schemas/Link" + readOnly: true + projectId: type: string - description: State of the Private Endpoint Service connection when MongoDB - Cloud received this request. - enum: - - INITIATING - - AVAILABLE - - WAITING_FOR_USER - - FAILED - - DELETING - readOnly: true - required: - - cloudProvider - title: GCP - GCPHardwareSpec: - type: object - properties: - instanceSize: - type: string - description: Hardware specification for the instance sizes in this region. - Each instance size has a default storage and memory capacity. The instance - size you select applies to all the data-bearing hosts 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 - title: GCP Instance Sizes - nodeCount: - type: integer - format: int32 - description: Number of nodes of the given type for MongoDB Cloud to deploy - to the region. - GCPHardwareSpec20240805: - type: object - properties: - diskSizeGB: - type: number - format: double - description: "Storage capacity of instance data volumes expressed in gigabytes.\ - \ Increase this number to add capacity.\n\n This value must be equal for\ - \ all shards and node types.\n\n This value is not configurable on M0/M2/M5\ - \ clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\ - \n If you specify a disk size below the minimum (10 GB), this parameter\ - \ defaults to the minimum disk size value. \n\n Storage charge calculations\ - \ depend on whether you choose the default value or a custom value.\n\n\ - \ The maximum value for disk storage cannot exceed 50 times the maximum\ - \ RAM for the selected cluster. If you require more storage space, consider\ - \ upgrading your cluster to a higher tier." - maximum: 4096 - minimum: 10 - instanceSize: - type: string - description: Hardware specification for the instance sizes in this region - in this shard. Each instance size has a default storage and memory capacity. - Electable nodes and read-only nodes (known as "base nodes") within a single - shard must use the same instance size. Analytics nodes can scale independently - from base nodes within a shard. Both base nodes and analytics nodes can - scale independently from their equivalents in other shards. - enum: - - M10 - - M20 - - M30 - - M40 - - M50 - - M60 - - M80 - - M140 - - M200 - - M250 - - M300 - - M400 - - R40 - - R50 - - R60 - - R80 - - R200 - - R300 - - R400 - - R600 - title: GCP Instance Sizes - nodeCount: - type: integer - format: int32 - description: Number of nodes of the given type for MongoDB Cloud to deploy - to the region. - GCPNetworkPeeringConnectionSettings: - type: object - description: Group of Network Peering connection settings. - properties: - containerId: - type: string - description: Unique 24-hexadecimal digit string that identifies the MongoDB - Cloud network container that contains the specified network peering connection. + description: Unique 24-hexadecimal digit string that identifies the project + from which the restore job originated. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" - 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: + restoreFinishedDate: 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. - maxLength: 30 - minLength: 6 - pattern: "^[a-z][0-9a-z-]{4,28}[0-9a-z]{1}" - id: + format: date-time + 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. + readOnly: true + restoreScheduledDate: type: string - description: Unique 24-hexadecimal digit string that identifies the network - peering connection. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" + format: date-time + description: Date and time when MongoDB Cloud will restore this snapshot. + This parameter expresses its value in the ISO 8601 timestamp format in + UTC. readOnly: true - networkName: + snapshotFinishedDate: type: string - description: Human-readable label that identifies the network to peer with - the MongoDB Cloud VPC. - maxLength: 63 - minLength: 1 - pattern: "[a-z]([-a-z0-9]{0,62}[a-z0-9]{0,1})?" - providerName: + format: date-time + description: Date and time when MongoDB Cloud completed writing this snapshot. + This parameter expresses its value in the ISO 8601 timestamp format in + UTC. + readOnly: true + snapshotUrl: type: string - description: Cloud service provider that serves the requested network peering - connection. - enum: - - AWS - - AZURE - - GCP + 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: State of the network peering connection at the time you made - the request. + description: Phase of the restore workflow for this job at the time this + resource made this request. enum: - - ADDING_PEER - - WAITING_FOR_USER - - AVAILABLE + - PENDING + - QUEUED + - RUNNING - FAILED - - DELETING + - COMPLETED readOnly: true required: - - containerId - - gcpProjectId - - networkName - title: GCP - GCPRegionConfig: - type: object - allOf: - - $ref: "#/components/schemas/CloudRegionConfig" - - type: object - properties: - analyticsAutoScaling: - $ref: "#/components/schemas/AdvancedAutoScalingSettings" - analyticsSpecs: - $ref: "#/components/schemas/DedicatedHardwareSpec" - autoScaling: - $ref: "#/components/schemas/AdvancedAutoScalingSettings" - readOnlySpecs: - $ref: "#/components/schemas/DedicatedHardwareSpec" - description: Details that explain how MongoDB Cloud replicates data in one region - on the specified MongoDB database. - title: GCP Regional Replication Specifications - GCPRegionConfig20240805: - type: object - allOf: - - $ref: "#/components/schemas/CloudRegionConfig20240805" - - type: object - properties: - analyticsAutoScaling: - $ref: "#/components/schemas/AdvancedAutoScalingSettings" - analyticsSpecs: - $ref: "#/components/schemas/DedicatedHardwareSpec20240805" - autoScaling: - $ref: "#/components/schemas/AdvancedAutoScalingSettings" - readOnlySpecs: - $ref: "#/components/schemas/DedicatedHardwareSpec20240805" - description: Details that explain how MongoDB Cloud replicates data in one region - on the specified MongoDB database. - title: GCP Regional Replication Specifications - GeoSharding: + - _snapshotId + - _targetDeploymentItemName + title: Create Flex Backup Restore Job + FlexBackupSettings20250101: type: object + description: Flex backup configuration properties: - customZoneMapping: - type: object - additionalProperties: - 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 - 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. - items: - $ref: "#/components/schemas/ManagedNamespaces" - readOnly: true - selfManagedSharding: + enabled: 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. + default: true + description: "Flag that indicates whether backups are performed for this\ + \ flex cluster. Backup uses [TODO](TODO) for flex clusters." readOnly: true - GeoSharding20240805: + readOnly: true + title: Flex Backup Configuration + FlexBackupSnapshot20250101: type: object + description: Details for one snapshot of a flex cluster. properties: - customZoneMapping: - type: object - additionalProperties: - type: string - description: |- - List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone. - - The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property. - - This parameter returns an empty object if no custom zones exist. - readOnly: true - description: |- - List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone. - - The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property. - - This parameter returns an empty object if no custom zones exist. - readOnly: true - managedNamespaces: - type: array - description: List that contains a namespace for a Global Cluster. MongoDB - Cloud manages this cluster. - items: - $ref: "#/components/schemas/ManagedNamespaces" - readOnly: true - 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. + expiration: + type: string + format: date-time + description: Date and time when the download link no longer works. This + parameter expresses its value in the ISO 8601 timestamp format in UTC. readOnly: true - GoogleCloudKMS: - type: object - description: Details that define the configuration of Encryption at Rest using - Google Cloud Key Management Service (KMS). - externalDocs: - description: Google Cloud Key Management Service - url: https://www.mongodb.com/docs/atlas/security-gcp-kms/ - properties: - enabled: - 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: + finishTime: 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 - serviceAccountKey: + format: date-time + description: Date and time when MongoDB Cloud completed writing this snapshot. + This parameter expresses its value in the ISO 8601 timestamp format in + UTC. + readOnly: true + id: type: string - description: 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. + description: Unique 24-hexadecimal digit string that identifies the snapshot. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." externalDocs: - description: Google Cloud Authentication - url: https://cloud.google.com/docs/authentication/getting-started - writeOnly: true - valid: - type: boolean - description: Flag that indicates whether the Google Cloud Key Management - Service (KMS) encryption key can encrypt and decrypt data. + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" readOnly: true - GreaterThanDaysThresholdView: - type: object - description: Threshold value that triggers an alert. - properties: - operator: - type: string - description: Comparison operator to apply when checking the current metric - value. - enum: - - GREATER_THAN - threshold: - type: integer - format: int32 - description: "Value of metric that, when exceeded, triggers an alert." - units: + mongoDBVersion: type: string - description: "Element used to express the quantity. This can be an element\ - \ of time, storage capacity, and the like." - enum: - - DAYS - GreaterThanRawThreshold: - type: object - description: A Limit that triggers an alert when greater than a number. - properties: - operator: + description: MongoDB host version that the snapshot runs. + readOnly: true + scheduledTime: type: string - description: Comparison operator to apply when checking the current metric - value. - enum: - - GREATER_THAN - threshold: - type: integer - format: int32 - description: "Value of metric that, when exceeded, triggers an alert." - units: - $ref: "#/components/schemas/RawMetricUnits" - title: Greater Than Raw Threshold - GreaterThanRawThresholdAlertConfigViewForNdsGroup: - type: object - properties: - created: + format: date-time + description: Date and time when MongoDB Cloud will take the snapshot. This + parameter expresses its value in the ISO 8601 timestamp format in UTC. + readOnly: true + startTime: type: string format: date-time - description: Date and time when MongoDB Cloud created the alert configuration. - This parameter expresses its value in the ISO 8601 timestamp format - in UTC. + description: Date and time when MongoDB Cloud began taking the snapshot. + This parameter expresses its value in the ISO 8601 timestamp format in + UTC. readOnly: true - enabled: - type: boolean - default: false - description: Flag that indicates whether someone enabled this alert configuration - for the specified project. - eventTypeName: - $ref: "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" - groupId: + status: type: string - description: Unique 24-hexadecimal digit string that identifies the project - that owns this alert configuration. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" + description: Phase of the workflow for this snapshot at the time this resource + made this request. + enum: + - PENDING + - QUEUED + - RUNNING + - FAILED + - COMPLETED readOnly: true - id: + title: Flex Backup Snapshot + FlexBackupSnapshotDownloadCreate20250101: + type: object + description: Details for one backup snapshot download of a flex cluster. + properties: + _snapshotId: type: string - description: Unique 24-hexadecimal digit string that identifies this alert - configuration. + description: Unique 24-hexadecimal digit string that identifies the snapshot + to download. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" - readOnly: true + writeOnly: true links: type: array description: "List of one or more Uniform Resource Locators (URLs) that\ @@ -33904,67 +35041,42 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true - matchers: - type: array - description: "List of rules that determine whether MongoDB Cloud checks\ - \ an object for the alert configuration. You can filter using the matchers\ - \ array if the **eventTypeName** specifies an event for a host, replica\ - \ set, or sharded cluster." - items: - $ref: "#/components/schemas/ReplicaSetMatcher" - notifications: - type: array - description: List that contains the targets that MongoDB Cloud sends notifications. - items: - $ref: "#/components/schemas/AlertsNotificationRootForGroup" - threshold: - $ref: "#/components/schemas/GreaterThanRawThreshold" - updated: - type: string - format: date-time - description: Date and time when someone last updated this alert configuration. - This parameter expresses its value in the ISO 8601 timestamp format - in UTC. - readOnly: true required: - - eventTypeName - - notifications - GreaterThanTimeThreshold: + - _snapshotId + title: Flex Backup Snapshot Download Create + FlexClusterDescription20250101: type: object - description: A Limit that triggers an alert when greater than a time period. + description: Group of settings that configure a MongoDB Flex cluster. properties: - operator: + backupSettings: + $ref: "#/components/schemas/FlexBackupSettings20250101" + clusterType: type: string - description: Comparison operator to apply when checking the current metric - value. + description: Flex cluster topology. enum: - - GREATER_THAN - threshold: - type: integer - format: int32 - description: "Value of metric that, when exceeded, triggers an alert." - units: - $ref: "#/components/schemas/TimeMetricUnits" - title: Greater Than Time Threshold - Group: - type: object - properties: - clusterCount: - type: integer - format: int64 - description: Quantity of MongoDB Cloud clusters deployed in this project. + - REPLICASET + - LOADBALANCED readOnly: true - created: + connectionStrings: + $ref: "#/components/schemas/FlexConnectionStrings20250101" + createDate: type: string format: date-time - description: Date and time when MongoDB Cloud created this project. This - parameter expresses its value in the ISO 8601 timestamp format in UTC. + description: Date and time when MongoDB Cloud created this instance. This + parameter expresses its value in ISO 8601 format in UTC. + readOnly: true + groupId: + type: string + description: Unique 24-hexadecimal character string that identifies the + project. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" readOnly: true id: type: string - description: Unique 24-hexadecimal digit string that identifies the MongoDB - Cloud project. + description: Unique 24-hexadecimal digit string that identifies the instance. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 @@ -33981,18 +35093,1021 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true + mongoDBVersion: + type: string + description: Version of MongoDB that the instance runs. + pattern: "([\\d]+\\.[\\d]+\\.[\\d]+)" + readOnly: true name: type: string - description: Human-readable label that identifies the project included in - the MongoDB Cloud organization. + description: Human-readable label that identifies the instance. maxLength: 64 minLength: 1 - pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" - orgId: + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + readOnly: true + providerSettings: + $ref: "#/components/schemas/FlexProviderSettings20250101" + stateName: type: string - description: Unique 24-hexadecimal digit string that identifies the MongoDB - Cloud organization to which the project belongs. - example: 32b6e34b3d91647abb20e7b8 + description: Human-readable label that indicates the current operating condition + of this instance. + enum: + - IDLE + - CREATING + - UPDATING + - DELETING + - REPAIRING + readOnly: true + tags: + type: array + description: List that contains key-value pairs between 1 to 255 characters + in length for tagging and categorizing the instance. + externalDocs: + description: Resource Tags + url: https://dochub.mongodb.org/core/add-cluster-tag-atlas + items: + $ref: "#/components/schemas/ResourceTag" + terminationProtectionEnabled: + type: boolean + default: false + description: "Flag that indicates whether termination protection is enabled\ + \ on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster.\ + \ If set to `false`, MongoDB Cloud will delete the cluster." + versionReleaseSystem: + type: string + default: LTS + description: Method by which the cluster maintains the MongoDB versions. + enum: + - LTS + readOnly: true + required: + - providerSettings + title: Flex Cluster Description + FlexClusterDescriptionCreate20250101: + type: object + description: Settings that you can specify when you create a flex cluster. + properties: + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + name: + type: string + description: Human-readable label that identifies the instance. + maxLength: 64 + minLength: 1 + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + writeOnly: true + providerSettings: + $ref: "#/components/schemas/FlexProviderSettingsCreate20250101" + tags: + type: array + description: List that contains key-value pairs between 1 to 255 characters + in length for tagging and categorizing the instance. + externalDocs: + description: Resource Tags + url: https://dochub.mongodb.org/core/add-cluster-tag-atlas + items: + $ref: "#/components/schemas/ResourceTag" + terminationProtectionEnabled: + type: boolean + default: false + description: "Flag that indicates whether termination protection is enabled\ + \ on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster.\ + \ If set to `false`, MongoDB Cloud will delete the cluster." + required: + - name + - providerSettings + title: Flex Cluster Description Create + FlexConnectionStrings20250101: + type: object + description: Collection of Uniform Resource Locators that point to the MongoDB + database. + externalDocs: + description: Connection string URI format. + url: https://docs.mongodb.com/manual/reference/connection-string/ + properties: + standard: + type: string + description: Public connection string that you can use to connect to this + cluster. This connection string uses the mongodb:// protocol. + externalDocs: + description: Connection String URI Format + url: https://docs.mongodb.com/manual/reference/connection-string/ + readOnly: true + standardSrv: + type: string + description: Public connection string that you can use to connect to this + flex cluster. This connection string uses the `mongodb+srv://` protocol. + externalDocs: + description: Connection String URI Format + url: https://docs.mongodb.com/manual/reference/connection-string/ + readOnly: true + readOnly: true + title: Flex Cluster Connection Strings + FlexProviderSettings20250101: + type: object + description: Group of cloud provider settings that configure the provisioned + MongoDB flex cluster. + properties: + backingProviderName: + type: string + description: Cloud service provider on which MongoDB Cloud provisioned the + flex cluster. + enum: + - AWS + - AZURE + - GCP + readOnly: true + diskSizeGB: + type: number + format: double + description: Storage capacity available to the flex cluster expressed in + gigabytes. + readOnly: true + providerName: + type: string + default: FLEX + description: Human-readable label that identifies the cloud service provider. + enum: + - FLEX + readOnly: true + regionName: + type: string + description: "Human-readable label that identifies the geographic location\ + \ of your MongoDB flex cluster. The region you choose can affect network\ + \ latency for clients accessing your databases. For a complete list of\ + \ region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws),\ + \ [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/)." + readOnly: true + readOnly: true + title: Cloud Service Provider Settings for a Flex Cluster + FlexProviderSettingsCreate20250101: + type: object + description: Group of cloud provider settings that configure the provisioned + MongoDB flex cluster. + properties: + backingProviderName: + type: string + description: Cloud service provider on which MongoDB Cloud provisioned the + flex cluster. + enum: + - AWS + - AZURE + - GCP + writeOnly: true + diskSizeGB: + type: number + format: double + description: Storage capacity available to the flex cluster expressed in + gigabytes. + readOnly: true + providerName: + type: string + default: FLEX + description: Human-readable label that identifies the cloud service provider. + enum: + - FLEX + readOnly: true + regionName: + type: string + description: "Human-readable label that identifies the geographic location\ + \ of your MongoDB flex cluster. The region you choose can affect network\ + \ latency for clients accessing your databases. For a complete list of\ + \ region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws),\ + \ [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/)." + writeOnly: true + required: + - backingProviderName + - regionName + title: Cloud Service Provider Settings for a Flex Cluster + writeOnly: true + ForNdsGroup: + type: object + description: ReplicaSet Event identifies different activities about replica + set of mongod instances. + properties: + created: + type: string + format: date-time + description: Date and time when this event occurred. This parameter expresses + its value in the ISO 8601 timestamp format in UTC. + readOnly: true + eventTypeName: + $ref: "#/components/schemas/ReplicaSetEventTypeViewForNdsGroup" + groupId: + type: string + description: Unique 24-hexadecimal digit string that identifies the project + in which the event occurred. The **eventId** identifies the specific event. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + id: + type: string + description: Unique 24-hexadecimal digit string that identifies the event. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + orgId: + type: string + description: Unique 24-hexadecimal digit string that identifies the organization + to which these events apply. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + port: + type: integer + format: int32 + description: IANA port on which the MongoDB process listens for requests. + example: 27017 + readOnly: true + raw: + $ref: "#/components/schemas/raw" + replicaSetName: + type: string + description: Human-readable label of the replica set associated with the + event. + example: event-replica-set + readOnly: true + shardName: + type: string + description: Human-readable label of the shard associated with the event. + example: event-sh-01 + readOnly: true + required: + - created + - eventTypeName + - id + title: ReplicaSet Events + GCPCloudProviderContainer: + type: object + allOf: + - $ref: "#/components/schemas/CloudProviderContainer" + - type: object + properties: + atlasCidrBlock: + type: string + description: |- + IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project. + + These CIDR blocks must fall within the ranges reserved per RFC 1918. GCP further limits the block to a lower bound of the `/18` range. + + To modify the CIDR block, the target project cannot have: + + - Any M10 or greater clusters + - Any other VPC peering connections + + You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project. + + **Example:** A project in an Google Cloud (GCP) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets. + pattern: "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + gcpProjectId: + 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. + maxLength: 26 + minLength: 26 + pattern: "^p-[0-9a-z]{24}$" + readOnly: true + networkName: + 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. + maxLength: 36 + minLength: 36 + pattern: "^nt-[0-9a-f]{24}-[0-9a-z]{8}$" + 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." + 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." + 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 + description: Collection of settings that configures the network container for + a virtual private connection on Amazon Web Services. + required: + - atlasCidrBlock + title: GCP + GCPComputeAutoScaling: + type: object + description: Collection of settings that configures how a cluster might scale + its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling + is unavailable for clusters using Low CPU or NVME storage classes. + properties: + maxInstanceSize: + type: string + description: Maximum instance size to which your cluster can automatically + scale. + enum: + - M10 + - M20 + - M30 + - M40 + - M50 + - M60 + - M80 + - M140 + - M200 + - M250 + - M300 + - M400 + - R40 + - R50 + - R60 + - R80 + - R200 + - R300 + - R400 + - R600 + title: GCP Instance Sizes + minInstanceSize: + 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 + title: GCP Instance Sizes + title: GCP + GCPConsumerForwardingRule: + type: object + properties: + endpointName: + type: string + description: Human-readable label that identifies the Google Cloud consumer + forwarding rule that you created. + externalDocs: + description: Google Cloud Forwarding Rule Concepts + url: https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts + readOnly: true + ipAddress: + type: string + description: One Private Internet Protocol version 4 (IPv4) address to which + this Google Cloud consumer forwarding rule resolves. + pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + readOnly: true + status: + type: string + description: State of the MongoDB Cloud endpoint group when MongoDB Cloud + received this request. + enum: + - INITIATING + - AVAILABLE + - FAILED + - DELETING + readOnly: true + 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 + 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. + enum: + - CENTRAL_US + - WESTERN_EUROPE + readOnly: true + GCPEndpointService: + type: object + description: Group of Private Endpoint Service settings. + properties: + cloudProvider: + type: string + description: Cloud service provider that serves the requested endpoint service. + enum: + - AWS + - AZURE + - GCP + readOnly: true + 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 + 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: + type: string + description: Unique 24-hexadecimal digit string that identifies the Private + Endpoint Service. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + 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 + items: + 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. + 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\\-]+" + status: + type: string + description: State of the Private Endpoint Service connection when MongoDB + Cloud received this request. + enum: + - INITIATING + - AVAILABLE + - WAITING_FOR_USER + - FAILED + - DELETING + readOnly: true + required: + - cloudProvider + title: GCP + GCPHardwareSpec: + type: object + properties: + instanceSize: + type: string + description: Hardware specification for the instance sizes in this region. + Each instance size has a default storage and memory capacity. The instance + size you select applies to all the data-bearing hosts 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 + title: GCP Instance Sizes + nodeCount: + type: integer + format: int32 + description: Number of nodes of the given type for MongoDB Cloud to deploy + to the region. + GCPHardwareSpec20240805: + type: object + properties: + diskSizeGB: + type: number + format: double + description: "Storage capacity of instance data volumes expressed in gigabytes.\ + \ Increase this number to add capacity.\n\n This value must be equal for\ + \ all shards and node types.\n\n This value is not configurable on M0/M2/M5\ + \ clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\ + \n If you specify a disk size below the minimum (10 GB), this parameter\ + \ defaults to the minimum disk size value. \n\n Storage charge calculations\ + \ depend on whether you choose the default value or a custom value.\n\n\ + \ The maximum value for disk storage cannot exceed 50 times the maximum\ + \ RAM for the selected cluster. If you require more storage space, consider\ + \ upgrading your cluster to a higher tier." + maximum: 4096 + minimum: 10 + instanceSize: + type: string + description: Hardware specification for the instance sizes in this region + in this shard. Each instance size has a default storage and memory capacity. + Electable nodes and read-only nodes (known as "base nodes") within a single + shard must use the same instance size. Analytics nodes can scale independently + from base nodes within a shard. Both base nodes and analytics nodes can + scale independently from their equivalents in other shards. + enum: + - M10 + - M20 + - M30 + - M40 + - M50 + - M60 + - M80 + - M140 + - M200 + - M250 + - M300 + - M400 + - R40 + - R50 + - R60 + - R80 + - R200 + - R300 + - R400 + - R600 + title: GCP Instance Sizes + nodeCount: + type: integer + format: int32 + description: Number of nodes of the given type for MongoDB Cloud to deploy + to the region. + GCPNetworkPeeringConnectionSettings: + type: object + description: Group of Network Peering connection settings. + properties: + containerId: + type: string + description: Unique 24-hexadecimal digit string that identifies the MongoDB + Cloud network container that contains the specified network peering connection. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + 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: + 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. + maxLength: 30 + minLength: 6 + pattern: "^[a-z][0-9a-z-]{4,28}[0-9a-z]{1}" + id: + type: string + description: Unique 24-hexadecimal digit string that identifies the network + peering connection. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + networkName: + type: string + description: Human-readable label that identifies the network to peer with + the MongoDB Cloud VPC. + maxLength: 63 + minLength: 1 + pattern: "[a-z]([-a-z0-9]{0,62}[a-z0-9]{0,1})?" + 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. + enum: + - ADDING_PEER + - WAITING_FOR_USER + - AVAILABLE + - FAILED + - DELETING + readOnly: true + required: + - containerId + - gcpProjectId + - networkName + title: GCP + GCPRegionConfig: + type: object + allOf: + - $ref: "#/components/schemas/CloudRegionConfig" + - type: object + properties: + analyticsAutoScaling: + $ref: "#/components/schemas/AdvancedAutoScalingSettings" + analyticsSpecs: + $ref: "#/components/schemas/DedicatedHardwareSpec" + autoScaling: + $ref: "#/components/schemas/AdvancedAutoScalingSettings" + readOnlySpecs: + $ref: "#/components/schemas/DedicatedHardwareSpec" + description: Details that explain how MongoDB Cloud replicates data in one region + on the specified MongoDB database. + title: GCP Regional Replication Specifications + GCPRegionConfig20240805: + type: object + allOf: + - $ref: "#/components/schemas/CloudRegionConfig20240805" + - type: object + properties: + analyticsAutoScaling: + $ref: "#/components/schemas/AdvancedAutoScalingSettings" + analyticsSpecs: + $ref: "#/components/schemas/DedicatedHardwareSpec20240805" + autoScaling: + $ref: "#/components/schemas/AdvancedAutoScalingSettings" + readOnlySpecs: + $ref: "#/components/schemas/DedicatedHardwareSpec20240805" + description: Details that explain how MongoDB Cloud replicates data in one region + on the specified MongoDB database. + title: GCP Regional Replication Specifications + GeoSharding: + type: object + properties: + customZoneMapping: + type: object + additionalProperties: + 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 + 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. + items: + $ref: "#/components/schemas/ManagedNamespaces" + readOnly: true + 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 + GeoSharding20240805: + type: object + properties: + customZoneMapping: + type: object + additionalProperties: + type: string + description: |- + List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone. + + The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property. + + This parameter returns an empty object if no custom zones exist. + readOnly: true + description: |- + List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone. + + The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property. + + This parameter returns an empty object if no custom zones exist. + readOnly: true + managedNamespaces: + type: array + description: List that contains a namespace for a Global Cluster. MongoDB + Cloud manages this cluster. + items: + $ref: "#/components/schemas/ManagedNamespaces" + readOnly: true + 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 + GoogleCloudKMS: + type: object + description: Details that define the configuration of Encryption at Rest using + Google Cloud Key Management Service (KMS). + externalDocs: + description: Google Cloud Key Management Service + url: https://www.mongodb.com/docs/atlas/security-gcp-kms/ + properties: + enabled: + 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 + 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. + externalDocs: + description: Google Cloud Authentication + url: https://cloud.google.com/docs/authentication/getting-started + writeOnly: true + valid: + type: boolean + description: Flag that indicates whether the Google Cloud Key Management + Service (KMS) encryption key can encrypt and decrypt data. + readOnly: true + GreaterThanDaysThresholdView: + type: object + description: Threshold value that triggers an alert. + properties: + operator: + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - GREATER_THAN + threshold: + type: integer + format: int32 + description: "Value of metric that, when exceeded, triggers an alert." + units: + type: string + description: "Element used to express the quantity. This can be an element\ + \ of time, storage capacity, and the like." + enum: + - DAYS + GreaterThanRawThreshold: + type: object + description: A Limit that triggers an alert when greater than a number. + properties: + operator: + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - GREATER_THAN + threshold: + type: integer + format: int32 + description: "Value of metric that, when exceeded, triggers an alert." + units: + $ref: "#/components/schemas/RawMetricUnits" + title: Greater Than Raw Threshold + GreaterThanRawThresholdAlertConfigViewForNdsGroup: + type: object + properties: + created: + type: string + format: date-time + description: Date and time when MongoDB Cloud created the alert configuration. + This parameter expresses its value in the ISO 8601 timestamp format + in UTC. + readOnly: true + enabled: + type: boolean + default: false + description: Flag that indicates whether someone enabled this alert configuration + for the specified project. + eventTypeName: + $ref: "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" + groupId: + type: string + description: Unique 24-hexadecimal digit string that identifies the project + that owns this alert configuration. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + id: + type: string + description: Unique 24-hexadecimal digit string that identifies this alert + configuration. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + matchers: + type: array + description: "List of rules that determine whether MongoDB Cloud checks\ + \ an object for the alert configuration. You can filter using the matchers\ + \ array if the **eventTypeName** specifies an event for a host, replica\ + \ set, or sharded cluster." + items: + $ref: "#/components/schemas/ReplicaSetMatcher" + notifications: + type: array + description: List that contains the targets that MongoDB Cloud sends notifications. + items: + $ref: "#/components/schemas/AlertsNotificationRootForGroup" + threshold: + $ref: "#/components/schemas/GreaterThanRawThreshold" + updated: + type: string + format: date-time + description: Date and time when someone last updated this alert configuration. + This parameter expresses its value in the ISO 8601 timestamp format + in UTC. + readOnly: true + required: + - eventTypeName + - notifications + GreaterThanTimeThreshold: + type: object + description: A Limit that triggers an alert when greater than a time period. + properties: + operator: + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - GREATER_THAN + threshold: + type: integer + format: int32 + description: "Value of metric that, when exceeded, triggers an alert." + units: + $ref: "#/components/schemas/TimeMetricUnits" + title: Greater Than Time Threshold + Group: + type: object + properties: + clusterCount: + type: integer + format: int64 + description: Quantity of MongoDB Cloud clusters deployed in this project. + readOnly: true + created: + type: string + format: date-time + description: Date and time when MongoDB Cloud created this project. This + parameter expresses its value in the ISO 8601 timestamp format in UTC. + readOnly: true + id: + type: string + description: Unique 24-hexadecimal digit string that identifies the MongoDB + Cloud project. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + name: + type: string + description: Human-readable label that identifies the project included in + the MongoDB Cloud organization. + maxLength: 64 + minLength: 1 + pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + orgId: + type: string + description: Unique 24-hexadecimal digit string that identifies the MongoDB + Cloud organization to which the project belongs. + example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" @@ -34241,25 +36356,26 @@ components: maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" - readOnly: true destinationOrgPrivateApiKey: type: string - description: "Unique string that identifies the private part of the [API\ - \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) used\ - \ to verify access to the destination organization. This parameter is\ - \ required only when you authenticate with Programmatic API Keys." + description: Unique string that identifies the private part of the API Key + used to verify access to the destination organization. This parameter + is required only when you authenticate with Programmatic API Keys. example: 55c3bbb6-b4bb-0be1-e66d20841f3e - readOnly: true + externalDocs: + description: Grant Programmatic Access to Atlas + url: https://dochub.mongodb.org/core/atlas-create-prog-api-key destinationOrgPublicApiKey: type: string - description: "Unique string that identifies the public part of the [API\ - \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) used\ - \ to verify access to the destination organization. This parameter is\ - \ required only when you authenticate with Programmatic API Keys." + description: Unique string that identifies the public part of the API Key + used to verify access to the destination organization. This parameter + is required only when you authenticate with Programmatic API Keys. example: zmmrboas + externalDocs: + description: Grant Programmatic Access to Atlas + url: https://dochub.mongodb.org/core/atlas-create-prog-api-key maxLength: 8 minLength: 8 - readOnly: true GroupNotification: type: object description: Group notification configuration for MongoDB Cloud to send information @@ -34349,7 +36465,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/EventViewForNdsGroup" @@ -34397,6 +36513,33 @@ components: - GROUP_READ_ONLY - GROUP_SEARCH_INDEX_EDITOR - GROUP_STREAM_PROCESSING_OWNER + GroupRoleAssignment: + type: object + properties: + groupId: + type: string + description: Unique 24-hexadecimal digit string that identifies the project + to which these roles belong. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + groupRoles: + type: array + description: One or more project level roles assigned to the MongoDB Cloud + user. + items: + type: string + enum: + - GROUP_OWNER + - GROUP_CLUSTER_MANAGER + - GROUP_STREAM_PROCESSING_OWNER + - GROUP_DATA_ACCESS_ADMIN + - GROUP_DATA_ACCESS_READ_WRITE + - GROUP_DATA_ACCESS_READ_ONLY + - GROUP_READ_ONLY + - GROUP_SEARCH_INDEX_EDITOR + uniqueItems: true GroupService: type: object description: List of IP addresses in a project categorized by services. @@ -34412,26 +36555,26 @@ components: GroupServiceAccount: type: object properties: + clientId: + type: string + description: The Client ID of the Service Account. + pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" createdAt: type: string format: date-time - description: Service account creation time. + description: The date that the Service Account was created on. description: type: string - description: Description of the service account. - id: - type: string - description: ID for the service account. - pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" + description: Human readable description for the Service Account. name: type: string - description: Name for service account. + description: Human-readable name for the Service Account. roles: type: array - description: Roles assigned to the Service Account group. + description: A list of Project roles associated with the Service Account. items: type: string - description: Project roles associated with the service account. + description: Project roles available for Service Accounts. enum: - GROUP_OWNER - GROUP_READ_ONLY @@ -34444,7 +36587,7 @@ components: uniqueItems: true secrets: type: array - description: List of secrets. + description: A list of secrets associated with the specified Service Account. items: $ref: "#/components/schemas/ServiceAccountSecret" uniqueItems: true @@ -34453,23 +36596,23 @@ components: properties: description: type: string - description: Human readable description for the service account. + description: Human readable description for the Service Account. maxLength: 250 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" name: type: string - description: Human-readable name for the service account. The name is modifiable + description: Human-readable name for the Service Account. The name is modifiable and does not have to be unique. maxLength: 64 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" roles: type: array - description: Project roles associated with the service account. + description: A list of project-level roles for the Service Account. items: type: string - description: Project roles associated with the service account. + description: Project roles available for Service Accounts. enum: - GROUP_OWNER - GROUP_READ_ONLY @@ -34482,20 +36625,23 @@ components: secretExpiresAfterHours: type: integer format: int32 - description: Secret expiration time. + description: The expiration time of the new Service Account secret. The + expiration is provided in hours. required: - description - name + - roles - secretExpiresAfterHours GroupServiceAccountRoleAssignment: type: object properties: roles: type: array - description: Group access roles. + description: The Project permissions for the Service Account in the specified + Project. items: type: string - description: Project roles associated with the service account. + description: Project roles available for Service Accounts. enum: - GROUP_OWNER - GROUP_READ_ONLY @@ -34506,28 +36652,30 @@ components: - GROUP_SEARCH_INDEX_EDITOR - GROUP_STREAM_PROCESSING_OWNER uniqueItems: true + required: + - roles GroupServiceAccountUpdateRequest: type: object properties: description: type: string - description: Human readable description for the service account. + description: Human readable description for the Service Account. maxLength: 250 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" name: type: string - description: Human-readable name for the service account. The name is modifiable + description: Human-readable name for the Service Account. The name is modifiable and does not have to be unique. maxLength: 64 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" roles: type: array - description: Project roles associated with the service account. + description: A list of Project roles associated with the Service Account. items: type: string - description: Project roles associated with the service account. + description: Project roles available for Service Accounts. enum: - GROUP_OWNER - GROUP_READ_ONLY @@ -34791,7 +36939,7 @@ components: example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -34910,6 +37058,8 @@ components: - HOST_HAS_INDEX_SUGGESTIONS - HOST_MONGOT_RECOVERED_OOM - HOST_MONGOT_CRASHING_OOM + - HOST_MONGOT_RESUME_REPLICATION + - HOST_MONGOT_STOP_REPLICATION - HOST_ENOUGH_DISK_SPACE - HOST_NOT_ENOUGH_DISK_SPACE example: HOST_DOWN @@ -34921,6 +37071,7 @@ components: - HOST_DOWN - HOST_HAS_INDEX_SUGGESTIONS - HOST_MONGOT_CRASHING_OOM + - HOST_MONGOT_STOP_REPLICATION - HOST_NOT_ENOUGH_DISK_SPACE example: HOST_DOWN title: Host Event Types @@ -35217,6 +37368,7 @@ components: OPCOUNTER_REPL_INSERT: "#/components/schemas/RawMetricAlertView" OPCOUNTER_REPL_UPDATE: "#/components/schemas/RawMetricAlertView" OPCOUNTER_UPDATE: "#/components/schemas/RawMetricAlertView" + OPERATIONS_QUERIES_KILLED: "#/components/schemas/RawMetricAlertView" OPERATIONS_SCAN_AND_ORDER: "#/components/schemas/RawMetricAlertView" OPERATION_THROTTLING_REJECTED_OPERATIONS: "#/components/schemas/RawMetricAlertView" OPLOG_MASTER_LAG_TIME_DIFF: "#/components/schemas/TimeMetricAlertView" @@ -35291,7 +37443,7 @@ components: example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -35620,6 +37772,7 @@ components: OPCOUNTER_REPL_INSERT: "#/components/schemas/RawMetricEventView" OPCOUNTER_REPL_UPDATE: "#/components/schemas/RawMetricEventView" OPCOUNTER_UPDATE: "#/components/schemas/RawMetricEventView" + OPERATIONS_QUERIES_KILLED: "#/components/schemas/RawMetricEventView" OPERATIONS_SCAN_AND_ORDER: "#/components/schemas/RawMetricEventView" OPERATION_THROTTLING_REJECTED_OPERATIONS: "#/components/schemas/RawMetricEventView" OPLOG_MASTER_LAG_TIME_DIFF: "#/components/schemas/TimeMetricEventView" @@ -35925,6 +38078,7 @@ components: OPCOUNTER_REPL_INSERT: "#/components/schemas/RawMetricThresholdView" OPCOUNTER_REPL_UPDATE: "#/components/schemas/RawMetricThresholdView" OPCOUNTER_UPDATE: "#/components/schemas/RawMetricThresholdView" + OPERATIONS_QUERIES_KILLED: "#/components/schemas/RawMetricThresholdView" OPERATIONS_SCAN_AND_ORDER: "#/components/schemas/RawMetricThresholdView" OPERATION_THROTTLING_REJECTED_OPERATIONS: "#/components/schemas/RawMetricThresholdView" OPLOG_MASTER_LAG_TIME_DIFF: "#/components/schemas/TimeMetricThresholdView" @@ -35969,7 +38123,12 @@ components: enum: - AVERAGE operator: - $ref: "#/components/schemas/Operator" + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - LESS_THAN + - GREATER_THAN threshold: type: number format: double @@ -36446,7 +38605,7 @@ components: the charge. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -36882,6 +39041,21 @@ components: - ATLAS_AWS_STREAM_PROCESSING_DATA_TRANSFER - ATLAS_AZURE_STREAM_PROCESSING_DATA_TRANSFER - ATLAS_AWS_STREAM_PROCESSING_VPC_PEERING + - 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 readOnly: true startDate: type: string @@ -37207,6 +39381,371 @@ components: - REPLICASET - SHARDED - GEOSHARDED + configServerManagementMode: + type: string + default: ATLAS_MANAGED + description: |- + Config Server Management Mode for creating or updating a sharded cluster. + + When configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings. + + When configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server. + enum: + - ATLAS_MANAGED + - FIXED_TO_DEDICATED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + configServerType: + type: string + description: Describes a sharded cluster's config server type. + enum: + - DEDICATED + - EMBEDDED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + readOnly: true + connectionStrings: + $ref: "#/components/schemas/ClusterConnectionStrings" + createDate: + type: string + format: date-time + description: Date and time when MongoDB Cloud created this serverless instance. + MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. + readOnly: true + diskSizeGB: + type: number + format: double + 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." + maximum: 4096 + minimum: 10 + diskWarmingMode: + type: string + default: FULLY_WARMED + description: Disk warming mode selection. + enum: + - FULLY_WARMED + - VISIBLE_EARLIER + externalDocs: + description: Reduce Secondary Disk Warming Impact + url: https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact + encryptionAtRestProvider: + type: string + description: Cloud service provider that manages your customer keys to provide + an additional layer of Encryption at Rest for the cluster. + enum: + - NONE + - AWS + - AZURE + - GCP + externalDocs: + description: Encryption at Rest using Customer Key Management + url: https://www.mongodb.com/docs/atlas/security-kms-encryption/ + featureCompatibilityVersion: + type: string + description: Feature compatibility version of the cluster. + readOnly: true + featureCompatibilityVersionExpirationDate: + type: string + format: date-time + description: Feature compatibility version expiration date. + 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: + type: string + description: Unique 24-hexadecimal character string that identifies the + project. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + id: + type: string + description: Unique 24-hexadecimal digit string that identifies the cluster. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + labels: + type: array + deprecated: true + description: |- + Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels. + + Cluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead. + items: + $ref: "#/components/schemas/ComponentLabel" + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + 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- + mongoDBVersion: + type: string + description: Version of MongoDB that the cluster runs. + pattern: "([\\d]+\\.[\\d]+\\.[\\d]+)" + 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." + externalDocs: + description: Connection string URI format. + url: https://docs.mongodb.com/manual/reference/connection-string/ + readOnly: true + mongoURIUpdated: + type: string + format: date-time + description: Date and time when someone last updated the connection string. + MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. + readOnly: true + 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." + externalDocs: + description: Connection string URI format. + url: https://docs.mongodb.com/manual/reference/connection-string/ + readOnly: true + name: + type: string + description: Human-readable label that identifies the cluster. + maxLength: 64 + minLength: 1 + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + numShards: + type: integer + format: int32 + default: 1 + description: Number of shards up to 50 to deploy for a sharded cluster. + The resource returns `1` to indicate a replica set and values of `2` and + higher to indicate a sharded cluster. The returned value equals the number + of shards in the cluster. + externalDocs: + description: Sharding + url: https://docs.mongodb.com/manual/sharding/ + maximum: 50 + minimum: 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 + default: WORKLOAD_TYPE + description: |- + Set this field to configure the replica set scaling mode for your cluster. + + By default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes. + + When configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads. + + When configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads. + enum: + - SEQUENTIAL + - WORKLOAD_TYPE + - NODE_TYPE + externalDocs: + description: Modify the Replica Set Scaling Mode + url: https://dochub.mongodb.org/core/scale-nodes + replicationFactor: + type: integer + format: int32 + default: 3 + deprecated: true + description: "Number of members that belong to the replica set. Each member\ + \ retains a copy of your databases, providing high availability and data\ + \ redundancy. Use **replicationSpecs** instead." + enum: + - 3 + - 5 + - 7 + replicationSpec: + type: object + additionalProperties: + $ref: "#/components/schemas/RegionSpec" + description: Physical location where MongoDB Cloud provisions cluster nodes. + title: Region Configuration + 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. + items: + $ref: "#/components/schemas/LegacyReplicationSpec" + rootCertType: + type: string + default: ISRGROOTX1 + description: Root Certificate Authority that MongoDB Atlas clusters uses. + MongoDB Cloud supports Internet Security Research Group. + 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. + externalDocs: + description: Connection string URI format. + url: https://docs.mongodb.com/manual/reference/connection-string/ + readOnly: true + stateName: + type: string + description: Human-readable label that indicates the current operating condition + of the cluster. + enum: + - IDLE + - CREATING + - UPDATING + - DELETING + - REPAIRING + readOnly: true + tags: + type: array + description: List that contains key-value pairs between 1 to 255 characters + in length for tagging and categorizing the cluster. + externalDocs: + description: Resource Tags + url: https://dochub.mongodb.org/core/add-cluster-tag-atlas + items: + $ref: "#/components/schemas/ResourceTag" + terminationProtectionEnabled: + type: boolean + default: false + description: "Flag that indicates whether termination protection is enabled\ + \ on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster.\ + \ If set to `false`, MongoDB Cloud will delete the cluster." + versionReleaseSystem: + type: string + default: LTS + description: "Method by which the cluster maintains the MongoDB versions.\ + \ If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**." + enum: + - LTS + - CONTINUOUS + title: Cluster Description + LegacyAtlasTenantClusterUpgradeRequest: + type: object + description: Request containing target state of tenant cluster to be upgraded + properties: + acceptDataRisksAndForceReplicaSetReconfig: + type: string + format: date-time + description: "If reconfiguration is necessary to regain a primary due to\ + \ a regional outage, submit this field alongside your topology reconfiguration\ + \ to request a new regional outage resistant topology. Forced reconfigurations\ + \ during an outage of the majority of electable nodes carry a risk of\ + \ data loss if replicated writes (even majority committed writes) have\ + \ not been replicated to the new primary node. MongoDB Atlas docs contain\ + \ more information. To proceed with an operation which carries that risk,\ + \ set **acceptDataRisksAndForceReplicaSetReconfig** to the current date." + externalDocs: + description: Reconfiguring a Replica Set during a regional outage + url: https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set + 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 + default: ATLAS_MANAGED + description: |- + Config Server Management Mode for creating or updating a sharded cluster. + + When configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings. + + When configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server. + enum: + - ATLAS_MANAGED + - FIXED_TO_DEDICATED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + configServerType: + type: string + description: Describes a sharded cluster's config server type. + enum: + - DEDICATED + - EMBEDDED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + readOnly: true connectionStrings: $ref: "#/components/schemas/ClusterConnectionStrings" createDate: @@ -37251,6 +39790,15 @@ components: externalDocs: description: Encryption at Rest using Customer Key Management url: https://www.mongodb.com/docs/atlas/security-kms-encryption/ + featureCompatibilityVersion: + type: string + description: Feature compatibility version of the cluster. + readOnly: true + featureCompatibilityVersionExpirationDate: + type: string + format: date-time + description: Feature compatibility version expiration date. + readOnly: true globalClusterSelfManagedSharding: type: boolean description: |- @@ -37301,6 +39849,8 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true + mongoDBEmployeeAccessGrant: + $ref: "#/components/schemas/EmployeeAccessGrantView" mongoDBMajorVersion: type: string description: |- @@ -37347,7 +39897,7 @@ components: description: Human-readable label that identifies the cluster. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" numShards: type: integer format: int32 @@ -37379,292 +39929,24 @@ components: \ use MongoDB Cloud backups." providerSettings: $ref: "#/components/schemas/ClusterProviderSettings" - replicationFactor: - type: integer - format: int32 - default: 3 - deprecated: true - description: "Number of members that belong to the replica set. Each member\ - \ retains a copy of your databases, providing high availability and data\ - \ redundancy. Use **replicationSpecs** instead." - enum: - - 3 - - 5 - - 7 - replicationSpec: - type: object - additionalProperties: - $ref: "#/components/schemas/RegionSpec" - description: Physical location where MongoDB Cloud provisions cluster nodes. - title: Region Configuration - 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. - items: - $ref: "#/components/schemas/LegacyReplicationSpec" - rootCertType: - type: string - default: ISRGROOTX1 - description: Root Certificate Authority that MongoDB Atlas clusters uses. - MongoDB Cloud supports Internet Security Research Group. - 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. - externalDocs: - description: Connection string URI format. - url: https://docs.mongodb.com/manual/reference/connection-string/ - readOnly: true - stateName: - type: string - description: Human-readable label that indicates the current operating condition - of the cluster. - enum: - - IDLE - - CREATING - - UPDATING - - DELETING - - REPAIRING - readOnly: true - tags: - type: array - description: List that contains key-value pairs between 1 to 255 characters - in length for tagging and categorizing the cluster. - externalDocs: - description: Resource Tags - url: https://dochub.mongodb.org/core/add-cluster-tag-atlas - items: - $ref: "#/components/schemas/ResourceTag" - terminationProtectionEnabled: - type: boolean - default: false - description: "Flag that indicates whether termination protection is enabled\ - \ on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster.\ - \ If set to `false`, MongoDB Cloud will delete the cluster." - versionReleaseSystem: - type: string - default: LTS - description: "Method by which the cluster maintains the MongoDB versions.\ - \ If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**." - enum: - - LTS - - CONTINUOUS - title: Cluster Description - LegacyAtlasTenantClusterUpgradeRequest: - type: object - description: Request containing target state of tenant cluster to be upgraded - properties: - acceptDataRisksAndForceReplicaSetReconfig: - type: string - format: date-time - description: "If reconfiguration is necessary to regain a primary due to\ - \ a regional outage, submit this field alongside your topology reconfiguration\ - \ to request a new regional outage resistant topology. Forced reconfigurations\ - \ during an outage of the majority of electable nodes carry a risk of\ - \ data loss if replicated writes (even majority committed writes) have\ - \ not been replicated to the new primary node. MongoDB Atlas docs contain\ - \ more information. To proceed with an operation which carries that risk,\ - \ set **acceptDataRisksAndForceReplicaSetReconfig** to the current date." - externalDocs: - description: Reconfiguring a Replica Set during a regional outage - url: https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set - 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 - connectionStrings: - $ref: "#/components/schemas/ClusterConnectionStrings" - createDate: - type: string - format: date-time - description: Date and time when MongoDB Cloud created this serverless instance. - MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. - readOnly: true - diskSizeGB: - type: number - format: double - 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." - maximum: 4096 - minimum: 10 - diskWarmingMode: - type: string - default: FULLY_WARMED - description: Disk warming mode selection. - enum: - - FULLY_WARMED - - VISIBLE_EARLIER - externalDocs: - description: Reduce Secondary Disk Warming Impact - url: https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact - encryptionAtRestProvider: - type: string - description: Cloud service provider that manages your customer keys to provide - an additional layer of Encryption at Rest for the cluster. - enum: - - NONE - - AWS - - AZURE - - GCP - externalDocs: - description: Encryption at Rest using Customer Key Management - url: https://www.mongodb.com/docs/atlas/security-kms-encryption/ - 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: - type: string - description: Unique 24-hexadecimal character string that identifies the - project. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - id: + replicaSetScalingStrategy: type: string - description: Unique 24-hexadecimal digit string that identifies the cluster. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - labels: - type: array - deprecated: true + default: WORKLOAD_TYPE 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. + Set this field to configure the replica set scaling mode for your cluster. - Cluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead. - items: - $ref: "#/components/schemas/ComponentLabel" - links: - type: array - description: "List of one or more Uniform Resource Locators (URLs) that\ - \ point to API sub-resources, related API resources, or both. RFC 5988\ - \ outlines these relationships." - externalDocs: - description: Web Linking Specification (RFC 5988) - url: https://datatracker.ietf.org/doc/html/rfc5988 - items: - $ref: "#/components/schemas/Link" - readOnly: true - mongoDBMajorVersion: - type: string - description: |- - MongoDB major version of the cluster. + By default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes. - 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). + When configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads. - 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- - mongoDBVersion: - type: string - description: Version of MongoDB that the cluster runs. - pattern: "([\\d]+\\.[\\d]+\\.[\\d]+)" - 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." - externalDocs: - description: Connection string URI format. - url: https://docs.mongodb.com/manual/reference/connection-string/ - readOnly: true - mongoURIUpdated: - type: string - format: date-time - description: Date and time when someone last updated the connection string. - MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. - readOnly: true - 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." - externalDocs: - description: Connection string URI format. - url: https://docs.mongodb.com/manual/reference/connection-string/ - readOnly: true - name: - type: string - description: Human-readable label that identifies the cluster. - maxLength: 64 - minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - numShards: - type: integer - format: int32 - default: 1 - description: Number of shards up to 50 to deploy for a sharded cluster. - The resource returns `1` to indicate a replica set and values of `2` and - higher to indicate a sharded cluster. The returned value equals the number - of shards in the cluster. - externalDocs: - description: Sharding - url: https://docs.mongodb.com/manual/sharding/ - maximum: 50 - minimum: 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. + When configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads. + enum: + - SEQUENTIAL + - WORKLOAD_TYPE + - NODE_TYPE externalDocs: - description: 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" + description: Modify the Replica Set Scaling Mode + url: https://dochub.mongodb.org/core/scale-nodes replicationFactor: type: integer format: int32 @@ -38227,6 +40509,10 @@ components: - INSTANCE_NAME - PROCESSOR_NAME title: Streams Matcher Fields + - type: string + enum: + - RULE_ID + title: Log Ingestion Matcher Fields MatcherHostType: type: string description: Value to match or exceed using the specified **matchers.operator**. @@ -38941,6 +41227,7 @@ components: - 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 @@ -39018,6 +41305,8 @@ components: - 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 @@ -39047,6 +41336,9 @@ components: - 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 @@ -39105,9 +41397,13 @@ components: - 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 example: CLUSTER_CREATED title: NDS Audit Types NDSAuditTypeViewForOrg: @@ -40083,7 +42379,7 @@ components: example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -40342,7 +42638,12 @@ components: enum: - AVERAGE operator: - $ref: "#/components/schemas/Operator" + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - LESS_THAN + - GREATER_THAN threshold: type: number format: double @@ -40532,6 +42833,57 @@ components: required: - typeName title: OpsGenie Notification + OrgActiveUserResponse: + type: object + allOf: + - $ref: "#/components/schemas/OrgUserResponse" + - type: object + properties: + country: + type: string + description: Two alphabet characters that identifies MongoDB Cloud user's + geographic location. This parameter uses the ISO 3166-1a2 code format. + example: US + pattern: "^([A-Z]{2})$" + readOnly: true + createdAt: + type: string + format: date-time + description: Date and time when MongoDB Cloud created the current account. + This value is in the ISO 8601 timestamp format in UTC. + readOnly: true + firstName: + type: string + description: First or given name that belongs to the MongoDB Cloud user. + example: John + readOnly: true + lastAuth: + type: string + format: date-time + description: Date and time when the current account last authenticated. + This value is in the ISO 8601 timestamp format in UTC. + readOnly: true + lastName: + type: string + description: "Last name, family name, or surname that belongs to the MongoDB\ + \ Cloud user." + example: Doe + readOnly: true + mobileNumber: + type: string + description: Mobile phone number that belongs to the MongoDB Cloud user. + pattern: "(?:(?:\\\\+?1\\\\s*(?:[.-]\\\\s*)?)?(?:(\\\\s*([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9])\\\ + \\s*)|([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9]))\\\\s*(?:[.-]\\\\\ + s*)?)([2-9]1[02-9]|[2-9][02-9]1|[2-9][02-9]{2})\\\\s*(?:[.-]\\\\s*)?([0-9]{4})$" + readOnly: true + required: + - createdAt + - firstName + - id + - lastName + - orgMembershipStatus + - roles + - username OrgEventTypeViewForOrg: type: string description: Unique identifier of event type. @@ -40882,7 +43234,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/EventViewForOrg" @@ -40894,29 +43246,61 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true + OrgPendingUserResponse: + type: object + allOf: + - $ref: "#/components/schemas/OrgUserResponse" + - type: object + properties: + invitationCreatedAt: + type: string + format: date-time + description: Date and time when MongoDB Cloud sent the invitation. MongoDB + Cloud represents this timestamp in ISO 8601 format in UTC. + readOnly: true + invitationExpiresAt: + type: string + format: date-time + description: Date and time when the invitation from MongoDB Cloud expires. + MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. + readOnly: true + inviterUsername: + type: string + format: email + description: Username of the MongoDB Cloud user who sent the invitation + to join the organization. + readOnly: true + required: + - id + - invitationCreatedAt + - invitationExpiresAt + - inviterUsername + - orgMembershipStatus + - roles + - username OrgServiceAccount: type: object properties: + clientId: + type: string + description: The Client ID of the Service Account. + pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" createdAt: type: string format: date-time - description: Service account creation time. + description: The date that the Service Account was created on. description: type: string - description: Description of the service account. - id: - type: string - description: ID for the service account. - pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" + description: Human readable description for the Service Account. name: type: string - description: Name for service account. + description: Human-readable name for the Service Account. roles: type: array - description: Organization roles assigned to the Service Account. + description: A list of Organization roles associated with the Service Account. items: type: string - description: Organization roles associated with the service account. + description: Organization roles available for Service Accounts. enum: - ORG_MEMBER - ORG_READ_ONLY @@ -40927,7 +43311,7 @@ components: uniqueItems: true secrets: type: array - description: List of secrets. + description: A list of secrets associated with the specified Service Account. items: $ref: "#/components/schemas/ServiceAccountSecret" uniqueItems: true @@ -40936,23 +43320,23 @@ components: properties: description: type: string - description: Human readable description for the service account. + description: Human readable description for the Service Account. maxLength: 250 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" name: type: string - description: Human-readable name for the service account. The name is modifiable + description: Human-readable name for the Service Account. The name is modifiable and does not have to be unique. maxLength: 64 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" roles: type: array - description: Organization roles associated with the service account. + description: A list of organization-level roles for the Service Account. items: type: string - description: Organization roles associated with the service account. + description: Organization roles available for Service Accounts. enum: - ORG_MEMBER - ORG_READ_ONLY @@ -40963,33 +43347,35 @@ components: secretExpiresAfterHours: type: integer format: int32 - description: Secret expiration time. + description: The expiration time of the new Service Account secret. The + expiration is provided in hours. required: - description - name + - roles - secretExpiresAfterHours OrgServiceAccountUpdateRequest: type: object properties: description: type: string - description: Human readable description for the service account. + description: Human readable description for the Service Account. maxLength: 250 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" name: type: string - description: Human-readable name for the service account. The name is modifiable + description: Human-readable name for the Service Account. The name is modifiable and does not have to be unique. maxLength: 64 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" roles: type: array - description: Organization roles associated with the Service account. + description: A list of organization-level roles for the Service Account. items: type: string - description: Organization roles associated with the service account. + description: Organization roles available for Service Accounts. enum: - ORG_MEMBER - ORG_READ_ONLY @@ -40997,6 +43383,158 @@ components: - ORG_BILLING_READ_ONLY - ORG_GROUP_CREATOR - ORG_OWNER + OrgUserRequest: + type: object + properties: + roles: + $ref: "#/components/schemas/OrgUserRolesRequest" + teamIds: + type: array + description: List of unique 24-hexadecimal digit strings that identifies + the teams to which this MongoDB Cloud user belongs. + items: + type: string + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + uniqueItems: true + writeOnly: true + username: + type: string + format: email + description: Email address that represents the username of the MongoDB Cloud + user. + writeOnly: true + required: + - roles + - username + OrgUserResponse: + type: object + discriminator: + mapping: + ACTIVE: "#/components/schemas/OrgActiveUserResponse" + PENDING: "#/components/schemas/OrgPendingUserResponse" + propertyName: orgMembershipStatus + oneOf: + - $ref: "#/components/schemas/OrgPendingUserResponse" + - $ref: "#/components/schemas/OrgActiveUserResponse" + properties: + id: + type: string + description: Unique 24-hexadecimal digit string that identifies the MongoDB + Cloud user. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + orgMembershipStatus: + type: string + description: String enum that indicates whether the MongoDB Cloud user has + a pending invitation to join the organization or they are already active + in the organization. + enum: + - PENDING + - ACTIVE + readOnly: true + roles: + $ref: "#/components/schemas/OrgUserRolesResponse" + teamIds: + type: array + description: List of unique 24-hexadecimal digit strings that identifies + the teams to which this MongoDB Cloud user belongs. + items: + type: string + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + uniqueItems: true + username: + type: string + format: email + description: Email address that represents the username of the MongoDB Cloud + user. + readOnly: true + required: + - id + - orgMembershipStatus + - roles + - username + OrgUserRolesRequest: + type: object + description: Organization and project level roles to assign the MongoDB Cloud + user within one organization. + properties: + groupRoleAssignments: + type: array + description: List of project level role assignments to assign the MongoDB + Cloud user. + items: + $ref: "#/components/schemas/GroupRoleAssignment" + orgRoles: + type: array + description: One or more organization level roles to assign the MongoDB + Cloud user. + items: + type: string + enum: + - ORG_OWNER + - ORG_GROUP_CREATOR + - ORG_BILLING_ADMIN + - ORG_BILLING_READ_ONLY + - ORG_READ_ONLY + - ORG_MEMBER + minItems: 1 + uniqueItems: true + required: + - orgRoles + writeOnly: true + OrgUserRolesResponse: + type: object + description: Organization and project level roles assigned to one MongoDB Cloud + user within one organization. + properties: + groupRoleAssignments: + type: array + description: List of project level role assignments assigned to the MongoDB + Cloud user. + items: + $ref: "#/components/schemas/GroupRoleAssignment" + orgRoles: + type: array + description: One or more organization level roles assigned to the MongoDB + Cloud user. + items: + type: string + enum: + - ORG_OWNER + - ORG_GROUP_CREATOR + - ORG_BILLING_ADMIN + - ORG_BILLING_READ_ONLY + - ORG_READ_ONLY + - ORG_MEMBER + uniqueItems: true + readOnly: true + OrgUserUpdateRequest: + type: object + properties: + roles: + $ref: "#/components/schemas/OrgUserRolesRequest" + teamIds: + type: array + description: List of unique 24-hexadecimal digit strings that identifies + the teams to assign the MongoDB Cloud user. + items: + type: string + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + uniqueItems: true + writeOnly: true OrganizationInvitation: type: object properties: @@ -41208,10 +43746,11 @@ components: restrictEmployeeAccess: type: boolean description: "Flag that indicates whether to block MongoDB Support from\ - \ accessing Atlas infrastructure 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/." + \ 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/." OutboundControlPlaneCloudProviderIPAddresses: type: object description: "List of outbound IP addresses from the Atlas control plane, categorized\ @@ -41384,7 +43923,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/AdvancedClusterDescription" @@ -41412,7 +43951,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/GroupAlertsConfig" @@ -41440,7 +43979,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/AlertViewForNdsGroup" @@ -41468,7 +44007,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ApiKeyUserDetails" @@ -41496,7 +44035,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/CloudAppUser" @@ -41524,7 +44063,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ApiAtlasCheckpointView" @@ -41554,7 +44093,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/CloudDatabaseUser" @@ -41582,7 +44121,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/DiskBackupExportJob" @@ -41610,7 +44149,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/EARPrivateEndpoint" @@ -41622,7 +44161,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedApiAtlasProviderRegionsView: + PaginatedApiAtlasFlexBackupRestoreJob20250101View: type: object properties: links: @@ -41638,10 +44177,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/CloudProviderRegions" + $ref: "#/components/schemas/FlexBackupRestoreJob20250101" readOnly: true totalCount: type: integer @@ -41650,7 +44189,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedApiAtlasServerlessBackupRestoreJobView: + PaginatedApiAtlasFlexBackupSnapshot20240710View: type: object properties: links: @@ -41666,10 +44205,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/ServerlessBackupRestoreJob" + $ref: "#/components/schemas/FlexBackupSnapshot20250101" readOnly: true totalCount: type: integer @@ -41678,7 +44217,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedApiAtlasServerlessBackupSnapshotView: + PaginatedApiAtlasProviderRegionsView: type: object properties: links: @@ -41694,10 +44233,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/ServerlessBackupSnapshot" + $ref: "#/components/schemas/CloudProviderRegions" readOnly: true totalCount: type: integer @@ -41706,7 +44245,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedApiAtlasUSSBackupRestoreJob20250101View: + PaginatedApiAtlasServerlessBackupRestoreJobView: type: object properties: links: @@ -41722,10 +44261,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/USSBackupRestoreJob20250101" + $ref: "#/components/schemas/ServerlessBackupRestoreJob" readOnly: true totalCount: type: integer @@ -41734,7 +44273,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedApiAtlasUSSBackupSnapshot20240710View: + PaginatedApiAtlasServerlessBackupSnapshotView: type: object properties: links: @@ -41750,10 +44289,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/USSBackupSnapshot20250101" + $ref: "#/components/schemas/ServerlessBackupSnapshot" readOnly: true totalCount: type: integer @@ -41778,7 +44317,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/BillingInvoiceMetadata" @@ -41806,7 +44345,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/BillingInvoice" @@ -41834,7 +44373,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/StreamsConnection" @@ -41846,6 +44385,34 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true + PaginatedApiStreamsPrivateLinkView: + type: object + properties: + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + results: + type: array + description: List of returned documents that MongoDB Cloud provides when + completing this request. + items: + $ref: "#/components/schemas/StreamsPrivateLinkConnection" + readOnly: true + totalCount: + type: integer + format: int32 + description: Total number of documents available. MongoDB Cloud omits this + value if `includeCount` is set to `false`. + minimum: 0 + readOnly: true PaginatedApiStreamsStreamProcessorWithStatsView: type: object properties: @@ -41862,7 +44429,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/StreamsProcessorWithStats" @@ -41890,7 +44457,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/StreamsTenant" @@ -41918,7 +44485,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/UserAccessListResponse" @@ -41930,6 +44497,34 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true + PaginatedApiVersions: + type: object + properties: + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + results: + type: array + description: List of returned documents that MongoDB Cloud provides when + completing this request. + items: + $ref: "#/components/schemas/ApiVersion" + readOnly: true + totalCount: + type: integer + format: int32 + description: Total number of documents available. MongoDB Cloud omits this + value if `includeCount` is set to `false`. + minimum: 0 + readOnly: true PaginatedAppUserView: type: object properties: @@ -41946,7 +44541,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/CloudAppUser" @@ -41974,7 +44569,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/Group" @@ -42002,7 +44597,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/MdbAvailableVersion" @@ -42030,7 +44625,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/DiskBackupSnapshotAWSExportBucket" @@ -42058,7 +44653,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/DiskBackupSnapshotExportBucket" @@ -42086,7 +44681,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/DiskBackupSnapshot" @@ -42114,7 +44709,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/DiskBackupReplicaSet" @@ -42142,7 +44737,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/DiskBackupSnapshotRestoreJob" @@ -42170,7 +44765,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/DiskBackupShardedClusterSnapshot" @@ -42199,7 +44794,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/CloudProviderContainer" @@ -42228,7 +44823,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ClusterDescription20240805" @@ -42256,7 +44851,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ConnectedOrgConfig" @@ -42285,7 +44880,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/BaseNetworkPeeringConnectionSettings" @@ -42313,7 +44908,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/MesurementsDatabase" @@ -42341,7 +44936,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/MeasurementDiskPartition" @@ -42369,7 +44964,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/EventTypeDetails" @@ -42397,7 +44992,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/FederationIdentityProvider" @@ -42409,9 +45004,37 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true + PaginatedFlexClusters20250101: + type: object + properties: + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + results: + type: array + description: List of returned documents that MongoDB Cloud provides when + completing this request. + items: + type: object + readOnly: true + totalCount: + type: integer + format: int32 + description: Total number of documents available. MongoDB Cloud omits this + value if `includeCount` is set to `false`. + minimum: 0 + readOnly: true PaginatedGroupServiceAccounts: type: object - description: List of Service Accounts + description: A list of Project Service Accounts. properties: links: type: array @@ -42426,7 +45049,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/GroupServiceAccount" @@ -42454,7 +45077,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ApiHostView_Atlas" @@ -42482,7 +45105,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ThirdPartyIntegration" @@ -42510,7 +45133,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/LegacyAtlasCluster" @@ -42538,7 +45161,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/NetworkPermissionEntry" @@ -42566,7 +45189,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/BackupOnlineArchive" @@ -42594,7 +45217,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/OrgGroup" @@ -42608,7 +45231,7 @@ components: readOnly: true PaginatedOrgServiceAccounts: type: object - description: List of Service Accounts + description: A list of Organization Service Accounts. properties: links: type: array @@ -42623,7 +45246,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/OrgServiceAccount" @@ -42651,7 +45274,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/AtlasOrganization" @@ -42679,7 +45302,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/IngestionPipelineRun" @@ -42707,7 +45330,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/PrivateNetworkEndpointIdEntry" @@ -42735,7 +45358,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/PublicApiUsageDetailsLineItemView" @@ -42763,7 +45386,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/BackupRestoreJob" @@ -42793,7 +45416,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/AuthFederationRoleMapping" @@ -42821,7 +45444,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ServerlessInstanceDescription" @@ -42835,7 +45458,7 @@ components: readOnly: true PaginatedServiceAccountGroup: type: object - description: List of Service Account projects. + description: A list of projects associated with the Service Account. properties: links: type: array @@ -42850,7 +45473,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ServiceAccountGroup" @@ -42862,7 +45485,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedSnapshotView: + PaginatedServiceAccountIPAccessEntryView: type: object properties: links: @@ -42878,10 +45501,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/BackupSnapshot" + $ref: "#/components/schemas/ServiceAccountIPAccessListEntry" readOnly: true totalCount: type: integer @@ -42890,7 +45513,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedTeamRoleView: + PaginatedSnapshotView: type: object properties: links: @@ -42906,10 +45529,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/TeamRole" + $ref: "#/components/schemas/BackupSnapshot" readOnly: true totalCount: type: integer @@ -42918,7 +45541,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedTeamView: + PaginatedTeamRoleView: type: object properties: links: @@ -42934,10 +45557,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/TeamResponse" + $ref: "#/components/schemas/TeamRole" readOnly: true totalCount: type: integer @@ -42946,7 +45569,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedTenantRestoreView: + PaginatedTeamView: type: object properties: links: @@ -42962,10 +45585,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/TenantRestore" + $ref: "#/components/schemas/TeamResponse" readOnly: true totalCount: type: integer @@ -42974,7 +45597,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedTenantSnapshotView: + PaginatedTenantRestoreView: type: object properties: links: @@ -42990,10 +45613,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/BackupTenantSnapshot" + $ref: "#/components/schemas/TenantRestore" readOnly: true totalCount: type: integer @@ -43002,7 +45625,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedUSSInstance20250101: + PaginatedTenantSnapshotView: type: object properties: links: @@ -43018,10 +45641,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - type: object + $ref: "#/components/schemas/BackupTenantSnapshot" readOnly: true totalCount: type: integer @@ -43046,7 +45669,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/UserCert" @@ -43534,6 +46157,13 @@ components: PrivateNetworkEndpointIdEntry: type: object properties: + azureConnectionName: + type: string + description: Connection name that identifies the Azure private endpoint + connection. + 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. @@ -43541,6 +46171,10 @@ components: type: string description: Human-readable label to identify customer's VPC endpoint DNS name. + customerEndpointIPAddress: + type: string + description: IP address used to connect to the Azure private endpoint. + pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" endpointId: type: string description: Unique 22-character alphanumeric string that identifies the @@ -43553,6 +46187,10 @@ components: maxLength: 22 minLength: 22 pattern: "^vpce-[0-9a-f]{17}$" + errorMessage: + type: string + description: Error message describing a failure approving the private endpoint + request. provider: type: string default: AWS @@ -43564,6 +46202,14 @@ components: type: string description: Human-readable label to identify the region of customer's VPC endpoint. + status: + type: string + description: Status of the private endpoint connection request. + enum: + - PENDING + - OK + - FAILED + - DELETING type: type: string default: DATA_LAKE @@ -43633,16 +46279,6 @@ components: - serviceDiscovery - username title: PROMETHEUS - ProxyInfo: - type: object - description: VPC Proxy Information. - properties: - authKey: - type: string - description: Authentication key for the proxy. - dnsName: - type: string - description: DNS name to use to reach the proxy/s. PublicApiUsageDetailsLineItemView: type: object properties: @@ -43734,7 +46370,12 @@ components: enum: - AVERAGE operator: - $ref: "#/components/schemas/Operator" + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - LESS_THAN + - GREATER_THAN threshold: type: number format: double @@ -43785,7 +46426,7 @@ components: example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -44044,7 +46685,12 @@ components: enum: - AVERAGE operator: - $ref: "#/components/schemas/Operator" + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - LESS_THAN + - GREATER_THAN threshold: type: number format: double @@ -44234,7 +46880,7 @@ components: example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -45035,7 +47681,7 @@ components: you loaded the sample dataset. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true completeDate: type: string @@ -45849,7 +48495,7 @@ components: \ this parameter when `\"deliveryType\" : \"download\"`." items: type: string - description: One Uniform Resource Locator that point to the compressed + description: One Uniform Resource Locator that points to the compressed snapshot files for manual download. readOnly: true desiredTimestamp: @@ -45936,7 +48582,7 @@ components: parameter when `"deliveryType":` `"automated"`. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" targetGroupId: type: string description: Unique 24-hexadecimal digit string that identifies the target @@ -46011,7 +48657,7 @@ components: which MongoDB Cloud took this snapshot. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true snapshotType: type: string @@ -46143,7 +48789,7 @@ components: description: Human-readable label that identifies the serverless instance. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" providerSettings: $ref: "#/components/schemas/ServerlessProviderSettings" serverlessBackupOptions: @@ -46212,7 +48858,7 @@ components: description: Human-readable label that identifies the serverless instance. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" writeOnly: true providerSettings: $ref: "#/components/schemas/ServerlessProviderSettings" @@ -46376,7 +49022,12 @@ components: enum: - AVERAGE operator: - $ref: "#/components/schemas/Operator" + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - LESS_THAN + - GREATER_THAN threshold: type: number format: double @@ -46586,7 +49237,11 @@ components: properties: groupId: type: string - description: Unique 24-hexadecimal digit string that identifies the project. + description: "Unique 24-hexadecimal digit string that identifies your project.\ + \ **NOTE**: Groups and projects are synonymous terms. Your group id is\ + \ the same as your project id. For existing groups, your group/project\ + \ id remains the same. The resource and corresponding endpoints use the\ + \ term groups." example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 @@ -46699,6 +49354,54 @@ components: - eventTypeName - id title: ServiceAccount Events + ServiceAccountIPAccessListEntry: + type: object + properties: + cidrBlock: + type: string + description: "Range of network addresses in the access list for the Service\ + \ Account. This parameter requires the range to be expressed in Classless\ + \ Inter-Domain Routing (CIDR) notation of Internet Protocol version 4\ + \ or version 6 addresses. You can set a value for this parameter or **ipAddress**,\ + \ but not for both in the same request." + example: 203.0.113.0/24 + pattern: "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + createdAt: + type: string + format: date-time + description: Date MongoDB Cloud added the entry was added to the Access + List. + readOnly: true + ipAddress: + type: string + description: "Network address in the access list for the Service Account.\ + \ This parameter requires the address to be expressed as one Internet\ + \ Protocol version 4 or version 6 address. You can set a value for this\ + \ parameter or **cidrBlock**, but not for both in the same request." + example: 203.0.113.10 + pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + 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 makes at least one request. + readOnly: true + lastUsedAt: + type: string + format: date-time + description: "Date when MongoDB Cloud received the most recent request that\ + \ originated from this Internet Protocol version 4 or version 6 address.\ + \ The resource returns this parameter when at least one request originates\ + \ from this IP address. MongoDB Cloud updates this parameter each time\ + \ a client accesses the permitted resource, with a delay of up to 5 minutes." + readOnly: true + requestCount: + type: integer + format: int32 + description: The number of requests that has originated from this network + address. + readOnly: true ServiceAccountOrgEvents: type: object description: Service Account event identifies different activities around user @@ -46812,35 +49515,34 @@ components: createdAt: type: string format: date-time - description: Timestamp representing creation time. + description: The date that the secret was created on. readOnly: true expiresAt: type: string format: date-time - description: Timestamp representing secret expiration time. + description: The date for the expiration of the secret. readOnly: true id: type: string - description: Unique 24-hexadecimal character string that identifies the - secret. + description: Unique 24-hexadecimal digit string that identifies the secret. example: 32b6e34b3d91647abb20e7b8 pattern: "^([a-f0-9]{24})$" readOnly: true lastUsedAt: type: string format: date-time - description: Timestamp representing last secret usage. + description: The last time the secret was used. readOnly: true maskedSecretValue: type: string - description: Service Account secret with masked values of the first 20 characters. + description: The masked Service Account secret. example: mdb_ic_sk_...12ce readOnly: true secret: type: string - description: Secret for the service account. It will be returned only the - first time after service account creation. - pattern: "^mdb_sa_sk_[0-9a-zA-Z]{40}$" + description: The secret for the Service Account. It will be returned only + the first time after creation. + pattern: "^mdb_sa_sk_[0-9a-zA-Z_-]{40}$" readOnly: true required: - createdAt @@ -46852,7 +49554,8 @@ components: secretExpiresAfterHours: type: integer format: int32 - description: Number of hours representing validity duration for secret. + description: The expiration time of the new Service Account secret. The + expiration is provided in hours. required: - secretExpiresAfterHours ShardEntry: @@ -47475,17 +50178,19 @@ components: StreamsDLQ: type: object description: Dead letter queue for the stream processor. + externalDocs: + url: https://www.mongodb.com/docs/atlas/reference/glossary/#std-term-dead-letter-queue properties: coll: type: string - description: Name of the collection that will be used for the DLQ. + description: Name of the collection to use for the DLQ. connectionName: type: string - description: Connection name that will be used to write DLQ messages to. - Has to be an Atlas connection. + description: Name of the connection to write DLQ messages to. Must be an + Atlas connection. db: type: string - description: Name of the database that will be used for the DLQ. + description: Name of the database to use for the DLQ. links: type: array description: "List of one or more Uniform Resource Locators (URLs) that\ @@ -47654,8 +50359,6 @@ components: group.protocol.type: consumer networking: $ref: "#/components/schemas/StreamsKafkaNetworking" - proxyInfo: - $ref: "#/components/schemas/ProxyInfo" security: $ref: "#/components/schemas/StreamsKafkaSecurity" StreamsKafkaNetworking: @@ -47681,6 +50384,13 @@ components: type: object description: Information about the networking access. properties: + connectionId: + type: string + description: Reserved. Will be used by PRIVATE_LINK connection type. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" links: type: array description: "List of one or more Uniform Resource Locators (URLs) that\ @@ -47694,14 +50404,18 @@ components: readOnly: true name: type: string - description: Id of the vpc peer when the type is VPC. + description: Reserved. Will be used by PRIVATE_LINK connection type. type: type: string - description: Selected networking type. Either PUBLIC or VPC. Defaults to - PUBLIC + description: "Selected networking type. Either PUBLIC, VPC or PRIVATE_LINK.\ + \ Defaults to PUBLIC. For VPC, ensure that VPC peering exists and connectivity\ + \ has been established between Atlas VPC and the VPC where Kafka cluster\ + \ is hosted for the connection to function properly. PRIVATE_LINK support\ + \ is coming soon." enum: - PUBLIC - VPC + - PRIVATE_LINK title: Networking Access Type StreamsKafkaSecurity: type: object @@ -47780,6 +50494,52 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true + StreamsPrivateLinkConnection: + type: object + description: Container for metadata needed to create a Private Link connection. + properties: + _id: + type: string + description: The ID of the Private Link connection. + dnsDomain: + type: string + description: Domain name of Confluent cluster. + dnsSubDomain: + type: array + description: Sub-Domain name of Confluent cluster. These are typically your + availability zones. + items: + type: string + interfaceEndpointId: + type: string + description: Interface endpoint ID that is created from the service endpoint + ID provided. + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + provider: + type: string + description: Provider where the Kafka cluster is deployed. + region: + type: string + description: Domain name of Confluent cluster. + serviceEndpointId: + type: string + description: AWS Service Endpoint ID. + state: + type: string + description: State the connection is in. + vendor: + type: string + description: Vendor who manages the Kafka cluster. StreamsProcessor: type: object description: An atlas stream processor. @@ -47813,6 +50573,9 @@ components: type: array description: Stream aggregation pipeline you want to apply to your streaming data. + externalDocs: + description: Supported Aggregation Pipeline Stages + url: https://www.mongodb.com/docs/atlas/atlas-stream-processing/stream-aggregation/#std-label-stream-aggregation items: $ref: "#/components/schemas/Document" StreamsProcessorWithStats: @@ -47843,6 +50606,8 @@ components: type: string description: Human-readable name of the stream processor. readOnly: true + options: + $ref: "#/components/schemas/StreamsOptions" pipeline: type: array description: Stream aggregation pipeline you want to apply to your streaming @@ -47852,15 +50617,20 @@ components: readOnly: true state: type: string - description: The state of the stream processor. + description: "The state of the stream processor. Commonly occurring states\ + \ are 'CREATED', 'STARTED', 'STOPPED' and 'FAILED'." readOnly: true stats: type: object additionalProperties: type: object description: The stats associated with the stream processor. + externalDocs: + url: https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor readOnly: true description: The stats associated with the stream processor. + externalDocs: + url: https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor readOnly: true required: - _id @@ -47871,6 +50641,26 @@ components: type: object allOf: - $ref: "#/components/schemas/StreamsConnection" + StreamsSampleConnections: + type: object + description: Sample connections to add to SPI. + properties: + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + solar: + type: boolean + default: false + description: Flag that indicates whether to add a 'sample_stream_solar' + connection. StreamsTenant: type: object properties: @@ -47922,6 +50712,8 @@ components: name: type: string description: Human-readable label that identifies the stream instance. + sampleConnections: + $ref: "#/components/schemas/StreamsSampleConnections" streamConfig: $ref: "#/components/schemas/StreamConfig" SummaryNotification: @@ -48582,7 +51374,7 @@ components: description: Human-readable label that identifies the source cluster. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true deliveryType: type: string @@ -48692,6 +51484,8 @@ components: required: - snapshotId - targetDeploymentItemName + TenantWithSampleConnections: + type: object TextSearchHostStatusDetail: type: object properties: @@ -48908,808 +51702,199 @@ components: type: array description: List of documents detailing index status on each host. items: - $ref: "#/components/schemas/TextSearchHostStatusDetail" - synonymMappingStatus: - type: string - description: Status that describes this index's synonym mappings. This - status appears only if the index has synonyms defined. - enum: - - FAILED - - BUILDING - - READY - synonymMappingStatusDetail: - type: array - description: A list of documents describing the status of the index's - synonym mappings on each search host. Only appears if the index has - synonyms defined. - items: - type: object - additionalProperties: - $ref: "#/components/schemas/SynonymMappingStatusDetail" - title: Text Search Index Response - TextSearchIndexStatusDetail: - type: object - description: Contains status information about a text search index. - properties: - definition: - $ref: "#/components/schemas/TextSearchIndexDefinition" - definitionVersion: - $ref: "#/components/schemas/SearchIndexDefinitionVersion" - message: - type: string - description: Optional message describing an error. - queryable: - type: boolean - description: Flag that indicates whether the index generation is queryable - on the host. - status: - type: string - description: | - Condition of the search index when you made this request. - - | Status | Index Condition | - |---|---| - | DELETING | The index is being deleted. | - | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. | - | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. | - | PENDING | Atlas has not yet started building the index. | - | BUILDING | Atlas is building or re-building the index after an edit. | - | READY | The index is ready and can support queries. | - enum: - - DELETING - - FAILED - - STALE - - PENDING - - BUILDING - - READY - - DOES_NOT_EXIST - synonymMappingStatus: - type: string - description: Status that describes this index's synonym mappings. This status - appears only if the index has synonyms defined. - enum: - - FAILED - - BUILDING - - READY - synonymMappingStatusDetail: - type: array - description: List of synonym statuses by mapping. - items: - $ref: "#/components/schemas/SynonymMappingStatusDetailMap" - title: Text Search Index Status Detail - ThirdPartyIntegration: - type: object - description: Collection of settings that describe third-party integrations. - discriminator: - mapping: - DATADOG: "#/components/schemas/Datadog" - MICROSOFT_TEAMS: "#/components/schemas/MicrosoftTeams" - NEW_RELIC: "#/components/schemas/NewRelic" - OPS_GENIE: "#/components/schemas/OpsGenie" - PAGER_DUTY: "#/components/schemas/PagerDuty" - PROMETHEUS: "#/components/schemas/Prometheus" - SLACK: "#/components/schemas/Slack" - VICTOR_OPS: "#/components/schemas/VictorOps" - WEBHOOK: "#/components/schemas/Webhook" - propertyName: type - properties: - id: - type: string - description: Integration id. - nullable: true - type: - type: string - description: Integration type - enum: - - PAGER_DUTY - - SLACK - - DATADOG - - NEW_RELIC - - OPS_GENIE - - VICTOR_OPS - - WEBHOOK - - HIP_CHAT - - PROMETHEUS - - MICROSOFT_TEAMS - title: Integration Type - title: Third-Party Integration - TimeMetricAlertView: - type: object - properties: - acknowledgedUntil: - type: string - format: date-time - description: |- - Date and time until which this alert has been acknowledged. This parameter expresses its value in the 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. - acknowledgementComment: - type: string - description: Comment that a MongoDB Cloud user submitted when acknowledging - the alert. - example: Expiration on 3/19. Silencing for 7days. - maxLength: 200 - acknowledgingUsername: - type: string - format: email - description: MongoDB Cloud username of the person who acknowledged the alert. - The response returns this parameter if a MongoDB Cloud user previously - acknowledged this alert. - readOnly: true - alertConfigId: - type: string - description: Unique 24-hexadecimal digit string that identifies the alert - configuration that sets this alert. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - clusterName: - 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." - example: cluster1 - maxLength: 64 - minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - readOnly: true - created: - type: string - format: date-time - description: Date and time when MongoDB Cloud created this alert. This parameter - expresses its value in the ISO 8601 timestamp format - in UTC. - readOnly: true - currentValue: - $ref: "#/components/schemas/TimeMetricValueView" - eventTypeName: - $ref: "#/components/schemas/HostMetricEventTypeViewAlertable" - groupId: - type: string - description: Unique 24-hexadecimal digit string that identifies the project - that owns this alert. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - 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. - example: cloud-test.mongodb.com:27017 - readOnly: true - id: - type: string - description: Unique 24-hexadecimal digit string that identifies this alert. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - lastNotified: - type: string - format: date-time - description: Date and time that any notifications were last sent for this - alert. This parameter expresses its value in the ISO 8601 timestamp format - in UTC. The resource returns this parameter if MongoDB Cloud has sent - notifications for this alert. - readOnly: true - links: - type: array - description: "List of one or more Uniform Resource Locators (URLs) that\ - \ point to API sub-resources, related API resources, or both. RFC 5988\ - \ outlines these relationships." - externalDocs: - description: Web Linking Specification (RFC 5988) - url: https://datatracker.ietf.org/doc/html/rfc5988 - items: - $ref: "#/components/schemas/Link" - readOnly: true - 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. - example: ASSERT_USER - readOnly: true - orgId: - type: string - description: Unique 24-hexadecimal character string that identifies the - organization that owns the project to which this alert applies. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - 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." - example: event-replica-set - readOnly: true - resolved: - type: string - format: date-time - description: "Date and time that this alert changed to `\"status\" : \"\ - CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp\ - \ format in UTC. The resource returns this parameter once `\"status\"\ - \ : \"CLOSED\"`." - readOnly: true - status: - type: string - description: State of this alert at the time you requested its details. - enum: - - CANCELLED - - CLOSED - - OPEN - - TRACKING - example: OPEN - readOnly: true - updated: - type: string - format: date-time - description: Date and time when someone last updated this alert. This parameter - expresses its value in the ISO 8601 timestamp format - in UTC. - readOnly: true - required: - - alertConfigId - - created - - eventTypeName - - id - - status - - updated - TimeMetricEventView: - type: object - properties: - apiKeyId: - type: string - description: "Unique 24-hexadecimal digit string that identifies the [API\ - \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\ - \ triggered the event. If this resource returns this parameter, it doesn't\ - \ return the **userId** parameter." - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - created: - type: string - format: date-time - description: Date and time when this event occurred. This parameter expresses - its value in the ISO 8601 timestamp format in UTC. - readOnly: true - currentValue: - $ref: "#/components/schemas/TimeMetricValueView" - eventTypeName: - $ref: "#/components/schemas/HostMetricEventTypeView" - groupId: - type: string - description: Unique 24-hexadecimal digit string that identifies the project - in which the event occurred. The **eventId** identifies the specific event. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - id: - type: string - description: Unique 24-hexadecimal digit string that identifies the event. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - isGlobalAdmin: - type: boolean - default: false - description: Flag that indicates whether a MongoDB employee triggered the - specified event. - readOnly: true - links: - type: array - description: "List of one or more Uniform Resource Locators (URLs) that\ - \ point to API sub-resources, related API resources, or both. RFC 5988\ - \ outlines these relationships." - externalDocs: - description: Web Linking Specification (RFC 5988) - url: https://datatracker.ietf.org/doc/html/rfc5988 - items: - $ref: "#/components/schemas/Link" - readOnly: true - 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: - type: string - description: Unique 24-hexadecimal digit string that identifies the organization - to which these events apply. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - port: - type: integer - format: int32 - description: IANA port on which the MongoDB process listens for requests. - example: 27017 - readOnly: true - publicKey: - type: string - format: email - description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\ - \ that triggered the event. If this resource returns this parameter, it\ - \ doesn't return the **username** parameter." - example: test.user@mongodb.com - readOnly: true - raw: - $ref: "#/components/schemas/raw" - remoteAddress: - type: string - description: IPv4 or IPv6 address from which the user triggered this event. - example: 216.172.40.186 - pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" - readOnly: true - replicaSetName: - type: string - description: Human-readable label of the replica set associated with the - event. - example: event-replica-set - readOnly: true - shardName: - type: string - description: Human-readable label of the shard associated with the event. - example: event-sh-01 - readOnly: true - userId: - type: string - description: "Unique 24-hexadecimal digit string that identifies the console\ - \ user who triggered the event. If this resource returns this parameter,\ - \ it doesn't return the **apiKeyId** parameter." - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - username: - type: string - format: email - description: "Email address for the user who triggered this event. If this\ - \ resource returns this parameter, it doesn't return the **publicApiKey**\ - \ parameter." - example: test.user@mongodb.com - readOnly: true - required: - - created - - eventTypeName - - id - TimeMetricThresholdView: - 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: - $ref: "#/components/schemas/Operator" - threshold: - type: number - format: double - description: "Value of metric that, when exceeded, triggers an alert." - units: - $ref: "#/components/schemas/TimeMetricUnits" - required: - - metricName - TimeMetricUnits: - type: string - default: HOURS - description: "Element used to express the quantity. This can be an element of\ - \ time, storage capacity, and the like." - enum: - - NANOSECONDS - - MILLISECONDS - - MILLION_MINUTES - - SECONDS - - MINUTES - - HOURS - - DAYS - title: Time Metric Units - TimeMetricValueView: - type: object - description: Measurement of the **metricName** recorded at the time of the event. - properties: - number: - type: number - format: double - description: Amount of the **metricName** recorded at the time of the event. - This value triggered the alert. - readOnly: true - units: - $ref: "#/components/schemas/TimeMetricUnits" - readOnly: true - title: Time Metric Value - TokenFilterEnglishPossessive: - type: object - description: Filter that removes possessives (trailing 's) from words. - properties: - type: - type: string - description: Human-readable label that identifies this token filter type. - enum: - - englishPossessive - required: - - type - title: englishPossessive - TokenFilterFlattenGraph: - type: object - description: "Filter that transforms a token filter graph, such as the token\ - \ filter graph that the wordDelimiterGraph token filter produces, into a flat\ - \ form suitable for indexing." - properties: - type: - type: string - description: Human-readable label that identifies this token filter type. - enum: - - flattenGraph - required: - - type - title: flattenGraph - TokenFilterPorterStemming: + $ref: "#/components/schemas/TextSearchHostStatusDetail" + synonymMappingStatus: + type: string + description: Status that describes this index's synonym mappings. This + status appears only if the index has synonyms defined. + enum: + - FAILED + - BUILDING + - READY + synonymMappingStatusDetail: + type: array + description: A list of documents describing the status of the index's + synonym mappings on each search host. Only appears if the index has + synonyms defined. + items: + type: object + additionalProperties: + $ref: "#/components/schemas/SynonymMappingStatusDetail" + title: Text Search Index Response + TextSearchIndexStatusDetail: type: object - 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. + description: Contains status information about a text search index. properties: - type: + definition: + $ref: "#/components/schemas/TextSearchIndexDefinition" + definitionVersion: + $ref: "#/components/schemas/SearchIndexDefinitionVersion" + message: type: string - description: Human-readable label that identifies this token filter type. - enum: - - porterStemming - required: - - type - title: porterStemming - TokenFilterSpanishPluralStemming: - type: object - description: Filter that stems Spanish plural words. It expects lowercase text. - properties: - type: + description: Optional message describing an error. + queryable: + type: boolean + description: Flag that indicates whether the index generation is queryable + on the host. + status: type: string - description: Human-readable label that identifies this token filter type. + description: | + Condition of the search index when you made this request. + + | Status | Index Condition | + |---|---| + | DELETING | The index is being deleted. | + | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. | + | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. | + | PENDING | Atlas has not yet started building the index. | + | BUILDING | Atlas is building or re-building the index after an edit. | + | READY | The index is ready and can support queries. | enum: - - spanishPluralStemming - required: - - type - title: spanishPluralStemming - TokenFilterStempel: - type: object - description: Filter that uses Lucene's default Polish stemmer table to stem - words in the Polish language. It expects lowercase text. - externalDocs: - description: Default Polish stemmer table - url: https://lucene.apache.org/core/9_2_0/analysis/stempel/org/apache/lucene/analysis/pl/PolishAnalyzer.html#DEFAULT_STEMMER_FILE - properties: - type: + - DELETING + - FAILED + - STALE + - PENDING + - BUILDING + - READY + - DOES_NOT_EXIST + synonymMappingStatus: type: string - description: Human-readable label that identifies this token filter type. + description: Status that describes this index's synonym mappings. This status + appears only if the index has synonyms defined. enum: - - stempel - required: - - type - title: stempel - TokenFilterWordDelimiterGraph: + - FAILED + - BUILDING + - READY + synonymMappingStatusDetail: + type: array + description: List of synonym statuses by mapping. + items: + $ref: "#/components/schemas/SynonymMappingStatusDetailMap" + title: Text Search Index Status Detail + ThirdPartyIntegration: type: object - description: Filter that splits tokens into sub-tokens based on configured rules. + description: Collection of settings that describe third-party integrations. + discriminator: + mapping: + DATADOG: "#/components/schemas/Datadog" + MICROSOFT_TEAMS: "#/components/schemas/MicrosoftTeams" + NEW_RELIC: "#/components/schemas/NewRelic" + OPS_GENIE: "#/components/schemas/OpsGenie" + PAGER_DUTY: "#/components/schemas/PagerDuty" + PROMETHEUS: "#/components/schemas/Prometheus" + SLACK: "#/components/schemas/Slack" + VICTOR_OPS: "#/components/schemas/VictorOps" + WEBHOOK: "#/components/schemas/Webhook" + propertyName: type properties: - delimiterOptions: - type: object - description: Object that contains the rules that determine how to split - words into sub-words. - properties: - concatenateAll: - type: boolean - default: false - description: Flag that indicates whether to concatenate runs. - concatenateNumbers: - type: boolean - default: false - description: Flag that indicates whether to concatenate runs of sub-numbers. - concatenateWords: - type: boolean - default: false - description: Flag that indicates whether to concatenate runs of sub-words. - generateNumberParts: - type: boolean - default: true - description: "Flag that indicates whether to split tokens based on sub-numbers.\ - \ For example, if `true`, this option splits `100-2` into `100` and\ - \ `2`." - generateWordParts: - type: boolean - default: true - description: Flag that indicates whether to split tokens based on sub-words. - ignoreKeywords: - type: boolean - default: false - description: Flag that indicates whether to skip tokens with the `keyword` - attribute set to `true` - preserveOriginal: - type: boolean - default: true - description: Flag that indicates whether to generate tokens of the original - words. - splitOnCaseChange: - type: boolean - default: true - description: Flag that indicates whether to split tokens based on letter-case - transitions. - splitOnNumerics: - type: boolean - default: true - description: Flag that indicates whether to split tokens based on letter-number - transitions. - stemEnglishPossessive: - type: boolean - default: true - description: Flag that indicates whether to remove trailing possessives - from each sub-word. - protectedWords: - type: object - description: Object that contains options for protected words. - properties: - ignoreCase: - type: boolean - default: true - description: Flag that indicates whether to ignore letter case sensitivity - for protected words. - words: - type: array - description: List that contains the tokens to protect from delimination. - items: - type: string - required: - - words - type: + id: type: string - description: Human-readable label that identifies this token filter type. - enum: - - wordDelimiterGraph - required: - - type - title: wordDelimiterGraph - TokenFilterkStemming: - type: object - description: Filter that combines algorithmic stemming with a built-in dictionary - for the English language to stem words. - properties: + description: Integration id. + nullable: true type: type: string - description: Human-readable label that identifies this token filter type. + description: Integration type enum: - - kStemming - required: - - type - title: kStemming - TriggerIngestionPipelineRequest: - type: object - properties: - datasetRetentionPolicy: - $ref: "#/components/schemas/DatasetRetentionPolicy" - snapshotId: - type: string - description: Unique 24-hexadecimal character string that identifies the - snapshot. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - writeOnly: true - required: - - snapshotId - USSBackupRestoreJob20250101: + - PAGER_DUTY + - SLACK + - DATADOG + - NEW_RELIC + - OPS_GENIE + - VICTOR_OPS + - WEBHOOK + - HIP_CHAT + - PROMETHEUS + - MICROSOFT_TEAMS + title: Integration Type + title: Third-Party Integration + TimeMetricAlertView: type: object - description: Details for one restore job of a USS instance. properties: - deliveryType: - type: string - description: Means by which this resource returns the snapshot to the requesting - MongoDB Cloud user. - enum: - - RESTORE - - DOWNLOAD - readOnly: true - expirationDate: - type: string - format: date-time - description: Date and time when the download link no longer works. This - parameter expresses its value in the ISO 8601 timestamp format in UTC. - readOnly: true - id: - type: string - description: Unique 24-hexadecimal digit string that identifies the restore - job. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - instanceName: - type: string - description: Human-readable label that identifies the source instance. - maxLength: 64 - minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - readOnly: true - links: - type: array - description: "List of one or more Uniform Resource Locators (URLs) that\ - \ point to API sub-resources, related API resources, or both. RFC 5988\ - \ outlines these relationships." - externalDocs: - description: Web Linking Specification (RFC 5988) - url: https://datatracker.ietf.org/doc/html/rfc5988 - items: - $ref: "#/components/schemas/Link" - readOnly: true - projectId: - type: string - description: Unique 24-hexadecimal digit string that identifies the project - from which the restore job originated. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - restoreFinishedDate: + acknowledgedUntil: type: string format: date-time - 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. - readOnly: true - restoreScheduledDate: + 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. + acknowledgementComment: type: string - format: date-time - description: Date and time when MongoDB Cloud will restore this snapshot. - This parameter expresses its value in the ISO 8601 timestamp format in - UTC. - readOnly: true - snapshotFinishedDate: + description: Comment that a MongoDB Cloud user submitted when acknowledging + the alert. + example: Expiration on 3/19. Silencing for 7days. + maxLength: 200 + acknowledgingUsername: type: string - format: date-time - description: Date and time when MongoDB Cloud completed writing this snapshot. - This parameter expresses its value in the ISO 8601 timestamp format in - UTC. + format: email + description: MongoDB Cloud username of the person who acknowledged the alert. + The response returns this parameter if a MongoDB Cloud user previously + acknowledged this alert. readOnly: true - snapshotId: + alertConfigId: type: string - description: Unique 24-hexadecimal digit string that identifies the snapshot - to restore. + description: Unique 24-hexadecimal digit string that identifies the alert + configuration that sets this alert. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true - 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. - enum: - - PENDING - - QUEUED - - RUNNING - - FAILED - - COMPLETED - readOnly: true - targetDeploymentItemName: + clusterName: type: string - description: Human-readable label that identifies the instance or cluster - on the target project to which you want to restore the snapshot. You can - restore the snapshot to another USS instance or Dedicated cluster tier. + description: "Human-readable label that identifies the cluster to which\ + \ this alert applies. This resource returns this parameter for alerts\ + \ of events impacting backups, replica sets, or sharded clusters." + example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true - targetProjectId: + created: type: string - description: Unique 24-hexadecimal digit string that identifies the project - that contains the instance or cluster to which you want to restore the - snapshot. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" + format: date-time + description: Date and time when MongoDB Cloud created this alert. This parameter + expresses its value in the ISO 8601 timestamp format + in UTC. readOnly: true - title: USS Backup Restore Job - USSBackupRestoreJobCreate20250101: - type: object - description: Details to create one restore job of a USS instance. - properties: - _snapshotId: - type: string - description: Unique 24-hexadecimal digit string that identifies the snapshot - to restore. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - writeOnly: true - _targetDeploymentItemName: - type: string - description: Human-readable label that identifies the instance or cluster - on the target project to which you want to restore the snapshot. You can - restore the snapshot to another USS instance or Dedicated cluster tier. - maxLength: 64 - minLength: 1 - pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" - writeOnly: true - _targetProjectId: + currentValue: + $ref: "#/components/schemas/TimeMetricValueView" + eventTypeName: + $ref: "#/components/schemas/HostMetricEventTypeViewAlertable" + groupId: type: string description: Unique 24-hexadecimal digit string that identifies the project - that contains the instance or cluster to which you want to restore the - snapshot. + that owns this alert. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" - writeOnly: true - deliveryType: - type: string - description: Means by which this resource returns the snapshot to the requesting - MongoDB Cloud user. - enum: - - RESTORE - - DOWNLOAD readOnly: true - expirationDate: + hostnameAndPort: type: string - format: date-time - description: Date and time when the download link no longer works. This - parameter expresses its value in the ISO 8601 timestamp format in UTC. + description: Hostname and port of the host to which this alert applies. + The resource returns this parameter for alerts of events impacting hosts + or replica sets. + example: cloud-test.mongodb.com:27017 readOnly: true id: type: string - description: Unique 24-hexadecimal digit string that identifies the restore - job. + description: Unique 24-hexadecimal digit string that identifies this alert. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true - instanceName: + lastNotified: type: string - description: Human-readable label that identifies the source instance. - maxLength: 64 - minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + format: date-time + 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. readOnly: true links: type: array @@ -49722,94 +51907,114 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true - projectId: + metricName: type: string - description: Unique 24-hexadecimal digit string that identifies the project - from which the restore job originated. + 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. + example: ASSERT_USER + readOnly: true + orgId: + type: string + description: Unique 24-hexadecimal character string that identifies the + organization that owns the project to which this alert applies. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true - restoreFinishedDate: - type: string - format: date-time - 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. - readOnly: true - restoreScheduledDate: + replicaSetName: type: string - format: date-time - description: Date and time when MongoDB Cloud will restore this snapshot. - This parameter expresses its value in the ISO 8601 timestamp format in - UTC. + description: "Name of the replica set to which this alert applies. The response\ + \ returns this parameter for alerts of events impacting backups, hosts,\ + \ or replica sets." + example: event-replica-set readOnly: true - snapshotFinishedDate: + resolved: type: string format: date-time - description: Date and time when MongoDB Cloud completed writing this snapshot. - This parameter expresses its value in the ISO 8601 timestamp format in - UTC. - readOnly: true - snapshotUrl: - type: string - description: "Internet address from which you can download the compressed\ - \ snapshot files. The resource returns this parameter when `\"deliveryType\"\ - \ : \"DOWNLOAD\"`." + 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\"`." readOnly: true status: type: string - description: Phase of the restore workflow for this job at the time this - resource made this request. + description: State of this alert at the time you requested its details. enum: - - PENDING - - QUEUED - - RUNNING - - FAILED - - COMPLETED + - CANCELLED + - CLOSED + - OPEN + - TRACKING + example: OPEN + readOnly: true + updated: + type: string + format: date-time + description: Date and time when someone last updated this alert. This parameter + expresses its value in the ISO 8601 timestamp format + in UTC. readOnly: true required: - - _snapshotId - - _targetDeploymentItemName - title: Create USS Backup Restore Job - USSBackupSettings20250101: + - alertConfigId + - created + - eventTypeName + - id + - status + - updated + TimeMetricEventView: type: object - description: USS backup configuration properties: - enabled: - type: boolean - default: true - description: "Flag that indicates whether backups are performed for this\ - \ USS instance. Backup uses [TODO](TODO) for USS instances." + apiKeyId: + type: string + description: "Unique 24-hexadecimal digit string that identifies the [API\ + \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\ + \ triggered the event. If this resource returns this parameter, it doesn't\ + \ return the **userId** parameter." + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" readOnly: true - readOnly: true - title: USS backup configuration - USSBackupSnapshot20250101: - type: object - description: Details for one snapshot of a USS instance. - properties: - expiration: + created: type: string format: date-time - description: Date and time when the download link no longer works. This - parameter expresses its value in the ISO 8601 timestamp format in UTC. + description: Date and time when this event occurred. This parameter expresses + its value in the ISO 8601 timestamp format in UTC. readOnly: true - finishTime: + currentValue: + $ref: "#/components/schemas/TimeMetricValueView" + eventTypeName: + $ref: "#/components/schemas/HostMetricEventTypeView" + groupId: type: string - format: date-time - description: Date and time when MongoDB Cloud completed writing this snapshot. - This parameter expresses its value in the ISO 8601 timestamp format in - UTC. + description: Unique 24-hexadecimal digit string that identifies the project + in which the event occurred. The **eventId** identifies the specific event. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" readOnly: true id: type: string - description: Unique 24-hexadecimal digit string that identifies the snapshot. + description: Unique 24-hexadecimal digit string that identifies the event. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true + isGlobalAdmin: + type: boolean + default: false + description: Flag that indicates whether a MongoDB employee triggered the + specified event. + readOnly: true links: type: array description: "List of one or more Uniform Resource Locators (URLs) that\ @@ -49821,307 +52026,307 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true - mongoDBVersion: - type: string - description: MongoDB host version that the snapshot runs. - readOnly: true - scheduledTime: - type: string - format: date-time - description: Date and time when MongoDB Cloud will take the snapshot. This - parameter expresses its value in the ISO 8601 timestamp format in UTC. - readOnly: true - startTime: - type: string - format: date-time - description: Date and time when MongoDB Cloud began taking the snapshot. - This parameter expresses its value in the ISO 8601 timestamp format in - UTC. - readOnly: true - status: + metricName: type: string - description: Phase of the workflow for this snapshot at the time this resource - made this request. - enum: - - PENDING - - QUEUED - - RUNNING - - FAILED - - COMPLETED + description: Human-readable label of the metric associated with the **alertId**. + This field may change type of **currentValue** field. readOnly: true - title: USS Backup Snapshot - USSBackupSnapshotDownloadCreate20250101: - type: object - description: Details for one backup snapshot download of a USS instance. - properties: - _snapshotId: + orgId: type: string - description: Unique 24-hexadecimal digit string that identifies the snapshot - to download. + description: Unique 24-hexadecimal digit string that identifies the organization + to which these events apply. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" - writeOnly: true - links: - type: array - description: "List of one or more Uniform Resource Locators (URLs) that\ - \ point to API sub-resources, related API resources, or both. RFC 5988\ - \ outlines these relationships." - externalDocs: - description: Web Linking Specification (RFC 5988) - url: https://datatracker.ietf.org/doc/html/rfc5988 - items: - $ref: "#/components/schemas/Link" readOnly: true - required: - - _snapshotId - title: USS Backup Snapshot Download Create - USSConnectionStrings20250101: - type: object - description: Collection of Uniform Resource Locators that point to the MongoDB - database. - externalDocs: - description: Connection string URI format. - url: https://docs.mongodb.com/manual/reference/connection-string/ - properties: - standard: - type: string - description: Public connection string that you can use to connect to this - cluster. This connection string uses the mongodb:// protocol. - externalDocs: - description: Connection String URI Format - url: https://docs.mongodb.com/manual/reference/connection-string/ + port: + type: integer + format: int32 + description: IANA port on which the MongoDB process listens for requests. + example: 27017 readOnly: true - standardSrv: + publicKey: type: string - description: Public connection string that you can use to connect to this - USS instance. This connection string uses the `mongodb+srv://` protocol. - externalDocs: - description: Connection String URI Format - url: https://docs.mongodb.com/manual/reference/connection-string/ + format: email + description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\ + \ that triggered the event. If this resource returns this parameter, it\ + \ doesn't return the **username** parameter." + example: test.user@mongodb.com readOnly: true - readOnly: true - title: USS Instance Connection Strings - USSInstanceDescription20250101: - type: object - description: Group of settings that configure a MongoDB USS instance. - properties: - backupSettings: - $ref: "#/components/schemas/USSBackupSettings20250101" - clusterType: + raw: + $ref: "#/components/schemas/raw" + remoteAddress: type: string - description: USS instance topology. - enum: - - REPLICASET - - LOADBALANCED + description: IPv4 or IPv6 address from which the user triggered this event. + example: 216.172.40.186 + pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" readOnly: true - connectionStrings: - $ref: "#/components/schemas/USSConnectionStrings20250101" - createDate: + replicaSetName: type: string - format: date-time - description: Date and time when MongoDB Cloud created this instance. This - parameter expresses its value in ISO 8601 format in UTC. + description: Human-readable label of the replica set associated with the + event. + example: event-replica-set readOnly: true - groupId: + shardName: type: string - description: Unique 24-hexadecimal character string that identifies the - project. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" + description: Human-readable label of the shard associated with the event. + example: event-sh-01 readOnly: true - id: + userId: type: string - description: Unique 24-hexadecimal digit string that identifies the instance. + description: "Unique 24-hexadecimal digit string that identifies the console\ + \ user who triggered the event. If this resource returns this parameter,\ + \ it doesn't return the **apiKeyId** parameter." example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true - links: - type: array - description: "List of one or more Uniform Resource Locators (URLs) that\ - \ point to API sub-resources, related API resources, or both. RFC 5988\ - \ outlines these relationships." - externalDocs: - description: Web Linking Specification (RFC 5988) - url: https://datatracker.ietf.org/doc/html/rfc5988 - items: - $ref: "#/components/schemas/Link" - readOnly: true - mongoDBVersion: + username: type: string - description: Version of MongoDB that the instance runs. - pattern: "([\\d]+\\.[\\d]+\\.[\\d]+)" + format: email + description: "Email address for the user who triggered this event. If this\ + \ resource returns this parameter, it doesn't return the **publicApiKey**\ + \ parameter." + example: test.user@mongodb.com readOnly: true - name: + required: + - created + - eventTypeName + - id + TimeMetricThresholdView: + type: object + properties: + metricName: type: string - description: Human-readable label that identifies the instance. - maxLength: 64 - minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - readOnly: true - providerSettings: - $ref: "#/components/schemas/USSProviderSettings20250101" - stateName: + description: Human-readable label that identifies the metric against which + MongoDB Cloud checks the configured **metricThreshold.threshold**. + mode: type: string - description: Human-readable label that indicates the current operating condition - of this instance. + description: MongoDB Cloud computes the current metric value as an average. enum: - - IDLE - - CREATING - - UPDATING - - DELETING - - REPAIRING - readOnly: true - tags: - type: array - description: List that contains key-value pairs between 1 to 255 characters - in length for tagging and categorizing the instance. - externalDocs: - description: Resource Tags - url: https://dochub.mongodb.org/core/add-cluster-tag-atlas - items: - $ref: "#/components/schemas/ResourceTag" - terminationProtectionEnabled: - type: boolean - default: false - description: "Flag that indicates whether termination protection is enabled\ - \ on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster.\ - \ If set to `false`, MongoDB Cloud will delete the cluster." - versionReleaseSystem: + - AVERAGE + operator: type: string - default: LTS - description: Method by which the cluster maintains the MongoDB versions. + description: Comparison operator to apply when checking the current metric + value. enum: - - LTS - readOnly: true + - LESS_THAN + - GREATER_THAN + threshold: + type: number + format: double + description: "Value of metric that, when exceeded, triggers an alert." + units: + $ref: "#/components/schemas/TimeMetricUnits" required: - - providerSettings - title: USS Instance Description - USSInstanceDescriptionCreate20250101: + - metricName + TimeMetricUnits: + type: string + default: HOURS + description: "Element used to express the quantity. This can be an element of\ + \ time, storage capacity, and the like." + enum: + - NANOSECONDS + - MILLISECONDS + - MILLION_MINUTES + - SECONDS + - MINUTES + - HOURS + - DAYS + title: Time Metric Units + TimeMetricValueView: type: object - description: Settings that you can specify when you create a USS instance. + description: Measurement of the **metricName** recorded at the time of the event. properties: - links: - type: array - description: "List of one or more Uniform Resource Locators (URLs) that\ - \ point to API sub-resources, related API resources, or both. RFC 5988\ - \ outlines these relationships." - externalDocs: - description: Web Linking Specification (RFC 5988) - url: https://datatracker.ietf.org/doc/html/rfc5988 - items: - $ref: "#/components/schemas/Link" + number: + type: number + format: double + description: Amount of the **metricName** recorded at the time of the event. + This value triggered the alert. readOnly: true - name: + units: + $ref: "#/components/schemas/TimeMetricUnits" + readOnly: true + title: Time Metric Value + TokenFilterEnglishPossessive: + type: object + description: Filter that removes possessives (trailing 's) from words. + properties: + type: type: string - description: Human-readable label that identifies the instance. - maxLength: 64 - minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - writeOnly: true - providerSettings: - $ref: "#/components/schemas/USSProviderSettingsCreate20250101" - tags: - type: array - description: List that contains key-value pairs between 1 to 255 characters - in length for tagging and categorizing the instance. - externalDocs: - description: Resource Tags - url: https://dochub.mongodb.org/core/add-cluster-tag-atlas - items: - $ref: "#/components/schemas/ResourceTag" - terminationProtectionEnabled: - type: boolean - default: false - description: "Flag that indicates whether termination protection is enabled\ - \ on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster.\ - \ If set to `false`, MongoDB Cloud will delete the cluster." + description: Human-readable label that identifies this token filter type. + enum: + - englishPossessive required: - - name - - providerSettings - title: USS Instance Description Create - USSProviderSettings20250101: + - type + title: englishPossessive + TokenFilterFlattenGraph: type: object - description: Group of cloud provider settings that configure the provisioned - MongoDB USS instance. + description: "Filter that transforms a token filter graph, such as the token\ + \ filter graph that the wordDelimiterGraph token filter produces, into a flat\ + \ form suitable for indexing." properties: - backingProviderName: + type: type: string - description: Cloud service provider on which MongoDB Cloud provisioned the - USS instance. + description: Human-readable label that identifies this token filter type. enum: - - AWS - - AZURE - - GCP - readOnly: true - diskSizeGB: - type: number - format: double - description: Storage capacity available to the USS instance expressed in - gigabytes. - readOnly: true - providerName: + - flattenGraph + required: + - type + title: flattenGraph + TokenFilterPorterStemming: + type: object + description: Filter that uses the porter stemming algorithm to remove the common + morphological and inflectional suffixes from words in English. It expects + lowercase text and doesn't work as expected for uppercase text. + properties: + type: type: string - default: USS - description: Human-readable label that identifies the cloud service provider. + description: Human-readable label that identifies this token filter type. enum: - - USS - readOnly: true - regionName: + - porterStemming + required: + - type + title: porterStemming + TokenFilterSpanishPluralStemming: + type: object + description: Filter that stems Spanish plural words. It expects lowercase text. + properties: + type: type: string - description: "Human-readable label that identifies the geographic location\ - \ of your MongoDB USS 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/)." - readOnly: true - readOnly: true - title: Cloud Service Provider Settings for a USS Instance - USSProviderSettingsCreate20250101: + description: Human-readable label that identifies this token filter type. + enum: + - spanishPluralStemming + required: + - type + title: spanishPluralStemming + TokenFilterStempel: type: object - description: Group of cloud provider settings that configure the provisioned - MongoDB USS instance. + description: Filter that uses Lucene's default Polish stemmer table to stem + words in the Polish language. It expects lowercase text. + externalDocs: + description: Default Polish stemmer table + url: https://lucene.apache.org/core/9_2_0/analysis/stempel/org/apache/lucene/analysis/pl/PolishAnalyzer.html#DEFAULT_STEMMER_FILE properties: - backingProviderName: + type: type: string - description: Cloud service provider on which MongoDB Cloud provisioned the - serverless instance. + description: Human-readable label that identifies this token filter type. enum: - - AWS - - AZURE - - GCP - writeOnly: true - diskSizeGB: - type: number - format: double - description: Storage capacity available to the USS instance expressed in - gigabytes. - readOnly: true - providerName: + - stempel + required: + - type + title: stempel + TokenFilterWordDelimiterGraph: + type: object + description: Filter that splits tokens into sub-tokens based on configured rules. + properties: + delimiterOptions: + type: object + description: Object that contains the rules that determine how to split + words into sub-words. + properties: + concatenateAll: + type: boolean + default: false + description: Flag that indicates whether to concatenate runs. + concatenateNumbers: + type: boolean + default: false + description: Flag that indicates whether to concatenate runs of sub-numbers. + concatenateWords: + type: boolean + default: false + description: Flag that indicates whether to concatenate runs of sub-words. + generateNumberParts: + type: boolean + default: true + description: "Flag that indicates whether to split tokens based on sub-numbers.\ + \ For example, if `true`, this option splits `100-2` into `100` and\ + \ `2`." + generateWordParts: + type: boolean + default: true + description: Flag that indicates whether to split tokens based on sub-words. + ignoreKeywords: + type: boolean + default: false + description: Flag that indicates whether to skip tokens with the `keyword` + attribute set to `true` + preserveOriginal: + type: boolean + default: true + description: Flag that indicates whether to generate tokens of the original + words. + splitOnCaseChange: + type: boolean + default: true + description: Flag that indicates whether to split tokens based on letter-case + transitions. + splitOnNumerics: + type: boolean + default: true + description: Flag that indicates whether to split tokens based on letter-number + transitions. + stemEnglishPossessive: + type: boolean + default: true + description: Flag that indicates whether to remove trailing possessives + from each sub-word. + protectedWords: + type: object + description: Object that contains options for protected words. + properties: + ignoreCase: + type: boolean + default: true + description: Flag that indicates whether to ignore letter case sensitivity + for protected words. + words: + type: array + description: List that contains the tokens to protect from delimination. + items: + type: string + required: + - words + type: type: string - default: USS - description: Human-readable label that identifies the cloud service provider. + description: Human-readable label that identifies this token filter type. enum: - - USS - readOnly: true - regionName: + - wordDelimiterGraph + required: + - type + title: wordDelimiterGraph + TokenFilterkStemming: + type: object + description: Filter that combines algorithmic stemming with a built-in dictionary + for the English language to stem words. + properties: + type: type: string - description: "Human-readable label that identifies the geographic location\ - \ of your MongoDB USS 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/)." + description: Human-readable label that identifies this token filter type. + enum: + - kStemming + required: + - type + title: kStemming + TriggerIngestionPipelineRequest: + type: object + properties: + datasetRetentionPolicy: + $ref: "#/components/schemas/DatasetRetentionPolicy" + snapshotId: + type: string + description: Unique 24-hexadecimal character string that identifies the + snapshot. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" writeOnly: true required: - - backingProviderName - - regionName - title: Cloud Service Provider Settings for a USS Instance - writeOnly: true + - snapshotId UpdateAtlasOrganizationApiKey: type: object properties: @@ -50836,7 +53041,7 @@ components: Atlas Data Lake that this database user can access. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" type: type: string description: Category of resource that this database user can access. @@ -50895,6 +53100,28 @@ components: required: - match title: User to Distinguished Name Mapping + VPCPeeringActionChallenge: + type: object + description: Container for elements used to challenge the user before taking + certain actions on VPC Peering connections. + properties: + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + requesterAccountId: + type: string + description: The AWS requester account ID. + requesterVpcId: + type: string + description: The AWS requester VPC ID. VectorSearchHostStatusDetail: type: object properties: diff --git a/tools/cli/test/data/split/dev/openapi-v2-2023-10-01.json b/tools/cli/test/data/split/dev/openapi-v2-2023-10-01.json index f1ed285f90..bf17769de3 100644 --- a/tools/cli/test/data/split/dev/openapi-v2-2023-10-01.json +++ b/tools/cli/test/data/split/dev/openapi-v2-2023-10-01.json @@ -1,7 +1,7 @@ { "openapi" : "3.0.1", "info" : { - "description" : "The MongoDB Atlas Administration API allows developers to manage all components in MongoDB Atlas.\n\nThe Atlas Administration API uses HTTP Digest Authentication to authenticate requests. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request. For example, to [return database access history](#tag/Access-Tracking/operation/listAccessLogsByClusterName) with [cURL](https://en.wikipedia.org/wiki/CURL), run the following command in the terminal:\n\n```\ncurl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true\"\n```\n\nTo learn more, see [Get Started with the Atlas Administration API](https://www.mongodb.com/docs/atlas/configure-api-access/). For support, see [MongoDB Support](https://www.mongodb.com/support/get-started).", + "description" : "The MongoDB Atlas Administration API allows developers to manage all components in MongoDB Atlas.\n\nThe Atlas Administration API uses HTTP Digest Authentication to authenticate requests. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request. For example, to [return database access history](#tag/Access-Tracking/operation/listAccessLogsByClusterName) with [cURL](https://en.wikipedia.org/wiki/CURL), run the following command in the terminal:\n\n```\ncurl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-10-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true\"\n```\n\nTo learn more, see [Get Started with the Atlas Administration API](https://www.mongodb.com/docs/atlas/configure-api-access/). For support, see [MongoDB Support](https://www.mongodb.com/support/get-started).\n\nYou can also explore the various endpoints available through the Atlas Administration API in MongoDB's [Postman workspace](https://www.postman.com/mongodb-devrel/workspace/mongodb-atlas-administration-apis/).", "license" : { "name" : "CC BY-NC-SA 3.0 US", "url" : "https://creativecommons.org/licenses/by-nc-sa/3.0/us/" @@ -9,7 +9,7 @@ "termsOfService" : "https://www.mongodb.com/mongodb-management-service-terms-and-conditions", "title" : "MongoDB Atlas Administration API", "version" : "2.0", - "x-xgen-sha" : "09d9d18db2111c955a8e01702a27ca2763417782" + "x-xgen-sha" : "e6ba3136dbd0be2a81dd4ed21b9e6c470edd4420" }, "servers" : [ { "url" : "https://cloud.mongodb.com" @@ -57,7 +57,11 @@ "description" : "Returns, adds, edits, and removes Federated Database Instances. This resource requires your project ID. Changes to federated database instance configurations can affect costs.", "name" : "Data Federation" }, { - "description" : "Returns, adds, edits, and removes Atlas Data Lake Pipelines and associated runs.", + "description" : "Returns, edits, and removes Atlas Data Lake Pipelines and associated runs.", + "externalDocs" : { + "description" : "Data Lake Pipelines are deprecated. Please see Data Lake Deprecation Guide.", + "url" : "https://dochub.mongodb.org/core/data-lake-deprecation" + }, "name" : "Data Lake Pipelines" }, { "description" : "Returns, adds, edits, and removes database users.", @@ -119,6 +123,9 @@ }, { "description" : "You can continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket. Atlas exports logs every 5 minutes.", "name" : "Push-Based Log Export" + }, { + "description" : "Configure and manage Atlas Resource Policies within your organization.", + "name" : "Resource Policies" }, { "description" : "Creates one index to a database deployment in a rolling manner. You can't create a rolling index on an `M0` free cluster or `M2/M5` shared cluster.", "name" : "Rolling Index" @@ -135,6 +142,13 @@ "url" : "https://dochub.mongodb.org/core/serverless-private-endpoint" }, "name" : "Serverless Private Endpoints" + }, { + "description" : "Endpoints for managing Service Accounts and secrets. Service Accounts are used for programmatic access to the Atlas Admin API through the OAuth 2.0 Client Credentials flow. This feature is available as a Preview feature.", + "externalDocs" : { + "description" : "Get Started with the Atlas Administration API", + "url" : "https://www.mongodb.com/docs/atlas/configure-api-access/" + }, + "name" : "Service Accounts" }, { "description" : "Returns and adds restore jobs for shared-tier database deployments.", "name" : "Shared-Tier Restore Jobs" @@ -2728,7 +2742,7 @@ "/api/atlas/v2/groups/{groupId}/backup/exportBuckets" : { "get" : { "deprecated" : true, - "description" : "Returns all AWS S3 buckets and Azure Blob Storage Containers associated with the specified Project. To use this resource, the requesting API Key must have the Project Read Only role.", + "description" : "Returns all Export Buckets associated with the specified Project. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "listExportBuckets", "parameters" : [ { "$ref" : "#/components/parameters/envelope" @@ -2765,13 +2779,13 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Return All AWS S3 Buckets and Azure Blob Storage Containers Used for Cloud Backup Snapshot Exports", + "summary" : "Return All Snapshot Export Buckets", "tags" : [ "Cloud Backups" ], - "x-sunset" : "2025-05-30" + "x-sunset" : "2026-05-30" }, "post" : { "deprecated" : true, - "description" : "Grants MongoDB Cloud access to the specified AWS S3 Bucket or Azure Blob Storage Container. This enables this Export Bucket to receive Atlas Cloud Backup Snapshots. To use this resource, the requesting API Key must have the Project Owner role.", + "description" : "Creates a Snapshot Export Bucket for an AWS S3 Bucket or Azure Blob Storage Container. Once created, an snapshots can be exported to the Export Bucket and its referenced AWS S3 Bucket or Azure Blob Storage Container. To use this resource, the requesting API Key must have the Project Owner role.", "operationId" : "createExportBucket", "parameters" : [ { "$ref" : "#/components/parameters/envelope" @@ -2790,7 +2804,7 @@ "x-xgen-version" : "2023-01-01" } }, - "description" : "Grants MongoDB Cloud access to the specified AWS S3 Bucket or Azure Blob Storage Container.", + "description" : "Specifies the role and AWS S3 Bucket or Azure Blob Storage Container that the Export Bucket should reference.", "required" : true }, "responses" : { @@ -2821,21 +2835,21 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Grant Access to AWS S3 Bucket or Azure Blob Storage Container for Cloud Backup Snapshot Exports", + "summary" : "Create One Snapshot Export Bucket", "tags" : [ "Cloud Backups" ], - "x-sunset" : "2025-05-30" + "x-sunset" : "2026-05-30" } }, "/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}" : { "delete" : { - "description" : "Revoke MongoDB Cloud access to the specified AWS S3 Bucket or Azure Blob Storage Container. This prevents this Export Bucket from receiving Atlas Cloud Backup Snapshots. 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 API Key must have the Project Owner role.", + "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 API Key must have the Project Owner role.", "operationId" : "deleteExportBucket", "parameters" : [ { "$ref" : "#/components/parameters/envelope" }, { "$ref" : "#/components/parameters/groupId" }, { - "description" : "Unique string that identifies the AWS S3 Bucket or Azure Blob Storage Container to which you export your Snapshots.", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", "in" : "path", "name" : "exportBucketId", "required" : true, @@ -2875,12 +2889,12 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Revoke Access to AWS S3 Bucket or Azure Blob Storage Container for Cloud Backup Snapshot Exports", + "summary" : "Delete One Snapshot Export Bucket", "tags" : [ "Cloud Backups" ] }, "get" : { "deprecated" : true, - "description" : "Returns one AWS S3 Bucket or Azure Blob Storage Container associated with the specified Project. To use this resource, the requesting API Key must have the Project Read Only role.", + "description" : "Returns one Export Bucket associated with the specified Project. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "getExportBucket", "parameters" : [ { "$ref" : "#/components/parameters/envelope" @@ -2924,9 +2938,9 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Return One AWS S3 Bucket or Azure Blob Storage Container Used for Cloud Backup Snapshot Exports", + "summary" : "Return One Snapshot Export Bucket", "tags" : [ "Cloud Backups" ], - "x-sunset" : "2025-05-30" + "x-sunset" : "2026-05-30" } }, "/api/atlas/v2/groups/{groupId}/backupCompliancePolicy" : { @@ -3084,7 +3098,7 @@ "content" : { "application/vnd.atlas.2023-01-01+json" : { "schema" : { - "$ref" : "#/components/schemas/CloudProviderAccessRole" + "$ref" : "#/components/schemas/CloudProviderAccessRoleRequest" } } }, @@ -3134,7 +3148,7 @@ "required" : true, "schema" : { "type" : "string", - "enum" : [ "AWS" ] + "enum" : [ "AWS", "AZURE", "GCP" ] } }, { "description" : "Unique 24-hexadecimal digit string that identifies the role.", @@ -3222,7 +3236,7 @@ "tags" : [ "Cloud Provider Access" ] }, "patch" : { - "description" : "Grants access to the specified project for the specified access role. To use this resource, the requesting API Key must have the Project Owner role. This API endpoint is one step in a procedure to create unified access for MongoDB Cloud services.", + "description" : "Grants access to the specified project for the specified access role. To use this resource, the requesting API Key must have the Project Owner role. This API endpoint is one step in a procedure to create unified access for MongoDB Cloud services. 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/" @@ -3250,7 +3264,7 @@ "content" : { "application/vnd.atlas.2023-01-01+json" : { "schema" : { - "$ref" : "#/components/schemas/CloudProviderAccessRole" + "$ref" : "#/components/schemas/CloudProviderAccessRoleRequestUpdate" } } }, @@ -3601,7 +3615,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster.", @@ -3661,7 +3675,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -3715,7 +3729,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -3767,7 +3781,7 @@ }, "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports" : { "get" : { - "description" : "Returns all Cloud Backup snapshot export jobs associated with the specified Atlas cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role.", + "description" : "Returns all Cloud Backup Snapshot Export Jobs associated with the specified Atlas cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role.", "operationId" : "listBackupExportJobs", "parameters" : [ { "$ref" : "#/components/parameters/envelope" @@ -3790,7 +3804,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -3815,11 +3829,11 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Return All Cloud Backup Snapshot Export Jobs", + "summary" : "Return All Snapshot Export Jobs", "tags" : [ "Cloud Backups" ] }, "post" : { - "description" : "Exports one backup snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. To use this resource, the requesting API Key must have the Project Atlas Admin role.", + "description" : "Exports one backup Snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. To use this resource, the requesting API Key must have the Project Atlas Admin role.", "operationId" : "createBackupExportJob", "parameters" : [ { "$ref" : "#/components/parameters/envelope" @@ -3834,7 +3848,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -3879,13 +3893,13 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Create One Cloud Backup Snapshot Export Job", + "summary" : "Create One Snapshot Export Job", "tags" : [ "Cloud Backups" ] } }, "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}" : { "get" : { - "description" : "Returns one Cloud Backup snapshot export job associated with the specified Atlas cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role.", + "description" : "Returns one Cloud Backup Snapshot Export Job associated with the specified Atlas cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role.", "operationId" : "getBackupExportJob", "parameters" : [ { "$ref" : "#/components/parameters/envelope" @@ -3900,15 +3914,19 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { - "description" : "Unique string that identifies the export job to return.", + "description" : "Unique 24-hexadecimal character string that identifies the Export Job.", "in" : "path", "name" : "exportId", "required" : true, "schema" : { - "type" : "string" + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" } } ], "responses" : { @@ -3933,7 +3951,7 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Return One Cloud Backup Snapshot Export Job", + "summary" : "Return One Snapshot Export Job", "tags" : [ "Cloud Backups" ] } }, @@ -3962,7 +3980,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -4008,7 +4026,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -4076,7 +4094,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the restore job to remove.", @@ -4136,7 +4154,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the restore job to return.", @@ -4194,7 +4212,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -4224,7 +4242,7 @@ } ], "summary" : "Remove All Cloud Backup Schedules", "tags" : [ "Cloud Backups" ], - "x-sunset" : "2025-08-05" + "x-sunset" : "2026-05-30" }, "get" : { "deprecated" : true, @@ -4245,7 +4263,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -4272,7 +4290,7 @@ } ], "summary" : "Return One Cloud Backup Schedule", "tags" : [ "Cloud Backups" ], - "x-sunset" : "2025-08-05" + "x-sunset" : "2026-05-30" }, "patch" : { "deprecated" : true, @@ -4293,7 +4311,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -4334,7 +4352,7 @@ } ], "summary" : "Update Cloud Backup Schedule for One Cluster", "tags" : [ "Cloud Backups" ], - "x-sunset" : "2025-08-05" + "x-sunset" : "2026-05-30" } }, "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots" : { @@ -4362,7 +4380,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -4411,7 +4429,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -4473,7 +4491,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -4530,7 +4548,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -4592,7 +4610,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -4643,7 +4661,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -4703,7 +4721,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -4763,7 +4781,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -4830,7 +4848,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "$ref" : "#/components/parameters/envelope" @@ -4901,7 +4919,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "$ref" : "#/components/parameters/envelope" @@ -4969,7 +4987,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "$ref" : "#/components/parameters/envelope" @@ -5020,7 +5038,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "$ref" : "#/components/parameters/envelope" @@ -5088,7 +5106,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -5139,7 +5157,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -5208,7 +5226,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -5268,7 +5286,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -5327,7 +5345,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -5398,7 +5416,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Name of the collection that contains one or more Atlas Search indexes.", @@ -5471,7 +5489,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the Atlas Search index. Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes.", @@ -5537,7 +5555,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "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.", @@ -5600,7 +5618,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "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.", @@ -5682,7 +5700,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -5736,7 +5754,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -5788,7 +5806,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -5854,7 +5872,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "$ref" : "#/components/parameters/groupId" @@ -5925,7 +5943,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -5995,7 +6013,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -6149,7 +6167,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -6199,7 +6217,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -6292,7 +6310,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Flag that indicates whether to download logs for queries against your online archive only or both your online archive and cluster.", @@ -6371,7 +6389,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -6435,7 +6453,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -6502,7 +6520,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -6574,7 +6592,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -6630,7 +6648,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -6686,7 +6704,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -6753,7 +6771,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -6808,7 +6826,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -6875,7 +6893,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -6937,7 +6955,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -6987,7 +7005,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -7050,7 +7068,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", @@ -7113,7 +7131,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -7164,7 +7182,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -7215,7 +7233,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -7280,7 +7298,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -7347,7 +7365,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -7394,7 +7412,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -7460,7 +7478,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Human-readable label that specifies whether to return only completed, incomplete, or all snapshots. By default, MongoDB Cloud only returns completed snapshots.", @@ -7518,7 +7536,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -7579,7 +7597,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -7637,7 +7655,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -7707,7 +7725,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -7767,7 +7785,7 @@ } } }, { - "description" : "Date and time when the period specifies the inclusive ending point for the range of log messages to retrieve. This parameter expresses its value in the number of seconds that have elapsed since the UNIX epoch.", + "description" : "Specifies the date and time for the ending point of the range of log messages to retrieve, in the number of seconds that have elapsed since the UNIX epoch. This value will default to 24 hours after the start date. If the start date is also unspecified, the value will default to the time of the request.", "in" : "query", "name" : "endDate", "schema" : { @@ -7776,7 +7794,7 @@ "minimum" : 1199145600 } }, { - "description" : "Date and time when the period specifies the inclusive starting point for the range of log messages to retrieve. This parameter expresses its value in the number of seconds that have elapsed since the UNIX epoch.", + "description" : "Specifies the date and time for the starting point of the range of log messages to retrieve, in the number of seconds that have elapsed since the UNIX epoch. This value will default to 24 hours prior to the end date. If the end date is also unspecified, the value will default to 24 hours prior to the time of the request.", "in" : "query", "name" : "startDate", "schema" : { @@ -9543,7 +9561,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Date and time when to stop retrieving database history. If you specify **end**, you must also specify **start**. This parameter uses UNIX epoch time in milliseconds.", @@ -9806,6 +9824,12 @@ "$ref" : "#/components/parameters/pretty" }, { "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" }, { "description" : "Human-readable label that identifies the cloud provider for the private endpoints to return.", "in" : "path", @@ -9928,17 +9952,6 @@ "pattern" : "^([a-f0-9]{24})$" } } ], - "requestBody" : { - "content" : { - "application/vnd.atlas.2023-01-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/EncryptionAtRestPrivateEndpointRequest" - } - } - }, - "description" : "Cloud provider of the private endpoints to delete and the list of cloud provider regions in which to delete the private endpoints.", - "required" : true - }, "responses" : { "204" : { "content" : { @@ -10009,6 +10022,9 @@ "403" : { "$ref" : "#/components/responses/forbidden" }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, "500" : { "$ref" : "#/components/responses/internalServerError" } @@ -10046,7 +10062,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, "style" : "form" @@ -10764,7 +10780,7 @@ } ], "summary" : "Return All Project Invitations", "tags" : [ "Projects" ], - "x-sunset" : "2024-10-04" + "x-sunset" : "2024-11-04" }, "patch" : { "deprecated" : true, @@ -10818,7 +10834,7 @@ } ], "summary" : "Update One Project Invitation", "tags" : [ "Projects" ], - "x-sunset" : "2024-10-04" + "x-sunset" : "2024-11-04" }, "post" : { "deprecated" : true, @@ -10866,7 +10882,7 @@ } ], "summary" : "Invite One MongoDB Cloud User to Join One Project", "tags" : [ "Projects" ], - "x-sunset" : "2024-10-04" + "x-sunset" : "2024-11-04" } }, "/api/atlas/v2/groups/{groupId}/invites/{invitationId}" : { @@ -10914,7 +10930,7 @@ } ], "summary" : "Cancel One Project Invitation", "tags" : [ "Projects" ], - "x-sunset" : "2024-10-04" + "x-sunset" : "2024-11-04" }, "get" : { "deprecated" : true, @@ -10965,7 +10981,7 @@ } ], "summary" : "Return One Project Invitation", "tags" : [ "Projects" ], - "x-sunset" : "2024-10-04" + "x-sunset" : "2024-11-04" }, "patch" : { "deprecated" : true, @@ -11028,7 +11044,7 @@ } ], "summary" : "Update One Project Invitation by Invitation ID", "tags" : [ "Projects" ], - "x-sunset" : "2024-10-04" + "x-sunset" : "2024-11-04" } }, "/api/atlas/v2/groups/{groupId}/ipAddresses" : { @@ -11125,13 +11141,13 @@ "description" : "Removes the specified project limit. Depending on the limit, Atlas either resets the limit to its default value or removes the limit entirely. To use this resource, the requesting API Key must have the Project Owner role.", "operationId" : "deleteProjectLimit", "parameters" : [ { - "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", + "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| 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 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n| atlas.project.deployment.salesSoldM0s | Limit on the number of M0 clusters in this project if the org is sales-sold | 100 | 100 |\n", "in" : "path", "name" : "limitName", "required" : true, "schema" : { "type" : "string", - "enum" : [ "atlas.project.security.databaseAccess.users", "atlas.project.deployment.clusters", "atlas.project.deployment.serverlessMTMs", "atlas.project.security.databaseAccess.customRoles", "atlas.project.security.networkAccess.entries", "atlas.project.security.networkAccess.crossRegionEntries", "atlas.project.deployment.nodesPerPrivateLinkRegion", "dataFederation.bytesProcessed.query", "dataFederation.bytesProcessed.daily", "dataFederation.bytesProcessed.weekly", "dataFederation.bytesProcessed.monthly", "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", "atlas.project.deployment.privateServiceConnectionsSubnetMask" ] + "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" @@ -11175,13 +11191,13 @@ "description" : "Returns the specified limit for the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "getProjectLimit", "parameters" : [ { - "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", + "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| 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 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n| atlas.project.deployment.salesSoldM0s | Limit on the number of M0 clusters in this project if the org is sales-sold | 100 | 100 |\n", "in" : "path", "name" : "limitName", "required" : true, "schema" : { "type" : "string", - "enum" : [ "atlas.project.security.databaseAccess.users", "atlas.project.deployment.clusters", "atlas.project.deployment.serverlessMTMs", "atlas.project.security.databaseAccess.customRoles", "atlas.project.security.networkAccess.entries", "atlas.project.security.networkAccess.crossRegionEntries", "atlas.project.deployment.nodesPerPrivateLinkRegion", "dataFederation.bytesProcessed.query", "dataFederation.bytesProcessed.daily", "dataFederation.bytesProcessed.weekly", "dataFederation.bytesProcessed.monthly", "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", "atlas.project.deployment.privateServiceConnectionsSubnetMask" ] + "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" @@ -11228,13 +11244,13 @@ "description" : "Sets the specified project limit. To use this resource, the requesting API Key must have the Project Owner role.\n\n**NOTE**: Increasing the following configuration limits might lead to slower response times in the MongoDB Cloud UI or increased user management overhead leading to authentication or authorization re-architecture. If possible, we recommend that you create additional projects to gain access to more of these resources for a more sustainable growth pattern.", "operationId" : "setProjectLimit", "parameters" : [ { - "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", + "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| 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 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n| atlas.project.deployment.salesSoldM0s | Limit on the number of M0 clusters in this project if the org is sales-sold | 100 | 100 |\n", "in" : "path", "name" : "limitName", "required" : true, "schema" : { "type" : "string", - "enum" : [ "atlas.project.security.databaseAccess.users", "atlas.project.deployment.clusters", "atlas.project.deployment.serverlessMTMs", "atlas.project.security.databaseAccess.customRoles", "atlas.project.security.networkAccess.entries", "atlas.project.security.networkAccess.crossRegionEntries", "atlas.project.deployment.nodesPerPrivateLinkRegion", "dataFederation.bytesProcessed.query", "dataFederation.bytesProcessed.daily", "dataFederation.bytesProcessed.weekly", "dataFederation.bytesProcessed.monthly", "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", "atlas.project.deployment.privateServiceConnectionsSubnetMask" ] + "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" @@ -12223,6 +12239,7 @@ }, "/api/atlas/v2/groups/{groupId}/pipelines" : { "get" : { + "deprecated" : true, "description" : "Returns a list of Data Lake Pipelines. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "listPipelines", "parameters" : [ { @@ -12259,10 +12276,16 @@ "DigestAuth" : [ ] } ], "summary" : "Return All Data Lake Pipelines from One Project", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" }, "post" : { + "deprecated" : true, "description" : "Creates one Data Lake Pipeline.", + "externalDocs" : { + "description" : "Data Lake Pipelines are deprecated. Please see Data Lake Deprecation Guide.", + "url" : "https://dochub.mongodb.org/core/data-lake-deprecation" + }, "operationId" : "createPipeline", "parameters" : [ { "$ref" : "#/components/parameters/envelope" @@ -12309,11 +12332,13 @@ "DigestAuth" : [ ] } ], "summary" : "Create One Data Lake Pipeline", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}" : { "delete" : { + "deprecated" : true, "description" : "Removes one Data Lake Pipeline.", "operationId" : "deletePipeline", "parameters" : [ { @@ -12358,9 +12383,11 @@ "DigestAuth" : [ ] } ], "summary" : "Remove One Data Lake Pipeline", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" }, "get" : { + "deprecated" : true, "description" : "Returns the details of one Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "getPipeline", "parameters" : [ { @@ -12407,9 +12434,11 @@ "DigestAuth" : [ ] } ], "summary" : "Return One Data Lake Pipeline", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" }, "patch" : { + "deprecated" : true, "description" : "Updates one Data Lake Pipeline.", "operationId" : "updatePipeline", "parameters" : [ { @@ -12471,11 +12500,13 @@ "DigestAuth" : [ ] } ], "summary" : "Update One Data Lake Pipeline", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules" : { "get" : { + "deprecated" : true, "description" : "Returns a list of backup schedule policy items that you can use as a Data Lake Pipeline source. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "listPipelineSchedules", "parameters" : [ { @@ -12525,11 +12556,13 @@ "DigestAuth" : [ ] } ], "summary" : "Return Available Ingestion Schedules for One Data Lake Pipeline", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots" : { "get" : { + "deprecated" : true, "description" : "Returns a list of backup snapshots that you can use to trigger an on demand pipeline run. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "listPipelineSnapshots", "parameters" : [ { @@ -12551,7 +12584,7 @@ "schema" : { "type" : "string", "format" : "date-time", - "example" : "2022-01-01T00:00:00.000Z" + "example" : "2022-01-01T00:00:00Z" } }, { "description" : "Human-readable label that identifies the Data Lake Pipeline.", @@ -12591,11 +12624,13 @@ "DigestAuth" : [ ] } ], "summary" : "Return Available Backup Snapshots for One Data Lake Pipeline", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause" : { "post" : { + "deprecated" : true, "description" : "Pauses ingestion for a Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "pausePipeline", "parameters" : [ { @@ -12642,11 +12677,13 @@ "DigestAuth" : [ ] } ], "summary" : "Pause One Data Lake Pipeline", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume" : { "post" : { + "deprecated" : true, "description" : "Resumes ingestion for a Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "resumePipeline", "parameters" : [ { @@ -12693,11 +12730,13 @@ "DigestAuth" : [ ] } ], "summary" : "Resume One Data Lake Pipeline", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs" : { "get" : { + "deprecated" : true, "description" : "Returns a list of past Data Lake Pipeline runs. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "listPipelineRuns", "parameters" : [ { @@ -12719,7 +12758,7 @@ "schema" : { "type" : "string", "format" : "date-time", - "example" : "2022-01-01T00:00:00.000Z" + "example" : "2022-01-01T00:00:00Z" } }, { "description" : "Human-readable label that identifies the Data Lake Pipeline.", @@ -12759,11 +12798,13 @@ "DigestAuth" : [ ] } ], "summary" : "Return All Data Lake Pipeline Runs from One Project", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}" : { "delete" : { + "deprecated" : true, "description" : "Deletes dataset that Atlas generated during the specified pipeline run.", "operationId" : "deletePipelineRunDataset", "parameters" : [ { @@ -12822,9 +12863,11 @@ "DigestAuth" : [ ] } ], "summary" : "Delete Pipeline Run Dataset", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" }, "get" : { + "deprecated" : true, "description" : "Returns the details of one Data Lake Pipeline run within the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "getPipelineRun", "parameters" : [ { @@ -12883,11 +12926,13 @@ "DigestAuth" : [ ] } ], "summary" : "Return One Data Lake Pipeline Run", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger" : { "post" : { + "deprecated" : true, "description" : "Triggers a Data Lake Pipeline ingestion of a specified snapshot.", "operationId" : "triggerSnapshotIngestion", "parameters" : [ { @@ -12945,7 +12990,8 @@ "DigestAuth" : [ ] } ], "summary" : "Trigger on demand snapshot ingestion", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService" : { @@ -13105,7 +13151,7 @@ "schema" : { "type" : "string", "maxLength" : 64, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -13158,7 +13204,7 @@ "schema" : { "type" : "string", "maxLength" : 64, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -13217,7 +13263,7 @@ "schema" : { "type" : "string", "maxLength" : 64, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be removed.", @@ -13274,7 +13320,7 @@ "schema" : { "type" : "string", "maxLength" : 64, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the tenant endpoint.", @@ -13331,7 +13377,7 @@ "schema" : { "type" : "string", "maxLength" : 64, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be updated.", @@ -14464,7 +14510,7 @@ "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" ] + "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" ] }, "maxItems" : 10, "minItems" : 1, @@ -14543,7 +14589,7 @@ "items" : { "type" : "string", "description" : "One measurement requested for this MongoDB process.", - "enum" : [ "ASSERT_MSG", "ASSERT_REGULAR", "ASSERT_USER", "ASSERT_WARNING", "BACKGROUND_FLUSH_AVG", "CACHE_BYTES_READ_INTO", "CACHE_BYTES_WRITTEN_FROM", "CACHE_DIRTY_BYTES", "CACHE_USED_BYTES", "COMPUTED_MEMORY", "CONNECTIONS", "CURSORS_TOTAL_OPEN", "CURSORS_TOTAL_TIMED_OUT", "DB_DATA_SIZE_TOTAL", "DB_STORAGE_TOTAL", "DOCUMENT_METRICS_DELETED", "DOCUMENT_METRICS_INSERTED", "DOCUMENT_METRICS_RETURNED", "DOCUMENT_METRICS_UPDATED", "EXTRA_INFO_PAGE_FAULTS", "FTS_DISK_UTILIZATION", "FTS_MEMORY_MAPPED", "FTS_MEMORY_RESIDENT", "FTS_MEMORY_VIRTUAL", "FTS_PROCESS_CPU_KERNEL", "FTS_PROCESS_CPU_USER", "FTS_PROCESS_NORMALIZED_CPU_KERNEL", "FTS_PROCESS_NORMALIZED_CPU_USER", "GLOBAL_ACCESSES_NOT_IN_MEMORY", "GLOBAL_LOCK_CURRENT_QUEUE_READERS", "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL", "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS", "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN", "INDEX_COUNTERS_BTREE_ACCESSES", "INDEX_COUNTERS_BTREE_HITS", "INDEX_COUNTERS_BTREE_MISS_RATIO", "INDEX_COUNTERS_BTREE_MISSES", "JOURNALING_COMMITS_IN_WRITE_LOCK", "JOURNALING_MB", "JOURNALING_WRITE_DATA_FILES_MB", "MAX_PROCESS_CPU_CHILDREN_KERNEL", "MAX_PROCESS_CPU_CHILDREN_USER", "MAX_PROCESS_CPU_KERNEL", "MAX_PROCESS_CPU_USER", "MAX_PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL", "MAX_PROCESS_NORMALIZED_CPU_CHILDREN_USER", "MAX_PROCESS_NORMALIZED_CPU_KERNEL", "MAX_PROCESS_NORMALIZED_CPU_USER", "MAX_SWAP_USAGE_FREE", "MAX_SWAP_USAGE_USED ", "MAX_SYSTEM_CPU_GUEST", "MAX_SYSTEM_CPU_IOWAIT", "MAX_SYSTEM_CPU_IRQ", "MAX_SYSTEM_CPU_KERNEL", "MAX_SYSTEM_CPU_SOFTIRQ", "MAX_SYSTEM_CPU_STEAL", "MAX_SYSTEM_CPU_USER", "MAX_SYSTEM_MEMORY_AVAILABLE", "MAX_SYSTEM_MEMORY_FREE", "MAX_SYSTEM_MEMORY_USED", "MAX_SYSTEM_NETWORK_IN", "MAX_SYSTEM_NETWORK_OUT", "MAX_SYSTEM_NORMALIZED_CPU_GUEST", "MAX_SYSTEM_NORMALIZED_CPU_IOWAIT", "MAX_SYSTEM_NORMALIZED_CPU_IRQ", "MAX_SYSTEM_NORMALIZED_CPU_KERNEL", "MAX_SYSTEM_NORMALIZED_CPU_NICE", "MAX_SYSTEM_NORMALIZED_CPU_SOFTIRQ", "MAX_SYSTEM_NORMALIZED_CPU_STEAL", "MAX_SYSTEM_NORMALIZED_CPU_USER", "MEMORY_MAPPED", "MEMORY_RESIDENT", "MEMORY_VIRTUAL", "NETWORK_BYTES_IN", "NETWORK_BYTES_OUT", "NETWORK_NUM_REQUESTS", "OP_EXECUTION_TIME_COMMANDS", "OP_EXECUTION_TIME_READS", "OP_EXECUTION_TIME_WRITES", "OPCOUNTER_CMD", "OPCOUNTER_DELETE", "OPCOUNTER_GETMORE", "OPCOUNTER_INSERT", "OPCOUNTER_QUERY", "OPCOUNTER_REPL_CMD", "OPCOUNTER_REPL_DELETE", "OPCOUNTER_REPL_INSERT", "OPCOUNTER_REPL_UPDATE", "OPCOUNTER_UPDATE", "OPERATIONS_SCAN_AND_ORDER", "OPLOG_MASTER_LAG_TIME_DIFF", "OPLOG_MASTER_TIME", "OPLOG_RATE_GB_PER_HOUR", "OPLOG_SLAVE_LAG_MASTER_TIME", "OPLOG_REPLICATION_LAG", "PROCESS_CPU_CHILDREN_KERNEL", "PROCESS_CPU_CHILDREN_USER", "PROCESS_CPU_KERNEL", "PROCESS_CPU_USER", "PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL", "PROCESS_NORMALIZED_CPU_CHILDREN_USER", "PROCESS_NORMALIZED_CPU_KERNEL", "PROCESS_NORMALIZED_CPU_USER", "QUERY_EXECUTOR_SCANNED", "QUERY_EXECUTOR_SCANNED_OBJECTS", "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED", "QUERY_TARGETING_SCANNED_PER_RETURNED", "RESTARTS_IN_LAST_HOUR", "SWAP_USAGE_FREE", "SWAP_USAGE_USED", "SYSTEM_CPU_GUEST", "SYSTEM_CPU_IOWAIT", "SYSTEM_CPU_IRQ", "SYSTEM_CPU_KERNEL", "SYSTEM_CPU_NICE", "SYSTEM_CPU_SOFTIRQ", "SYSTEM_CPU_STEAL", "SYSTEM_CPU_USER", "SYSTEM_MEMORY_AVAILABLE", "SYSTEM_MEMORY_FREE", "SYSTEM_MEMORY_USED", "SYSTEM_NETWORK_IN", "SYSTEM_NETWORK_OUT", "SYSTEM_NORMALIZED_CPU_GUEST", "SYSTEM_NORMALIZED_CPU_IOWAIT", "SYSTEM_NORMALIZED_CPU_IRQ", "SYSTEM_NORMALIZED_CPU_KERNEL", "SYSTEM_NORMALIZED_CPU_NICE", "SYSTEM_NORMALIZED_CPU_SOFTIRQ", "SYSTEM_NORMALIZED_CPU_STEAL", "SYSTEM_NORMALIZED_CPU_USER", "TICKETS_AVAILABLE_READS", "TICKETS_AVAILABLE_WRITE", "OPERATION_THROTTLING_REJECTED_OPERATIONS" ] + "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_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" ] }, "maxItems" : 10, "minItems" : 1, @@ -15047,7 +15093,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -15248,7 +15294,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -15297,7 +15343,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -15365,7 +15411,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the restore job to return.", @@ -15433,7 +15479,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -15482,7 +15528,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -15541,7 +15587,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "$ref" : "#/components/parameters/envelope" @@ -15587,7 +15633,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Value that we want to set for the Serverless Auto Indexing toggle.", @@ -15645,20 +15691,20 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { - "204" : { + "202" : { "content" : { "application/vnd.atlas.2023-01-01+json" : { "schema" : { - "$ref" : "#/components/schemas/NoBody" + "$ref" : "#/components/schemas/RequestAccepted" }, "x-xgen-version" : "2023-01-01" } }, - "description" : "This endpoint does not return a response body." + "description" : "Accepted" }, "400" : { "$ref" : "#/components/responses/badRequest" @@ -15697,7 +15743,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -15749,7 +15795,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -15792,29 +15838,25 @@ "tags" : [ "Serverless Instances" ] } }, - "/api/atlas/v2/groups/{groupId}/serviceAccounts" : { + "/api/atlas/v2/groups/{groupId}/settings" : { "get" : { - "description" : "Returns list of Service Accounts for a project with service account details.", - "operationId" : "listProjectServiceAccounts", + "description" : "Returns details about the specified project's settings. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "getProjectSettings", "parameters" : [ { - "$ref" : "#/components/parameters/groupId" - }, { - "$ref" : "#/components/parameters/itemsPerPage" + "$ref" : "#/components/parameters/envelope" }, { - "$ref" : "#/components/parameters/pageNum" + "$ref" : "#/components/parameters/groupId" }, { "$ref" : "#/components/parameters/pretty" - }, { - "$ref" : "#/components/parameters/envelope" } ], "responses" : { "200" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2023-01-01+json" : { "schema" : { - "$ref" : "#/components/schemas/PaginatedGroupServiceAccounts" + "$ref" : "#/components/schemas/GroupSettings" }, - "x-xgen-version" : "2023-10-01" + "x-xgen-version" : "2023-01-01" } }, "description" : "OK" @@ -15825,102 +15867,6 @@ "403" : { "$ref" : "#/components/responses/forbidden" }, - "500" : { - "$ref" : "#/components/responses/internalServerError" - } - }, - "security" : [ { - "DigestAuth" : [ ] - } ], - "summary" : "Return All project Service Accounts", - "tags" : [ "Groups" ] - }, - "post" : { - "description" : "Creates and assigns the specified Service Account to the specified Project.", - "operationId" : "createProjectServiceAccount", - "parameters" : [ { - "$ref" : "#/components/parameters/groupId" - }, { - "$ref" : "#/components/parameters/envelope" - }, { - "$ref" : "#/components/parameters/pretty" - } ], - "requestBody" : { - "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/GroupServiceAccountRequest" - }, - "x-xgen-version" : "2023-10-01" - } - }, - "description" : "Details to create service account and add to the specified project.", - "required" : true - }, - "responses" : { - "201" : { - "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/GroupServiceAccount" - }, - "x-xgen-version" : "2023-10-01" - } - }, - "description" : "Created" - }, - "400" : { - "$ref" : "#/components/responses/badRequest" - }, - "401" : { - "$ref" : "#/components/responses/unauthorized" - }, - "500" : { - "$ref" : "#/components/responses/internalServerError" - } - }, - "security" : [ { - "DigestAuth" : [ ] - } ], - "summary" : "Create and Assign one Service Account to one project", - "tags" : [ "Groups" ] - } - }, - "/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}" : { - "delete" : { - "description" : "Removes one Service Account from the specified project.", - "operationId" : "deleteProjectServiceAccount", - "parameters" : [ { - "description" : "Id of the service account.", - "in" : "path", - "name" : "serviceAccountId", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "$ref" : "#/components/parameters/groupId" - }, { - "$ref" : "#/components/parameters/envelope" - }, { - "$ref" : "#/components/parameters/pretty" - } ], - "responses" : { - "204" : { - "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/NoBody" - }, - "x-xgen-version" : "2023-10-01" - } - }, - "description" : "This endpoint does not return a response body.", - "x-xgen-version" : "2023-10-01" - }, - "401" : { - "$ref" : "#/components/responses/unauthorized" - }, "404" : { "$ref" : "#/components/responses/notFound" }, @@ -15931,189 +15877,30 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Unassign One Service Account from One Project.", - "tags" : [ "Groups" ] - }, - "get" : { - "description" : "Get project Service Account Details.", - "operationId" : "getProjectServiceAccount", - "parameters" : [ { - "$ref" : "#/components/parameters/groupId" - }, { - "description" : "Id of the service account.", - "in" : "path", - "name" : "serviceAccountId", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "$ref" : "#/components/parameters/envelope" - }, { - "$ref" : "#/components/parameters/pretty" - } ], - "responses" : { - "200" : { - "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/GroupServiceAccount" - }, - "x-xgen-version" : "2023-10-01" - } - }, - "description" : "OK" - }, - "401" : { - "$ref" : "#/components/responses/unauthorized" - }, - "404" : { - "$ref" : "#/components/responses/notFound" - }, - "500" : { - "$ref" : "#/components/responses/internalServerError" - } - }, - "security" : [ { - "DigestAuth" : [ ] - } ], - "summary" : "Service Account Fetching", - "tags" : [ "Groups" ] + "summary" : "Return One Project Settings", + "tags" : [ "Projects" ] }, "patch" : { - "description" : "Update Service Account in Project.", - "operationId" : "updateProjectServiceAccount", + "description" : "Updates the settings of the specified project. You can update any of the options available. MongoDB cloud only updates the options provided in the request. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "updateProjectSettings", "parameters" : [ { - "description" : "Id of the service account.", - "in" : "path", - "name" : "serviceAccountId", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "$ref" : "#/components/parameters/groupId" - }, { "$ref" : "#/components/parameters/envelope" - }, { - "$ref" : "#/components/parameters/pretty" - } ], - "requestBody" : { - "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/GroupServiceAccountUpdateRequest" - } - } - }, - "description" : "Details to update service account in the specified Project.", - "required" : true - }, - "responses" : { - "200" : { - "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/GroupServiceAccount" - }, - "x-xgen-version" : "2023-10-01" - } - }, - "description" : "OK" - }, - "400" : { - "$ref" : "#/components/responses/badRequest" - }, - "401" : { - "$ref" : "#/components/responses/unauthorized" - }, - "404" : { - "$ref" : "#/components/responses/notFound" - }, - "500" : { - "$ref" : "#/components/responses/internalServerError" - } - }, - "security" : [ { - "DigestAuth" : [ ] - } ], - "summary" : "Service Account Update in Project", - "tags" : [ "Groups" ] - }, - "post" : { - "description" : "Assigns the specified organization Service Account to the specified project.", - "operationId" : "addProjectServiceAccount", - "parameters" : [ { - "description" : "Id of the service account.", - "in" : "path", - "name" : "serviceAccountId", - "required" : true, - "schema" : { - "type" : "string" - } }, { "$ref" : "#/components/parameters/groupId" - }, { - "$ref" : "#/components/parameters/envelope" }, { "$ref" : "#/components/parameters/pretty" } ], "requestBody" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2023-01-01+json" : { "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/GroupServiceAccountRoleAssignment" - } - }, - "x-xgen-version" : "2023-10-01" + "$ref" : "#/components/schemas/GroupSettings" + } } }, - "description" : "Service Account Roles to be assigned to the specified project.", + "description" : "Settings to update.", "required" : true }, - "responses" : { - "204" : { - "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/NoBody" - }, - "x-xgen-version" : "2023-10-01" - } - }, - "description" : "This endpoint does not return a response body.", - "x-xgen-version" : "2023-10-01" - }, - "401" : { - "$ref" : "#/components/responses/unauthorized" - }, - "404" : { - "$ref" : "#/components/responses/notFound" - }, - "500" : { - "$ref" : "#/components/responses/internalServerError" - } - }, - "security" : [ { - "DigestAuth" : [ ] - } ], - "summary" : "Assign One Service Account to One Project", - "tags" : [ "Groups" ] - } - }, - "/api/atlas/v2/groups/{groupId}/settings" : { - "get" : { - "description" : "Returns details about the specified project's settings. To use this resource, the requesting API Key must have the Project Read Only role.", - "operationId" : "getProjectSettings", - "parameters" : [ { - "$ref" : "#/components/parameters/envelope" - }, { - "$ref" : "#/components/parameters/groupId" - }, { - "$ref" : "#/components/parameters/pretty" - } ], "responses" : { "200" : { "content" : { @@ -16142,51 +15929,92 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Return One Project Settings", + "summary" : "Update One Project Settings", "tags" : [ "Projects" ] - }, - "patch" : { - "description" : "Updates the settings of the specified project. You can update any of the options available. MongoDB cloud only updates the options provided in the request. To use this resource, the requesting API Key must have the Project Owner role.", - "operationId" : "updateProjectSettings", + } + }, + "/api/atlas/v2/groups/{groupId}/streams" : { + "get" : { + "description" : "Returns all stream instances for the specified project.", + "operationId" : "listStreamInstances", "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { "$ref" : "#/components/parameters/envelope" }, { - "$ref" : "#/components/parameters/groupId" + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiStreamsTenantView" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Project Stream Instances", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "post" : { + "description" : "Creates one stream instance in the specified project. To use this resource, the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role.", + "operationId" : "createStreamInstance", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" }, { "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" } ], "requestBody" : { "content" : { - "application/vnd.atlas.2023-01-01+json" : { + "application/vnd.atlas.2023-02-01+json" : { "schema" : { - "$ref" : "#/components/schemas/GroupSettings" + "$ref" : "#/components/schemas/StreamsTenant" } } }, - "description" : "Settings to update.", + "description" : "Details to create one streams instance in the specified project.", "required" : true }, "responses" : { "200" : { "content" : { - "application/vnd.atlas.2023-01-01+json" : { + "application/vnd.atlas.2023-02-01+json" : { "schema" : { - "$ref" : "#/components/schemas/GroupSettings" + "$ref" : "#/components/schemas/StreamsTenant" }, - "x-xgen-version" : "2023-01-01" + "x-xgen-version" : "2023-02-01" } }, "description" : "OK" }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, "401" : { "$ref" : "#/components/responses/unauthorized" }, - "403" : { - "$ref" : "#/components/responses/forbidden" - }, - "404" : { - "$ref" : "#/components/responses/notFound" - }, "500" : { "$ref" : "#/components/responses/internalServerError" } @@ -16194,14 +16022,17 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Update One Project Settings", - "tags" : [ "Projects" ] + "summary" : "Create One Stream Instance", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } } }, - "/api/atlas/v2/groups/{groupId}/streams" : { + "/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections" : { "get" : { - "description" : "Returns all stream instances for the specified project.", - "operationId" : "listStreamInstances", + "description" : "Returns all Private Link connections for the specified project.To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role.", + "operationId" : "listPrivateLinkConnections", "parameters" : [ { "$ref" : "#/components/parameters/groupId" }, { @@ -16218,7 +16049,7 @@ "content" : { "application/vnd.atlas.2023-02-01+json" : { "schema" : { - "$ref" : "#/components/schemas/PaginatedApiStreamsTenantView" + "$ref" : "#/components/schemas/PaginatedApiStreamsPrivateLinkView" }, "x-xgen-version" : "2023-02-01" } @@ -16228,6 +16059,9 @@ "401" : { "$ref" : "#/components/responses/unauthorized" }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, "500" : { "$ref" : "#/components/responses/internalServerError" } @@ -16235,15 +16069,15 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Return All Project Stream Instances", + "summary" : "Return All Private Link", "tags" : [ "Streams" ], "x-xgen-changelog" : { - "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + "2024-10-02" : "The MongoDB Atlas Streams Processing Private Link API is now exposed as part of private preview, but is subject to change until GA." } }, "post" : { - "description" : "Creates one stream instance in the specified project. To use this resource, the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role.", - "operationId" : "createStreamInstance", + "description" : "Creates one Private Link in the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Stream Processing Owner role.", + "operationId" : "createPrivateLinkConnection", "parameters" : [ { "$ref" : "#/components/parameters/envelope" }, { @@ -16255,11 +16089,11 @@ "content" : { "application/vnd.atlas.2023-02-01+json" : { "schema" : { - "$ref" : "#/components/schemas/StreamsTenant" + "$ref" : "#/components/schemas/StreamsPrivateLinkConnection" } } }, - "description" : "Details to create one streams instance in the specified project.", + "description" : "Details to create one Private Link connection for a project. project.", "required" : true }, "responses" : { @@ -16267,7 +16101,7 @@ "content" : { "application/vnd.atlas.2023-02-01+json" : { "schema" : { - "$ref" : "#/components/schemas/StreamsTenant" + "$ref" : "#/components/schemas/StreamsPrivateLinkConnection" }, "x-xgen-version" : "2023-02-01" } @@ -16280,6 +16114,9 @@ "401" : { "$ref" : "#/components/responses/unauthorized" }, + "409" : { + "$ref" : "#/components/responses/unauthorized" + }, "500" : { "$ref" : "#/components/responses/internalServerError" } @@ -16287,13 +16124,310 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Create One Stream Instance", + "summary" : "Create One Private Link connection", "tags" : [ "Streams" ], "x-xgen-changelog" : { - "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + "2024-10-02" : "The MongoDB Atlas Streams Processing Private Link API is now exposed as part of private preview, but is subject to change until GA." } } }, + "/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections/{connectionId}" : { + "delete" : { + "description" : "Deletes one Private Link in the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Stream Processing Owner role.", + "operationId" : "deletePrivateLinkConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique ID that identifies the Private Link connection.", + "in" : "path", + "name" : "connectionId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Accepted" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete One Private Link connection", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2024-10-02" : "The MongoDB Atlas Streams Processing Private Link API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "get" : { + "description" : "Returns the details of one Private Link connection within the project. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "getPrivateLinkConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique ID that identifies the Private Link connection.", + "in" : "path", + "name" : "connectionId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsPrivateLinkConnection" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One PrivateLink Connection", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2024-10-02" : "The MongoDB Atlas Streams Processing Private Link API is now exposed as part of private preview, but is subject to change until GA." + } + } + }, + "/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections" : { + "get" : { + "description" : "Returns a list of incoming VPC Peering Connections.", + "operationId" : "getVPCPeeringConnections", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All VPC Peering Connections.", + "tags" : [ "Streams" ] + } + }, + "/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}" : { + "delete" : { + "description" : "Deletes an incoming VPC Peering connection.", + "operationId" : "deleteVPCPeeringConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "The VPC Peering Connection id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Accepted" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Deletes an incoming VPC Peering connection.", + "tags" : [ "Streams" ] + } + }, + "/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:accept" : { + "post" : { + "description" : "Requests the acceptance of an incoming VPC Peering connection.", + "operationId" : "acceptVPCPeeringConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "The VPC Peering Connection id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/VPCPeeringActionChallenge" + } + } + }, + "description" : "Challenge values for VPC Peering requester account ID, and requester VPC ID.", + "required" : true + }, + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Accepted" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Requests the acceptance of an incoming VPC Peering connection.", + "tags" : [ "Streams" ] + } + }, + "/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:reject" : { + "post" : { + "description" : "Requests the rejection of an incoming VPC Peering connection.", + "operationId" : "rejectVPCPeeringConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "The VPC Peering Connection id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Accepted" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Requests the rejection of an incoming VPC Peering connection.", + "tags" : [ "Streams" ] + } + }, "/api/atlas/v2/groups/{groupId}/streams/{tenantName}" : { "delete" : { "description" : "Delete one stream instance in the specified project. To use this resource, the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role.", @@ -18471,7 +18605,7 @@ "schema" : { "type" : "string", "format" : "date-time", - "example" : "2021-11-17T23:15:00.060Z" + "example" : "2021-11-17T23:15:00.06Z" } } ], "responses" : { @@ -19361,414 +19495,6 @@ "tags" : [ "Cloud Migration Service" ] } }, - "/api/atlas/v2/orgs/{orgId}/serviceAccounts" : { - "get" : { - "description" : "Returns list of Service Accounts with service account details.", - "operationId" : "listServiceAccounts", - "parameters" : [ { - "$ref" : "#/components/parameters/orgId" - }, { - "$ref" : "#/components/parameters/itemsPerPage" - }, { - "$ref" : "#/components/parameters/pageNum" - }, { - "$ref" : "#/components/parameters/pretty" - }, { - "$ref" : "#/components/parameters/envelope" - } ], - "responses" : { - "200" : { - "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/PaginatedOrgServiceAccounts" - }, - "x-xgen-version" : "2023-10-01" - } - }, - "description" : "OK" - }, - "401" : { - "$ref" : "#/components/responses/unauthorized" - }, - "403" : { - "$ref" : "#/components/responses/forbidden" - }, - "500" : { - "$ref" : "#/components/responses/internalServerError" - } - }, - "security" : [ { - "DigestAuth" : [ ] - } ], - "summary" : "Return All Service Accounts", - "tags" : [ "Organizations" ] - }, - "post" : { - "description" : "Create Service Account containing client id and client secrets.", - "operationId" : "createServiceAccount", - "parameters" : [ { - "$ref" : "#/components/parameters/orgId" - }, { - "$ref" : "#/components/parameters/envelope" - }, { - "$ref" : "#/components/parameters/pretty" - } ], - "requestBody" : { - "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/OrgServiceAccountRequest" - } - } - }, - "description" : "Details to create service account in the specified organization.", - "required" : true - }, - "responses" : { - "201" : { - "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/OrgServiceAccount" - }, - "x-xgen-version" : "2023-10-01" - } - }, - "description" : "Created" - }, - "400" : { - "$ref" : "#/components/responses/badRequest" - }, - "401" : { - "$ref" : "#/components/responses/unauthorized" - }, - "500" : { - "$ref" : "#/components/responses/internalServerError" - } - }, - "security" : [ { - "DigestAuth" : [ ] - } ], - "summary" : "Service Account Creation", - "tags" : [ "Organizations" ] - } - }, - "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}" : { - "delete" : { - "description" : "Delete Service Account.", - "operationId" : "deleteServiceAccount", - "parameters" : [ { - "description" : "Id of the service account.", - "in" : "path", - "name" : "serviceAccountId", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "$ref" : "#/components/parameters/orgId" - }, { - "$ref" : "#/components/parameters/envelope" - }, { - "$ref" : "#/components/parameters/pretty" - } ], - "responses" : { - "204" : { - "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "x-xgen-version" : "2023-10-01" - } - }, - "description" : "This endpoint does not return a response body." - }, - "401" : { - "$ref" : "#/components/responses/unauthorized" - }, - "404" : { - "$ref" : "#/components/responses/notFound" - }, - "500" : { - "$ref" : "#/components/responses/internalServerError" - } - }, - "security" : [ { - "DigestAuth" : [ ] - } ], - "summary" : "Service Account Deletion.", - "tags" : [ "Organizations" ] - }, - "get" : { - "description" : "Get Service Account Details.", - "operationId" : "getServiceAccount", - "parameters" : [ { - "$ref" : "#/components/parameters/orgId" - }, { - "description" : "Id of the service account.", - "in" : "path", - "name" : "serviceAccountId", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "$ref" : "#/components/parameters/envelope" - }, { - "$ref" : "#/components/parameters/pretty" - } ], - "responses" : { - "200" : { - "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/OrgServiceAccount" - }, - "x-xgen-version" : "2023-10-01" - } - }, - "description" : "OK" - }, - "401" : { - "$ref" : "#/components/responses/unauthorized" - }, - "404" : { - "$ref" : "#/components/responses/notFound" - }, - "500" : { - "$ref" : "#/components/responses/internalServerError" - } - }, - "security" : [ { - "DigestAuth" : [ ] - } ], - "summary" : "Service Account Fetching", - "tags" : [ "Organizations" ] - }, - "patch" : { - "description" : "Update Service Account.", - "operationId" : "updateServiceAccount", - "parameters" : [ { - "description" : "Id of the service account.", - "in" : "path", - "name" : "serviceAccountId", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "$ref" : "#/components/parameters/orgId" - }, { - "$ref" : "#/components/parameters/envelope" - }, { - "$ref" : "#/components/parameters/pretty" - } ], - "requestBody" : { - "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/OrgServiceAccountUpdateRequest" - } - } - }, - "description" : "Details to update service account in the specified organization.", - "required" : true - }, - "responses" : { - "200" : { - "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/OrgServiceAccount" - }, - "x-xgen-version" : "2023-10-01" - } - }, - "description" : "OK" - }, - "400" : { - "$ref" : "#/components/responses/badRequest" - }, - "401" : { - "$ref" : "#/components/responses/unauthorized" - }, - "404" : { - "$ref" : "#/components/responses/notFound" - }, - "500" : { - "$ref" : "#/components/responses/internalServerError" - } - }, - "security" : [ { - "DigestAuth" : [ ] - } ], - "summary" : "Service Account Update", - "tags" : [ "Organizations" ] - } - }, - "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/groups" : { - "get" : { - "description" : "Returns list of Service Account projects.", - "operationId" : "listServiceAccountProjects", - "parameters" : [ { - "$ref" : "#/components/parameters/orgId" - }, { - "description" : "Id of the service account.", - "in" : "path", - "name" : "serviceAccountId", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "$ref" : "#/components/parameters/itemsPerPage" - }, { - "$ref" : "#/components/parameters/pageNum" - }, { - "$ref" : "#/components/parameters/pretty" - }, { - "$ref" : "#/components/parameters/envelope" - } ], - "responses" : { - "200" : { - "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/PaginatedServiceAccountGroup" - }, - "x-xgen-version" : "2023-10-01" - } - }, - "description" : "OK" - }, - "401" : { - "$ref" : "#/components/responses/unauthorized" - }, - "403" : { - "$ref" : "#/components/responses/forbidden" - }, - "500" : { - "$ref" : "#/components/responses/internalServerError" - } - }, - "security" : [ { - "DigestAuth" : [ ] - } ], - "summary" : "Return All Service Account projects", - "tags" : [ "Organizations" ] - } - }, - "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets" : { - "post" : { - "description" : "Create Service Account secret.", - "operationId" : "createServiceAccountSecret", - "parameters" : [ { - "$ref" : "#/components/parameters/orgId" - }, { - "description" : "Id of the service account.", - "in" : "path", - "name" : "serviceAccountId", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "$ref" : "#/components/parameters/envelope" - }, { - "$ref" : "#/components/parameters/pretty" - } ], - "requestBody" : { - "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/ServiceAccountSecretRequest" - } - } - }, - "description" : "Details to create secret in the specified service account.", - "required" : true - }, - "responses" : { - "201" : { - "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/ServiceAccountSecret" - }, - "x-xgen-version" : "2023-10-01" - } - }, - "description" : "Created" - }, - "400" : { - "$ref" : "#/components/responses/badRequest" - }, - "401" : { - "$ref" : "#/components/responses/unauthorized" - }, - "500" : { - "$ref" : "#/components/responses/internalServerError" - } - }, - "security" : [ { - "DigestAuth" : [ ] - } ], - "summary" : "Service Account Secret Creation", - "tags" : [ "Organizations" ] - } - }, - "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets/{secretId}" : { - "delete" : { - "description" : "Delete Service Account Secret.", - "operationId" : "deleteServiceAccountSecret", - "parameters" : [ { - "description" : "Id of the service account.", - "in" : "path", - "name" : "serviceAccountId", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "description" : "Id of the secret.", - "in" : "path", - "name" : "secretId", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "$ref" : "#/components/parameters/orgId" - }, { - "$ref" : "#/components/parameters/envelope" - }, { - "$ref" : "#/components/parameters/pretty" - } ], - "responses" : { - "204" : { - "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "x-xgen-version" : "2023-10-01" - } - }, - "description" : "This endpoint does not return a response body." - }, - "401" : { - "$ref" : "#/components/responses/unauthorized" - }, - "404" : { - "$ref" : "#/components/responses/notFound" - }, - "500" : { - "$ref" : "#/components/responses/internalServerError" - } - }, - "security" : [ { - "DigestAuth" : [ ] - } ], - "summary" : "Service Account Secret Deletion.", - "tags" : [ "Organizations" ] - } - }, "/api/atlas/v2/orgs/{orgId}/settings" : { "get" : { "description" : "Returns details about the specified organization's settings. To use this resource, the requesting API Key must have the Organization Owner role.", @@ -19844,6 +19570,9 @@ }, "description" : "OK" }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, "401" : { "$ref" : "#/components/responses/unauthorized" }, @@ -20470,12 +20199,15 @@ }, "/api/atlas/v2/orgs/{orgId}/users/{userId}" : { "delete" : { + "deprecated" : true, "description" : "Removes one MongoDB Cloud user from the specified organization. To use this resource, the requesting API Key must have the Organization User Admin role.", "operationId" : "removeOrganizationUser", "parameters" : [ { "$ref" : "#/components/parameters/envelope" }, { "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" }, { "description" : "Unique 24-hexadecimal digit string that identifies the user to be deleted.", "in" : "path", @@ -20519,8 +20251,9 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Remove One MongoDB Cloud User from One Organization", - "tags" : [ "Organizations" ] + "summary" : "Remove One MongoDB Cloud User From One Organization", + "tags" : [ "Organizations" ], + "x-sunset" : "2026-01-01" } }, "/api/atlas/v2/orgs/{orgId}/users/{userId}/roles" : { @@ -21241,7 +20974,7 @@ "diskIOPS" : { "type" : "integer", "format" : "int32", - "description" : "Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.\n\n Change this parameter only if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" to \"AWS\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" to \"M30\"` or greater (not including `Mxx_NVME` tiers).\n\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType\" to \"PROVISIONED\"`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1." + "description" : "Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.\n\n Change this parameter if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" to \"AWS\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" to \"M30\"` or greater (not including `Mxx_NVME` tiers).\n\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType\" to \"PROVISIONED\"`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1." }, "ebsVolumeType" : { "type" : "string", @@ -21270,7 +21003,7 @@ "diskIOPS" : { "type" : "integer", "format" : "int32", - "description" : "Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.\n\n You can set different IOPS values on different shards when provisioned IOPS are supported.\n\n Change this parameter only if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" to \"AWS\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" to \"M30\"` or greater (not including `Mxx_NVME` tiers).\n\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType\" to \"PROVISIONED\"`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1." + "description" : "Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.\n\n You can set different IOPS values on different shards when provisioned IOPS are supported.\n\n Change this parameter if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" to \"AWS\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" to \"M30\"` or greater (not including `Mxx_NVME` tiers).\n\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType\" to \"PROVISIONED\"`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1." }, "diskSizeGB" : { "type" : "number", @@ -21601,6 +21334,26 @@ "description" : "Configuration of nodes that comprise the cluster.", "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] }, + "configServerManagementMode" : { + "type" : "string", + "default" : "ATLAS_MANAGED", + "description" : "Config Server Management Mode for creating or updating a sharded cluster.\n\nWhen configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings.\n\nWhen configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server.", + "enum" : [ "ATLAS_MANAGED", "FIXED_TO_DEDICATED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + } + }, + "configServerType" : { + "type" : "string", + "description" : "Describes a sharded cluster's config server type.", + "enum" : [ "DEDICATED", "EMBEDDED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + }, + "readOnly" : true + }, "connectionStrings" : { "$ref" : "#/components/schemas/ClusterConnectionStrings" }, @@ -21636,6 +21389,17 @@ "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" } }, + "featureCompatibilityVersion" : { + "type" : "string", + "description" : "Feature compatibility version of the cluster.", + "readOnly" : true + }, + "featureCompatibilityVersionExpirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Feature compatibility version expiration date.", + "readOnly" : true + }, "globalClusterSelfManagedSharding" : { "type" : "boolean", "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen 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.\n\nWhen 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.\n\nThis setting cannot be changed once the cluster is deployed.", @@ -21682,6 +21446,9 @@ }, "readOnly" : true }, + "mongoDBEmployeeAccessGrant" : { + "$ref" : "#/components/schemas/EmployeeAccessGrantView" + }, "mongoDBMajorVersion" : { "type" : "string", "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", @@ -21701,7 +21468,7 @@ "description" : "Human-readable label that identifies the advanced cluster.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, "paused" : { "type" : "boolean", @@ -21715,6 +21482,16 @@ "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" } }, + "replicaSetScalingStrategy" : { + "type" : "string", + "default" : "WORKLOAD_TYPE", + "description" : "Set this field to configure the replica set scaling mode for your cluster.\n\nBy default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes.\n\nWhen configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads.\n\nWhen configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads.", + "enum" : [ "SEQUENTIAL", "WORKLOAD_TYPE", "NODE_TYPE" ], + "externalDocs" : { + "description" : "Modify the Replica Set Scaling Mode", + "url" : "https://dochub.mongodb.org/core/scale-nodes" + } + }, "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.", @@ -22585,6 +22362,257 @@ }, "title" : "mappings" }, + "ApiAtlasInvalidPolicyErrorDetailView" : { + "type" : "object", + "properties" : { + "detail" : { + "type" : "string", + "description" : "A string that provides a detailed description of a validation error.", + "readOnly" : true + } + } + }, + "ApiAtlasInvalidPolicyView" : { + "type" : "object", + "properties" : { + "body" : { + "type" : "string", + "description" : "A string that defines the permissions for the policy. The syntax used is the Cedar Policy language.", + "example" : " forbid (\n principal,\n action == cloud::Action::\"cluster.createEdit\",\n resource\n ) when {\n context.cluster.regions.contains(cloud::region::\"aws:us-east-1\")\n };\n", + "readOnly" : true + }, + "errors" : { + "type" : "array", + "description" : "List of validation errors.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasInvalidPolicyErrorDetailView" + }, + "readOnly" : true + } + } + }, + "ApiAtlasInvalidResourcePolicyCreateErrorView" : { + "type" : "object", + "properties" : { + "errorType" : { + "type" : "string", + "description" : "Human-readable label that displays the type of an error.", + "enum" : [ "POLICY_PARSING_ERROR", "POLICY_HAS_FAILED_VALIDATIONS", "POLICY_HAS_INVALID_PRINCIPAL", "POLICY_HAS_BODY_EXCEEDING_MAX_SIZE", "POLICY_HAS_UNEXPECTED_ENTITIES" ] + }, + "invalidPolicies" : { + "type" : "array", + "description" : "List of invalid policies containing details of their validation errors.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasInvalidPolicyView" + }, + "readOnly" : true + } + } + }, + "ApiAtlasNonCompliantResourceView" : { + "type" : "object", + "properties" : { + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization the resource belongs to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resourceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the non-compliant resource.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resourcePoliciesCausingNonCompliance" : { + "type" : "array", + "description" : "List of resource policies causing the resource to be considered non-compliant.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasResourcePolicyMetadataView" + }, + "readOnly" : true + }, + "resourceType" : { + "type" : "string", + "description" : "Human-readable label that displays the type of a resource.", + "enum" : [ "PROJECT", "CLUSTER" ], + "readOnly" : true + } + } + }, + "ApiAtlasPolicyCreateView" : { + "type" : "object", + "properties" : { + "body" : { + "type" : "string", + "description" : "A string that defines the permissions for the policy. The syntax used is the Cedar Policy language.", + "example" : " forbid (\n principal,\n action == cloud::Action::\"cluster.createEdit\",\n resource\n ) when {\n context.cluster.regions.contains(cloud::region::\"aws:us-east-1\")\n };\n" + } + }, + "required" : [ "body" ] + }, + "ApiAtlasPolicyMetadataView" : { + "type" : "object", + "properties" : { + "policyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "ApiAtlasPolicyView" : { + "type" : "object", + "properties" : { + "body" : { + "type" : "string", + "description" : "A string that defines the permissions for the policy. The syntax used is the Cedar Policy language.", + "example" : " forbid (\n principal,\n action == cloud::Action::\"cluster.createEdit\",\n resource\n ) when {\n context.cluster.regions.contains(cloud::region::\"aws:us-east-1\")\n };\n", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "ApiAtlasResourcePolicyCreateView" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that describes the atlas resource policy." + }, + "policies" : { + "type" : "array", + "description" : "List of policies that make up the atlas resource policy.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasPolicyCreateView" + } + } + }, + "required" : [ "name", "policies" ] + }, + "ApiAtlasResourcePolicyEditView" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that describes the atlas resource policy." + }, + "policies" : { + "type" : "array", + "description" : "List of policies that make up the atlas resource policy.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasPolicyCreateView" + } + } + } + }, + "ApiAtlasResourcePolicyMetadataView" : { + "type" : "object", + "properties" : { + "policiesCausingNonCompliance" : { + "type" : "array", + "description" : "List of policies that are in conflict with the current state of the resource.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasPolicyMetadataView" + }, + "readOnly" : true + }, + "resourcePolicyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the atlas resource policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resourcePolicyName" : { + "type" : "string", + "description" : "Human-readable label that describes the atlas resource policy.", + "readOnly" : true + } + } + }, + "ApiAtlasResourcePolicyView" : { + "type" : "object", + "properties" : { + "createdByUser" : { + "$ref" : "#/components/schemas/ApiAtlasUserMetadataView" + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time in UTC when the atlas resource policy was created.", + "example" : "2022-01-01T00:00:00Z", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the atlas resource policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastUpdatedByUser" : { + "$ref" : "#/components/schemas/ApiAtlasUserMetadataView" + }, + "lastUpdatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time in UTC when the atlas resource policy was last updated.", + "example" : "2022-01-01T00:00:00Z", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that describes the atlas resource policy.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization the atlas resource policy belongs to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "policies" : { + "type" : "array", + "description" : "List of policies that make up the atlas resource policy.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasPolicyView" + }, + "readOnly" : true + }, + "version" : { + "type" : "string", + "description" : "A string that identifies the version of the atlas resource policy.", + "example" : "v1", + "readOnly" : true + } + } + }, "ApiAtlasSnapshotScheduleView" : { "type" : "object", "properties" : { @@ -22661,6 +22689,27 @@ }, "required" : [ "clusterCheckpointIntervalMin", "clusterId", "dailySnapshotRetentionDays", "groupId", "monthlySnapshotRetentionMonths", "pointInTimeWindowHours", "snapshotIntervalHours", "snapshotRetentionDays", "weeklySnapshotRetentionWeeks" ] }, + "ApiAtlasUserMetadataView" : { + "type" : "object", + "description" : "The user that last updated the atlas resource policy.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies a user.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that describes a user.", + "readOnly" : true + } + }, + "readOnly" : true + }, "ApiBSONTimestampView" : { "type" : "object", "description" : "BSON timestamp that indicates when the checkpoint token entry in the oplog occurred.", @@ -22717,6 +22766,9 @@ "ApiError" : { "type" : "object", "properties" : { + "badRequestDetail" : { + "$ref" : "#/components/schemas/BadRequestDetail" + }, "detail" : { "type" : "string", "description" : "Describes the specific conditions or reasons that cause each type of error." @@ -22727,24 +22779,30 @@ "description" : "HTTP status code returned with this error.", "externalDocs" : { "url" : "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status" - } + }, + "readOnly" : true }, "errorCode" : { "type" : "string", - "description" : "Application error code returned with this error." + "description" : "Application error code returned with this error.", + "readOnly" : true }, "parameters" : { "type" : "array", "description" : "Parameters used to give more information about the error.", "items" : { - "type" : "object" - } + "type" : "object", + "readOnly" : true + }, + "readOnly" : true }, "reason" : { "type" : "string", - "description" : "Application error message returned with this error." + "description" : "Application error message returned with this error.", + "readOnly" : true } - } + }, + "required" : [ "error", "errorCode" ] }, "ApiHostView_Atlas" : { "type" : "object", @@ -23000,6 +23058,24 @@ } } }, + "ApiPrivateDownloadDeliveryUrl" : { + "type" : "object", + "description" : "One Uniform Resource Locator (URL) that points to the compressed snapshot files for manual download and the corresponding private endpoint.", + "properties" : { + "deliveryUrl" : { + "type" : "string", + "description" : "One Uniform Resource Locator that points to the compressed snapshot files for manual download." + }, + "endpointId" : { + "type" : "string", + "description" : "Unique 22-character alphanumeric string that identifies the private endpoint.", + "example" : "vpce-3bf78b0ddee411ba1", + "maxLength" : 22, + "minLength" : 22, + "pattern" : "^vpce-[0-9a-f]{17}$" + } + } + }, "ApiPublicUsageDetailsQueryRequest" : { "type" : "object", "description" : "Request body for an Invoice Usage Details query with filtering, pagination, and sort.", @@ -23093,7 +23169,12 @@ "ApiStreamsAWSRegionView" : { "type" : "string", "description" : "Atlas Streams AWS Regions.", - "enum" : [ "VIRGINIA_USA" ] + "enum" : [ "SYDNEY_AUS", "MUMBAI_IND", "FRANKFURT_DEU", "DUBLIN_IRL", "LONDON_GBR", "VIRGINIA_USA", "OREGON_USA", "SAOPAULO_BRA", "MONTREAL_CAN", "TOKYO_JPN", "SINGAPORE_SGP" ] + }, + "ApiStreamsAzureRegionView" : { + "type" : "string", + "description" : "Atlas Streams Azure Regions.", + "enum" : [ "VIRGINIA_USA", "AMSTERDAM_NLD" ] }, "ApiUserEventTypeViewForNdsGroup" : { "type" : "string", @@ -23317,6 +23398,15 @@ "required" : [ "created", "eventTypeName", "id" ], "title" : "API User Events" }, + "ApiVersion" : { + "type" : "object", + "properties" : { + "version" : { + "type" : "string", + "description" : "Object representing a version of the Atlas Admin API." + } + } + }, "AppServiceAlertConfigViewForNdsGroup" : { "type" : "object", "description" : "App Services metric alert configuration allows to select which app service conditions and events trigger alerts and how users are notified.", @@ -23739,7 +23829,9 @@ "enum" : [ "AVERAGE" ] }, "operator" : { - "$ref" : "#/components/schemas/Operator" + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, "threshold" : { "type" : "number", @@ -23779,6 +23871,11 @@ "description" : "Atlas Data Federation Azure Regions.", "enum" : [ "VIRGINIA_USA", "AMSTERDAM_NLD" ] }, + "AtlasDataFederationGCPRegion" : { + "type" : "string", + "description" : "Atlas Data Federation GCP Regions.", + "enum" : [ "IOWA_USA", "BELGIUM_EU" ] + }, "AtlasOrganization" : { "type" : "object", "description" : "Details that describe the organization.", @@ -23819,6 +23916,122 @@ }, "required" : [ "name" ] }, + "AtlasResourcePolicyAuditForOrg" : { + "type" : "object", + "description" : "Atlas resource policy audits indicate org level changes to resource policies", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "RESOURCE_POLICY_CREATED", "RESOURCE_POLICY_MODIFIED", "RESOURCE_POLICY_DELETED" ], + "example" : "RESOURCE_POLICY_CREATED", + "title" : "Atlas Resource Policy Audit Types" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "resourcePolicyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the resource policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Atlas Resource Policy Audits" + }, "AtlasSearchAnalyzer" : { "type" : "object", "properties" : { @@ -24334,6 +24547,15 @@ "AzureHardwareSpec" : { "type" : "object", "properties" : { + "diskIOPS" : { + "type" : "integer", + "format" : "int32", + "description" : "Target throughput desired for storage attached to your Azure-provisioned cluster. Change this parameter if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" : \"Azure\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : \"M40\"` or greater not including `Mxx_NVME` tiers.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://www.mongodb.com/docs/atlas/customize-storage/#extend-iops-on-azure" + } + }, "instanceSize" : { "type" : "string", "description" : "Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts of the node type.", @@ -24350,6 +24572,15 @@ "AzureHardwareSpec20240805" : { "type" : "object", "properties" : { + "diskIOPS" : { + "type" : "integer", + "format" : "int32", + "description" : "Target throughput desired for storage attached to your Azure-provisioned cluster. Change this parameter if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" : \"Azure\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : \"M40\"` or greater not including `Mxx_NVME` tiers.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://www.mongodb.com/docs/atlas/customize-storage/#extend-iops-on-azure" + } + }, "diskSizeGB" : { "type" : "number", "format" : "double", @@ -24477,7 +24708,7 @@ "status" : { "type" : "string", "description" : "State of the Encryption At Rest private endpoint.", - "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "ACTIVE", "FAILED" ], + "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "ACTIVE", "FAILED", "PENDING_RECREATION", "DELETING" ], "readOnly" : true } }, @@ -24810,7 +25041,7 @@ "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to create an online archive.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "collName" : { @@ -24894,7 +25125,7 @@ "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to create an online archive.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "collName" : { @@ -24997,7 +25228,7 @@ "description" : "Human-readable label that identifies the cluster containing the snapshots you want to retrieve.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -25154,7 +25385,7 @@ "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\"`.\n\nIf the target cluster doesn't have backup enabled, two resources return parameters with empty values:\n\n- **Get All Snapshots** endpoint returns an empty results array without **clusterId** elements\n- **Get a Snapshot** endpoint doesn't return a **clusterId** parameter.\n\nTo return a response with the **clusterId** parameter, either use the **delivery.targetClusterName** parameter or enable backup on the target cluster.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, "targetGroupId" : { "type" : "string", @@ -25415,6 +25646,20 @@ } } }, + "BadRequestDetail" : { + "type" : "object", + "description" : "Bad request detail.", + "properties" : { + "fields" : { + "type" : "array", + "description" : "Describes all violations in a client request.", + "items" : { + "$ref" : "#/components/schemas/FieldViolation" + } + } + }, + "readOnly" : true + }, "BaseAtlasDataLakeRegion" : { "type" : "object", "description" : "Name of the region to which the data lake routes client connections.", @@ -25422,6 +25667,8 @@ "$ref" : "#/components/schemas/ApiAtlasDataLakeAWSRegionView" }, { "$ref" : "#/components/schemas/AtlasDataFederationAzureRegion" + }, { + "$ref" : "#/components/schemas/AtlasDataFederationGCPRegion" } ] }, "BaseCloudProviderInstanceSize" : { @@ -25489,6 +25736,8 @@ "description" : "Name of the cloud provider region hosting Atlas Stream Processing.", "oneOf" : [ { "$ref" : "#/components/schemas/ApiStreamsAWSRegionView" + }, { + "$ref" : "#/components/schemas/ApiStreamsAzureRegionView" } ] }, "BasicBSONList" : { @@ -26378,7 +26627,7 @@ "description" : "Human-readable label that identifies the cluster.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "nodeCount" : { @@ -26430,6 +26679,11 @@ "format" : "date-time", "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." }, + "description" : { + "type" : "string", + "description" : "Description of this database user.", + "maxLength" : 100 + }, "groupId" : { "type" : "string", "description" : "Unique 24-hexadecimal digit string that identifies the project.", @@ -26608,6 +26862,123 @@ "description" : "Details that describe the features linked to the Amazon Web Services (AWS) Identity and Access Management (IAM) role.", "required" : [ "providerName" ] }, + "CloudProviderAccessAWSIAMRoleRequest" : { + "type" : "object", + "description" : "Details that describe the features linked to the Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "properties" : { + "atlasAWSAccountArn" : { + "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.", + "example" : "arn:aws:iam::772401394250:role/my-test-aws-role", + "maxLength" : 2048, + "minLength" : 20, + "readOnly" : true + }, + "atlasAssumedRoleExternalId" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique external ID that MongoDB Cloud uses when it assumes the IAM role in your Amazon Web Services (AWS) account.", + "readOnly" : true + }, + "authorizedDate" : { + "type" : "string", + "format" : "date-time", + "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.", + "readOnly" : true + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "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.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider of the role.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "roleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + }, + "required" : [ "providerName" ] + }, + "CloudProviderAccessAWSIAMRoleRequestUpdate" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessRoleRequestUpdate" + }, { + "type" : "object", + "properties" : { + "atlasAWSAccountArn" : { + "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.", + "example" : "arn:aws:iam::772401394250:role/my-test-aws-role", + "maxLength" : 2048, + "minLength" : 20, + "readOnly" : true + }, + "atlasAssumedRoleExternalId" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique external ID that MongoDB Cloud uses when it assumes the IAM role in your Amazon Web Services (AWS) account.", + "readOnly" : true + }, + "authorizedDate" : { + "type" : "string", + "format" : "date-time", + "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.", + "readOnly" : true + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "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.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "iamAssumedRoleArn" : { + "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", + "maxLength" : 2048, + "minLength" : 20 + }, + "roleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + } ], + "description" : "Details that describe the features linked to the Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "required" : [ "providerName" ] + }, "CloudProviderAccessAzureServicePrincipal" : { "type" : "object", "allOf" : [ { @@ -26670,6 +27041,130 @@ "description" : "Details that describe the features linked to the Azure Service Principal.", "required" : [ "providerName" ] }, + "CloudProviderAccessAzureServicePrincipalRequest" : { + "type" : "object", + "description" : "Details that describe the features linked to the Azure Service Principal.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "atlasAzureAppId" : { + "type" : "string", + "description" : "Azure Active Directory Application ID of Atlas.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this Azure Service Principal was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Azure Service Principal.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "lastUpdatedDate" : { + "type" : "string", + "format" : "date-time", + "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.", + "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.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "tenantId" : { + "type" : "string", + "description" : "UUID String that identifies the Azure Active Directory Tenant ID.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + } + }, + "required" : [ "providerName" ] + }, + "CloudProviderAccessAzureServicePrincipalRequestUpdate" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessRoleRequestUpdate" + }, { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "atlasAzureAppId" : { + "type" : "string", + "description" : "Azure Active Directory Application ID of Atlas.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this Azure Service Principal was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Azure Service Principal.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "lastUpdatedDate" : { + "type" : "string", + "format" : "date-time", + "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.", + "readOnly" : true + }, + "servicePrincipalId" : { + "type" : "string", + "description" : "UUID string that identifies the Azure Service Principal.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "tenantId" : { + "type" : "string", + "description" : "UUID String that identifies the Azure Active Directory Tenant ID.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + } + } + } ], + "description" : "Details that describe the features linked to the Azure Service Principal.", + "required" : [ "providerName" ] + }, "CloudProviderAccessDataLakeFeatureUsage" : { "type" : "object", "allOf" : [ { @@ -26796,6 +27291,92 @@ } } }, + "CloudProviderAccessGCPServiceAccount" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, { + "type" : "object", + "properties" : { + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this Google Service Account was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Google Service Account.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "gcpServiceAccountForAtlas" : { + "type" : "string", + "description" : "Email address for the Google Service Account created by Atlas.", + "maxLength" : 82, + "minLength" : 57, + "pattern" : "^mongodb-atlas-[0-9a-z]{16}@p-[0-9a-z]{24}.iam.gserviceaccount.com$" + }, + "roleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + } ], + "description" : "Details that describe the features linked to the GCP Service Account.", + "required" : [ "providerName" ] + }, + "CloudProviderAccessGCPServiceAccountRequest" : { + "type" : "object", + "description" : "Details that describe the features linked to the GCP Service Account.", + "properties" : { + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this GCP Service Account was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this GCP Service Account.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "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" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "readOnly" : true + } + }, + "required" : [ "providerName" ] + }, + "CloudProviderAccessGCPServiceAccountRequestUpdate" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessRoleRequestUpdate" + } ], + "description" : "Details that describe the features linked to the GCP Service Account.", + "required" : [ "providerName" ] + }, "CloudProviderAccessPushBasedLogExportFeatureUsage" : { "type" : "object", "allOf" : [ { @@ -26816,20 +27397,63 @@ "discriminator" : { "mapping" : { "AWS" : "#/components/schemas/CloudProviderAccessAWSIAMRole", - "AZURE" : "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + "AZURE" : "#/components/schemas/CloudProviderAccessAzureServicePrincipal", + "GCP" : "#/components/schemas/CloudProviderAccessGCPServiceAccount" + }, + "propertyName" : "providerName" + }, + "properties" : { + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider of the role.", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, + "required" : [ "providerName" ] + }, + "CloudProviderAccessRoleRequest" : { + "type" : "object", + "description" : "Cloud provider access role.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/CloudProviderAccessAWSIAMRoleRequest", + "AZURE" : "#/components/schemas/CloudProviderAccessAzureServicePrincipalRequest", + "GCP" : "#/components/schemas/CloudProviderAccessGCPServiceAccountRequest" }, "propertyName" : "providerName" }, "oneOf" : [ { - "$ref" : "#/components/schemas/CloudProviderAccessAWSIAMRole" + "$ref" : "#/components/schemas/CloudProviderAccessAWSIAMRoleRequest" + }, { + "$ref" : "#/components/schemas/CloudProviderAccessAzureServicePrincipalRequest" }, { - "$ref" : "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + "$ref" : "#/components/schemas/CloudProviderAccessGCPServiceAccountRequest" } ], "properties" : { "providerName" : { "type" : "string", "description" : "Human-readable label that identifies the cloud provider of the role.", - "enum" : [ "AWS", "AZURE" ] + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, + "required" : [ "providerName" ] + }, + "CloudProviderAccessRoleRequestUpdate" : { + "type" : "object", + "description" : "Cloud provider access role.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/CloudProviderAccessAWSIAMRoleRequestUpdate", + "AZURE" : "#/components/schemas/CloudProviderAccessAzureServicePrincipalRequestUpdate", + "GCP" : "#/components/schemas/CloudProviderAccessGCPServiceAccountRequestUpdate" + }, + "propertyName" : "providerName" + }, + "properties" : { + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider of the role.", + "enum" : [ "AWS", "AZURE", "GCP" ] } }, "required" : [ "providerName" ] @@ -26843,6 +27467,13 @@ "items" : { "$ref" : "#/components/schemas/CloudProviderAccessAWSIAMRole" } + }, + "azureServicePrincipals" : { + "type" : "array", + "description" : "List that contains the Azure Service Principals registered with MongoDB Cloud.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + } } } }, @@ -27225,7 +27856,7 @@ "example" : "cluster1", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -27318,6 +27949,7 @@ }, "diskGBEnabled" : { "type" : "boolean", + "default" : false, "description" : "Flag that indicates whether someone enabled disk auto-scaling for this cluster." } }, @@ -27347,10 +27979,12 @@ "properties" : { "enabled" : { "type" : "boolean", + "default" : false, "description" : "Flag that indicates whether cluster tier auto-scaling is enabled. Set to `true` to enable cluster tier auto-scaling. If enabled, you must specify a value for **providerSettings.autoScaling.compute.maxInstanceSize** also. Set to `false` to disable cluster tier auto-scaling." }, "scaleDownEnabled" : { "type" : "boolean", + "default" : false, "description" : "Flag that indicates whether the cluster tier can scale down. This is required if **autoScaling.compute.enabled** is `true`. If you enable this option, specify a value for **providerSettings.autoScaling.compute.minInstanceSize**." } } @@ -27385,14 +28019,14 @@ "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.", + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to Atlas through the interface endpoint that the key names. If the cluster uses an optimized connection string, `awsPrivateLinkSrv` contains the optimized connection string. If the cluster has the non-optimized (legacy) connection string, `awsPrivateLinkSrv` contains the non-optimized connection string even if an optimized connection string is also present.", "externalDocs" : { "description" : "Network Peering Connection", "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" }, "readOnly" : true }, - "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.", + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to Atlas through the interface endpoint that the key names. If the cluster uses an optimized connection string, `awsPrivateLinkSrv` contains the optimized connection string. If the cluster has the non-optimized (legacy) connection string, `awsPrivateLinkSrv` contains the non-optimized connection string even if an optimized connection string is also present.", "externalDocs" : { "description" : "Network Peering Connection", "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" @@ -27472,6 +28106,26 @@ "description" : "Configuration of nodes that comprise the cluster.", "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] }, + "configServerManagementMode" : { + "type" : "string", + "default" : "ATLAS_MANAGED", + "description" : "Config Server Management Mode for creating or updating a sharded cluster.\n\nWhen configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings.\n\nWhen configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server.", + "enum" : [ "ATLAS_MANAGED", "FIXED_TO_DEDICATED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + } + }, + "configServerType" : { + "type" : "string", + "description" : "Describes a sharded cluster's config server type.", + "enum" : [ "DEDICATED", "EMBEDDED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + }, + "readOnly" : true + }, "connectionStrings" : { "$ref" : "#/components/schemas/ClusterConnectionStrings" }, @@ -27500,6 +28154,17 @@ "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" } }, + "featureCompatibilityVersion" : { + "type" : "string", + "description" : "Feature compatibility version of the cluster.", + "readOnly" : true + }, + "featureCompatibilityVersionExpirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Feature compatibility version expiration date.", + "readOnly" : true + }, "globalClusterSelfManagedSharding" : { "type" : "boolean", "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen 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.\n\nWhen 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.\n\nThis setting cannot be changed once the cluster is deployed.", @@ -27546,6 +28211,9 @@ }, "readOnly" : true }, + "mongoDBEmployeeAccessGrant" : { + "$ref" : "#/components/schemas/EmployeeAccessGrantView" + }, "mongoDBMajorVersion" : { "type" : "string", "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", @@ -27565,7 +28233,7 @@ "description" : "Human-readable label that identifies the cluster.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, "paused" : { "type" : "boolean", @@ -27579,6 +28247,24 @@ "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" } }, + "redactClientLogData" : { + "type" : "boolean", + "description" : "Enable or disable log redaction.", + "externalDocs" : { + "description" : "This options corresponds to the ``security.redactClientLogData`` cluster parameter.\n\nThis setting configures the ``mongod`` or ``mongos`` to redact any message accompanying a given log event before logging. This prevents the program from writing potentially sensitive data stored on the database to the diagnostic log. Metadata such as error or operation codes, line numbers, and source file names are still visible in the logs.\n\nUse ``redactClientLogData`` in conjunction with Encryption at Rest and TLS/SSL (Transport Encryption) to assist compliance with regulatory requirements.", + "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.redactClientLogData" + } + }, + "replicaSetScalingStrategy" : { + "type" : "string", + "default" : "WORKLOAD_TYPE", + "description" : "Set this field to configure the replica set scaling mode for your cluster.\n\nBy default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes.\n\nWhen configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads.\n\nWhen configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads.", + "enum" : [ "SEQUENTIAL", "WORKLOAD_TYPE", "NODE_TYPE" ], + "externalDocs" : { + "description" : "Modify the Replica Set Scaling Mode", + "url" : "https://dochub.mongodb.org/core/scale-nodes" + } + }, "replicationSpecs" : { "type" : "array", "description" : "List of settings that configure your cluster regions. This array has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations.", @@ -27688,6 +28374,16 @@ "ClusterDescriptionProcessArgs" : { "type" : "object", "properties" : { + "changeStreamOptionsPreAndPostImagesExpireAfterSeconds" : { + "type" : "integer", + "format" : "int32", + "default" : -1, + "description" : "The minimum pre- and post-image retention time in seconds.", + "externalDocs" : { + "description" : "This option corresponds to the ``changeStreamOptions.preAndPostImages.expireAfterSeconds`` cluster parameter. This setting controls the retention policy of change stream pre- and post-images. Pre- and post-images are the versions of a document before and after document modification, respectively. ``expireAfterSeconds`` controls how long MongoDB retains pre- and post-images. When set to -1 (off), MongoDB uses the default retention policy: pre- and post-images are retained until the corresponding change stream events are removed from the oplog. To set the minimum pre- and post-image retention time, specify an integer value greater than zero. Setting this too low could increase the risk of interrupting Realm sync or triggers processing. The default value is -1 (off).", + "url" : "https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/changeStreamOptions/#mongodb-parameter-param.changeStreamOptions.preAndPostImages.expireAfterSeconds" + } + }, "chunkMigrationConcurrency" : { "type" : "integer", "format" : "int32", @@ -27697,6 +28393,15 @@ "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.chunkMigrationConcurrency" } }, + "defaultMaxTimeMS" : { + "type" : "integer", + "format" : "int32", + "description" : "Default time limit in milliseconds for individual read operations to complete.", + "externalDocs" : { + "description" : "This option corresponds to the defaultMaxTimeMS cluster parameter.", + "url" : "https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/defaultMaxTimeMS/" + } + }, "defaultReadConcern" : { "type" : "string", "default" : "available", @@ -27727,7 +28432,7 @@ }, "javascriptEnabled" : { "type" : "boolean", - "description" : "Flag that indicates whether the cluster allows execution of operations that perform server-side executions of JavaScript.", + "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" @@ -27815,6 +28520,16 @@ "ClusterDescriptionProcessArgs20240805" : { "type" : "object", "properties" : { + "changeStreamOptionsPreAndPostImagesExpireAfterSeconds" : { + "type" : "integer", + "format" : "int32", + "default" : -1, + "description" : "The minimum pre- and post-image retention time in seconds.", + "externalDocs" : { + "description" : "This option corresponds to the ``changeStreamOptions.preAndPostImages.expireAfterSeconds`` cluster parameter. This setting controls the retention policy of change stream pre- and post-images. Pre- and post-images are the versions of a document before and after document modification, respectively. ``expireAfterSeconds`` controls how long MongoDB retains pre- and post-images. When set to -1 (off), MongoDB uses the default retention policy: pre- and post-images are retained until the corresponding change stream events are removed from the oplog. To set the minimum pre- and post-image retention time, specify an integer value greater than zero. Setting this too low could increase the risk of interrupting Realm sync or triggers processing. The default value is -1 (off).", + "url" : "https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/changeStreamOptions/#mongodb-parameter-param.changeStreamOptions.preAndPostImages.expireAfterSeconds" + } + }, "chunkMigrationConcurrency" : { "type" : "integer", "format" : "int32", @@ -27824,6 +28539,15 @@ "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.chunkMigrationConcurrency" } }, + "defaultMaxTimeMS" : { + "type" : "integer", + "format" : "int32", + "description" : "Default time limit in milliseconds for individual read operations to complete.", + "externalDocs" : { + "description" : "This option corresponds to the defaultMaxTimeMS cluster parameter.", + "url" : "https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/defaultMaxTimeMS/" + } + }, "defaultWriteConcern" : { "type" : "string", "description" : "Default level of acknowledgment requested from MongoDB for write operations when none is specified by the driver.", @@ -27834,7 +28558,7 @@ }, "javascriptEnabled" : { "type" : "boolean", - "description" : "Flag that indicates whether the cluster allows execution of operations that perform server-side executions of JavaScript.", + "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" @@ -28101,7 +28825,7 @@ "description" : "Human-readable label that identifies the cluster that undergoes outage simulation.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "groupId" : { @@ -28695,7 +29419,8 @@ "discriminator" : { "mapping" : { "AWS" : "#/components/schemas/AWSCreateDataProcessRegionView", - "AZURE" : "#/components/schemas/AzureCreateDataProcessRegionView" + "AZURE" : "#/components/schemas/AzureCreateDataProcessRegionView", + "GCP" : "#/components/schemas/GCPCreateDataProcessRegionView" }, "propertyName" : "cloudProvider" }, @@ -29192,11 +29917,11 @@ }, "roleId" : { "type" : "string", - "description" : "Unique identifier of the role that Data Federation can use to access the data stores.Required if specifying cloudProviderConfig." + "description" : "Unique identifier of the role that Data Federation can use to access the data stores. Required if specifying cloudProviderConfig." }, "servicePrincipalId" : { "type" : "string", - "description" : "The ID of the Service Principal for which there is an access policyfor Atlas to access Azure resources.", + "description" : "The ID of the Service Principal for which there is an access policy for Atlas to access Azure resources.", "readOnly" : true }, "tenantId" : { @@ -29207,6 +29932,22 @@ }, "required" : [ "roleId" ] }, + "DataFederationGCPCloudProviderConfig" : { + "type" : "object", + "description" : "Configuration for running Data Federation in GCP.", + "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" : { + "type" : "string", + "description" : "Unique identifier of the role that Data Federation can use to access the data stores. Required if specifying cloudProviderConfig." + } + }, + "required" : [ "roleId" ] + }, "DataFederationLimit" : { "type" : "object", "description" : "Details of user managed limits.", @@ -29214,6 +29955,7 @@ "mapping" : { "atlas.project.deployment.clusters" : "#/components/schemas/DefaultLimit", "atlas.project.deployment.nodesPerPrivateLinkRegion" : "#/components/schemas/DefaultLimit", + "atlas.project.deployment.salesSoldM0s" : "#/components/schemas/DefaultLimit", "atlas.project.deployment.serverlessMTMs" : "#/components/schemas/DefaultLimit", "atlas.project.security.databaseAccess.customRoles" : "#/components/schemas/DefaultLimit", "atlas.project.security.databaseAccess.users" : "#/components/schemas/DefaultLimit", @@ -29554,9 +30296,12 @@ }, "azure" : { "$ref" : "#/components/schemas/DataFederationAzureCloudProviderConfig" + }, + "gcp" : { + "$ref" : "#/components/schemas/DataFederationGCPCloudProviderConfig" } }, - "title" : "Data Lake Cloud Provider" + "title" : "Data Federation Cloud Provider" }, "DataLakeDLSAWSStore" : { "type" : "object", @@ -29597,7 +30342,7 @@ "cloudProvider" : { "type" : "string", "description" : "Name of the cloud service that hosts the Federated Database Instance's infrastructure.", - "enum" : [ "AWS", "AZURE" ] + "enum" : [ "AWS", "AZURE", "GCP" ] }, "region" : { "$ref" : "#/components/schemas/BaseAtlasDataLakeRegion" @@ -30019,7 +30764,7 @@ "example" : "cluster1", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -30261,7 +31006,9 @@ "enum" : [ "AVERAGE" ] }, "operator" : { - "$ref" : "#/components/schemas/Operator" + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, "threshold" : { "type" : "number", @@ -30304,7 +31051,8 @@ "discriminator" : { "mapping" : { "AWS" : "#/components/schemas/AWSDataProcessRegionView", - "AZURE" : "#/components/schemas/AzureDataProcessRegionView" + "AZURE" : "#/components/schemas/AzureDataProcessRegionView", + "GCP" : "#/components/schemas/GCPDataProcessRegionView" }, "propertyName" : "cloudProvider" }, @@ -30312,7 +31060,7 @@ "cloudProvider" : { "type" : "string", "description" : "Human-readable label that identifies the Cloud service provider where you store your archived data.", - "enum" : [ "AWS", "AZURE" ], + "enum" : [ "AWS", "AZURE", "GCP" ], "readOnly" : true } }, @@ -30539,7 +31287,7 @@ "action" : { "type" : "string", "description" : "Human-readable label that identifies the privilege action.", - "enum" : [ "FIND", "INSERT", "REMOVE", "UPDATE", "BYPASS_DOCUMENT_VALIDATION", "USE_UUID", "KILL_OP", "CREATE_COLLECTION", "CREATE_INDEX", "DROP_COLLECTION", "ENABLE_PROFILER", "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", "STORAGE_GET_CONFIG", "STORAGE_SET_CONFIG", "FLUSH_ROUTER_CONFIG", "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" ] + "enum" : [ "FIND", "INSERT", "REMOVE", "UPDATE", "BYPASS_DOCUMENT_VALIDATION", "USE_UUID", "KILL_OP", "CREATE_COLLECTION", "CREATE_INDEX", "DROP_COLLECTION", "ENABLE_PROFILER", "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", "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", @@ -30818,7 +31566,7 @@ "title" : "Cps Backup Event Types" }, { "type" : "string", - "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEXES_RESTORE_FAILED" ], + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEXES_RESTORE_FAILED", "FTS_INDEXES_SYNONYM_MAPPING_INVALID" ], "title" : "FTS Index Audit Types" }, { "type" : "string", @@ -30961,7 +31709,7 @@ "title" : "Encryption Event Types" }, { "type" : "string", - "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEXES_RESTORE_FAILED" ], + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEXES_RESTORE_FAILED", "FTS_INDEXES_SYNONYM_MAPPING_INVALID" ], "title" : "FTS Index Audit Types" }, { "type" : "string", @@ -31226,7 +31974,7 @@ "title" : "Tenant Backup Event Types" }, { "type" : "string", - "enum" : [ "CLUSTER_VERSION_FIXED", "CLUSTER_VERSION_UNFIXED", "CLUSTER_FCV_FIXED", "CLUSTER_FCV_UNFIXED", "AGENT_VERSION_FIXED", "AGENT_VERSION_UNFIXED", "FIXED_VERSION_UPDATED", "FIXED_AGENT_VERSION_UPDATED", "CLUSTER_FCV_DOWNGRADED" ], + "enum" : [ "CLUSTER_VERSION_FIXED", "CLUSTER_VERSION_UNFIXED", "CLUSTER_FCV_FIXED", "CLUSTER_FCV_UNFIXED", "CLUSTER_FCV_EXPIRATION_DATE_UPDATED", "AGENT_VERSION_FIXED", "AGENT_VERSION_UNFIXED", "FIXED_VERSION_UPDATED", "FIXED_AGENT_VERSION_UPDATED", "CLUSTER_FCV_DOWNGRADED", "CLUSTER_BINARY_VERSION_DOWNGRADED", "CLUSTER_BINARY_VERSION_UPGRADED" ], "title" : "Version Audit Types" } ] }, @@ -31550,7 +32298,6 @@ }, "hostnameSchemaType" : { "type" : "string", - "default" : "PUBLIC", "description" : "The network type to use between the migration host and the destination cluster.", "enum" : [ "PUBLIC", "PRIVATE_LINK", "VPC_PEERING" ] }, @@ -31674,28 +32421,19 @@ "createdAt" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when someone created this export job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "description" : "Date and time when a user or Atlas created the Export Job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", "readOnly" : true }, "customData" : { "type" : "array", - "description" : "Collection of key-value pairs that represent custom data for the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes.", + "description" : "Collection of key-value pairs that represent custom data for the metadata file that MongoDB Cloud uploads when the Export Job finishes.", "items" : { "$ref" : "#/components/schemas/BackupLabel" } }, - "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\"`.", - "items" : { - "type" : "string", - "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download." - }, - "readOnly" : true - }, "exportBucketId" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket to export to.", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -31708,7 +32446,7 @@ "finishedAt" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when this export job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "description" : "Date and time when this Export Job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", "readOnly" : true }, "id" : { @@ -31734,7 +32472,7 @@ }, "prefix" : { "type" : "string", - "description" : "Full path on the cloud provider bucket to the folder where the snapshot is exported.", + "description" : "Prefix used for all blob storage objects uploaded as part of the Export Job.", "pattern" : "/exported_snapshots/\\{ORG-NAME\\}/\\{PROJECT-NAME\\}/\\{CLUSTER-NAME\\}/\\{SNAPSHOT-INITIATION-DATE\\}/\\{TIMESTAMP\\}", "readOnly" : true }, @@ -31748,7 +32486,7 @@ }, "state" : { "type" : "string", - "description" : "State of the export job.", + "description" : "State of the Export Job.", "enum" : [ "Cancelled", "Failed", "InProgress", "Queued", "Successful" ], "readOnly" : true } @@ -31767,7 +32505,7 @@ }, "exportBucketId" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket to export to.", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -31968,7 +32706,15 @@ "properties" : { "downloadUrl" : { "type" : "string", - "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", + "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.", + "items" : { + "$ref" : "#/components/schemas/ApiPrivateDownloadDeliveryUrl" + }, "readOnly" : true }, "replicaSetName" : { @@ -32396,7 +33142,7 @@ "description" : "One or more Uniform Resource Locators (URLs) that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", "items" : { "type" : "string", - "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download." + "description" : "One Uniform Resource Locator that points to the compressed snapshot files for manual download." }, "readOnly" : true }, @@ -32465,6 +33211,14 @@ "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`.", "minimum" : 1199145600 }, + "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.", + "items" : { + "$ref" : "#/components/schemas/ApiPrivateDownloadDeliveryUrl" + }, + "readOnly" : true + }, "snapshotId" : { "type" : "string", "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", @@ -32478,7 +33232,7 @@ "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.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, "targetGroupId" : { "type" : "string", @@ -32518,7 +33272,7 @@ "description" : "Human-readable label that identifies the cluster with the Snapshot you want to return.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "copySettings" : { @@ -32619,7 +33373,7 @@ "description" : "Human-readable label that identifies the cluster with the Snapshot you want to return.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "copySettings" : { @@ -32714,9 +33468,15 @@ "additionalProperties" : { "type" : "object", "description" : "The stats associated with the stream processor.", + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor" + }, "readOnly" : true }, "description" : "The stats associated with the stream processor.", + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor" + }, "readOnly" : true }, "EARPrivateEndpoint" : { @@ -32759,7 +33519,7 @@ "status" : { "type" : "string", "description" : "State of the Encryption At Rest private endpoint.", - "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "ACTIVE", "FAILED" ], + "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "ACTIVE", "FAILED", "PENDING_RECREATION", "DELETING" ], "readOnly" : true } }, @@ -32799,6 +33559,36 @@ "required" : [ "typeName" ], "title" : "Email Notification" }, + "EmployeeAccessGrantView" : { + "type" : "object", + "description" : "MongoDB employee granted access level and expiration for a cluster.", + "properties" : { + "expirationTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Expiration date for the employee access grant." + }, + "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.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "required" : [ "expirationTime", "grantType" ] + }, "EncryptionAtRest" : { "type" : "object", "properties" : { @@ -32813,27 +33603,6 @@ } } }, - "EncryptionAtRestPrivateEndpointRequest" : { - "type" : "object", - "description" : "Create or delete private endpoints from the specified regions list.", - "properties" : { - "cloudProvider" : { - "type" : "string", - "description" : "Cloud service provider name.", - "enum" : [ "AZURE" ] - }, - "regions" : { - "type" : "array", - "description" : "List of regions.", - "items" : { - "type" : "string" - }, - "uniqueItems" : true - } - }, - "required" : [ "cloudProvider" ], - "title" : "Encryption At Rest Private Endpoints setup." - }, "EncryptionKeyAlertConfigViewForNdsGroup" : { "type" : "object", "description" : "Encryption key alert configuration allows to select thresholds which trigger alerts and how users are notified.", @@ -33059,7 +33828,7 @@ "title" : "Export Bucket Audit Types" }, { "type" : "string", - "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEX_CREATED", "FTS_INDEX_UPDATED", "FTS_INDEX_DELETED", "FTS_INDEX_CLEANED_UP", "FTS_INDEXES_RESTORED", "FTS_INDEXES_RESTORE_FAILED" ], + "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" : "FTS Index Audit Types" }, { "type" : "string", @@ -33079,7 +33848,7 @@ "title" : "Group Integration 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_ENOUGH_DISK_SPACE", "HOST_NOT_ENOUGH_DISK_SPACE" ], + "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_ENOUGH_DISK_SPACE", "HOST_NOT_ENOUGH_DISK_SPACE" ], "title" : "Host Event Types" }, { "type" : "string", @@ -33091,7 +33860,7 @@ "title" : "Index Build 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_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_SSL_ROTATED", "CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER", "CLUSTER_INSTANCE_SSL_REVOKED", "RELOAD_SSL_ON_PROCESSES", "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", "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", "MOVE_SKIPPED", "PROXY_RESTARTED", "PROXY_PANICKED", "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", "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", "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", "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", "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", "PENDING_INDEXES_DELETED", "PENDING_INDEXES_CANCELED", "PROCESS_RESTART_REQUESTED", "AUTO_HEALING_ACTION", "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", "CLUSTER_FORCE_RECONFIG_REQUESTED", "PROJECT_BYPASSED_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", "ATLAS_SQL_SCHEDULED_UPDATE_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_MODIFIED", "ATLAS_SQL_SCHEDULED_UPDATE_REMOVED" ], + "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_SSL_ROTATED", "CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER", "CLUSTER_INSTANCE_SSL_REVOKED", "RELOAD_SSL_ON_PROCESSES", "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", "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", "MOVE_SKIPPED", "PROXY_RESTARTED", "PROXY_PANICKED", "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", "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", "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", "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", "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", "CLUSTER_FORCE_RECONFIG_REQUESTED", "PROJECT_BYPASSED_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" ], "title" : "NDS Audit Types" }, { "type" : "string", @@ -33191,7 +33960,7 @@ "title" : "User Event Types" }, { "type" : "string", - "enum" : [ "CLUSTER_VERSION_FIXED", "CLUSTER_VERSION_UNFIXED", "CLUSTER_FCV_FIXED", "CLUSTER_FCV_UNFIXED", "AGENT_VERSION_FIXED", "AGENT_VERSION_UNFIXED", "FIXED_VERSION_UPDATED", "FIXED_AGENT_VERSION_UPDATED", "CLUSTER_FCV_DOWNGRADED" ], + "enum" : [ "CLUSTER_VERSION_FIXED", "CLUSTER_VERSION_UNFIXED", "CLUSTER_FCV_FIXED", "CLUSTER_FCV_UNFIXED", "CLUSTER_FCV_EXPIRATION_DATE_UPDATED", "AGENT_VERSION_FIXED", "AGENT_VERSION_UNFIXED", "FIXED_VERSION_UPDATED", "FIXED_AGENT_VERSION_UPDATED", "CLUSTER_FCV_DOWNGRADED", "CLUSTER_BINARY_VERSION_DOWNGRADED", "CLUSTER_BINARY_VERSION_UPGRADED" ], "title" : "Version Audit Types" }, { "type" : "string", @@ -33261,6 +34030,10 @@ "type" : "string", "enum" : [ "GROUP_TAGS_MODIFIED" ], "title" : "Resource Event Types" + }, { + "type" : "string", + "enum" : [ "RESOURCE_POLICY_CREATED", "RESOURCE_POLICY_MODIFIED", "RESOURCE_POLICY_DELETED" ], + "title" : "Atlas Resource Policy Audit Types" } ] }, "EventViewForNdsGroup" : { @@ -33339,6 +34112,8 @@ "$ref" : "#/components/schemas/UserEventViewForOrg" }, { "$ref" : "#/components/schemas/ResourceEventViewForOrg" + }, { + "$ref" : "#/components/schemas/AtlasResourcePolicyAuditForOrg" } ] }, "ExampleResourceResponse20230101" : { @@ -33399,7 +34174,7 @@ }, "ExportStatus" : { "type" : "object", - "description" : "State of the export job for the collections on the replica set only.", + "description" : "State of the Export Job.", "properties" : { "exportedCollections" : { "type" : "integer", @@ -33434,7 +34209,7 @@ "FTSIndexAuditTypeView" : { "type" : "string", "description" : "Unique identifier of event type.", - "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEX_CREATED", "FTS_INDEX_UPDATED", "FTS_INDEX_DELETED", "FTS_INDEX_CLEANED_UP", "FTS_INDEXES_RESTORED", "FTS_INDEXES_RESTORE_FAILED" ], + "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" ], "example" : "FTS_INDEX_CREATED", "title" : "FTS Index Audit Types" }, @@ -34340,37 +35115,53 @@ }, "title" : "Field Transformation" }, - "ForNdsGroup" : { + "FieldViolation" : { "type" : "object", - "description" : "ReplicaSet Event identifies different activities about replica set of mongod instances.", "properties" : { - "created" : { + "description" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "description" : "A description of why the request element is bad." }, - "eventTypeName" : { - "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroup" + "field" : { + "type" : "string", + "description" : "A path that leads to a field in the request body." + } + }, + "required" : [ "description", "field" ] + }, + "FlexBackupRestoreJob20250101" : { + "type" : "object", + "description" : "Details for one restore job of a flex cluster.", + "properties" : { + "deliveryType" : { + "type" : "string", + "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", + "enum" : [ "RESTORE", "DOWNLOAD" ], + "readOnly" : true }, - "groupId" : { + "expirationDate" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, + "instanceName" : { + "type" : "string", + "description" : "Human-readable label that identifies the source instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "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.", @@ -34383,485 +35174,317 @@ }, "readOnly" : true }, - "orgId" : { + "projectId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "port" : { - "type" : "integer", - "format" : "int32", - "description" : "IANA port on which the MongoDB process listens for requests.", - "example" : 27017, + "restoreFinishedDate" : { + "type" : "string", + "format" : "date-time", + "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.", "readOnly" : true }, - "raw" : { - "$ref" : "#/components/schemas/raw" - }, - "replicaSetName" : { + "restoreScheduledDate" : { "type" : "string", - "description" : "Human-readable label of the replica set associated with the event.", - "example" : "event-replica-set", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "shardName" : { + "snapshotFinishedDate" : { "type" : "string", - "description" : "Human-readable label of the shard associated with the event.", - "example" : "event-sh-01", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true - } - }, - "required" : [ "created", "eventTypeName", "id" ], - "title" : "ReplicaSet Events" - }, - "GCPCloudProviderContainer" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/CloudProviderContainer" - }, { - "type" : "object", - "properties" : { - "atlasCidrBlock" : { - "type" : "string", - "description" : "IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.\n\nThese CIDR blocks must fall within the ranges reserved per RFC 1918. GCP further limits the block to a lower bound of the `/18` range.\n\nTo modify the CIDR block, the target project cannot have:\n\n- Any M10 or greater clusters\n- Any other VPC peering connections\n\n 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.\n\n **Example:** A project in an Google Cloud (GCP) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets.", - "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" - }, - "gcpProjectId" : { - "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.", - "maxLength" : 26, - "minLength" : 26, - "pattern" : "^p-[0-9a-z]{24}$", - "readOnly" : true - }, - "networkName" : { - "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.", - "maxLength" : 36, - "minLength" : 36, - "pattern" : "^nt-[0-9a-f]{24}-[0-9a-z]{8}$", - "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.", - "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.", - "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" ] - } - } - } - } ], - "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", - "required" : [ "atlasCidrBlock" ], - "title" : "GCP" - }, - "GCPComputeAutoScaling" : { - "type" : "object", - "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", - "properties" : { - "maxInstanceSize" : { + }, + "snapshotId" : { "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" ], - "title" : "GCP Instance Sizes" + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "minInstanceSize" : { + "snapshotUrl" : { "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" ], - "title" : "GCP Instance Sizes" - } - }, - "title" : "GCP" - }, - "GCPConsumerForwardingRule" : { - "type" : "object", - "properties" : { - "endpointName" : { + "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" : "Human-readable label that identifies the Google Cloud consumer forwarding rule that you created.", - "externalDocs" : { - "description" : "Google Cloud Forwarding Rule Concepts", - "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" - }, + "description" : "Phase of the restore workflow for this job at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], "readOnly" : true }, - "ipAddress" : { + "targetDeploymentItemName" : { "type" : "string", - "description" : "One Private Internet Protocol version 4 (IPv4) address to which this Google Cloud consumer forwarding rule resolves.", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "description" : "Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another USS instance or Dedicated cluster tier.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", "readOnly" : true }, - "status" : { + "targetProjectId" : { "type" : "string", - "description" : "State of the MongoDB Cloud endpoint group when MongoDB Cloud received this request.", - "enum" : [ "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true } - } + }, + "title" : "Flex Backup Restore Job" }, - "GCPEndpointService" : { + "FlexBackupRestoreJobCreate20250101" : { "type" : "object", - "description" : "Group of Private Endpoint Service settings.", + "description" : "Details to create one restore job of a flex cluster.", "properties" : { - "cloudProvider" : { + "_snapshotId" : { "type" : "string", - "description" : "Cloud service provider that serves the requested endpoint service.", - "enum" : [ "AWS", "AZURE", "GCP" ], - "readOnly" : true + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true }, - "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" - }, - "items" : { - "type" : "string", - "description" : "One Google Cloud network endpoint group that corresponds to the Private Service Connect endpoint service." - } + "_targetDeploymentItemName" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another flex cluster or dedicated cluster tier.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", + "writeOnly" : true }, - "errorMessage" : { + "_targetProjectId" : { "type" : "string", - "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "deliveryType" : { + "type" : "string", + "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", + "enum" : [ "RESTORE", "DOWNLOAD" ], + "readOnly" : true + }, + "expirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "regionName" : { + "instanceName" : { "type" : "string", - "description" : "Cloud provider region that manages this Private Endpoint Service.", + "description" : "Human-readable label that identifies the source instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, - "serviceAttachmentNames" : { + "links" : { "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.", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", "externalDocs" : { - "description" : "Google Cloud Private Service Connect Service Attachments", - "url" : "https://cloud.google.com/vpc/docs/private-service-connect#service-attachments" + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" }, "items" : { - "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.", - "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\\-]+" - } + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true }, - "status" : { + "projectId" : { "type" : "string", - "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", - "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true - } - }, - "required" : [ "cloudProvider" ], - "title" : "GCP" - }, - "GCPHardwareSpec" : { - "type" : "object", - "properties" : { - "instanceSize" : { + }, + "restoreFinishedDate" : { "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" ], - "title" : "GCP Instance Sizes" + "format" : "date-time", + "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.", + "readOnly" : true }, - "nodeCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." - } - } - }, - "GCPHardwareSpec20240805" : { - "type" : "object", - "properties" : { - "diskSizeGB" : { - "type" : "number", - "format" : "double", - "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", - "maximum" : 4096, - "minimum" : 10 - }, - "instanceSize" : { - "type" : "string", - "description" : "Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as \"base nodes\") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.", - "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], - "title" : "GCP Instance Sizes" - }, - "nodeCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." - } - } - }, - "GCPNetworkPeeringConnectionSettings" : { - "type" : "object", - "description" : "Group of Network Peering connection settings.", - "properties" : { - "containerId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" - }, - "errorMessage" : { + "restoreScheduledDate" : { "type" : "string", - "description" : "Details of the error returned when requesting a GCP network peering resource. The resource returns `null` if the request succeeded.", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "gcpProjectId" : { - "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.", - "maxLength" : 30, - "minLength" : 6, - "pattern" : "^[a-z][0-9a-z-]{4,28}[0-9a-z]{1}" - }, - "id" : { + "snapshotFinishedDate" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "networkName" : { - "type" : "string", - "description" : "Human-readable label that identifies the network to peer with the MongoDB Cloud VPC.", - "maxLength" : 63, - "minLength" : 1, - "pattern" : "[a-z]([-a-z0-9]{0,62}[a-z0-9]{0,1})?" - }, - "providerName" : { + "snapshotUrl" : { "type" : "string", - "description" : "Cloud service provider that serves the requested network peering connection.", - "enum" : [ "AWS", "AZURE", "GCP" ] + "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" : "State of the network peering connection at the time you made the request.", - "enum" : [ "ADDING_PEER", "WAITING_FOR_USER", "AVAILABLE", "FAILED", "DELETING" ], + "description" : "Phase of the restore workflow for this job at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], "readOnly" : true } }, - "required" : [ "containerId", "gcpProjectId", "networkName" ], - "title" : "GCP" - }, - "GCPRegionConfig" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/CloudRegionConfig" - }, { - "type" : "object", - "properties" : { - "analyticsAutoScaling" : { - "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" - }, - "analyticsSpecs" : { - "$ref" : "#/components/schemas/DedicatedHardwareSpec" - }, - "autoScaling" : { - "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" - }, - "readOnlySpecs" : { - "$ref" : "#/components/schemas/DedicatedHardwareSpec" - } - } - } ], - "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", - "title" : "GCP Regional Replication Specifications" + "required" : [ "_snapshotId", "_targetDeploymentItemName" ], + "title" : "Create Flex Backup Restore Job" }, - "GCPRegionConfig20240805" : { + "FlexBackupSettings20250101" : { "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/CloudRegionConfig20240805" - }, { - "type" : "object", - "properties" : { - "analyticsAutoScaling" : { - "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" - }, - "analyticsSpecs" : { - "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" - }, - "autoScaling" : { - "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" - }, - "readOnlySpecs" : { - "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" - } + "description" : "Flex backup configuration", + "properties" : { + "enabled" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether backups are performed for this flex cluster. Backup uses [TODO](TODO) for flex clusters.", + "readOnly" : true } - } ], - "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", - "title" : "GCP Regional Replication Specifications" + }, + "readOnly" : true, + "title" : "Flex Backup Configuration" }, - "GeoSharding" : { + "FlexBackupSnapshot20250101" : { "type" : "object", + "description" : "Details for one snapshot of a flex cluster.", "properties" : { - "customZoneMapping" : { - "type" : "object", - "additionalProperties" : { - "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `id` property.\n\nThis parameter returns an empty object if no custom zones exist.", - "readOnly" : true - }, - "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `id` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "expiration" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "managedNamespaces" : { - "type" : "array", - "description" : "List that contains a namespace for a Global Cluster. MongoDB Cloud manages this cluster.", - "items" : { - "$ref" : "#/components/schemas/ManagedNamespaces" - }, + "finishTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "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 - } - } - }, - "GeoSharding20240805" : { - "type" : "object", - "properties" : { - "customZoneMapping" : { - "type" : "object", - "additionalProperties" : { - "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.\n\nThis parameter returns an empty object if no custom zones exist.", - "readOnly" : true - }, - "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "managedNamespaces" : { + "links" : { "type" : "array", - "description" : "List that contains a namespace for a Global Cluster. MongoDB Cloud manages this cluster.", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, "items" : { - "$ref" : "#/components/schemas/ManagedNamespaces" + "$ref" : "#/components/schemas/Link" }, "readOnly" : true }, - "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.", + "mongoDBVersion" : { + "type" : "string", + "description" : "MongoDB host version that the snapshot runs.", "readOnly" : true - } - } - }, - "GoogleCloudKMS" : { - "type" : "object", - "description" : "Details that define the configuration of Encryption at Rest using Google Cloud Key Management Service (KMS).", - "externalDocs" : { - "description" : "Google Cloud Key Management Service", - "url" : "https://www.mongodb.com/docs/atlas/security-gcp-kms/" - }, - "properties" : { - "enabled" : { - "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" : { + "scheduledTime" : { "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" + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will take the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true }, - "serviceAccountKey" : { + "startTime" : { "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.", - "externalDocs" : { - "description" : "Google Cloud Authentication", - "url" : "https://cloud.google.com/docs/authentication/getting-started" - }, - "writeOnly" : true - }, - "valid" : { - "type" : "boolean", - "description" : "Flag that indicates whether the Google Cloud Key Management Service (KMS) encryption key can encrypt and decrypt data.", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began taking the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true - } - } - }, - "GreaterThanDaysThresholdView" : { - "type" : "object", - "description" : "Threshold value that triggers an alert.", - "properties" : { - "operator" : { - "type" : "string", - "description" : "Comparison operator to apply when checking the current metric value.", - "enum" : [ "GREATER_THAN" ] - }, - "threshold" : { - "type" : "integer", - "format" : "int32", - "description" : "Value of metric that, when exceeded, triggers an alert." }, - "units" : { + "status" : { "type" : "string", - "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", - "enum" : [ "DAYS" ] + "description" : "Phase of the workflow for this snapshot at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true } - } + }, + "title" : "Flex Backup Snapshot" }, - "GreaterThanRawThreshold" : { + "FlexBackupSnapshotDownloadCreate20250101" : { "type" : "object", - "description" : "A Limit that triggers an alert when greater than a number.", + "description" : "Details for one backup snapshot download of a flex cluster.", "properties" : { - "operator" : { + "_snapshotId" : { "type" : "string", - "description" : "Comparison operator to apply when checking the current metric value.", - "enum" : [ "GREATER_THAN" ] - }, - "threshold" : { - "type" : "integer", - "format" : "int32", - "description" : "Value of metric that, when exceeded, triggers an alert." + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to download.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true }, - "units" : { - "$ref" : "#/components/schemas/RawMetricUnits" + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true } }, - "title" : "Greater Than Raw Threshold" + "required" : [ "_snapshotId" ], + "title" : "Flex Backup Snapshot Download Create" }, - "GreaterThanRawThresholdAlertConfigViewForNdsGroup" : { + "FlexClusterDescription20250101" : { "type" : "object", + "description" : "Group of settings that configure a MongoDB Flex cluster.", "properties" : { - "created" : { + "backupSettings" : { + "$ref" : "#/components/schemas/FlexBackupSettings20250101" + }, + "clusterType" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Flex cluster topology.", + "enum" : [ "REPLICASET", "LOADBALANCED" ], "readOnly" : true }, - "enabled" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + "connectionStrings" : { + "$ref" : "#/components/schemas/FlexConnectionStrings20250101" }, - "eventTypeName" : { - "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this instance. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true }, "groupId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "description" : "Unique 24-hexadecimal character string that identifies the project.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -34870,7 +35493,7 @@ }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "description" : "Unique 24-hexadecimal digit string that identifies the instance.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -34889,76 +35512,60 @@ }, "readOnly" : true }, - "matchers" : { - "type" : "array", - "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", - "items" : { - "$ref" : "#/components/schemas/ReplicaSetMatcher" - } + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the instance runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true }, - "notifications" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "readOnly" : true + }, + "providerSettings" : { + "$ref" : "#/components/schemas/FlexProviderSettings20250101" + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of this instance.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { "type" : "array", - "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, "items" : { - "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + "$ref" : "#/components/schemas/ResourceTag" } }, - "threshold" : { - "$ref" : "#/components/schemas/GreaterThanRawThreshold" + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." }, - "updated" : { + "versionReleaseSystem" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions.", + "enum" : [ "LTS" ], "readOnly" : true } }, - "required" : [ "eventTypeName", "notifications" ] - }, - "GreaterThanTimeThreshold" : { - "type" : "object", - "description" : "A Limit that triggers an alert when greater than a time period.", - "properties" : { - "operator" : { - "type" : "string", - "description" : "Comparison operator to apply when checking the current metric value.", - "enum" : [ "GREATER_THAN" ] - }, - "threshold" : { - "type" : "integer", - "format" : "int32", - "description" : "Value of metric that, when exceeded, triggers an alert." - }, - "units" : { - "$ref" : "#/components/schemas/TimeMetricUnits" - } - }, - "title" : "Greater Than Time Threshold" + "required" : [ "providerSettings" ], + "title" : "Flex Cluster Description" }, - "Group" : { + "FlexClusterDescriptionCreate20250101" : { "type" : "object", + "description" : "Settings that you can specify when you create a flex cluster.", "properties" : { - "clusterCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Quantity of MongoDB Cloud clusters deployed in this project.", - "readOnly" : true - }, - "created" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created this project. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true - }, - "id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, "links" : { "type" : "array", "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", @@ -34973,111 +35580,899 @@ }, "name" : { "type" : "string", - "description" : "Human-readable label that identifies the project included in the MongoDB Cloud organization.", + "description" : "Human-readable label that identifies the instance.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" - }, - "orgId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud organization to which the project belongs.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "writeOnly" : true }, - "regionUsageRestrictions" : { - "type" : "string", - "default" : "COMMERCIAL_FEDRAMP_REGIONS_ONLY", - "description" : "Applies to Atlas for Government only.\n\nIn Commercial Atlas, this field will be rejected in requests and missing in responses.\n\nThis field sets restrictions on available regions in the project.\n\n| Value | Available Regions |\n|-----------------------------------|------------|\n| `COMMERCIAL_FEDRAMP_REGIONS_ONLY` | Only allows deployments in FedRAMP Moderate regions.|\n| `GOV_REGIONS_ONLY` | Only allows deployments in GovCloud regions.|", - "enum" : [ "COMMERCIAL_FEDRAMP_REGIONS_ONLY", "GOV_REGIONS_ONLY" ], - "externalDocs" : { - "url" : "https://www.mongodb.com/docs/atlas/government/overview/supported-regions/#supported-cloud-providers-and-regions" - } + "providerSettings" : { + "$ref" : "#/components/schemas/FlexProviderSettingsCreate20250101" }, "tags" : { "type" : "array", - "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the project.", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.", "externalDocs" : { "description" : "Resource Tags", - "url" : "https://www.mongodb.com/docs/atlas/tags" + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" }, "items" : { "$ref" : "#/components/schemas/ResourceTag" } }, - "withDefaultAlertsSettings" : { + "terminationProtectionEnabled" : { "type" : "boolean", - "description" : "Flag that indicates whether to create the project with default alert settings.", - "writeOnly" : true + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." } }, - "required" : [ "clusterCount", "created", "name", "orgId" ] - }, - "GroupAlertsConfig" : { - "type" : "object", - "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/StreamProcessorAlertConfigViewForNdsGroup" - } ] + "required" : [ "name", "providerSettings" ], + "title" : "Flex Cluster Description Create" }, - "GroupIPAddresses" : { + "FlexConnectionStrings20250101" : { "type" : "object", - "description" : "List of IP addresses in a project.", + "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, "properties" : { - "groupId" : { + "standard" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "description" : "Public connection string that you can use to connect to this cluster. This connection string uses the mongodb:// protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, "readOnly" : true }, - "services" : { - "$ref" : "#/components/schemas/GroupService" + "standardSrv" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this flex cluster. This connection string uses the `mongodb+srv://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true } }, - "title" : "Group IP Address" + "readOnly" : true, + "title" : "Flex Cluster Connection Strings" }, - "GroupInvitation" : { + "FlexProviderSettings20250101" : { "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB flex cluster.", "properties" : { - "createdAt" : { + "backingProviderName" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud sent the invitation. This parameter expresses its value in ISO 8601 format in UTC.", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the flex cluster.", + "enum" : [ "AWS", "AZURE", "GCP" ], "readOnly" : true }, - "expiresAt" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud expires the invitation. This parameter expresses its value in ISO 8601 format in UTC.", + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity available to the flex cluster expressed in gigabytes.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "default" : "FLEX", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "FLEX" ], + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB flex cluster. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Cloud Service Provider Settings for a Flex Cluster" + }, + "FlexProviderSettingsCreate20250101" : { + "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB flex cluster.", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the flex cluster.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "writeOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity available to the flex cluster expressed in gigabytes.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "default" : "FLEX", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "FLEX" ], + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB flex cluster. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).", + "writeOnly" : true + } + }, + "required" : [ "backingProviderName", "regionName" ], + "title" : "Cloud Service Provider Settings for a Flex Cluster", + "writeOnly" : true + }, + "ForNdsGroup" : { + "type" : "object", + "description" : "ReplicaSet Event identifies different activities about replica set of mongod instances.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "ReplicaSet Events" + }, + "GCPCloudProviderContainer" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, { + "type" : "object", + "properties" : { + "atlasCidrBlock" : { + "type" : "string", + "description" : "IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.\n\nThese CIDR blocks must fall within the ranges reserved per RFC 1918. GCP further limits the block to a lower bound of the `/18` range.\n\nTo modify the CIDR block, the target project cannot have:\n\n- Any M10 or greater clusters\n- Any other VPC peering connections\n\n 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.\n\n **Example:** A project in an Google Cloud (GCP) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets.", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + }, + "gcpProjectId" : { + "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.", + "maxLength" : 26, + "minLength" : 26, + "pattern" : "^p-[0-9a-z]{24}$", + "readOnly" : true + }, + "networkName" : { + "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.", + "maxLength" : 36, + "minLength" : 36, + "pattern" : "^nt-[0-9a-f]{24}-[0-9a-z]{8}$", + "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.", + "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.", + "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" ] + } + } + } + } ], + "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", + "required" : [ "atlasCidrBlock" ], + "title" : "GCP" + }, + "GCPComputeAutoScaling" : { + "type" : "object", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", + "properties" : { + "maxInstanceSize" : { + "type" : "string", + "description" : "Maximum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "minInstanceSize" : { + "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" ], + "title" : "GCP Instance Sizes" + } + }, + "title" : "GCP" + }, + "GCPConsumerForwardingRule" : { + "type" : "object", + "properties" : { + "endpointName" : { + "type" : "string", + "description" : "Human-readable label that identifies the Google Cloud consumer forwarding rule that you created.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "One Private Internet Protocol version 4 (IPv4) address to which this Google Cloud consumer forwarding rule resolves.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the MongoDB Cloud endpoint group when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + } + }, + "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" ] + } + } + } ] + }, + "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.", + "enum" : [ "CENTRAL_US", "WESTERN_EUROPE" ], + "readOnly" : true + } + } + } ] + }, + "GCPEndpointService" : { + "type" : "object", + "description" : "Group of Private Endpoint Service settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "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" + }, + "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" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "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" + }, + "items" : { + "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.", + "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\\-]+" + } + }, + "status" : { + "type" : "string", + "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "GCP" + }, + "GCPHardwareSpec" : { + "type" : "object", + "properties" : { + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts 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" ], + "title" : "GCP Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "GCPHardwareSpec20240805" : { + "type" : "object", + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as \"base nodes\") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "GCPNetworkPeeringConnectionSettings" : { + "type" : "object", + "description" : "Group of Network Peering connection settings.", + "properties" : { + "containerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "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" : { + "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.", + "maxLength" : 30, + "minLength" : 6, + "pattern" : "^[a-z][0-9a-z-]{4,28}[0-9a-z]{1}" + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "networkName" : { + "type" : "string", + "description" : "Human-readable label that identifies the network to peer with the MongoDB Cloud VPC.", + "maxLength" : 63, + "minLength" : 1, + "pattern" : "[a-z]([-a-z0-9]{0,62}[a-z0-9]{0,1})?" + }, + "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.", + "enum" : [ "ADDING_PEER", "WAITING_FOR_USER", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "containerId", "gcpProjectId", "networkName" ], + "title" : "GCP" + }, + "GCPRegionConfig" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "GCP Regional Replication Specifications" + }, + "GCPRegionConfig20240805" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20240805" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "GCP Regional Replication Specifications" + }, + "GeoSharding" : { + "type" : "object", + "properties" : { + "customZoneMapping" : { + "type" : "object", + "additionalProperties" : { + "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `id` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `id` property.\n\nThis 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.", + "items" : { + "$ref" : "#/components/schemas/ManagedNamespaces" + }, + "readOnly" : true + }, + "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 + } + } + }, + "GeoSharding20240805" : { + "type" : "object", + "properties" : { + "customZoneMapping" : { + "type" : "object", + "additionalProperties" : { + "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.\n\nThis 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.", + "items" : { + "$ref" : "#/components/schemas/ManagedNamespaces" + }, + "readOnly" : true + }, + "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 + } + } + }, + "GoogleCloudKMS" : { + "type" : "object", + "description" : "Details that define the configuration of Encryption at Rest using Google Cloud Key Management Service (KMS).", + "externalDocs" : { + "description" : "Google Cloud Key Management Service", + "url" : "https://www.mongodb.com/docs/atlas/security-gcp-kms/" + }, + "properties" : { + "enabled" : { + "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" + }, + "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.", + "externalDocs" : { + "description" : "Google Cloud Authentication", + "url" : "https://cloud.google.com/docs/authentication/getting-started" + }, + "writeOnly" : true + }, + "valid" : { + "type" : "boolean", + "description" : "Flag that indicates whether the Google Cloud Key Management Service (KMS) encryption key can encrypt and decrypt data.", + "readOnly" : true + } + } + }, + "GreaterThanDaysThresholdView" : { + "type" : "object", + "description" : "Threshold value that triggers an alert.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "GREATER_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "DAYS" ] + } + } + }, + "GreaterThanRawThreshold" : { + "type" : "object", + "description" : "A Limit that triggers an alert when greater than a number.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "GREATER_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/RawMetricUnits" + } + }, + "title" : "Greater Than Raw Threshold" + }, + "GreaterThanRawThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ReplicaSetMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/GreaterThanRawThreshold" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ] + }, + "GreaterThanTimeThreshold" : { + "type" : "object", + "description" : "A Limit that triggers an alert when greater than a time period.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "GREATER_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "title" : "Greater Than Time Threshold" + }, + "Group" : { + "type" : "object", + "properties" : { + "clusterCount" : { + "type" : "integer", + "format" : "int64", + "description" : "Quantity of MongoDB Cloud clusters deployed in this project.", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this project. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the project included in the MongoDB Cloud organization.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud organization to which the project belongs.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "regionUsageRestrictions" : { + "type" : "string", + "default" : "COMMERCIAL_FEDRAMP_REGIONS_ONLY", + "description" : "Applies to Atlas for Government only.\n\nIn Commercial Atlas, this field will be rejected in requests and missing in responses.\n\nThis field sets restrictions on available regions in the project.\n\n| Value | Available Regions |\n|-----------------------------------|------------|\n| `COMMERCIAL_FEDRAMP_REGIONS_ONLY` | Only allows deployments in FedRAMP Moderate regions.|\n| `GOV_REGIONS_ONLY` | Only allows deployments in GovCloud regions.|", + "enum" : [ "COMMERCIAL_FEDRAMP_REGIONS_ONLY", "GOV_REGIONS_ONLY" ], + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/government/overview/supported-regions/#supported-cloud-providers-and-regions" + } + }, + "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" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "withDefaultAlertsSettings" : { + "type" : "boolean", + "description" : "Flag that indicates whether to create the project with default alert settings.", + "writeOnly" : true + } + }, + "required" : [ "clusterCount", "created", "name", "orgId" ] + }, + "GroupAlertsConfig" : { + "type" : "object", + "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/StreamProcessorAlertConfigViewForNdsGroup" + } ] + }, + "GroupIPAddresses" : { + "type" : "object", + "description" : "List of IP addresses in a project.", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "services" : { + "$ref" : "#/components/schemas/GroupService" + } + }, + "title" : "Group IP Address" + }, + "GroupInvitation" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud sent the invitation. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud expires the invitation. This parameter expresses its value in ISO 8601 format in UTC.", "readOnly" : true }, "groupId" : { @@ -35217,22 +36612,27 @@ "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "pattern" : "^([a-f0-9]{24})$" }, "destinationOrgPrivateApiKey" : { "type" : "string", - "description" : "Unique string that identifies the private part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.", + "description" : "Unique string that identifies the private part of the API Key used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.", "example" : "55c3bbb6-b4bb-0be1-e66d20841f3e", - "readOnly" : true + "externalDocs" : { + "description" : "Grant Programmatic Access to Atlas", + "url" : "https://dochub.mongodb.org/core/atlas-create-prog-api-key" + } }, "destinationOrgPublicApiKey" : { "type" : "string", - "description" : "Unique string that identifies the public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.", + "description" : "Unique string that identifies the public part of the API Key used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.", "example" : "zmmrboas", + "externalDocs" : { + "description" : "Grant Programmatic Access to Atlas", + "url" : "https://dochub.mongodb.org/core/atlas-create-prog-api-key" + }, "maxLength" : 8, - "minLength" : 8, - "readOnly" : true + "minLength" : 8 } } }, @@ -35299,7 +36699,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/EventViewForNdsGroup" }, @@ -35332,6 +36732,28 @@ } } }, + "GroupRoleAssignment" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to which these roles belong.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "groupRoles" : { + "type" : "array", + "description" : "One or more project level roles assigned to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_OWNER", "GROUP_CLUSTER_MANAGER", "GROUP_STREAM_PROCESSING_OWNER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR" ] + }, + "uniqueItems" : true + } + } + }, "GroupService" : { "type" : "object", "description" : "List of IP addresses in a project categorized by services.", @@ -35351,37 +36773,37 @@ "GroupServiceAccount" : { "type" : "object", "properties" : { + "clientId" : { + "type" : "string", + "description" : "The Client ID of the Service Account.", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + }, "createdAt" : { "type" : "string", "format" : "date-time", - "description" : "Service account creation time." + "description" : "The date that the Service Account was created on." }, "description" : { "type" : "string", - "description" : "Description of the service account." - }, - "id" : { - "type" : "string", - "description" : "ID for the service account.", - "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + "description" : "Human readable description for the Service Account." }, "name" : { "type" : "string", - "description" : "Name for service account." + "description" : "Human-readable name for the Service Account." }, "roles" : { "type" : "array", - "description" : "Roles assigned to the Service Account group.", + "description" : "A list of Project roles associated with the Service Account.", "items" : { "type" : "string", - "description" : "Project roles associated with the service account.", + "description" : "Project roles available for Service Accounts.", "enum" : [ "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" ] }, "uniqueItems" : true }, "secrets" : { "type" : "array", - "description" : "List of secrets.", + "description" : "A list of secrets associated with the specified Service Account.", "items" : { "$ref" : "#/components/schemas/ServiceAccountSecret" }, @@ -35394,73 +36816,74 @@ "properties" : { "description" : { "type" : "string", - "description" : "Human readable description for the service account.", + "description" : "Human readable description for the Service Account.", "maxLength" : 250, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "name" : { "type" : "string", - "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "description" : "Human-readable name for the Service Account. The name is modifiable and does not have to be unique.", "maxLength" : 64, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "roles" : { "type" : "array", - "description" : "Project roles associated with the service account.", + "description" : "A list of project-level roles for the Service Account.", "items" : { "type" : "string", - "description" : "Project roles associated with the service account.", + "description" : "Project roles available for Service Accounts.", "enum" : [ "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" ] } }, "secretExpiresAfterHours" : { "type" : "integer", "format" : "int32", - "description" : "Secret expiration time." + "description" : "The expiration time of the new Service Account secret. The expiration is provided in hours." } }, - "required" : [ "description", "name", "secretExpiresAfterHours" ] + "required" : [ "description", "name", "roles", "secretExpiresAfterHours" ] }, "GroupServiceAccountRoleAssignment" : { "type" : "object", "properties" : { "roles" : { "type" : "array", - "description" : "Group access roles.", + "description" : "The Project permissions for the Service Account in the specified Project.", "items" : { "type" : "string", - "description" : "Project roles associated with the service account.", + "description" : "Project roles available for Service Accounts.", "enum" : [ "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" ] }, "uniqueItems" : true } - } + }, + "required" : [ "roles" ] }, "GroupServiceAccountUpdateRequest" : { "type" : "object", "properties" : { "description" : { "type" : "string", - "description" : "Human readable description for the service account.", + "description" : "Human readable description for the Service Account.", "maxLength" : 250, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "name" : { "type" : "string", - "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "description" : "Human-readable name for the Service Account. The name is modifiable and does not have to be unique.", "maxLength" : 64, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "roles" : { "type" : "array", - "description" : "Project roles associated with the service account.", + "description" : "A list of Project roles associated with the Service Account.", "items" : { "type" : "string", - "description" : "Project roles associated with the service account.", + "description" : "Project roles available for Service Accounts.", "enum" : [ "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" ] } } @@ -35704,7 +37127,7 @@ "example" : "cluster1", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -35799,14 +37222,14 @@ "HostEventTypeViewForNdsGroup" : { "type" : "string", "description" : "Unique identifier of event type.", - "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_ENOUGH_DISK_SPACE", "HOST_NOT_ENOUGH_DISK_SPACE" ], + "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_ENOUGH_DISK_SPACE", "HOST_NOT_ENOUGH_DISK_SPACE" ], "example" : "HOST_DOWN", "title" : "Host Event Types" }, "HostEventTypeViewForNdsGroupAlertable" : { "type" : "string", "description" : "Event type that triggers an alert.", - "enum" : [ "HOST_DOWN", "HOST_HAS_INDEX_SUGGESTIONS", "HOST_MONGOT_CRASHING_OOM", "HOST_NOT_ENOUGH_DISK_SPACE" ], + "enum" : [ "HOST_DOWN", "HOST_HAS_INDEX_SUGGESTIONS", "HOST_MONGOT_CRASHING_OOM", "HOST_MONGOT_STOP_REPLICATION", "HOST_NOT_ENOUGH_DISK_SPACE" ], "example" : "HOST_DOWN", "title" : "Host Event Types" }, @@ -36092,6 +37515,7 @@ "OPCOUNTER_REPL_INSERT" : "#/components/schemas/RawMetricAlertView", "OPCOUNTER_REPL_UPDATE" : "#/components/schemas/RawMetricAlertView", "OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricAlertView", + "OPERATIONS_QUERIES_KILLED" : "#/components/schemas/RawMetricAlertView", "OPERATIONS_SCAN_AND_ORDER" : "#/components/schemas/RawMetricAlertView", "OPERATION_THROTTLING_REJECTED_OPERATIONS" : "#/components/schemas/RawMetricAlertView", "OPLOG_MASTER_LAG_TIME_DIFF" : "#/components/schemas/TimeMetricAlertView", @@ -36161,7 +37585,7 @@ "example" : "cluster1", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -36470,6 +37894,7 @@ "OPCOUNTER_REPL_INSERT" : "#/components/schemas/RawMetricEventView", "OPCOUNTER_REPL_UPDATE" : "#/components/schemas/RawMetricEventView", "OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricEventView", + "OPERATIONS_QUERIES_KILLED" : "#/components/schemas/RawMetricEventView", "OPERATIONS_SCAN_AND_ORDER" : "#/components/schemas/RawMetricEventView", "OPERATION_THROTTLING_REJECTED_OPERATIONS" : "#/components/schemas/RawMetricEventView", "OPLOG_MASTER_LAG_TIME_DIFF" : "#/components/schemas/TimeMetricEventView", @@ -36775,6 +38200,7 @@ "OPCOUNTER_REPL_INSERT" : "#/components/schemas/RawMetricThresholdView", "OPCOUNTER_REPL_UPDATE" : "#/components/schemas/RawMetricThresholdView", "OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "OPERATIONS_QUERIES_KILLED" : "#/components/schemas/RawMetricThresholdView", "OPERATIONS_SCAN_AND_ORDER" : "#/components/schemas/RawMetricThresholdView", "OPERATION_THROTTLING_REJECTED_OPERATIONS" : "#/components/schemas/RawMetricThresholdView", "OPLOG_MASTER_LAG_TIME_DIFF" : "#/components/schemas/TimeMetricThresholdView", @@ -36821,7 +38247,9 @@ "enum" : [ "AVERAGE" ] }, "operator" : { - "$ref" : "#/components/schemas/Operator" + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, "threshold" : { "type" : "number", @@ -37173,7 +38601,7 @@ "description" : "Human-readable label that identifies the cluster that incurred the charge.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -37227,7 +38655,7 @@ "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.", - "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_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", "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_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_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" ], + "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_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", "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_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_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_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" ], "readOnly" : true }, "startDate" : { @@ -37517,6 +38945,323 @@ "description" : "Configuration of nodes that comprise the cluster.", "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] }, + "configServerManagementMode" : { + "type" : "string", + "default" : "ATLAS_MANAGED", + "description" : "Config Server Management Mode for creating or updating a sharded cluster.\n\nWhen configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings.\n\nWhen configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server.", + "enum" : [ "ATLAS_MANAGED", "FIXED_TO_DEDICATED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + } + }, + "configServerType" : { + "type" : "string", + "description" : "Describes a sharded cluster's config server type.", + "enum" : [ "DEDICATED", "EMBEDDED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + }, + "readOnly" : true + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/ClusterConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "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.", + "maximum" : 4096, + "minimum" : 10 + }, + "diskWarmingMode" : { + "type" : "string", + "default" : "FULLY_WARMED", + "description" : "Disk warming mode selection.", + "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], + "externalDocs" : { + "description" : "Reduce Secondary Disk Warming Impact", + "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" + } + }, + "encryptionAtRestProvider" : { + "type" : "string", + "description" : "Cloud service provider that manages your customer keys to provide an additional layer of Encryption at Rest for the cluster.", + "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "featureCompatibilityVersion" : { + "type" : "string", + "description" : "Feature compatibility version of the cluster.", + "readOnly" : true + }, + "featureCompatibilityVersionExpirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Feature compatibility version expiration date.", + "readOnly" : true + }, + "globalClusterSelfManagedSharding" : { + "type" : "boolean", + "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen 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.\n\nWhen 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.\n\nThis 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" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "labels" : { + "type" : "array", + "deprecated" : true, + "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBEmployeeAccessGrant" : { + "$ref" : "#/components/schemas/EmployeeAccessGrantView" + }, + "mongoDBMajorVersion" : { + "type" : "string", + "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", + "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-" + } + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the cluster runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)" + }, + "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.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "mongoURIUpdated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated the connection string. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "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.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + }, + "numShards" : { + "type" : "integer", + "format" : "int32", + "default" : 1, + "description" : "Number of shards up to 50 to deploy for a sharded cluster. The resource returns `1` to indicate a replica set and values of `2` and higher to indicate a sharded cluster. The returned value equals the number of shards in the cluster.", + "externalDocs" : { + "description" : "Sharding", + "url" : "https://docs.mongodb.com/manual/sharding/" + }, + "maximum" : 50, + "minimum" : 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", + "default" : "WORKLOAD_TYPE", + "description" : "Set this field to configure the replica set scaling mode for your cluster.\n\nBy default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes.\n\nWhen configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads.\n\nWhen configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads.", + "enum" : [ "SEQUENTIAL", "WORKLOAD_TYPE", "NODE_TYPE" ], + "externalDocs" : { + "description" : "Modify the Replica Set Scaling Mode", + "url" : "https://dochub.mongodb.org/core/scale-nodes" + } + }, + "replicationFactor" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "deprecated" : true, + "description" : "Number of members that belong to the replica set. Each member retains a copy of your databases, providing high availability and data redundancy. Use **replicationSpecs** instead.", + "enum" : [ 3, 5, 7 ] + }, + "replicationSpec" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RegionSpec" + }, + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "title" : "Region Configuration" + }, + "replicationSpecs" : { + "type" : "array", + "description" : "List of settings that configure your cluster regions.\n\n- For Global Clusters, each object in the array represents one zone where MongoDB Cloud deploys your clusters nodes.\n- For non-Global sharded clusters and replica sets, the single object represents where MongoDB Cloud deploys your clusters nodes.", + "items" : { + "$ref" : "#/components/schemas/LegacyReplicationSpec" + } + }, + "rootCertType" : { + "type" : "string", + "default" : "ISRGROOTX1", + "description" : "Root Certificate Authority that MongoDB Atlas clusters uses. MongoDB Cloud supports Internet Security Research Group.", + "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.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the cluster.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", + "enum" : [ "LTS", "CONTINUOUS" ] + } + }, + "title" : "Cluster Description" + }, + "LegacyAtlasTenantClusterUpgradeRequest" : { + "type" : "object", + "description" : "Request containing target state of tenant cluster to be upgraded", + "properties" : { + "acceptDataRisksAndForceReplicaSetReconfig" : { + "type" : "string", + "format" : "date-time", + "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", + "externalDocs" : { + "description" : "Reconfiguring a Replica Set during a regional outage", + "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + } + }, + "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", + "default" : "ATLAS_MANAGED", + "description" : "Config Server Management Mode for creating or updating a sharded cluster.\n\nWhen configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings.\n\nWhen configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server.", + "enum" : [ "ATLAS_MANAGED", "FIXED_TO_DEDICATED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + } + }, + "configServerType" : { + "type" : "string", + "description" : "Describes a sharded cluster's config server type.", + "enum" : [ "DEDICATED", "EMBEDDED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + }, + "readOnly" : true + }, "connectionStrings" : { "$ref" : "#/components/schemas/ClusterConnectionStrings" }, @@ -37552,6 +39297,17 @@ "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" } }, + "featureCompatibilityVersion" : { + "type" : "string", + "description" : "Feature compatibility version of the cluster.", + "readOnly" : true + }, + "featureCompatibilityVersionExpirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Feature compatibility version expiration date.", + "readOnly" : true + }, "globalClusterSelfManagedSharding" : { "type" : "boolean", "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen 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.\n\nWhen 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.\n\nThis setting cannot be changed once the cluster is deployed.", @@ -37598,6 +39354,9 @@ }, "readOnly" : true }, + "mongoDBEmployeeAccessGrant" : { + "$ref" : "#/components/schemas/EmployeeAccessGrantView" + }, "mongoDBMajorVersion" : { "type" : "string", "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", @@ -37640,7 +39399,7 @@ "description" : "Human-readable label that identifies the cluster.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, "numShards" : { "type" : "integer", @@ -37673,259 +39432,16 @@ "providerSettings" : { "$ref" : "#/components/schemas/ClusterProviderSettings" }, - "replicationFactor" : { - "type" : "integer", - "format" : "int32", - "default" : 3, - "deprecated" : true, - "description" : "Number of members that belong to the replica set. Each member retains a copy of your databases, providing high availability and data redundancy. Use **replicationSpecs** instead.", - "enum" : [ 3, 5, 7 ] - }, - "replicationSpec" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/RegionSpec" - }, - "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", - "title" : "Region Configuration" - }, - "replicationSpecs" : { - "type" : "array", - "description" : "List of settings that configure your cluster regions.\n\n- For Global Clusters, each object in the array represents one zone where MongoDB Cloud deploys your clusters nodes.\n- For non-Global sharded clusters and replica sets, the single object represents where MongoDB Cloud deploys your clusters nodes.", - "items" : { - "$ref" : "#/components/schemas/LegacyReplicationSpec" - } - }, - "rootCertType" : { - "type" : "string", - "default" : "ISRGROOTX1", - "description" : "Root Certificate Authority that MongoDB Atlas clusters uses. MongoDB Cloud supports Internet Security Research Group.", - "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.", - "externalDocs" : { - "description" : "Connection string URI format.", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, - "readOnly" : true - }, - "stateName" : { + "replicaSetScalingStrategy" : { "type" : "string", - "description" : "Human-readable label that indicates the current operating condition of the cluster.", - "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], - "readOnly" : true - }, - "tags" : { - "type" : "array", - "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "default" : "WORKLOAD_TYPE", + "description" : "Set this field to configure the replica set scaling mode for your cluster.\n\nBy default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes.\n\nWhen configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads.\n\nWhen configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads.", + "enum" : [ "SEQUENTIAL", "WORKLOAD_TYPE", "NODE_TYPE" ], "externalDocs" : { - "description" : "Resource Tags", - "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" - }, - "items" : { - "$ref" : "#/components/schemas/ResourceTag" - } - }, - "terminationProtectionEnabled" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." - }, - "versionReleaseSystem" : { - "type" : "string", - "default" : "LTS", - "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", - "enum" : [ "LTS", "CONTINUOUS" ] - } - }, - "title" : "Cluster Description" - }, - "LegacyAtlasTenantClusterUpgradeRequest" : { - "type" : "object", - "description" : "Request containing target state of tenant cluster to be upgraded", - "properties" : { - "acceptDataRisksAndForceReplicaSetReconfig" : { - "type" : "string", - "format" : "date-time", - "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", - "externalDocs" : { - "description" : "Reconfiguring a Replica Set during a regional outage", - "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + "description" : "Modify the Replica Set Scaling Mode", + "url" : "https://dochub.mongodb.org/core/scale-nodes" } }, - "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" ] - }, - "connectionStrings" : { - "$ref" : "#/components/schemas/ClusterConnectionStrings" - }, - "createDate" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", - "readOnly" : true - }, - "diskSizeGB" : { - "type" : "number", - "format" : "double", - "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.", - "maximum" : 4096, - "minimum" : 10 - }, - "diskWarmingMode" : { - "type" : "string", - "default" : "FULLY_WARMED", - "description" : "Disk warming mode selection.", - "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], - "externalDocs" : { - "description" : "Reduce Secondary Disk Warming Impact", - "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" - } - }, - "encryptionAtRestProvider" : { - "type" : "string", - "description" : "Cloud service provider that manages your customer keys to provide an additional layer of Encryption at Rest for the cluster.", - "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], - "externalDocs" : { - "description" : "Encryption at Rest using Customer Key Management", - "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" - } - }, - "globalClusterSelfManagedSharding" : { - "type" : "boolean", - "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen 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.\n\nWhen 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.\n\nThis 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" : { - "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the project.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "labels" : { - "type" : "array", - "deprecated" : true, - "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", - "items" : { - "$ref" : "#/components/schemas/ComponentLabel" - } - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - }, - "mongoDBMajorVersion" : { - "type" : "string", - "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", - "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-" - } - }, - "mongoDBVersion" : { - "type" : "string", - "description" : "Version of MongoDB that the cluster runs.", - "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)" - }, - "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.", - "externalDocs" : { - "description" : "Connection string URI format.", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, - "readOnly" : true - }, - "mongoURIUpdated" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when someone last updated the connection string. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", - "readOnly" : true - }, - "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.", - "externalDocs" : { - "description" : "Connection string URI format.", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "Human-readable label that identifies the cluster.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - }, - "numShards" : { - "type" : "integer", - "format" : "int32", - "default" : 1, - "description" : "Number of shards up to 50 to deploy for a sharded cluster. The resource returns `1` to indicate a replica set and values of `2` and higher to indicate a sharded cluster. The returned value equals the number of shards in the cluster.", - "externalDocs" : { - "description" : "Sharding", - "url" : "https://docs.mongodb.com/manual/sharding/" - }, - "maximum" : 50, - "minimum" : 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" - }, "replicationFactor" : { "type" : "integer", "format" : "int32", @@ -38472,6 +39988,10 @@ "type" : "string", "enum" : [ "INSTANCE_NAME", "PROCESSOR_NAME" ], "title" : "Streams Matcher Fields" + }, { + "type" : "string", + "enum" : [ "RULE_ID" ], + "title" : "Log Ingestion Matcher Fields" } ] }, "MatcherHostType" : { @@ -39122,7 +40642,7 @@ "NDSAuditTypeViewForNdsGroup" : { "type" : "string", "description" : "Unique identifier of event type.", - "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_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_SSL_ROTATED", "CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER", "CLUSTER_INSTANCE_SSL_REVOKED", "RELOAD_SSL_ON_PROCESSES", "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", "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", "MOVE_SKIPPED", "PROXY_RESTARTED", "PROXY_PANICKED", "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", "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", "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", "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", "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", "PENDING_INDEXES_DELETED", "PENDING_INDEXES_CANCELED", "PROCESS_RESTART_REQUESTED", "AUTO_HEALING_ACTION", "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", "CLUSTER_FORCE_RECONFIG_REQUESTED", "PROJECT_BYPASSED_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", "ATLAS_SQL_SCHEDULED_UPDATE_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_MODIFIED", "ATLAS_SQL_SCHEDULED_UPDATE_REMOVED" ], + "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_SSL_ROTATED", "CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER", "CLUSTER_INSTANCE_SSL_REVOKED", "RELOAD_SSL_ON_PROCESSES", "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", "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", "MOVE_SKIPPED", "PROXY_RESTARTED", "PROXY_PANICKED", "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", "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", "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", "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", "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", "CLUSTER_FORCE_RECONFIG_REQUESTED", "PROJECT_BYPASSED_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" ], "example" : "CLUSTER_CREATED", "title" : "NDS Audit Types" }, @@ -40019,7 +41539,7 @@ "example" : "cluster1", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -40261,7 +41781,9 @@ "enum" : [ "AVERAGE" ] }, "operator" : { - "$ref" : "#/components/schemas/Operator" + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, "threshold" : { "type" : "number", @@ -40445,6 +41967,54 @@ "required" : [ "typeName" ], "title" : "OpsGenie Notification" }, + "OrgActiveUserResponse" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OrgUserResponse" + }, { + "type" : "object", + "properties" : { + "country" : { + "type" : "string", + "description" : "Two alphabet characters that identifies MongoDB Cloud user's geographic location. This parameter uses the ISO 3166-1a2 code format.", + "example" : "US", + "pattern" : "^([A-Z]{2})$", + "readOnly" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the current account. This value is in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "firstName" : { + "type" : "string", + "description" : "First or given name that belongs to the MongoDB Cloud user.", + "example" : "John", + "readOnly" : true + }, + "lastAuth" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the current account last authenticated. This value is in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "lastName" : { + "type" : "string", + "description" : "Last name, family name, or surname that belongs to the MongoDB Cloud user.", + "example" : "Doe", + "readOnly" : true + }, + "mobileNumber" : { + "type" : "string", + "description" : "Mobile phone number that belongs to the MongoDB Cloud user.", + "pattern" : "(?:(?:\\\\+?1\\\\s*(?:[.-]\\\\s*)?)?(?:(\\\\s*([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9])\\\\s*)|([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9]))\\\\s*(?:[.-]\\\\s*)?)([2-9]1[02-9]|[2-9][02-9]1|[2-9][02-9]{2})\\\\s*(?:[.-]\\\\s*)?([0-9]{4})$", + "readOnly" : true + } + } + } ], + "required" : [ "createdAt", "firstName", "id", "lastName", "orgMembershipStatus", "roles", "username" ] + }, "OrgEventTypeViewForOrg" : { "type" : "string", "description" : "Unique identifier of event type.", @@ -40726,7 +42296,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/EventViewForOrg" }, @@ -40741,40 +42311,69 @@ } } }, + "OrgPendingUserResponse" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OrgUserResponse" + }, { + "type" : "object", + "properties" : { + "invitationCreatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud sent the invitation. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "invitationExpiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the invitation from MongoDB Cloud expires. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "inviterUsername" : { + "type" : "string", + "format" : "email", + "description" : "Username of the MongoDB Cloud user who sent the invitation to join the organization.", + "readOnly" : true + } + } + } ], + "required" : [ "id", "invitationCreatedAt", "invitationExpiresAt", "inviterUsername", "orgMembershipStatus", "roles", "username" ] + }, "OrgServiceAccount" : { "type" : "object", "properties" : { + "clientId" : { + "type" : "string", + "description" : "The Client ID of the Service Account.", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + }, "createdAt" : { "type" : "string", "format" : "date-time", - "description" : "Service account creation time." + "description" : "The date that the Service Account was created on." }, "description" : { "type" : "string", - "description" : "Description of the service account." - }, - "id" : { - "type" : "string", - "description" : "ID for the service account.", - "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + "description" : "Human readable description for the Service Account." }, "name" : { "type" : "string", - "description" : "Name for service account." + "description" : "Human-readable name for the Service Account." }, "roles" : { "type" : "array", - "description" : "Organization roles assigned to the Service Account.", + "description" : "A list of Organization roles associated with the Service Account.", "items" : { "type" : "string", - "description" : "Organization roles associated with the service account.", + "description" : "Organization roles available for Service Accounts.", "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] }, "uniqueItems" : true }, "secrets" : { "type" : "array", - "description" : "List of secrets.", + "description" : "A list of secrets associated with the specified Service Account.", "items" : { "$ref" : "#/components/schemas/ServiceAccountSecret" }, @@ -40787,63 +42386,215 @@ "properties" : { "description" : { "type" : "string", - "description" : "Human readable description for the service account.", + "description" : "Human readable description for the Service Account.", "maxLength" : 250, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "name" : { "type" : "string", - "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "description" : "Human-readable name for the Service Account. The name is modifiable and does not have to be unique.", "maxLength" : 64, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "roles" : { "type" : "array", - "description" : "Organization roles associated with the service account.", + "description" : "A list of organization-level roles for the Service Account.", "items" : { "type" : "string", - "description" : "Organization roles associated with the service account.", + "description" : "Organization roles available for Service Accounts.", "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] } }, "secretExpiresAfterHours" : { "type" : "integer", "format" : "int32", - "description" : "Secret expiration time." + "description" : "The expiration time of the new Service Account secret. The expiration is provided in hours." } }, - "required" : [ "description", "name", "secretExpiresAfterHours" ] + "required" : [ "description", "name", "roles", "secretExpiresAfterHours" ] }, "OrgServiceAccountUpdateRequest" : { "type" : "object", "properties" : { "description" : { "type" : "string", - "description" : "Human readable description for the service account.", + "description" : "Human readable description for the Service Account.", "maxLength" : 250, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "name" : { "type" : "string", - "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "description" : "Human-readable name for the Service Account. The name is modifiable and does not have to be unique.", "maxLength" : 64, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "roles" : { "type" : "array", - "description" : "Organization roles associated with the Service account.", + "description" : "A list of organization-level roles for the Service Account.", "items" : { "type" : "string", - "description" : "Organization roles associated with the service account.", + "description" : "Organization roles available for Service Accounts.", "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] } } } }, + "OrgUserRequest" : { + "type" : "object", + "properties" : { + "roles" : { + "$ref" : "#/components/schemas/OrgUserRolesRequest" + }, + "teamIds" : { + "type" : "array", + "description" : "List of unique 24-hexadecimal digit strings that identifies the teams to which this MongoDB Cloud user belongs.", + "items" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "uniqueItems" : true, + "writeOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address that represents the username of the MongoDB Cloud user.", + "writeOnly" : true + } + }, + "required" : [ "roles", "username" ] + }, + "OrgUserResponse" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "ACTIVE" : "#/components/schemas/OrgActiveUserResponse", + "PENDING" : "#/components/schemas/OrgPendingUserResponse" + }, + "propertyName" : "orgMembershipStatus" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/OrgPendingUserResponse" + }, { + "$ref" : "#/components/schemas/OrgActiveUserResponse" + } ], + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgMembershipStatus" : { + "type" : "string", + "description" : "String enum that indicates whether the MongoDB Cloud user has a pending invitation to join the organization or they are already active in the organization.", + "enum" : [ "PENDING", "ACTIVE" ], + "readOnly" : true + }, + "roles" : { + "$ref" : "#/components/schemas/OrgUserRolesResponse" + }, + "teamIds" : { + "type" : "array", + "description" : "List of unique 24-hexadecimal digit strings that identifies the teams to which this MongoDB Cloud user belongs.", + "items" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address that represents the username of the MongoDB Cloud user.", + "readOnly" : true + } + }, + "required" : [ "id", "orgMembershipStatus", "roles", "username" ] + }, + "OrgUserRolesRequest" : { + "type" : "object", + "description" : "Organization and project level roles to assign the MongoDB Cloud user within one organization.", + "properties" : { + "groupRoleAssignments" : { + "type" : "array", + "description" : "List of project level role assignments to assign the MongoDB Cloud user.", + "items" : { + "$ref" : "#/components/schemas/GroupRoleAssignment" + } + }, + "orgRoles" : { + "type" : "array", + "description" : "One or more organization level roles to assign the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_READ_ONLY", "ORG_MEMBER" ] + }, + "minItems" : 1, + "uniqueItems" : true + } + }, + "required" : [ "orgRoles" ], + "writeOnly" : true + }, + "OrgUserRolesResponse" : { + "type" : "object", + "description" : "Organization and project level roles assigned to one MongoDB Cloud user within one organization.", + "properties" : { + "groupRoleAssignments" : { + "type" : "array", + "description" : "List of project level role assignments assigned to the MongoDB Cloud user.", + "items" : { + "$ref" : "#/components/schemas/GroupRoleAssignment" + } + }, + "orgRoles" : { + "type" : "array", + "description" : "One or more organization level roles assigned to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_READ_ONLY", "ORG_MEMBER" ] + }, + "uniqueItems" : true + } + }, + "readOnly" : true + }, + "OrgUserUpdateRequest" : { + "type" : "object", + "properties" : { + "roles" : { + "$ref" : "#/components/schemas/OrgUserRolesRequest" + }, + "teamIds" : { + "type" : "array", + "description" : "List of unique 24-hexadecimal digit strings that identifies the teams to assign the MongoDB Cloud user.", + "items" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "uniqueItems" : true, + "writeOnly" : true + } + } + }, "OrganizationInvitation" : { "type" : "object", "properties" : { @@ -41048,7 +42799,7 @@ }, "restrictEmployeeAccess" : { "type" : "boolean", - "description" : "Flag that indicates whether to block MongoDB Support from accessing Atlas infrastructure 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/." + "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/." } } }, @@ -41195,7 +42946,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/AdvancedClusterDescription" }, @@ -41227,7 +42978,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/GroupAlertsConfig" }, @@ -41259,7 +43010,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/AlertViewForNdsGroup" }, @@ -41291,7 +43042,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ApiKeyUserDetails" }, @@ -41323,7 +43074,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/CloudAppUser" }, @@ -41355,7 +43106,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ApiAtlasCheckpointView" }, @@ -41388,7 +43139,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/CloudDatabaseUser" }, @@ -41420,7 +43171,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/DiskBackupExportJob" }, @@ -41452,7 +43203,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/EARPrivateEndpoint" }, @@ -41467,7 +43218,7 @@ } } }, - "PaginatedApiAtlasProviderRegionsView" : { + "PaginatedApiAtlasFlexBackupRestoreJob20250101View" : { "type" : "object", "properties" : { "links" : { @@ -41484,9 +43235,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/CloudProviderRegions" + "$ref" : "#/components/schemas/FlexBackupRestoreJob20250101" }, "readOnly" : true }, @@ -41499,7 +43250,7 @@ } } }, - "PaginatedApiAtlasServerlessBackupRestoreJobView" : { + "PaginatedApiAtlasFlexBackupSnapshot20240710View" : { "type" : "object", "properties" : { "links" : { @@ -41516,9 +43267,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" + "$ref" : "#/components/schemas/FlexBackupSnapshot20250101" }, "readOnly" : true }, @@ -41531,7 +43282,7 @@ } } }, - "PaginatedApiAtlasServerlessBackupSnapshotView" : { + "PaginatedApiAtlasProviderRegionsView" : { "type" : "object", "properties" : { "links" : { @@ -41548,9 +43299,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/ServerlessBackupSnapshot" + "$ref" : "#/components/schemas/CloudProviderRegions" }, "readOnly" : true }, @@ -41563,7 +43314,7 @@ } } }, - "PaginatedApiAtlasUSSBackupRestoreJob20250101View" : { + "PaginatedApiAtlasServerlessBackupRestoreJobView" : { "type" : "object", "properties" : { "links" : { @@ -41580,9 +43331,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/USSBackupRestoreJob20250101" + "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" }, "readOnly" : true }, @@ -41595,7 +43346,7 @@ } } }, - "PaginatedApiAtlasUSSBackupSnapshot20240710View" : { + "PaginatedApiAtlasServerlessBackupSnapshotView" : { "type" : "object", "properties" : { "links" : { @@ -41612,9 +43363,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/USSBackupSnapshot20250101" + "$ref" : "#/components/schemas/ServerlessBackupSnapshot" }, "readOnly" : true }, @@ -41644,7 +43395,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/BillingInvoiceMetadata" }, @@ -41676,7 +43427,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/BillingInvoice" }, @@ -41708,7 +43459,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/StreamsConnection" }, @@ -41723,6 +43474,38 @@ } } }, + "PaginatedApiStreamsPrivateLinkView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", + "items" : { + "$ref" : "#/components/schemas/StreamsPrivateLinkConnection" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, "PaginatedApiStreamsStreamProcessorWithStatsView" : { "type" : "object", "properties" : { @@ -41740,7 +43523,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/StreamsProcessorWithStats" }, @@ -41772,7 +43555,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/StreamsTenant" }, @@ -41804,7 +43587,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/UserAccessListResponse" }, @@ -41819,6 +43602,38 @@ } } }, + "PaginatedApiVersions" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ApiVersion" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, "PaginatedAppUserView" : { "type" : "object", "properties" : { @@ -41836,7 +43651,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/CloudAppUser" }, @@ -41868,7 +43683,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/Group" }, @@ -41900,7 +43715,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/MdbAvailableVersion" }, @@ -41932,7 +43747,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" }, @@ -41964,7 +43779,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/DiskBackupSnapshotExportBucket" }, @@ -41996,7 +43811,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/DiskBackupSnapshot" }, @@ -42028,7 +43843,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/DiskBackupReplicaSet" }, @@ -42060,7 +43875,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/DiskBackupSnapshotRestoreJob" }, @@ -42092,7 +43907,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/DiskBackupShardedClusterSnapshot" }, @@ -42125,7 +43940,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/CloudProviderContainer" }, @@ -42158,7 +43973,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ClusterDescription20240805" }, @@ -42190,7 +44005,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ConnectedOrgConfig" }, @@ -42223,7 +44038,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" }, @@ -42255,7 +44070,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/MesurementsDatabase" }, @@ -42287,7 +44102,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/MeasurementDiskPartition" }, @@ -42319,7 +44134,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/EventTypeDetails" }, @@ -42351,7 +44166,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/FederationIdentityProvider" }, @@ -42366,9 +44181,41 @@ } } }, + "PaginatedFlexClusters20250101" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", + "items" : { + "type" : "object" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, "PaginatedGroupServiceAccounts" : { "type" : "object", - "description" : "List of Service Accounts", + "description" : "A list of Project Service Accounts.", "properties" : { "links" : { "type" : "array", @@ -42384,7 +44231,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/GroupServiceAccount" }, @@ -42416,7 +44263,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ApiHostView_Atlas" }, @@ -42448,7 +44295,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ThirdPartyIntegration" }, @@ -42480,7 +44327,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/LegacyAtlasCluster" }, @@ -42512,7 +44359,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/NetworkPermissionEntry" }, @@ -42544,7 +44391,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/BackupOnlineArchive" }, @@ -42576,7 +44423,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/OrgGroup" }, @@ -42593,7 +44440,7 @@ }, "PaginatedOrgServiceAccounts" : { "type" : "object", - "description" : "List of Service Accounts", + "description" : "A list of Organization Service Accounts.", "properties" : { "links" : { "type" : "array", @@ -42609,7 +44456,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/OrgServiceAccount" }, @@ -42641,7 +44488,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/AtlasOrganization" }, @@ -42673,7 +44520,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/IngestionPipelineRun" }, @@ -42705,7 +44552,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/PrivateNetworkEndpointIdEntry" }, @@ -42737,7 +44584,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/PublicApiUsageDetailsLineItemView" }, @@ -42769,7 +44616,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/BackupRestoreJob" }, @@ -42802,7 +44649,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/AuthFederationRoleMapping" }, @@ -42834,7 +44681,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ServerlessInstanceDescription" }, @@ -42851,7 +44698,7 @@ }, "PaginatedServiceAccountGroup" : { "type" : "object", - "description" : "List of Service Account projects.", + "description" : "A list of projects associated with the Service Account.", "properties" : { "links" : { "type" : "array", @@ -42867,7 +44714,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ServiceAccountGroup" }, @@ -42882,7 +44729,7 @@ } } }, - "PaginatedSnapshotView" : { + "PaginatedServiceAccountIPAccessEntryView" : { "type" : "object", "properties" : { "links" : { @@ -42899,9 +44746,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/BackupSnapshot" + "$ref" : "#/components/schemas/ServiceAccountIPAccessListEntry" }, "readOnly" : true }, @@ -42914,7 +44761,7 @@ } } }, - "PaginatedTeamRoleView" : { + "PaginatedSnapshotView" : { "type" : "object", "properties" : { "links" : { @@ -42931,9 +44778,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/TeamRole" + "$ref" : "#/components/schemas/BackupSnapshot" }, "readOnly" : true }, @@ -42946,7 +44793,7 @@ } } }, - "PaginatedTeamView" : { + "PaginatedTeamRoleView" : { "type" : "object", "properties" : { "links" : { @@ -42963,9 +44810,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/TeamResponse" + "$ref" : "#/components/schemas/TeamRole" }, "readOnly" : true }, @@ -42978,7 +44825,7 @@ } } }, - "PaginatedTenantRestoreView" : { + "PaginatedTeamView" : { "type" : "object", "properties" : { "links" : { @@ -42995,9 +44842,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/TenantRestore" + "$ref" : "#/components/schemas/TeamResponse" }, "readOnly" : true }, @@ -43010,7 +44857,7 @@ } } }, - "PaginatedTenantSnapshotView" : { + "PaginatedTenantRestoreView" : { "type" : "object", "properties" : { "links" : { @@ -43027,9 +44874,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/BackupTenantSnapshot" + "$ref" : "#/components/schemas/TenantRestore" }, "readOnly" : true }, @@ -43042,7 +44889,7 @@ } } }, - "PaginatedUSSInstance20250101" : { + "PaginatedTenantSnapshotView" : { "type" : "object", "properties" : { "links" : { @@ -43059,9 +44906,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "type" : "object" + "$ref" : "#/components/schemas/BackupTenantSnapshot" }, "readOnly" : true }, @@ -43091,7 +44938,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/UserCert" }, @@ -43598,6 +45445,14 @@ "PrivateNetworkEndpointIdEntry" : { "type" : "object", "properties" : { + "azureConnectionName" : { + "type" : "string", + "description" : "Connection name that identifies the Azure private endpoint connection." + }, + "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." @@ -43606,6 +45461,11 @@ "type" : "string", "description" : "Human-readable label to identify customer's VPC endpoint DNS name." }, + "customerEndpointIPAddress" : { + "type" : "string", + "description" : "IP address used to connect to the Azure private endpoint.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + }, "endpointId" : { "type" : "string", "description" : "Unique 22-character alphanumeric string that identifies the private endpoint.", @@ -43618,6 +45478,10 @@ "minLength" : 22, "pattern" : "^vpce-[0-9a-f]{17}$" }, + "errorMessage" : { + "type" : "string", + "description" : "Error message describing a failure approving the private endpoint request." + }, "provider" : { "type" : "string", "default" : "AWS", @@ -43628,6 +45492,11 @@ "type" : "string", "description" : "Human-readable label to identify the region of customer's VPC endpoint." }, + "status" : { + "type" : "string", + "description" : "Status of the private endpoint connection request.", + "enum" : [ "PENDING", "OK", "FAILED", "DELETING" ] + }, "type" : { "type" : "string", "default" : "DATA_LAKE", @@ -43684,20 +45553,6 @@ "required" : [ "enabled", "serviceDiscovery", "username" ], "title" : "PROMETHEUS" }, - "ProxyInfo" : { - "type" : "object", - "description" : "VPC Proxy Information.", - "properties" : { - "authKey" : { - "type" : "string", - "description" : "Authentication key for the proxy." - }, - "dnsName" : { - "type" : "string", - "description" : "DNS name to use to reach the proxy/s." - } - } - }, "PublicApiUsageDetailsLineItemView" : { "type" : "object", "properties" : { @@ -43795,7 +45650,9 @@ "enum" : [ "AVERAGE" ] }, "operator" : { - "$ref" : "#/components/schemas/Operator" + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, "threshold" : { "type" : "number", @@ -43843,7 +45700,7 @@ "example" : "cluster1", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -44085,7 +45942,9 @@ "enum" : [ "AVERAGE" ] }, "operator" : { - "$ref" : "#/components/schemas/Operator" + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, "threshold" : { "type" : "number", @@ -44263,7 +46122,7 @@ "example" : "cluster1", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -44543,472 +46402,69 @@ } }, "zoneName" : { - "type" : "string", - "description" : "Human-readable label that identifies the zone in a Global Cluster. Provide this value only if `\"clusterType\" : \"GEOSHARDED\"`." - } - }, - "title" : "Replication Specifications" - }, - "ReplicationSpec20240805" : { - "type" : "object", - "description" : "Details that explain how MongoDB Cloud replicates data on the specified MongoDB database.", - "properties" : { - "id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a shard in a Cluster. If you include existing shard replication configurations in the request, you must specify this parameter. If you add a new shard to an existing Cluster, you may specify this parameter. The request deletes any existing shards in the Cluster that you exclude from the request.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "regionConfigs" : { - "type" : "array", - "description" : "Hardware specifications for nodes set for a given region. 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**.\n\n**Example:**\n\nIf you set `\"replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize\" : \"M30\"`, set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : `\"M30\"` if you have electable nodes and `\"replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize\" : `\"M30\"` if you have read-only nodes.", - "items" : { - "$ref" : "#/components/schemas/CloudRegionConfig20240805" - } - }, - "zoneId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the zone in a Global Cluster. This value can be used to configure Global Cluster backup policies.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "zoneName" : { - "type" : "string", - "description" : "Human-readable label that describes the zone this shard belongs to in a Global Cluster. Provide this value only if \"clusterType\" : \"GEOSHARDED\" but not \"selfManagedSharding\" : true." - } - }, - "title" : "Replication Specifications" - }, - "RequestAccepted" : { - "type" : "object", - "description" : "Accepted" - }, - "ResourceEventTypeView" : { - "type" : "string", - "description" : "Unique identifier of event type.", - "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], - "example" : "TAGS_MODIFIED", - "title" : "Resource Event Types" - }, - "ResourceEventTypeViewForOrg" : { - "type" : "string", - "description" : "Unique identifier of event type.", - "enum" : [ "GROUP_TAGS_MODIFIED" ], - "example" : "GROUP_TAGS_MODIFIED", - "title" : "Resource Event Types" - }, - "ResourceEventViewForNdsGroup" : { - "type" : "object", - "description" : "Resource event reflects different activities about resources.", - "properties" : { - "apiKeyId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "created" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true - }, - "eventTypeName" : { - "$ref" : "#/components/schemas/ResourceEventTypeView" - }, - "groupId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "isGlobalAdmin" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", - "readOnly" : true - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - }, - "orgId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "publicKey" : { - "type" : "string", - "format" : "email", - "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "example" : "test.user@mongodb.com", - "readOnly" : true - }, - "raw" : { - "$ref" : "#/components/schemas/raw" - }, - "remoteAddress" : { - "type" : "string", - "description" : "IPv4 or IPv6 address from which the user triggered this event.", - "example" : "216.172.40.186", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", - "readOnly" : true - }, - "resourceId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the resource associated with the event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "resourceType" : { - "type" : "string", - "description" : "Unique identifier of resource type.", - "example" : "cluster" - }, - "userId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "username" : { - "type" : "string", - "format" : "email", - "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", - "example" : "test.user@mongodb.com", - "readOnly" : true - } - }, - "required" : [ "created", "eventTypeName", "id", "resourceType" ], - "title" : "Resource Events" - }, - "ResourceEventViewForOrg" : { - "type" : "object", - "description" : "Resource event reflects different activities about resources.", - "properties" : { - "apiKeyId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "created" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true - }, - "eventTypeName" : { - "$ref" : "#/components/schemas/ResourceEventTypeViewForOrg" - }, - "groupId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "isGlobalAdmin" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", - "readOnly" : true - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - }, - "orgId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "publicKey" : { - "type" : "string", - "format" : "email", - "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "example" : "test.user@mongodb.com", - "readOnly" : true - }, - "raw" : { - "$ref" : "#/components/schemas/raw" - }, - "remoteAddress" : { - "type" : "string", - "description" : "IPv4 or IPv6 address from which the user triggered this event.", - "example" : "216.172.40.186", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", - "readOnly" : true - }, - "resourceId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the resource associated with the event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "resourceType" : { - "type" : "string", - "description" : "Unique identifier of resource type.", - "example" : "cluster" - }, - "userId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "username" : { - "type" : "string", - "format" : "email", - "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", - "example" : "test.user@mongodb.com", - "readOnly" : true - } - }, - "required" : [ "created", "eventTypeName", "id", "resourceType" ], - "title" : "Resource Events" - }, - "ResourceTag" : { - "type" : "object", - "description" : "Key-value pair that tags and categorizes a MongoDB Cloud organization, project, or cluster. For example, `environment : production`.", - "properties" : { - "key" : { - "type" : "string", - "description" : "Constant that defines the set of the tag. For example, `environment` in the `environment : production` tag.", - "maxLength" : 255, - "minLength" : 1 - }, - "value" : { - "type" : "string", - "description" : "Variable that belongs to the set of the tag. For example, `production` in the `environment : production` tag.", - "maxLength" : 255, - "minLength" : 1 - } - }, - "required" : [ "key", "value" ], - "title" : "Resource Tag" - }, - "RestoreJobFileHash" : { - "type" : "object", - "description" : "Key and value pair that map one restore file to one hashed checksum. This parameter applies after you download the corresponding **delivery.url**.", - "properties" : { - "fileName" : { - "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.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - }, - "typeName" : { - "type" : "string", - "description" : "Human-readable label that identifies the hashing algorithm used to compute the hash value.", - "enum" : [ "SHA1" ], - "readOnly" : true - } - }, - "readOnly" : true - }, - "RoleAssignment" : { - "type" : "object", - "properties" : { - "groupId" : { - "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", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" - }, - "orgId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization to which this role belongs. Each element within **roleAssignments** can have a value for **orgId** or **groupId**, but not both.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" - }, - "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.\n\nOrganization Roles\n\n* ORG_OWNER\n* ORG_MEMBER\n* ORG_GROUP_CREATOR\n* ORG_BILLING_ADMIN\n* ORG_READ_ONLY\n\nProject Roles\n\n* GROUP_CLUSTER_MANAGER\n* GROUP_DATA_ACCESS_ADMIN\n* GROUP_DATA_ACCESS_READ_ONLY\n* GROUP_DATA_ACCESS_READ_WRITE\n* GROUP_OWNER\n* GROUP_READ_ONLY\n* GROUP_SEARCH_INDEX_EDITOR\n* GROUP_STREAM_PROCESSING_OWNER\n\n", - "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] - } - } - }, - "SMSNotification" : { - "type" : "object", - "description" : "SMS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", - "properties" : { - "delayMin" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." - }, - "intervalMin" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", - "minimum" : 5 - }, - "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" : { - "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" ] + "type" : "string", + "description" : "Human-readable label that identifies the zone in a Global Cluster. Provide this value only if `\"clusterType\" : \"GEOSHARDED\"`." } }, - "required" : [ "typeName" ], - "title" : "SMS Notification" + "title" : "Replication Specifications" }, - "SampleDatasetStatus" : { + "ReplicationSpec20240805" : { "type" : "object", + "description" : "Details that explain how MongoDB Cloud replicates data on the specified MongoDB database.", "properties" : { - "_id" : { + "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies this sample dataset.", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a shard in a Cluster. If you include existing shard replication configurations in the request, you must specify this parameter. If you add a new shard to an existing Cluster, you may specify this parameter. The request deletes any existing shards in the Cluster that you exclude from the request.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "clusterName" : { - "type" : "string", - "description" : "Human-readable label that identifies the cluster into which you loaded the sample dataset.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "readOnly" : true - }, - "completeDate" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when the sample dataset load job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", - "readOnly" : true - }, - "createDate" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when you started the sample dataset load job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", - "readOnly" : true + "regionConfigs" : { + "type" : "array", + "description" : "Hardware specifications for nodes set for a given region. 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**.\n\n**Example:**\n\nIf you set `\"replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize\" : \"M30\"`, set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : `\"M30\"` if you have electable nodes and `\"replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize\" : `\"M30\"` if you have read-only nodes.", + "items" : { + "$ref" : "#/components/schemas/CloudRegionConfig20240805" + } }, - "errorMessage" : { + "zoneId" : { "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.", + "description" : "Unique 24-hexadecimal digit string that identifies the zone in a Global Cluster. This value can be used to configure Global Cluster backup policies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "state" : { + "zoneName" : { "type" : "string", - "description" : "Status of the sample dataset load job.", - "enum" : [ "WORKING", "FAILED", "COMPLETED" ], - "readOnly" : true + "description" : "Human-readable label that describes the zone this shard belongs to in a Global Cluster. Provide this value only if \"clusterType\" : \"GEOSHARDED\" but not \"selfManagedSharding\" : true." } - } + }, + "title" : "Replication Specifications" }, - "SearchDeploymentAuditTypeView" : { + "RequestAccepted" : { + "type" : "object", + "description" : "Accepted" + }, + "ResourceEventTypeView" : { "type" : "string", "description" : "Unique identifier of event type.", - "enum" : [ "SEARCH_DEPLOYMENT_CREATED", "SEARCH_DEPLOYMENT_UPDATED", "SEARCH_DEPLOYMENT_DELETED" ], - "example" : "SEARCH_DEPLOYMENT_CREATED", - "title" : "Search Deployment Audit Types" + "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], + "example" : "TAGS_MODIFIED", + "title" : "Resource Event Types" }, - "SearchDeploymentAuditView" : { + "ResourceEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "GROUP_TAGS_MODIFIED" ], + "example" : "GROUP_TAGS_MODIFIED", + "title" : "Resource Event Types" + }, + "ResourceEventViewForNdsGroup" : { "type" : "object", - "description" : "Indicates activities on decoupled search nodes.", + "description" : "Resource event reflects different activities about resources.", "properties" : { "apiKeyId" : { "type" : "string", @@ -45026,7 +46482,7 @@ "readOnly" : true }, "eventTypeName" : { - "$ref" : "#/components/schemas/SearchDeploymentAuditTypeView" + "$ref" : "#/components/schemas/ResourceEventTypeView" }, "groupId" : { "type" : "string", @@ -45077,6 +46533,7 @@ "type" : "string", "format" : "email", "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true }, "raw" : { @@ -45089,6 +46546,20 @@ "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", "readOnly" : true }, + "resourceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the resource associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resourceType" : { + "type" : "string", + "description" : "Unique identifier of resource type.", + "example" : "cluster" + }, "userId" : { "type" : "string", "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", @@ -45106,541 +46577,159 @@ "readOnly" : true } }, - "required" : [ "created", "eventTypeName", "id" ], - "title" : "Search Deployment Audits" - }, - "SearchHostStatusDetail" : { - "type" : "object", - "properties" : { - "hostname" : { - "type" : "string", - "description" : "Hostname that corresponds to the status detail." - }, - "mainIndex" : { - "$ref" : "#/components/schemas/SearchMainIndexStatusDetail" - }, - "queryable" : { - "type" : "boolean", - "description" : "Flag that indicates whether the index is queryable on the host." - }, - "stagedIndex" : { - "$ref" : "#/components/schemas/SearchStagedIndexStatusDetail" - }, - "status" : { - "type" : "string", - "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", - "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] - } - }, - "title" : "Search Host Status Detail" - }, - "SearchIndex" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/ClusterSearchIndex" - }, { - "type" : "object", - "properties" : { - "analyzer" : { - "type" : "string", - "default" : "lucene.standard", - "description" : "Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves a variety of changes made to the text in fields:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\n MongoDB Cloud uses the selected process to build the Atlas Search index.", - "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ], - "externalDocs" : { - "description" : "Atlas Search Analyzers", - "url" : "https://dochub.mongodb.org/core/analyzers--fts" - } - }, - "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" - }, - "items" : { - "$ref" : "#/components/schemas/ApiAtlasFTSAnalyzersViewManual" - } - }, - "mappings" : { - "$ref" : "#/components/schemas/ApiAtlasFTSMappingsViewManual" - }, - "searchAnalyzer" : { - "type" : "string", - "default" : "lucene.standard", - "description" : "Method applied to identify words when searching this index.", - "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] - }, - "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" - }, - "items" : { - "$ref" : "#/components/schemas/SearchSynonymMappingDefinition" - } - } - } - } ], - "required" : [ "collectionName", "database", "name" ] - }, - "SearchIndexCreateRequest" : { - "type" : "object", - "discriminator" : { - "mapping" : { - "search" : "#/components/schemas/TextSearchIndexCreateRequest", - "vectorSearch" : "#/components/schemas/VectorSearchIndexCreateRequest" - }, - "propertyName" : "type" - }, - "properties" : { - "collectionName" : { - "type" : "string", - "description" : "Label that identifies the collection to create an Atlas Search index in." - }, - "database" : { - "type" : "string", - "description" : "Label that identifies the database that contains the collection to create an Atlas Search index in." - }, - "name" : { - "type" : "string", - "description" : "Label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique." - }, - "type" : { - "type" : "string", - "description" : "Type of the index. The default type is search.", - "enum" : [ "search", "vectorSearch" ] - } - }, - "required" : [ "collectionName", "database", "name" ] - }, - "SearchIndexDefinition" : { - "type" : "object", - "description" : "The search index definition set by the user.", - "title" : "Search Index Definition" - }, - "SearchIndexDefinitionVersion" : { - "type" : "object", - "description" : "Object which includes the version number of the index definition and the time that the index definition was created.", - "properties" : { - "createdAt" : { - "type" : "string", - "format" : "date-time", - "description" : "The time at which this index definition was created." - }, - "version" : { - "type" : "integer", - "format" : "int64", - "description" : "The version number associated with this index definition when it was created." - } - }, - "title" : "Search Index Definition Version" + "required" : [ "created", "eventTypeName", "id", "resourceType" ], + "title" : "Resource Events" }, - "SearchIndexResponse" : { + "ResourceEventViewForOrg" : { "type" : "object", - "discriminator" : { - "mapping" : { - "search" : "#/components/schemas/TextSearchIndexResponse", - "vectorSearch" : "#/components/schemas/VectorSearchIndexResponse" - }, - "propertyName" : "type" - }, + "description" : "Resource event reflects different activities about resources.", "properties" : { - "collectionName" : { - "type" : "string", - "description" : "Label that identifies the collection that contains one or more Atlas Search indexes." - }, - "database" : { - "type" : "string", - "description" : "Label that identifies the database that contains the collection with one or more Atlas Search indexes." - }, - "indexID" : { + "apiKeyId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies this Atlas Search index.", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" - }, - "latestDefinition" : { - "$ref" : "#/components/schemas/SearchIndexDefinition" - }, - "latestDefinitionVersion" : { - "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" - }, - "name" : { - "type" : "string", - "description" : "Label that identifies this index. Within each namespace, the names of all indexes must be unique." - }, - "queryable" : { - "type" : "boolean", - "description" : "Flag that indicates whether the index is queryable on all hosts." - }, - "status" : { - "type" : "string", - "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", - "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] - }, - "statusDetail" : { - "type" : "array", - "description" : "List of documents detailing index status on each host.", - "items" : { - "$ref" : "#/components/schemas/SearchHostStatusDetail" - } - }, - "type" : { - "type" : "string", - "description" : "Type of the index. The default type is search.", - "enum" : [ "search", "vectorSearch" ] - } - }, - "title" : "Search Index Response" - }, - "SearchIndexUpdateRequest" : { - "type" : "object", - "properties" : { - "definition" : { - "type" : "object", - "description" : "The index definition to update the search index to.", - "oneOf" : [ { - "$ref" : "#/components/schemas/TextSearchIndexDefinition" - }, { - "$ref" : "#/components/schemas/VectorSearchIndexDefinition" - } ] - } - }, - "required" : [ "definition" ], - "title" : "Search Index Update Request" - }, - "SearchMainIndexStatusDetail" : { - "type" : "object", - "description" : "Contains status information about the active index.", - "properties" : { - "definition" : { - "$ref" : "#/components/schemas/SearchIndexDefinition" - }, - "definitionVersion" : { - "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" - }, - "message" : { - "type" : "string", - "description" : "Optional message describing an error." - }, - "queryable" : { - "type" : "boolean", - "description" : "Flag that indicates whether the index generation is queryable on the host." - }, - "status" : { - "type" : "string", - "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", - "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] - } - }, - "title" : "Search Main Index Status Detail" - }, - "SearchMappings" : { - "type" : "object", - "description" : "Index specifications for the collection's fields.", - "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/field-mapping-definition-fts#static-and-dynamic-mappings" - } - }, - "fields" : { - "type" : "object", - "additionalProperties" : { - "type" : "object", - "description" : "One or more field specifications for the Atlas Search index. Required if **mappings.dynamic** is omitted or set to **false**.", - "externalDocs" : { - "description" : "Atlas Search Index", - "url" : "https://dochub.mongodb.org/core/index-definitions-fts" - }, - "x-additionalPropertiesName" : "Field Name" - }, - "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" - }, - "x-additionalPropertiesName" : "Field Name" - } - }, - "title" : "Mappings" - }, - "SearchStagedIndexStatusDetail" : { - "type" : "object", - "description" : "Contains status information about an index building in the background.", - "properties" : { - "definition" : { - "$ref" : "#/components/schemas/SearchIndexDefinition" - }, - "definitionVersion" : { - "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" - }, - "message" : { - "type" : "string", - "description" : "Optional message describing an error." - }, - "queryable" : { - "type" : "boolean", - "description" : "Flag that indicates whether the index generation is queryable on the host." + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "status" : { - "type" : "string", - "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", - "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] - } - }, - "title" : "Search Staged Index Status Detail" - }, - "SearchSynonymMappingDefinition" : { - "type" : "object", - "description" : "Synonyms used for this full text index.", - "properties" : { - "analyzer" : { + "created" : { "type" : "string", - "description" : "Specific pre-defined method chosen to apply to the synonyms to be searched.", - "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true }, - "name" : { - "type" : "string", - "description" : "Label that identifies the synonym definition. Each **synonym.name** must be unique within the same index definition." + "eventTypeName" : { + "$ref" : "#/components/schemas/ResourceEventTypeViewForOrg" }, - "source" : { - "$ref" : "#/components/schemas/SynonymSource" - } - }, - "required" : [ "analyzer", "name", "source" ], - "title" : "Synonym Mapping Definition" - }, - "ServerlessAWSTenantEndpoint" : { - "type" : "object", - "description" : "View for a serverless AWS tenant endpoint.", - "properties" : { - "_id" : { + "groupId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "cloudProviderEndpointId" : { - "type" : "string", - "description" : "Unique string that identifies the private endpoint's network interface.", - "pattern" : "^vpce-[0-9a-f]{17}$", - "readOnly" : true - }, - "comment" : { - "type" : "string", - "description" : "Human-readable comment associated with the private endpoint.", - "maxLength" : 80, - "readOnly" : true - }, - "endpointServiceName" : { + "id" : { "type" : "string", - "description" : "Unique string that identifies the Amazon Web Services (AWS) PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", - "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "errorMessage" : { - "type" : "string", - "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", "readOnly" : true }, - "providerName" : { - "type" : "string", - "description" : "Human-readable label that identifies the cloud service provider.", - "enum" : [ "AWS" ], + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, "readOnly" : true }, - "status" : { - "type" : "string", - "description" : "Human-readable label that indicates the current operating status of the private endpoint.", - "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], - "readOnly" : true - } - }, - "title" : "AWS" - }, - "ServerlessAWSTenantEndpointUpdate" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" - }, { - "type" : "object", - "properties" : { - "cloudProviderEndpointId" : { - "type" : "string", - "description" : "Unique string that identifies the private endpoint's network interface.", - "pattern" : "^vpce-[0-9a-f]{17}$", - "writeOnly" : true - } - } - } ], - "description" : "Updates to a serverless AWS tenant endpoint.", - "required" : [ "providerName" ], - "title" : "AWS" - }, - "ServerlessAzureTenantEndpoint" : { - "type" : "object", - "description" : "View for a serverless Azure tenant endpoint.", - "properties" : { - "_id" : { + "orgId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "cloudProviderEndpointId" : { - "type" : "string", - "description" : "Unique string that identifies the Azure private endpoint's network interface that someone added to this private endpoint service.", - "pattern" : "^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\\.Network/privateEndpoints/[-\\w._()]+$", - "readOnly" : true - }, - "comment" : { + "publicKey" : { "type" : "string", - "description" : "Human-readable comment associated with the private endpoint.", - "maxLength" : 80, + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true }, - "endpointServiceName" : { - "type" : "string", - "description" : "Unique string that identifies the Azure private endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", - "pattern" : "^pls_[0-9a-f]{24}$", - "readOnly" : true + "raw" : { + "$ref" : "#/components/schemas/raw" }, - "errorMessage" : { + "remoteAddress" : { "type" : "string", - "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", "readOnly" : true }, - "privateEndpointIpAddress" : { + "resourceId" : { "type" : "string", - "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "description" : "Unique 24-hexadecimal digit string that identifies the resource associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "privateLinkServiceResourceId" : { + "resourceType" : { "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 + "description" : "Unique identifier of resource type.", + "example" : "cluster" }, - "providerName" : { + "userId" : { "type" : "string", - "description" : "Human-readable label that identifies the cloud service provider.", - "enum" : [ "AZURE" ], + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "status" : { + "username" : { "type" : "string", - "description" : "Human-readable label that indicates the current operating status of the private endpoint.", - "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true } }, - "title" : "Azure" - }, - "ServerlessAzureTenantEndpointUpdate" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" - }, { - "type" : "object", - "properties" : { - "cloudProviderEndpointId" : { - "type" : "string", - "description" : "Unique string that identifies the Azure private endpoint's network interface for this private endpoint service.", - "pattern" : "^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\\.Network/privateEndpoints/[-\\w._()]+$", - "writeOnly" : true - }, - "privateEndpointIpAddress" : { - "type" : "string", - "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", - "writeOnly" : true - } - } - } ], - "description" : "Updates to a serverless Azure tenant endpoint.", - "required" : [ "providerName" ], - "title" : "AZURE" + "required" : [ "created", "eventTypeName", "id", "resourceType" ], + "title" : "Resource Events" }, - "ServerlessBackupRestoreJob" : { + "ResourceTag" : { "type" : "object", + "description" : "Key-value pair that tags and categorizes a MongoDB Cloud organization, project, or cluster. For example, `environment : production`.", "properties" : { - "cancelled" : { - "type" : "boolean", - "description" : "Flag that indicates whether someone canceled this restore job.", - "readOnly" : true - }, - "deliveryType" : { + "key" : { "type" : "string", - "description" : "Human-readable label that categorizes the restore job to create.", - "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\"`.", - "items" : { - "type" : "string", - "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download." - }, - "readOnly" : true - }, - "desiredTimestamp" : { - "$ref" : "#/components/schemas/ApiBSONTimestampView" - }, - "expired" : { - "type" : "boolean", - "description" : "Flag that indicates whether the restore job expired.", - "readOnly" : true + "description" : "Constant that defines the set of the tag. For example, `environment` in the `environment : production` tag.", + "maxLength" : 255, + "minLength" : 1 }, - "expiresAt" : { + "value" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when the restore job expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true - }, - "failed" : { - "type" : "boolean", - "description" : "Flag that indicates whether the restore job failed.", - "readOnly" : true - }, - "finishedAt" : { + "description" : "Variable that belongs to the set of the tag. For example, `production` in the `environment : production` tag.", + "maxLength" : 255, + "minLength" : 1 + } + }, + "required" : [ "key", "value" ], + "title" : "Resource Tag" + }, + "RestoreJobFileHash" : { + "type" : "object", + "description" : "Key and value pair that map one restore file to one hashed checksum. This parameter applies after you download the corresponding **delivery.url**.", + "properties" : { + "fileName" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when the restore job completed. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Human-readable label that identifies the hashed file.", "readOnly" : true }, - "id" : { + "hash" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the restore job.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "description" : "Hashed checksum that maps to the restore file.", "readOnly" : true }, "links" : { @@ -45655,87 +46744,173 @@ }, "readOnly" : true }, - "oplogInc" : { - "type" : "integer", - "format" : "int32", - "description" : "Oplog operation number from which you want to restore this snapshot. This number represents the second part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", - "example" : 1, - "minimum" : 1 + "typeName" : { + "type" : "string", + "description" : "Human-readable label that identifies the hashing algorithm used to compute the hash value.", + "enum" : [ "SHA1" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "RoleAssignment" : { + "type" : "object", + "properties" : { + "groupId" : { + "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", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" }, - "oplogTs" : { + "orgId" : { + "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", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "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.\n\nOrganization Roles\n\n* ORG_OWNER\n* ORG_MEMBER\n* ORG_GROUP_CREATOR\n* ORG_BILLING_ADMIN\n* ORG_READ_ONLY\n\nProject Roles\n\n* GROUP_CLUSTER_MANAGER\n* GROUP_DATA_ACCESS_ADMIN\n* GROUP_DATA_ACCESS_READ_ONLY\n* GROUP_DATA_ACCESS_READ_WRITE\n* GROUP_OWNER\n* GROUP_READ_ONLY\n* GROUP_SEARCH_INDEX_EDITOR\n* GROUP_STREAM_PROCESSING_OWNER\n\n", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + } + }, + "SMSNotification" : { + "type" : "object", + "description" : "SMS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { "type" : "integer", "format" : "int32", - "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`.", - "minimum" : 1199145600 + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." }, - "pointInTimeUTCSeconds" : { + "intervalMin" : { "type" : "integer", "format" : "int32", - "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`.", - "minimum" : 1199145600 + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 }, - "snapshotId" : { + "mobileNumber" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "description" : "Mobile phone number to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"SMS\"`.", + "example" : "1233337892" + }, + "notifierId" : { + "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" ] + } + }, + "required" : [ "typeName" ], + "title" : "SMS Notification" + }, + "SampleDatasetStatus" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies this sample dataset.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "targetClusterName" : { + "clusterName" : { "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\"`.", + "description" : "Human-readable label that identifies the cluster into which you loaded the sample dataset.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "readOnly" : true }, - "targetGroupId" : { + "completeDate" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the target project for the specified **targetClusterName**.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" + "format" : "date-time", + "description" : "Date and time when the sample dataset load job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true }, - "timestamp" : { + "createDate" : { "type" : "string", "format" : "date-time", - "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.", + "description" : "Date and time when you started the sample dataset load job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "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.", + "enum" : [ "WORKING", "FAILED", "COMPLETED" ], "readOnly" : true } - }, - "required" : [ "deliveryType", "targetClusterName", "targetGroupId" ] + } }, - "ServerlessBackupSnapshot" : { + "SearchDeploymentAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "SEARCH_DEPLOYMENT_CREATED", "SEARCH_DEPLOYMENT_UPDATED", "SEARCH_DEPLOYMENT_DELETED" ], + "example" : "SEARCH_DEPLOYMENT_CREATED", + "title" : "Search Deployment Audit Types" + }, + "SearchDeploymentAuditView" : { "type" : "object", + "description" : "Indicates activities on decoupled search nodes.", "properties" : { - "createdAt" : { + "apiKeyId" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "expiresAt" : { + "created" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "frequencyType" : { + "eventTypeName" : { + "$ref" : "#/components/schemas/SearchDeploymentAuditTypeView" + }, + "groupId" : { "type" : "string", - "description" : "Human-readable label that identifies how often this snapshot triggers.", - "enum" : [ "hourly", "daily", "weekly", "monthly" ], + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, "links" : { "type" : "array", "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", @@ -45748,450 +46923,445 @@ }, "readOnly" : true }, - "mongodVersion" : { + "orgId" : { "type" : "string", - "description" : "Version of the MongoDB host that this snapshot backs up.", - "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "serverlessInstanceName" : { + "publicKey" : { "type" : "string", - "description" : "Human-readable label given to the serverless instance from which MongoDB Cloud took this snapshot.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", "readOnly" : true }, - "snapshotType" : { + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { "type" : "string", - "description" : "Human-readable label that identifies when this snapshot triggers.", - "enum" : [ "onDemand", "scheduled" ], + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", "readOnly" : true }, - "status" : { + "userId" : { "type" : "string", - "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", - "enum" : [ "queued", "inProgress", "completed", "failed" ], + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "storageSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "Number of bytes taken to store the backup snapshot.", + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true } - } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Search Deployment Audits" }, - "ServerlessConnectionStringsPrivateEndpointItem" : { + "SearchHostStatusDetail" : { "type" : "object", - "description" : "Details of a private endpoint deployed for this serverless instance.", "properties" : { - "endpointId" : { + "hostname" : { "type" : "string", - "description" : "Unique string that the cloud provider uses to identify the private endpoint.", - "readOnly" : true + "description" : "Hostname that corresponds to the status detail." }, - "providerName" : { - "type" : "string", - "description" : "Cloud provider where the private endpoint is deployed.", - "enum" : [ "AWS", "AZURE" ], - "readOnly" : true + "mainIndex" : { + "$ref" : "#/components/schemas/SearchMainIndexStatusDetail" }, - "region" : { + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on the host." + }, + "stagedIndex" : { + "$ref" : "#/components/schemas/SearchStagedIndexStatusDetail" + }, + "status" : { "type" : "string", - "description" : "Region where the private endpoint is deployed.", - "readOnly" : true + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] } }, - "title" : "Serverless Instance Private Endpoint Connection Strings Endpoint" + "title" : "Search Host Status Detail" }, - "ServerlessConnectionStringsPrivateEndpointList" : { + "SearchIndex" : { "type" : "object", - "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/" + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, { + "type" : "object", + "properties" : { + "analyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves a variety of changes made to the text in fields:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\n MongoDB Cloud uses the selected process to build the Atlas Search index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ], + "externalDocs" : { + "description" : "Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/analyzers--fts" + } + }, + "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" + }, + "items" : { + "$ref" : "#/components/schemas/ApiAtlasFTSAnalyzersViewManual" + } + }, + "mappings" : { + "$ref" : "#/components/schemas/ApiAtlasFTSMappingsViewManual" + }, + "searchAnalyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Method applied to identify words when searching this index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] + }, + "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" + }, + "items" : { + "$ref" : "#/components/schemas/SearchSynonymMappingDefinition" + } + } + } + } ], + "required" : [ "collectionName", "database", "name" ] + }, + "SearchIndexCreateRequest" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "search" : "#/components/schemas/TextSearchIndexCreateRequest", + "vectorSearch" : "#/components/schemas/VectorSearchIndexCreateRequest" + }, + "propertyName" : "type" }, "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**.", - "items" : { - "$ref" : "#/components/schemas/ServerlessConnectionStringsPrivateEndpointItem" - }, - "readOnly" : true + "collectionName" : { + "type" : "string", + "description" : "Label that identifies the collection to create an Atlas Search index in." }, - "srvConnectionString" : { + "database" : { "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 + "description" : "Label that identifies the database that contains the collection to create an Atlas Search index in." + }, + "name" : { + "type" : "string", + "description" : "Label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique." }, "type" : { "type" : "string", - "description" : "MongoDB process type to which your application connects.", - "enum" : [ "MONGOS" ], - "readOnly" : true + "description" : "Type of the index. The default type is search.", + "enum" : [ "search", "vectorSearch" ] } }, - "title" : "Serverless Instance Private Endpoint Connection String" + "required" : [ "collectionName", "database", "name" ] }, - "ServerlessEventTypeViewAlertable" : { - "type" : "string", - "description" : "Event type that triggers an alert.", - "enum" : [ "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], - "example" : "OUTSIDE_SERVERLESS_METRIC_THRESHOLD", - "title" : "Serverless Event Types" + "SearchIndexDefinition" : { + "type" : "object", + "description" : "The search index definition set by the user.", + "title" : "Search Index Definition" + }, + "SearchIndexDefinitionVersion" : { + "type" : "object", + "description" : "Object which includes the version number of the index definition and the time that the index definition was created.", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "The time at which this index definition was created." + }, + "version" : { + "type" : "integer", + "format" : "int64", + "description" : "The version number associated with this index definition when it was created." + } + }, + "title" : "Search Index Definition Version" }, - "ServerlessInstanceDescription" : { + "SearchIndexResponse" : { "type" : "object", - "description" : "Group of settings that configure a MongoDB serverless instance.", - "properties" : { - "connectionStrings" : { - "$ref" : "#/components/schemas/ServerlessInstanceDescriptionConnectionStrings" + "discriminator" : { + "mapping" : { + "search" : "#/components/schemas/TextSearchIndexResponse", + "vectorSearch" : "#/components/schemas/VectorSearchIndexResponse" }, - "createDate" : { + "propertyName" : "type" + }, + "properties" : { + "collectionName" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", - "readOnly" : true + "description" : "Label that identifies the collection that contains one or more Atlas Search indexes." }, - "groupId" : { + "database" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the project.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "description" : "Label that identifies the database that contains the collection with one or more Atlas Search indexes." }, - "id" : { + "indexID" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the serverless instance.", + "description" : "Unique 24-hexadecimal digit string that identifies this Atlas Search index.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "pattern" : "^([a-f0-9]{24})$" }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true + "latestDefinition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" }, - "mongoDBVersion" : { - "type" : "string", - "description" : "Version of MongoDB that the serverless instance runs.", - "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", - "readOnly" : true + "latestDefinitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" }, "name" : { "type" : "string", - "description" : "Human-readable label that identifies the serverless instance.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - }, - "providerSettings" : { - "$ref" : "#/components/schemas/ServerlessProviderSettings" + "description" : "Label that identifies this index. Within each namespace, the names of all indexes must be unique." }, - "serverlessBackupOptions" : { - "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on all hosts." }, - "stateName" : { + "status" : { "type" : "string", - "description" : "Human-readable label that indicates the current operating condition of the serverless instance.", - "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], - "readOnly" : true + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] }, - "tags" : { + "statusDetail" : { "type" : "array", - "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", + "description" : "List of documents detailing index status on each host.", "items" : { - "$ref" : "#/components/schemas/ResourceTag" + "$ref" : "#/components/schemas/SearchHostStatusDetail" } }, - "terminationProtectionEnabled" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." + "type" : { + "type" : "string", + "description" : "Type of the index. The default type is search.", + "enum" : [ "search", "vectorSearch" ] } }, - "required" : [ "providerSettings" ], - "title" : "Serverless Instance Description" + "title" : "Search Index Response" }, - "ServerlessInstanceDescriptionConnectionStrings" : { + "SearchIndexUpdateRequest" : { "type" : "object", - "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", - "externalDocs" : { - "description" : "Connection string URI format.", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, "properties" : { - "privateEndpoint" : { - "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.", - "items" : { - "$ref" : "#/components/schemas/ServerlessConnectionStringsPrivateEndpointList" - }, - "readOnly" : true - }, - "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.", - "externalDocs" : { - "description" : "Connection String URI Format", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, - "readOnly" : true + "definition" : { + "type" : "object", + "description" : "The index definition to update the search index to.", + "oneOf" : [ { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + }, { + "$ref" : "#/components/schemas/VectorSearchIndexDefinition" + } ] } }, - "readOnly" : true, - "title" : "Serverless Instance Connection Strings" + "required" : [ "definition" ], + "title" : "Search Index Update Request" }, - "ServerlessInstanceDescriptionCreate" : { + "SearchMainIndexStatusDetail" : { "type" : "object", - "description" : "Settings that you can specify when you create a serverless instance.", + "description" : "Contains status information about the active index.", "properties" : { - "name" : { - "type" : "string", - "description" : "Human-readable label that identifies the serverless instance.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "writeOnly" : true - }, - "providerSettings" : { - "$ref" : "#/components/schemas/ServerlessProviderSettings" + "definition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" }, - "serverlessBackupOptions" : { - "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" }, - "stateName" : { + "message" : { "type" : "string", - "description" : "Human-readable label that indicates the current operating condition of the serverless instance.", - "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], - "readOnly" : true - }, - "tags" : { - "type" : "array", - "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", - "items" : { - "$ref" : "#/components/schemas/ResourceTag" - } + "description" : "Optional message describing an error." }, - "terminationProtectionEnabled" : { + "queryable" : { "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." + "description" : "Flag that indicates whether the index generation is queryable on the host." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] } }, - "required" : [ "name", "providerSettings" ], - "title" : "Serverless Instance Description Create" + "title" : "Search Main Index Status Detail" }, - "ServerlessInstanceDescriptionUpdate" : { + "SearchMappings" : { "type" : "object", - "description" : "Settings that you can update when you request a serverless cluster update.", + "description" : "Index specifications for the collection's fields.", "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.", - "items" : { - "$ref" : "#/components/schemas/ResourceTag" + "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/field-mapping-definition-fts#static-and-dynamic-mappings" } }, - "terminationProtectionEnabled" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." + "fields" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "One or more field specifications for the Atlas Search index. Required if **mappings.dynamic** is omitted or set to **false**.", + "externalDocs" : { + "description" : "Atlas Search Index", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "x-additionalPropertiesName" : "Field Name" + }, + "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" + }, + "x-additionalPropertiesName" : "Field Name" } }, - "title" : "Serverless Instance Description Update" + "title" : "Mappings" }, - "ServerlessMetricAlertConfigViewForNdsGroup" : { + "SearchStagedIndexStatusDetail" : { "type" : "object", - "description" : "Serverless metric alert configuration allows to select which serverless database metrics trigger alerts and how users are notified.", + "description" : "Contains status information about an index building in the background.", "properties" : { - "created" : { + "definition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" + }, + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "message" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "description" : "Optional message describing an error." }, - "enabled" : { + "queryable" : { "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + "description" : "Flag that indicates whether the index generation is queryable on the host." }, - "eventTypeName" : { - "$ref" : "#/components/schemas/ServerlessEventTypeViewAlertable" + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Search Staged Index Status Detail" + }, + "SearchSynonymMappingDefinition" : { + "type" : "object", + "description" : "Synonyms used for this full text index.", + "properties" : { + "analyzer" : { + "type" : "string", + "description" : "Specific pre-defined method chosen to apply to the synonyms to be searched.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] }, - "groupId" : { + "name" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "description" : "Label that identifies the synonym definition. Each **synonym.name** must be unique within the same index definition." }, - "id" : { + "source" : { + "$ref" : "#/components/schemas/SynonymSource" + } + }, + "required" : [ "analyzer", "name", "source" ], + "title" : "Synonym Mapping Definition" + }, + "ServerlessAWSTenantEndpoint" : { + "type" : "object", + "description" : "View for a serverless AWS tenant endpoint.", + "properties" : { + "_id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - }, - "matchers" : { - "type" : "array", - "description" : "Matching conditions for target resources.", - "items" : { - "$ref" : "#/components/schemas/AlertMatcher" - } - }, - "metricThreshold" : { - "$ref" : "#/components/schemas/ServerlessMetricThreshold" - }, - "notifications" : { - "type" : "array", - "description" : "List that contains the targets that MongoDB Cloud sends notifications.", - "items" : { - "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" - } - }, - "updated" : { + "cloudProviderEndpointId" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Unique string that identifies the private endpoint's network interface.", + "pattern" : "^vpce-[0-9a-f]{17}$", "readOnly" : true - } - }, - "required" : [ "eventTypeName", "notifications" ], - "title" : "Serverless Alert Configuration" - }, - "ServerlessMetricThreshold" : { - "type" : "object", - "description" : "Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.", - "discriminator" : { - "mapping" : { - "SERVERLESS_AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", - "SERVERLESS_AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", - "SERVERLESS_AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", - "SERVERLESS_CONNECTIONS" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricThresholdView", - "SERVERLESS_NETWORK_BYTES_IN" : "#/components/schemas/DataMetricThresholdView", - "SERVERLESS_NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricThresholdView", - "SERVERLESS_NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_OPCOUNTER_CMD" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_OPCOUNTER_QUERY" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_TOTAL_READ_UNITS" : "#/components/schemas/RPUMetricThresholdView", - "SERVERLESS_TOTAL_WRITE_UNITS" : "#/components/schemas/RPUMetricThresholdView" }, - "propertyName" : "metricName" - }, - "properties" : { - "metricName" : { + "comment" : { "type" : "string", - "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "readOnly" : true }, - "mode" : { + "endpointServiceName" : { "type" : "string", - "description" : "MongoDB Cloud computes the current metric value as an average.", - "enum" : [ "AVERAGE" ] - }, - "operator" : { - "$ref" : "#/components/schemas/Operator" - }, - "threshold" : { - "type" : "number", - "format" : "double", - "description" : "Value of metric that, when exceeded, triggers an alert." + "description" : "Unique string that identifies the Amazon Web Services (AWS) PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}", + "readOnly" : true }, - "units" : { - "type" : "string", - "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", - "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] - } - }, - "required" : [ "metricName" ], - "title" : "Serverless Metric Threshold" - }, - "ServerlessMetricUnits" : { - "type" : "string", - "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", - "enum" : [ "RPU", "THOUSAND_RPU", "MILLION_RPU", "WPU", "THOUSAND_WPU", "MILLION_WPU" ], - "example" : "RPU", - "title" : "Serverless Metric Units" - }, - "ServerlessProviderSettings" : { - "type" : "object", - "description" : "Group of cloud provider settings that configure the provisioned MongoDB serverless instance.", - "properties" : { - "backingProviderName" : { + "errorMessage" : { "type" : "string", - "description" : "Cloud service provider on which MongoDB Cloud provisioned the serverless instance.", - "enum" : [ "AWS", "AZURE", "GCP" ] + "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", + "readOnly" : true }, "providerName" : { "type" : "string", - "default" : "SERVERLESS", "description" : "Human-readable label that identifies the cloud service provider.", - "enum" : [ "SERVERLESS" ] + "enum" : [ "AWS" ], + "readOnly" : true }, - "regionName" : { + "status" : { "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/)." + "description" : "Human-readable label that indicates the current operating status of the private endpoint.", + "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true } }, - "required" : [ "backingProviderName", "regionName" ], - "title" : "Cloud Service Provider Settings for a Serverless Instance" + "title" : "AWS" }, - "ServerlessTenantCreateRequest" : { + "ServerlessAWSTenantEndpointUpdate" : { "type" : "object", - "properties" : { - "comment" : { - "type" : "string", - "description" : "Human-readable comment associated with the private endpoint.", - "maxLength" : 80, - "writeOnly" : true + "allOf" : [ { + "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" + }, { + "type" : "object", + "properties" : { + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface.", + "pattern" : "^vpce-[0-9a-f]{17}$", + "writeOnly" : true + } } - } + } ], + "description" : "Updates to a serverless AWS tenant endpoint.", + "required" : [ "providerName" ], + "title" : "AWS" }, - "ServerlessTenantEndpoint" : { + "ServerlessAzureTenantEndpoint" : { "type" : "object", - "oneOf" : [ { - "$ref" : "#/components/schemas/ServerlessAWSTenantEndpoint" - }, { - "$ref" : "#/components/schemas/ServerlessAzureTenantEndpoint" - } ], + "description" : "View for a serverless Azure tenant endpoint.", "properties" : { "_id" : { "type" : "string", @@ -46204,7 +47374,8 @@ }, "cloudProviderEndpointId" : { "type" : "string", - "description" : "Unique string that identifies the private endpoint's network interface.", + "description" : "Unique string that identifies the Azure private endpoint's network interface that someone added to this private endpoint service.", + "pattern" : "^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\\.Network/privateEndpoints/[-\\w._()]+$", "readOnly" : true }, "comment" : { @@ -46215,8 +47386,8 @@ }, "endpointServiceName" : { "type" : "string", - "description" : "Unique string that identifies the PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", - "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}|pls_[0-9a-f]{24}$", + "description" : "Unique string that identifies the Azure private endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^pls_[0-9a-f]{24}$", "readOnly" : true }, "errorMessage" : { @@ -46224,112 +47395,113 @@ "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", "readOnly" : true }, - "status" : { + "privateEndpointIpAddress" : { "type" : "string", - "description" : "Human-readable label that indicates the current operating status of the private endpoint.", - "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", "readOnly" : true - } - } - }, - "ServerlessTenantEndpointUpdate" : { - "type" : "object", - "description" : "Update view for a serverless tenant endpoint.", - "discriminator" : { - "mapping" : { - "AWS" : "#/components/schemas/ServerlessAWSTenantEndpointUpdate", - "AZURE" : "#/components/schemas/ServerlessAzureTenantEndpointUpdate" }, - "propertyName" : "providerName" - }, - "properties" : { - "comment" : { + "privateLinkServiceResourceId" : { "type" : "string", - "description" : "Human-readable comment associated with the private endpoint.", - "maxLength" : 80, - "writeOnly" : true + "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 provider of the tenant endpoint.", - "enum" : [ "AWS", "AZURE" ], - "writeOnly" : true + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "AZURE" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating status of the private endpoint.", + "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true } }, - "required" : [ "providerName" ] - }, - "ServiceAccountEventTypeViewForNdsGroup" : { - "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" ], - "title" : "Service Account Event Types" - }, - "ServiceAccountEventTypeViewForOrg" : { - "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" ], - "title" : "Service Account Event Types" + "title" : "Azure" }, - "ServiceAccountGroup" : { + "ServerlessAzureTenantEndpointUpdate" : { "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "allOf" : [ { + "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" + }, { + "type" : "object", + "properties" : { + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure private endpoint's network interface for this private endpoint service.", + "pattern" : "^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\\.Network/privateEndpoints/[-\\w._()]+$", + "writeOnly" : true + }, + "privateEndpointIpAddress" : { + "type" : "string", + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "writeOnly" : true + } } - } + } ], + "description" : "Updates to a serverless Azure tenant endpoint.", + "required" : [ "providerName" ], + "title" : "AZURE" }, - "ServiceAccountGroupEvents" : { + "ServerlessBackupRestoreJob" : { "type" : "object", - "description" : "Service Account event identifies different activities around user api keys.", "properties" : { - "apiKeyId" : { + "cancelled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone canceled this restore job.", + "readOnly" : true + }, + "deliveryType" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "description" : "Human-readable label that categorizes the restore job to create.", + "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\"`.", + "items" : { + "type" : "string", + "description" : "One Uniform Resource Locator that points to the compressed snapshot files for manual download." + }, "readOnly" : true }, - "created" : { + "desiredTimestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "expired" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job expired.", + "readOnly" : true + }, + "expiresAt" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Date and time when the restore job expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "eventTypeName" : { - "$ref" : "#/components/schemas/ServiceAccountEventTypeViewForNdsGroup" + "failed" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job failed.", + "readOnly" : true }, - "groupId" : { + "finishedAt" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "format" : "date-time", + "description" : "Date and time when the restore job completed. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "description" : "Unique 24-hexadecimal character string that identifies the restore job.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "isGlobalAdmin" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", - "readOnly" : true - }, "links" : { "type" : "array", "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", @@ -46342,98 +47514,87 @@ }, "readOnly" : true }, - "orgId" : { + "oplogInc" : { + "type" : "integer", + "format" : "int32", + "description" : "Oplog operation number from which you want to restore this snapshot. This number represents the second part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", + "example" : 1, + "minimum" : 1 + }, + "oplogTs" : { + "type" : "integer", + "format" : "int32", + "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`.", + "minimum" : 1199145600 + }, + "pointInTimeUTCSeconds" : { + "type" : "integer", + "format" : "int32", + "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`.", + "minimum" : 1199145600 + }, + "snapshotId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "publicKey" : { - "type" : "string", - "format" : "email", - "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "example" : "test.user@mongodb.com", - "readOnly" : true - }, - "raw" : { - "$ref" : "#/components/schemas/raw" + "pattern" : "^([a-f0-9]{24})$" }, - "remoteAddress" : { + "targetClusterName" : { "type" : "string", - "description" : "IPv4 or IPv6 address from which the user triggered this event.", - "example" : "216.172.40.186", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", - "readOnly" : true + "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\"`.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, - "userId" : { + "targetGroupId" : { "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.", + "description" : "Unique 24-hexadecimal digit string that identifies the target project for the specified **targetClusterName**.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "pattern" : "^([a-f0-9]{24})$" }, - "username" : { + "timestamp" : { "type" : "string", - "format" : "email", - "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", - "example" : "test.user@mongodb.com", + "format" : "date-time", + "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.", "readOnly" : true } }, - "required" : [ "created", "eventTypeName", "id" ], - "title" : "ServiceAccount Events" + "required" : [ "deliveryType", "targetClusterName", "targetGroupId" ] }, - "ServiceAccountOrgEvents" : { + "ServerlessBackupSnapshot" : { "type" : "object", - "description" : "Service Account event identifies different activities around user api keys.", "properties" : { - "apiKeyId" : { + "createdAt" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "created" : { + "expiresAt" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "eventTypeName" : { - "$ref" : "#/components/schemas/ServiceAccountEventTypeViewForOrg" - }, - "groupId" : { + "frequencyType" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "description" : "Human-readable label that identifies how often this snapshot triggers.", + "enum" : [ "hourly", "daily", "weekly", "monthly" ], "readOnly" : true }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "isGlobalAdmin" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", - "readOnly" : true - }, "links" : { "type" : "array", "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", @@ -46446,332 +47607,278 @@ }, "readOnly" : true }, - "orgId" : { + "mongodVersion" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "description" : "Version of the MongoDB host that this snapshot backs up.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", "readOnly" : true }, - "publicKey" : { + "serverlessInstanceName" : { "type" : "string", - "format" : "email", - "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "example" : "test.user@mongodb.com", + "description" : "Human-readable label given to the serverless instance from which MongoDB Cloud took this snapshot.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, - "raw" : { - "$ref" : "#/components/schemas/raw" - }, - "remoteAddress" : { + "snapshotType" : { "type" : "string", - "description" : "IPv4 or IPv6 address from which the user triggered this event.", - "example" : "216.172.40.186", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "description" : "Human-readable label that identifies when this snapshot triggers.", + "enum" : [ "onDemand", "scheduled" ], "readOnly" : true }, - "userId" : { + "status" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", + "enum" : [ "queued", "inProgress", "completed", "failed" ], "readOnly" : true }, - "username" : { - "type" : "string", - "format" : "email", - "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", - "example" : "test.user@mongodb.com", + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of bytes taken to store the backup snapshot.", "readOnly" : true } - }, - "required" : [ "created", "eventTypeName", "id" ], - "title" : "ServiceAccount Events" + } }, - "ServiceAccountSecret" : { + "ServerlessConnectionStringsPrivateEndpointItem" : { "type" : "object", + "description" : "Details of a private endpoint deployed for this serverless instance.", "properties" : { - "createdAt" : { + "endpointId" : { "type" : "string", - "format" : "date-time", - "description" : "Timestamp representing creation time.", + "description" : "Unique string that the cloud provider uses to identify the private endpoint.", "readOnly" : true }, - "expiresAt" : { + "providerName" : { "type" : "string", - "format" : "date-time", - "description" : "Timestamp representing secret expiration time.", + "description" : "Cloud provider where the private endpoint is deployed.", + "enum" : [ "AWS", "AZURE" ], "readOnly" : true }, - "id" : { + "region" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the secret.", - "example" : "32b6e34b3d91647abb20e7b8", - "pattern" : "^([a-f0-9]{24})$", + "description" : "Region where the private endpoint is deployed.", "readOnly" : true - }, - "lastUsedAt" : { - "type" : "string", - "format" : "date-time", - "description" : "Timestamp representing last secret usage.", + } + }, + "title" : "Serverless Instance Private Endpoint Connection Strings Endpoint" + }, + "ServerlessConnectionStringsPrivateEndpointList" : { + "type" : "object", + "description" : "Private endpoint connection string that you can use to connect to this serverless instance through a private endpoint.", + "externalDocs" : { + "description" : "Private Endpoint for Serverless Instance", + "url" : "https://docs.atlas.mongodb.com/security-serverless-private-endpoint/" + }, + "properties" : { + "endpoints" : { + "type" : "array", + "description" : "List that contains the private endpoints through which you connect to MongoDB Cloud when you use **connectionStrings.privateEndpoint[n].srvConnectionString**.", + "items" : { + "$ref" : "#/components/schemas/ServerlessConnectionStringsPrivateEndpointItem" + }, "readOnly" : true }, - "maskedSecretValue" : { + "srvConnectionString" : { "type" : "string", - "description" : "Service Account secret with masked values of the first 20 characters.", - "example" : "mdb_ic_sk_...12ce", + "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 }, - "secret" : { + "type" : { "type" : "string", - "description" : "Secret for the service account. It will be returned only the first time after service account creation.", - "pattern" : "^mdb_sa_sk_[0-9a-zA-Z]{40}$", + "description" : "MongoDB process type to which your application connects.", + "enum" : [ "MONGOS" ], "readOnly" : true } }, - "required" : [ "createdAt", "expiresAt", "id" ] + "title" : "Serverless Instance Private Endpoint Connection String" }, - "ServiceAccountSecretRequest" : { - "type" : "object", - "properties" : { - "secretExpiresAfterHours" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of hours representing validity duration for secret." - } - }, - "required" : [ "secretExpiresAfterHours" ] + "ServerlessEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], + "example" : "OUTSIDE_SERVERLESS_METRIC_THRESHOLD", + "title" : "Serverless Event Types" }, - "ShardEntry" : { + "ServerlessInstanceDescription" : { "type" : "object", - "description" : "Sharding configuration for a collection to be sharded on the destination cluster.", + "description" : "Group of settings that configure a MongoDB serverless instance.", "properties" : { - "collection" : { + "connectionStrings" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescriptionConnectionStrings" + }, + "createDate" : { "type" : "string", - "description" : "Human-readable label that identifies the collection to be sharded on the destination cluster.", - "writeOnly" : true + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true }, - "database" : { + "groupId" : { "type" : "string", - "description" : "Human-readable label that identifies the database that contains the collection to be sharded on the destination cluster.", - "writeOnly" : true + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "shardCollection" : { - "$ref" : "#/components/schemas/ShardKeys" - } - }, - "required" : [ "collection", "database", "shardCollection" ] - }, - "ShardKeys" : { - "type" : "object", - "description" : "Document that configures the shard key on the destination cluster.", - "properties" : { - "key" : { - "type" : "array", - "description" : "List of fields to use for the shard key.", - "items" : { - "type" : "object", - "additionalProperties" : { - "type" : "object" - } - }, - "uniqueItems" : true, - "writeOnly" : true - } - }, - "writeOnly" : true - }, - "ShardingRequest" : { - "type" : "object", - "description" : "Document that configures sharding on the destination cluster when migrating from a replica set source to a sharded cluster destination on MongoDB 6.0 or higher. If you don't wish to shard any collections on the destination cluster, leave this empty.", - "properties" : { - "createSupportingIndexes" : { - "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 + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the serverless instance.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "shardingEntries" : { + "links" : { "type" : "array", - "description" : "List of shard configurations to shard destination collections. Atlas shards only those collections that you include in the sharding entries array.", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, "items" : { - "$ref" : "#/components/schemas/ShardEntry" + "$ref" : "#/components/schemas/Link" }, - "uniqueItems" : true, - "writeOnly" : true - } - }, - "required" : [ "createSupportingIndexes" ], - "writeOnly" : true - }, - "Slack" : { - "type" : "object", - "description" : "Details to integrate one Slack account with one MongoDB Cloud project.", - "properties" : { - "apiToken" : { + "readOnly" : true + }, + "mongoDBVersion" : { "type" : "string", - "description" : "Key that allows MongoDB Cloud to access your Slack account.\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.\n\n**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" + "description" : "Version of MongoDB that the serverless instance runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true }, - "channelName" : { + "name" : { "type" : "string", - "description" : "Name of the Slack channel to which MongoDB Cloud sends alert notifications.", - "example" : "alerts", - "maxLength" : 80, + "description" : "Human-readable label that identifies the serverless instance.", + "maxLength" : 64, "minLength" : 1, - "nullable" : true + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, - "id" : { - "type" : "string", - "description" : "Integration id.", - "nullable" : true + "providerSettings" : { + "$ref" : "#/components/schemas/ServerlessProviderSettings" }, - "teamName" : { - "type" : "string", - "description" : "Human-readable label that identifies your Slack team. Set this parameter when you configure a legacy Slack integration.", - "example" : "MongoDB" + "serverlessBackupOptions" : { + "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" }, - "type" : { + "stateName" : { "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" : "Human-readable label that indicates the current operating condition of the serverless instance.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." } }, - "required" : [ "apiToken", "channelName" ], - "title" : "SLACK" + "required" : [ "providerSettings" ], + "title" : "Serverless Instance Description" }, - "SlackNotification" : { + "ServerlessInstanceDescriptionConnectionStrings" : { "type" : "object", - "description" : "Slack notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, "properties" : { - "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", - "format" : "int32", - "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." - }, - "integrationId" : { - "type" : "string", - "description" : "The id of the associated integration, the credentials of which to use for requests.", - "example" : "32b6e34b3d91647abb20e7b8" - }, - "intervalMin" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", - "minimum" : 5 - }, - "notifierId" : { - "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" + "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.", + "items" : { + "$ref" : "#/components/schemas/ServerlessConnectionStringsPrivateEndpointList" + }, + "readOnly" : true }, - "typeName" : { + "standardSrv" : { "type" : "string", - "description" : "Human-readable label that displays the alert notification type.", - "enum" : [ "SLACK" ] + "description" : "Public connection string that you can use to connect to this serverless instance. This connection string uses the `mongodb+srv://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true } }, - "required" : [ "typeName" ], - "title" : "Slack Notification" + "readOnly" : true, + "title" : "Serverless Instance Connection Strings" }, - "Source" : { + "ServerlessInstanceDescriptionCreate" : { "type" : "object", - "description" : "Document that describes the source of the migration.", + "description" : "Settings that you can specify when you create a serverless instance.", "properties" : { - "caCertificatePath" : { + "name" : { "type" : "string", - "description" : "Path to the CA certificate that signed SSL certificates use to authenticate to the source cluster." + "description" : "Human-readable label that identifies the serverless instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "writeOnly" : true }, - "clusterName" : { - "type" : "string", - "description" : "Label that identifies the source cluster name." + "providerSettings" : { + "$ref" : "#/components/schemas/ServerlessProviderSettings" }, - "groupId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the source project.", - "example" : "9b43a5b329223c3a1591a678", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" + "serverlessBackupOptions" : { + "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" }, - "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." + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the serverless instance.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true }, - "password" : { - "type" : "string", - "description" : "Password that authenticates the username to the source cluster.", - "writeOnly" : true + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } }, - "ssl" : { + "terminationProtectionEnabled" : { "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 - } - }, - "required" : [ "clusterName", "groupId", "managedAuthentication", "ssl" ] - }, - "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/" + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." } }, - "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/" - } + "required" : [ "name", "providerSettings" ], + "title" : "Serverless Instance Description Create" }, - "StreamConfig" : { + "ServerlessInstanceDescriptionUpdate" : { "type" : "object", - "description" : "Configuration options for an Atlas Stream Processing Instance.", - "nullable" : true, + "description" : "Settings that you can update when you request a serverless cluster update.", "properties" : { - "links" : { + "serverlessBackupOptions" : { + "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" + }, + "tags" : { "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true + "$ref" : "#/components/schemas/ResourceTag" + } }, - "tier" : { - "type" : "string", - "description" : "Selected tier for the Stream Instance. Configures Memory / VCPU allowances.", - "enum" : [ "SP30", "SP10" ], - "title" : "Stream Instance Tier" + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." } - } + }, + "title" : "Serverless Instance Description Update" }, - "StreamProcessorAlertConfigViewForNdsGroup" : { + "ServerlessMetricAlertConfigViewForNdsGroup" : { "type" : "object", - "description" : "Host metric alert configuration allows to select which Atlas streams processors trigger alerts and how users are notified.", + "description" : "Serverless metric alert configuration allows to select which serverless database metrics trigger alerts and how users are notified.", "properties" : { "created" : { "type" : "string", @@ -46785,7 +47892,7 @@ "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." }, "eventTypeName" : { - "$ref" : "#/components/schemas/StreamProcessorEventTypeViewAlertable" + "$ref" : "#/components/schemas/ServerlessEventTypeViewAlertable" }, "groupId" : { "type" : "string", @@ -46819,11 +47926,14 @@ }, "matchers" : { "type" : "array", - "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration.", + "description" : "Matching conditions for target resources.", "items" : { - "$ref" : "#/components/schemas/StreamsMatcher" + "$ref" : "#/components/schemas/AlertMatcher" } }, + "metricThreshold" : { + "$ref" : "#/components/schemas/ServerlessMetricThreshold" + }, "notifications" : { "type" : "array", "description" : "List that contains the targets that MongoDB Cloud sends notifications.", @@ -46839,157 +47949,215 @@ } }, "required" : [ "eventTypeName", "notifications" ], - "title" : "Stream Processor Alert Configuration" + "title" : "Serverless Alert Configuration" }, - "StreamProcessorAlertViewForNdsGroup" : { + "ServerlessMetricThreshold" : { "type" : "object", - "description" : "Stream Processor alert notifies about activities on Stream Processor in AtlasStreams.", + "description" : "Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.", + "discriminator" : { + "mapping" : { + "SERVERLESS_AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_CONNECTIONS" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_BYTES_IN" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_CMD" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_QUERY" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_TOTAL_READ_UNITS" : "#/components/schemas/RPUMetricThresholdView", + "SERVERLESS_TOTAL_WRITE_UNITS" : "#/components/schemas/RPUMetricThresholdView" + }, + "propertyName" : "metricName" + }, "properties" : { - "acknowledgedUntil" : { + "metricName" : { "type" : "string", - "format" : "date-time", - "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.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." }, - "acknowledgementComment" : { + "mode" : { "type" : "string", - "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", - "example" : "Expiration on 3/19. Silencing for 7days.", - "maxLength" : 200 + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] }, - "acknowledgingUsername" : { + "operator" : { "type" : "string", - "format" : "email", - "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", - "readOnly" : true + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, - "alertConfigId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." }, - "created" : { + "units" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true - }, - "eventTypeName" : { - "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroupAlertable" - }, - "groupId" : { + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] + } + }, + "required" : [ "metricName" ], + "title" : "Serverless Metric Threshold" + }, + "ServerlessMetricUnits" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "RPU", "THOUSAND_RPU", "MILLION_RPU", "WPU", "THOUSAND_WPU", "MILLION_WPU" ], + "example" : "RPU", + "title" : "Serverless Metric Units" + }, + "ServerlessProviderSettings" : { + "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB serverless instance.", + "properties" : { + "backingProviderName" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "description" : "Cloud service provider on which MongoDB Cloud provisioned the serverless instance.", + "enum" : [ "AWS", "AZURE", "GCP" ] }, - "id" : { + "providerName" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies this alert.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "default" : "SERVERLESS", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "SERVERLESS" ] }, - "instanceName" : { + "regionName" : { "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.", - "example" : "foobar", - "readOnly" : true - }, - "lastNotified" : { + "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/)." + } + }, + "required" : [ "backingProviderName", "regionName" ], + "title" : "Cloud Service Provider Settings for a Serverless Instance" + }, + "ServerlessTenantCreateRequest" : { + "type" : "object", + "properties" : { + "comment" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", - "readOnly" : true - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - }, - "orgId" : { + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "writeOnly" : true + } + } + }, + "ServerlessTenantEndpoint" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/ServerlessAWSTenantEndpoint" + }, { + "$ref" : "#/components/schemas/ServerlessAzureTenantEndpoint" + } ], + "properties" : { + "_id" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "processorErrorMsg" : { + "cloudProviderEndpointId" : { "type" : "string", - "description" : "The error message associated with the Stream Processor to which this alert applies.", - "example" : "MongoServerError: Failed to start stream processor: (Location77175) Could not connect to the Kafka topic with kafka error code: -195, message: Local: Broker transport failure.: (Location77175)", + "description" : "Unique string that identifies the private endpoint's network interface.", "readOnly" : true }, - "processorName" : { + "comment" : { "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.", - "example" : "foobar", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, "readOnly" : true }, - "processorState" : { + "endpointServiceName" : { "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.", - "example" : "STARTED", + "description" : "Unique string that identifies the PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}|pls_[0-9a-f]{24}$", "readOnly" : true }, - "resolved" : { + "errorMessage" : { "type" : "string", - "format" : "date-time", - "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\"`.", + "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", "readOnly" : true }, "status" : { "type" : "string", - "description" : "State of this alert at the time you requested its details.", - "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], - "example" : "OPEN", + "description" : "Human-readable label that indicates the current operating status of the private endpoint.", + "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], "readOnly" : true + } + } + }, + "ServerlessTenantEndpointUpdate" : { + "type" : "object", + "description" : "Update view for a serverless tenant endpoint.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/ServerlessAWSTenantEndpointUpdate", + "AZURE" : "#/components/schemas/ServerlessAzureTenantEndpointUpdate" }, - "updated" : { + "propertyName" : "providerName" + }, + "properties" : { + "comment" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "writeOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider of the tenant endpoint.", + "enum" : [ "AWS", "AZURE" ], + "writeOnly" : true } }, - "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], - "title" : "Stream Processor Alerts" + "required" : [ "providerName" ] }, - "StreamProcessorEventTypeViewAlertable" : { + "ServiceAccountEventTypeViewForNdsGroup" : { "type" : "string", - "description" : "Event type that triggers an alert.", - "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], - "example" : "STREAM_PROCESSOR_STATE_IS_FAILED", - "title" : "Stream Processor Event Types" + "description" : "Unique identifier of event type.", + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" }, - "StreamProcessorEventTypeViewForNdsGroup" : { + "ServiceAccountEventTypeViewForOrg" : { "type" : "string", "description" : "Unique identifier of event type.", - "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], - "example" : "STREAM_PROCESSOR_STATE_IS_FAILED", - "title" : "Stream Processor Event Types" + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" }, - "StreamProcessorEventViewForNdsGroup" : { + "ServiceAccountGroup" : { "type" : "object", - "description" : "Stream Processor event identifies different activities about a stream processor in Atlas Streams.", "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies your project. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "ServiceAccountGroupEvents" : { + "type" : "object", + "description" : "Service Account event identifies different activities around user api keys.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, "created" : { "type" : "string", "format" : "date-time", @@ -46997,7 +48165,7 @@ "readOnly" : true }, "eventTypeName" : { - "$ref" : "#/components/schemas/StreamProcessorEventTypeViewForNdsGroup" + "$ref" : "#/components/schemas/ServiceAccountEventTypeViewForNdsGroup" }, "groupId" : { "type" : "string", @@ -47017,10 +48185,10 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "instanceName" : { - "type" : "string", - "description" : "Name of the stream processing instance associated with the event.", - "example" : "foobar", + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", "readOnly" : true }, "links" : { @@ -47044,159 +48212,96 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "processorErrorMsg" : { - "type" : "string", - "description" : "Error message linked to the stream processor associated with the event.", - "example" : "invalid auth", - "readOnly" : true - }, - "processorName" : { - "type" : "string", - "description" : "Name of the stream processor associated with the event.", - "example" : "foobar", - "readOnly" : true - }, - "processorState" : { + "publicKey" : { "type" : "string", - "description" : "State of the stream processor associated with the event.", - "example" : "FAILED", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true }, "raw" : { "$ref" : "#/components/schemas/raw" - } - }, - "required" : [ "created", "eventTypeName", "id" ], - "title" : "Stream Processor Events" - }, - "StreamsClusterConnection" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/StreamsConnection" - }, { - "type" : "object", - "properties" : { - "clusterName" : { - "type" : "string", - "description" : "Name of the cluster configured for this connection." - }, - "dbRoleToExecute" : { - "$ref" : "#/components/schemas/DBRoleToExecute" - } - } - } ] - }, - "StreamsConnection" : { - "type" : "object", - "description" : "Settings that define a connection to an external data store.", - "discriminator" : { - "mapping" : { - "Cluster" : "#/components/schemas/StreamsClusterConnection", - "Kafka" : "#/components/schemas/StreamsKafkaConnection", - "Sample" : "#/components/schemas/StreamsSampleConnection" }, - "propertyName" : "type" - }, - "oneOf" : [ { - "$ref" : "#/components/schemas/StreamsSampleConnection" - }, { - "$ref" : "#/components/schemas/StreamsClusterConnection" - }, { - "$ref" : "#/components/schemas/StreamsKafkaConnection" - } ], - "properties" : { - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", "readOnly" : true }, - "name" : { + "userId" : { "type" : "string", - "description" : "Human-readable label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source." + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "type" : { + "username" : { "type" : "string", - "description" : "Type of the connection. Can be either Cluster or Kafka.", - "enum" : [ "Kafka", "Cluster", "Sample" ] + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true } }, - "readOnly" : true + "required" : [ "created", "eventTypeName", "id" ], + "title" : "ServiceAccount Events" }, - "StreamsDLQ" : { + "ServiceAccountIPAccessListEntry" : { "type" : "object", - "description" : "Dead letter queue for the stream processor.", "properties" : { - "coll" : { + "cidrBlock" : { "type" : "string", - "description" : "Name of the collection that will be used for the DLQ." + "description" : "Range of network addresses in the access list for the Service Account. This parameter requires the range to be expressed in Classless Inter-Domain Routing (CIDR) notation of Internet Protocol version 4 or version 6 addresses. You can set a value for this parameter or **ipAddress**, but not for both in the same request.", + "example" : "203.0.113.0/24", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" }, - "connectionName" : { + "createdAt" : { "type" : "string", - "description" : "Connection name that will be used to write DLQ messages to. Has to be an Atlas connection." + "format" : "date-time", + "description" : "Date MongoDB Cloud added the entry was added to the Access List.", + "readOnly" : true }, - "db" : { + "ipAddress" : { "type" : "string", - "description" : "Name of the database that will be used for the DLQ." + "description" : "Network address in the access list for the Service Account. This parameter requires the address to be expressed as one Internet Protocol version 4 or version 6 address. You can set a value for this parameter or **cidrBlock**, but not for both in the same request.", + "example" : "203.0.113.10", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - } - } - }, - "StreamsDataProcessRegion" : { - "type" : "object", - "description" : "Information about the cloud provider region in which MongoDB Cloud processes the stream.", - "properties" : { - "cloudProvider" : { + "lastUsedAddress" : { "type" : "string", - "description" : "Label that identifies the cloud service provider where MongoDB Cloud performs stream processing. Currently, this parameter supports AWS only.", - "enum" : [ "AWS", "GCP", "AZURE", "TENANT", "SERVERLESS" ] + "description" : "Network address that issued the most recent request to the API. This parameter requires the address to be expressed as one Internet Protocol version 4 or version 6 address. The resource returns this parameter after this IP address makes at least one request.", + "readOnly" : true }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, + "lastUsedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date when MongoDB Cloud received the most recent request that originated from this Internet Protocol version 4 or version 6 address. The resource returns this parameter when at least one request originates from this IP address. MongoDB Cloud updates this parameter each time a client accesses the permitted resource, with a delay of up to 5 minutes.", "readOnly" : true }, - "region" : { - "$ref" : "#/components/schemas/BaseStreamsRegion" + "requestCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of requests that has originated from this network address.", + "readOnly" : true } - }, - "required" : [ "cloudProvider", "region" ] - }, - "StreamsEventTypeViewForNdsGroup" : { - "type" : "string", - "description" : "Unique identifier of event type.", - "enum" : [ "MAX_PROCESSOR_COUNT_REACHED" ], - "example" : "MAX_PROCESSOR_COUNT_REACHED", - "title" : "Streams Event Types" + } }, - "StreamsEventViewForNdsGroup" : { + "ServiceAccountOrgEvents" : { "type" : "object", - "description" : "Streams event identifies different activities about Atlas Streams.", + "description" : "Service Account event identifies different activities around user api keys.", "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, "created" : { "type" : "string", "format" : "date-time", @@ -47204,7 +48309,7 @@ "readOnly" : true }, "eventTypeName" : { - "$ref" : "#/components/schemas/StreamsEventTypeViewForNdsGroup" + "$ref" : "#/components/schemas/ServiceAccountEventTypeViewForOrg" }, "groupId" : { "type" : "string", @@ -47224,10 +48329,10 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "instanceName" : { - "type" : "string", - "description" : "Name of the stream processing instance associated with the event.", - "example" : "foobar", + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", "readOnly" : true }, "links" : { @@ -47251,387 +48356,217 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, "raw" : { "$ref" : "#/components/schemas/raw" - } - }, - "required" : [ "created", "eventTypeName", "id" ], - "title" : "Streams Events" - }, - "StreamsKafkaAuthentication" : { - "type" : "object", - "description" : "User credentials required to connect to a Kafka Cluster. Includes the authentication type, as well as the parameters for that authentication mode.", - "properties" : { - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true }, - "mechanism" : { + "remoteAddress" : { "type" : "string", - "description" : "Style of authentication. Can be one of PLAIN, SCRAM-256, or SCRAM-512." + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true }, - "password" : { + "userId" : { "type" : "string", - "format" : "password", - "description" : "Password of the account to connect to the Kafka cluster.", - "writeOnly" : true + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, "username" : { "type" : "string", - "description" : "Username of the account to connect to the Kafka cluster." - } - } - }, - "StreamsKafkaConnection" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/StreamsConnection" - }, { - "type" : "object", - "properties" : { - "authentication" : { - "$ref" : "#/components/schemas/StreamsKafkaAuthentication" - }, - "bootstrapServers" : { - "type" : "string", - "description" : "Comma separated list of server addresses." - }, - "config" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "description" : "A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.", - "example" : "{\"group.protocol.type\":\"consumer\",\"debug\":\"queue, msg, protocol\"}" - }, - "description" : "A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.", - "example" : { - "debug" : "queue, msg, protocol", - "group.protocol.type" : "consumer" - } - }, - "networking" : { - "$ref" : "#/components/schemas/StreamsKafkaNetworking" - }, - "proxyInfo" : { - "$ref" : "#/components/schemas/ProxyInfo" - }, - "security" : { - "$ref" : "#/components/schemas/StreamsKafkaSecurity" - } - } - } ] - }, - "StreamsKafkaNetworking" : { - "type" : "object", - "description" : "Networking Access Type can either be 'PUBLIC' (default) or VPC. VPC type is in public preview, please file a support ticket to enable VPC Network Access", - "properties" : { - "access" : { - "$ref" : "#/components/schemas/StreamsKafkaNetworkingAccess" - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true } - } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "ServiceAccount Events" }, - "StreamsKafkaNetworkingAccess" : { + "ServiceAccountSecret" : { "type" : "object", - "description" : "Information about the networking access.", "properties" : { - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "The date that the secret was created on.", "readOnly" : true }, - "name" : { + "expiresAt" : { "type" : "string", - "description" : "Id of the vpc peer when the type is VPC." + "format" : "date-time", + "description" : "The date for the expiration of the secret.", + "readOnly" : true }, - "type" : { + "id" : { "type" : "string", - "description" : "Selected networking type. Either PUBLIC or VPC. Defaults to PUBLIC", - "enum" : [ "PUBLIC", "VPC" ], - "title" : "Networking Access Type" - } - } - }, - "StreamsKafkaSecurity" : { - "type" : "object", - "description" : "Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use.", - "properties" : { - "brokerPublicCertificate" : { + "description" : "Unique 24-hexadecimal digit string that identifies the secret.", + "example" : "32b6e34b3d91647abb20e7b8", + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastUsedAt" : { "type" : "string", - "description" : "A trusted, public x509 certificate for connecting to Kafka over SSL." + "format" : "date-time", + "description" : "The last time the secret was used.", + "readOnly" : true }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, + "maskedSecretValue" : { + "type" : "string", + "description" : "The masked Service Account secret.", + "example" : "mdb_ic_sk_...12ce", "readOnly" : true }, - "protocol" : { + "secret" : { "type" : "string", - "description" : "Describes the transport type. Can be either PLAINTEXT or SSL." + "description" : "The secret for the Service Account. It will be returned only the first time after creation.", + "pattern" : "^mdb_sa_sk_[0-9a-zA-Z_-]{40}$", + "readOnly" : true } - } + }, + "required" : [ "createdAt", "expiresAt", "id" ] }, - "StreamsMatcher" : { + "ServiceAccountSecretRequest" : { "type" : "object", - "description" : "Rules to apply when comparing a stream processing instance or stream processor against this alert configuration.", "properties" : { - "fieldName" : { - "$ref" : "#/components/schemas/StreamsMatcherField" - }, - "operator" : { + "secretExpiresAfterHours" : { + "type" : "integer", + "format" : "int32", + "description" : "The expiration time of the new Service Account secret. The expiration is provided in hours." + } + }, + "required" : [ "secretExpiresAfterHours" ] + }, + "ShardEntry" : { + "type" : "object", + "description" : "Sharding configuration for a collection to be sharded on the destination cluster.", + "properties" : { + "collection" : { "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" ] + "description" : "Human-readable label that identifies the collection to be sharded on the destination cluster.", + "writeOnly" : true }, - "value" : { + "database" : { "type" : "string", - "description" : "Value to match or exceed using the specified **matchers.operator**.", - "example" : "event-replica-set" + "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" } }, - "required" : [ "fieldName", "operator", "value" ], - "title" : "Matchers" - }, - "StreamsMatcherField" : { - "type" : "string", - "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", - "enum" : [ "INSTANCE_NAME", "PROCESSOR_NAME" ], - "example" : "INSTANCE_NAME", - "title" : "Streams Matcher Fields" + "required" : [ "collection", "database", "shardCollection" ] }, - "StreamsOptions" : { + "ShardKeys" : { "type" : "object", - "description" : "Optional configuration for the stream processor.", + "description" : "Document that configures the shard key on the destination cluster.", "properties" : { - "dlq" : { - "$ref" : "#/components/schemas/StreamsDLQ" - }, - "links" : { + "key" : { "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, + "description" : "List of fields to use for the shard key.", "items" : { - "$ref" : "#/components/schemas/Link" + "type" : "object", + "additionalProperties" : { + "type" : "object" + } }, - "readOnly" : true + "uniqueItems" : true, + "writeOnly" : true } - } + }, + "writeOnly" : true }, - "StreamsProcessor" : { + "ShardingRequest" : { "type" : "object", - "description" : "An atlas stream processor.", + "description" : "Document that configures sharding on the destination cluster when migrating from a replica set source to a sharded cluster destination on MongoDB 6.0 or higher. If you don't wish to shard any collections on the destination cluster, leave this empty.", "properties" : { - "_id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the stream processor.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "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 }, - "links" : { + "shardingEntries" : { "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, + "description" : "List of shard configurations to shard destination collections. Atlas shards only those collections that you include in the sharding entries array.", "items" : { - "$ref" : "#/components/schemas/Link" + "$ref" : "#/components/schemas/ShardEntry" }, - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "Human-readable name of the stream processor." - }, - "options" : { - "$ref" : "#/components/schemas/StreamsOptions" - }, - "pipeline" : { - "type" : "array", - "description" : "Stream aggregation pipeline you want to apply to your streaming data.", - "items" : { - "$ref" : "#/components/schemas/Document" - } + "uniqueItems" : true, + "writeOnly" : true } - } + }, + "required" : [ "createSupportingIndexes" ], + "writeOnly" : true }, - "StreamsProcessorWithStats" : { + "Slack" : { "type" : "object", - "description" : "An atlas stream processor with optional stats.", + "description" : "Details to integrate one Slack account with one MongoDB Cloud project.", "properties" : { - "_id" : { + "apiToken" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the stream processor.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true + "description" : "Key that allows MongoDB Cloud to access your Slack account.\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.\n\n**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" }, - "name" : { + "channelName" : { "type" : "string", - "description" : "Human-readable name of the stream processor.", - "readOnly" : true + "description" : "Name of the Slack channel to which MongoDB Cloud sends alert notifications.", + "example" : "alerts", + "maxLength" : 80, + "minLength" : 1, + "nullable" : true }, - "pipeline" : { - "type" : "array", - "description" : "Stream aggregation pipeline you want to apply to your streaming data.", - "items" : { - "$ref" : "#/components/schemas/Document" - }, - "readOnly" : true + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true }, - "state" : { + "teamName" : { "type" : "string", - "description" : "The state of the stream processor.", - "readOnly" : true + "description" : "Human-readable label that identifies your Slack team. Set this parameter when you configure a legacy Slack integration.", + "example" : "MongoDB" }, - "stats" : { - "type" : "object", - "additionalProperties" : { - "type" : "object", - "description" : "The stats associated with the stream processor.", - "readOnly" : true - }, - "description" : "The stats associated with the stream processor.", - "readOnly" : 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" : [ "SLACK" ] } }, - "required" : [ "_id", "name", "pipeline", "state" ] - }, - "StreamsSampleConnection" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/StreamsConnection" - } ] + "required" : [ "apiToken", "channelName" ], + "title" : "SLACK" }, - "StreamsTenant" : { + "SlackNotification" : { "type" : "object", + "description" : "Slack notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", "properties" : { - "_id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the project.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "connections" : { - "type" : "array", - "description" : "List of connections configured in the stream instance.", - "items" : { - "$ref" : "#/components/schemas/StreamsConnection" - }, - "readOnly" : true - }, - "dataProcessRegion" : { - "$ref" : "#/components/schemas/StreamsDataProcessRegion" - }, - "groupId" : { + "apiToken" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the project.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "hostnames" : { - "type" : "array", - "description" : "List that contains the hostnames assigned to the stream instance.", - "items" : { - "type" : "string", - "description" : "Unique hostname assigned to the stream instance.", - "readOnly" : true - }, - "readOnly" : true - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true + "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" }, - "name" : { + "channelName" : { "type" : "string", - "description" : "Human-readable label that identifies the stream instance." + "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" }, - "streamConfig" : { - "$ref" : "#/components/schemas/StreamConfig" - } - } - }, - "SummaryNotification" : { - "type" : "object", - "description" : "Summary notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", - "properties" : { "delayMin" : { "type" : "integer", "format" : "int32", "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." }, - "emailAddress" : { + "integrationId" : { "type" : "string", - "format" : "email", - "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:\n\n- specific MongoDB Cloud users (`\"notifications.[n].typeName\" : \"USER\"`)\n- MongoDB Cloud users with specific project roles (`\"notifications.[n].typeName\" : \"GROUP\"`)\n- MongoDB Cloud users with specific organization roles (`\"notifications.[n].typeName\" : \"ORG\"`)\n- MongoDB Cloud teams (`\"notifications.[n].typeName\" : \"TEAM\"`)\n\nTo send emails to one MongoDB Cloud user or grouping of users, set the **notifications.[n].emailEnabled** parameter." + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" }, "intervalMin" : { "type" : "integer", @@ -47647,68 +48582,74 @@ "typeName" : { "type" : "string", "description" : "Human-readable label that displays the alert notification type.", - "enum" : [ "SUMMARY" ] + "enum" : [ "SLACK" ] } }, "required" : [ "typeName" ], - "title" : "Summary Notification" + "title" : "Slack Notification" }, - "SynonymMappingStatusDetail" : { + "Source" : { "type" : "object", - "description" : "Contains the status of the index's synonym mappings on each search host. This field (and its subfields) only appear if the index has synonyms defined.", + "description" : "Document that describes the source of the migration.", "properties" : { - "message" : { + "caCertificatePath" : { "type" : "string", - "description" : "Optional message describing an error." + "description" : "Path to the CA certificate that signed SSL certificates use to authenticate to the source cluster." }, - "queryable" : { + "clusterName" : { + "type" : "string", + "description" : "Label that identifies the source cluster name." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the source project.", + "example" : "9b43a5b329223c3a1591a678", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "managedAuthentication" : { "type" : "boolean", - "description" : "Flag that indicates whether the synonym mapping is queryable on a host." + "description" : "Flag that indicates whether MongoDB Automation manages authentication to the source cluster. If true, do not provide values for username and password." }, - "status" : { + "password" : { "type" : "string", - "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", - "enum" : [ "FAILED", "BUILDING", "READY" ] + "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 } }, - "title" : "Synonym Mapping Status Detail" + "required" : [ "clusterName", "groupId", "managedAuthentication", "ssl" ] }, - "SynonymMappingStatusDetailMap" : { + "StorageEngine" : { "type" : "object", "additionalProperties" : { - "$ref" : "#/components/schemas/SynonymMappingStatusDetail" - }, - "x-additionalPropertiesName" : "Synonym Mapping Name" - }, - "SynonymSource" : { - "type" : "object", - "description" : "Data set that stores words and their applicable synonyms.", - "properties" : { - "collection" : { - "type" : "string", - "description" : "Label that identifies the MongoDB collection that stores words and their applicable synonyms." + "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/" } }, - "required" : [ "collection" ] + "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/" + } }, - "SystemStatus" : { + "StreamConfig" : { "type" : "object", + "description" : "Configuration options for an Atlas Stream Processing Instance.", + "nullable" : true, "properties" : { - "apiKey" : { - "$ref" : "#/components/schemas/ApiKey" - }, - "appName" : { - "type" : "string", - "description" : "Human-readable label that identifies the service from which you requested this response.", - "enum" : [ "MongoDB Atlas" ], - "readOnly" : true - }, - "build" : { - "type" : "string", - "description" : "Unique 40-hexadecimal digit hash that identifies the latest git commit merged for this application.", - "example" : "83be55e140f493c88e7f578aae96548dd881587b", - "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.", @@ -47721,43 +48662,44 @@ }, "readOnly" : true }, - "throttling" : { - "type" : "boolean", - "description" : "Flag that indicates whether someone enabled throttling on this service.", - "readOnly" : true - } - }, - "required" : [ "apiKey", "appName", "build", "throttling" ] - }, - "TargetOrg" : { - "type" : "object", - "properties" : { - "linkToken" : { + "tier" : { "type" : "string", - "description" : "Link token that contains all the information required to complete the link." - } - }, - "required" : [ "linkToken" ] - }, - "TargetOrgRequest" : { - "type" : "object", - "properties" : { - "accessListIps" : { - "type" : "array", - "description" : "IP address access list entries associated with the API key.", - "items" : { - "type" : "string", - "description" : "One IP address access list entry associated with the API key." - } + "description" : "Selected tier for the Stream Instance. Configures Memory / VCPU allowances.", + "enum" : [ "SP30", "SP10" ], + "title" : "Stream Instance Tier" } } }, - "Team" : { + "StreamProcessorAlertConfigViewForNdsGroup" : { "type" : "object", + "description" : "Host metric alert configuration allows to select which Atlas streams processors trigger alerts and how users are notified.", "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/StreamProcessorEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies this team.", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -47776,30 +48718,54 @@ }, "readOnly" : true }, - "name" : { - "type" : "string", - "description" : "Human-readable label that identifies the team." + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration.", + "items" : { + "$ref" : "#/components/schemas/StreamsMatcher" + } }, - "usernames" : { + "notifications" : { "type" : "array", - "description" : "List that contains the MongoDB Cloud users in this team.", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", "items" : { - "type" : "string", - "format" : "email", - "description" : "List that contains email addresses that identify MongoDB Cloud users to in this team." - }, - "uniqueItems" : true + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true } }, - "required" : [ "name" ] + "required" : [ "eventTypeName", "notifications" ], + "title" : "Stream Processor Alert Configuration" }, - "TeamEvent" : { + "StreamProcessorAlertViewForNdsGroup" : { "type" : "object", - "description" : "Team event identifies different activities around organization teams.", + "description" : "Stream Processor alert notifies about activities on Stream Processor in AtlasStreams.", "properties" : { - "apiKeyId" : { + "acknowledgedUntil" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "format" : "date-time", + "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.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -47809,15 +48775,15 @@ "created" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, "eventTypeName" : { - "$ref" : "#/components/schemas/TeamEventTypeView" + "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroupAlertable" }, "groupId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -47826,17 +48792,23 @@ }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "isGlobalAdmin" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "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.", + "example" : "foobar", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", "readOnly" : true }, "links" : { @@ -47853,86 +48825,72 @@ }, "orgId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "publicKey" : { + "processorErrorMsg" : { "type" : "string", - "format" : "email", - "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "example" : "test.user@mongodb.com", + "description" : "The error message associated with the Stream Processor to which this alert applies.", + "example" : "MongoServerError: Failed to start stream processor: (Location77175) Could not connect to the Kafka topic with kafka error code: -195, message: Local: Broker transport failure.: (Location77175)", "readOnly" : true }, - "raw" : { - "$ref" : "#/components/schemas/raw" + "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.", + "example" : "foobar", + "readOnly" : true }, - "remoteAddress" : { + "processorState" : { "type" : "string", - "description" : "IPv4 or IPv6 address from which the user triggered this event.", - "example" : "216.172.40.186", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "description" : "The state of the Stream Processor to which this alert applies. The resource returns this parameter for alerts of events impacting Stream Processors.", + "example" : "STARTED", "readOnly" : true }, - "teamId" : { + "resolved" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization team associated with this event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "format" : "date-time", + "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\"`.", "readOnly" : true }, - "userId" : { + "status" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", "readOnly" : true }, - "username" : { + "updated" : { "type" : "string", - "format" : "email", - "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", - "example" : "test.user@mongodb.com", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true } }, - "required" : [ "created", "eventTypeName", "id" ], - "title" : "Team Events" + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Stream Processor Alerts" }, - "TeamEventTypeView" : { + "StreamProcessorEventTypeViewAlertable" : { "type" : "string", - "description" : "Unique identifier of event type.", - "enum" : [ "TEAM_CREATED", "TEAM_DELETED", "TEAM_UPDATED", "TEAM_NAME_CHANGED", "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], - "example" : "TEAM_ADDED_TO_GROUP", - "title" : "Team Event Types" + "description" : "Event type that triggers an alert.", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "example" : "STREAM_PROCESSOR_STATE_IS_FAILED", + "title" : "Stream Processor Event Types" }, - "TeamEventTypeViewForNdsGroup" : { + "StreamProcessorEventTypeViewForNdsGroup" : { "type" : "string", "description" : "Unique identifier of event type.", - "enum" : [ "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], - "example" : "TEAM_ADDED_TO_GROUP", - "title" : "Team Event Types" + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "example" : "STREAM_PROCESSOR_STATE_IS_FAILED", + "title" : "Stream Processor Event Types" }, - "TeamEventViewForNdsGroup" : { + "StreamProcessorEventViewForNdsGroup" : { "type" : "object", - "description" : "Team event identifies different activities around organization teams.", + "description" : "Stream Processor event identifies different activities about a stream processor in Atlas Streams.", "properties" : { - "apiKeyId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, "created" : { "type" : "string", "format" : "date-time", @@ -47940,7 +48898,7 @@ "readOnly" : true }, "eventTypeName" : { - "$ref" : "#/components/schemas/TeamEventTypeViewForNdsGroup" + "$ref" : "#/components/schemas/StreamProcessorEventTypeViewForNdsGroup" }, "groupId" : { "type" : "string", @@ -47960,10 +48918,10 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "isGlobalAdmin" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "instanceName" : { + "type" : "string", + "description" : "Name of the stream processing instance associated with the event.", + "example" : "foobar", "readOnly" : true }, "links" : { @@ -47987,113 +48945,297 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "publicKey" : { + "processorErrorMsg" : { "type" : "string", - "format" : "email", - "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "example" : "test.user@mongodb.com", + "description" : "Error message linked to the stream processor associated with the event.", + "example" : "invalid auth", + "readOnly" : true + }, + "processorName" : { + "type" : "string", + "description" : "Name of the stream processor associated with the event.", + "example" : "foobar", + "readOnly" : true + }, + "processorState" : { + "type" : "string", + "description" : "State of the stream processor associated with the event.", + "example" : "FAILED", "readOnly" : true }, "raw" : { "$ref" : "#/components/schemas/raw" + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Stream Processor Events" + }, + "StreamsClusterConnection" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/StreamsConnection" + }, { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Name of the cluster configured for this connection." + }, + "dbRoleToExecute" : { + "$ref" : "#/components/schemas/DBRoleToExecute" + } + } + } ] + }, + "StreamsConnection" : { + "type" : "object", + "description" : "Settings that define a connection to an external data store.", + "discriminator" : { + "mapping" : { + "Cluster" : "#/components/schemas/StreamsClusterConnection", + "Kafka" : "#/components/schemas/StreamsKafkaConnection", + "Sample" : "#/components/schemas/StreamsSampleConnection" }, - "remoteAddress" : { + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/StreamsSampleConnection" + }, { + "$ref" : "#/components/schemas/StreamsClusterConnection" + }, { + "$ref" : "#/components/schemas/StreamsKafkaConnection" + } ], + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { "type" : "string", - "description" : "IPv4 or IPv6 address from which the user triggered this event.", - "example" : "216.172.40.186", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "description" : "Human-readable label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source." + }, + "type" : { + "type" : "string", + "description" : "Type of the connection. Can be either Cluster or Kafka.", + "enum" : [ "Kafka", "Cluster", "Sample" ] + } + }, + "readOnly" : true + }, + "StreamsDLQ" : { + "type" : "object", + "description" : "Dead letter queue for the stream processor.", + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/reference/glossary/#std-term-dead-letter-queue" + }, + "properties" : { + "coll" : { + "type" : "string", + "description" : "Name of the collection to use for the DLQ." + }, + "connectionName" : { + "type" : "string", + "description" : "Name of the connection to write DLQ messages to. Must be an Atlas connection." + }, + "db" : { + "type" : "string", + "description" : "Name of the database to use for the DLQ." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, "readOnly" : true + } + } + }, + "StreamsDataProcessRegion" : { + "type" : "object", + "description" : "Information about the cloud provider region in which MongoDB Cloud processes the stream.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Label that identifies the cloud service provider where MongoDB Cloud performs stream processing. Currently, this parameter supports AWS only.", + "enum" : [ "AWS", "GCP", "AZURE", "TENANT", "SERVERLESS" ] }, - "teamId" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "region" : { + "$ref" : "#/components/schemas/BaseStreamsRegion" + } + }, + "required" : [ "cloudProvider", "region" ] + }, + "StreamsEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "MAX_PROCESSOR_COUNT_REACHED" ], + "example" : "MAX_PROCESSOR_COUNT_REACHED", + "title" : "Streams Event Types" + }, + "StreamsEventViewForNdsGroup" : { + "type" : "object", + "description" : "Streams event identifies different activities about Atlas Streams.", + "properties" : { + "created" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization team associated with this event.", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/StreamsEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "userId" : { + "id" : { "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.", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "username" : { + "instanceName" : { "type" : "string", - "format" : "email", - "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", - "example" : "test.user@mongodb.com", + "description" : "Name of the stream processing instance associated with the event.", + "example" : "foobar", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" } }, "required" : [ "created", "eventTypeName", "id" ], - "title" : "Team Events" + "title" : "Streams Events" }, - "TeamNotification" : { + "StreamsKafkaAuthentication" : { "type" : "object", - "description" : "Team notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "description" : "User credentials required to connect to a Kafka Cluster. Includes the authentication type, as well as the parameters for that authentication mode.", "properties" : { - "delayMin" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." - }, - "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:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" - }, - "intervalMin" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", - "minimum" : 5 - }, - "notifierId" : { - "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:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true }, - "teamId" : { + "mechanism" : { "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", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" + "description" : "Style of authentication. Can be one of PLAIN, SCRAM-256, or SCRAM-512." }, - "teamName" : { + "password" : { "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" + "format" : "password", + "description" : "Password of the account to connect to the Kafka cluster.", + "writeOnly" : true }, - "typeName" : { + "username" : { "type" : "string", - "description" : "Human-readable label that displays the alert notification type.", - "enum" : [ "TEAM" ] + "description" : "Username of the account to connect to the Kafka cluster." } - }, - "required" : [ "typeName" ], - "title" : "Team Notification" + } }, - "TeamResponse" : { + "StreamsKafkaConnection" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/StreamsConnection" + }, { + "type" : "object", + "properties" : { + "authentication" : { + "$ref" : "#/components/schemas/StreamsKafkaAuthentication" + }, + "bootstrapServers" : { + "type" : "string", + "description" : "Comma separated list of server addresses." + }, + "config" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.", + "example" : "{\"group.protocol.type\":\"consumer\",\"debug\":\"queue, msg, protocol\"}" + }, + "description" : "A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.", + "example" : { + "debug" : "queue, msg, protocol", + "group.protocol.type" : "consumer" + } + }, + "networking" : { + "$ref" : "#/components/schemas/StreamsKafkaNetworking" + }, + "security" : { + "$ref" : "#/components/schemas/StreamsKafkaSecurity" + } + } + } ] + }, + "StreamsKafkaNetworking" : { "type" : "object", + "description" : "Networking Access Type can either be 'PUBLIC' (default) or VPC. VPC type is in public preview, please file a support ticket to enable VPC Network Access", "properties" : { - "id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies this team.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "access" : { + "$ref" : "#/components/schemas/StreamsKafkaNetworkingAccess" }, "links" : { "type" : "array", @@ -48106,16 +49248,21 @@ "$ref" : "#/components/schemas/Link" }, "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "Human-readable label that identifies the team." } } }, - "TeamRole" : { + "StreamsKafkaNetworkingAccess" : { "type" : "object", + "description" : "Information about the networking access.", "properties" : { + "connectionId" : { + "type" : "string", + "description" : "Reserved. Will be used by PRIVATE_LINK connection type.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, "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.", @@ -48128,28 +49275,26 @@ }, "readOnly" : true }, - "roleNames" : { - "type" : "array", - "description" : "One or more organization- or project-level roles to assign to the MongoDB Cloud user.", - "items" : { - "type" : "string", - "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] - }, - "uniqueItems" : true + "name" : { + "type" : "string", + "description" : "Reserved. Will be used by PRIVATE_LINK connection type." }, - "teamId" : { + "type" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the team.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" + "description" : "Selected networking type. Either PUBLIC, VPC or PRIVATE_LINK. Defaults to PUBLIC. For VPC, ensure that VPC peering exists and connectivity has been established between Atlas VPC and the VPC where Kafka cluster is hosted for the connection to function properly. PRIVATE_LINK support is coming soon.", + "enum" : [ "PUBLIC", "VPC", "PRIVATE_LINK" ], + "title" : "Networking Access Type" } } }, - "TeamUpdate" : { + "StreamsKafkaSecurity" : { "type" : "object", + "description" : "Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use.", "properties" : { + "brokerPublicCertificate" : { + "type" : "string", + "description" : "A trusted, public x509 certificate for connecting to Kafka over SSL." + }, "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.", @@ -48162,108 +49307,83 @@ }, "readOnly" : true }, - "name" : { - "type" : "string", - "description" : "Human-readable label that identifies the team.", - "writeOnly" : true - } - }, - "required" : [ "name" ] - }, - "TenantHardwareSpec" : { - "type" : "object", - "properties" : { - "instanceSize" : { + "protocol" : { "type" : "string", - "description" : "Hardware specification for the instances in this M0/M2/M5 tier cluster.", - "enum" : [ "M0", "M2", "M5" ], - "title" : "Tenant Instance Sizes" + "description" : "Describes the transport type. Can be either PLAINTEXT or SSL." } } }, - "TenantHardwareSpec20240805" : { + "StreamsMatcher" : { "type" : "object", + "description" : "Rules to apply when comparing a stream processing instance or stream processor against this alert configuration.", "properties" : { - "diskSizeGB" : { - "type" : "number", - "format" : "double", - "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", - "maximum" : 4096, - "minimum" : 10 + "fieldName" : { + "$ref" : "#/components/schemas/StreamsMatcherField" }, - "instanceSize" : { + "operator" : { "type" : "string", - "description" : "Hardware specification for the instances in this M0/M2/M5 tier cluster.", - "enum" : [ "M0", "M2", "M5" ], - "title" : "Tenant Instance Sizes" + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" } - } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" }, - "TenantRegionConfig" : { - "type" : "object", - "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`.", - "enum" : [ "AWS", "GCP", "AZURE" ] - } - } - } ], - "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", - "title" : "Tenant Regional Replication Specifications" + "StreamsMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "INSTANCE_NAME", "PROCESSOR_NAME" ], + "example" : "INSTANCE_NAME", + "title" : "Streams Matcher Fields" }, - "TenantRegionConfig20240805" : { + "StreamsOptions" : { "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/CloudRegionConfig20240805" - }, { - "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`.", - "enum" : [ "AWS", "GCP", "AZURE" ] - } + "description" : "Optional configuration for the stream processor.", + "properties" : { + "dlq" : { + "$ref" : "#/components/schemas/StreamsDLQ" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true } - } ], - "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", - "title" : "Tenant Regional Replication Specifications" + } }, - "TenantRestore" : { + "StreamsPrivateLinkConnection" : { "type" : "object", + "description" : "Container for metadata needed to create a Private Link connection.", "properties" : { - "clusterName" : { + "_id" : { "type" : "string", - "description" : "Human-readable label that identifies the source cluster.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "readOnly" : true + "description" : "The ID of the Private Link connection." }, - "deliveryType" : { + "dnsDomain" : { "type" : "string", - "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", - "enum" : [ "RESTORE", "DOWNLOAD" ], - "readOnly" : true + "description" : "Domain name of Confluent cluster." }, - "expirationDate" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "dnsSubDomain" : { + "type" : "array", + "description" : "Sub-Domain name of Confluent cluster. These are typically your availability zones.", + "items" : { + "type" : "string" + } }, - "id" : { + "interfaceEndpointId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "description" : "Interface endpoint ID that is created from the service endpoint ID provided." }, "links" : { "type" : "array", @@ -48277,354 +49397,451 @@ }, "readOnly" : true }, - "projectId" : { + "provider" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "description" : "Provider where the Kafka cluster is deployed." }, - "restoreFinishedDate" : { + "region" : { "type" : "string", - "format" : "date-time", - "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.", - "readOnly" : true + "description" : "Domain name of Confluent cluster." }, - "restoreScheduledDate" : { + "serviceEndpointId" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "description" : "AWS Service Endpoint ID." }, - "snapshotFinishedDate" : { + "state" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "description" : "State the connection is in." }, - "snapshotId" : { + "vendor" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "description" : "Vendor who manages the Kafka cluster." + } + } + }, + "StreamsProcessor" : { + "type" : "object", + "description" : "An atlas stream processor.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the stream processor.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" - }, - "snapshotUrl" : { - "type" : "string", - "description" : "Internet address from which you can download the compressed snapshot files. The resource returns this parameter when `\"deliveryType\" : \"DOWNLOAD\"`.", + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "status" : { - "type" : "string", - "description" : "Phase of the restore workflow for this job at the time this resource made this request.", - "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, "readOnly" : true }, - "targetDeploymentItemName" : { + "name" : { "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.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + "description" : "Human-readable name of the stream processor." }, - "targetProjectId" : { - "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", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" + "options" : { + "$ref" : "#/components/schemas/StreamsOptions" + }, + "pipeline" : { + "type" : "array", + "description" : "Stream aggregation pipeline you want to apply to your streaming data.", + "externalDocs" : { + "description" : "Supported Aggregation Pipeline Stages", + "url" : "https://www.mongodb.com/docs/atlas/atlas-stream-processing/stream-aggregation/#std-label-stream-aggregation" + }, + "items" : { + "$ref" : "#/components/schemas/Document" + } } - }, - "required" : [ "snapshotId", "targetDeploymentItemName" ] + } }, - "TextSearchHostStatusDetail" : { + "StreamsProcessorWithStats" : { "type" : "object", + "description" : "An atlas stream processor with optional stats.", "properties" : { - "hostname" : { + "_id" : { "type" : "string", - "description" : "Hostname that corresponds to the status detail." + "description" : "Unique 24-hexadecimal character string that identifies the stream processor.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "mainIndex" : { - "$ref" : "#/components/schemas/TextSearchIndexStatusDetail" + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true }, - "queryable" : { - "type" : "boolean", - "description" : "Flag that indicates whether the index is queryable on the host." + "name" : { + "type" : "string", + "description" : "Human-readable name of the stream processor.", + "readOnly" : true }, - "stagedIndex" : { - "$ref" : "#/components/schemas/TextSearchIndexStatusDetail" + "options" : { + "$ref" : "#/components/schemas/StreamsOptions" }, - "status" : { + "pipeline" : { + "type" : "array", + "description" : "Stream aggregation pipeline you want to apply to your streaming data.", + "items" : { + "$ref" : "#/components/schemas/Document" + }, + "readOnly" : true + }, + "state" : { "type" : "string", - "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", - "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + "description" : "The state of the stream processor. Commonly occurring states are 'CREATED', 'STARTED', 'STOPPED' and 'FAILED'.", + "readOnly" : true + }, + "stats" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "The stats associated with the stream processor.", + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor" + }, + "readOnly" : true + }, + "description" : "The stats associated with the stream processor.", + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor" + }, + "readOnly" : true } }, - "title" : "Text Search Host Status Detail" + "required" : [ "_id", "name", "pipeline", "state" ] }, - "TextSearchIndexCreateRequest" : { + "StreamsSampleConnection" : { "type" : "object", "allOf" : [ { - "$ref" : "#/components/schemas/SearchIndexCreateRequest" - }, { - "type" : "object", - "properties" : { - "definition" : { - "$ref" : "#/components/schemas/TextSearchIndexDefinition" - } + "$ref" : "#/components/schemas/StreamsConnection" + } ] + }, + "StreamsSampleConnections" : { + "type" : "object", + "description" : "Sample connections to add to SPI.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "solar" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to add a 'sample_stream_solar' connection." } - } ], - "description" : "Text Search Index Create Request", - "required" : [ "collectionName", "database", "definition", "name" ] + } }, - "TextSearchIndexDefinition" : { + "StreamsTenant" : { "type" : "object", - "description" : "The text search index definition set by the user.", "properties" : { - "analyzer" : { + "_id" : { "type" : "string", - "default" : "lucene.standard", - "description" : "Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves making the following changes to the text in fields:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\n MongoDB Cloud uses the process you select to build the Atlas Search index.", - "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ], - "externalDocs" : { - "description" : "Atlas Search Analyzers", - "url" : "https://dochub.mongodb.org/core/analyzers--fts" - } + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "analyzers" : { + "connections" : { "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" - }, + "description" : "List of connections configured in the stream instance.", "items" : { - "$ref" : "#/components/schemas/AtlasSearchAnalyzer" - } + "$ref" : "#/components/schemas/StreamsConnection" + }, + "readOnly" : true }, - "mappings" : { - "$ref" : "#/components/schemas/SearchMappings" + "dataProcessRegion" : { + "$ref" : "#/components/schemas/StreamsDataProcessRegion" }, - "searchAnalyzer" : { + "groupId" : { "type" : "string", - "default" : "lucene.standard", - "description" : "Method applied to identify words when searching this index.", - "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "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 Stored Source Fields.", - "example" : { - "include | exclude" : [ "field1", "field2" ] + "hostnames" : { + "type" : "array", + "description" : "List that contains the hostnames assigned to the stream instance.", + "items" : { + "type" : "string", + "description" : "Unique hostname assigned to the stream instance.", + "readOnly" : true }, - "externalDocs" : { - "description" : "Stored Source Fields", - "url" : "https://dochub.mongodb.org/core/atlas-search-stored-source" - } + "readOnly" : true }, - "synonyms" : { + "links" : { "type" : "array", - "description" : "Rule sets that map words to their synonyms in this index.", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", "externalDocs" : { - "description" : "Synonym Mapping", - "url" : "https://dochub.mongodb.org/core/fts-synonym-mappings" + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" }, "items" : { - "$ref" : "#/components/schemas/SearchSynonymMappingDefinition" - } - } - }, - "required" : [ "mappings" ], - "title" : "Text Search Index Definition" - }, - "TextSearchIndexResponse" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/SearchIndexResponse" - }, { - "type" : "object", - "properties" : { - "latestDefinition" : { - "$ref" : "#/components/schemas/TextSearchIndexDefinition" - }, - "statusDetail" : { - "type" : "array", - "description" : "List of documents detailing index status on each host.", - "items" : { - "$ref" : "#/components/schemas/TextSearchHostStatusDetail" - } - }, - "synonymMappingStatus" : { - "type" : "string", - "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", - "enum" : [ "FAILED", "BUILDING", "READY" ] - }, - "synonymMappingStatusDetail" : { - "type" : "array", - "description" : "A list of documents describing the status of the index's synonym mappings on each search host. Only appears if the index has synonyms defined.", - "items" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/SynonymMappingStatusDetail" - } - } - } + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the stream instance." + }, + "sampleConnections" : { + "$ref" : "#/components/schemas/StreamsSampleConnections" + }, + "streamConfig" : { + "$ref" : "#/components/schemas/StreamConfig" } - } ], - "title" : "Text Search Index Response" + } }, - "TextSearchIndexStatusDetail" : { + "SummaryNotification" : { "type" : "object", - "description" : "Contains status information about a text search index.", + "description" : "Summary notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", "properties" : { - "definition" : { - "$ref" : "#/components/schemas/TextSearchIndexDefinition" + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." }, - "definitionVersion" : { - "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + "emailAddress" : { + "type" : "string", + "format" : "email", + "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:\n\n- specific MongoDB Cloud users (`\"notifications.[n].typeName\" : \"USER\"`)\n- MongoDB Cloud users with specific project roles (`\"notifications.[n].typeName\" : \"GROUP\"`)\n- MongoDB Cloud users with specific organization roles (`\"notifications.[n].typeName\" : \"ORG\"`)\n- MongoDB Cloud teams (`\"notifications.[n].typeName\" : \"TEAM\"`)\n\nTo send emails to one MongoDB Cloud user or grouping of users, set the **notifications.[n].emailEnabled** parameter." + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "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" ] + } + }, + "required" : [ "typeName" ], + "title" : "Summary Notification" + }, + "SynonymMappingStatusDetail" : { + "type" : "object", + "description" : "Contains the status of the index's synonym mappings on each search host. This field (and its subfields) only appear if the index has synonyms defined.", + "properties" : { "message" : { "type" : "string", "description" : "Optional message describing an error." }, "queryable" : { "type" : "boolean", - "description" : "Flag that indicates whether the index generation is queryable on the host." + "description" : "Flag that indicates whether the synonym mapping is queryable on a host." }, "status" : { - "type" : "string", - "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", - "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] - }, - "synonymMappingStatus" : { "type" : "string", "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", "enum" : [ "FAILED", "BUILDING", "READY" ] - }, - "synonymMappingStatusDetail" : { - "type" : "array", - "description" : "List of synonym statuses by mapping.", - "items" : { - "$ref" : "#/components/schemas/SynonymMappingStatusDetailMap" - } } }, - "title" : "Text Search Index Status Detail" + "title" : "Synonym Mapping Status Detail" }, - "ThirdPartyIntegration" : { + "SynonymMappingStatusDetailMap" : { "type" : "object", - "description" : "Collection of settings that describe third-party integrations.", - "discriminator" : { - "mapping" : { - "DATADOG" : "#/components/schemas/Datadog", - "MICROSOFT_TEAMS" : "#/components/schemas/MicrosoftTeams", - "NEW_RELIC" : "#/components/schemas/NewRelic", - "OPS_GENIE" : "#/components/schemas/OpsGenie", - "PAGER_DUTY" : "#/components/schemas/PagerDuty", - "PROMETHEUS" : "#/components/schemas/Prometheus", - "SLACK" : "#/components/schemas/Slack", - "VICTOR_OPS" : "#/components/schemas/VictorOps", - "WEBHOOK" : "#/components/schemas/Webhook" - }, - "propertyName" : "type" + "additionalProperties" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetail" }, + "x-additionalPropertiesName" : "Synonym Mapping Name" + }, + "SynonymSource" : { + "type" : "object", + "description" : "Data set that stores words and their applicable synonyms.", "properties" : { - "id" : { - "type" : "string", - "description" : "Integration id.", - "nullable" : true - }, - "type" : { + "collection" : { "type" : "string", - "description" : "Integration type", - "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], - "title" : "Integration Type" + "description" : "Label that identifies the MongoDB collection that stores words and their applicable synonyms." } }, - "title" : "Third-Party Integration" + "required" : [ "collection" ] }, - "TimeMetricAlertView" : { + "SystemStatus" : { "type" : "object", "properties" : { - "acknowledgedUntil" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + "apiKey" : { + "$ref" : "#/components/schemas/ApiKey" }, - "acknowledgementComment" : { + "appName" : { "type" : "string", - "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", - "example" : "Expiration on 3/19. Silencing for 7days.", - "maxLength" : 200 + "description" : "Human-readable label that identifies the service from which you requested this response.", + "enum" : [ "MongoDB Atlas" ], + "readOnly" : true }, - "acknowledgingUsername" : { + "build" : { "type" : "string", - "format" : "email", - "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "description" : "Unique 40-hexadecimal digit hash that identifies the latest git commit merged for this application.", + "example" : "83be55e140f493c88e7f578aae96548dd881587b", "readOnly" : true }, - "alertConfigId" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "throttling" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled throttling on this service.", + "readOnly" : true + } + }, + "required" : [ "apiKey", "appName", "build", "throttling" ] + }, + "TargetOrg" : { + "type" : "object", + "properties" : { + "linkToken" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "description" : "Link token that contains all the information required to complete the link." + } + }, + "required" : [ "linkToken" ] + }, + "TargetOrgRequest" : { + "type" : "object", + "properties" : { + "accessListIps" : { + "type" : "array", + "description" : "IP address access list entries associated with the API key.", + "items" : { + "type" : "string", + "description" : "One IP address access list entry associated with the API key." + } + } + } + }, + "Team" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this team.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "clusterName" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { "type" : "string", - "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", - "example" : "cluster1", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "description" : "Human-readable label that identifies the team." + }, + "usernames" : { + "type" : "array", + "description" : "List that contains the MongoDB Cloud users in this team.", + "items" : { + "type" : "string", + "format" : "email", + "description" : "List that contains email addresses that identify MongoDB Cloud users to in this team." + }, + "uniqueItems" : true + } + }, + "required" : [ "name" ] + }, + "TeamEvent" : { + "type" : "object", + "description" : "Team event identifies different activities around organization teams.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, "created" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "currentValue" : { - "$ref" : "#/components/schemas/TimeMetricValueView" - }, "eventTypeName" : { - "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + "$ref" : "#/components/schemas/TeamEventTypeView" }, "groupId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "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.", - "example" : "cloud-test.mongodb.com:27017", - "readOnly" : true - }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "lastNotified" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", "readOnly" : true }, "links" : { @@ -48639,51 +49856,78 @@ }, "readOnly" : true }, - "metricName" : { - "type" : "string", - "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", - "example" : "ASSERT_USER", - "readOnly" : true - }, "orgId" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "replicaSetName" : { + "publicKey" : { "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.", - "example" : "event-replica-set", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true }, - "resolved" : { + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { "type" : "string", - "format" : "date-time", - "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\"`.", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", "readOnly" : true }, - "status" : { + "teamId" : { "type" : "string", - "description" : "State of this alert at the time you requested its details.", - "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], - "example" : "OPEN", + "description" : "Unique 24-hexadecimal digit string that identifies the organization team associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "updated" : { + "userId" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true } }, - "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Team Events" }, - "TimeMetricEventView" : { + "TeamEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TEAM_CREATED", "TEAM_DELETED", "TEAM_UPDATED", "TEAM_NAME_CHANGED", "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "example" : "TEAM_ADDED_TO_GROUP", + "title" : "Team Event Types" + }, + "TeamEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "example" : "TEAM_ADDED_TO_GROUP", + "title" : "Team Event Types" + }, + "TeamEventViewForNdsGroup" : { "type" : "object", + "description" : "Team event identifies different activities around organization teams.", "properties" : { "apiKeyId" : { "type" : "string", @@ -48700,11 +49944,8 @@ "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "currentValue" : { - "$ref" : "#/components/schemas/TimeMetricValueView" - }, "eventTypeName" : { - "$ref" : "#/components/schemas/HostMetricEventTypeView" + "$ref" : "#/components/schemas/TeamEventTypeViewForNdsGroup" }, "groupId" : { "type" : "string", @@ -48742,11 +49983,6 @@ }, "readOnly" : true }, - "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" : { "type" : "string", "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", @@ -48756,13 +49992,6 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "port" : { - "type" : "integer", - "format" : "int32", - "description" : "IANA port on which the MongoDB process listens for requests.", - "example" : 27017, - "readOnly" : true - }, "publicKey" : { "type" : "string", "format" : "email", @@ -48780,16 +50009,13 @@ "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", "readOnly" : true }, - "replicaSetName" : { - "type" : "string", - "description" : "Human-readable label of the replica set associated with the event.", - "example" : "event-replica-set", - "readOnly" : true - }, - "shardName" : { + "teamId" : { "type" : "string", - "description" : "Human-readable label of the shard associated with the event.", - "example" : "event-sh-01", + "description" : "Unique 24-hexadecimal digit string that identifies the organization team associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, "userId" : { @@ -48809,250 +50035,220 @@ "readOnly" : true } }, - "required" : [ "created", "eventTypeName", "id" ] + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Team Events" }, - "TimeMetricThresholdView" : { + "TeamNotification" : { "type" : "object", + "description" : "Team notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", "properties" : { - "metricName" : { - "type" : "string", - "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." }, - "mode" : { + "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:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { "type" : "string", - "description" : "MongoDB Cloud computes the current metric value as an average.", - "enum" : [ "AVERAGE" ] + "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" }, - "operator" : { - "$ref" : "#/components/schemas/Operator" + "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:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" }, - "threshold" : { - "type" : "number", - "format" : "double", - "description" : "Value of metric that, when exceeded, triggers an alert." + "teamId" : { + "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", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" }, - "units" : { - "$ref" : "#/components/schemas/TimeMetricUnits" - } - }, - "required" : [ "metricName" ] - }, - "TimeMetricUnits" : { - "type" : "string", - "default" : "HOURS", - "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", - "enum" : [ "NANOSECONDS", "MILLISECONDS", "MILLION_MINUTES", "SECONDS", "MINUTES", "HOURS", "DAYS" ], - "title" : "Time Metric Units" - }, - "TimeMetricValueView" : { - "type" : "object", - "description" : "Measurement of the **metricName** recorded at the time of the event.", - "properties" : { - "number" : { - "type" : "number", - "format" : "double", - "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", - "readOnly" : true + "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" }, - "units" : { - "$ref" : "#/components/schemas/TimeMetricUnits" - } - }, - "readOnly" : true, - "title" : "Time Metric Value" - }, - "TokenFilterEnglishPossessive" : { - "type" : "object", - "description" : "Filter that removes possessives (trailing 's) from words.", - "properties" : { - "type" : { + "typeName" : { "type" : "string", - "description" : "Human-readable label that identifies this token filter type.", - "enum" : [ "englishPossessive" ] + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "TEAM" ] } }, - "required" : [ "type" ], - "title" : "englishPossessive" + "required" : [ "typeName" ], + "title" : "Team Notification" }, - "TokenFilterFlattenGraph" : { + "TeamResponse" : { "type" : "object", - "description" : "Filter that transforms a token filter graph, such as the token filter graph that the wordDelimiterGraph token filter produces, into a flat form suitable for indexing.", "properties" : { - "type" : { + "id" : { "type" : "string", - "description" : "Human-readable label that identifies this token filter type.", - "enum" : [ "flattenGraph" ] + "description" : "Unique 24-hexadecimal digit string that identifies this team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the team." } - }, - "required" : [ "type" ], - "title" : "flattenGraph" + } }, - "TokenFilterPorterStemming" : { + "TeamRole" : { "type" : "object", - "description" : "Filter that uses the porter stemming algorithm to remove the common morphological and inflectional suffixes from words in English. It expects lowercase text and doesn't work as expected for uppercase text.", "properties" : { - "type" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "roleNames" : { + "type" : "array", + "description" : "One or more organization- or project-level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "teamId" : { "type" : "string", - "description" : "Human-readable label that identifies this token filter type.", - "enum" : [ "porterStemming" ] + "description" : "Unique 24-hexadecimal character string that identifies the team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" } - }, - "required" : [ "type" ], - "title" : "porterStemming" + } }, - "TokenFilterSpanishPluralStemming" : { + "TeamUpdate" : { "type" : "object", - "description" : "Filter that stems Spanish plural words. It expects lowercase text.", "properties" : { - "type" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { "type" : "string", - "description" : "Human-readable label that identifies this token filter type.", - "enum" : [ "spanishPluralStemming" ] + "description" : "Human-readable label that identifies the team.", + "writeOnly" : true } }, - "required" : [ "type" ], - "title" : "spanishPluralStemming" + "required" : [ "name" ] }, - "TokenFilterStempel" : { + "TenantHardwareSpec" : { "type" : "object", - "description" : "Filter that uses Lucene's default Polish stemmer table to stem words in the Polish language. It expects lowercase text.", - "externalDocs" : { - "description" : "Default Polish stemmer table", - "url" : "https://lucene.apache.org/core/9_2_0/analysis/stempel/org/apache/lucene/analysis/pl/PolishAnalyzer.html#DEFAULT_STEMMER_FILE" - }, "properties" : { - "type" : { + "instanceSize" : { "type" : "string", - "description" : "Human-readable label that identifies this token filter type.", - "enum" : [ "stempel" ] + "description" : "Hardware specification for the instances in this M0/M2/M5 tier cluster.", + "enum" : [ "M0", "M2", "M5" ], + "title" : "Tenant Instance Sizes" } - }, - "required" : [ "type" ], - "title" : "stempel" + } }, - "TokenFilterWordDelimiterGraph" : { + "TenantHardwareSpec20240805" : { "type" : "object", - "description" : "Filter that splits tokens into sub-tokens based on configured rules.", "properties" : { - "delimiterOptions" : { - "type" : "object", - "description" : "Object that contains the rules that determine how to split words into sub-words.", - "properties" : { - "concatenateAll" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether to concatenate runs." - }, - "concatenateNumbers" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether to concatenate runs of sub-numbers." - }, - "concatenateWords" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether to concatenate runs of sub-words." - }, - "generateNumberParts" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether to split tokens based on sub-numbers. For example, if `true`, this option splits `100-2` into `100` and `2`." - }, - "generateWordParts" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether to split tokens based on sub-words." - }, - "ignoreKeywords" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether to skip tokens with the `keyword` attribute set to `true`" - }, - "preserveOriginal" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether to generate tokens of the original words." - }, - "splitOnCaseChange" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether to split tokens based on letter-case transitions." - }, - "splitOnNumerics" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether to split tokens based on letter-number transitions." - }, - "stemEnglishPossessive" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether to remove trailing possessives from each sub-word." - } - } - }, - "protectedWords" : { - "type" : "object", - "description" : "Object that contains options for protected words.", - "properties" : { - "ignoreCase" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether to ignore letter case sensitivity for protected words." - }, - "words" : { - "type" : "array", - "description" : "List that contains the tokens to protect from delimination.", - "items" : { - "type" : "string" - } - } - }, - "required" : [ "words" ] + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 }, - "type" : { + "instanceSize" : { "type" : "string", - "description" : "Human-readable label that identifies this token filter type.", - "enum" : [ "wordDelimiterGraph" ] + "description" : "Hardware specification for the instances in this M0/M2/M5 tier cluster.", + "enum" : [ "M0", "M2", "M5" ], + "title" : "Tenant Instance Sizes" } - }, - "required" : [ "type" ], - "title" : "wordDelimiterGraph" + } }, - "TokenFilterkStemming" : { + "TenantRegionConfig" : { "type" : "object", - "description" : "Filter that combines algorithmic stemming with a built-in dictionary for the English language to stem words.", - "properties" : { - "type" : { - "type" : "string", - "description" : "Human-readable label that identifies this token filter type.", - "enum" : [ "kStemming" ] + "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`.", + "enum" : [ "AWS", "GCP", "AZURE" ] + } } - }, - "required" : [ "type" ], - "title" : "kStemming" + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Tenant Regional Replication Specifications" }, - "TriggerIngestionPipelineRequest" : { + "TenantRegionConfig20240805" : { "type" : "object", - "properties" : { - "datasetRetentionPolicy" : { - "$ref" : "#/components/schemas/DatasetRetentionPolicy" - }, - "snapshotId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "writeOnly" : true + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20240805" + }, { + "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`.", + "enum" : [ "AWS", "GCP", "AZURE" ] + } } - }, - "required" : [ "snapshotId" ] + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Tenant Regional Replication Specifications" }, - "USSBackupRestoreJob20250101" : { + "TenantRestore" : { "type" : "object", - "description" : "Details for one restore job of a USS instance.", "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the source cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "readOnly" : true + }, "deliveryType" : { "type" : "string", "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", @@ -49074,14 +50270,6 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "instanceName" : { - "type" : "string", - "description" : "Human-readable label that identifies the source instance.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "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.", @@ -49127,8 +50315,7 @@ "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "pattern" : "^([a-f0-9]{24})$" }, "snapshotUrl" : { "type" : "string", @@ -49143,176 +50330,311 @@ }, "targetDeploymentItemName" : { "type" : "string", - "description" : "Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another USS instance or Dedicated cluster tier.", + "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.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", - "readOnly" : true + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" }, "targetProjectId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the cluster to which you want to restore the snapshot.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "pattern" : "^([a-f0-9]{24})$" } }, - "title" : "USS Backup Restore Job" + "required" : [ "snapshotId", "targetDeploymentItemName" ] + }, + "TenantWithSampleConnections" : { + "type" : "object" }, - "USSBackupRestoreJobCreate20250101" : { + "TextSearchHostStatusDetail" : { "type" : "object", - "description" : "Details to create one restore job of a USS instance.", "properties" : { - "_snapshotId" : { + "hostname" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "writeOnly" : true + "description" : "Hostname that corresponds to the status detail." }, - "_targetDeploymentItemName" : { - "type" : "string", - "description" : "Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another USS instance or Dedicated cluster tier.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", - "writeOnly" : true + "mainIndex" : { + "$ref" : "#/components/schemas/TextSearchIndexStatusDetail" }, - "_targetProjectId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "writeOnly" : true + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on the host." }, - "deliveryType" : { - "type" : "string", - "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", - "enum" : [ "RESTORE", "DOWNLOAD" ], - "readOnly" : true + "stagedIndex" : { + "$ref" : "#/components/schemas/TextSearchIndexStatusDetail" }, - "expirationDate" : { + "status" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true - }, - "id" : { + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Text Search Host Status Detail" + }, + "TextSearchIndexCreateRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexCreateRequest" + }, { + "type" : "object", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + } + } + } ], + "description" : "Text Search Index Create Request", + "required" : [ "collectionName", "database", "definition", "name" ] + }, + "TextSearchIndexDefinition" : { + "type" : "object", + "description" : "The text search index definition set by the user.", + "properties" : { + "analyzer" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "default" : "lucene.standard", + "description" : "Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves making the following changes to the text in fields:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\n MongoDB Cloud uses the process you select to build the Atlas Search index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ], + "externalDocs" : { + "description" : "Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/analyzers--fts" + } }, - "instanceName" : { + "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" + }, + "items" : { + "$ref" : "#/components/schemas/AtlasSearchAnalyzer" + } + }, + "mappings" : { + "$ref" : "#/components/schemas/SearchMappings" + }, + "searchAnalyzer" : { "type" : "string", - "description" : "Human-readable label that identifies the source instance.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "readOnly" : true + "default" : "lucene.standard", + "description" : "Method applied to identify words when searching this index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] }, - "links" : { + "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 Stored Source Fields.", + "example" : { + "include | exclude" : [ "field1", "field2" ] + }, + "externalDocs" : { + "description" : "Stored Source Fields", + "url" : "https://dochub.mongodb.org/core/atlas-search-stored-source" + } + }, + "synonyms" : { "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.", + "description" : "Rule sets that map words to their synonyms in this index.", "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + "description" : "Synonym Mapping", + "url" : "https://dochub.mongodb.org/core/fts-synonym-mappings" }, "items" : { - "$ref" : "#/components/schemas/Link" + "$ref" : "#/components/schemas/SearchSynonymMappingDefinition" + } + } + }, + "required" : [ "mappings" ], + "title" : "Text Search Index Definition" + }, + "TextSearchIndexResponse" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexResponse" + }, { + "type" : "object", + "properties" : { + "latestDefinition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" }, - "readOnly" : true + "statusDetail" : { + "type" : "array", + "description" : "List of documents detailing index status on each host.", + "items" : { + "$ref" : "#/components/schemas/TextSearchHostStatusDetail" + } + }, + "synonymMappingStatus" : { + "type" : "string", + "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", + "enum" : [ "FAILED", "BUILDING", "READY" ] + }, + "synonymMappingStatusDetail" : { + "type" : "array", + "description" : "A list of documents describing the status of the index's synonym mappings on each search host. Only appears if the index has synonyms defined.", + "items" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetail" + } + } + } + } + } ], + "title" : "Text Search Index Response" + }, + "TextSearchIndexStatusDetail" : { + "type" : "object", + "description" : "Contains status information about a text search index.", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" }, - "projectId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" }, - "restoreFinishedDate" : { + "message" : { "type" : "string", - "format" : "date-time", - "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.", - "readOnly" : true + "description" : "Optional message describing an error." }, - "restoreScheduledDate" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index generation is queryable on the host." }, - "snapshotFinishedDate" : { + "status" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] }, - "snapshotUrl" : { + "synonymMappingStatus" : { "type" : "string", - "description" : "Internet address from which you can download the compressed snapshot files. The resource returns this parameter when `\"deliveryType\" : \"DOWNLOAD\"`.", - "readOnly" : true + "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", + "enum" : [ "FAILED", "BUILDING", "READY" ] }, - "status" : { - "type" : "string", - "description" : "Phase of the restore workflow for this job at the time this resource made this request.", - "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], - "readOnly" : true + "synonymMappingStatusDetail" : { + "type" : "array", + "description" : "List of synonym statuses by mapping.", + "items" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetailMap" + } } }, - "required" : [ "_snapshotId", "_targetDeploymentItemName" ], - "title" : "Create USS Backup Restore Job" + "title" : "Text Search Index Status Detail" }, - "USSBackupSettings20250101" : { + "ThirdPartyIntegration" : { "type" : "object", - "description" : "USS backup configuration", + "description" : "Collection of settings that describe third-party integrations.", + "discriminator" : { + "mapping" : { + "DATADOG" : "#/components/schemas/Datadog", + "MICROSOFT_TEAMS" : "#/components/schemas/MicrosoftTeams", + "NEW_RELIC" : "#/components/schemas/NewRelic", + "OPS_GENIE" : "#/components/schemas/OpsGenie", + "PAGER_DUTY" : "#/components/schemas/PagerDuty", + "PROMETHEUS" : "#/components/schemas/Prometheus", + "SLACK" : "#/components/schemas/Slack", + "VICTOR_OPS" : "#/components/schemas/VictorOps", + "WEBHOOK" : "#/components/schemas/Webhook" + }, + "propertyName" : "type" + }, "properties" : { - "enabled" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether backups are performed for this USS instance. Backup uses [TODO](TODO) for USS instances.", - "readOnly" : true + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "type" : { + "type" : "string", + "description" : "Integration type", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" } }, - "readOnly" : true, - "title" : "USS backup configuration" + "title" : "Third-Party Integration" }, - "USSBackupSnapshot20250101" : { + "TimeMetricAlertView" : { "type" : "object", - "description" : "Details for one snapshot of a USS instance.", "properties" : { - "expiration" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "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.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "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.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "readOnly" : true + }, + "created" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "finishTime" : { + "currentValue" : { + "$ref" : "#/components/schemas/TimeMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "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.", + "example" : "cloud-test.mongodb.com:27017", "readOnly" : true }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, "links" : { "type" : "array", "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", @@ -49325,116 +50647,76 @@ }, "readOnly" : true }, - "mongoDBVersion" : { + "metricName" : { "type" : "string", - "description" : "MongoDB host version that the snapshot runs.", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", "readOnly" : true }, - "scheduledTime" : { + "orgId" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud will take the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "startTime" : { + "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.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when MongoDB Cloud began taking the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "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\"`.", "readOnly" : true }, "status" : { "type" : "string", - "description" : "Phase of the workflow for this snapshot at the time this resource made this request.", - "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true } }, - "title" : "USS Backup Snapshot" + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] }, - "USSBackupSnapshotDownloadCreate20250101" : { + "TimeMetricEventView" : { "type" : "object", - "description" : "Details for one backup snapshot download of a USS instance.", "properties" : { - "_snapshotId" : { + "apiKeyId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to download.", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", - "writeOnly" : true - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - } - }, - "required" : [ "_snapshotId" ], - "title" : "USS Backup Snapshot Download Create" - }, - "USSConnectionStrings20250101" : { - "type" : "object", - "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", - "externalDocs" : { - "description" : "Connection string URI format.", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, - "properties" : { - "standard" : { - "type" : "string", - "description" : "Public connection string that you can use to connect to this cluster. This connection string uses the mongodb:// protocol.", - "externalDocs" : { - "description" : "Connection String URI Format", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, - "readOnly" : true - }, - "standardSrv" : { - "type" : "string", - "description" : "Public connection string that you can use to connect to this USS instance. This connection string uses the `mongodb+srv://` protocol.", - "externalDocs" : { - "description" : "Connection String URI Format", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, "readOnly" : true - } - }, - "readOnly" : true, - "title" : "USS Instance Connection Strings" - }, - "USSInstanceDescription20250101" : { - "type" : "object", - "description" : "Group of settings that configure a MongoDB USS instance.", - "properties" : { - "backupSettings" : { - "$ref" : "#/components/schemas/USSBackupSettings20250101" }, - "clusterType" : { + "created" : { "type" : "string", - "description" : "USS instance topology.", - "enum" : [ "REPLICASET", "LOADBALANCED" ], + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "connectionStrings" : { - "$ref" : "#/components/schemas/USSConnectionStrings20250101" + "currentValue" : { + "$ref" : "#/components/schemas/TimeMetricValueView" }, - "createDate" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created this instance. This parameter expresses its value in ISO 8601 format in UTC.", - "readOnly" : true + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" }, "groupId" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the project.", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -49443,13 +50725,19 @@ }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the instance.", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, "links" : { "type" : "array", "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", @@ -49462,167 +50750,314 @@ }, "readOnly" : true }, - "mongoDBVersion" : { + "metricName" : { "type" : "string", - "description" : "Version of MongoDB that the instance runs.", - "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", "readOnly" : true }, - "name" : { + "orgId" : { "type" : "string", - "description" : "Human-readable label that identifies the instance.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "providerSettings" : { - "$ref" : "#/components/schemas/USSProviderSettings20250101" + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true }, - "stateName" : { + "publicKey" : { "type" : "string", - "description" : "Human-readable label that indicates the current operating condition of this instance.", - "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true }, - "tags" : { - "type" : "array", - "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.", - "externalDocs" : { - "description" : "Resource Tags", - "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" - }, - "items" : { - "$ref" : "#/components/schemas/ResourceTag" - } + "raw" : { + "$ref" : "#/components/schemas/raw" }, - "terminationProtectionEnabled" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true }, - "versionReleaseSystem" : { + "replicaSetName" : { "type" : "string", - "default" : "LTS", - "description" : "Method by which the cluster maintains the MongoDB versions.", - "enum" : [ "LTS" ], + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true } }, - "required" : [ "providerSettings" ], - "title" : "USS Instance Description" + "required" : [ "created", "eventTypeName", "id" ] }, - "USSInstanceDescriptionCreate20250101" : { + "TimeMetricThresholdView" : { "type" : "object", - "description" : "Settings that you can specify when you create a USS instance.", "properties" : { - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." }, - "name" : { + "mode" : { "type" : "string", - "description" : "Human-readable label that identifies the instance.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "writeOnly" : true + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] }, - "providerSettings" : { - "$ref" : "#/components/schemas/USSProviderSettingsCreate20250101" + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, - "tags" : { - "type" : "array", - "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.", - "externalDocs" : { - "description" : "Resource Tags", - "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" - }, - "items" : { - "$ref" : "#/components/schemas/ResourceTag" - } + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." }, - "terminationProtectionEnabled" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" } }, - "required" : [ "name", "providerSettings" ], - "title" : "USS Instance Description Create" + "required" : [ "metricName" ] + }, + "TimeMetricUnits" : { + "type" : "string", + "default" : "HOURS", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "NANOSECONDS", "MILLISECONDS", "MILLION_MINUTES", "SECONDS", "MINUTES", "HOURS", "DAYS" ], + "title" : "Time Metric Units" }, - "USSProviderSettings20250101" : { + "TimeMetricValueView" : { "type" : "object", - "description" : "Group of cloud provider settings that configure the provisioned MongoDB USS instance.", + "description" : "Measurement of the **metricName** recorded at the time of the event.", "properties" : { - "backingProviderName" : { - "type" : "string", - "description" : "Cloud service provider on which MongoDB Cloud provisioned the USS instance.", - "enum" : [ "AWS", "AZURE", "GCP" ], - "readOnly" : true - }, - "diskSizeGB" : { + "number" : { "type" : "number", "format" : "double", - "description" : "Storage capacity available to the USS instance expressed in gigabytes.", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", "readOnly" : true }, - "providerName" : { + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "readOnly" : true, + "title" : "Time Metric Value" + }, + "TokenFilterEnglishPossessive" : { + "type" : "object", + "description" : "Filter that removes possessives (trailing 's) from words.", + "properties" : { + "type" : { "type" : "string", - "default" : "USS", - "description" : "Human-readable label that identifies the cloud service provider.", - "enum" : [ "USS" ], - "readOnly" : true - }, - "regionName" : { + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "englishPossessive" ] + } + }, + "required" : [ "type" ], + "title" : "englishPossessive" + }, + "TokenFilterFlattenGraph" : { + "type" : "object", + "description" : "Filter that transforms a token filter graph, such as the token filter graph that the wordDelimiterGraph token filter produces, into a flat form suitable for indexing.", + "properties" : { + "type" : { "type" : "string", - "description" : "Human-readable label that identifies the geographic location of your MongoDB USS 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/).", - "readOnly" : true + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "flattenGraph" ] } }, - "readOnly" : true, - "title" : "Cloud Service Provider Settings for a USS Instance" + "required" : [ "type" ], + "title" : "flattenGraph" }, - "USSProviderSettingsCreate20250101" : { + "TokenFilterPorterStemming" : { "type" : "object", - "description" : "Group of cloud provider settings that configure the provisioned MongoDB USS instance.", + "description" : "Filter that uses the porter stemming algorithm to remove the common morphological and inflectional suffixes from words in English. It expects lowercase text and doesn't work as expected for uppercase text.", "properties" : { - "backingProviderName" : { + "type" : { "type" : "string", - "description" : "Cloud service provider on which MongoDB Cloud provisioned the serverless instance.", - "enum" : [ "AWS", "AZURE", "GCP" ], - "writeOnly" : true + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "porterStemming" ] + } + }, + "required" : [ "type" ], + "title" : "porterStemming" + }, + "TokenFilterSpanishPluralStemming" : { + "type" : "object", + "description" : "Filter that stems Spanish plural words. It expects lowercase text.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "spanishPluralStemming" ] + } + }, + "required" : [ "type" ], + "title" : "spanishPluralStemming" + }, + "TokenFilterStempel" : { + "type" : "object", + "description" : "Filter that uses Lucene's default Polish stemmer table to stem words in the Polish language. It expects lowercase text.", + "externalDocs" : { + "description" : "Default Polish stemmer table", + "url" : "https://lucene.apache.org/core/9_2_0/analysis/stempel/org/apache/lucene/analysis/pl/PolishAnalyzer.html#DEFAULT_STEMMER_FILE" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "stempel" ] + } + }, + "required" : [ "type" ], + "title" : "stempel" + }, + "TokenFilterWordDelimiterGraph" : { + "type" : "object", + "description" : "Filter that splits tokens into sub-tokens based on configured rules.", + "properties" : { + "delimiterOptions" : { + "type" : "object", + "description" : "Object that contains the rules that determine how to split words into sub-words.", + "properties" : { + "concatenateAll" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to concatenate runs." + }, + "concatenateNumbers" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to concatenate runs of sub-numbers." + }, + "concatenateWords" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to concatenate runs of sub-words." + }, + "generateNumberParts" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on sub-numbers. For example, if `true`, this option splits `100-2` into `100` and `2`." + }, + "generateWordParts" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on sub-words." + }, + "ignoreKeywords" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to skip tokens with the `keyword` attribute set to `true`" + }, + "preserveOriginal" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to generate tokens of the original words." + }, + "splitOnCaseChange" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on letter-case transitions." + }, + "splitOnNumerics" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on letter-number transitions." + }, + "stemEnglishPossessive" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to remove trailing possessives from each sub-word." + } + } }, - "diskSizeGB" : { - "type" : "number", - "format" : "double", - "description" : "Storage capacity available to the USS instance expressed in gigabytes.", - "readOnly" : true + "protectedWords" : { + "type" : "object", + "description" : "Object that contains options for protected words.", + "properties" : { + "ignoreCase" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to ignore letter case sensitivity for protected words." + }, + "words" : { + "type" : "array", + "description" : "List that contains the tokens to protect from delimination.", + "items" : { + "type" : "string" + } + } + }, + "required" : [ "words" ] }, - "providerName" : { + "type" : { "type" : "string", - "default" : "USS", - "description" : "Human-readable label that identifies the cloud service provider.", - "enum" : [ "USS" ], - "readOnly" : true + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "wordDelimiterGraph" ] + } + }, + "required" : [ "type" ], + "title" : "wordDelimiterGraph" + }, + "TokenFilterkStemming" : { + "type" : "object", + "description" : "Filter that combines algorithmic stemming with a built-in dictionary for the English language to stem words.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "kStemming" ] + } + }, + "required" : [ "type" ], + "title" : "kStemming" + }, + "TriggerIngestionPipelineRequest" : { + "type" : "object", + "properties" : { + "datasetRetentionPolicy" : { + "$ref" : "#/components/schemas/DatasetRetentionPolicy" }, - "regionName" : { + "snapshotId" : { "type" : "string", - "description" : "Human-readable label that identifies the geographic location of your MongoDB USS 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/).", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "writeOnly" : true } }, - "required" : [ "backingProviderName", "regionName" ], - "title" : "Cloud Service Provider Settings for a USS Instance", - "writeOnly" : true + "required" : [ "snapshotId" ] }, "UpdateAtlasOrganizationApiKey" : { "type" : "object", @@ -50260,7 +51695,7 @@ "description" : "Human-readable label that identifies the cluster or MongoDB Atlas Data Lake that this database user can access.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, "type" : { "type" : "string", @@ -50316,6 +51751,32 @@ "required" : [ "match" ], "title" : "User to Distinguished Name Mapping" }, + "VPCPeeringActionChallenge" : { + "type" : "object", + "description" : "Container for elements used to challenge the user before taking certain actions on VPC Peering connections.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "requesterAccountId" : { + "type" : "string", + "description" : "The AWS requester account ID." + }, + "requesterVpcId" : { + "type" : "string", + "description" : "The AWS requester VPC ID." + } + } + }, "VectorSearchHostStatusDetail" : { "type" : "object", "properties" : { diff --git a/tools/cli/test/data/split/dev/openapi-v2-2023-10-01.yaml b/tools/cli/test/data/split/dev/openapi-v2-2023-10-01.yaml index fa21d0c29b..e160fc5c4a 100644 --- a/tools/cli/test/data/split/dev/openapi-v2-2023-10-01.yaml +++ b/tools/cli/test/data/split/dev/openapi-v2-2023-10-01.yaml @@ -13,13 +13,15 @@ info: ``` To learn more, see [Get Started with the Atlas Administration API](https://www.mongodb.com/docs/atlas/configure-api-access/). For support, see [MongoDB Support](https://www.mongodb.com/support/get-started). + + You can also explore the various endpoints available through the Atlas Administration API in MongoDB's [Postman workspace](https://www.postman.com/mongodb-devrel/workspace/mongodb-atlas-administration-apis/). license: name: CC BY-NC-SA 3.0 US url: https://creativecommons.org/licenses/by-nc-sa/3.0/us/ termsOfService: https://www.mongodb.com/mongodb-management-service-terms-and-conditions title: MongoDB Atlas Administration API version: "2.0" - x-xgen-sha: 09d9d18db2111c955a8e01702a27ca2763417782 + x-xgen-sha: e6ba3136dbd0be2a81dd4ed21b9e6c470edd4420 servers: - url: https://cloud.mongodb.com tags: @@ -82,8 +84,12 @@ tags: \ resource requires your project ID. Changes to federated database instance configurations\ \ can affect costs." name: Data Federation -- description: "Returns, adds, edits, and removes Atlas Data Lake Pipelines and associated\ +- description: "Returns, edits, and removes Atlas Data Lake Pipelines and associated\ \ runs." + externalDocs: + description: Data Lake Pipelines are deprecated. Please see Data Lake Deprecation + Guide. + url: https://dochub.mongodb.org/core/data-lake-deprecation name: Data Lake Pipelines - description: "Returns, adds, edits, and removes database users." name: Database Users @@ -158,6 +164,8 @@ tags: - description: "You can continually push logs from mongod, mongos, and audit logs\ \ to an AWS S3 bucket. Atlas exports logs every 5 minutes." name: Push-Based Log Export +- description: Configure and manage Atlas Resource Policies within your organization. + name: Resource Policies - description: Creates one index to a database deployment in a rolling manner. You can't create a rolling index on an `M0` free cluster or `M2/M5` shared cluster. name: Rolling Index @@ -173,6 +181,13 @@ tags: description: Set Up a Private Endpoint for a Serverless Instance Tutorial url: https://dochub.mongodb.org/core/serverless-private-endpoint name: Serverless Private Endpoints +- description: Endpoints for managing Service Accounts and secrets. Service Accounts + are used for programmatic access to the Atlas Admin API through the OAuth 2.0 + Client Credentials flow. This feature is available as a Preview feature. + externalDocs: + description: Get Started with the Atlas Administration API + url: https://www.mongodb.com/docs/atlas/configure-api-access/ + name: Service Accounts - description: Returns and adds restore jobs for shared-tier database deployments. name: Shared-Tier Restore Jobs - description: Returns and requests to download shared-tier database deployment snapshots. @@ -2234,9 +2249,9 @@ paths: /api/atlas/v2/groups/{groupId}/backup/exportBuckets: get: deprecated: true - description: "Returns all AWS S3 buckets and Azure Blob Storage Containers associated\ - \ with the specified Project. To use this resource, the requesting API Key\ - \ must have the Project Read Only role." + description: "Returns all Export Buckets associated with the specified Project.\ + \ To use this resource, the requesting API Key must have the Project Read\ + \ Only role." operationId: listExportBuckets parameters: - $ref: "#/components/parameters/envelope" @@ -2259,17 +2274,17 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Return All AWS S3 Buckets and Azure Blob Storage Containers Used for - Cloud Backup Snapshot Exports + summary: Return All Snapshot Export Buckets tags: - Cloud Backups - x-sunset: 2025-05-30 + x-sunset: 2026-05-30 post: deprecated: true - description: "Grants MongoDB Cloud access to the specified AWS S3 Bucket or\ - \ Azure Blob Storage Container. This enables this Export Bucket to receive\ - \ Atlas Cloud Backup Snapshots. To use this resource, the requesting API Key\ - \ must have the Project Owner role." + description: "Creates a Snapshot Export Bucket for an AWS S3 Bucket or Azure\ + \ Blob Storage Container. Once created, an snapshots can be exported to the\ + \ Export Bucket and its referenced AWS S3 Bucket or Azure Blob Storage Container.\ + \ To use this resource, the requesting API Key must have the Project Owner\ + \ role." operationId: createExportBucket parameters: - $ref: "#/components/parameters/envelope" @@ -2282,8 +2297,8 @@ paths: $ref: "#/components/schemas/DiskBackupSnapshotAWSExportBucket" x-sunset: 2025-05-30 x-xgen-version: 2023-01-01 - description: Grants MongoDB Cloud access to the specified AWS S3 Bucket or - Azure Blob Storage Container. + description: Specifies the role and AWS S3 Bucket or Azure Blob Storage Container + that the Export Bucket should reference. required: true responses: "200": @@ -2303,25 +2318,22 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Grant Access to AWS S3 Bucket or Azure Blob Storage Container for Cloud - Backup Snapshot Exports + summary: Create One Snapshot Export Bucket tags: - Cloud Backups - x-sunset: 2025-05-30 + x-sunset: 2026-05-30 /api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}: delete: - description: "Revoke MongoDB Cloud access to the specified AWS S3 Bucket or\ - \ Azure Blob Storage Container. This prevents this Export Bucket from receiving\ - \ Atlas Cloud Backup Snapshots. 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 API Key must have the Project Owner\ - \ role." + 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 API Key must have the Project\ + \ Owner role." operationId: deleteExportBucket parameters: - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/groupId" - - description: Unique string that identifies the AWS S3 Bucket or Azure Blob - Storage Container to which you export your Snapshots. + - description: Unique 24-hexadecimal character string that identifies the Export + Bucket. in: path name: exportBucketId required: true @@ -2349,15 +2361,14 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Revoke Access to AWS S3 Bucket or Azure Blob Storage Container for - Cloud Backup Snapshot Exports + summary: Delete One Snapshot Export Bucket tags: - Cloud Backups get: deprecated: true - description: "Returns one AWS S3 Bucket or Azure Blob Storage Container associated\ - \ with the specified Project. To use this resource, the requesting API Key\ - \ must have the Project Read Only role." + description: "Returns one Export Bucket associated with the specified Project.\ + \ To use this resource, the requesting API Key must have the Project Read\ + \ Only role." operationId: getExportBucket parameters: - $ref: "#/components/parameters/envelope" @@ -2389,11 +2400,10 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Return One AWS S3 Bucket or Azure Blob Storage Container Used for Cloud - Backup Snapshot Exports + summary: Return One Snapshot Export Bucket tags: - Cloud Backups - x-sunset: 2025-05-30 + x-sunset: 2026-05-30 /api/atlas/v2/groups/{groupId}/backupCompliancePolicy: get: description: "Returns the Backup Compliance Policy settings with the specified\ @@ -2512,7 +2522,7 @@ paths: content: application/vnd.atlas.2023-01-01+json: schema: - $ref: "#/components/schemas/CloudProviderAccessRole" + $ref: "#/components/schemas/CloudProviderAccessRoleRequest" description: Creates one role for the specified cloud provider. required: true responses: @@ -2551,6 +2561,8 @@ paths: type: string enum: - AWS + - AZURE + - GCP - description: Unique 24-hexadecimal digit string that identifies the role. in: path name: roleId @@ -2617,7 +2629,8 @@ paths: description: "Grants access to the specified project for the specified access\ \ role. To use this resource, the requesting API Key must have the Project\ \ Owner role. This API endpoint is one step in a procedure to create unified\ - \ access for MongoDB Cloud services." + \ 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/ @@ -2639,7 +2652,7 @@ paths: content: application/vnd.atlas.2023-01-01+json: schema: - $ref: "#/components/schemas/CloudProviderAccessRole" + $ref: "#/components/schemas/CloudProviderAccessRoleRequestUpdate" description: Grants access to the specified project for the specified access role. required: true @@ -2898,7 +2911,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster. in: query @@ -2946,7 +2959,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -2994,7 +3007,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-02-01+json: @@ -3028,7 +3041,7 @@ paths: x-sunset: 2026-03-01 /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports: get: - description: "Returns all Cloud Backup snapshot export jobs associated with\ + description: "Returns all Cloud Backup Snapshot Export Jobs associated with\ \ the specified Atlas cluster. To use this resource, the requesting API Key\ \ must have the Project Atlas Admin role." operationId: listBackupExportJobs @@ -3047,7 +3060,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -3062,11 +3075,11 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Return All Cloud Backup Snapshot Export Jobs + summary: Return All Snapshot Export Jobs tags: - Cloud Backups post: - description: "Exports one backup snapshot for dedicated Atlas cluster using\ + description: "Exports one backup Snapshot for dedicated Atlas cluster using\ \ Cloud Backups to an Export Bucket. To use this resource, the requesting\ \ API Key must have the Project Atlas Admin role." operationId: createBackupExportJob @@ -3081,7 +3094,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -3109,12 +3122,12 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Create One Cloud Backup Snapshot Export Job + summary: Create One Snapshot Export Job tags: - Cloud Backups /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}: get: - description: "Returns one Cloud Backup snapshot export job associated with the\ + description: "Returns one Cloud Backup Snapshot Export Job associated with the\ \ specified Atlas cluster. To use this resource, the requesting API Key must\ \ have the Project Atlas Admin role." operationId: getBackupExportJob @@ -3129,13 +3142,18 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - - description: Unique string that identifies the export job to return. + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + - description: Unique 24-hexadecimal character string that identifies the Export + Job. in: path name: exportId required: true schema: type: string + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" responses: "200": content: @@ -3150,7 +3168,7 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Return One Cloud Backup Snapshot Export Job + summary: Return One Snapshot Export Job tags: - Cloud Backups /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs: @@ -3175,7 +3193,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -3211,7 +3229,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -3260,7 +3278,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the restore job to remove. in: path @@ -3308,7 +3326,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the restore job to return. in: path @@ -3355,7 +3373,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -3375,7 +3393,7 @@ paths: summary: Remove All Cloud Backup Schedules tags: - Cloud Backups - x-sunset: 2025-08-05 + x-sunset: 2026-05-30 get: deprecated: true description: "Returns the cloud backup schedule for the specified cluster within\ @@ -3395,7 +3413,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -3413,7 +3431,7 @@ paths: summary: Return One Cloud Backup Schedule tags: - Cloud Backups - x-sunset: 2025-08-05 + x-sunset: 2026-05-30 patch: deprecated: true description: "Updates the cloud backup schedule for one cluster within the specified\ @@ -3433,7 +3451,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -3463,7 +3481,7 @@ paths: summary: Update Cloud Backup Schedule for One Cluster tags: - Cloud Backups - x-sunset: 2025-08-05 + x-sunset: 2026-05-30 /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots: get: description: "Returns all snapshots of one cluster from the specified project.\ @@ -3485,7 +3503,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -3523,7 +3541,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -3568,7 +3586,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -3613,7 +3631,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -3661,7 +3679,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -3698,7 +3716,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -3744,7 +3762,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -3790,7 +3808,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -3845,7 +3863,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/groupId" - $ref: "#/components/parameters/pretty" @@ -3899,7 +3917,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/groupId" - $ref: "#/components/parameters/pretty" @@ -3948,7 +3966,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/groupId" - $ref: "#/components/parameters/pretty" @@ -3985,7 +4003,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/groupId" - $ref: "#/components/parameters/pretty" @@ -4036,7 +4054,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -4074,7 +4092,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -4127,7 +4145,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -4174,7 +4192,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -4221,7 +4239,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -4275,7 +4293,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Name of the collection that contains one or more Atlas Search indexes. in: path @@ -4333,7 +4351,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: "Unique 24-hexadecimal digit string that identifies the Atlas\ \ Search index. Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/)\ \ endpoint to find the IDs of all Atlas Search indexes." @@ -4388,7 +4406,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - 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/)\ @@ -4442,7 +4460,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - 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/)\ @@ -4507,7 +4525,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -4551,7 +4569,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -4593,7 +4611,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-02-01+json: @@ -4645,7 +4663,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - $ref: "#/components/parameters/groupId" - description: Human-readable label that identifies the database that contains the collection. @@ -4702,7 +4720,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-02-01+json: @@ -4757,7 +4775,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -4872,7 +4890,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -4911,7 +4929,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -4989,7 +5007,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Flag that indicates whether to download logs for queries against your online archive only or both your online archive and cluster. in: query @@ -5056,7 +5074,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "204": content: @@ -5107,7 +5125,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5160,7 +5178,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -5211,7 +5229,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5252,7 +5270,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5293,7 +5311,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -5346,7 +5364,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5392,7 +5410,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -5445,7 +5463,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5498,7 +5516,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5548,7 +5566,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -5596,7 +5614,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the restore job. in: path @@ -5643,7 +5661,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5681,7 +5699,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5719,7 +5737,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -5765,7 +5783,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -5816,7 +5834,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5854,7 +5872,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -5908,7 +5926,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: "Human-readable label that specifies whether to return only completed,\ \ incomplete, or all snapshots. By default, MongoDB Cloud only returns completed\ \ snapshots." @@ -5963,7 +5981,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -6017,7 +6035,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -6070,7 +6088,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -6125,7 +6143,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -6187,18 +6205,22 @@ paths: externalDocs: description: Set up Database Auditing url: https://docs.atlas.mongodb.com/database-auditing/ - - description: Date and time when the period specifies the inclusive ending - point for the range of log messages to retrieve. This parameter expresses - its value in the number of seconds that have elapsed since the UNIX epoch. + - description: "Specifies the date and time for the ending point of the range\ + \ of log messages to retrieve, in the number of seconds that have elapsed\ + \ since the UNIX epoch. This value will default to 24 hours after the start\ + \ date. If the start date is also unspecified, the value will default to\ + \ the time of the request." in: query name: endDate schema: type: integer format: int64 minimum: 1199145600 - - description: Date and time when the period specifies the inclusive starting - point for the range of log messages to retrieve. This parameter expresses - its value in the number of seconds that have elapsed since the UNIX epoch. + - description: "Specifies the date and time for the starting point of the range\ + \ of log messages to retrieve, in the number of seconds that have elapsed\ + \ since the UNIX epoch. This value will default to 24 hours prior to the\ + \ end date. If the end date is also unspecified, the value will default\ + \ to 24 hours prior to the time of the request." in: query name: startDate schema: @@ -7635,7 +7657,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: "Date and time when to stop retrieving database history. If you\ \ specify **end**, you must also specify **start**. This parameter uses\ \ UNIX epoch time in milliseconds." @@ -7854,6 +7876,9 @@ paths: - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/pretty" - $ref: "#/components/parameters/groupId" + - $ref: "#/components/parameters/includeCount" + - $ref: "#/components/parameters/itemsPerPage" + - $ref: "#/components/parameters/pageNum" - description: Human-readable label that identifies the cloud provider for the private endpoints to return. in: path @@ -7951,14 +7976,6 @@ paths: maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" - requestBody: - content: - application/vnd.atlas.2023-01-01+json: - schema: - $ref: "#/components/schemas/EncryptionAtRestPrivateEndpointRequest" - description: Cloud provider of the private endpoints to delete and the list - of cloud provider regions in which to delete the private endpoints. - required: true responses: "204": content: @@ -8013,6 +8030,8 @@ paths: description: OK "403": $ref: "#/components/responses/forbidden" + "404": + $ref: "#/components/responses/notFound" "500": $ref: "#/components/responses/internalServerError" security: @@ -8044,7 +8063,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" style: form - description: |- Category of incident recorded at this moment in time. @@ -8671,7 +8690,7 @@ paths: summary: Return All Project Invitations tags: - Projects - x-sunset: 2024-10-04 + x-sunset: 2024-11-04 patch: deprecated: true description: "Updates the details of one pending invitation to the specified\ @@ -8712,7 +8731,7 @@ paths: summary: Update One Project Invitation tags: - Projects - x-sunset: 2024-10-04 + x-sunset: 2024-11-04 post: deprecated: true description: "Invites one MongoDB Cloud user to join the specified project.\ @@ -8748,7 +8767,7 @@ paths: summary: Invite One MongoDB Cloud User to Join One Project tags: - Projects - x-sunset: 2024-10-04 + x-sunset: 2024-11-04 /api/atlas/v2/groups/{groupId}/invites/{invitationId}: delete: deprecated: true @@ -8786,7 +8805,7 @@ paths: summary: Cancel One Project Invitation tags: - Projects - x-sunset: 2024-10-04 + x-sunset: 2024-11-04 get: deprecated: true description: "Returns the details of one pending invitation to the specified\ @@ -8825,7 +8844,7 @@ paths: summary: Return One Project Invitation tags: - Projects - x-sunset: 2024-10-04 + x-sunset: 2024-11-04 patch: deprecated: true description: "Updates the details of one pending invitation to the specified\ @@ -8875,7 +8894,7 @@ paths: summary: Update One Project Invitation by Invitation ID tags: - Projects - x-sunset: 2024-10-04 + x-sunset: 2024-11-04 /api/atlas/v2/groups/{groupId}/ipAddresses: get: description: "Returns all IP addresses for this project. To use this resource,\ @@ -8951,7 +8970,7 @@ paths: | Limit Name | Description | Default | API Override Limit | | --- | --- | --- | --- | - | atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 | + | atlas.project.deployment.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 | @@ -8963,6 +8982,7 @@ paths: | 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 | in: path name: limitName required: true @@ -8982,6 +9002,7 @@ paths: - 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" @@ -9016,7 +9037,7 @@ paths: | Limit Name | Description | Default | API Override Limit | | --- | --- | --- | --- | - | atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 | + | atlas.project.deployment.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 | @@ -9028,6 +9049,7 @@ paths: | 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 | in: path name: limitName required: true @@ -9047,6 +9069,7 @@ paths: - 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" @@ -9085,7 +9108,7 @@ paths: | Limit Name | Description | Default | API Override Limit | | --- | --- | --- | --- | - | atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 | + | atlas.project.deployment.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 | @@ -9097,6 +9120,7 @@ paths: | 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 | in: path name: limitName required: true @@ -9116,6 +9140,7 @@ paths: - 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" @@ -9893,6 +9918,7 @@ paths: - Network Peering /api/atlas/v2/groups/{groupId}/pipelines: get: + deprecated: true description: "Returns a list of Data Lake Pipelines. To use this resource, the\ \ requesting API Key must have the Project Read Only role." operationId: listPipelines @@ -9920,8 +9946,14 @@ paths: summary: Return All Data Lake Pipelines from One Project tags: - Data Lake Pipelines + x-sunset: 2025-09-09 post: + deprecated: true description: Creates one Data Lake Pipeline. + externalDocs: + description: Data Lake Pipelines are deprecated. Please see Data Lake Deprecation + Guide. + url: https://dochub.mongodb.org/core/data-lake-deprecation operationId: createPipeline parameters: - $ref: "#/components/parameters/envelope" @@ -9954,8 +9986,10 @@ paths: summary: Create One Data Lake Pipeline tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}: delete: + deprecated: true description: Removes one Data Lake Pipeline. operationId: deletePipeline parameters: @@ -9989,7 +10023,9 @@ paths: summary: Remove One Data Lake Pipeline tags: - Data Lake Pipelines + x-sunset: 2025-09-09 get: + deprecated: true description: "Returns the details of one Data Lake Pipeline within the specified\ \ project. To use this resource, the requesting API Key must have the Project\ \ Read Only role." @@ -10026,7 +10062,9 @@ paths: summary: Return One Data Lake Pipeline tags: - Data Lake Pipelines + x-sunset: 2025-09-09 patch: + deprecated: true description: Updates one Data Lake Pipeline. operationId: updatePipeline parameters: @@ -10071,8 +10109,10 @@ paths: summary: Update One Data Lake Pipeline tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules: get: + deprecated: true description: "Returns a list of backup schedule policy items that you can use\ \ as a Data Lake Pipeline source. To use this resource, the requesting API\ \ Key must have the Project Read Only role." @@ -10111,8 +10151,10 @@ paths: summary: Return Available Ingestion Schedules for One Data Lake Pipeline tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots: get: + deprecated: true description: "Returns a list of backup snapshots that you can use to trigger\ \ an on demand pipeline run. To use this resource, the requesting API Key\ \ must have the Project Read Only role." @@ -10162,8 +10204,10 @@ paths: summary: Return Available Backup Snapshots for One Data Lake Pipeline tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause: post: + deprecated: true description: "Pauses ingestion for a Data Lake Pipeline within the specified\ \ project. To use this resource, the requesting API Key must have the Project\ \ Read Only role." @@ -10200,8 +10244,10 @@ paths: summary: Pause One Data Lake Pipeline tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume: post: + deprecated: true description: "Resumes ingestion for a Data Lake Pipeline within the specified\ \ project. To use this resource, the requesting API Key must have the Project\ \ Read Only role." @@ -10238,8 +10284,10 @@ paths: summary: Resume One Data Lake Pipeline tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs: get: + deprecated: true description: "Returns a list of past Data Lake Pipeline runs. To use this resource,\ \ the requesting API Key must have the Project Read Only role." operationId: listPipelineRuns @@ -10286,8 +10334,10 @@ paths: summary: Return All Data Lake Pipeline Runs from One Project tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}: delete: + deprecated: true description: Deletes dataset that Atlas generated during the specified pipeline run. operationId: deletePipelineRunDataset @@ -10334,7 +10384,9 @@ paths: summary: Delete Pipeline Run Dataset tags: - Data Lake Pipelines + x-sunset: 2025-09-09 get: + deprecated: true description: "Returns the details of one Data Lake Pipeline run within the specified\ \ project. To use this resource, the requesting API Key must have the Project\ \ Read Only role." @@ -10382,8 +10434,10 @@ paths: summary: Return One Data Lake Pipeline Run tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger: post: + deprecated: true description: Triggers a Data Lake Pipeline ingestion of a specified snapshot. operationId: triggerSnapshotIngestion parameters: @@ -10425,6 +10479,7 @@ paths: summary: Trigger on demand snapshot ingestion tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService: post: description: "Creates one private endpoint service for the specified cloud service\ @@ -10556,7 +10611,7 @@ paths: schema: type: string maxLength: 64 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -10598,7 +10653,7 @@ paths: schema: type: string maxLength: 64 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -10642,7 +10697,7 @@ paths: schema: type: string maxLength: 64 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be removed. in: path @@ -10688,7 +10743,7 @@ paths: schema: type: string maxLength: 64 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the tenant endpoint. in: path @@ -10733,7 +10788,7 @@ paths: schema: type: string maxLength: 64 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be updated. in: path @@ -11726,6 +11781,8 @@ paths: - 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 maxItems: 10 minItems: 1 uniqueItems: true @@ -11810,6 +11867,8 @@ paths: - CACHE_BYTES_WRITTEN_FROM - CACHE_DIRTY_BYTES - CACHE_USED_BYTES + - CACHE_FILL_RATIO + - DIRTY_FILL_RATIO - COMPUTED_MEMORY - CONNECTIONS - CURSORS_TOTAL_OPEN @@ -11891,6 +11950,7 @@ paths: - 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 @@ -12362,7 +12422,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "201": content: @@ -12507,7 +12567,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -12545,7 +12605,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -12595,7 +12655,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the restore job to return. in: path @@ -12646,7 +12706,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -12683,7 +12743,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -12728,7 +12788,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/pretty" responses: @@ -12761,7 +12821,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Value that we want to set for the Serverless Auto Indexing toggle. in: query name: enable @@ -12805,15 +12865,15 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: - "204": + "202": content: application/vnd.atlas.2023-01-01+json: schema: - $ref: "#/components/schemas/NoBody" + $ref: "#/components/schemas/RequestAccepted" x-xgen-version: 2023-01-01 - description: This endpoint does not return a response body. + description: Accepted "400": $ref: "#/components/responses/badRequest" "404": @@ -12844,7 +12904,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -12882,7 +12942,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -12909,222 +12969,6 @@ paths: summary: Update One Serverless Instance in One Project tags: - Serverless Instances - /api/atlas/v2/groups/{groupId}/serviceAccounts: - get: - description: Returns list of Service Accounts for a project with service account - details. - operationId: listProjectServiceAccounts - parameters: - - $ref: "#/components/parameters/groupId" - - $ref: "#/components/parameters/itemsPerPage" - - $ref: "#/components/parameters/pageNum" - - $ref: "#/components/parameters/pretty" - - $ref: "#/components/parameters/envelope" - responses: - "200": - content: - application/vnd.atlas.2023-10-01+json: - schema: - $ref: "#/components/schemas/PaginatedGroupServiceAccounts" - x-xgen-version: 2023-10-01 - description: OK - "401": - $ref: "#/components/responses/unauthorized" - "403": - $ref: "#/components/responses/forbidden" - "500": - $ref: "#/components/responses/internalServerError" - security: - - DigestAuth: [] - summary: Return All project Service Accounts - tags: - - Groups - post: - description: Creates and assigns the specified Service Account to the specified - Project. - operationId: createProjectServiceAccount - parameters: - - $ref: "#/components/parameters/groupId" - - $ref: "#/components/parameters/envelope" - - $ref: "#/components/parameters/pretty" - requestBody: - content: - application/vnd.atlas.2023-10-01+json: - schema: - $ref: "#/components/schemas/GroupServiceAccountRequest" - x-xgen-version: 2023-10-01 - description: Details to create service account and add to the specified project. - required: true - responses: - "201": - content: - application/vnd.atlas.2023-10-01+json: - schema: - $ref: "#/components/schemas/GroupServiceAccount" - x-xgen-version: 2023-10-01 - description: Created - "400": - $ref: "#/components/responses/badRequest" - "401": - $ref: "#/components/responses/unauthorized" - "500": - $ref: "#/components/responses/internalServerError" - security: - - DigestAuth: [] - summary: Create and Assign one Service Account to one project - tags: - - Groups - /api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}: - delete: - description: Removes one Service Account from the specified project. - operationId: deleteProjectServiceAccount - parameters: - - description: Id of the service account. - in: path - name: serviceAccountId - required: true - schema: - type: string - - $ref: "#/components/parameters/groupId" - - $ref: "#/components/parameters/envelope" - - $ref: "#/components/parameters/pretty" - responses: - "204": - content: - application/vnd.atlas.2023-10-01+json: - schema: - $ref: "#/components/schemas/NoBody" - x-xgen-version: 2023-10-01 - description: This endpoint does not return a response body. - x-xgen-version: 2023-10-01 - "401": - $ref: "#/components/responses/unauthorized" - "404": - $ref: "#/components/responses/notFound" - "500": - $ref: "#/components/responses/internalServerError" - security: - - DigestAuth: [] - summary: Unassign One Service Account from One Project. - tags: - - Groups - get: - description: Get project Service Account Details. - operationId: getProjectServiceAccount - parameters: - - $ref: "#/components/parameters/groupId" - - description: Id of the service account. - in: path - name: serviceAccountId - required: true - schema: - type: string - - $ref: "#/components/parameters/envelope" - - $ref: "#/components/parameters/pretty" - responses: - "200": - content: - application/vnd.atlas.2023-10-01+json: - schema: - $ref: "#/components/schemas/GroupServiceAccount" - x-xgen-version: 2023-10-01 - description: OK - "401": - $ref: "#/components/responses/unauthorized" - "404": - $ref: "#/components/responses/notFound" - "500": - $ref: "#/components/responses/internalServerError" - security: - - DigestAuth: [] - summary: Service Account Fetching - tags: - - Groups - patch: - description: Update Service Account in Project. - operationId: updateProjectServiceAccount - parameters: - - description: Id of the service account. - in: path - name: serviceAccountId - required: true - schema: - type: string - - $ref: "#/components/parameters/groupId" - - $ref: "#/components/parameters/envelope" - - $ref: "#/components/parameters/pretty" - requestBody: - content: - application/vnd.atlas.2023-10-01+json: - schema: - $ref: "#/components/schemas/GroupServiceAccountUpdateRequest" - description: Details to update service account in the specified Project. - required: true - responses: - "200": - content: - application/vnd.atlas.2023-10-01+json: - schema: - $ref: "#/components/schemas/GroupServiceAccount" - x-xgen-version: 2023-10-01 - description: OK - "400": - $ref: "#/components/responses/badRequest" - "401": - $ref: "#/components/responses/unauthorized" - "404": - $ref: "#/components/responses/notFound" - "500": - $ref: "#/components/responses/internalServerError" - security: - - DigestAuth: [] - summary: Service Account Update in Project - tags: - - Groups - post: - description: Assigns the specified organization Service Account to the specified - project. - operationId: addProjectServiceAccount - parameters: - - description: Id of the service account. - in: path - name: serviceAccountId - required: true - schema: - type: string - - $ref: "#/components/parameters/groupId" - - $ref: "#/components/parameters/envelope" - - $ref: "#/components/parameters/pretty" - requestBody: - content: - application/vnd.atlas.2023-10-01+json: - schema: - type: array - items: - $ref: "#/components/schemas/GroupServiceAccountRoleAssignment" - x-xgen-version: 2023-10-01 - description: Service Account Roles to be assigned to the specified project. - required: true - responses: - "204": - content: - application/vnd.atlas.2023-10-01+json: - schema: - $ref: "#/components/schemas/NoBody" - x-xgen-version: 2023-10-01 - description: This endpoint does not return a response body. - x-xgen-version: 2023-10-01 - "401": - $ref: "#/components/responses/unauthorized" - "404": - $ref: "#/components/responses/notFound" - "500": - $ref: "#/components/responses/internalServerError" - security: - - DigestAuth: [] - summary: Assign One Service Account to One Project - tags: - - Groups /api/atlas/v2/groups/{groupId}/settings: get: description: "Returns details about the specified project's settings. To use\ @@ -13261,19 +13105,305 @@ paths: x-xgen-changelog: "2023-09-11": "The MongoDB Atlas Streams Processing API is now exposed as\ \ part of private preview, but is subject to change until GA." - /api/atlas/v2/groups/{groupId}/streams/{tenantName}: + /api/atlas/v2/groups/{groupId}/streams/privateLinkConnections: + get: + description: "Returns all Private Link connections for the specified project.To\ + \ use this resource, the requesting API Key must have the Project Data Access\ + \ roles, Project Owner role or Project Stream Processing Owner role." + operationId: listPrivateLinkConnections + parameters: + - $ref: "#/components/parameters/groupId" + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/itemsPerPage" + - $ref: "#/components/parameters/pageNum" + - $ref: "#/components/parameters/pretty" + responses: + "200": + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/PaginatedApiStreamsPrivateLinkView" + x-xgen-version: 2023-02-01 + description: OK + "401": + $ref: "#/components/responses/unauthorized" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Return All Private Link + tags: + - Streams + x-xgen-changelog: + "2024-10-02": "The MongoDB Atlas Streams Processing Private Link API is now\ + \ exposed as part of private preview, but is subject to change until GA." + post: + description: "Creates one Private Link in the specified project. To use this\ + \ resource, the requesting API Key must have the Project Owner or Project\ + \ Stream Processing Owner role." + operationId: createPrivateLinkConnection + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/pretty" + - $ref: "#/components/parameters/groupId" + requestBody: + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/StreamsPrivateLinkConnection" + description: Details to create one Private Link connection for a project. + project. + required: true + responses: + "200": + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/StreamsPrivateLinkConnection" + x-xgen-version: 2023-02-01 + description: OK + "400": + $ref: "#/components/responses/badRequest" + "401": + $ref: "#/components/responses/unauthorized" + "409": + $ref: "#/components/responses/unauthorized" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Create One Private Link connection + tags: + - Streams + x-xgen-changelog: + "2024-10-02": "The MongoDB Atlas Streams Processing Private Link API is now\ + \ exposed as part of private preview, but is subject to change until GA." + /api/atlas/v2/groups/{groupId}/streams/privateLinkConnections/{connectionId}: delete: - description: "Delete one stream instance in the specified project. To use this\ - \ resource, the requesting API Key must have the Project Data Access Admin\ - \ role, Project Owner role or Project Stream Processing Owner role." - operationId: deleteStreamInstance + description: "Deletes one Private Link in the specified project. To use this\ + \ resource, the requesting API Key must have the Project Owner or Project\ + \ Stream Processing Owner role." + operationId: deletePrivateLinkConnection parameters: - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/pretty" - $ref: "#/components/parameters/groupId" - - description: Human-readable label that identifies the stream instance to delete. + - description: Unique ID that identifies the Private Link connection. in: path - name: tenantName + name: connectionId + required: true + schema: + type: string + responses: + "202": + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/NoBody" + x-xgen-version: 2023-02-01 + description: Accepted + "401": + $ref: "#/components/responses/unauthorized" + "403": + $ref: "#/components/responses/forbidden" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Delete One Private Link connection + tags: + - Streams + x-xgen-changelog: + "2024-10-02": "The MongoDB Atlas Streams Processing Private Link API is now\ + \ exposed as part of private preview, but is subject to change until GA." + get: + description: "Returns the details of one Private Link connection within the\ + \ project. To use this resource, the requesting API Key must have the Project\ + \ Read Only role." + operationId: getPrivateLinkConnection + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/groupId" + - description: Unique ID that identifies the Private Link connection. + in: path + name: connectionId + required: true + schema: + type: string + responses: + "200": + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/StreamsPrivateLinkConnection" + x-xgen-version: 2023-02-01 + description: OK + "401": + $ref: "#/components/responses/unauthorized" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Return One PrivateLink Connection + tags: + - Streams + x-xgen-changelog: + "2024-10-02": "The MongoDB Atlas Streams Processing Private Link API is now\ + \ exposed as part of private preview, but is subject to change until GA." + /api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections: + get: + description: Returns a list of incoming VPC Peering Connections. + operationId: getVPCPeeringConnections + parameters: + - $ref: "#/components/parameters/groupId" + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/itemsPerPage" + - $ref: "#/components/parameters/pageNum" + - $ref: "#/components/parameters/pretty" + responses: + "200": + content: + application/vnd.atlas.2023-02-01+json: + x-xgen-version: 2023-02-01 + description: OK + "401": + $ref: "#/components/responses/unauthorized" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Return All VPC Peering Connections. + tags: + - Streams + /api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}: + delete: + description: Deletes an incoming VPC Peering connection. + operationId: deleteVPCPeeringConnection + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/groupId" + - description: The VPC Peering Connection id. + in: path + name: id + required: true + schema: + type: string + responses: + "202": + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/NoBody" + x-xgen-version: 2023-02-01 + description: Accepted + "401": + $ref: "#/components/responses/unauthorized" + "403": + $ref: "#/components/responses/forbidden" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Deletes an incoming VPC Peering connection. + tags: + - Streams + /api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:accept: + post: + description: Requests the acceptance of an incoming VPC Peering connection. + operationId: acceptVPCPeeringConnection + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/groupId" + - description: The VPC Peering Connection id. + in: path + name: id + required: true + schema: + type: string + requestBody: + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/VPCPeeringActionChallenge" + description: "Challenge values for VPC Peering requester account ID, and requester\ + \ VPC ID." + required: true + responses: + "202": + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/NoBody" + x-xgen-version: 2023-02-01 + description: Accepted + "401": + $ref: "#/components/responses/unauthorized" + "403": + $ref: "#/components/responses/forbidden" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Requests the acceptance of an incoming VPC Peering connection. + tags: + - Streams + /api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:reject: + post: + description: Requests the rejection of an incoming VPC Peering connection. + operationId: rejectVPCPeeringConnection + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/groupId" + - description: The VPC Peering Connection id. + in: path + name: id + required: true + schema: + type: string + responses: + "202": + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/NoBody" + x-xgen-version: 2023-02-01 + description: Accepted + "401": + $ref: "#/components/responses/unauthorized" + "403": + $ref: "#/components/responses/forbidden" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Requests the rejection of an incoming VPC Peering connection. + tags: + - Streams + /api/atlas/v2/groups/{groupId}/streams/{tenantName}: + delete: + description: "Delete one stream instance in the specified project. To use this\ + \ resource, the requesting API Key must have the Project Data Access Admin\ + \ role, Project Owner role or Project Stream Processing Owner role." + operationId: deleteStreamInstance + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/pretty" + - $ref: "#/components/parameters/groupId" + - description: Human-readable label that identifies the stream instance to delete. + in: path + name: tenantName required: true schema: type: string @@ -15644,284 +15774,6 @@ paths: summary: Create One Link-Token tags: - Cloud Migration Service - /api/atlas/v2/orgs/{orgId}/serviceAccounts: - get: - description: Returns list of Service Accounts with service account details. - operationId: listServiceAccounts - parameters: - - $ref: "#/components/parameters/orgId" - - $ref: "#/components/parameters/itemsPerPage" - - $ref: "#/components/parameters/pageNum" - - $ref: "#/components/parameters/pretty" - - $ref: "#/components/parameters/envelope" - responses: - "200": - content: - application/vnd.atlas.2023-10-01+json: - schema: - $ref: "#/components/schemas/PaginatedOrgServiceAccounts" - x-xgen-version: 2023-10-01 - description: OK - "401": - $ref: "#/components/responses/unauthorized" - "403": - $ref: "#/components/responses/forbidden" - "500": - $ref: "#/components/responses/internalServerError" - security: - - DigestAuth: [] - summary: Return All Service Accounts - tags: - - Organizations - post: - description: Create Service Account containing client id and client secrets. - operationId: createServiceAccount - parameters: - - $ref: "#/components/parameters/orgId" - - $ref: "#/components/parameters/envelope" - - $ref: "#/components/parameters/pretty" - requestBody: - content: - application/vnd.atlas.2023-10-01+json: - schema: - $ref: "#/components/schemas/OrgServiceAccountRequest" - description: Details to create service account in the specified organization. - required: true - responses: - "201": - content: - application/vnd.atlas.2023-10-01+json: - schema: - $ref: "#/components/schemas/OrgServiceAccount" - x-xgen-version: 2023-10-01 - description: Created - "400": - $ref: "#/components/responses/badRequest" - "401": - $ref: "#/components/responses/unauthorized" - "500": - $ref: "#/components/responses/internalServerError" - security: - - DigestAuth: [] - summary: Service Account Creation - tags: - - Organizations - /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}: - delete: - description: Delete Service Account. - operationId: deleteServiceAccount - parameters: - - description: Id of the service account. - in: path - name: serviceAccountId - required: true - schema: - type: string - - $ref: "#/components/parameters/orgId" - - $ref: "#/components/parameters/envelope" - - $ref: "#/components/parameters/pretty" - responses: - "204": - content: - application/vnd.atlas.2023-10-01+json: - x-xgen-version: 2023-10-01 - description: This endpoint does not return a response body. - "401": - $ref: "#/components/responses/unauthorized" - "404": - $ref: "#/components/responses/notFound" - "500": - $ref: "#/components/responses/internalServerError" - security: - - DigestAuth: [] - summary: Service Account Deletion. - tags: - - Organizations - get: - description: Get Service Account Details. - operationId: getServiceAccount - parameters: - - $ref: "#/components/parameters/orgId" - - description: Id of the service account. - in: path - name: serviceAccountId - required: true - schema: - type: string - - $ref: "#/components/parameters/envelope" - - $ref: "#/components/parameters/pretty" - responses: - "200": - content: - application/vnd.atlas.2023-10-01+json: - schema: - $ref: "#/components/schemas/OrgServiceAccount" - x-xgen-version: 2023-10-01 - description: OK - "401": - $ref: "#/components/responses/unauthorized" - "404": - $ref: "#/components/responses/notFound" - "500": - $ref: "#/components/responses/internalServerError" - security: - - DigestAuth: [] - summary: Service Account Fetching - tags: - - Organizations - patch: - description: Update Service Account. - operationId: updateServiceAccount - parameters: - - description: Id of the service account. - in: path - name: serviceAccountId - required: true - schema: - type: string - - $ref: "#/components/parameters/orgId" - - $ref: "#/components/parameters/envelope" - - $ref: "#/components/parameters/pretty" - requestBody: - content: - application/vnd.atlas.2023-10-01+json: - schema: - $ref: "#/components/schemas/OrgServiceAccountUpdateRequest" - description: Details to update service account in the specified organization. - required: true - responses: - "200": - content: - application/vnd.atlas.2023-10-01+json: - schema: - $ref: "#/components/schemas/OrgServiceAccount" - x-xgen-version: 2023-10-01 - description: OK - "400": - $ref: "#/components/responses/badRequest" - "401": - $ref: "#/components/responses/unauthorized" - "404": - $ref: "#/components/responses/notFound" - "500": - $ref: "#/components/responses/internalServerError" - security: - - DigestAuth: [] - summary: Service Account Update - tags: - - Organizations - /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/groups: - get: - description: Returns list of Service Account projects. - operationId: listServiceAccountProjects - parameters: - - $ref: "#/components/parameters/orgId" - - description: Id of the service account. - in: path - name: serviceAccountId - required: true - schema: - type: string - - $ref: "#/components/parameters/itemsPerPage" - - $ref: "#/components/parameters/pageNum" - - $ref: "#/components/parameters/pretty" - - $ref: "#/components/parameters/envelope" - responses: - "200": - content: - application/vnd.atlas.2023-10-01+json: - schema: - $ref: "#/components/schemas/PaginatedServiceAccountGroup" - x-xgen-version: 2023-10-01 - description: OK - "401": - $ref: "#/components/responses/unauthorized" - "403": - $ref: "#/components/responses/forbidden" - "500": - $ref: "#/components/responses/internalServerError" - security: - - DigestAuth: [] - summary: Return All Service Account projects - tags: - - Organizations - /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets: - post: - description: Create Service Account secret. - operationId: createServiceAccountSecret - parameters: - - $ref: "#/components/parameters/orgId" - - description: Id of the service account. - in: path - name: serviceAccountId - required: true - schema: - type: string - - $ref: "#/components/parameters/envelope" - - $ref: "#/components/parameters/pretty" - requestBody: - content: - application/vnd.atlas.2023-10-01+json: - schema: - $ref: "#/components/schemas/ServiceAccountSecretRequest" - description: Details to create secret in the specified service account. - required: true - responses: - "201": - content: - application/vnd.atlas.2023-10-01+json: - schema: - $ref: "#/components/schemas/ServiceAccountSecret" - x-xgen-version: 2023-10-01 - description: Created - "400": - $ref: "#/components/responses/badRequest" - "401": - $ref: "#/components/responses/unauthorized" - "500": - $ref: "#/components/responses/internalServerError" - security: - - DigestAuth: [] - summary: Service Account Secret Creation - tags: - - Organizations - /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets/{secretId}: - delete: - description: Delete Service Account Secret. - operationId: deleteServiceAccountSecret - parameters: - - description: Id of the service account. - in: path - name: serviceAccountId - required: true - schema: - type: string - - description: Id of the secret. - in: path - name: secretId - required: true - schema: - type: string - - $ref: "#/components/parameters/orgId" - - $ref: "#/components/parameters/envelope" - - $ref: "#/components/parameters/pretty" - responses: - "204": - content: - application/vnd.atlas.2023-10-01+json: - x-xgen-version: 2023-10-01 - description: This endpoint does not return a response body. - "401": - $ref: "#/components/responses/unauthorized" - "404": - $ref: "#/components/responses/notFound" - "500": - $ref: "#/components/responses/internalServerError" - security: - - DigestAuth: [] - summary: Service Account Secret Deletion. - tags: - - Organizations /api/atlas/v2/orgs/{orgId}/settings: get: description: "Returns details about the specified organization's settings. To\ @@ -15976,6 +15828,8 @@ paths: $ref: "#/components/schemas/OrganizationSettings" x-xgen-version: 2023-01-01 description: OK + "400": + $ref: "#/components/responses/badRequest" "401": $ref: "#/components/responses/unauthorized" "403": @@ -16450,6 +16304,7 @@ paths: - Organizations /api/atlas/v2/orgs/{orgId}/users/{userId}: delete: + deprecated: true description: "Removes one MongoDB Cloud user from the specified organization.\ \ To use this resource, the requesting API Key must have the Organization\ \ User Admin role." @@ -16457,6 +16312,7 @@ paths: parameters: - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/orgId" + - $ref: "#/components/parameters/pretty" - description: Unique 24-hexadecimal digit string that identifies the user to be deleted. in: path @@ -16487,9 +16343,10 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Remove One MongoDB Cloud User from One Organization + summary: Remove One MongoDB Cloud User From One Organization tags: - Organizations + x-sunset: 2026-01-01 /api/atlas/v2/orgs/{orgId}/users/{userId}/roles: put: description: "Updates the roles of the specified user in the specified organization.\ @@ -17294,7 +17151,7 @@ components: description: |- Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. - Change this parameter only if you: + 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). @@ -17370,7 +17227,7 @@ components: You can set different IOPS values on different shards when provisioned IOPS are supported. - Change this parameter only if you: + 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). @@ -17801,6 +17658,31 @@ components: - REPLICASET - SHARDED - GEOSHARDED + configServerManagementMode: + type: string + default: ATLAS_MANAGED + description: |- + Config Server Management Mode for creating or updating a sharded cluster. + + When configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings. + + When configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server. + enum: + - ATLAS_MANAGED + - FIXED_TO_DEDICATED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + configServerType: + type: string + description: Describes a sharded cluster's config server type. + enum: + - DEDICATED + - EMBEDDED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + readOnly: true connectionStrings: $ref: "#/components/schemas/ClusterConnectionStrings" createDate: @@ -17848,6 +17730,15 @@ components: externalDocs: description: Encryption at Rest using Customer Key Management url: https://www.mongodb.com/docs/atlas/security-kms-encryption/ + featureCompatibilityVersion: + type: string + description: Feature compatibility version of the cluster. + readOnly: true + featureCompatibilityVersionExpirationDate: + type: string + format: date-time + description: Feature compatibility version expiration date. + readOnly: true globalClusterSelfManagedSharding: type: boolean description: |- @@ -17898,6 +17789,8 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true + mongoDBEmployeeAccessGrant: + $ref: "#/components/schemas/EmployeeAccessGrantView" mongoDBMajorVersion: type: string description: |- @@ -17919,7 +17812,7 @@ components: description: Human-readable label that identifies the advanced cluster. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" paused: type: boolean description: Flag that indicates whether the cluster is paused. @@ -17930,6 +17823,24 @@ components: externalDocs: description: Continuous Cloud Backups url: https://docs.atlas.mongodb.com/backup/cloud-backup/overview/ + replicaSetScalingStrategy: + type: string + default: WORKLOAD_TYPE + description: |- + Set this field to configure the replica set scaling mode for your cluster. + + By default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes. + + When configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads. + + When configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads. + enum: + - SEQUENTIAL + - WORKLOAD_TYPE + - NODE_TYPE + externalDocs: + description: Modify the Replica Set Scaling Mode + url: https://dochub.mongodb.org/core/scale-nodes replicationSpecs: type: array description: "List of settings that configure your cluster regions. For\ @@ -18808,6 +18719,246 @@ components: description: Atlas Search Index url: https://dochub.mongodb.org/core/index-definitions-fts title: mappings + ApiAtlasInvalidPolicyErrorDetailView: + type: object + properties: + detail: + type: string + description: A string that provides a detailed description of a validation + error. + readOnly: true + ApiAtlasInvalidPolicyView: + type: object + properties: + body: + type: string + description: A string that defines the permissions for the policy. The syntax + used is the Cedar Policy language. + example: |2 + forbid ( + principal, + action == cloud::Action::"cluster.createEdit", + resource + ) when { + context.cluster.regions.contains(cloud::region::"aws:us-east-1") + }; + readOnly: true + errors: + type: array + description: List of validation errors. + items: + $ref: "#/components/schemas/ApiAtlasInvalidPolicyErrorDetailView" + readOnly: true + ApiAtlasInvalidResourcePolicyCreateErrorView: + type: object + properties: + errorType: + type: string + description: Human-readable label that displays the type of an error. + enum: + - POLICY_PARSING_ERROR + - POLICY_HAS_FAILED_VALIDATIONS + - POLICY_HAS_INVALID_PRINCIPAL + - POLICY_HAS_BODY_EXCEEDING_MAX_SIZE + - POLICY_HAS_UNEXPECTED_ENTITIES + invalidPolicies: + type: array + description: List of invalid policies containing details of their validation + errors. + items: + $ref: "#/components/schemas/ApiAtlasInvalidPolicyView" + readOnly: true + ApiAtlasNonCompliantResourceView: + type: object + properties: + orgId: + type: string + description: Unique 24-hexadecimal character string that identifies the + organization the resource belongs to. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + resourceId: + type: string + description: Unique 24-hexadecimal character string that identifies the + non-compliant resource. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + resourcePoliciesCausingNonCompliance: + type: array + description: List of resource policies causing the resource to be considered + non-compliant. + items: + $ref: "#/components/schemas/ApiAtlasResourcePolicyMetadataView" + readOnly: true + resourceType: + type: string + description: Human-readable label that displays the type of a resource. + enum: + - PROJECT + - CLUSTER + readOnly: true + ApiAtlasPolicyCreateView: + type: object + properties: + body: + type: string + description: A string that defines the permissions for the policy. The syntax + used is the Cedar Policy language. + example: |2 + forbid ( + principal, + action == cloud::Action::"cluster.createEdit", + resource + ) when { + context.cluster.regions.contains(cloud::region::"aws:us-east-1") + }; + required: + - body + ApiAtlasPolicyMetadataView: + type: object + properties: + policyId: + type: string + description: Unique 24-hexadecimal character string that identifies the + policy. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + ApiAtlasPolicyView: + type: object + properties: + body: + type: string + description: A string that defines the permissions for the policy. The syntax + used is the Cedar Policy language. + example: |2 + forbid ( + principal, + action == cloud::Action::"cluster.createEdit", + resource + ) when { + context.cluster.regions.contains(cloud::region::"aws:us-east-1") + }; + readOnly: true + id: + type: string + description: Unique 24-hexadecimal character string that identifies the + policy. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + ApiAtlasResourcePolicyCreateView: + type: object + properties: + name: + type: string + description: Human-readable label that describes the atlas resource policy. + policies: + type: array + description: List of policies that make up the atlas resource policy. + items: + $ref: "#/components/schemas/ApiAtlasPolicyCreateView" + required: + - name + - policies + ApiAtlasResourcePolicyEditView: + type: object + properties: + name: + type: string + description: Human-readable label that describes the atlas resource policy. + policies: + type: array + description: List of policies that make up the atlas resource policy. + items: + $ref: "#/components/schemas/ApiAtlasPolicyCreateView" + ApiAtlasResourcePolicyMetadataView: + type: object + properties: + policiesCausingNonCompliance: + type: array + description: List of policies that are in conflict with the current state + of the resource. + items: + $ref: "#/components/schemas/ApiAtlasPolicyMetadataView" + readOnly: true + resourcePolicyId: + type: string + description: Unique 24-hexadecimal character string that identifies the + atlas resource policy. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + resourcePolicyName: + type: string + description: Human-readable label that describes the atlas resource policy. + readOnly: true + ApiAtlasResourcePolicyView: + type: object + properties: + createdByUser: + $ref: "#/components/schemas/ApiAtlasUserMetadataView" + createdDate: + type: string + format: date-time + description: Date and time in UTC when the atlas resource policy was created. + example: 2022-01-01T00:00:00Z + readOnly: true + id: + type: string + description: Unique 24-hexadecimal character string that identifies the + atlas resource policy. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + lastUpdatedByUser: + $ref: "#/components/schemas/ApiAtlasUserMetadataView" + lastUpdatedDate: + type: string + format: date-time + description: Date and time in UTC when the atlas resource policy was last + updated. + example: 2022-01-01T00:00:00Z + readOnly: true + name: + type: string + description: Human-readable label that describes the atlas resource policy. + readOnly: true + orgId: + type: string + description: Unique 24-hexadecimal character string that identifies the + organization the atlas resource policy belongs to. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + policies: + type: array + description: List of policies that make up the atlas resource policy. + items: + $ref: "#/components/schemas/ApiAtlasPolicyView" + readOnly: true + version: + type: string + description: A string that identifies the version of the atlas resource + policy. + example: v1 + readOnly: true ApiAtlasSnapshotScheduleView: type: object properties: @@ -18944,6 +19095,23 @@ components: - snapshotIntervalHours - snapshotRetentionDays - weeklySnapshotRetentionWeeks + ApiAtlasUserMetadataView: + type: object + description: The user that last updated the atlas resource policy. + properties: + id: + type: string + description: Unique 24-hexadecimal character string that identifies a user. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + name: + type: string + description: Human-readable label that describes a user. + readOnly: true + readOnly: true ApiBSONTimestampView: type: object description: BSON timestamp that indicates when the checkpoint token entry in @@ -19000,6 +19168,8 @@ components: ApiError: type: object properties: + badRequestDetail: + $ref: "#/components/schemas/BadRequestDetail" detail: type: string description: Describes the specific conditions or reasons that cause each @@ -19010,17 +19180,25 @@ components: description: HTTP status code returned with this error. externalDocs: url: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status + readOnly: true 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. items: type: object + readOnly: true + readOnly: true reason: type: string description: Application error message returned with this error. + readOnly: true + required: + - error + - errorCode ApiHostView_Atlas: type: object properties: @@ -19309,6 +19487,23 @@ components: \ and **period** in the same request. This parameter expresses its value\ \ in the ISO 8601 timestamp format in UTC." readOnly: true + ApiPrivateDownloadDeliveryUrl: + type: object + description: One Uniform Resource Locator (URL) that points to the compressed + snapshot files for manual download and the corresponding private endpoint. + properties: + deliveryUrl: + type: string + description: One Uniform Resource Locator that points to the compressed + snapshot files for manual download. + endpointId: + type: string + description: Unique 22-character alphanumeric string that identifies the + private endpoint. + example: vpce-3bf78b0ddee411ba1 + maxLength: 22 + minLength: 22 + pattern: "^vpce-[0-9a-f]{17}$" ApiPublicUsageDetailsQueryRequest: type: object description: "Request body for an Invoice Usage Details query with filtering,\ @@ -19420,7 +19615,23 @@ components: type: string description: Atlas Streams AWS Regions. enum: + - SYDNEY_AUS + - MUMBAI_IND + - FRANKFURT_DEU + - DUBLIN_IRL + - LONDON_GBR - VIRGINIA_USA + - OREGON_USA + - SAOPAULO_BRA + - MONTREAL_CAN + - TOKYO_JPN + - SINGAPORE_SGP + ApiStreamsAzureRegionView: + type: string + description: Atlas Streams Azure Regions. + enum: + - VIRGINIA_USA + - AMSTERDAM_NLD ApiUserEventTypeViewForNdsGroup: type: string description: Unique identifier of event type. @@ -19667,6 +19878,12 @@ components: - eventTypeName - id title: API User Events + ApiVersion: + type: object + properties: + version: + type: string + description: Object representing a version of the Atlas Admin API. AppServiceAlertConfigViewForNdsGroup: type: object description: App Services metric alert configuration allows to select which @@ -20148,7 +20365,12 @@ components: enum: - AVERAGE operator: - $ref: "#/components/schemas/Operator" + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - LESS_THAN + - GREATER_THAN threshold: type: number format: double @@ -20226,6 +20448,12 @@ components: enum: - VIRGINIA_USA - AMSTERDAM_NLD + AtlasDataFederationGCPRegion: + type: string + description: Atlas Data Federation GCP Regions. + enum: + - IOWA_USA + - BELGIUM_EU AtlasOrganization: type: object description: Details that describe the organization. @@ -20261,6 +20489,128 @@ components: pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" required: - name + AtlasResourcePolicyAuditForOrg: + type: object + description: Atlas resource policy audits indicate org level changes to resource + policies + properties: + apiKeyId: + type: string + description: "Unique 24-hexadecimal digit string that identifies the [API\ + \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\ + \ triggered the event. If this resource returns this parameter, it doesn't\ + \ return the **userId** parameter." + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + created: + type: string + format: date-time + description: Date and time when this event occurred. This parameter expresses + its value in the ISO 8601 timestamp format in UTC. + readOnly: true + eventTypeName: + type: string + description: Unique identifier of event type. + enum: + - RESOURCE_POLICY_CREATED + - RESOURCE_POLICY_MODIFIED + - RESOURCE_POLICY_DELETED + example: RESOURCE_POLICY_CREATED + title: Atlas Resource Policy Audit Types + groupId: + type: string + description: Unique 24-hexadecimal digit string that identifies the project + in which the event occurred. The **eventId** identifies the specific event. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + id: + type: string + description: Unique 24-hexadecimal digit string that identifies the event. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + isGlobalAdmin: + type: boolean + default: false + description: Flag that indicates whether a MongoDB employee triggered the + specified event. + readOnly: true + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + orgId: + type: string + description: Unique 24-hexadecimal digit string that identifies the organization + to which these events apply. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + publicKey: + type: string + format: email + description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\ + \ that triggered the event. If this resource returns this parameter, it\ + \ doesn't return the **username** parameter." + readOnly: true + raw: + $ref: "#/components/schemas/raw" + remoteAddress: + type: string + description: IPv4 or IPv6 address from which the user triggered this event. + example: 216.172.40.186 + pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + readOnly: true + resourcePolicyId: + type: string + description: Unique 24-hexadecimal character string that identifies the + resource policy. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + userId: + type: string + description: "Unique 24-hexadecimal digit string that identifies the console\ + \ user who triggered the event. If this resource returns this parameter,\ + \ it doesn't return the **apiKeyId** parameter." + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + username: + type: string + format: email + description: "Email address for the user who triggered this event. If this\ + \ resource returns this parameter, it doesn't return the **publicApiKey**\ + \ parameter." + example: test.user@mongodb.com + readOnly: true + required: + - created + - eventTypeName + - id + title: Atlas Resource Policy Audits AtlasSearchAnalyzer: type: object properties: @@ -20982,6 +21332,21 @@ components: AzureHardwareSpec: type: object properties: + diskIOPS: + type: integer + format: int32 + description: |- + Target throughput desired for storage attached to your Azure-provisioned cluster. Change this parameter if you: + + - set `"replicationSpecs[n].regionConfigs[m].providerName" : "Azure"`. + - set `"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize" : "M40"` or greater not including `Mxx_NVME` tiers. + + The maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**. + This parameter defaults to the cluster tier's standard IOPS value. + Changing this value impacts cluster cost. + externalDocs: + description: Programmatic API Keys + url: https://www.mongodb.com/docs/atlas/customize-storage/#extend-iops-on-azure instanceSize: type: string description: Hardware specification for the instance sizes in this region. @@ -21019,6 +21384,21 @@ components: AzureHardwareSpec20240805: type: object properties: + diskIOPS: + type: integer + format: int32 + description: |- + Target throughput desired for storage attached to your Azure-provisioned cluster. Change this parameter if you: + + - set `"replicationSpecs[n].regionConfigs[m].providerName" : "Azure"`. + - set `"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize" : "M40"` or greater not including `Mxx_NVME` tiers. + + The maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**. + This parameter defaults to the cluster tier's standard IOPS value. + Changing this value impacts cluster cost. + externalDocs: + description: Programmatic API Keys + url: https://www.mongodb.com/docs/atlas/customize-storage/#extend-iops-on-azure diskSizeGB: type: number format: double @@ -21234,6 +21614,8 @@ components: - PENDING_ACCEPTANCE - ACTIVE - FAILED + - PENDING_RECREATION + - DELETING readOnly: true title: Azure Key Vault EAR Private Endpoint AzureNetworkPeeringConnectionSettings: @@ -21668,7 +22050,7 @@ components: the collection for which you want to create an online archive. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true collName: type: string @@ -21780,7 +22162,7 @@ components: the collection for which you want to create an online archive. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true collName: type: string @@ -21919,7 +22301,7 @@ components: the snapshots you want to retrieve. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -22132,7 +22514,7 @@ components: To return a response with the **clusterId** parameter, either use the **delivery.targetClusterName** parameter or enable backup on the target cluster. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" targetGroupId: type: string description: "Unique 24-hexadecimal digit string that identifies the project\ @@ -22404,12 +22786,23 @@ components: - FAILED - COMPLETED readOnly: true + BadRequestDetail: + type: object + description: Bad request detail. + properties: + fields: + type: array + description: Describes all violations in a client request. + items: + $ref: "#/components/schemas/FieldViolation" + readOnly: true BaseAtlasDataLakeRegion: type: object description: Name of the region to which the data lake routes client connections. oneOf: - $ref: "#/components/schemas/ApiAtlasDataLakeAWSRegionView" - $ref: "#/components/schemas/AtlasDataFederationAzureRegion" + - $ref: "#/components/schemas/AtlasDataFederationGCPRegion" BaseCloudProviderInstanceSize: type: object description: "Minimum instance size to which your cluster can automatically\ @@ -22537,6 +22930,7 @@ components: description: Name of the cloud provider region hosting Atlas Stream Processing. oneOf: - $ref: "#/components/schemas/ApiStreamsAWSRegionView" + - $ref: "#/components/schemas/ApiStreamsAzureRegionView" BasicBSONList: type: array description: "List that contains the search criteria that the query uses. To\ @@ -23624,7 +24018,7 @@ components: description: Human-readable label that identifies the cluster. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true nodeCount: type: integer @@ -23685,6 +24079,10 @@ components: 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. + description: + type: string + description: Description of this database user. + maxLength: 100 groupId: type: string description: Unique 24-hexadecimal digit string that identifies the project. @@ -23952,6 +24350,127 @@ components: (AWS) Identity and Access Management (IAM) role. required: - providerName + CloudProviderAccessAWSIAMRoleRequest: + type: object + description: Details that describe the features linked to the Amazon Web Services + (AWS) Identity and Access Management (IAM) role. + properties: + atlasAWSAccountArn: + 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. + example: arn:aws:iam::772401394250:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + readOnly: true + atlasAssumedRoleExternalId: + type: string + format: uuid + description: Unique external ID that MongoDB Cloud uses when it assumes + the IAM role in your Amazon Web Services (AWS) account. + readOnly: true + authorizedDate: + type: string + format: date-time + 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. + readOnly: true + createdDate: + type: string + format: date-time + 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. + readOnly: true + featureUsages: + type: array + description: List that contains application features associated with this + Amazon Web Services (AWS) Identity and Access Management (IAM) role. + items: + $ref: "#/components/schemas/CloudProviderAccessFeatureUsage" + readOnly: true + providerName: + type: string + description: Human-readable label that identifies the cloud provider of + the role. + enum: + - AWS + - AZURE + - GCP + roleId: + type: string + description: Unique 24-hexadecimal digit string that identifies the role. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + required: + - providerName + CloudProviderAccessAWSIAMRoleRequestUpdate: + type: object + allOf: + - $ref: "#/components/schemas/CloudProviderAccessRoleRequestUpdate" + - type: object + properties: + atlasAWSAccountArn: + 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. + example: arn:aws:iam::772401394250:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + readOnly: true + atlasAssumedRoleExternalId: + type: string + format: uuid + description: Unique external ID that MongoDB Cloud uses when it assumes + the IAM role in your Amazon Web Services (AWS) account. + readOnly: true + authorizedDate: + type: string + format: date-time + 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. + readOnly: true + createdDate: + type: string + format: date-time + 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. + readOnly: true + featureUsages: + type: array + description: List that contains application features associated with this + Amazon Web Services (AWS) Identity and Access Management (IAM) role. + items: + $ref: "#/components/schemas/CloudProviderAccessFeatureUsage" + readOnly: true + iamAssumedRoleArn: + 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 + maxLength: 2048 + minLength: 20 + roleId: + type: string + description: Unique 24-hexadecimal digit string that identifies the role. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + description: Details that describe the features linked to the Amazon Web Services + (AWS) Identity and Access Management (IAM) role. + required: + - providerName CloudProviderAccessAzureServicePrincipal: type: object allOf: @@ -24013,6 +24532,133 @@ components: Principal. required: - providerName + CloudProviderAccessAzureServicePrincipalRequest: + type: object + description: Details that describe the features linked to the Azure Service + Principal. + properties: + _id: + type: string + description: Unique 24-hexadecimal digit string that identifies the role. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + atlasAzureAppId: + type: string + description: Azure Active Directory Application ID of Atlas. + maxLength: 36 + minLength: 32 + pattern: "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\\ + b-[0-9a-fA-F]{12}$" + createdDate: + type: string + format: date-time + description: Date and time when this Azure Service Principal was created. + This parameter expresses its value in the ISO 8601 timestamp format in + UTC. + readOnly: true + featureUsages: + type: array + description: List that contains application features associated with this + Azure Service Principal. + items: + $ref: "#/components/schemas/CloudProviderAccessFeatureUsage" + readOnly: true + lastUpdatedDate: + type: string + format: date-time + 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. + 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. + maxLength: 36 + minLength: 32 + pattern: "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\\ + b-[0-9a-fA-F]{12}$" + tenantId: + type: string + description: UUID String that identifies the Azure Active Directory Tenant + ID. + maxLength: 36 + minLength: 32 + pattern: "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\\ + b-[0-9a-fA-F]{12}$" + required: + - providerName + CloudProviderAccessAzureServicePrincipalRequestUpdate: + type: object + allOf: + - $ref: "#/components/schemas/CloudProviderAccessRoleRequestUpdate" + - type: object + properties: + _id: + type: string + description: Unique 24-hexadecimal digit string that identifies the role. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + atlasAzureAppId: + type: string + description: Azure Active Directory Application ID of Atlas. + maxLength: 36 + minLength: 32 + pattern: "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\\ + b-[0-9a-fA-F]{12}$" + createdDate: + type: string + format: date-time + description: Date and time when this Azure Service Principal was created. + This parameter expresses its value in the ISO 8601 timestamp format + in UTC. + readOnly: true + featureUsages: + type: array + description: List that contains application features associated with this + Azure Service Principal. + items: + $ref: "#/components/schemas/CloudProviderAccessFeatureUsage" + readOnly: true + lastUpdatedDate: + type: string + format: date-time + 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. + readOnly: true + servicePrincipalId: + type: string + description: UUID string that identifies the Azure Service Principal. + maxLength: 36 + minLength: 32 + pattern: "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\\ + b-[0-9a-fA-F]{12}$" + tenantId: + type: string + description: UUID String that identifies the Azure Active Directory Tenant + ID. + maxLength: 36 + minLength: 32 + pattern: "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\\ + b-[0-9a-fA-F]{12}$" + description: Details that describe the features linked to the Azure Service + Principal. + required: + - providerName CloudProviderAccessDataLakeFeatureUsage: type: object allOf: @@ -24125,6 +24771,85 @@ components: minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true + CloudProviderAccessGCPServiceAccount: + type: object + allOf: + - $ref: "#/components/schemas/CloudProviderAccessRole" + - type: object + properties: + createdDate: + type: string + format: date-time + description: Date and time when this Google Service Account was created. + This parameter expresses its value in the ISO 8601 timestamp format + in UTC. + readOnly: true + featureUsages: + type: array + description: List that contains application features associated with this + Google Service Account. + items: + $ref: "#/components/schemas/CloudProviderAccessFeatureUsage" + readOnly: true + gcpServiceAccountForAtlas: + type: string + description: Email address for the Google Service Account created by Atlas. + maxLength: 82 + minLength: 57 + pattern: "^mongodb-atlas-[0-9a-z]{16}@p-[0-9a-z]{24}.iam.gserviceaccount.com$" + roleId: + type: string + description: Unique 24-hexadecimal digit string that identifies the role. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + description: Details that describe the features linked to the GCP Service Account. + required: + - providerName + CloudProviderAccessGCPServiceAccountRequest: + type: object + description: Details that describe the features linked to the GCP Service Account. + properties: + createdDate: + type: string + format: date-time + description: Date and time when this GCP Service Account was created. This + parameter expresses its value in the ISO 8601 timestamp format in UTC. + readOnly: true + featureUsages: + type: array + description: List that contains application features associated with this + GCP Service Account. + items: + $ref: "#/components/schemas/CloudProviderAccessFeatureUsage" + readOnly: true + 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: + type: string + description: Unique 24-hexadecimal digit string that identifies the role. + readOnly: true + required: + - providerName + CloudProviderAccessGCPServiceAccountRequestUpdate: + type: object + allOf: + - $ref: "#/components/schemas/CloudProviderAccessRoleRequestUpdate" + description: Details that describe the features linked to the GCP Service Account. + required: + - providerName CloudProviderAccessPushBasedLogExportFeatureUsage: type: object allOf: @@ -24143,10 +24868,52 @@ components: mapping: AWS: "#/components/schemas/CloudProviderAccessAWSIAMRole" AZURE: "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + GCP: "#/components/schemas/CloudProviderAccessGCPServiceAccount" + propertyName: providerName + properties: + providerName: + type: string + description: Human-readable label that identifies the cloud provider of + the role. + enum: + - AWS + - AZURE + - GCP + required: + - providerName + CloudProviderAccessRoleRequest: + type: object + description: Cloud provider access role. + discriminator: + mapping: + AWS: "#/components/schemas/CloudProviderAccessAWSIAMRoleRequest" + AZURE: "#/components/schemas/CloudProviderAccessAzureServicePrincipalRequest" + GCP: "#/components/schemas/CloudProviderAccessGCPServiceAccountRequest" propertyName: providerName oneOf: - - $ref: "#/components/schemas/CloudProviderAccessAWSIAMRole" - - $ref: "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + - $ref: "#/components/schemas/CloudProviderAccessAWSIAMRoleRequest" + - $ref: "#/components/schemas/CloudProviderAccessAzureServicePrincipalRequest" + - $ref: "#/components/schemas/CloudProviderAccessGCPServiceAccountRequest" + properties: + providerName: + type: string + description: Human-readable label that identifies the cloud provider of + the role. + enum: + - AWS + - AZURE + - GCP + required: + - providerName + CloudProviderAccessRoleRequestUpdate: + type: object + description: Cloud provider access role. + discriminator: + mapping: + AWS: "#/components/schemas/CloudProviderAccessAWSIAMRoleRequestUpdate" + AZURE: "#/components/schemas/CloudProviderAccessAzureServicePrincipalRequestUpdate" + GCP: "#/components/schemas/CloudProviderAccessGCPServiceAccountRequestUpdate" + propertyName: providerName properties: providerName: type: string @@ -24155,6 +24922,7 @@ components: enum: - AWS - AZURE + - GCP required: - providerName CloudProviderAccessRoles: @@ -24166,6 +24934,12 @@ components: registered and authorized with MongoDB Cloud. items: $ref: "#/components/schemas/CloudProviderAccessAWSIAMRole" + azureServicePrincipals: + type: array + description: List that contains the Azure Service Principals registered + with MongoDB Cloud. + items: + $ref: "#/components/schemas/CloudProviderAccessAzureServicePrincipal" CloudProviderAzureAutoScaling: type: object description: Range of instance sizes to which your cluster can scale. @@ -24834,7 +25608,7 @@ components: example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -24938,6 +25712,7 @@ components: $ref: "#/components/schemas/ClusterComputeAutoScaling" diskGBEnabled: type: boolean + default: false description: Flag that indicates whether someone enabled disk auto-scaling for this cluster. title: Automatic Cluster Scaling Settings @@ -24964,12 +25739,14 @@ components: properties: enabled: type: boolean + default: false description: "Flag that indicates whether cluster tier auto-scaling is enabled.\ \ Set to `true` to enable cluster tier auto-scaling. If enabled, you must\ \ specify a value for **providerSettings.autoScaling.compute.maxInstanceSize**\ \ also. Set to `false` to disable cluster tier auto-scaling." scaleDownEnabled: type: boolean + default: false description: "Flag that indicates whether the cluster tier can scale down.\ \ This is required if **autoScaling.compute.enabled** is `true`. If you\ \ enable this option, specify a value for **providerSettings.autoScaling.compute.minInstanceSize**." @@ -25007,20 +25784,28 @@ components: 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. + description: "Private endpoint-aware connection strings that use AWS-hosted\ + \ clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies\ + \ an Amazon Web Services (AWS) interface endpoint. Each value identifies\ + \ the related `mongodb://` connection string that you use to connect\ + \ to Atlas through the interface endpoint that the key names. If the\ + \ cluster uses an optimized connection string, `awsPrivateLinkSrv` contains\ + \ the optimized connection string. If the cluster has the non-optimized\ + \ (legacy) connection string, `awsPrivateLinkSrv` contains the non-optimized\ + \ connection string even if an optimized connection string is also present." externalDocs: description: Network Peering Connection url: https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/ readOnly: true - 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. + description: "Private endpoint-aware connection strings that use AWS-hosted\ + \ clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies\ + \ an Amazon Web Services (AWS) interface endpoint. Each value identifies\ + \ the related `mongodb://` connection string that you use to connect to\ + \ Atlas through the interface endpoint that the key names. If the cluster\ + \ uses an optimized connection string, `awsPrivateLinkSrv` contains the\ + \ optimized connection string. If the cluster has the non-optimized (legacy)\ + \ connection string, `awsPrivateLinkSrv` contains the non-optimized connection\ + \ string even if an optimized connection string is also present." externalDocs: description: Network Peering Connection url: https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/ @@ -25122,6 +25907,31 @@ components: - REPLICASET - SHARDED - GEOSHARDED + configServerManagementMode: + type: string + default: ATLAS_MANAGED + description: |- + Config Server Management Mode for creating or updating a sharded cluster. + + When configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings. + + When configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server. + enum: + - ATLAS_MANAGED + - FIXED_TO_DEDICATED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + configServerType: + type: string + description: Describes a sharded cluster's config server type. + enum: + - DEDICATED + - EMBEDDED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + readOnly: true connectionStrings: $ref: "#/components/schemas/ClusterConnectionStrings" createDate: @@ -25155,6 +25965,15 @@ components: externalDocs: description: Encryption at Rest using Customer Key Management url: https://www.mongodb.com/docs/atlas/security-kms-encryption/ + featureCompatibilityVersion: + type: string + description: Feature compatibility version of the cluster. + readOnly: true + featureCompatibilityVersionExpirationDate: + type: string + format: date-time + description: Feature compatibility version expiration date. + readOnly: true globalClusterSelfManagedSharding: type: boolean description: |- @@ -25205,6 +26024,8 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true + mongoDBEmployeeAccessGrant: + $ref: "#/components/schemas/EmployeeAccessGrantView" mongoDBMajorVersion: type: string description: |- @@ -25226,7 +26047,7 @@ components: description: Human-readable label that identifies the cluster. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" paused: type: boolean description: Flag that indicates whether the cluster is paused. @@ -25237,6 +26058,35 @@ components: externalDocs: description: Continuous Cloud Backups url: https://docs.atlas.mongodb.com/backup/cloud-backup/overview/ + redactClientLogData: + type: boolean + description: Enable or disable log redaction. + externalDocs: + description: |- + This options corresponds to the ``security.redactClientLogData`` cluster parameter. + + This setting configures the ``mongod`` or ``mongos`` to redact any message accompanying a given log event before logging. This prevents the program from writing potentially sensitive data stored on the database to the diagnostic log. Metadata such as error or operation codes, line numbers, and source file names are still visible in the logs. + + Use ``redactClientLogData`` in conjunction with Encryption at Rest and TLS/SSL (Transport Encryption) to assist compliance with regulatory requirements. + url: https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.redactClientLogData + replicaSetScalingStrategy: + type: string + default: WORKLOAD_TYPE + description: |- + Set this field to configure the replica set scaling mode for your cluster. + + By default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes. + + When configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads. + + When configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads. + enum: + - SEQUENTIAL + - WORKLOAD_TYPE + - NODE_TYPE + externalDocs: + description: Modify the Replica Set Scaling Mode + url: https://dochub.mongodb.org/core/scale-nodes replicationSpecs: type: array description: List of settings that configure your cluster regions. This @@ -25362,6 +26212,24 @@ components: ClusterDescriptionProcessArgs: type: object properties: + changeStreamOptionsPreAndPostImagesExpireAfterSeconds: + type: integer + format: int32 + default: -1 + description: The minimum pre- and post-image retention time in seconds. + externalDocs: + description: "This option corresponds to the ``changeStreamOptions.preAndPostImages.expireAfterSeconds``\ + \ cluster parameter. This setting controls the retention policy of change\ + \ stream pre- and post-images. Pre- and post-images are the versions\ + \ of a document before and after document modification, respectively.\ + \ ``expireAfterSeconds`` controls how long MongoDB retains pre- and\ + \ post-images. When set to -1 (off), MongoDB uses the default retention\ + \ policy: pre- and post-images are retained until the corresponding\ + \ change stream events are removed from the oplog. To set the minimum\ + \ pre- and post-image retention time, specify an integer value greater\ + \ than zero. Setting this too low could increase the risk of interrupting\ + \ Realm sync or triggers processing. The default value is -1 (off)." + url: https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/changeStreamOptions/#mongodb-parameter-param.changeStreamOptions.preAndPostImages.expireAfterSeconds chunkMigrationConcurrency: type: integer format: int32 @@ -25372,6 +26240,14 @@ components: description: This option corresponds to the `chunkMigrationConcurrency` `mongod` configuration file option. url: https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.chunkMigrationConcurrency + defaultMaxTimeMS: + type: integer + format: int32 + description: Default time limit in milliseconds for individual read operations + to complete. + externalDocs: + description: This option corresponds to the defaultMaxTimeMS cluster parameter. + url: https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/defaultMaxTimeMS/ defaultReadConcern: type: string default: available @@ -25408,8 +26284,10 @@ components: url: https://docs.mongodb.com/upcoming/reference/parameters/#mongodb-parameter-param.failIndexKeyTooLong javascriptEnabled: type: boolean - description: Flag that indicates whether the cluster allows execution of - operations that perform server-side executions of JavaScript. + 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. @@ -25502,6 +26380,24 @@ components: ClusterDescriptionProcessArgs20240805: type: object properties: + changeStreamOptionsPreAndPostImagesExpireAfterSeconds: + type: integer + format: int32 + default: -1 + description: The minimum pre- and post-image retention time in seconds. + externalDocs: + description: "This option corresponds to the ``changeStreamOptions.preAndPostImages.expireAfterSeconds``\ + \ cluster parameter. This setting controls the retention policy of change\ + \ stream pre- and post-images. Pre- and post-images are the versions\ + \ of a document before and after document modification, respectively.\ + \ ``expireAfterSeconds`` controls how long MongoDB retains pre- and\ + \ post-images. When set to -1 (off), MongoDB uses the default retention\ + \ policy: pre- and post-images are retained until the corresponding\ + \ change stream events are removed from the oplog. To set the minimum\ + \ pre- and post-image retention time, specify an integer value greater\ + \ than zero. Setting this too low could increase the risk of interrupting\ + \ Realm sync or triggers processing. The default value is -1 (off)." + url: https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/changeStreamOptions/#mongodb-parameter-param.changeStreamOptions.preAndPostImages.expireAfterSeconds chunkMigrationConcurrency: type: integer format: int32 @@ -25512,6 +26408,14 @@ components: description: This option corresponds to the `chunkMigrationConcurrency` `mongod` configuration file option. url: https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.chunkMigrationConcurrency + defaultMaxTimeMS: + type: integer + format: int32 + description: Default time limit in milliseconds for individual read operations + to complete. + externalDocs: + description: This option corresponds to the defaultMaxTimeMS cluster parameter. + url: https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/defaultMaxTimeMS/ defaultWriteConcern: type: string description: Default level of acknowledgment requested from MongoDB for @@ -25522,8 +26426,10 @@ components: url: https://docs.mongodb.com/manual/reference/write-concern/ javascriptEnabled: type: boolean - description: Flag that indicates whether the cluster allows execution of - operations that perform server-side executions of JavaScript. + 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. @@ -25808,7 +26714,7 @@ components: outage simulation. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true groupId: type: string @@ -26623,6 +27529,7 @@ components: mapping: AWS: "#/components/schemas/AWSCreateDataProcessRegionView" AZURE: "#/components/schemas/AzureCreateDataProcessRegionView" + GCP: "#/components/schemas/GCPCreateDataProcessRegionView" propertyName: cloudProvider properties: cloudProvider: @@ -27105,11 +28012,11 @@ components: roleId: type: string description: Unique identifier of the role that Data Federation can use - to access the data stores.Required if specifying cloudProviderConfig. + to access the data stores. Required if specifying cloudProviderConfig. servicePrincipalId: type: string description: The ID of the Service Principal for which there is an access - policyfor Atlas to access Azure resources. + policy for Atlas to access Azure resources. readOnly: true tenantId: type: string @@ -27118,6 +28025,22 @@ components: readOnly: true required: - roleId + DataFederationGCPCloudProviderConfig: + type: object + description: Configuration for running Data Federation in GCP. + 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: + type: string + description: Unique identifier of the role that Data Federation can use + to access the data stores. Required if specifying cloudProviderConfig. + required: + - roleId DataFederationLimit: type: object description: Details of user managed limits. @@ -27125,6 +28048,7 @@ components: mapping: atlas.project.deployment.clusters: "#/components/schemas/DefaultLimit" atlas.project.deployment.nodesPerPrivateLinkRegion: "#/components/schemas/DefaultLimit" + atlas.project.deployment.salesSoldM0s: "#/components/schemas/DefaultLimit" atlas.project.deployment.serverlessMTMs: "#/components/schemas/DefaultLimit" atlas.project.security.databaseAccess.customRoles: "#/components/schemas/DefaultLimit" atlas.project.security.databaseAccess.users: "#/components/schemas/DefaultLimit" @@ -27495,7 +28419,9 @@ components: $ref: "#/components/schemas/DataLakeAWSCloudProviderConfig" azure: $ref: "#/components/schemas/DataFederationAzureCloudProviderConfig" - title: Data Lake Cloud Provider + gcp: + $ref: "#/components/schemas/DataFederationGCPCloudProviderConfig" + title: Data Federation Cloud Provider DataLakeDLSAWSStore: type: object allOf: @@ -27620,6 +28546,7 @@ components: enum: - AWS - AZURE + - GCP region: $ref: "#/components/schemas/BaseAtlasDataLakeRegion" required: @@ -28096,7 +29023,7 @@ components: example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -28355,7 +29282,12 @@ components: enum: - AVERAGE operator: - $ref: "#/components/schemas/Operator" + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - LESS_THAN + - GREATER_THAN threshold: type: number format: double @@ -28403,6 +29335,7 @@ components: mapping: AWS: "#/components/schemas/AWSDataProcessRegionView" AZURE: "#/components/schemas/AzureDataProcessRegionView" + GCP: "#/components/schemas/GCPDataProcessRegionView" propertyName: cloudProvider properties: cloudProvider: @@ -28412,6 +29345,7 @@ components: enum: - AWS - AZURE + - GCP readOnly: true readOnly: true DataProtectionSettings: @@ -28703,6 +29637,8 @@ components: - SQL_SET_SCHEMA - VIEW_ALL_HISTORY - OUT_TO_S3 + - OUT_TO_AZURE + - OUT_TO_GCS - STORAGE_GET_CONFIG - STORAGE_SET_CONFIG - FLUSH_ROUTER_CONFIG @@ -29062,6 +29998,7 @@ components: - FTS_INDEX_BUILD_COMPLETE - FTS_INDEX_BUILD_FAILED - FTS_INDEXES_RESTORE_FAILED + - FTS_INDEXES_SYNONYM_MAPPING_INVALID title: FTS Index Audit Types - type: string enum: @@ -29262,6 +30199,7 @@ components: - FTS_INDEX_BUILD_COMPLETE - FTS_INDEX_BUILD_FAILED - FTS_INDEXES_RESTORE_FAILED + - FTS_INDEXES_SYNONYM_MAPPING_INVALID title: FTS Index Audit Types - type: string enum: @@ -29717,11 +30655,14 @@ components: - CLUSTER_VERSION_UNFIXED - CLUSTER_FCV_FIXED - CLUSTER_FCV_UNFIXED + - CLUSTER_FCV_EXPIRATION_DATE_UPDATED - AGENT_VERSION_FIXED - AGENT_VERSION_UNFIXED - FIXED_VERSION_UPDATED - FIXED_AGENT_VERSION_UPDATED - CLUSTER_FCV_DOWNGRADED + - CLUSTER_BINARY_VERSION_DOWNGRADED + - CLUSTER_BINARY_VERSION_UPGRADED title: Version Audit Types groupId: type: string @@ -30109,7 +31050,6 @@ components: pattern: "^([a-f0-9]{24})$" hostnameSchemaType: type: string - default: PUBLIC description: The network type to use between the migration host and the destination cluster. enum: @@ -30310,30 +31250,19 @@ components: createdAt: type: string format: date-time - description: Date and time when someone created this export job. MongoDB - Cloud represents this timestamp in ISO 8601 format in UTC. + description: Date and time when a user or Atlas created the Export Job. + MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. readOnly: true customData: type: array description: Collection of key-value pairs that represent custom data for - the metadata file that MongoDB Cloud uploads to the bucket when the export - job finishes. + the metadata file that MongoDB Cloud uploads when the Export Job finishes. items: $ref: "#/components/schemas/BackupLabel" - 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\"`." - items: - type: string - description: One Uniform Resource Locator that point to the compressed - snapshot files for manual download. - readOnly: true exportBucketId: type: string description: Unique 24-hexadecimal character string that identifies the - Export Bucket to export to. + Export Bucket. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 @@ -30344,7 +31273,7 @@ components: finishedAt: type: string format: date-time - description: Date and time when this export job completed. MongoDB Cloud + description: Date and time when this Export Job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. readOnly: true id: @@ -30369,8 +31298,8 @@ components: readOnly: true prefix: type: string - description: Full path on the cloud provider bucket to the folder where - the snapshot is exported. + description: Prefix used for all blob storage objects uploaded as part of + the Export Job. pattern: "/exported_snapshots/\\{ORG-NAME\\}/\\{PROJECT-NAME\\}/\\{CLUSTER-NAME\\\ }/\\{SNAPSHOT-INITIATION-DATE\\}/\\{TIMESTAMP\\}" readOnly: true @@ -30384,7 +31313,7 @@ components: pattern: "^([a-f0-9]{24})$" state: type: string - description: State of the export job. + description: State of the Export Job. enum: - Cancelled - Failed @@ -30407,7 +31336,7 @@ components: exportBucketId: type: string description: Unique 24-hexadecimal character string that identifies the - Export Bucket to export to. + Export Bucket. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 @@ -30614,10 +31543,19 @@ components: properties: downloadUrl: type: string - description: "One Uniform Resource Locator that point to the compressed\ + 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." + items: + $ref: "#/components/schemas/ApiPrivateDownloadDeliveryUrl" + readOnly: true replicaSetName: type: string description: Human-readable label that identifies the replica set on the @@ -31069,7 +32007,7 @@ components: \ this parameter when `\"deliveryType\" : \"download\"`." items: type: string - description: One Uniform Resource Locator that point to the compressed + description: One Uniform Resource Locator that points to the compressed snapshot files for manual download. readOnly: true desiredTimestamp: @@ -31141,6 +32079,15 @@ components: \ when `\"deliveryType\" : \"pointInTime\"` and **pointInTimeUTCSeconds**\ \ exceeds `0`." minimum: 1199145600 + 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." + items: + $ref: "#/components/schemas/ApiPrivateDownloadDeliveryUrl" + readOnly: true snapshotId: type: string description: Unique 24-hexadecimal character string that identifies the @@ -31157,7 +32104,7 @@ components: and `pointInTime` restore types. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" targetGroupId: type: string description: Unique 24-hexadecimal digit string that identifies the target @@ -31198,7 +32145,7 @@ components: you want to return. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true copySettings: type: array @@ -31292,7 +32239,7 @@ components: you want to return. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true copySettings: type: array @@ -31378,8 +32325,12 @@ components: additionalProperties: type: object description: The stats associated with the stream processor. + externalDocs: + url: https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor readOnly: true description: The stats associated with the stream processor. + externalDocs: + url: https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor readOnly: true EARPrivateEndpoint: type: object @@ -31474,6 +32425,8 @@ components: - PENDING_ACCEPTANCE - ACTIVE - FAILED + - PENDING_RECREATION + - DELETING readOnly: true title: Encryption At Rest Private Endpoint EmailNotification: @@ -31520,6 +32473,36 @@ components: required: - typeName title: Email Notification + EmployeeAccessGrantView: + type: object + description: MongoDB employee granted access level and expiration for a cluster. + properties: + expirationTime: + type: string + format: date-time + description: Expiration date for the employee access grant. + 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." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + readOnly: true + required: + - expirationTime + - grantType EncryptionAtRest: type: object properties: @@ -31529,24 +32512,6 @@ components: $ref: "#/components/schemas/AzureKeyVault" googleCloudKms: $ref: "#/components/schemas/GoogleCloudKMS" - EncryptionAtRestPrivateEndpointRequest: - type: object - description: Create or delete private endpoints from the specified regions list. - properties: - cloudProvider: - type: string - description: Cloud service provider name. - enum: - - AZURE - regions: - type: array - description: List of regions. - items: - type: string - uniqueItems: true - required: - - cloudProvider - title: Encryption At Rest Private Endpoints setup. EncryptionKeyAlertConfigViewForNdsGroup: type: object description: Encryption key alert configuration allows to select thresholds which @@ -31893,6 +32858,7 @@ components: - FTS_INDEX_CLEANED_UP - FTS_INDEXES_RESTORED - FTS_INDEXES_RESTORE_FAILED + - FTS_INDEXES_SYNONYM_MAPPING_INVALID title: FTS Index Audit Types - type: string enum: @@ -31946,6 +32912,8 @@ components: - HOST_HAS_INDEX_SUGGESTIONS - HOST_MONGOT_RECOVERED_OOM - HOST_MONGOT_CRASHING_OOM + - HOST_MONGOT_RESUME_REPLICATION + - HOST_MONGOT_STOP_REPLICATION - HOST_ENOUGH_DISK_SPACE - HOST_NOT_ENOUGH_DISK_SPACE title: Host Event Types @@ -31983,6 +32951,7 @@ components: - 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 @@ -32060,6 +33029,8 @@ components: - 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 @@ -32089,6 +33060,9 @@ components: - 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 @@ -32147,9 +33121,13 @@ components: - 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 title: NDS Audit Types - type: string enum: @@ -32346,11 +33324,14 @@ components: - CLUSTER_VERSION_UNFIXED - CLUSTER_FCV_FIXED - CLUSTER_FCV_UNFIXED + - CLUSTER_FCV_EXPIRATION_DATE_UPDATED - AGENT_VERSION_FIXED - AGENT_VERSION_UNFIXED - FIXED_VERSION_UPDATED - FIXED_AGENT_VERSION_UPDATED - CLUSTER_FCV_DOWNGRADED + - CLUSTER_BINARY_VERSION_DOWNGRADED + - CLUSTER_BINARY_VERSION_UPGRADED title: Version Audit Types - type: string enum: @@ -32626,6 +33607,12 @@ components: enum: - GROUP_TAGS_MODIFIED title: Resource Event Types + - type: string + enum: + - RESOURCE_POLICY_CREATED + - RESOURCE_POLICY_MODIFIED + - RESOURCE_POLICY_DELETED + title: Atlas Resource Policy Audit Types EventViewForNdsGroup: type: object oneOf: @@ -32667,6 +33654,7 @@ components: - $ref: "#/components/schemas/TeamEvent" - $ref: "#/components/schemas/UserEventViewForOrg" - $ref: "#/components/schemas/ResourceEventViewForOrg" + - $ref: "#/components/schemas/AtlasResourcePolicyAuditForOrg" ExampleResourceResponse20230101: type: object properties: @@ -32716,8 +33704,7 @@ components: - description ExportStatus: type: object - description: State of the export job for the collections on the replica set - only. + description: State of the Export Job. properties: exportedCollections: type: integer @@ -32763,6 +33750,7 @@ components: - FTS_INDEX_CLEANED_UP - FTS_INDEXES_RESTORED - FTS_INDEXES_RESTORE_FAILED + - FTS_INDEXES_SYNONYM_MAPPING_INVALID example: FTS_INDEX_CREATED title: FTS Index Audit Types FTSIndexAuditView: @@ -33690,37 +34678,52 @@ components: enum: - EXCLUDE title: Field Transformation - ForNdsGroup: + FieldViolation: type: object - description: ReplicaSet Event identifies different activities about replica - set of mongod instances. properties: - created: + description: type: string - format: date-time - description: Date and time when this event occurred. This parameter expresses - its value in the ISO 8601 timestamp format in UTC. + 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. + required: + - description + - field + FlexBackupRestoreJob20250101: + type: object + description: Details for one restore job of a flex cluster. + properties: + deliveryType: + type: string + description: Means by which this resource returns the snapshot to the requesting + MongoDB Cloud user. + enum: + - RESTORE + - DOWNLOAD readOnly: true - eventTypeName: - $ref: "#/components/schemas/ReplicaSetEventTypeViewForNdsGroup" - groupId: + expirationDate: type: string - description: Unique 24-hexadecimal digit string that identifies the project - in which the event occurred. The **eventId** identifies the specific event. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" + format: date-time + description: Date and time when the download link no longer works. This + parameter expresses its value in the ISO 8601 timestamp format in UTC. readOnly: true id: type: string - description: Unique 24-hexadecimal digit string that identifies the event. + description: Unique 24-hexadecimal digit string that identifies the restore + job. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true + instanceName: + type: string + description: Human-readable label that identifies the source instance. + maxLength: 64 + minLength: 1 + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + readOnly: true links: type: array description: "List of one or more Uniform Resource Locators (URLs) that\ @@ -33732,656 +34735,296 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true - orgId: + projectId: type: string - description: Unique 24-hexadecimal digit string that identifies the organization - to which these events apply. + description: Unique 24-hexadecimal digit string that identifies the project + from which the restore job originated. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true - port: - type: integer - format: int32 - description: IANA port on which the MongoDB process listens for requests. - example: 27017 - readOnly: true - raw: - $ref: "#/components/schemas/raw" - replicaSetName: + restoreFinishedDate: type: string - description: Human-readable label of the replica set associated with the - event. - example: event-replica-set + format: date-time + 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. readOnly: true - shardName: + restoreScheduledDate: type: string - description: Human-readable label of the shard associated with the event. - example: event-sh-01 + format: date-time + description: Date and time when MongoDB Cloud will restore this snapshot. + This parameter expresses its value in the ISO 8601 timestamp format in + UTC. readOnly: true - required: - - created - - eventTypeName - - id - title: ReplicaSet Events - GCPCloudProviderContainer: - type: object - allOf: - - $ref: "#/components/schemas/CloudProviderContainer" - - type: object - properties: - atlasCidrBlock: - type: string - description: |- - IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project. - - These CIDR blocks must fall within the ranges reserved per RFC 1918. GCP further limits the block to a lower bound of the `/18` range. - - To modify the CIDR block, the target project cannot have: - - - Any M10 or greater clusters - - Any other VPC peering connections - - You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project. - - **Example:** A project in an Google Cloud (GCP) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets. - pattern: "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" - gcpProjectId: - 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. - maxLength: 26 - minLength: 26 - pattern: "^p-[0-9a-z]{24}$" - readOnly: true - networkName: - 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. - maxLength: 36 - minLength: 36 - pattern: "^nt-[0-9a-f]{24}-[0-9a-z]{8}$" - 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." - 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." - 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 - description: Collection of settings that configures the network container for - a virtual private connection on Amazon Web Services. - required: - - atlasCidrBlock - title: GCP - GCPComputeAutoScaling: - type: object - description: Collection of settings that configures how a cluster might scale - its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling - is unavailable for clusters using Low CPU or NVME storage classes. - properties: - maxInstanceSize: - type: string - description: Maximum instance size to which your cluster can automatically - scale. - enum: - - M10 - - M20 - - M30 - - M40 - - M50 - - M60 - - M80 - - M140 - - M200 - - M250 - - M300 - - M400 - - R40 - - R50 - - R60 - - R80 - - R200 - - R300 - - R400 - - R600 - title: GCP Instance Sizes - minInstanceSize: + snapshotFinishedDate: 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 - title: GCP Instance Sizes - title: GCP - GCPConsumerForwardingRule: - type: object - properties: - endpointName: + format: date-time + description: Date and time when MongoDB Cloud completed writing this snapshot. + This parameter expresses its value in the ISO 8601 timestamp format in + UTC. + readOnly: true + snapshotId: type: string - description: Human-readable label that identifies the Google Cloud consumer - forwarding rule that you created. - externalDocs: - description: Google Cloud Forwarding Rule Concepts - url: https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts + description: Unique 24-hexadecimal digit string that identifies the snapshot + to restore. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" readOnly: true - ipAddress: + snapshotUrl: type: string - description: One Private Internet Protocol version 4 (IPv4) address to which - this Google Cloud consumer forwarding rule resolves. - pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + 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: State of the MongoDB Cloud endpoint group when MongoDB Cloud - received this request. + description: Phase of the restore workflow for this job at the time this + resource made this request. enum: - - INITIATING - - AVAILABLE + - PENDING + - QUEUED + - RUNNING - FAILED - - DELETING + - COMPLETED readOnly: true - GCPEndpointService: + targetDeploymentItemName: + type: string + description: Human-readable label that identifies the instance or cluster + on the target project to which you want to restore the snapshot. You can + restore the snapshot to another USS instance or Dedicated cluster tier. + maxLength: 64 + minLength: 1 + pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + readOnly: true + targetProjectId: + type: string + description: Unique 24-hexadecimal digit string that identifies the project + that contains the instance or cluster to which you want to restore the + snapshot. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + title: Flex Backup Restore Job + FlexBackupRestoreJobCreate20250101: type: object - description: Group of Private Endpoint Service settings. + description: Details to create one restore job of a flex cluster. properties: - cloudProvider: + _snapshotId: type: string - description: Cloud service provider that serves the requested endpoint service. + description: Unique 24-hexadecimal digit string that identifies the snapshot + to restore. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + writeOnly: true + _targetDeploymentItemName: + type: string + description: Human-readable label that identifies the instance or cluster + on the target project to which you want to restore the snapshot. You can + restore the snapshot to another flex cluster or dedicated cluster tier. + maxLength: 64 + minLength: 1 + pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + writeOnly: true + _targetProjectId: + type: string + description: Unique 24-hexadecimal digit string that identifies the project + that contains the instance or cluster to which you want to restore the + snapshot. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + writeOnly: true + deliveryType: + type: string + description: Means by which this resource returns the snapshot to the requesting + MongoDB Cloud user. enum: - - AWS - - AZURE - - GCP + - RESTORE + - DOWNLOAD readOnly: true - 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 - items: - type: string - description: One Google Cloud network endpoint group that corresponds - to the Private Service Connect endpoint service. - errorMessage: + expirationDate: type: string - description: Error message returned when requesting private connection resource. - The resource returns `null` if the request succeeded. + format: date-time + description: Date and time when the download link no longer works. This + parameter expresses its value in the ISO 8601 timestamp format in UTC. readOnly: true id: type: string - description: Unique 24-hexadecimal digit string that identifies the Private - Endpoint Service. + description: Unique 24-hexadecimal digit string that identifies the restore + job. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true - regionName: + instanceName: type: string - description: Cloud provider region that manages this Private Endpoint Service. + description: Human-readable label that identifies the source instance. + maxLength: 64 + minLength: 1 + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true - serviceAttachmentNames: + links: 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. + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." externalDocs: - description: Google Cloud Private Service Connect Service Attachments - url: https://cloud.google.com/vpc/docs/private-service-connect#service-attachments + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 items: - 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. - 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\\-]+" - status: + $ref: "#/components/schemas/Link" + readOnly: true + projectId: type: string - description: State of the Private Endpoint Service connection when MongoDB - Cloud received this request. - enum: - - INITIATING - - AVAILABLE - - WAITING_FOR_USER - - FAILED - - DELETING - readOnly: true - required: - - cloudProvider - title: GCP - GCPHardwareSpec: - type: object - properties: - instanceSize: - type: string - description: Hardware specification for the instance sizes in this region. - Each instance size has a default storage and memory capacity. The instance - size you select applies to all the data-bearing hosts 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 - title: GCP Instance Sizes - nodeCount: - type: integer - format: int32 - description: Number of nodes of the given type for MongoDB Cloud to deploy - to the region. - GCPHardwareSpec20240805: - type: object - properties: - diskSizeGB: - type: number - format: double - description: "Storage capacity of instance data volumes expressed in gigabytes.\ - \ Increase this number to add capacity.\n\n This value must be equal for\ - \ all shards and node types.\n\n This value is not configurable on M0/M2/M5\ - \ clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\ - \n If you specify a disk size below the minimum (10 GB), this parameter\ - \ defaults to the minimum disk size value. \n\n Storage charge calculations\ - \ depend on whether you choose the default value or a custom value.\n\n\ - \ The maximum value for disk storage cannot exceed 50 times the maximum\ - \ RAM for the selected cluster. If you require more storage space, consider\ - \ upgrading your cluster to a higher tier." - maximum: 4096 - minimum: 10 - instanceSize: - type: string - description: Hardware specification for the instance sizes in this region - in this shard. Each instance size has a default storage and memory capacity. - Electable nodes and read-only nodes (known as "base nodes") within a single - shard must use the same instance size. Analytics nodes can scale independently - from base nodes within a shard. Both base nodes and analytics nodes can - scale independently from their equivalents in other shards. - enum: - - M10 - - M20 - - M30 - - M40 - - M50 - - M60 - - M80 - - M140 - - M200 - - M250 - - M300 - - M400 - - R40 - - R50 - - R60 - - R80 - - R200 - - R300 - - R400 - - R600 - title: GCP Instance Sizes - nodeCount: - type: integer - format: int32 - description: Number of nodes of the given type for MongoDB Cloud to deploy - to the region. - GCPNetworkPeeringConnectionSettings: - type: object - description: Group of Network Peering connection settings. - properties: - containerId: - type: string - description: Unique 24-hexadecimal digit string that identifies the MongoDB - Cloud network container that contains the specified network peering connection. + description: Unique 24-hexadecimal digit string that identifies the project + from which the restore job originated. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" - 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: + restoreFinishedDate: 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. - maxLength: 30 - minLength: 6 - pattern: "^[a-z][0-9a-z-]{4,28}[0-9a-z]{1}" - id: + format: date-time + 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. + readOnly: true + restoreScheduledDate: type: string - description: Unique 24-hexadecimal digit string that identifies the network - peering connection. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" + format: date-time + description: Date and time when MongoDB Cloud will restore this snapshot. + This parameter expresses its value in the ISO 8601 timestamp format in + UTC. readOnly: true - networkName: + snapshotFinishedDate: type: string - description: Human-readable label that identifies the network to peer with - the MongoDB Cloud VPC. - maxLength: 63 - minLength: 1 - pattern: "[a-z]([-a-z0-9]{0,62}[a-z0-9]{0,1})?" - providerName: + format: date-time + description: Date and time when MongoDB Cloud completed writing this snapshot. + This parameter expresses its value in the ISO 8601 timestamp format in + UTC. + readOnly: true + snapshotUrl: type: string - description: Cloud service provider that serves the requested network peering - connection. - enum: - - AWS - - AZURE - - GCP + 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: State of the network peering connection at the time you made - the request. + description: Phase of the restore workflow for this job at the time this + resource made this request. enum: - - ADDING_PEER - - WAITING_FOR_USER - - AVAILABLE + - PENDING + - QUEUED + - RUNNING - FAILED - - DELETING + - COMPLETED readOnly: true required: - - containerId - - gcpProjectId - - networkName - title: GCP - GCPRegionConfig: - type: object - allOf: - - $ref: "#/components/schemas/CloudRegionConfig" - - type: object - properties: - analyticsAutoScaling: - $ref: "#/components/schemas/AdvancedAutoScalingSettings" - analyticsSpecs: - $ref: "#/components/schemas/DedicatedHardwareSpec" - autoScaling: - $ref: "#/components/schemas/AdvancedAutoScalingSettings" - readOnlySpecs: - $ref: "#/components/schemas/DedicatedHardwareSpec" - description: Details that explain how MongoDB Cloud replicates data in one region - on the specified MongoDB database. - title: GCP Regional Replication Specifications - GCPRegionConfig20240805: - type: object - allOf: - - $ref: "#/components/schemas/CloudRegionConfig20240805" - - type: object - properties: - analyticsAutoScaling: - $ref: "#/components/schemas/AdvancedAutoScalingSettings" - analyticsSpecs: - $ref: "#/components/schemas/DedicatedHardwareSpec20240805" - autoScaling: - $ref: "#/components/schemas/AdvancedAutoScalingSettings" - readOnlySpecs: - $ref: "#/components/schemas/DedicatedHardwareSpec20240805" - description: Details that explain how MongoDB Cloud replicates data in one region - on the specified MongoDB database. - title: GCP Regional Replication Specifications - GeoSharding: + - _snapshotId + - _targetDeploymentItemName + title: Create Flex Backup Restore Job + FlexBackupSettings20250101: type: object + description: Flex backup configuration properties: - customZoneMapping: - type: object - additionalProperties: - 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 - 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. - items: - $ref: "#/components/schemas/ManagedNamespaces" - readOnly: true - selfManagedSharding: + enabled: 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. + default: true + description: "Flag that indicates whether backups are performed for this\ + \ flex cluster. Backup uses [TODO](TODO) for flex clusters." readOnly: true - GeoSharding20240805: + readOnly: true + title: Flex Backup Configuration + FlexBackupSnapshot20250101: type: object + description: Details for one snapshot of a flex cluster. properties: - customZoneMapping: - type: object - additionalProperties: - type: string - description: |- - List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone. - - The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property. - - This parameter returns an empty object if no custom zones exist. - readOnly: true - description: |- - List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone. - - The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property. - - This parameter returns an empty object if no custom zones exist. - readOnly: true - managedNamespaces: - type: array - description: List that contains a namespace for a Global Cluster. MongoDB - Cloud manages this cluster. - items: - $ref: "#/components/schemas/ManagedNamespaces" - readOnly: true - 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. + expiration: + type: string + format: date-time + description: Date and time when the download link no longer works. This + parameter expresses its value in the ISO 8601 timestamp format in UTC. readOnly: true - GoogleCloudKMS: - type: object - description: Details that define the configuration of Encryption at Rest using - Google Cloud Key Management Service (KMS). - externalDocs: - description: Google Cloud Key Management Service - url: https://www.mongodb.com/docs/atlas/security-gcp-kms/ - properties: - enabled: - 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: + finishTime: 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 - serviceAccountKey: + format: date-time + description: Date and time when MongoDB Cloud completed writing this snapshot. + This parameter expresses its value in the ISO 8601 timestamp format in + UTC. + readOnly: true + id: type: string - description: 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. + description: Unique 24-hexadecimal digit string that identifies the snapshot. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." externalDocs: - description: Google Cloud Authentication - url: https://cloud.google.com/docs/authentication/getting-started - writeOnly: true - valid: - type: boolean - description: Flag that indicates whether the Google Cloud Key Management - Service (KMS) encryption key can encrypt and decrypt data. + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" readOnly: true - GreaterThanDaysThresholdView: - type: object - description: Threshold value that triggers an alert. - properties: - operator: - type: string - description: Comparison operator to apply when checking the current metric - value. - enum: - - GREATER_THAN - threshold: - type: integer - format: int32 - description: "Value of metric that, when exceeded, triggers an alert." - units: + mongoDBVersion: type: string - description: "Element used to express the quantity. This can be an element\ - \ of time, storage capacity, and the like." - enum: - - DAYS - GreaterThanRawThreshold: - type: object - description: A Limit that triggers an alert when greater than a number. - properties: - operator: + description: MongoDB host version that the snapshot runs. + readOnly: true + scheduledTime: type: string - description: Comparison operator to apply when checking the current metric - value. - enum: - - GREATER_THAN - threshold: - type: integer - format: int32 - description: "Value of metric that, when exceeded, triggers an alert." - units: - $ref: "#/components/schemas/RawMetricUnits" - title: Greater Than Raw Threshold - GreaterThanRawThresholdAlertConfigViewForNdsGroup: - type: object - properties: - created: + format: date-time + description: Date and time when MongoDB Cloud will take the snapshot. This + parameter expresses its value in the ISO 8601 timestamp format in UTC. + readOnly: true + startTime: type: string format: date-time - description: Date and time when MongoDB Cloud created the alert configuration. - This parameter expresses its value in the ISO 8601 timestamp format - in UTC. + description: Date and time when MongoDB Cloud began taking the snapshot. + This parameter expresses its value in the ISO 8601 timestamp format in + UTC. readOnly: true - enabled: - type: boolean - default: false - description: Flag that indicates whether someone enabled this alert configuration - for the specified project. - eventTypeName: - $ref: "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" - groupId: + status: type: string - description: Unique 24-hexadecimal digit string that identifies the project - that owns this alert configuration. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" + description: Phase of the workflow for this snapshot at the time this resource + made this request. + enum: + - PENDING + - QUEUED + - RUNNING + - FAILED + - COMPLETED readOnly: true - id: + title: Flex Backup Snapshot + FlexBackupSnapshotDownloadCreate20250101: + type: object + description: Details for one backup snapshot download of a flex cluster. + properties: + _snapshotId: type: string - description: Unique 24-hexadecimal digit string that identifies this alert - configuration. + description: Unique 24-hexadecimal digit string that identifies the snapshot + to download. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" - readOnly: true + writeOnly: true links: type: array description: "List of one or more Uniform Resource Locators (URLs) that\ @@ -34393,67 +35036,42 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true - matchers: - type: array - description: "List of rules that determine whether MongoDB Cloud checks\ - \ an object for the alert configuration. You can filter using the matchers\ - \ array if the **eventTypeName** specifies an event for a host, replica\ - \ set, or sharded cluster." - items: - $ref: "#/components/schemas/ReplicaSetMatcher" - notifications: - type: array - description: List that contains the targets that MongoDB Cloud sends notifications. - items: - $ref: "#/components/schemas/AlertsNotificationRootForGroup" - threshold: - $ref: "#/components/schemas/GreaterThanRawThreshold" - updated: - type: string - format: date-time - description: Date and time when someone last updated this alert configuration. - This parameter expresses its value in the ISO 8601 timestamp format - in UTC. - readOnly: true required: - - eventTypeName - - notifications - GreaterThanTimeThreshold: + - _snapshotId + title: Flex Backup Snapshot Download Create + FlexClusterDescription20250101: type: object - description: A Limit that triggers an alert when greater than a time period. + description: Group of settings that configure a MongoDB Flex cluster. properties: - operator: + backupSettings: + $ref: "#/components/schemas/FlexBackupSettings20250101" + clusterType: type: string - description: Comparison operator to apply when checking the current metric - value. + description: Flex cluster topology. enum: - - GREATER_THAN - threshold: - type: integer - format: int32 - description: "Value of metric that, when exceeded, triggers an alert." - units: - $ref: "#/components/schemas/TimeMetricUnits" - title: Greater Than Time Threshold - Group: - type: object - properties: - clusterCount: - type: integer - format: int64 - description: Quantity of MongoDB Cloud clusters deployed in this project. + - REPLICASET + - LOADBALANCED readOnly: true - created: + connectionStrings: + $ref: "#/components/schemas/FlexConnectionStrings20250101" + createDate: type: string format: date-time - description: Date and time when MongoDB Cloud created this project. This - parameter expresses its value in the ISO 8601 timestamp format in UTC. + description: Date and time when MongoDB Cloud created this instance. This + parameter expresses its value in ISO 8601 format in UTC. + readOnly: true + groupId: + type: string + description: Unique 24-hexadecimal character string that identifies the + project. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" readOnly: true id: type: string - description: Unique 24-hexadecimal digit string that identifies the MongoDB - Cloud project. + description: Unique 24-hexadecimal digit string that identifies the instance. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 @@ -34470,18 +35088,1021 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true + mongoDBVersion: + type: string + description: Version of MongoDB that the instance runs. + pattern: "([\\d]+\\.[\\d]+\\.[\\d]+)" + readOnly: true name: type: string - description: Human-readable label that identifies the project included in - the MongoDB Cloud organization. + description: Human-readable label that identifies the instance. maxLength: 64 minLength: 1 - pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" - orgId: + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + readOnly: true + providerSettings: + $ref: "#/components/schemas/FlexProviderSettings20250101" + stateName: type: string - description: Unique 24-hexadecimal digit string that identifies the MongoDB - Cloud organization to which the project belongs. - example: 32b6e34b3d91647abb20e7b8 + description: Human-readable label that indicates the current operating condition + of this instance. + enum: + - IDLE + - CREATING + - UPDATING + - DELETING + - REPAIRING + readOnly: true + tags: + type: array + description: List that contains key-value pairs between 1 to 255 characters + in length for tagging and categorizing the instance. + externalDocs: + description: Resource Tags + url: https://dochub.mongodb.org/core/add-cluster-tag-atlas + items: + $ref: "#/components/schemas/ResourceTag" + terminationProtectionEnabled: + type: boolean + default: false + description: "Flag that indicates whether termination protection is enabled\ + \ on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster.\ + \ If set to `false`, MongoDB Cloud will delete the cluster." + versionReleaseSystem: + type: string + default: LTS + description: Method by which the cluster maintains the MongoDB versions. + enum: + - LTS + readOnly: true + required: + - providerSettings + title: Flex Cluster Description + FlexClusterDescriptionCreate20250101: + type: object + description: Settings that you can specify when you create a flex cluster. + properties: + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + name: + type: string + description: Human-readable label that identifies the instance. + maxLength: 64 + minLength: 1 + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + writeOnly: true + providerSettings: + $ref: "#/components/schemas/FlexProviderSettingsCreate20250101" + tags: + type: array + description: List that contains key-value pairs between 1 to 255 characters + in length for tagging and categorizing the instance. + externalDocs: + description: Resource Tags + url: https://dochub.mongodb.org/core/add-cluster-tag-atlas + items: + $ref: "#/components/schemas/ResourceTag" + terminationProtectionEnabled: + type: boolean + default: false + description: "Flag that indicates whether termination protection is enabled\ + \ on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster.\ + \ If set to `false`, MongoDB Cloud will delete the cluster." + required: + - name + - providerSettings + title: Flex Cluster Description Create + FlexConnectionStrings20250101: + type: object + description: Collection of Uniform Resource Locators that point to the MongoDB + database. + externalDocs: + description: Connection string URI format. + url: https://docs.mongodb.com/manual/reference/connection-string/ + properties: + standard: + type: string + description: Public connection string that you can use to connect to this + cluster. This connection string uses the mongodb:// protocol. + externalDocs: + description: Connection String URI Format + url: https://docs.mongodb.com/manual/reference/connection-string/ + readOnly: true + standardSrv: + type: string + description: Public connection string that you can use to connect to this + flex cluster. This connection string uses the `mongodb+srv://` protocol. + externalDocs: + description: Connection String URI Format + url: https://docs.mongodb.com/manual/reference/connection-string/ + readOnly: true + readOnly: true + title: Flex Cluster Connection Strings + FlexProviderSettings20250101: + type: object + description: Group of cloud provider settings that configure the provisioned + MongoDB flex cluster. + properties: + backingProviderName: + type: string + description: Cloud service provider on which MongoDB Cloud provisioned the + flex cluster. + enum: + - AWS + - AZURE + - GCP + readOnly: true + diskSizeGB: + type: number + format: double + description: Storage capacity available to the flex cluster expressed in + gigabytes. + readOnly: true + providerName: + type: string + default: FLEX + description: Human-readable label that identifies the cloud service provider. + enum: + - FLEX + readOnly: true + regionName: + type: string + description: "Human-readable label that identifies the geographic location\ + \ of your MongoDB flex cluster. The region you choose can affect network\ + \ latency for clients accessing your databases. For a complete list of\ + \ region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws),\ + \ [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/)." + readOnly: true + readOnly: true + title: Cloud Service Provider Settings for a Flex Cluster + FlexProviderSettingsCreate20250101: + type: object + description: Group of cloud provider settings that configure the provisioned + MongoDB flex cluster. + properties: + backingProviderName: + type: string + description: Cloud service provider on which MongoDB Cloud provisioned the + flex cluster. + enum: + - AWS + - AZURE + - GCP + writeOnly: true + diskSizeGB: + type: number + format: double + description: Storage capacity available to the flex cluster expressed in + gigabytes. + readOnly: true + providerName: + type: string + default: FLEX + description: Human-readable label that identifies the cloud service provider. + enum: + - FLEX + readOnly: true + regionName: + type: string + description: "Human-readable label that identifies the geographic location\ + \ of your MongoDB flex cluster. The region you choose can affect network\ + \ latency for clients accessing your databases. For a complete list of\ + \ region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws),\ + \ [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/)." + writeOnly: true + required: + - backingProviderName + - regionName + title: Cloud Service Provider Settings for a Flex Cluster + writeOnly: true + ForNdsGroup: + type: object + description: ReplicaSet Event identifies different activities about replica + set of mongod instances. + properties: + created: + type: string + format: date-time + description: Date and time when this event occurred. This parameter expresses + its value in the ISO 8601 timestamp format in UTC. + readOnly: true + eventTypeName: + $ref: "#/components/schemas/ReplicaSetEventTypeViewForNdsGroup" + groupId: + type: string + description: Unique 24-hexadecimal digit string that identifies the project + in which the event occurred. The **eventId** identifies the specific event. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + id: + type: string + description: Unique 24-hexadecimal digit string that identifies the event. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + orgId: + type: string + description: Unique 24-hexadecimal digit string that identifies the organization + to which these events apply. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + port: + type: integer + format: int32 + description: IANA port on which the MongoDB process listens for requests. + example: 27017 + readOnly: true + raw: + $ref: "#/components/schemas/raw" + replicaSetName: + type: string + description: Human-readable label of the replica set associated with the + event. + example: event-replica-set + readOnly: true + shardName: + type: string + description: Human-readable label of the shard associated with the event. + example: event-sh-01 + readOnly: true + required: + - created + - eventTypeName + - id + title: ReplicaSet Events + GCPCloudProviderContainer: + type: object + allOf: + - $ref: "#/components/schemas/CloudProviderContainer" + - type: object + properties: + atlasCidrBlock: + type: string + description: |- + IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project. + + These CIDR blocks must fall within the ranges reserved per RFC 1918. GCP further limits the block to a lower bound of the `/18` range. + + To modify the CIDR block, the target project cannot have: + + - Any M10 or greater clusters + - Any other VPC peering connections + + You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project. + + **Example:** A project in an Google Cloud (GCP) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets. + pattern: "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + gcpProjectId: + 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. + maxLength: 26 + minLength: 26 + pattern: "^p-[0-9a-z]{24}$" + readOnly: true + networkName: + 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. + maxLength: 36 + minLength: 36 + pattern: "^nt-[0-9a-f]{24}-[0-9a-z]{8}$" + 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." + 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." + 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 + description: Collection of settings that configures the network container for + a virtual private connection on Amazon Web Services. + required: + - atlasCidrBlock + title: GCP + GCPComputeAutoScaling: + type: object + description: Collection of settings that configures how a cluster might scale + its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling + is unavailable for clusters using Low CPU or NVME storage classes. + properties: + maxInstanceSize: + type: string + description: Maximum instance size to which your cluster can automatically + scale. + enum: + - M10 + - M20 + - M30 + - M40 + - M50 + - M60 + - M80 + - M140 + - M200 + - M250 + - M300 + - M400 + - R40 + - R50 + - R60 + - R80 + - R200 + - R300 + - R400 + - R600 + title: GCP Instance Sizes + minInstanceSize: + 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 + title: GCP Instance Sizes + title: GCP + GCPConsumerForwardingRule: + type: object + properties: + endpointName: + type: string + description: Human-readable label that identifies the Google Cloud consumer + forwarding rule that you created. + externalDocs: + description: Google Cloud Forwarding Rule Concepts + url: https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts + readOnly: true + ipAddress: + type: string + description: One Private Internet Protocol version 4 (IPv4) address to which + this Google Cloud consumer forwarding rule resolves. + pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + readOnly: true + status: + type: string + description: State of the MongoDB Cloud endpoint group when MongoDB Cloud + received this request. + enum: + - INITIATING + - AVAILABLE + - FAILED + - DELETING + readOnly: true + 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 + 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. + enum: + - CENTRAL_US + - WESTERN_EUROPE + readOnly: true + GCPEndpointService: + type: object + description: Group of Private Endpoint Service settings. + properties: + cloudProvider: + type: string + description: Cloud service provider that serves the requested endpoint service. + enum: + - AWS + - AZURE + - GCP + readOnly: true + 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 + 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: + type: string + description: Unique 24-hexadecimal digit string that identifies the Private + Endpoint Service. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + 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 + items: + 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. + 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\\-]+" + status: + type: string + description: State of the Private Endpoint Service connection when MongoDB + Cloud received this request. + enum: + - INITIATING + - AVAILABLE + - WAITING_FOR_USER + - FAILED + - DELETING + readOnly: true + required: + - cloudProvider + title: GCP + GCPHardwareSpec: + type: object + properties: + instanceSize: + type: string + description: Hardware specification for the instance sizes in this region. + Each instance size has a default storage and memory capacity. The instance + size you select applies to all the data-bearing hosts 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 + title: GCP Instance Sizes + nodeCount: + type: integer + format: int32 + description: Number of nodes of the given type for MongoDB Cloud to deploy + to the region. + GCPHardwareSpec20240805: + type: object + properties: + diskSizeGB: + type: number + format: double + description: "Storage capacity of instance data volumes expressed in gigabytes.\ + \ Increase this number to add capacity.\n\n This value must be equal for\ + \ all shards and node types.\n\n This value is not configurable on M0/M2/M5\ + \ clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\ + \n If you specify a disk size below the minimum (10 GB), this parameter\ + \ defaults to the minimum disk size value. \n\n Storage charge calculations\ + \ depend on whether you choose the default value or a custom value.\n\n\ + \ The maximum value for disk storage cannot exceed 50 times the maximum\ + \ RAM for the selected cluster. If you require more storage space, consider\ + \ upgrading your cluster to a higher tier." + maximum: 4096 + minimum: 10 + instanceSize: + type: string + description: Hardware specification for the instance sizes in this region + in this shard. Each instance size has a default storage and memory capacity. + Electable nodes and read-only nodes (known as "base nodes") within a single + shard must use the same instance size. Analytics nodes can scale independently + from base nodes within a shard. Both base nodes and analytics nodes can + scale independently from their equivalents in other shards. + enum: + - M10 + - M20 + - M30 + - M40 + - M50 + - M60 + - M80 + - M140 + - M200 + - M250 + - M300 + - M400 + - R40 + - R50 + - R60 + - R80 + - R200 + - R300 + - R400 + - R600 + title: GCP Instance Sizes + nodeCount: + type: integer + format: int32 + description: Number of nodes of the given type for MongoDB Cloud to deploy + to the region. + GCPNetworkPeeringConnectionSettings: + type: object + description: Group of Network Peering connection settings. + properties: + containerId: + type: string + description: Unique 24-hexadecimal digit string that identifies the MongoDB + Cloud network container that contains the specified network peering connection. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + 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: + 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. + maxLength: 30 + minLength: 6 + pattern: "^[a-z][0-9a-z-]{4,28}[0-9a-z]{1}" + id: + type: string + description: Unique 24-hexadecimal digit string that identifies the network + peering connection. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + networkName: + type: string + description: Human-readable label that identifies the network to peer with + the MongoDB Cloud VPC. + maxLength: 63 + minLength: 1 + pattern: "[a-z]([-a-z0-9]{0,62}[a-z0-9]{0,1})?" + 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. + enum: + - ADDING_PEER + - WAITING_FOR_USER + - AVAILABLE + - FAILED + - DELETING + readOnly: true + required: + - containerId + - gcpProjectId + - networkName + title: GCP + GCPRegionConfig: + type: object + allOf: + - $ref: "#/components/schemas/CloudRegionConfig" + - type: object + properties: + analyticsAutoScaling: + $ref: "#/components/schemas/AdvancedAutoScalingSettings" + analyticsSpecs: + $ref: "#/components/schemas/DedicatedHardwareSpec" + autoScaling: + $ref: "#/components/schemas/AdvancedAutoScalingSettings" + readOnlySpecs: + $ref: "#/components/schemas/DedicatedHardwareSpec" + description: Details that explain how MongoDB Cloud replicates data in one region + on the specified MongoDB database. + title: GCP Regional Replication Specifications + GCPRegionConfig20240805: + type: object + allOf: + - $ref: "#/components/schemas/CloudRegionConfig20240805" + - type: object + properties: + analyticsAutoScaling: + $ref: "#/components/schemas/AdvancedAutoScalingSettings" + analyticsSpecs: + $ref: "#/components/schemas/DedicatedHardwareSpec20240805" + autoScaling: + $ref: "#/components/schemas/AdvancedAutoScalingSettings" + readOnlySpecs: + $ref: "#/components/schemas/DedicatedHardwareSpec20240805" + description: Details that explain how MongoDB Cloud replicates data in one region + on the specified MongoDB database. + title: GCP Regional Replication Specifications + GeoSharding: + type: object + properties: + customZoneMapping: + type: object + additionalProperties: + 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 + 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. + items: + $ref: "#/components/schemas/ManagedNamespaces" + readOnly: true + 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 + GeoSharding20240805: + type: object + properties: + customZoneMapping: + type: object + additionalProperties: + type: string + description: |- + List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone. + + The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property. + + This parameter returns an empty object if no custom zones exist. + readOnly: true + description: |- + List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone. + + The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property. + + This parameter returns an empty object if no custom zones exist. + readOnly: true + managedNamespaces: + type: array + description: List that contains a namespace for a Global Cluster. MongoDB + Cloud manages this cluster. + items: + $ref: "#/components/schemas/ManagedNamespaces" + readOnly: true + 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 + GoogleCloudKMS: + type: object + description: Details that define the configuration of Encryption at Rest using + Google Cloud Key Management Service (KMS). + externalDocs: + description: Google Cloud Key Management Service + url: https://www.mongodb.com/docs/atlas/security-gcp-kms/ + properties: + enabled: + 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 + 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. + externalDocs: + description: Google Cloud Authentication + url: https://cloud.google.com/docs/authentication/getting-started + writeOnly: true + valid: + type: boolean + description: Flag that indicates whether the Google Cloud Key Management + Service (KMS) encryption key can encrypt and decrypt data. + readOnly: true + GreaterThanDaysThresholdView: + type: object + description: Threshold value that triggers an alert. + properties: + operator: + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - GREATER_THAN + threshold: + type: integer + format: int32 + description: "Value of metric that, when exceeded, triggers an alert." + units: + type: string + description: "Element used to express the quantity. This can be an element\ + \ of time, storage capacity, and the like." + enum: + - DAYS + GreaterThanRawThreshold: + type: object + description: A Limit that triggers an alert when greater than a number. + properties: + operator: + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - GREATER_THAN + threshold: + type: integer + format: int32 + description: "Value of metric that, when exceeded, triggers an alert." + units: + $ref: "#/components/schemas/RawMetricUnits" + title: Greater Than Raw Threshold + GreaterThanRawThresholdAlertConfigViewForNdsGroup: + type: object + properties: + created: + type: string + format: date-time + description: Date and time when MongoDB Cloud created the alert configuration. + This parameter expresses its value in the ISO 8601 timestamp format + in UTC. + readOnly: true + enabled: + type: boolean + default: false + description: Flag that indicates whether someone enabled this alert configuration + for the specified project. + eventTypeName: + $ref: "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" + groupId: + type: string + description: Unique 24-hexadecimal digit string that identifies the project + that owns this alert configuration. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + id: + type: string + description: Unique 24-hexadecimal digit string that identifies this alert + configuration. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + matchers: + type: array + description: "List of rules that determine whether MongoDB Cloud checks\ + \ an object for the alert configuration. You can filter using the matchers\ + \ array if the **eventTypeName** specifies an event for a host, replica\ + \ set, or sharded cluster." + items: + $ref: "#/components/schemas/ReplicaSetMatcher" + notifications: + type: array + description: List that contains the targets that MongoDB Cloud sends notifications. + items: + $ref: "#/components/schemas/AlertsNotificationRootForGroup" + threshold: + $ref: "#/components/schemas/GreaterThanRawThreshold" + updated: + type: string + format: date-time + description: Date and time when someone last updated this alert configuration. + This parameter expresses its value in the ISO 8601 timestamp format + in UTC. + readOnly: true + required: + - eventTypeName + - notifications + GreaterThanTimeThreshold: + type: object + description: A Limit that triggers an alert when greater than a time period. + properties: + operator: + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - GREATER_THAN + threshold: + type: integer + format: int32 + description: "Value of metric that, when exceeded, triggers an alert." + units: + $ref: "#/components/schemas/TimeMetricUnits" + title: Greater Than Time Threshold + Group: + type: object + properties: + clusterCount: + type: integer + format: int64 + description: Quantity of MongoDB Cloud clusters deployed in this project. + readOnly: true + created: + type: string + format: date-time + description: Date and time when MongoDB Cloud created this project. This + parameter expresses its value in the ISO 8601 timestamp format in UTC. + readOnly: true + id: + type: string + description: Unique 24-hexadecimal digit string that identifies the MongoDB + Cloud project. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + name: + type: string + description: Human-readable label that identifies the project included in + the MongoDB Cloud organization. + maxLength: 64 + minLength: 1 + pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + orgId: + type: string + description: Unique 24-hexadecimal digit string that identifies the MongoDB + Cloud organization to which the project belongs. + example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" @@ -34730,25 +36351,26 @@ components: maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" - readOnly: true destinationOrgPrivateApiKey: type: string - description: "Unique string that identifies the private part of the [API\ - \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) used\ - \ to verify access to the destination organization. This parameter is\ - \ required only when you authenticate with Programmatic API Keys." + description: Unique string that identifies the private part of the API Key + used to verify access to the destination organization. This parameter + is required only when you authenticate with Programmatic API Keys. example: 55c3bbb6-b4bb-0be1-e66d20841f3e - readOnly: true + externalDocs: + description: Grant Programmatic Access to Atlas + url: https://dochub.mongodb.org/core/atlas-create-prog-api-key destinationOrgPublicApiKey: type: string - description: "Unique string that identifies the public part of the [API\ - \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) used\ - \ to verify access to the destination organization. This parameter is\ - \ required only when you authenticate with Programmatic API Keys." + description: Unique string that identifies the public part of the API Key + used to verify access to the destination organization. This parameter + is required only when you authenticate with Programmatic API Keys. example: zmmrboas + externalDocs: + description: Grant Programmatic Access to Atlas + url: https://dochub.mongodb.org/core/atlas-create-prog-api-key maxLength: 8 minLength: 8 - readOnly: true GroupNotification: type: object description: Group notification configuration for MongoDB Cloud to send information @@ -34838,7 +36460,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/EventViewForNdsGroup" @@ -34886,6 +36508,33 @@ components: - GROUP_READ_ONLY - GROUP_SEARCH_INDEX_EDITOR - GROUP_STREAM_PROCESSING_OWNER + GroupRoleAssignment: + type: object + properties: + groupId: + type: string + description: Unique 24-hexadecimal digit string that identifies the project + to which these roles belong. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + groupRoles: + type: array + description: One or more project level roles assigned to the MongoDB Cloud + user. + items: + type: string + enum: + - GROUP_OWNER + - GROUP_CLUSTER_MANAGER + - GROUP_STREAM_PROCESSING_OWNER + - GROUP_DATA_ACCESS_ADMIN + - GROUP_DATA_ACCESS_READ_WRITE + - GROUP_DATA_ACCESS_READ_ONLY + - GROUP_READ_ONLY + - GROUP_SEARCH_INDEX_EDITOR + uniqueItems: true GroupService: type: object description: List of IP addresses in a project categorized by services. @@ -34901,26 +36550,26 @@ components: GroupServiceAccount: type: object properties: + clientId: + type: string + description: The Client ID of the Service Account. + pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" createdAt: type: string format: date-time - description: Service account creation time. + description: The date that the Service Account was created on. description: type: string - description: Description of the service account. - id: - type: string - description: ID for the service account. - pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" + description: Human readable description for the Service Account. name: type: string - description: Name for service account. + description: Human-readable name for the Service Account. roles: type: array - description: Roles assigned to the Service Account group. + description: A list of Project roles associated with the Service Account. items: type: string - description: Project roles associated with the service account. + description: Project roles available for Service Accounts. enum: - GROUP_OWNER - GROUP_READ_ONLY @@ -34933,7 +36582,7 @@ components: uniqueItems: true secrets: type: array - description: List of secrets. + description: A list of secrets associated with the specified Service Account. items: $ref: "#/components/schemas/ServiceAccountSecret" uniqueItems: true @@ -34942,23 +36591,23 @@ components: properties: description: type: string - description: Human readable description for the service account. + description: Human readable description for the Service Account. maxLength: 250 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" name: type: string - description: Human-readable name for the service account. The name is modifiable + description: Human-readable name for the Service Account. The name is modifiable and does not have to be unique. maxLength: 64 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" roles: type: array - description: Project roles associated with the service account. + description: A list of project-level roles for the Service Account. items: type: string - description: Project roles associated with the service account. + description: Project roles available for Service Accounts. enum: - GROUP_OWNER - GROUP_READ_ONLY @@ -34971,20 +36620,23 @@ components: secretExpiresAfterHours: type: integer format: int32 - description: Secret expiration time. + description: The expiration time of the new Service Account secret. The + expiration is provided in hours. required: - description - name + - roles - secretExpiresAfterHours GroupServiceAccountRoleAssignment: type: object properties: roles: type: array - description: Group access roles. + description: The Project permissions for the Service Account in the specified + Project. items: type: string - description: Project roles associated with the service account. + description: Project roles available for Service Accounts. enum: - GROUP_OWNER - GROUP_READ_ONLY @@ -34995,28 +36647,30 @@ components: - GROUP_SEARCH_INDEX_EDITOR - GROUP_STREAM_PROCESSING_OWNER uniqueItems: true + required: + - roles GroupServiceAccountUpdateRequest: type: object properties: description: type: string - description: Human readable description for the service account. + description: Human readable description for the Service Account. maxLength: 250 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" name: type: string - description: Human-readable name for the service account. The name is modifiable + description: Human-readable name for the Service Account. The name is modifiable and does not have to be unique. maxLength: 64 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" roles: type: array - description: Project roles associated with the service account. + description: A list of Project roles associated with the Service Account. items: type: string - description: Project roles associated with the service account. + description: Project roles available for Service Accounts. enum: - GROUP_OWNER - GROUP_READ_ONLY @@ -35280,7 +36934,7 @@ components: example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -35399,6 +37053,8 @@ components: - HOST_HAS_INDEX_SUGGESTIONS - HOST_MONGOT_RECOVERED_OOM - HOST_MONGOT_CRASHING_OOM + - HOST_MONGOT_RESUME_REPLICATION + - HOST_MONGOT_STOP_REPLICATION - HOST_ENOUGH_DISK_SPACE - HOST_NOT_ENOUGH_DISK_SPACE example: HOST_DOWN @@ -35410,6 +37066,7 @@ components: - HOST_DOWN - HOST_HAS_INDEX_SUGGESTIONS - HOST_MONGOT_CRASHING_OOM + - HOST_MONGOT_STOP_REPLICATION - HOST_NOT_ENOUGH_DISK_SPACE example: HOST_DOWN title: Host Event Types @@ -35706,6 +37363,7 @@ components: OPCOUNTER_REPL_INSERT: "#/components/schemas/RawMetricAlertView" OPCOUNTER_REPL_UPDATE: "#/components/schemas/RawMetricAlertView" OPCOUNTER_UPDATE: "#/components/schemas/RawMetricAlertView" + OPERATIONS_QUERIES_KILLED: "#/components/schemas/RawMetricAlertView" OPERATIONS_SCAN_AND_ORDER: "#/components/schemas/RawMetricAlertView" OPERATION_THROTTLING_REJECTED_OPERATIONS: "#/components/schemas/RawMetricAlertView" OPLOG_MASTER_LAG_TIME_DIFF: "#/components/schemas/TimeMetricAlertView" @@ -35780,7 +37438,7 @@ components: example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -36109,6 +37767,7 @@ components: OPCOUNTER_REPL_INSERT: "#/components/schemas/RawMetricEventView" OPCOUNTER_REPL_UPDATE: "#/components/schemas/RawMetricEventView" OPCOUNTER_UPDATE: "#/components/schemas/RawMetricEventView" + OPERATIONS_QUERIES_KILLED: "#/components/schemas/RawMetricEventView" OPERATIONS_SCAN_AND_ORDER: "#/components/schemas/RawMetricEventView" OPERATION_THROTTLING_REJECTED_OPERATIONS: "#/components/schemas/RawMetricEventView" OPLOG_MASTER_LAG_TIME_DIFF: "#/components/schemas/TimeMetricEventView" @@ -36414,6 +38073,7 @@ components: OPCOUNTER_REPL_INSERT: "#/components/schemas/RawMetricThresholdView" OPCOUNTER_REPL_UPDATE: "#/components/schemas/RawMetricThresholdView" OPCOUNTER_UPDATE: "#/components/schemas/RawMetricThresholdView" + OPERATIONS_QUERIES_KILLED: "#/components/schemas/RawMetricThresholdView" OPERATIONS_SCAN_AND_ORDER: "#/components/schemas/RawMetricThresholdView" OPERATION_THROTTLING_REJECTED_OPERATIONS: "#/components/schemas/RawMetricThresholdView" OPLOG_MASTER_LAG_TIME_DIFF: "#/components/schemas/TimeMetricThresholdView" @@ -36458,7 +38118,12 @@ components: enum: - AVERAGE operator: - $ref: "#/components/schemas/Operator" + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - LESS_THAN + - GREATER_THAN threshold: type: number format: double @@ -36935,7 +38600,7 @@ components: the charge. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -37371,6 +39036,21 @@ components: - ATLAS_AWS_STREAM_PROCESSING_DATA_TRANSFER - ATLAS_AZURE_STREAM_PROCESSING_DATA_TRANSFER - ATLAS_AWS_STREAM_PROCESSING_VPC_PEERING + - 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 readOnly: true startDate: type: string @@ -37696,6 +39376,371 @@ components: - REPLICASET - SHARDED - GEOSHARDED + configServerManagementMode: + type: string + default: ATLAS_MANAGED + description: |- + Config Server Management Mode for creating or updating a sharded cluster. + + When configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings. + + When configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server. + enum: + - ATLAS_MANAGED + - FIXED_TO_DEDICATED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + configServerType: + type: string + description: Describes a sharded cluster's config server type. + enum: + - DEDICATED + - EMBEDDED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + readOnly: true + connectionStrings: + $ref: "#/components/schemas/ClusterConnectionStrings" + createDate: + type: string + format: date-time + description: Date and time when MongoDB Cloud created this serverless instance. + MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. + readOnly: true + diskSizeGB: + type: number + format: double + 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." + maximum: 4096 + minimum: 10 + diskWarmingMode: + type: string + default: FULLY_WARMED + description: Disk warming mode selection. + enum: + - FULLY_WARMED + - VISIBLE_EARLIER + externalDocs: + description: Reduce Secondary Disk Warming Impact + url: https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact + encryptionAtRestProvider: + type: string + description: Cloud service provider that manages your customer keys to provide + an additional layer of Encryption at Rest for the cluster. + enum: + - NONE + - AWS + - AZURE + - GCP + externalDocs: + description: Encryption at Rest using Customer Key Management + url: https://www.mongodb.com/docs/atlas/security-kms-encryption/ + featureCompatibilityVersion: + type: string + description: Feature compatibility version of the cluster. + readOnly: true + featureCompatibilityVersionExpirationDate: + type: string + format: date-time + description: Feature compatibility version expiration date. + 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: + type: string + description: Unique 24-hexadecimal character string that identifies the + project. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + id: + type: string + description: Unique 24-hexadecimal digit string that identifies the cluster. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + labels: + type: array + deprecated: true + description: |- + Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels. + + Cluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead. + items: + $ref: "#/components/schemas/ComponentLabel" + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + 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- + mongoDBVersion: + type: string + description: Version of MongoDB that the cluster runs. + pattern: "([\\d]+\\.[\\d]+\\.[\\d]+)" + 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." + externalDocs: + description: Connection string URI format. + url: https://docs.mongodb.com/manual/reference/connection-string/ + readOnly: true + mongoURIUpdated: + type: string + format: date-time + description: Date and time when someone last updated the connection string. + MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. + readOnly: true + 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." + externalDocs: + description: Connection string URI format. + url: https://docs.mongodb.com/manual/reference/connection-string/ + readOnly: true + name: + type: string + description: Human-readable label that identifies the cluster. + maxLength: 64 + minLength: 1 + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + numShards: + type: integer + format: int32 + default: 1 + description: Number of shards up to 50 to deploy for a sharded cluster. + The resource returns `1` to indicate a replica set and values of `2` and + higher to indicate a sharded cluster. The returned value equals the number + of shards in the cluster. + externalDocs: + description: Sharding + url: https://docs.mongodb.com/manual/sharding/ + maximum: 50 + minimum: 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 + default: WORKLOAD_TYPE + description: |- + Set this field to configure the replica set scaling mode for your cluster. + + By default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes. + + When configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads. + + When configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads. + enum: + - SEQUENTIAL + - WORKLOAD_TYPE + - NODE_TYPE + externalDocs: + description: Modify the Replica Set Scaling Mode + url: https://dochub.mongodb.org/core/scale-nodes + replicationFactor: + type: integer + format: int32 + default: 3 + deprecated: true + description: "Number of members that belong to the replica set. Each member\ + \ retains a copy of your databases, providing high availability and data\ + \ redundancy. Use **replicationSpecs** instead." + enum: + - 3 + - 5 + - 7 + replicationSpec: + type: object + additionalProperties: + $ref: "#/components/schemas/RegionSpec" + description: Physical location where MongoDB Cloud provisions cluster nodes. + title: Region Configuration + 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. + items: + $ref: "#/components/schemas/LegacyReplicationSpec" + rootCertType: + type: string + default: ISRGROOTX1 + description: Root Certificate Authority that MongoDB Atlas clusters uses. + MongoDB Cloud supports Internet Security Research Group. + 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. + externalDocs: + description: Connection string URI format. + url: https://docs.mongodb.com/manual/reference/connection-string/ + readOnly: true + stateName: + type: string + description: Human-readable label that indicates the current operating condition + of the cluster. + enum: + - IDLE + - CREATING + - UPDATING + - DELETING + - REPAIRING + readOnly: true + tags: + type: array + description: List that contains key-value pairs between 1 to 255 characters + in length for tagging and categorizing the cluster. + externalDocs: + description: Resource Tags + url: https://dochub.mongodb.org/core/add-cluster-tag-atlas + items: + $ref: "#/components/schemas/ResourceTag" + terminationProtectionEnabled: + type: boolean + default: false + description: "Flag that indicates whether termination protection is enabled\ + \ on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster.\ + \ If set to `false`, MongoDB Cloud will delete the cluster." + versionReleaseSystem: + type: string + default: LTS + description: "Method by which the cluster maintains the MongoDB versions.\ + \ If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**." + enum: + - LTS + - CONTINUOUS + title: Cluster Description + LegacyAtlasTenantClusterUpgradeRequest: + type: object + description: Request containing target state of tenant cluster to be upgraded + properties: + acceptDataRisksAndForceReplicaSetReconfig: + type: string + format: date-time + description: "If reconfiguration is necessary to regain a primary due to\ + \ a regional outage, submit this field alongside your topology reconfiguration\ + \ to request a new regional outage resistant topology. Forced reconfigurations\ + \ during an outage of the majority of electable nodes carry a risk of\ + \ data loss if replicated writes (even majority committed writes) have\ + \ not been replicated to the new primary node. MongoDB Atlas docs contain\ + \ more information. To proceed with an operation which carries that risk,\ + \ set **acceptDataRisksAndForceReplicaSetReconfig** to the current date." + externalDocs: + description: Reconfiguring a Replica Set during a regional outage + url: https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set + 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 + default: ATLAS_MANAGED + description: |- + Config Server Management Mode for creating or updating a sharded cluster. + + When configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings. + + When configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server. + enum: + - ATLAS_MANAGED + - FIXED_TO_DEDICATED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + configServerType: + type: string + description: Describes a sharded cluster's config server type. + enum: + - DEDICATED + - EMBEDDED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + readOnly: true connectionStrings: $ref: "#/components/schemas/ClusterConnectionStrings" createDate: @@ -37740,6 +39785,15 @@ components: externalDocs: description: Encryption at Rest using Customer Key Management url: https://www.mongodb.com/docs/atlas/security-kms-encryption/ + featureCompatibilityVersion: + type: string + description: Feature compatibility version of the cluster. + readOnly: true + featureCompatibilityVersionExpirationDate: + type: string + format: date-time + description: Feature compatibility version expiration date. + readOnly: true globalClusterSelfManagedSharding: type: boolean description: |- @@ -37790,6 +39844,8 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true + mongoDBEmployeeAccessGrant: + $ref: "#/components/schemas/EmployeeAccessGrantView" mongoDBMajorVersion: type: string description: |- @@ -37836,7 +39892,7 @@ components: description: Human-readable label that identifies the cluster. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" numShards: type: integer format: int32 @@ -37868,292 +39924,24 @@ components: \ use MongoDB Cloud backups." providerSettings: $ref: "#/components/schemas/ClusterProviderSettings" - replicationFactor: - type: integer - format: int32 - default: 3 - deprecated: true - description: "Number of members that belong to the replica set. Each member\ - \ retains a copy of your databases, providing high availability and data\ - \ redundancy. Use **replicationSpecs** instead." - enum: - - 3 - - 5 - - 7 - replicationSpec: - type: object - additionalProperties: - $ref: "#/components/schemas/RegionSpec" - description: Physical location where MongoDB Cloud provisions cluster nodes. - title: Region Configuration - 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. - items: - $ref: "#/components/schemas/LegacyReplicationSpec" - rootCertType: - type: string - default: ISRGROOTX1 - description: Root Certificate Authority that MongoDB Atlas clusters uses. - MongoDB Cloud supports Internet Security Research Group. - 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. - externalDocs: - description: Connection string URI format. - url: https://docs.mongodb.com/manual/reference/connection-string/ - readOnly: true - stateName: - type: string - description: Human-readable label that indicates the current operating condition - of the cluster. - enum: - - IDLE - - CREATING - - UPDATING - - DELETING - - REPAIRING - readOnly: true - tags: - type: array - description: List that contains key-value pairs between 1 to 255 characters - in length for tagging and categorizing the cluster. - externalDocs: - description: Resource Tags - url: https://dochub.mongodb.org/core/add-cluster-tag-atlas - items: - $ref: "#/components/schemas/ResourceTag" - terminationProtectionEnabled: - type: boolean - default: false - description: "Flag that indicates whether termination protection is enabled\ - \ on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster.\ - \ If set to `false`, MongoDB Cloud will delete the cluster." - versionReleaseSystem: - type: string - default: LTS - description: "Method by which the cluster maintains the MongoDB versions.\ - \ If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**." - enum: - - LTS - - CONTINUOUS - title: Cluster Description - LegacyAtlasTenantClusterUpgradeRequest: - type: object - description: Request containing target state of tenant cluster to be upgraded - properties: - acceptDataRisksAndForceReplicaSetReconfig: - type: string - format: date-time - description: "If reconfiguration is necessary to regain a primary due to\ - \ a regional outage, submit this field alongside your topology reconfiguration\ - \ to request a new regional outage resistant topology. Forced reconfigurations\ - \ during an outage of the majority of electable nodes carry a risk of\ - \ data loss if replicated writes (even majority committed writes) have\ - \ not been replicated to the new primary node. MongoDB Atlas docs contain\ - \ more information. To proceed with an operation which carries that risk,\ - \ set **acceptDataRisksAndForceReplicaSetReconfig** to the current date." - externalDocs: - description: Reconfiguring a Replica Set during a regional outage - url: https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set - 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 - connectionStrings: - $ref: "#/components/schemas/ClusterConnectionStrings" - createDate: - type: string - format: date-time - description: Date and time when MongoDB Cloud created this serverless instance. - MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. - readOnly: true - diskSizeGB: - type: number - format: double - 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." - maximum: 4096 - minimum: 10 - diskWarmingMode: - type: string - default: FULLY_WARMED - description: Disk warming mode selection. - enum: - - FULLY_WARMED - - VISIBLE_EARLIER - externalDocs: - description: Reduce Secondary Disk Warming Impact - url: https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact - encryptionAtRestProvider: - type: string - description: Cloud service provider that manages your customer keys to provide - an additional layer of Encryption at Rest for the cluster. - enum: - - NONE - - AWS - - AZURE - - GCP - externalDocs: - description: Encryption at Rest using Customer Key Management - url: https://www.mongodb.com/docs/atlas/security-kms-encryption/ - 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: - type: string - description: Unique 24-hexadecimal character string that identifies the - project. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - id: + replicaSetScalingStrategy: type: string - description: Unique 24-hexadecimal digit string that identifies the cluster. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - labels: - type: array - deprecated: true + default: WORKLOAD_TYPE 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. + Set this field to configure the replica set scaling mode for your cluster. - Cluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead. - items: - $ref: "#/components/schemas/ComponentLabel" - links: - type: array - description: "List of one or more Uniform Resource Locators (URLs) that\ - \ point to API sub-resources, related API resources, or both. RFC 5988\ - \ outlines these relationships." - externalDocs: - description: Web Linking Specification (RFC 5988) - url: https://datatracker.ietf.org/doc/html/rfc5988 - items: - $ref: "#/components/schemas/Link" - readOnly: true - mongoDBMajorVersion: - type: string - description: |- - MongoDB major version of the cluster. + By default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes. - 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). + When configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads. - 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- - mongoDBVersion: - type: string - description: Version of MongoDB that the cluster runs. - pattern: "([\\d]+\\.[\\d]+\\.[\\d]+)" - 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." - externalDocs: - description: Connection string URI format. - url: https://docs.mongodb.com/manual/reference/connection-string/ - readOnly: true - mongoURIUpdated: - type: string - format: date-time - description: Date and time when someone last updated the connection string. - MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. - readOnly: true - 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." - externalDocs: - description: Connection string URI format. - url: https://docs.mongodb.com/manual/reference/connection-string/ - readOnly: true - name: - type: string - description: Human-readable label that identifies the cluster. - maxLength: 64 - minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - numShards: - type: integer - format: int32 - default: 1 - description: Number of shards up to 50 to deploy for a sharded cluster. - The resource returns `1` to indicate a replica set and values of `2` and - higher to indicate a sharded cluster. The returned value equals the number - of shards in the cluster. - externalDocs: - description: Sharding - url: https://docs.mongodb.com/manual/sharding/ - maximum: 50 - minimum: 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. + When configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads. + enum: + - SEQUENTIAL + - WORKLOAD_TYPE + - NODE_TYPE externalDocs: - description: 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" + description: Modify the Replica Set Scaling Mode + url: https://dochub.mongodb.org/core/scale-nodes replicationFactor: type: integer format: int32 @@ -38716,6 +40504,10 @@ components: - INSTANCE_NAME - PROCESSOR_NAME title: Streams Matcher Fields + - type: string + enum: + - RULE_ID + title: Log Ingestion Matcher Fields MatcherHostType: type: string description: Value to match or exceed using the specified **matchers.operator**. @@ -39430,6 +41222,7 @@ components: - 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 @@ -39507,6 +41300,8 @@ components: - 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 @@ -39536,6 +41331,9 @@ components: - 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 @@ -39594,9 +41392,13 @@ components: - 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 example: CLUSTER_CREATED title: NDS Audit Types NDSAuditTypeViewForOrg: @@ -40572,7 +42374,7 @@ components: example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -40831,7 +42633,12 @@ components: enum: - AVERAGE operator: - $ref: "#/components/schemas/Operator" + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - LESS_THAN + - GREATER_THAN threshold: type: number format: double @@ -41021,6 +42828,57 @@ components: required: - typeName title: OpsGenie Notification + OrgActiveUserResponse: + type: object + allOf: + - $ref: "#/components/schemas/OrgUserResponse" + - type: object + properties: + country: + type: string + description: Two alphabet characters that identifies MongoDB Cloud user's + geographic location. This parameter uses the ISO 3166-1a2 code format. + example: US + pattern: "^([A-Z]{2})$" + readOnly: true + createdAt: + type: string + format: date-time + description: Date and time when MongoDB Cloud created the current account. + This value is in the ISO 8601 timestamp format in UTC. + readOnly: true + firstName: + type: string + description: First or given name that belongs to the MongoDB Cloud user. + example: John + readOnly: true + lastAuth: + type: string + format: date-time + description: Date and time when the current account last authenticated. + This value is in the ISO 8601 timestamp format in UTC. + readOnly: true + lastName: + type: string + description: "Last name, family name, or surname that belongs to the MongoDB\ + \ Cloud user." + example: Doe + readOnly: true + mobileNumber: + type: string + description: Mobile phone number that belongs to the MongoDB Cloud user. + pattern: "(?:(?:\\\\+?1\\\\s*(?:[.-]\\\\s*)?)?(?:(\\\\s*([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9])\\\ + \\s*)|([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9]))\\\\s*(?:[.-]\\\\\ + s*)?)([2-9]1[02-9]|[2-9][02-9]1|[2-9][02-9]{2})\\\\s*(?:[.-]\\\\s*)?([0-9]{4})$" + readOnly: true + required: + - createdAt + - firstName + - id + - lastName + - orgMembershipStatus + - roles + - username OrgEventTypeViewForOrg: type: string description: Unique identifier of event type. @@ -41371,7 +43229,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/EventViewForOrg" @@ -41383,29 +43241,61 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true + OrgPendingUserResponse: + type: object + allOf: + - $ref: "#/components/schemas/OrgUserResponse" + - type: object + properties: + invitationCreatedAt: + type: string + format: date-time + description: Date and time when MongoDB Cloud sent the invitation. MongoDB + Cloud represents this timestamp in ISO 8601 format in UTC. + readOnly: true + invitationExpiresAt: + type: string + format: date-time + description: Date and time when the invitation from MongoDB Cloud expires. + MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. + readOnly: true + inviterUsername: + type: string + format: email + description: Username of the MongoDB Cloud user who sent the invitation + to join the organization. + readOnly: true + required: + - id + - invitationCreatedAt + - invitationExpiresAt + - inviterUsername + - orgMembershipStatus + - roles + - username OrgServiceAccount: type: object properties: + clientId: + type: string + description: The Client ID of the Service Account. + pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" createdAt: type: string format: date-time - description: Service account creation time. + description: The date that the Service Account was created on. description: type: string - description: Description of the service account. - id: - type: string - description: ID for the service account. - pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" + description: Human readable description for the Service Account. name: type: string - description: Name for service account. + description: Human-readable name for the Service Account. roles: type: array - description: Organization roles assigned to the Service Account. + description: A list of Organization roles associated with the Service Account. items: type: string - description: Organization roles associated with the service account. + description: Organization roles available for Service Accounts. enum: - ORG_MEMBER - ORG_READ_ONLY @@ -41416,7 +43306,7 @@ components: uniqueItems: true secrets: type: array - description: List of secrets. + description: A list of secrets associated with the specified Service Account. items: $ref: "#/components/schemas/ServiceAccountSecret" uniqueItems: true @@ -41425,23 +43315,23 @@ components: properties: description: type: string - description: Human readable description for the service account. + description: Human readable description for the Service Account. maxLength: 250 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" name: type: string - description: Human-readable name for the service account. The name is modifiable + description: Human-readable name for the Service Account. The name is modifiable and does not have to be unique. maxLength: 64 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" roles: type: array - description: Organization roles associated with the service account. + description: A list of organization-level roles for the Service Account. items: type: string - description: Organization roles associated with the service account. + description: Organization roles available for Service Accounts. enum: - ORG_MEMBER - ORG_READ_ONLY @@ -41452,33 +43342,35 @@ components: secretExpiresAfterHours: type: integer format: int32 - description: Secret expiration time. + description: The expiration time of the new Service Account secret. The + expiration is provided in hours. required: - description - name + - roles - secretExpiresAfterHours OrgServiceAccountUpdateRequest: type: object properties: description: type: string - description: Human readable description for the service account. + description: Human readable description for the Service Account. maxLength: 250 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" name: type: string - description: Human-readable name for the service account. The name is modifiable + description: Human-readable name for the Service Account. The name is modifiable and does not have to be unique. maxLength: 64 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" roles: type: array - description: Organization roles associated with the Service account. + description: A list of organization-level roles for the Service Account. items: type: string - description: Organization roles associated with the service account. + description: Organization roles available for Service Accounts. enum: - ORG_MEMBER - ORG_READ_ONLY @@ -41486,6 +43378,158 @@ components: - ORG_BILLING_READ_ONLY - ORG_GROUP_CREATOR - ORG_OWNER + OrgUserRequest: + type: object + properties: + roles: + $ref: "#/components/schemas/OrgUserRolesRequest" + teamIds: + type: array + description: List of unique 24-hexadecimal digit strings that identifies + the teams to which this MongoDB Cloud user belongs. + items: + type: string + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + uniqueItems: true + writeOnly: true + username: + type: string + format: email + description: Email address that represents the username of the MongoDB Cloud + user. + writeOnly: true + required: + - roles + - username + OrgUserResponse: + type: object + discriminator: + mapping: + ACTIVE: "#/components/schemas/OrgActiveUserResponse" + PENDING: "#/components/schemas/OrgPendingUserResponse" + propertyName: orgMembershipStatus + oneOf: + - $ref: "#/components/schemas/OrgPendingUserResponse" + - $ref: "#/components/schemas/OrgActiveUserResponse" + properties: + id: + type: string + description: Unique 24-hexadecimal digit string that identifies the MongoDB + Cloud user. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + orgMembershipStatus: + type: string + description: String enum that indicates whether the MongoDB Cloud user has + a pending invitation to join the organization or they are already active + in the organization. + enum: + - PENDING + - ACTIVE + readOnly: true + roles: + $ref: "#/components/schemas/OrgUserRolesResponse" + teamIds: + type: array + description: List of unique 24-hexadecimal digit strings that identifies + the teams to which this MongoDB Cloud user belongs. + items: + type: string + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + uniqueItems: true + username: + type: string + format: email + description: Email address that represents the username of the MongoDB Cloud + user. + readOnly: true + required: + - id + - orgMembershipStatus + - roles + - username + OrgUserRolesRequest: + type: object + description: Organization and project level roles to assign the MongoDB Cloud + user within one organization. + properties: + groupRoleAssignments: + type: array + description: List of project level role assignments to assign the MongoDB + Cloud user. + items: + $ref: "#/components/schemas/GroupRoleAssignment" + orgRoles: + type: array + description: One or more organization level roles to assign the MongoDB + Cloud user. + items: + type: string + enum: + - ORG_OWNER + - ORG_GROUP_CREATOR + - ORG_BILLING_ADMIN + - ORG_BILLING_READ_ONLY + - ORG_READ_ONLY + - ORG_MEMBER + minItems: 1 + uniqueItems: true + required: + - orgRoles + writeOnly: true + OrgUserRolesResponse: + type: object + description: Organization and project level roles assigned to one MongoDB Cloud + user within one organization. + properties: + groupRoleAssignments: + type: array + description: List of project level role assignments assigned to the MongoDB + Cloud user. + items: + $ref: "#/components/schemas/GroupRoleAssignment" + orgRoles: + type: array + description: One or more organization level roles assigned to the MongoDB + Cloud user. + items: + type: string + enum: + - ORG_OWNER + - ORG_GROUP_CREATOR + - ORG_BILLING_ADMIN + - ORG_BILLING_READ_ONLY + - ORG_READ_ONLY + - ORG_MEMBER + uniqueItems: true + readOnly: true + OrgUserUpdateRequest: + type: object + properties: + roles: + $ref: "#/components/schemas/OrgUserRolesRequest" + teamIds: + type: array + description: List of unique 24-hexadecimal digit strings that identifies + the teams to assign the MongoDB Cloud user. + items: + type: string + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + uniqueItems: true + writeOnly: true OrganizationInvitation: type: object properties: @@ -41697,10 +43741,11 @@ components: restrictEmployeeAccess: type: boolean description: "Flag that indicates whether to block MongoDB Support from\ - \ accessing Atlas infrastructure 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/." + \ 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/." OutboundControlPlaneCloudProviderIPAddresses: type: object description: "List of outbound IP addresses from the Atlas control plane, categorized\ @@ -41873,7 +43918,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/AdvancedClusterDescription" @@ -41901,7 +43946,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/GroupAlertsConfig" @@ -41929,7 +43974,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/AlertViewForNdsGroup" @@ -41957,7 +44002,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ApiKeyUserDetails" @@ -41985,7 +44030,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/CloudAppUser" @@ -42013,7 +44058,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ApiAtlasCheckpointView" @@ -42043,7 +44088,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/CloudDatabaseUser" @@ -42071,7 +44116,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/DiskBackupExportJob" @@ -42099,7 +44144,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/EARPrivateEndpoint" @@ -42111,7 +44156,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedApiAtlasProviderRegionsView: + PaginatedApiAtlasFlexBackupRestoreJob20250101View: type: object properties: links: @@ -42127,10 +44172,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/CloudProviderRegions" + $ref: "#/components/schemas/FlexBackupRestoreJob20250101" readOnly: true totalCount: type: integer @@ -42139,7 +44184,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedApiAtlasServerlessBackupRestoreJobView: + PaginatedApiAtlasFlexBackupSnapshot20240710View: type: object properties: links: @@ -42155,10 +44200,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/ServerlessBackupRestoreJob" + $ref: "#/components/schemas/FlexBackupSnapshot20250101" readOnly: true totalCount: type: integer @@ -42167,7 +44212,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedApiAtlasServerlessBackupSnapshotView: + PaginatedApiAtlasProviderRegionsView: type: object properties: links: @@ -42183,10 +44228,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/ServerlessBackupSnapshot" + $ref: "#/components/schemas/CloudProviderRegions" readOnly: true totalCount: type: integer @@ -42195,7 +44240,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedApiAtlasUSSBackupRestoreJob20250101View: + PaginatedApiAtlasServerlessBackupRestoreJobView: type: object properties: links: @@ -42211,10 +44256,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/USSBackupRestoreJob20250101" + $ref: "#/components/schemas/ServerlessBackupRestoreJob" readOnly: true totalCount: type: integer @@ -42223,7 +44268,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedApiAtlasUSSBackupSnapshot20240710View: + PaginatedApiAtlasServerlessBackupSnapshotView: type: object properties: links: @@ -42239,10 +44284,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/USSBackupSnapshot20250101" + $ref: "#/components/schemas/ServerlessBackupSnapshot" readOnly: true totalCount: type: integer @@ -42267,7 +44312,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/BillingInvoiceMetadata" @@ -42295,7 +44340,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/BillingInvoice" @@ -42323,7 +44368,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/StreamsConnection" @@ -42335,6 +44380,34 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true + PaginatedApiStreamsPrivateLinkView: + type: object + properties: + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + results: + type: array + description: List of returned documents that MongoDB Cloud provides when + completing this request. + items: + $ref: "#/components/schemas/StreamsPrivateLinkConnection" + readOnly: true + totalCount: + type: integer + format: int32 + description: Total number of documents available. MongoDB Cloud omits this + value if `includeCount` is set to `false`. + minimum: 0 + readOnly: true PaginatedApiStreamsStreamProcessorWithStatsView: type: object properties: @@ -42351,7 +44424,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/StreamsProcessorWithStats" @@ -42379,7 +44452,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/StreamsTenant" @@ -42407,7 +44480,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/UserAccessListResponse" @@ -42419,6 +44492,34 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true + PaginatedApiVersions: + type: object + properties: + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + results: + type: array + description: List of returned documents that MongoDB Cloud provides when + completing this request. + items: + $ref: "#/components/schemas/ApiVersion" + readOnly: true + totalCount: + type: integer + format: int32 + description: Total number of documents available. MongoDB Cloud omits this + value if `includeCount` is set to `false`. + minimum: 0 + readOnly: true PaginatedAppUserView: type: object properties: @@ -42435,7 +44536,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/CloudAppUser" @@ -42463,7 +44564,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/Group" @@ -42491,7 +44592,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/MdbAvailableVersion" @@ -42519,7 +44620,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/DiskBackupSnapshotAWSExportBucket" @@ -42547,7 +44648,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/DiskBackupSnapshotExportBucket" @@ -42575,7 +44676,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/DiskBackupSnapshot" @@ -42603,7 +44704,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/DiskBackupReplicaSet" @@ -42631,7 +44732,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/DiskBackupSnapshotRestoreJob" @@ -42659,7 +44760,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/DiskBackupShardedClusterSnapshot" @@ -42688,7 +44789,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/CloudProviderContainer" @@ -42717,7 +44818,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ClusterDescription20240805" @@ -42745,7 +44846,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ConnectedOrgConfig" @@ -42774,7 +44875,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/BaseNetworkPeeringConnectionSettings" @@ -42802,7 +44903,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/MesurementsDatabase" @@ -42830,7 +44931,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/MeasurementDiskPartition" @@ -42858,7 +44959,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/EventTypeDetails" @@ -42886,7 +44987,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/FederationIdentityProvider" @@ -42898,9 +44999,37 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true + PaginatedFlexClusters20250101: + type: object + properties: + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + results: + type: array + description: List of returned documents that MongoDB Cloud provides when + completing this request. + items: + type: object + readOnly: true + totalCount: + type: integer + format: int32 + description: Total number of documents available. MongoDB Cloud omits this + value if `includeCount` is set to `false`. + minimum: 0 + readOnly: true PaginatedGroupServiceAccounts: type: object - description: List of Service Accounts + description: A list of Project Service Accounts. properties: links: type: array @@ -42915,7 +45044,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/GroupServiceAccount" @@ -42943,7 +45072,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ApiHostView_Atlas" @@ -42971,7 +45100,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ThirdPartyIntegration" @@ -42999,7 +45128,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/LegacyAtlasCluster" @@ -43027,7 +45156,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/NetworkPermissionEntry" @@ -43055,7 +45184,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/BackupOnlineArchive" @@ -43083,7 +45212,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/OrgGroup" @@ -43097,7 +45226,7 @@ components: readOnly: true PaginatedOrgServiceAccounts: type: object - description: List of Service Accounts + description: A list of Organization Service Accounts. properties: links: type: array @@ -43112,7 +45241,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/OrgServiceAccount" @@ -43140,7 +45269,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/AtlasOrganization" @@ -43168,7 +45297,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/IngestionPipelineRun" @@ -43196,7 +45325,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/PrivateNetworkEndpointIdEntry" @@ -43224,7 +45353,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/PublicApiUsageDetailsLineItemView" @@ -43252,7 +45381,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/BackupRestoreJob" @@ -43282,7 +45411,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/AuthFederationRoleMapping" @@ -43310,7 +45439,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ServerlessInstanceDescription" @@ -43324,7 +45453,7 @@ components: readOnly: true PaginatedServiceAccountGroup: type: object - description: List of Service Account projects. + description: A list of projects associated with the Service Account. properties: links: type: array @@ -43339,7 +45468,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ServiceAccountGroup" @@ -43351,7 +45480,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedSnapshotView: + PaginatedServiceAccountIPAccessEntryView: type: object properties: links: @@ -43367,10 +45496,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/BackupSnapshot" + $ref: "#/components/schemas/ServiceAccountIPAccessListEntry" readOnly: true totalCount: type: integer @@ -43379,7 +45508,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedTeamRoleView: + PaginatedSnapshotView: type: object properties: links: @@ -43395,10 +45524,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/TeamRole" + $ref: "#/components/schemas/BackupSnapshot" readOnly: true totalCount: type: integer @@ -43407,7 +45536,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedTeamView: + PaginatedTeamRoleView: type: object properties: links: @@ -43423,10 +45552,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/TeamResponse" + $ref: "#/components/schemas/TeamRole" readOnly: true totalCount: type: integer @@ -43435,7 +45564,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedTenantRestoreView: + PaginatedTeamView: type: object properties: links: @@ -43451,10 +45580,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/TenantRestore" + $ref: "#/components/schemas/TeamResponse" readOnly: true totalCount: type: integer @@ -43463,7 +45592,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedTenantSnapshotView: + PaginatedTenantRestoreView: type: object properties: links: @@ -43479,10 +45608,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/BackupTenantSnapshot" + $ref: "#/components/schemas/TenantRestore" readOnly: true totalCount: type: integer @@ -43491,7 +45620,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedUSSInstance20250101: + PaginatedTenantSnapshotView: type: object properties: links: @@ -43507,10 +45636,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - type: object + $ref: "#/components/schemas/BackupTenantSnapshot" readOnly: true totalCount: type: integer @@ -43535,7 +45664,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/UserCert" @@ -44023,6 +46152,13 @@ components: PrivateNetworkEndpointIdEntry: type: object properties: + azureConnectionName: + type: string + description: Connection name that identifies the Azure private endpoint + connection. + 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. @@ -44030,6 +46166,10 @@ components: type: string description: Human-readable label to identify customer's VPC endpoint DNS name. + customerEndpointIPAddress: + type: string + description: IP address used to connect to the Azure private endpoint. + pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" endpointId: type: string description: Unique 22-character alphanumeric string that identifies the @@ -44042,6 +46182,10 @@ components: maxLength: 22 minLength: 22 pattern: "^vpce-[0-9a-f]{17}$" + errorMessage: + type: string + description: Error message describing a failure approving the private endpoint + request. provider: type: string default: AWS @@ -44053,6 +46197,14 @@ components: type: string description: Human-readable label to identify the region of customer's VPC endpoint. + status: + type: string + description: Status of the private endpoint connection request. + enum: + - PENDING + - OK + - FAILED + - DELETING type: type: string default: DATA_LAKE @@ -44122,16 +46274,6 @@ components: - serviceDiscovery - username title: PROMETHEUS - ProxyInfo: - type: object - description: VPC Proxy Information. - properties: - authKey: - type: string - description: Authentication key for the proxy. - dnsName: - type: string - description: DNS name to use to reach the proxy/s. PublicApiUsageDetailsLineItemView: type: object properties: @@ -44223,7 +46365,12 @@ components: enum: - AVERAGE operator: - $ref: "#/components/schemas/Operator" + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - LESS_THAN + - GREATER_THAN threshold: type: number format: double @@ -44274,7 +46421,7 @@ components: example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -44533,7 +46680,12 @@ components: enum: - AVERAGE operator: - $ref: "#/components/schemas/Operator" + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - LESS_THAN + - GREATER_THAN threshold: type: number format: double @@ -44723,7 +46875,7 @@ components: example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -45524,7 +47676,7 @@ components: you loaded the sample dataset. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true completeDate: type: string @@ -46338,7 +48490,7 @@ components: \ this parameter when `\"deliveryType\" : \"download\"`." items: type: string - description: One Uniform Resource Locator that point to the compressed + description: One Uniform Resource Locator that points to the compressed snapshot files for manual download. readOnly: true desiredTimestamp: @@ -46425,7 +48577,7 @@ components: parameter when `"deliveryType":` `"automated"`. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" targetGroupId: type: string description: Unique 24-hexadecimal digit string that identifies the target @@ -46500,7 +48652,7 @@ components: which MongoDB Cloud took this snapshot. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true snapshotType: type: string @@ -46632,7 +48784,7 @@ components: description: Human-readable label that identifies the serverless instance. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" providerSettings: $ref: "#/components/schemas/ServerlessProviderSettings" serverlessBackupOptions: @@ -46701,7 +48853,7 @@ components: description: Human-readable label that identifies the serverless instance. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" writeOnly: true providerSettings: $ref: "#/components/schemas/ServerlessProviderSettings" @@ -46865,7 +49017,12 @@ components: enum: - AVERAGE operator: - $ref: "#/components/schemas/Operator" + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - LESS_THAN + - GREATER_THAN threshold: type: number format: double @@ -47075,7 +49232,11 @@ components: properties: groupId: type: string - description: Unique 24-hexadecimal digit string that identifies the project. + description: "Unique 24-hexadecimal digit string that identifies your project.\ + \ **NOTE**: Groups and projects are synonymous terms. Your group id is\ + \ the same as your project id. For existing groups, your group/project\ + \ id remains the same. The resource and corresponding endpoints use the\ + \ term groups." example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 @@ -47188,6 +49349,54 @@ components: - eventTypeName - id title: ServiceAccount Events + ServiceAccountIPAccessListEntry: + type: object + properties: + cidrBlock: + type: string + description: "Range of network addresses in the access list for the Service\ + \ Account. This parameter requires the range to be expressed in Classless\ + \ Inter-Domain Routing (CIDR) notation of Internet Protocol version 4\ + \ or version 6 addresses. You can set a value for this parameter or **ipAddress**,\ + \ but not for both in the same request." + example: 203.0.113.0/24 + pattern: "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + createdAt: + type: string + format: date-time + description: Date MongoDB Cloud added the entry was added to the Access + List. + readOnly: true + ipAddress: + type: string + description: "Network address in the access list for the Service Account.\ + \ This parameter requires the address to be expressed as one Internet\ + \ Protocol version 4 or version 6 address. You can set a value for this\ + \ parameter or **cidrBlock**, but not for both in the same request." + example: 203.0.113.10 + pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + 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 makes at least one request. + readOnly: true + lastUsedAt: + type: string + format: date-time + description: "Date when MongoDB Cloud received the most recent request that\ + \ originated from this Internet Protocol version 4 or version 6 address.\ + \ The resource returns this parameter when at least one request originates\ + \ from this IP address. MongoDB Cloud updates this parameter each time\ + \ a client accesses the permitted resource, with a delay of up to 5 minutes." + readOnly: true + requestCount: + type: integer + format: int32 + description: The number of requests that has originated from this network + address. + readOnly: true ServiceAccountOrgEvents: type: object description: Service Account event identifies different activities around user @@ -47301,35 +49510,34 @@ components: createdAt: type: string format: date-time - description: Timestamp representing creation time. + description: The date that the secret was created on. readOnly: true expiresAt: type: string format: date-time - description: Timestamp representing secret expiration time. + description: The date for the expiration of the secret. readOnly: true id: type: string - description: Unique 24-hexadecimal character string that identifies the - secret. + description: Unique 24-hexadecimal digit string that identifies the secret. example: 32b6e34b3d91647abb20e7b8 pattern: "^([a-f0-9]{24})$" readOnly: true lastUsedAt: type: string format: date-time - description: Timestamp representing last secret usage. + description: The last time the secret was used. readOnly: true maskedSecretValue: type: string - description: Service Account secret with masked values of the first 20 characters. + description: The masked Service Account secret. example: mdb_ic_sk_...12ce readOnly: true secret: type: string - description: Secret for the service account. It will be returned only the - first time after service account creation. - pattern: "^mdb_sa_sk_[0-9a-zA-Z]{40}$" + description: The secret for the Service Account. It will be returned only + the first time after creation. + pattern: "^mdb_sa_sk_[0-9a-zA-Z_-]{40}$" readOnly: true required: - createdAt @@ -47341,7 +49549,8 @@ components: secretExpiresAfterHours: type: integer format: int32 - description: Number of hours representing validity duration for secret. + description: The expiration time of the new Service Account secret. The + expiration is provided in hours. required: - secretExpiresAfterHours ShardEntry: @@ -47964,17 +50173,19 @@ components: StreamsDLQ: type: object description: Dead letter queue for the stream processor. + externalDocs: + url: https://www.mongodb.com/docs/atlas/reference/glossary/#std-term-dead-letter-queue properties: coll: type: string - description: Name of the collection that will be used for the DLQ. + description: Name of the collection to use for the DLQ. connectionName: type: string - description: Connection name that will be used to write DLQ messages to. - Has to be an Atlas connection. + description: Name of the connection to write DLQ messages to. Must be an + Atlas connection. db: type: string - description: Name of the database that will be used for the DLQ. + description: Name of the database to use for the DLQ. links: type: array description: "List of one or more Uniform Resource Locators (URLs) that\ @@ -48143,8 +50354,6 @@ components: group.protocol.type: consumer networking: $ref: "#/components/schemas/StreamsKafkaNetworking" - proxyInfo: - $ref: "#/components/schemas/ProxyInfo" security: $ref: "#/components/schemas/StreamsKafkaSecurity" StreamsKafkaNetworking: @@ -48170,6 +50379,13 @@ components: type: object description: Information about the networking access. properties: + connectionId: + type: string + description: Reserved. Will be used by PRIVATE_LINK connection type. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" links: type: array description: "List of one or more Uniform Resource Locators (URLs) that\ @@ -48183,14 +50399,18 @@ components: readOnly: true name: type: string - description: Id of the vpc peer when the type is VPC. + description: Reserved. Will be used by PRIVATE_LINK connection type. type: type: string - description: Selected networking type. Either PUBLIC or VPC. Defaults to - PUBLIC + description: "Selected networking type. Either PUBLIC, VPC or PRIVATE_LINK.\ + \ Defaults to PUBLIC. For VPC, ensure that VPC peering exists and connectivity\ + \ has been established between Atlas VPC and the VPC where Kafka cluster\ + \ is hosted for the connection to function properly. PRIVATE_LINK support\ + \ is coming soon." enum: - PUBLIC - VPC + - PRIVATE_LINK title: Networking Access Type StreamsKafkaSecurity: type: object @@ -48269,6 +50489,52 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true + StreamsPrivateLinkConnection: + type: object + description: Container for metadata needed to create a Private Link connection. + properties: + _id: + type: string + description: The ID of the Private Link connection. + dnsDomain: + type: string + description: Domain name of Confluent cluster. + dnsSubDomain: + type: array + description: Sub-Domain name of Confluent cluster. These are typically your + availability zones. + items: + type: string + interfaceEndpointId: + type: string + description: Interface endpoint ID that is created from the service endpoint + ID provided. + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + provider: + type: string + description: Provider where the Kafka cluster is deployed. + region: + type: string + description: Domain name of Confluent cluster. + serviceEndpointId: + type: string + description: AWS Service Endpoint ID. + state: + type: string + description: State the connection is in. + vendor: + type: string + description: Vendor who manages the Kafka cluster. StreamsProcessor: type: object description: An atlas stream processor. @@ -48302,6 +50568,9 @@ components: type: array description: Stream aggregation pipeline you want to apply to your streaming data. + externalDocs: + description: Supported Aggregation Pipeline Stages + url: https://www.mongodb.com/docs/atlas/atlas-stream-processing/stream-aggregation/#std-label-stream-aggregation items: $ref: "#/components/schemas/Document" StreamsProcessorWithStats: @@ -48332,6 +50601,8 @@ components: type: string description: Human-readable name of the stream processor. readOnly: true + options: + $ref: "#/components/schemas/StreamsOptions" pipeline: type: array description: Stream aggregation pipeline you want to apply to your streaming @@ -48341,15 +50612,20 @@ components: readOnly: true state: type: string - description: The state of the stream processor. + description: "The state of the stream processor. Commonly occurring states\ + \ are 'CREATED', 'STARTED', 'STOPPED' and 'FAILED'." readOnly: true stats: type: object additionalProperties: type: object description: The stats associated with the stream processor. + externalDocs: + url: https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor readOnly: true description: The stats associated with the stream processor. + externalDocs: + url: https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor readOnly: true required: - _id @@ -48360,6 +50636,26 @@ components: type: object allOf: - $ref: "#/components/schemas/StreamsConnection" + StreamsSampleConnections: + type: object + description: Sample connections to add to SPI. + properties: + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + solar: + type: boolean + default: false + description: Flag that indicates whether to add a 'sample_stream_solar' + connection. StreamsTenant: type: object properties: @@ -48411,6 +50707,8 @@ components: name: type: string description: Human-readable label that identifies the stream instance. + sampleConnections: + $ref: "#/components/schemas/StreamsSampleConnections" streamConfig: $ref: "#/components/schemas/StreamConfig" SummaryNotification: @@ -49071,7 +51369,7 @@ components: description: Human-readable label that identifies the source cluster. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true deliveryType: type: string @@ -49181,6 +51479,8 @@ components: required: - snapshotId - targetDeploymentItemName + TenantWithSampleConnections: + type: object TextSearchHostStatusDetail: type: object properties: @@ -49397,808 +51697,199 @@ components: type: array description: List of documents detailing index status on each host. items: - $ref: "#/components/schemas/TextSearchHostStatusDetail" - synonymMappingStatus: - type: string - description: Status that describes this index's synonym mappings. This - status appears only if the index has synonyms defined. - enum: - - FAILED - - BUILDING - - READY - synonymMappingStatusDetail: - type: array - description: A list of documents describing the status of the index's - synonym mappings on each search host. Only appears if the index has - synonyms defined. - items: - type: object - additionalProperties: - $ref: "#/components/schemas/SynonymMappingStatusDetail" - title: Text Search Index Response - TextSearchIndexStatusDetail: - type: object - description: Contains status information about a text search index. - properties: - definition: - $ref: "#/components/schemas/TextSearchIndexDefinition" - definitionVersion: - $ref: "#/components/schemas/SearchIndexDefinitionVersion" - message: - type: string - description: Optional message describing an error. - queryable: - type: boolean - description: Flag that indicates whether the index generation is queryable - on the host. - status: - type: string - description: | - Condition of the search index when you made this request. - - | Status | Index Condition | - |---|---| - | DELETING | The index is being deleted. | - | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. | - | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. | - | PENDING | Atlas has not yet started building the index. | - | BUILDING | Atlas is building or re-building the index after an edit. | - | READY | The index is ready and can support queries. | - enum: - - DELETING - - FAILED - - STALE - - PENDING - - BUILDING - - READY - - DOES_NOT_EXIST - synonymMappingStatus: - type: string - description: Status that describes this index's synonym mappings. This status - appears only if the index has synonyms defined. - enum: - - FAILED - - BUILDING - - READY - synonymMappingStatusDetail: - type: array - description: List of synonym statuses by mapping. - items: - $ref: "#/components/schemas/SynonymMappingStatusDetailMap" - title: Text Search Index Status Detail - ThirdPartyIntegration: - type: object - description: Collection of settings that describe third-party integrations. - discriminator: - mapping: - DATADOG: "#/components/schemas/Datadog" - MICROSOFT_TEAMS: "#/components/schemas/MicrosoftTeams" - NEW_RELIC: "#/components/schemas/NewRelic" - OPS_GENIE: "#/components/schemas/OpsGenie" - PAGER_DUTY: "#/components/schemas/PagerDuty" - PROMETHEUS: "#/components/schemas/Prometheus" - SLACK: "#/components/schemas/Slack" - VICTOR_OPS: "#/components/schemas/VictorOps" - WEBHOOK: "#/components/schemas/Webhook" - propertyName: type - properties: - id: - type: string - description: Integration id. - nullable: true - type: - type: string - description: Integration type - enum: - - PAGER_DUTY - - SLACK - - DATADOG - - NEW_RELIC - - OPS_GENIE - - VICTOR_OPS - - WEBHOOK - - HIP_CHAT - - PROMETHEUS - - MICROSOFT_TEAMS - title: Integration Type - title: Third-Party Integration - TimeMetricAlertView: - type: object - properties: - acknowledgedUntil: - type: string - format: date-time - description: |- - Date and time until which this alert has been acknowledged. This parameter expresses its value in the 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. - acknowledgementComment: - type: string - description: Comment that a MongoDB Cloud user submitted when acknowledging - the alert. - example: Expiration on 3/19. Silencing for 7days. - maxLength: 200 - acknowledgingUsername: - type: string - format: email - description: MongoDB Cloud username of the person who acknowledged the alert. - The response returns this parameter if a MongoDB Cloud user previously - acknowledged this alert. - readOnly: true - alertConfigId: - type: string - description: Unique 24-hexadecimal digit string that identifies the alert - configuration that sets this alert. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - clusterName: - 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." - example: cluster1 - maxLength: 64 - minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - readOnly: true - created: - type: string - format: date-time - description: Date and time when MongoDB Cloud created this alert. This parameter - expresses its value in the ISO 8601 timestamp format - in UTC. - readOnly: true - currentValue: - $ref: "#/components/schemas/TimeMetricValueView" - eventTypeName: - $ref: "#/components/schemas/HostMetricEventTypeViewAlertable" - groupId: - type: string - description: Unique 24-hexadecimal digit string that identifies the project - that owns this alert. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - 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. - example: cloud-test.mongodb.com:27017 - readOnly: true - id: - type: string - description: Unique 24-hexadecimal digit string that identifies this alert. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - lastNotified: - type: string - format: date-time - description: Date and time that any notifications were last sent for this - alert. This parameter expresses its value in the ISO 8601 timestamp format - in UTC. The resource returns this parameter if MongoDB Cloud has sent - notifications for this alert. - readOnly: true - links: - type: array - description: "List of one or more Uniform Resource Locators (URLs) that\ - \ point to API sub-resources, related API resources, or both. RFC 5988\ - \ outlines these relationships." - externalDocs: - description: Web Linking Specification (RFC 5988) - url: https://datatracker.ietf.org/doc/html/rfc5988 - items: - $ref: "#/components/schemas/Link" - readOnly: true - 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. - example: ASSERT_USER - readOnly: true - orgId: - type: string - description: Unique 24-hexadecimal character string that identifies the - organization that owns the project to which this alert applies. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - 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." - example: event-replica-set - readOnly: true - resolved: - type: string - format: date-time - description: "Date and time that this alert changed to `\"status\" : \"\ - CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp\ - \ format in UTC. The resource returns this parameter once `\"status\"\ - \ : \"CLOSED\"`." - readOnly: true - status: - type: string - description: State of this alert at the time you requested its details. - enum: - - CANCELLED - - CLOSED - - OPEN - - TRACKING - example: OPEN - readOnly: true - updated: - type: string - format: date-time - description: Date and time when someone last updated this alert. This parameter - expresses its value in the ISO 8601 timestamp format - in UTC. - readOnly: true - required: - - alertConfigId - - created - - eventTypeName - - id - - status - - updated - TimeMetricEventView: - type: object - properties: - apiKeyId: - type: string - description: "Unique 24-hexadecimal digit string that identifies the [API\ - \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\ - \ triggered the event. If this resource returns this parameter, it doesn't\ - \ return the **userId** parameter." - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - created: - type: string - format: date-time - description: Date and time when this event occurred. This parameter expresses - its value in the ISO 8601 timestamp format in UTC. - readOnly: true - currentValue: - $ref: "#/components/schemas/TimeMetricValueView" - eventTypeName: - $ref: "#/components/schemas/HostMetricEventTypeView" - groupId: - type: string - description: Unique 24-hexadecimal digit string that identifies the project - in which the event occurred. The **eventId** identifies the specific event. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - id: - type: string - description: Unique 24-hexadecimal digit string that identifies the event. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - isGlobalAdmin: - type: boolean - default: false - description: Flag that indicates whether a MongoDB employee triggered the - specified event. - readOnly: true - links: - type: array - description: "List of one or more Uniform Resource Locators (URLs) that\ - \ point to API sub-resources, related API resources, or both. RFC 5988\ - \ outlines these relationships." - externalDocs: - description: Web Linking Specification (RFC 5988) - url: https://datatracker.ietf.org/doc/html/rfc5988 - items: - $ref: "#/components/schemas/Link" - readOnly: true - 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: - type: string - description: Unique 24-hexadecimal digit string that identifies the organization - to which these events apply. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - port: - type: integer - format: int32 - description: IANA port on which the MongoDB process listens for requests. - example: 27017 - readOnly: true - publicKey: - type: string - format: email - description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\ - \ that triggered the event. If this resource returns this parameter, it\ - \ doesn't return the **username** parameter." - example: test.user@mongodb.com - readOnly: true - raw: - $ref: "#/components/schemas/raw" - remoteAddress: - type: string - description: IPv4 or IPv6 address from which the user triggered this event. - example: 216.172.40.186 - pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" - readOnly: true - replicaSetName: - type: string - description: Human-readable label of the replica set associated with the - event. - example: event-replica-set - readOnly: true - shardName: - type: string - description: Human-readable label of the shard associated with the event. - example: event-sh-01 - readOnly: true - userId: - type: string - description: "Unique 24-hexadecimal digit string that identifies the console\ - \ user who triggered the event. If this resource returns this parameter,\ - \ it doesn't return the **apiKeyId** parameter." - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - username: - type: string - format: email - description: "Email address for the user who triggered this event. If this\ - \ resource returns this parameter, it doesn't return the **publicApiKey**\ - \ parameter." - example: test.user@mongodb.com - readOnly: true - required: - - created - - eventTypeName - - id - TimeMetricThresholdView: - 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: - $ref: "#/components/schemas/Operator" - threshold: - type: number - format: double - description: "Value of metric that, when exceeded, triggers an alert." - units: - $ref: "#/components/schemas/TimeMetricUnits" - required: - - metricName - TimeMetricUnits: - type: string - default: HOURS - description: "Element used to express the quantity. This can be an element of\ - \ time, storage capacity, and the like." - enum: - - NANOSECONDS - - MILLISECONDS - - MILLION_MINUTES - - SECONDS - - MINUTES - - HOURS - - DAYS - title: Time Metric Units - TimeMetricValueView: - type: object - description: Measurement of the **metricName** recorded at the time of the event. - properties: - number: - type: number - format: double - description: Amount of the **metricName** recorded at the time of the event. - This value triggered the alert. - readOnly: true - units: - $ref: "#/components/schemas/TimeMetricUnits" - readOnly: true - title: Time Metric Value - TokenFilterEnglishPossessive: - type: object - description: Filter that removes possessives (trailing 's) from words. - properties: - type: - type: string - description: Human-readable label that identifies this token filter type. - enum: - - englishPossessive - required: - - type - title: englishPossessive - TokenFilterFlattenGraph: - type: object - description: "Filter that transforms a token filter graph, such as the token\ - \ filter graph that the wordDelimiterGraph token filter produces, into a flat\ - \ form suitable for indexing." - properties: - type: - type: string - description: Human-readable label that identifies this token filter type. - enum: - - flattenGraph - required: - - type - title: flattenGraph - TokenFilterPorterStemming: + $ref: "#/components/schemas/TextSearchHostStatusDetail" + synonymMappingStatus: + type: string + description: Status that describes this index's synonym mappings. This + status appears only if the index has synonyms defined. + enum: + - FAILED + - BUILDING + - READY + synonymMappingStatusDetail: + type: array + description: A list of documents describing the status of the index's + synonym mappings on each search host. Only appears if the index has + synonyms defined. + items: + type: object + additionalProperties: + $ref: "#/components/schemas/SynonymMappingStatusDetail" + title: Text Search Index Response + TextSearchIndexStatusDetail: type: object - 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. + description: Contains status information about a text search index. properties: - type: + definition: + $ref: "#/components/schemas/TextSearchIndexDefinition" + definitionVersion: + $ref: "#/components/schemas/SearchIndexDefinitionVersion" + message: type: string - description: Human-readable label that identifies this token filter type. - enum: - - porterStemming - required: - - type - title: porterStemming - TokenFilterSpanishPluralStemming: - type: object - description: Filter that stems Spanish plural words. It expects lowercase text. - properties: - type: + description: Optional message describing an error. + queryable: + type: boolean + description: Flag that indicates whether the index generation is queryable + on the host. + status: type: string - description: Human-readable label that identifies this token filter type. + description: | + Condition of the search index when you made this request. + + | Status | Index Condition | + |---|---| + | DELETING | The index is being deleted. | + | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. | + | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. | + | PENDING | Atlas has not yet started building the index. | + | BUILDING | Atlas is building or re-building the index after an edit. | + | READY | The index is ready and can support queries. | enum: - - spanishPluralStemming - required: - - type - title: spanishPluralStemming - TokenFilterStempel: - type: object - description: Filter that uses Lucene's default Polish stemmer table to stem - words in the Polish language. It expects lowercase text. - externalDocs: - description: Default Polish stemmer table - url: https://lucene.apache.org/core/9_2_0/analysis/stempel/org/apache/lucene/analysis/pl/PolishAnalyzer.html#DEFAULT_STEMMER_FILE - properties: - type: + - DELETING + - FAILED + - STALE + - PENDING + - BUILDING + - READY + - DOES_NOT_EXIST + synonymMappingStatus: type: string - description: Human-readable label that identifies this token filter type. + description: Status that describes this index's synonym mappings. This status + appears only if the index has synonyms defined. enum: - - stempel - required: - - type - title: stempel - TokenFilterWordDelimiterGraph: + - FAILED + - BUILDING + - READY + synonymMappingStatusDetail: + type: array + description: List of synonym statuses by mapping. + items: + $ref: "#/components/schemas/SynonymMappingStatusDetailMap" + title: Text Search Index Status Detail + ThirdPartyIntegration: type: object - description: Filter that splits tokens into sub-tokens based on configured rules. + description: Collection of settings that describe third-party integrations. + discriminator: + mapping: + DATADOG: "#/components/schemas/Datadog" + MICROSOFT_TEAMS: "#/components/schemas/MicrosoftTeams" + NEW_RELIC: "#/components/schemas/NewRelic" + OPS_GENIE: "#/components/schemas/OpsGenie" + PAGER_DUTY: "#/components/schemas/PagerDuty" + PROMETHEUS: "#/components/schemas/Prometheus" + SLACK: "#/components/schemas/Slack" + VICTOR_OPS: "#/components/schemas/VictorOps" + WEBHOOK: "#/components/schemas/Webhook" + propertyName: type properties: - delimiterOptions: - type: object - description: Object that contains the rules that determine how to split - words into sub-words. - properties: - concatenateAll: - type: boolean - default: false - description: Flag that indicates whether to concatenate runs. - concatenateNumbers: - type: boolean - default: false - description: Flag that indicates whether to concatenate runs of sub-numbers. - concatenateWords: - type: boolean - default: false - description: Flag that indicates whether to concatenate runs of sub-words. - generateNumberParts: - type: boolean - default: true - description: "Flag that indicates whether to split tokens based on sub-numbers.\ - \ For example, if `true`, this option splits `100-2` into `100` and\ - \ `2`." - generateWordParts: - type: boolean - default: true - description: Flag that indicates whether to split tokens based on sub-words. - ignoreKeywords: - type: boolean - default: false - description: Flag that indicates whether to skip tokens with the `keyword` - attribute set to `true` - preserveOriginal: - type: boolean - default: true - description: Flag that indicates whether to generate tokens of the original - words. - splitOnCaseChange: - type: boolean - default: true - description: Flag that indicates whether to split tokens based on letter-case - transitions. - splitOnNumerics: - type: boolean - default: true - description: Flag that indicates whether to split tokens based on letter-number - transitions. - stemEnglishPossessive: - type: boolean - default: true - description: Flag that indicates whether to remove trailing possessives - from each sub-word. - protectedWords: - type: object - description: Object that contains options for protected words. - properties: - ignoreCase: - type: boolean - default: true - description: Flag that indicates whether to ignore letter case sensitivity - for protected words. - words: - type: array - description: List that contains the tokens to protect from delimination. - items: - type: string - required: - - words - type: + id: type: string - description: Human-readable label that identifies this token filter type. - enum: - - wordDelimiterGraph - required: - - type - title: wordDelimiterGraph - TokenFilterkStemming: - type: object - description: Filter that combines algorithmic stemming with a built-in dictionary - for the English language to stem words. - properties: + description: Integration id. + nullable: true type: type: string - description: Human-readable label that identifies this token filter type. + description: Integration type enum: - - kStemming - required: - - type - title: kStemming - TriggerIngestionPipelineRequest: - type: object - properties: - datasetRetentionPolicy: - $ref: "#/components/schemas/DatasetRetentionPolicy" - snapshotId: - type: string - description: Unique 24-hexadecimal character string that identifies the - snapshot. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - writeOnly: true - required: - - snapshotId - USSBackupRestoreJob20250101: + - PAGER_DUTY + - SLACK + - DATADOG + - NEW_RELIC + - OPS_GENIE + - VICTOR_OPS + - WEBHOOK + - HIP_CHAT + - PROMETHEUS + - MICROSOFT_TEAMS + title: Integration Type + title: Third-Party Integration + TimeMetricAlertView: type: object - description: Details for one restore job of a USS instance. properties: - deliveryType: - type: string - description: Means by which this resource returns the snapshot to the requesting - MongoDB Cloud user. - enum: - - RESTORE - - DOWNLOAD - readOnly: true - expirationDate: - type: string - format: date-time - description: Date and time when the download link no longer works. This - parameter expresses its value in the ISO 8601 timestamp format in UTC. - readOnly: true - id: - type: string - description: Unique 24-hexadecimal digit string that identifies the restore - job. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - instanceName: - type: string - description: Human-readable label that identifies the source instance. - maxLength: 64 - minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - readOnly: true - links: - type: array - description: "List of one or more Uniform Resource Locators (URLs) that\ - \ point to API sub-resources, related API resources, or both. RFC 5988\ - \ outlines these relationships." - externalDocs: - description: Web Linking Specification (RFC 5988) - url: https://datatracker.ietf.org/doc/html/rfc5988 - items: - $ref: "#/components/schemas/Link" - readOnly: true - projectId: - type: string - description: Unique 24-hexadecimal digit string that identifies the project - from which the restore job originated. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - restoreFinishedDate: + acknowledgedUntil: type: string format: date-time - 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. - readOnly: true - restoreScheduledDate: + 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. + acknowledgementComment: type: string - format: date-time - description: Date and time when MongoDB Cloud will restore this snapshot. - This parameter expresses its value in the ISO 8601 timestamp format in - UTC. - readOnly: true - snapshotFinishedDate: + description: Comment that a MongoDB Cloud user submitted when acknowledging + the alert. + example: Expiration on 3/19. Silencing for 7days. + maxLength: 200 + acknowledgingUsername: type: string - format: date-time - description: Date and time when MongoDB Cloud completed writing this snapshot. - This parameter expresses its value in the ISO 8601 timestamp format in - UTC. + format: email + description: MongoDB Cloud username of the person who acknowledged the alert. + The response returns this parameter if a MongoDB Cloud user previously + acknowledged this alert. readOnly: true - snapshotId: + alertConfigId: type: string - description: Unique 24-hexadecimal digit string that identifies the snapshot - to restore. + description: Unique 24-hexadecimal digit string that identifies the alert + configuration that sets this alert. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true - 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. - enum: - - PENDING - - QUEUED - - RUNNING - - FAILED - - COMPLETED - readOnly: true - targetDeploymentItemName: + clusterName: type: string - description: Human-readable label that identifies the instance or cluster - on the target project to which you want to restore the snapshot. You can - restore the snapshot to another USS instance or Dedicated cluster tier. + description: "Human-readable label that identifies the cluster to which\ + \ this alert applies. This resource returns this parameter for alerts\ + \ of events impacting backups, replica sets, or sharded clusters." + example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true - targetProjectId: + created: type: string - description: Unique 24-hexadecimal digit string that identifies the project - that contains the instance or cluster to which you want to restore the - snapshot. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" + format: date-time + description: Date and time when MongoDB Cloud created this alert. This parameter + expresses its value in the ISO 8601 timestamp format + in UTC. readOnly: true - title: USS Backup Restore Job - USSBackupRestoreJobCreate20250101: - type: object - description: Details to create one restore job of a USS instance. - properties: - _snapshotId: - type: string - description: Unique 24-hexadecimal digit string that identifies the snapshot - to restore. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - writeOnly: true - _targetDeploymentItemName: - type: string - description: Human-readable label that identifies the instance or cluster - on the target project to which you want to restore the snapshot. You can - restore the snapshot to another USS instance or Dedicated cluster tier. - maxLength: 64 - minLength: 1 - pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" - writeOnly: true - _targetProjectId: + currentValue: + $ref: "#/components/schemas/TimeMetricValueView" + eventTypeName: + $ref: "#/components/schemas/HostMetricEventTypeViewAlertable" + groupId: type: string description: Unique 24-hexadecimal digit string that identifies the project - that contains the instance or cluster to which you want to restore the - snapshot. + that owns this alert. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" - writeOnly: true - deliveryType: - type: string - description: Means by which this resource returns the snapshot to the requesting - MongoDB Cloud user. - enum: - - RESTORE - - DOWNLOAD readOnly: true - expirationDate: + hostnameAndPort: type: string - format: date-time - description: Date and time when the download link no longer works. This - parameter expresses its value in the ISO 8601 timestamp format in UTC. + description: Hostname and port of the host to which this alert applies. + The resource returns this parameter for alerts of events impacting hosts + or replica sets. + example: cloud-test.mongodb.com:27017 readOnly: true id: type: string - description: Unique 24-hexadecimal digit string that identifies the restore - job. + description: Unique 24-hexadecimal digit string that identifies this alert. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true - instanceName: + lastNotified: type: string - description: Human-readable label that identifies the source instance. - maxLength: 64 - minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + format: date-time + 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. readOnly: true links: type: array @@ -50211,94 +51902,114 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true - projectId: + metricName: type: string - description: Unique 24-hexadecimal digit string that identifies the project - from which the restore job originated. + 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. + example: ASSERT_USER + readOnly: true + orgId: + type: string + description: Unique 24-hexadecimal character string that identifies the + organization that owns the project to which this alert applies. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true - restoreFinishedDate: - type: string - format: date-time - 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. - readOnly: true - restoreScheduledDate: + replicaSetName: type: string - format: date-time - description: Date and time when MongoDB Cloud will restore this snapshot. - This parameter expresses its value in the ISO 8601 timestamp format in - UTC. + description: "Name of the replica set to which this alert applies. The response\ + \ returns this parameter for alerts of events impacting backups, hosts,\ + \ or replica sets." + example: event-replica-set readOnly: true - snapshotFinishedDate: + resolved: type: string format: date-time - description: Date and time when MongoDB Cloud completed writing this snapshot. - This parameter expresses its value in the ISO 8601 timestamp format in - UTC. - readOnly: true - snapshotUrl: - type: string - description: "Internet address from which you can download the compressed\ - \ snapshot files. The resource returns this parameter when `\"deliveryType\"\ - \ : \"DOWNLOAD\"`." + 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\"`." readOnly: true status: type: string - description: Phase of the restore workflow for this job at the time this - resource made this request. + description: State of this alert at the time you requested its details. enum: - - PENDING - - QUEUED - - RUNNING - - FAILED - - COMPLETED + - CANCELLED + - CLOSED + - OPEN + - TRACKING + example: OPEN + readOnly: true + updated: + type: string + format: date-time + description: Date and time when someone last updated this alert. This parameter + expresses its value in the ISO 8601 timestamp format + in UTC. readOnly: true required: - - _snapshotId - - _targetDeploymentItemName - title: Create USS Backup Restore Job - USSBackupSettings20250101: + - alertConfigId + - created + - eventTypeName + - id + - status + - updated + TimeMetricEventView: type: object - description: USS backup configuration properties: - enabled: - type: boolean - default: true - description: "Flag that indicates whether backups are performed for this\ - \ USS instance. Backup uses [TODO](TODO) for USS instances." + apiKeyId: + type: string + description: "Unique 24-hexadecimal digit string that identifies the [API\ + \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\ + \ triggered the event. If this resource returns this parameter, it doesn't\ + \ return the **userId** parameter." + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" readOnly: true - readOnly: true - title: USS backup configuration - USSBackupSnapshot20250101: - type: object - description: Details for one snapshot of a USS instance. - properties: - expiration: + created: type: string format: date-time - description: Date and time when the download link no longer works. This - parameter expresses its value in the ISO 8601 timestamp format in UTC. + description: Date and time when this event occurred. This parameter expresses + its value in the ISO 8601 timestamp format in UTC. readOnly: true - finishTime: + currentValue: + $ref: "#/components/schemas/TimeMetricValueView" + eventTypeName: + $ref: "#/components/schemas/HostMetricEventTypeView" + groupId: type: string - format: date-time - description: Date and time when MongoDB Cloud completed writing this snapshot. - This parameter expresses its value in the ISO 8601 timestamp format in - UTC. + description: Unique 24-hexadecimal digit string that identifies the project + in which the event occurred. The **eventId** identifies the specific event. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" readOnly: true id: type: string - description: Unique 24-hexadecimal digit string that identifies the snapshot. + description: Unique 24-hexadecimal digit string that identifies the event. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true + isGlobalAdmin: + type: boolean + default: false + description: Flag that indicates whether a MongoDB employee triggered the + specified event. + readOnly: true links: type: array description: "List of one or more Uniform Resource Locators (URLs) that\ @@ -50310,307 +52021,307 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true - mongoDBVersion: - type: string - description: MongoDB host version that the snapshot runs. - readOnly: true - scheduledTime: - type: string - format: date-time - description: Date and time when MongoDB Cloud will take the snapshot. This - parameter expresses its value in the ISO 8601 timestamp format in UTC. - readOnly: true - startTime: - type: string - format: date-time - description: Date and time when MongoDB Cloud began taking the snapshot. - This parameter expresses its value in the ISO 8601 timestamp format in - UTC. - readOnly: true - status: + metricName: type: string - description: Phase of the workflow for this snapshot at the time this resource - made this request. - enum: - - PENDING - - QUEUED - - RUNNING - - FAILED - - COMPLETED + description: Human-readable label of the metric associated with the **alertId**. + This field may change type of **currentValue** field. readOnly: true - title: USS Backup Snapshot - USSBackupSnapshotDownloadCreate20250101: - type: object - description: Details for one backup snapshot download of a USS instance. - properties: - _snapshotId: + orgId: type: string - description: Unique 24-hexadecimal digit string that identifies the snapshot - to download. + description: Unique 24-hexadecimal digit string that identifies the organization + to which these events apply. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" - writeOnly: true - links: - type: array - description: "List of one or more Uniform Resource Locators (URLs) that\ - \ point to API sub-resources, related API resources, or both. RFC 5988\ - \ outlines these relationships." - externalDocs: - description: Web Linking Specification (RFC 5988) - url: https://datatracker.ietf.org/doc/html/rfc5988 - items: - $ref: "#/components/schemas/Link" readOnly: true - required: - - _snapshotId - title: USS Backup Snapshot Download Create - USSConnectionStrings20250101: - type: object - description: Collection of Uniform Resource Locators that point to the MongoDB - database. - externalDocs: - description: Connection string URI format. - url: https://docs.mongodb.com/manual/reference/connection-string/ - properties: - standard: - type: string - description: Public connection string that you can use to connect to this - cluster. This connection string uses the mongodb:// protocol. - externalDocs: - description: Connection String URI Format - url: https://docs.mongodb.com/manual/reference/connection-string/ + port: + type: integer + format: int32 + description: IANA port on which the MongoDB process listens for requests. + example: 27017 readOnly: true - standardSrv: + publicKey: type: string - description: Public connection string that you can use to connect to this - USS instance. This connection string uses the `mongodb+srv://` protocol. - externalDocs: - description: Connection String URI Format - url: https://docs.mongodb.com/manual/reference/connection-string/ + format: email + description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\ + \ that triggered the event. If this resource returns this parameter, it\ + \ doesn't return the **username** parameter." + example: test.user@mongodb.com readOnly: true - readOnly: true - title: USS Instance Connection Strings - USSInstanceDescription20250101: - type: object - description: Group of settings that configure a MongoDB USS instance. - properties: - backupSettings: - $ref: "#/components/schemas/USSBackupSettings20250101" - clusterType: + raw: + $ref: "#/components/schemas/raw" + remoteAddress: type: string - description: USS instance topology. - enum: - - REPLICASET - - LOADBALANCED + description: IPv4 or IPv6 address from which the user triggered this event. + example: 216.172.40.186 + pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" readOnly: true - connectionStrings: - $ref: "#/components/schemas/USSConnectionStrings20250101" - createDate: + replicaSetName: type: string - format: date-time - description: Date and time when MongoDB Cloud created this instance. This - parameter expresses its value in ISO 8601 format in UTC. + description: Human-readable label of the replica set associated with the + event. + example: event-replica-set readOnly: true - groupId: + shardName: type: string - description: Unique 24-hexadecimal character string that identifies the - project. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" + description: Human-readable label of the shard associated with the event. + example: event-sh-01 readOnly: true - id: + userId: type: string - description: Unique 24-hexadecimal digit string that identifies the instance. + description: "Unique 24-hexadecimal digit string that identifies the console\ + \ user who triggered the event. If this resource returns this parameter,\ + \ it doesn't return the **apiKeyId** parameter." example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true - links: - type: array - description: "List of one or more Uniform Resource Locators (URLs) that\ - \ point to API sub-resources, related API resources, or both. RFC 5988\ - \ outlines these relationships." - externalDocs: - description: Web Linking Specification (RFC 5988) - url: https://datatracker.ietf.org/doc/html/rfc5988 - items: - $ref: "#/components/schemas/Link" - readOnly: true - mongoDBVersion: + username: type: string - description: Version of MongoDB that the instance runs. - pattern: "([\\d]+\\.[\\d]+\\.[\\d]+)" + format: email + description: "Email address for the user who triggered this event. If this\ + \ resource returns this parameter, it doesn't return the **publicApiKey**\ + \ parameter." + example: test.user@mongodb.com readOnly: true - name: + required: + - created + - eventTypeName + - id + TimeMetricThresholdView: + type: object + properties: + metricName: type: string - description: Human-readable label that identifies the instance. - maxLength: 64 - minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - readOnly: true - providerSettings: - $ref: "#/components/schemas/USSProviderSettings20250101" - stateName: + description: Human-readable label that identifies the metric against which + MongoDB Cloud checks the configured **metricThreshold.threshold**. + mode: type: string - description: Human-readable label that indicates the current operating condition - of this instance. + description: MongoDB Cloud computes the current metric value as an average. enum: - - IDLE - - CREATING - - UPDATING - - DELETING - - REPAIRING - readOnly: true - tags: - type: array - description: List that contains key-value pairs between 1 to 255 characters - in length for tagging and categorizing the instance. - externalDocs: - description: Resource Tags - url: https://dochub.mongodb.org/core/add-cluster-tag-atlas - items: - $ref: "#/components/schemas/ResourceTag" - terminationProtectionEnabled: - type: boolean - default: false - description: "Flag that indicates whether termination protection is enabled\ - \ on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster.\ - \ If set to `false`, MongoDB Cloud will delete the cluster." - versionReleaseSystem: + - AVERAGE + operator: type: string - default: LTS - description: Method by which the cluster maintains the MongoDB versions. + description: Comparison operator to apply when checking the current metric + value. enum: - - LTS - readOnly: true + - LESS_THAN + - GREATER_THAN + threshold: + type: number + format: double + description: "Value of metric that, when exceeded, triggers an alert." + units: + $ref: "#/components/schemas/TimeMetricUnits" required: - - providerSettings - title: USS Instance Description - USSInstanceDescriptionCreate20250101: + - metricName + TimeMetricUnits: + type: string + default: HOURS + description: "Element used to express the quantity. This can be an element of\ + \ time, storage capacity, and the like." + enum: + - NANOSECONDS + - MILLISECONDS + - MILLION_MINUTES + - SECONDS + - MINUTES + - HOURS + - DAYS + title: Time Metric Units + TimeMetricValueView: type: object - description: Settings that you can specify when you create a USS instance. + description: Measurement of the **metricName** recorded at the time of the event. properties: - links: - type: array - description: "List of one or more Uniform Resource Locators (URLs) that\ - \ point to API sub-resources, related API resources, or both. RFC 5988\ - \ outlines these relationships." - externalDocs: - description: Web Linking Specification (RFC 5988) - url: https://datatracker.ietf.org/doc/html/rfc5988 - items: - $ref: "#/components/schemas/Link" + number: + type: number + format: double + description: Amount of the **metricName** recorded at the time of the event. + This value triggered the alert. readOnly: true - name: + units: + $ref: "#/components/schemas/TimeMetricUnits" + readOnly: true + title: Time Metric Value + TokenFilterEnglishPossessive: + type: object + description: Filter that removes possessives (trailing 's) from words. + properties: + type: type: string - description: Human-readable label that identifies the instance. - maxLength: 64 - minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - writeOnly: true - providerSettings: - $ref: "#/components/schemas/USSProviderSettingsCreate20250101" - tags: - type: array - description: List that contains key-value pairs between 1 to 255 characters - in length for tagging and categorizing the instance. - externalDocs: - description: Resource Tags - url: https://dochub.mongodb.org/core/add-cluster-tag-atlas - items: - $ref: "#/components/schemas/ResourceTag" - terminationProtectionEnabled: - type: boolean - default: false - description: "Flag that indicates whether termination protection is enabled\ - \ on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster.\ - \ If set to `false`, MongoDB Cloud will delete the cluster." + description: Human-readable label that identifies this token filter type. + enum: + - englishPossessive required: - - name - - providerSettings - title: USS Instance Description Create - USSProviderSettings20250101: + - type + title: englishPossessive + TokenFilterFlattenGraph: type: object - description: Group of cloud provider settings that configure the provisioned - MongoDB USS instance. + description: "Filter that transforms a token filter graph, such as the token\ + \ filter graph that the wordDelimiterGraph token filter produces, into a flat\ + \ form suitable for indexing." properties: - backingProviderName: + type: type: string - description: Cloud service provider on which MongoDB Cloud provisioned the - USS instance. + description: Human-readable label that identifies this token filter type. enum: - - AWS - - AZURE - - GCP - readOnly: true - diskSizeGB: - type: number - format: double - description: Storage capacity available to the USS instance expressed in - gigabytes. - readOnly: true - providerName: + - flattenGraph + required: + - type + title: flattenGraph + TokenFilterPorterStemming: + type: object + description: Filter that uses the porter stemming algorithm to remove the common + morphological and inflectional suffixes from words in English. It expects + lowercase text and doesn't work as expected for uppercase text. + properties: + type: type: string - default: USS - description: Human-readable label that identifies the cloud service provider. + description: Human-readable label that identifies this token filter type. enum: - - USS - readOnly: true - regionName: + - porterStemming + required: + - type + title: porterStemming + TokenFilterSpanishPluralStemming: + type: object + description: Filter that stems Spanish plural words. It expects lowercase text. + properties: + type: type: string - description: "Human-readable label that identifies the geographic location\ - \ of your MongoDB USS 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/)." - readOnly: true - readOnly: true - title: Cloud Service Provider Settings for a USS Instance - USSProviderSettingsCreate20250101: + description: Human-readable label that identifies this token filter type. + enum: + - spanishPluralStemming + required: + - type + title: spanishPluralStemming + TokenFilterStempel: type: object - description: Group of cloud provider settings that configure the provisioned - MongoDB USS instance. + description: Filter that uses Lucene's default Polish stemmer table to stem + words in the Polish language. It expects lowercase text. + externalDocs: + description: Default Polish stemmer table + url: https://lucene.apache.org/core/9_2_0/analysis/stempel/org/apache/lucene/analysis/pl/PolishAnalyzer.html#DEFAULT_STEMMER_FILE properties: - backingProviderName: + type: type: string - description: Cloud service provider on which MongoDB Cloud provisioned the - serverless instance. + description: Human-readable label that identifies this token filter type. enum: - - AWS - - AZURE - - GCP - writeOnly: true - diskSizeGB: - type: number - format: double - description: Storage capacity available to the USS instance expressed in - gigabytes. - readOnly: true - providerName: + - stempel + required: + - type + title: stempel + TokenFilterWordDelimiterGraph: + type: object + description: Filter that splits tokens into sub-tokens based on configured rules. + properties: + delimiterOptions: + type: object + description: Object that contains the rules that determine how to split + words into sub-words. + properties: + concatenateAll: + type: boolean + default: false + description: Flag that indicates whether to concatenate runs. + concatenateNumbers: + type: boolean + default: false + description: Flag that indicates whether to concatenate runs of sub-numbers. + concatenateWords: + type: boolean + default: false + description: Flag that indicates whether to concatenate runs of sub-words. + generateNumberParts: + type: boolean + default: true + description: "Flag that indicates whether to split tokens based on sub-numbers.\ + \ For example, if `true`, this option splits `100-2` into `100` and\ + \ `2`." + generateWordParts: + type: boolean + default: true + description: Flag that indicates whether to split tokens based on sub-words. + ignoreKeywords: + type: boolean + default: false + description: Flag that indicates whether to skip tokens with the `keyword` + attribute set to `true` + preserveOriginal: + type: boolean + default: true + description: Flag that indicates whether to generate tokens of the original + words. + splitOnCaseChange: + type: boolean + default: true + description: Flag that indicates whether to split tokens based on letter-case + transitions. + splitOnNumerics: + type: boolean + default: true + description: Flag that indicates whether to split tokens based on letter-number + transitions. + stemEnglishPossessive: + type: boolean + default: true + description: Flag that indicates whether to remove trailing possessives + from each sub-word. + protectedWords: + type: object + description: Object that contains options for protected words. + properties: + ignoreCase: + type: boolean + default: true + description: Flag that indicates whether to ignore letter case sensitivity + for protected words. + words: + type: array + description: List that contains the tokens to protect from delimination. + items: + type: string + required: + - words + type: type: string - default: USS - description: Human-readable label that identifies the cloud service provider. + description: Human-readable label that identifies this token filter type. enum: - - USS - readOnly: true - regionName: + - wordDelimiterGraph + required: + - type + title: wordDelimiterGraph + TokenFilterkStemming: + type: object + description: Filter that combines algorithmic stemming with a built-in dictionary + for the English language to stem words. + properties: + type: type: string - description: "Human-readable label that identifies the geographic location\ - \ of your MongoDB USS 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/)." + description: Human-readable label that identifies this token filter type. + enum: + - kStemming + required: + - type + title: kStemming + TriggerIngestionPipelineRequest: + type: object + properties: + datasetRetentionPolicy: + $ref: "#/components/schemas/DatasetRetentionPolicy" + snapshotId: + type: string + description: Unique 24-hexadecimal character string that identifies the + snapshot. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" writeOnly: true required: - - backingProviderName - - regionName - title: Cloud Service Provider Settings for a USS Instance - writeOnly: true + - snapshotId UpdateAtlasOrganizationApiKey: type: object properties: @@ -51325,7 +53036,7 @@ components: Atlas Data Lake that this database user can access. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" type: type: string description: Category of resource that this database user can access. @@ -51384,6 +53095,28 @@ components: required: - match title: User to Distinguished Name Mapping + VPCPeeringActionChallenge: + type: object + description: Container for elements used to challenge the user before taking + certain actions on VPC Peering connections. + properties: + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + requesterAccountId: + type: string + description: The AWS requester account ID. + requesterVpcId: + type: string + description: The AWS requester VPC ID. VectorSearchHostStatusDetail: type: object properties: diff --git a/tools/cli/test/data/split/dev/openapi-v2-2023-11-15.json b/tools/cli/test/data/split/dev/openapi-v2-2023-11-15.json index 68b6c26349..489f11b2fb 100644 --- a/tools/cli/test/data/split/dev/openapi-v2-2023-11-15.json +++ b/tools/cli/test/data/split/dev/openapi-v2-2023-11-15.json @@ -1,7 +1,7 @@ { "openapi" : "3.0.1", "info" : { - "description" : "The MongoDB Atlas Administration API allows developers to manage all components in MongoDB Atlas.\n\nThe Atlas Administration API uses HTTP Digest Authentication to authenticate requests. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request. For example, to [return database access history](#tag/Access-Tracking/operation/listAccessLogsByClusterName) with [cURL](https://en.wikipedia.org/wiki/CURL), run the following command in the terminal:\n\n```\ncurl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true\"\n```\n\nTo learn more, see [Get Started with the Atlas Administration API](https://www.mongodb.com/docs/atlas/configure-api-access/). For support, see [MongoDB Support](https://www.mongodb.com/support/get-started).", + "description" : "The MongoDB Atlas Administration API allows developers to manage all components in MongoDB Atlas.\n\nThe Atlas Administration API uses HTTP Digest Authentication to authenticate requests. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request. For example, to [return database access history](#tag/Access-Tracking/operation/listAccessLogsByClusterName) with [cURL](https://en.wikipedia.org/wiki/CURL), run the following command in the terminal:\n\n```\ncurl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2023-11-15+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true\"\n```\n\nTo learn more, see [Get Started with the Atlas Administration API](https://www.mongodb.com/docs/atlas/configure-api-access/). For support, see [MongoDB Support](https://www.mongodb.com/support/get-started).\n\nYou can also explore the various endpoints available through the Atlas Administration API in MongoDB's [Postman workspace](https://www.postman.com/mongodb-devrel/workspace/mongodb-atlas-administration-apis/).", "license" : { "name" : "CC BY-NC-SA 3.0 US", "url" : "https://creativecommons.org/licenses/by-nc-sa/3.0/us/" @@ -9,7 +9,7 @@ "termsOfService" : "https://www.mongodb.com/mongodb-management-service-terms-and-conditions", "title" : "MongoDB Atlas Administration API", "version" : "2.0", - "x-xgen-sha" : "09d9d18db2111c955a8e01702a27ca2763417782" + "x-xgen-sha" : "e6ba3136dbd0be2a81dd4ed21b9e6c470edd4420" }, "servers" : [ { "url" : "https://cloud.mongodb.com" @@ -57,7 +57,11 @@ "description" : "Returns, adds, edits, and removes Federated Database Instances. This resource requires your project ID. Changes to federated database instance configurations can affect costs.", "name" : "Data Federation" }, { - "description" : "Returns, adds, edits, and removes Atlas Data Lake Pipelines and associated runs.", + "description" : "Returns, edits, and removes Atlas Data Lake Pipelines and associated runs.", + "externalDocs" : { + "description" : "Data Lake Pipelines are deprecated. Please see Data Lake Deprecation Guide.", + "url" : "https://dochub.mongodb.org/core/data-lake-deprecation" + }, "name" : "Data Lake Pipelines" }, { "description" : "Returns, adds, edits, and removes database users.", @@ -119,6 +123,9 @@ }, { "description" : "You can continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket. Atlas exports logs every 5 minutes.", "name" : "Push-Based Log Export" + }, { + "description" : "Configure and manage Atlas Resource Policies within your organization.", + "name" : "Resource Policies" }, { "description" : "Creates one index to a database deployment in a rolling manner. You can't create a rolling index on an `M0` free cluster or `M2/M5` shared cluster.", "name" : "Rolling Index" @@ -135,6 +142,13 @@ "url" : "https://dochub.mongodb.org/core/serverless-private-endpoint" }, "name" : "Serverless Private Endpoints" + }, { + "description" : "Endpoints for managing Service Accounts and secrets. Service Accounts are used for programmatic access to the Atlas Admin API through the OAuth 2.0 Client Credentials flow. This feature is available as a Preview feature.", + "externalDocs" : { + "description" : "Get Started with the Atlas Administration API", + "url" : "https://www.mongodb.com/docs/atlas/configure-api-access/" + }, + "name" : "Service Accounts" }, { "description" : "Returns and adds restore jobs for shared-tier database deployments.", "name" : "Shared-Tier Restore Jobs" @@ -2869,7 +2883,7 @@ "/api/atlas/v2/groups/{groupId}/backup/exportBuckets" : { "get" : { "deprecated" : true, - "description" : "Returns all AWS S3 buckets and Azure Blob Storage Containers associated with the specified Project. To use this resource, the requesting API Key must have the Project Read Only role.", + "description" : "Returns all Export Buckets associated with the specified Project. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "listExportBuckets", "parameters" : [ { "$ref" : "#/components/parameters/envelope" @@ -2906,13 +2920,13 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Return All AWS S3 Buckets and Azure Blob Storage Containers Used for Cloud Backup Snapshot Exports", + "summary" : "Return All Snapshot Export Buckets", "tags" : [ "Cloud Backups" ], - "x-sunset" : "2025-05-30" + "x-sunset" : "2026-05-30" }, "post" : { "deprecated" : true, - "description" : "Grants MongoDB Cloud access to the specified AWS S3 Bucket or Azure Blob Storage Container. This enables this Export Bucket to receive Atlas Cloud Backup Snapshots. To use this resource, the requesting API Key must have the Project Owner role.", + "description" : "Creates a Snapshot Export Bucket for an AWS S3 Bucket or Azure Blob Storage Container. Once created, an snapshots can be exported to the Export Bucket and its referenced AWS S3 Bucket or Azure Blob Storage Container. To use this resource, the requesting API Key must have the Project Owner role.", "operationId" : "createExportBucket", "parameters" : [ { "$ref" : "#/components/parameters/envelope" @@ -2931,7 +2945,7 @@ "x-xgen-version" : "2023-01-01" } }, - "description" : "Grants MongoDB Cloud access to the specified AWS S3 Bucket or Azure Blob Storage Container.", + "description" : "Specifies the role and AWS S3 Bucket or Azure Blob Storage Container that the Export Bucket should reference.", "required" : true }, "responses" : { @@ -2962,21 +2976,21 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Grant Access to AWS S3 Bucket or Azure Blob Storage Container for Cloud Backup Snapshot Exports", + "summary" : "Create One Snapshot Export Bucket", "tags" : [ "Cloud Backups" ], - "x-sunset" : "2025-05-30" + "x-sunset" : "2026-05-30" } }, "/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}" : { "delete" : { - "description" : "Revoke MongoDB Cloud access to the specified AWS S3 Bucket or Azure Blob Storage Container. This prevents this Export Bucket from receiving Atlas Cloud Backup Snapshots. 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 API Key must have the Project Owner role.", + "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 API Key must have the Project Owner role.", "operationId" : "deleteExportBucket", "parameters" : [ { "$ref" : "#/components/parameters/envelope" }, { "$ref" : "#/components/parameters/groupId" }, { - "description" : "Unique string that identifies the AWS S3 Bucket or Azure Blob Storage Container to which you export your Snapshots.", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", "in" : "path", "name" : "exportBucketId", "required" : true, @@ -3016,12 +3030,12 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Revoke Access to AWS S3 Bucket or Azure Blob Storage Container for Cloud Backup Snapshot Exports", + "summary" : "Delete One Snapshot Export Bucket", "tags" : [ "Cloud Backups" ] }, "get" : { "deprecated" : true, - "description" : "Returns one AWS S3 Bucket or Azure Blob Storage Container associated with the specified Project. To use this resource, the requesting API Key must have the Project Read Only role.", + "description" : "Returns one Export Bucket associated with the specified Project. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "getExportBucket", "parameters" : [ { "$ref" : "#/components/parameters/envelope" @@ -3065,9 +3079,9 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Return One AWS S3 Bucket or Azure Blob Storage Container Used for Cloud Backup Snapshot Exports", + "summary" : "Return One Snapshot Export Bucket", "tags" : [ "Cloud Backups" ], - "x-sunset" : "2025-05-30" + "x-sunset" : "2026-05-30" } }, "/api/atlas/v2/groups/{groupId}/backupCompliancePolicy" : { @@ -3225,7 +3239,7 @@ "content" : { "application/vnd.atlas.2023-01-01+json" : { "schema" : { - "$ref" : "#/components/schemas/CloudProviderAccessRole" + "$ref" : "#/components/schemas/CloudProviderAccessRoleRequest" } } }, @@ -3275,7 +3289,7 @@ "required" : true, "schema" : { "type" : "string", - "enum" : [ "AWS" ] + "enum" : [ "AWS", "AZURE", "GCP" ] } }, { "description" : "Unique 24-hexadecimal digit string that identifies the role.", @@ -3363,7 +3377,7 @@ "tags" : [ "Cloud Provider Access" ] }, "patch" : { - "description" : "Grants access to the specified project for the specified access role. To use this resource, the requesting API Key must have the Project Owner role. This API endpoint is one step in a procedure to create unified access for MongoDB Cloud services.", + "description" : "Grants access to the specified project for the specified access role. To use this resource, the requesting API Key must have the Project Owner role. This API endpoint is one step in a procedure to create unified access for MongoDB Cloud services. 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/" @@ -3391,7 +3405,7 @@ "content" : { "application/vnd.atlas.2023-01-01+json" : { "schema" : { - "$ref" : "#/components/schemas/CloudProviderAccessRole" + "$ref" : "#/components/schemas/CloudProviderAccessRoleRequestUpdate" } } }, @@ -3742,7 +3756,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster.", @@ -3802,7 +3816,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -3856,7 +3870,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -3908,7 +3922,7 @@ }, "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports" : { "get" : { - "description" : "Returns all Cloud Backup snapshot export jobs associated with the specified Atlas cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role.", + "description" : "Returns all Cloud Backup Snapshot Export Jobs associated with the specified Atlas cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role.", "operationId" : "listBackupExportJobs", "parameters" : [ { "$ref" : "#/components/parameters/envelope" @@ -3931,7 +3945,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -3956,11 +3970,11 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Return All Cloud Backup Snapshot Export Jobs", + "summary" : "Return All Snapshot Export Jobs", "tags" : [ "Cloud Backups" ] }, "post" : { - "description" : "Exports one backup snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. To use this resource, the requesting API Key must have the Project Atlas Admin role.", + "description" : "Exports one backup Snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. To use this resource, the requesting API Key must have the Project Atlas Admin role.", "operationId" : "createBackupExportJob", "parameters" : [ { "$ref" : "#/components/parameters/envelope" @@ -3975,7 +3989,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -4020,13 +4034,13 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Create One Cloud Backup Snapshot Export Job", + "summary" : "Create One Snapshot Export Job", "tags" : [ "Cloud Backups" ] } }, "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}" : { "get" : { - "description" : "Returns one Cloud Backup snapshot export job associated with the specified Atlas cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role.", + "description" : "Returns one Cloud Backup Snapshot Export Job associated with the specified Atlas cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role.", "operationId" : "getBackupExportJob", "parameters" : [ { "$ref" : "#/components/parameters/envelope" @@ -4041,15 +4055,19 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { - "description" : "Unique string that identifies the export job to return.", + "description" : "Unique 24-hexadecimal character string that identifies the Export Job.", "in" : "path", "name" : "exportId", "required" : true, "schema" : { - "type" : "string" + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" } } ], "responses" : { @@ -4074,7 +4092,7 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Return One Cloud Backup Snapshot Export Job", + "summary" : "Return One Snapshot Export Job", "tags" : [ "Cloud Backups" ] } }, @@ -4103,7 +4121,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -4149,7 +4167,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -4217,7 +4235,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the restore job to remove.", @@ -4277,7 +4295,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the restore job to return.", @@ -4335,7 +4353,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -4365,7 +4383,7 @@ } ], "summary" : "Remove All Cloud Backup Schedules", "tags" : [ "Cloud Backups" ], - "x-sunset" : "2025-08-05" + "x-sunset" : "2026-05-30" }, "get" : { "deprecated" : true, @@ -4386,7 +4404,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -4413,7 +4431,7 @@ } ], "summary" : "Return One Cloud Backup Schedule", "tags" : [ "Cloud Backups" ], - "x-sunset" : "2025-08-05" + "x-sunset" : "2026-05-30" }, "patch" : { "deprecated" : true, @@ -4434,7 +4452,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -4475,7 +4493,7 @@ } ], "summary" : "Update Cloud Backup Schedule for One Cluster", "tags" : [ "Cloud Backups" ], - "x-sunset" : "2025-08-05" + "x-sunset" : "2026-05-30" } }, "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots" : { @@ -4503,7 +4521,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -4552,7 +4570,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -4614,7 +4632,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -4671,7 +4689,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -4733,7 +4751,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -4784,7 +4802,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -4844,7 +4862,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -4904,7 +4922,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -4971,7 +4989,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "$ref" : "#/components/parameters/envelope" @@ -5042,7 +5060,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "$ref" : "#/components/parameters/envelope" @@ -5110,7 +5128,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "$ref" : "#/components/parameters/envelope" @@ -5161,7 +5179,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "$ref" : "#/components/parameters/envelope" @@ -5229,7 +5247,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -5280,7 +5298,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -5349,7 +5367,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -5409,7 +5427,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -5461,7 +5479,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -5511,7 +5529,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -5583,7 +5601,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -5657,7 +5675,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -5727,7 +5745,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -5798,7 +5816,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Name of the collection that contains one or more Atlas Search indexes.", @@ -5871,7 +5889,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the Atlas Search index. Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes.", @@ -5937,7 +5955,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "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.", @@ -6000,7 +6018,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "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.", @@ -6082,7 +6100,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -6136,7 +6154,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -6188,7 +6206,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -6254,7 +6272,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "$ref" : "#/components/parameters/groupId" @@ -6325,7 +6343,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -6395,7 +6413,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -6549,7 +6567,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -6599,7 +6617,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -6692,7 +6710,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Flag that indicates whether to download logs for queries against your online archive only or both your online archive and cluster.", @@ -6771,7 +6789,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -6835,7 +6853,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -6902,7 +6920,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -6974,7 +6992,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -7030,7 +7048,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -7086,7 +7104,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -7153,7 +7171,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -7208,7 +7226,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -7275,7 +7293,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -7337,7 +7355,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -7387,7 +7405,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -7450,7 +7468,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", @@ -7513,7 +7531,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -7564,7 +7582,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -7615,7 +7633,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -7680,7 +7698,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -7747,7 +7765,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -7794,7 +7812,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -7860,7 +7878,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Human-readable label that specifies whether to return only completed, incomplete, or all snapshots. By default, MongoDB Cloud only returns completed snapshots.", @@ -7918,7 +7936,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -7979,7 +7997,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -8037,7 +8055,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -8107,7 +8125,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -8151,7 +8169,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Human-readable label that identifies the cluster topology to retrieve metrics for.", @@ -8212,7 +8230,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Human-readable label that identifies the cluster topology to retrieve metrics for.", @@ -8314,7 +8332,7 @@ } } }, { - "description" : "Date and time when the period specifies the inclusive ending point for the range of log messages to retrieve. This parameter expresses its value in the number of seconds that have elapsed since the UNIX epoch.", + "description" : "Specifies the date and time for the ending point of the range of log messages to retrieve, in the number of seconds that have elapsed since the UNIX epoch. This value will default to 24 hours after the start date. If the start date is also unspecified, the value will default to the time of the request.", "in" : "query", "name" : "endDate", "schema" : { @@ -8323,7 +8341,7 @@ "minimum" : 1199145600 } }, { - "description" : "Date and time when the period specifies the inclusive starting point for the range of log messages to retrieve. This parameter expresses its value in the number of seconds that have elapsed since the UNIX epoch.", + "description" : "Specifies the date and time for the starting point of the range of log messages to retrieve, in the number of seconds that have elapsed since the UNIX epoch. This value will default to 24 hours prior to the end date. If the end date is also unspecified, the value will default to 24 hours prior to the time of the request.", "in" : "query", "name" : "startDate", "schema" : { @@ -10131,7 +10149,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Date and time when to stop retrieving database history. If you specify **end**, you must also specify **start**. This parameter uses UNIX epoch time in milliseconds.", @@ -10394,6 +10412,12 @@ "$ref" : "#/components/parameters/pretty" }, { "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" }, { "description" : "Human-readable label that identifies the cloud provider for the private endpoints to return.", "in" : "path", @@ -10516,17 +10540,6 @@ "pattern" : "^([a-f0-9]{24})$" } } ], - "requestBody" : { - "content" : { - "application/vnd.atlas.2023-01-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/EncryptionAtRestPrivateEndpointRequest" - } - } - }, - "description" : "Cloud provider of the private endpoints to delete and the list of cloud provider regions in which to delete the private endpoints.", - "required" : true - }, "responses" : { "204" : { "content" : { @@ -10597,6 +10610,9 @@ "403" : { "$ref" : "#/components/responses/forbidden" }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, "500" : { "$ref" : "#/components/responses/internalServerError" } @@ -10634,7 +10650,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, "style" : "form" @@ -11352,7 +11368,7 @@ } ], "summary" : "Return All Project Invitations", "tags" : [ "Projects" ], - "x-sunset" : "2024-10-04" + "x-sunset" : "2024-11-04" }, "patch" : { "deprecated" : true, @@ -11406,7 +11422,7 @@ } ], "summary" : "Update One Project Invitation", "tags" : [ "Projects" ], - "x-sunset" : "2024-10-04" + "x-sunset" : "2024-11-04" }, "post" : { "deprecated" : true, @@ -11454,7 +11470,7 @@ } ], "summary" : "Invite One MongoDB Cloud User to Join One Project", "tags" : [ "Projects" ], - "x-sunset" : "2024-10-04" + "x-sunset" : "2024-11-04" } }, "/api/atlas/v2/groups/{groupId}/invites/{invitationId}" : { @@ -11502,7 +11518,7 @@ } ], "summary" : "Cancel One Project Invitation", "tags" : [ "Projects" ], - "x-sunset" : "2024-10-04" + "x-sunset" : "2024-11-04" }, "get" : { "deprecated" : true, @@ -11553,7 +11569,7 @@ } ], "summary" : "Return One Project Invitation", "tags" : [ "Projects" ], - "x-sunset" : "2024-10-04" + "x-sunset" : "2024-11-04" }, "patch" : { "deprecated" : true, @@ -11616,7 +11632,7 @@ } ], "summary" : "Update One Project Invitation by Invitation ID", "tags" : [ "Projects" ], - "x-sunset" : "2024-10-04" + "x-sunset" : "2024-11-04" } }, "/api/atlas/v2/groups/{groupId}/ipAddresses" : { @@ -11713,13 +11729,13 @@ "description" : "Removes the specified project limit. Depending on the limit, Atlas either resets the limit to its default value or removes the limit entirely. To use this resource, the requesting API Key must have the Project Owner role.", "operationId" : "deleteProjectLimit", "parameters" : [ { - "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", + "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| 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 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n| atlas.project.deployment.salesSoldM0s | Limit on the number of M0 clusters in this project if the org is sales-sold | 100 | 100 |\n", "in" : "path", "name" : "limitName", "required" : true, "schema" : { "type" : "string", - "enum" : [ "atlas.project.security.databaseAccess.users", "atlas.project.deployment.clusters", "atlas.project.deployment.serverlessMTMs", "atlas.project.security.databaseAccess.customRoles", "atlas.project.security.networkAccess.entries", "atlas.project.security.networkAccess.crossRegionEntries", "atlas.project.deployment.nodesPerPrivateLinkRegion", "dataFederation.bytesProcessed.query", "dataFederation.bytesProcessed.daily", "dataFederation.bytesProcessed.weekly", "dataFederation.bytesProcessed.monthly", "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", "atlas.project.deployment.privateServiceConnectionsSubnetMask" ] + "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" @@ -11763,13 +11779,13 @@ "description" : "Returns the specified limit for the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "getProjectLimit", "parameters" : [ { - "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", + "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| 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 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n| atlas.project.deployment.salesSoldM0s | Limit on the number of M0 clusters in this project if the org is sales-sold | 100 | 100 |\n", "in" : "path", "name" : "limitName", "required" : true, "schema" : { "type" : "string", - "enum" : [ "atlas.project.security.databaseAccess.users", "atlas.project.deployment.clusters", "atlas.project.deployment.serverlessMTMs", "atlas.project.security.databaseAccess.customRoles", "atlas.project.security.networkAccess.entries", "atlas.project.security.networkAccess.crossRegionEntries", "atlas.project.deployment.nodesPerPrivateLinkRegion", "dataFederation.bytesProcessed.query", "dataFederation.bytesProcessed.daily", "dataFederation.bytesProcessed.weekly", "dataFederation.bytesProcessed.monthly", "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", "atlas.project.deployment.privateServiceConnectionsSubnetMask" ] + "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" @@ -11816,13 +11832,13 @@ "description" : "Sets the specified project limit. To use this resource, the requesting API Key must have the Project Owner role.\n\n**NOTE**: Increasing the following configuration limits might lead to slower response times in the MongoDB Cloud UI or increased user management overhead leading to authentication or authorization re-architecture. If possible, we recommend that you create additional projects to gain access to more of these resources for a more sustainable growth pattern.", "operationId" : "setProjectLimit", "parameters" : [ { - "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", + "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| 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 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n| atlas.project.deployment.salesSoldM0s | Limit on the number of M0 clusters in this project if the org is sales-sold | 100 | 100 |\n", "in" : "path", "name" : "limitName", "required" : true, "schema" : { "type" : "string", - "enum" : [ "atlas.project.security.databaseAccess.users", "atlas.project.deployment.clusters", "atlas.project.deployment.serverlessMTMs", "atlas.project.security.databaseAccess.customRoles", "atlas.project.security.networkAccess.entries", "atlas.project.security.networkAccess.crossRegionEntries", "atlas.project.deployment.nodesPerPrivateLinkRegion", "dataFederation.bytesProcessed.query", "dataFederation.bytesProcessed.daily", "dataFederation.bytesProcessed.weekly", "dataFederation.bytesProcessed.monthly", "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", "atlas.project.deployment.privateServiceConnectionsSubnetMask" ] + "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" @@ -12811,6 +12827,7 @@ }, "/api/atlas/v2/groups/{groupId}/pipelines" : { "get" : { + "deprecated" : true, "description" : "Returns a list of Data Lake Pipelines. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "listPipelines", "parameters" : [ { @@ -12847,10 +12864,16 @@ "DigestAuth" : [ ] } ], "summary" : "Return All Data Lake Pipelines from One Project", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" }, "post" : { + "deprecated" : true, "description" : "Creates one Data Lake Pipeline.", + "externalDocs" : { + "description" : "Data Lake Pipelines are deprecated. Please see Data Lake Deprecation Guide.", + "url" : "https://dochub.mongodb.org/core/data-lake-deprecation" + }, "operationId" : "createPipeline", "parameters" : [ { "$ref" : "#/components/parameters/envelope" @@ -12897,11 +12920,13 @@ "DigestAuth" : [ ] } ], "summary" : "Create One Data Lake Pipeline", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}" : { "delete" : { + "deprecated" : true, "description" : "Removes one Data Lake Pipeline.", "operationId" : "deletePipeline", "parameters" : [ { @@ -12946,9 +12971,11 @@ "DigestAuth" : [ ] } ], "summary" : "Remove One Data Lake Pipeline", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" }, "get" : { + "deprecated" : true, "description" : "Returns the details of one Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "getPipeline", "parameters" : [ { @@ -12995,9 +13022,11 @@ "DigestAuth" : [ ] } ], "summary" : "Return One Data Lake Pipeline", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" }, "patch" : { + "deprecated" : true, "description" : "Updates one Data Lake Pipeline.", "operationId" : "updatePipeline", "parameters" : [ { @@ -13059,11 +13088,13 @@ "DigestAuth" : [ ] } ], "summary" : "Update One Data Lake Pipeline", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules" : { "get" : { + "deprecated" : true, "description" : "Returns a list of backup schedule policy items that you can use as a Data Lake Pipeline source. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "listPipelineSchedules", "parameters" : [ { @@ -13113,11 +13144,13 @@ "DigestAuth" : [ ] } ], "summary" : "Return Available Ingestion Schedules for One Data Lake Pipeline", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots" : { "get" : { + "deprecated" : true, "description" : "Returns a list of backup snapshots that you can use to trigger an on demand pipeline run. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "listPipelineSnapshots", "parameters" : [ { @@ -13179,11 +13212,13 @@ "DigestAuth" : [ ] } ], "summary" : "Return Available Backup Snapshots for One Data Lake Pipeline", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause" : { "post" : { + "deprecated" : true, "description" : "Pauses ingestion for a Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "pausePipeline", "parameters" : [ { @@ -13230,11 +13265,13 @@ "DigestAuth" : [ ] } ], "summary" : "Pause One Data Lake Pipeline", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume" : { "post" : { + "deprecated" : true, "description" : "Resumes ingestion for a Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "resumePipeline", "parameters" : [ { @@ -13281,11 +13318,13 @@ "DigestAuth" : [ ] } ], "summary" : "Resume One Data Lake Pipeline", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs" : { "get" : { + "deprecated" : true, "description" : "Returns a list of past Data Lake Pipeline runs. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "listPipelineRuns", "parameters" : [ { @@ -13347,11 +13386,13 @@ "DigestAuth" : [ ] } ], "summary" : "Return All Data Lake Pipeline Runs from One Project", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}" : { "delete" : { + "deprecated" : true, "description" : "Deletes dataset that Atlas generated during the specified pipeline run.", "operationId" : "deletePipelineRunDataset", "parameters" : [ { @@ -13410,9 +13451,11 @@ "DigestAuth" : [ ] } ], "summary" : "Delete Pipeline Run Dataset", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" }, "get" : { + "deprecated" : true, "description" : "Returns the details of one Data Lake Pipeline run within the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "getPipelineRun", "parameters" : [ { @@ -13471,11 +13514,13 @@ "DigestAuth" : [ ] } ], "summary" : "Return One Data Lake Pipeline Run", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger" : { "post" : { + "deprecated" : true, "description" : "Triggers a Data Lake Pipeline ingestion of a specified snapshot.", "operationId" : "triggerSnapshotIngestion", "parameters" : [ { @@ -13533,7 +13578,8 @@ "DigestAuth" : [ ] } ], "summary" : "Trigger on demand snapshot ingestion", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService" : { @@ -13693,7 +13739,7 @@ "schema" : { "type" : "string", "maxLength" : 64, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -13746,7 +13792,7 @@ "schema" : { "type" : "string", "maxLength" : 64, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -13805,7 +13851,7 @@ "schema" : { "type" : "string", "maxLength" : 64, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be removed.", @@ -13862,7 +13908,7 @@ "schema" : { "type" : "string", "maxLength" : 64, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the tenant endpoint.", @@ -13919,7 +13965,7 @@ "schema" : { "type" : "string", "maxLength" : 64, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be updated.", @@ -15095,7 +15141,7 @@ "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" ] + "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" ] }, "maxItems" : 10, "minItems" : 1, @@ -15174,7 +15220,7 @@ "items" : { "type" : "string", "description" : "One measurement requested for this MongoDB process.", - "enum" : [ "ASSERT_MSG", "ASSERT_REGULAR", "ASSERT_USER", "ASSERT_WARNING", "BACKGROUND_FLUSH_AVG", "CACHE_BYTES_READ_INTO", "CACHE_BYTES_WRITTEN_FROM", "CACHE_DIRTY_BYTES", "CACHE_USED_BYTES", "COMPUTED_MEMORY", "CONNECTIONS", "CURSORS_TOTAL_OPEN", "CURSORS_TOTAL_TIMED_OUT", "DB_DATA_SIZE_TOTAL", "DB_STORAGE_TOTAL", "DOCUMENT_METRICS_DELETED", "DOCUMENT_METRICS_INSERTED", "DOCUMENT_METRICS_RETURNED", "DOCUMENT_METRICS_UPDATED", "EXTRA_INFO_PAGE_FAULTS", "FTS_DISK_UTILIZATION", "FTS_MEMORY_MAPPED", "FTS_MEMORY_RESIDENT", "FTS_MEMORY_VIRTUAL", "FTS_PROCESS_CPU_KERNEL", "FTS_PROCESS_CPU_USER", "FTS_PROCESS_NORMALIZED_CPU_KERNEL", "FTS_PROCESS_NORMALIZED_CPU_USER", "GLOBAL_ACCESSES_NOT_IN_MEMORY", "GLOBAL_LOCK_CURRENT_QUEUE_READERS", "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL", "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS", "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN", "INDEX_COUNTERS_BTREE_ACCESSES", "INDEX_COUNTERS_BTREE_HITS", "INDEX_COUNTERS_BTREE_MISS_RATIO", "INDEX_COUNTERS_BTREE_MISSES", "JOURNALING_COMMITS_IN_WRITE_LOCK", "JOURNALING_MB", "JOURNALING_WRITE_DATA_FILES_MB", "MAX_PROCESS_CPU_CHILDREN_KERNEL", "MAX_PROCESS_CPU_CHILDREN_USER", "MAX_PROCESS_CPU_KERNEL", "MAX_PROCESS_CPU_USER", "MAX_PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL", "MAX_PROCESS_NORMALIZED_CPU_CHILDREN_USER", "MAX_PROCESS_NORMALIZED_CPU_KERNEL", "MAX_PROCESS_NORMALIZED_CPU_USER", "MAX_SWAP_USAGE_FREE", "MAX_SWAP_USAGE_USED ", "MAX_SYSTEM_CPU_GUEST", "MAX_SYSTEM_CPU_IOWAIT", "MAX_SYSTEM_CPU_IRQ", "MAX_SYSTEM_CPU_KERNEL", "MAX_SYSTEM_CPU_SOFTIRQ", "MAX_SYSTEM_CPU_STEAL", "MAX_SYSTEM_CPU_USER", "MAX_SYSTEM_MEMORY_AVAILABLE", "MAX_SYSTEM_MEMORY_FREE", "MAX_SYSTEM_MEMORY_USED", "MAX_SYSTEM_NETWORK_IN", "MAX_SYSTEM_NETWORK_OUT", "MAX_SYSTEM_NORMALIZED_CPU_GUEST", "MAX_SYSTEM_NORMALIZED_CPU_IOWAIT", "MAX_SYSTEM_NORMALIZED_CPU_IRQ", "MAX_SYSTEM_NORMALIZED_CPU_KERNEL", "MAX_SYSTEM_NORMALIZED_CPU_NICE", "MAX_SYSTEM_NORMALIZED_CPU_SOFTIRQ", "MAX_SYSTEM_NORMALIZED_CPU_STEAL", "MAX_SYSTEM_NORMALIZED_CPU_USER", "MEMORY_MAPPED", "MEMORY_RESIDENT", "MEMORY_VIRTUAL", "NETWORK_BYTES_IN", "NETWORK_BYTES_OUT", "NETWORK_NUM_REQUESTS", "OP_EXECUTION_TIME_COMMANDS", "OP_EXECUTION_TIME_READS", "OP_EXECUTION_TIME_WRITES", "OPCOUNTER_CMD", "OPCOUNTER_DELETE", "OPCOUNTER_GETMORE", "OPCOUNTER_INSERT", "OPCOUNTER_QUERY", "OPCOUNTER_REPL_CMD", "OPCOUNTER_REPL_DELETE", "OPCOUNTER_REPL_INSERT", "OPCOUNTER_REPL_UPDATE", "OPCOUNTER_UPDATE", "OPERATIONS_SCAN_AND_ORDER", "OPLOG_MASTER_LAG_TIME_DIFF", "OPLOG_MASTER_TIME", "OPLOG_RATE_GB_PER_HOUR", "OPLOG_SLAVE_LAG_MASTER_TIME", "OPLOG_REPLICATION_LAG", "PROCESS_CPU_CHILDREN_KERNEL", "PROCESS_CPU_CHILDREN_USER", "PROCESS_CPU_KERNEL", "PROCESS_CPU_USER", "PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL", "PROCESS_NORMALIZED_CPU_CHILDREN_USER", "PROCESS_NORMALIZED_CPU_KERNEL", "PROCESS_NORMALIZED_CPU_USER", "QUERY_EXECUTOR_SCANNED", "QUERY_EXECUTOR_SCANNED_OBJECTS", "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED", "QUERY_TARGETING_SCANNED_PER_RETURNED", "RESTARTS_IN_LAST_HOUR", "SWAP_USAGE_FREE", "SWAP_USAGE_USED", "SYSTEM_CPU_GUEST", "SYSTEM_CPU_IOWAIT", "SYSTEM_CPU_IRQ", "SYSTEM_CPU_KERNEL", "SYSTEM_CPU_NICE", "SYSTEM_CPU_SOFTIRQ", "SYSTEM_CPU_STEAL", "SYSTEM_CPU_USER", "SYSTEM_MEMORY_AVAILABLE", "SYSTEM_MEMORY_FREE", "SYSTEM_MEMORY_USED", "SYSTEM_NETWORK_IN", "SYSTEM_NETWORK_OUT", "SYSTEM_NORMALIZED_CPU_GUEST", "SYSTEM_NORMALIZED_CPU_IOWAIT", "SYSTEM_NORMALIZED_CPU_IRQ", "SYSTEM_NORMALIZED_CPU_KERNEL", "SYSTEM_NORMALIZED_CPU_NICE", "SYSTEM_NORMALIZED_CPU_SOFTIRQ", "SYSTEM_NORMALIZED_CPU_STEAL", "SYSTEM_NORMALIZED_CPU_USER", "TICKETS_AVAILABLE_READS", "TICKETS_AVAILABLE_WRITE", "OPERATION_THROTTLING_REJECTED_OPERATIONS" ] + "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_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" ] }, "maxItems" : 10, "minItems" : 1, @@ -15744,7 +15790,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -15945,7 +15991,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -15994,7 +16040,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -16062,7 +16108,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the restore job to return.", @@ -16130,7 +16176,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -16179,7 +16225,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -16238,7 +16284,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "$ref" : "#/components/parameters/envelope" @@ -16284,7 +16330,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Value that we want to set for the Serverless Auto Indexing toggle.", @@ -16342,20 +16388,20 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { - "204" : { + "202" : { "content" : { "application/vnd.atlas.2023-01-01+json" : { "schema" : { - "$ref" : "#/components/schemas/NoBody" + "$ref" : "#/components/schemas/RequestAccepted" }, "x-xgen-version" : "2023-01-01" } }, - "description" : "This endpoint does not return a response body." + "description" : "Accepted" }, "400" : { "$ref" : "#/components/responses/badRequest" @@ -16394,7 +16440,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -16446,7 +16492,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -16489,29 +16535,25 @@ "tags" : [ "Serverless Instances" ] } }, - "/api/atlas/v2/groups/{groupId}/serviceAccounts" : { + "/api/atlas/v2/groups/{groupId}/settings" : { "get" : { - "description" : "Returns list of Service Accounts for a project with service account details.", - "operationId" : "listProjectServiceAccounts", + "description" : "Returns details about the specified project's settings. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "getProjectSettings", "parameters" : [ { - "$ref" : "#/components/parameters/groupId" - }, { - "$ref" : "#/components/parameters/itemsPerPage" + "$ref" : "#/components/parameters/envelope" }, { - "$ref" : "#/components/parameters/pageNum" + "$ref" : "#/components/parameters/groupId" }, { "$ref" : "#/components/parameters/pretty" - }, { - "$ref" : "#/components/parameters/envelope" } ], "responses" : { "200" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2023-01-01+json" : { "schema" : { - "$ref" : "#/components/schemas/PaginatedGroupServiceAccounts" + "$ref" : "#/components/schemas/GroupSettings" }, - "x-xgen-version" : "2023-10-01" + "x-xgen-version" : "2023-01-01" } }, "description" : "OK" @@ -16522,102 +16564,6 @@ "403" : { "$ref" : "#/components/responses/forbidden" }, - "500" : { - "$ref" : "#/components/responses/internalServerError" - } - }, - "security" : [ { - "DigestAuth" : [ ] - } ], - "summary" : "Return All project Service Accounts", - "tags" : [ "Groups" ] - }, - "post" : { - "description" : "Creates and assigns the specified Service Account to the specified Project.", - "operationId" : "createProjectServiceAccount", - "parameters" : [ { - "$ref" : "#/components/parameters/groupId" - }, { - "$ref" : "#/components/parameters/envelope" - }, { - "$ref" : "#/components/parameters/pretty" - } ], - "requestBody" : { - "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/GroupServiceAccountRequest" - }, - "x-xgen-version" : "2023-10-01" - } - }, - "description" : "Details to create service account and add to the specified project.", - "required" : true - }, - "responses" : { - "201" : { - "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/GroupServiceAccount" - }, - "x-xgen-version" : "2023-10-01" - } - }, - "description" : "Created" - }, - "400" : { - "$ref" : "#/components/responses/badRequest" - }, - "401" : { - "$ref" : "#/components/responses/unauthorized" - }, - "500" : { - "$ref" : "#/components/responses/internalServerError" - } - }, - "security" : [ { - "DigestAuth" : [ ] - } ], - "summary" : "Create and Assign one Service Account to one project", - "tags" : [ "Groups" ] - } - }, - "/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}" : { - "delete" : { - "description" : "Removes one Service Account from the specified project.", - "operationId" : "deleteProjectServiceAccount", - "parameters" : [ { - "description" : "Id of the service account.", - "in" : "path", - "name" : "serviceAccountId", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "$ref" : "#/components/parameters/groupId" - }, { - "$ref" : "#/components/parameters/envelope" - }, { - "$ref" : "#/components/parameters/pretty" - } ], - "responses" : { - "204" : { - "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/NoBody" - }, - "x-xgen-version" : "2023-10-01" - } - }, - "description" : "This endpoint does not return a response body.", - "x-xgen-version" : "2023-10-01" - }, - "401" : { - "$ref" : "#/components/responses/unauthorized" - }, "404" : { "$ref" : "#/components/responses/notFound" }, @@ -16628,189 +16574,30 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Unassign One Service Account from One Project.", - "tags" : [ "Groups" ] - }, - "get" : { - "description" : "Get project Service Account Details.", - "operationId" : "getProjectServiceAccount", - "parameters" : [ { - "$ref" : "#/components/parameters/groupId" - }, { - "description" : "Id of the service account.", - "in" : "path", - "name" : "serviceAccountId", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "$ref" : "#/components/parameters/envelope" - }, { - "$ref" : "#/components/parameters/pretty" - } ], - "responses" : { - "200" : { - "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/GroupServiceAccount" - }, - "x-xgen-version" : "2023-10-01" - } - }, - "description" : "OK" - }, - "401" : { - "$ref" : "#/components/responses/unauthorized" - }, - "404" : { - "$ref" : "#/components/responses/notFound" - }, - "500" : { - "$ref" : "#/components/responses/internalServerError" - } - }, - "security" : [ { - "DigestAuth" : [ ] - } ], - "summary" : "Service Account Fetching", - "tags" : [ "Groups" ] + "summary" : "Return One Project Settings", + "tags" : [ "Projects" ] }, "patch" : { - "description" : "Update Service Account in Project.", - "operationId" : "updateProjectServiceAccount", + "description" : "Updates the settings of the specified project. You can update any of the options available. MongoDB cloud only updates the options provided in the request. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "updateProjectSettings", "parameters" : [ { - "description" : "Id of the service account.", - "in" : "path", - "name" : "serviceAccountId", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "$ref" : "#/components/parameters/groupId" - }, { "$ref" : "#/components/parameters/envelope" - }, { - "$ref" : "#/components/parameters/pretty" - } ], - "requestBody" : { - "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/GroupServiceAccountUpdateRequest" - } - } - }, - "description" : "Details to update service account in the specified Project.", - "required" : true - }, - "responses" : { - "200" : { - "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/GroupServiceAccount" - }, - "x-xgen-version" : "2023-10-01" - } - }, - "description" : "OK" - }, - "400" : { - "$ref" : "#/components/responses/badRequest" - }, - "401" : { - "$ref" : "#/components/responses/unauthorized" - }, - "404" : { - "$ref" : "#/components/responses/notFound" - }, - "500" : { - "$ref" : "#/components/responses/internalServerError" - } - }, - "security" : [ { - "DigestAuth" : [ ] - } ], - "summary" : "Service Account Update in Project", - "tags" : [ "Groups" ] - }, - "post" : { - "description" : "Assigns the specified organization Service Account to the specified project.", - "operationId" : "addProjectServiceAccount", - "parameters" : [ { - "description" : "Id of the service account.", - "in" : "path", - "name" : "serviceAccountId", - "required" : true, - "schema" : { - "type" : "string" - } }, { "$ref" : "#/components/parameters/groupId" - }, { - "$ref" : "#/components/parameters/envelope" }, { "$ref" : "#/components/parameters/pretty" } ], "requestBody" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2023-01-01+json" : { "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/GroupServiceAccountRoleAssignment" - } - }, - "x-xgen-version" : "2023-10-01" + "$ref" : "#/components/schemas/GroupSettings" + } } }, - "description" : "Service Account Roles to be assigned to the specified project.", + "description" : "Settings to update.", "required" : true }, - "responses" : { - "204" : { - "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/NoBody" - }, - "x-xgen-version" : "2023-10-01" - } - }, - "description" : "This endpoint does not return a response body.", - "x-xgen-version" : "2023-10-01" - }, - "401" : { - "$ref" : "#/components/responses/unauthorized" - }, - "404" : { - "$ref" : "#/components/responses/notFound" - }, - "500" : { - "$ref" : "#/components/responses/internalServerError" - } - }, - "security" : [ { - "DigestAuth" : [ ] - } ], - "summary" : "Assign One Service Account to One Project", - "tags" : [ "Groups" ] - } - }, - "/api/atlas/v2/groups/{groupId}/settings" : { - "get" : { - "description" : "Returns details about the specified project's settings. To use this resource, the requesting API Key must have the Project Read Only role.", - "operationId" : "getProjectSettings", - "parameters" : [ { - "$ref" : "#/components/parameters/envelope" - }, { - "$ref" : "#/components/parameters/groupId" - }, { - "$ref" : "#/components/parameters/pretty" - } ], "responses" : { "200" : { "content" : { @@ -16839,51 +16626,92 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Return One Project Settings", + "summary" : "Update One Project Settings", "tags" : [ "Projects" ] - }, - "patch" : { - "description" : "Updates the settings of the specified project. You can update any of the options available. MongoDB cloud only updates the options provided in the request. To use this resource, the requesting API Key must have the Project Owner role.", - "operationId" : "updateProjectSettings", + } + }, + "/api/atlas/v2/groups/{groupId}/streams" : { + "get" : { + "description" : "Returns all stream instances for the specified project.", + "operationId" : "listStreamInstances", "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { "$ref" : "#/components/parameters/envelope" }, { - "$ref" : "#/components/parameters/groupId" + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiStreamsTenantView" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Project Stream Instances", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "post" : { + "description" : "Creates one stream instance in the specified project. To use this resource, the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role.", + "operationId" : "createStreamInstance", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" }, { "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" } ], "requestBody" : { "content" : { - "application/vnd.atlas.2023-01-01+json" : { + "application/vnd.atlas.2023-02-01+json" : { "schema" : { - "$ref" : "#/components/schemas/GroupSettings" + "$ref" : "#/components/schemas/StreamsTenant" } } }, - "description" : "Settings to update.", + "description" : "Details to create one streams instance in the specified project.", "required" : true }, "responses" : { "200" : { "content" : { - "application/vnd.atlas.2023-01-01+json" : { + "application/vnd.atlas.2023-02-01+json" : { "schema" : { - "$ref" : "#/components/schemas/GroupSettings" + "$ref" : "#/components/schemas/StreamsTenant" }, - "x-xgen-version" : "2023-01-01" + "x-xgen-version" : "2023-02-01" } }, "description" : "OK" }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, "401" : { "$ref" : "#/components/responses/unauthorized" }, - "403" : { - "$ref" : "#/components/responses/forbidden" - }, - "404" : { - "$ref" : "#/components/responses/notFound" - }, "500" : { "$ref" : "#/components/responses/internalServerError" } @@ -16891,14 +16719,17 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Update One Project Settings", - "tags" : [ "Projects" ] + "summary" : "Create One Stream Instance", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } } }, - "/api/atlas/v2/groups/{groupId}/streams" : { + "/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections" : { "get" : { - "description" : "Returns all stream instances for the specified project.", - "operationId" : "listStreamInstances", + "description" : "Returns all Private Link connections for the specified project.To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role.", + "operationId" : "listPrivateLinkConnections", "parameters" : [ { "$ref" : "#/components/parameters/groupId" }, { @@ -16915,7 +16746,7 @@ "content" : { "application/vnd.atlas.2023-02-01+json" : { "schema" : { - "$ref" : "#/components/schemas/PaginatedApiStreamsTenantView" + "$ref" : "#/components/schemas/PaginatedApiStreamsPrivateLinkView" }, "x-xgen-version" : "2023-02-01" } @@ -16925,6 +16756,9 @@ "401" : { "$ref" : "#/components/responses/unauthorized" }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, "500" : { "$ref" : "#/components/responses/internalServerError" } @@ -16932,15 +16766,15 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Return All Project Stream Instances", + "summary" : "Return All Private Link", "tags" : [ "Streams" ], "x-xgen-changelog" : { - "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + "2024-10-02" : "The MongoDB Atlas Streams Processing Private Link API is now exposed as part of private preview, but is subject to change until GA." } }, "post" : { - "description" : "Creates one stream instance in the specified project. To use this resource, the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role.", - "operationId" : "createStreamInstance", + "description" : "Creates one Private Link in the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Stream Processing Owner role.", + "operationId" : "createPrivateLinkConnection", "parameters" : [ { "$ref" : "#/components/parameters/envelope" }, { @@ -16952,11 +16786,11 @@ "content" : { "application/vnd.atlas.2023-02-01+json" : { "schema" : { - "$ref" : "#/components/schemas/StreamsTenant" + "$ref" : "#/components/schemas/StreamsPrivateLinkConnection" } } }, - "description" : "Details to create one streams instance in the specified project.", + "description" : "Details to create one Private Link connection for a project. project.", "required" : true }, "responses" : { @@ -16964,7 +16798,7 @@ "content" : { "application/vnd.atlas.2023-02-01+json" : { "schema" : { - "$ref" : "#/components/schemas/StreamsTenant" + "$ref" : "#/components/schemas/StreamsPrivateLinkConnection" }, "x-xgen-version" : "2023-02-01" } @@ -16977,6 +16811,9 @@ "401" : { "$ref" : "#/components/responses/unauthorized" }, + "409" : { + "$ref" : "#/components/responses/unauthorized" + }, "500" : { "$ref" : "#/components/responses/internalServerError" } @@ -16984,13 +16821,310 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Create One Stream Instance", + "summary" : "Create One Private Link connection", "tags" : [ "Streams" ], "x-xgen-changelog" : { - "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + "2024-10-02" : "The MongoDB Atlas Streams Processing Private Link API is now exposed as part of private preview, but is subject to change until GA." } } }, + "/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections/{connectionId}" : { + "delete" : { + "description" : "Deletes one Private Link in the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Stream Processing Owner role.", + "operationId" : "deletePrivateLinkConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique ID that identifies the Private Link connection.", + "in" : "path", + "name" : "connectionId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Accepted" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete One Private Link connection", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2024-10-02" : "The MongoDB Atlas Streams Processing Private Link API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "get" : { + "description" : "Returns the details of one Private Link connection within the project. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "getPrivateLinkConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique ID that identifies the Private Link connection.", + "in" : "path", + "name" : "connectionId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsPrivateLinkConnection" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One PrivateLink Connection", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2024-10-02" : "The MongoDB Atlas Streams Processing Private Link API is now exposed as part of private preview, but is subject to change until GA." + } + } + }, + "/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections" : { + "get" : { + "description" : "Returns a list of incoming VPC Peering Connections.", + "operationId" : "getVPCPeeringConnections", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All VPC Peering Connections.", + "tags" : [ "Streams" ] + } + }, + "/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}" : { + "delete" : { + "description" : "Deletes an incoming VPC Peering connection.", + "operationId" : "deleteVPCPeeringConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "The VPC Peering Connection id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Accepted" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Deletes an incoming VPC Peering connection.", + "tags" : [ "Streams" ] + } + }, + "/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:accept" : { + "post" : { + "description" : "Requests the acceptance of an incoming VPC Peering connection.", + "operationId" : "acceptVPCPeeringConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "The VPC Peering Connection id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/VPCPeeringActionChallenge" + } + } + }, + "description" : "Challenge values for VPC Peering requester account ID, and requester VPC ID.", + "required" : true + }, + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Accepted" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Requests the acceptance of an incoming VPC Peering connection.", + "tags" : [ "Streams" ] + } + }, + "/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:reject" : { + "post" : { + "description" : "Requests the rejection of an incoming VPC Peering connection.", + "operationId" : "rejectVPCPeeringConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "The VPC Peering Connection id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Accepted" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Requests the rejection of an incoming VPC Peering connection.", + "tags" : [ "Streams" ] + } + }, "/api/atlas/v2/groups/{groupId}/streams/{tenantName}" : { "delete" : { "description" : "Delete one stream instance in the specified project. To use this resource, the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role.", @@ -20058,414 +20192,6 @@ "tags" : [ "Cloud Migration Service" ] } }, - "/api/atlas/v2/orgs/{orgId}/serviceAccounts" : { - "get" : { - "description" : "Returns list of Service Accounts with service account details.", - "operationId" : "listServiceAccounts", - "parameters" : [ { - "$ref" : "#/components/parameters/orgId" - }, { - "$ref" : "#/components/parameters/itemsPerPage" - }, { - "$ref" : "#/components/parameters/pageNum" - }, { - "$ref" : "#/components/parameters/pretty" - }, { - "$ref" : "#/components/parameters/envelope" - } ], - "responses" : { - "200" : { - "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/PaginatedOrgServiceAccounts" - }, - "x-xgen-version" : "2023-10-01" - } - }, - "description" : "OK" - }, - "401" : { - "$ref" : "#/components/responses/unauthorized" - }, - "403" : { - "$ref" : "#/components/responses/forbidden" - }, - "500" : { - "$ref" : "#/components/responses/internalServerError" - } - }, - "security" : [ { - "DigestAuth" : [ ] - } ], - "summary" : "Return All Service Accounts", - "tags" : [ "Organizations" ] - }, - "post" : { - "description" : "Create Service Account containing client id and client secrets.", - "operationId" : "createServiceAccount", - "parameters" : [ { - "$ref" : "#/components/parameters/orgId" - }, { - "$ref" : "#/components/parameters/envelope" - }, { - "$ref" : "#/components/parameters/pretty" - } ], - "requestBody" : { - "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/OrgServiceAccountRequest" - } - } - }, - "description" : "Details to create service account in the specified organization.", - "required" : true - }, - "responses" : { - "201" : { - "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/OrgServiceAccount" - }, - "x-xgen-version" : "2023-10-01" - } - }, - "description" : "Created" - }, - "400" : { - "$ref" : "#/components/responses/badRequest" - }, - "401" : { - "$ref" : "#/components/responses/unauthorized" - }, - "500" : { - "$ref" : "#/components/responses/internalServerError" - } - }, - "security" : [ { - "DigestAuth" : [ ] - } ], - "summary" : "Service Account Creation", - "tags" : [ "Organizations" ] - } - }, - "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}" : { - "delete" : { - "description" : "Delete Service Account.", - "operationId" : "deleteServiceAccount", - "parameters" : [ { - "description" : "Id of the service account.", - "in" : "path", - "name" : "serviceAccountId", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "$ref" : "#/components/parameters/orgId" - }, { - "$ref" : "#/components/parameters/envelope" - }, { - "$ref" : "#/components/parameters/pretty" - } ], - "responses" : { - "204" : { - "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "x-xgen-version" : "2023-10-01" - } - }, - "description" : "This endpoint does not return a response body." - }, - "401" : { - "$ref" : "#/components/responses/unauthorized" - }, - "404" : { - "$ref" : "#/components/responses/notFound" - }, - "500" : { - "$ref" : "#/components/responses/internalServerError" - } - }, - "security" : [ { - "DigestAuth" : [ ] - } ], - "summary" : "Service Account Deletion.", - "tags" : [ "Organizations" ] - }, - "get" : { - "description" : "Get Service Account Details.", - "operationId" : "getServiceAccount", - "parameters" : [ { - "$ref" : "#/components/parameters/orgId" - }, { - "description" : "Id of the service account.", - "in" : "path", - "name" : "serviceAccountId", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "$ref" : "#/components/parameters/envelope" - }, { - "$ref" : "#/components/parameters/pretty" - } ], - "responses" : { - "200" : { - "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/OrgServiceAccount" - }, - "x-xgen-version" : "2023-10-01" - } - }, - "description" : "OK" - }, - "401" : { - "$ref" : "#/components/responses/unauthorized" - }, - "404" : { - "$ref" : "#/components/responses/notFound" - }, - "500" : { - "$ref" : "#/components/responses/internalServerError" - } - }, - "security" : [ { - "DigestAuth" : [ ] - } ], - "summary" : "Service Account Fetching", - "tags" : [ "Organizations" ] - }, - "patch" : { - "description" : "Update Service Account.", - "operationId" : "updateServiceAccount", - "parameters" : [ { - "description" : "Id of the service account.", - "in" : "path", - "name" : "serviceAccountId", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "$ref" : "#/components/parameters/orgId" - }, { - "$ref" : "#/components/parameters/envelope" - }, { - "$ref" : "#/components/parameters/pretty" - } ], - "requestBody" : { - "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/OrgServiceAccountUpdateRequest" - } - } - }, - "description" : "Details to update service account in the specified organization.", - "required" : true - }, - "responses" : { - "200" : { - "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/OrgServiceAccount" - }, - "x-xgen-version" : "2023-10-01" - } - }, - "description" : "OK" - }, - "400" : { - "$ref" : "#/components/responses/badRequest" - }, - "401" : { - "$ref" : "#/components/responses/unauthorized" - }, - "404" : { - "$ref" : "#/components/responses/notFound" - }, - "500" : { - "$ref" : "#/components/responses/internalServerError" - } - }, - "security" : [ { - "DigestAuth" : [ ] - } ], - "summary" : "Service Account Update", - "tags" : [ "Organizations" ] - } - }, - "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/groups" : { - "get" : { - "description" : "Returns list of Service Account projects.", - "operationId" : "listServiceAccountProjects", - "parameters" : [ { - "$ref" : "#/components/parameters/orgId" - }, { - "description" : "Id of the service account.", - "in" : "path", - "name" : "serviceAccountId", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "$ref" : "#/components/parameters/itemsPerPage" - }, { - "$ref" : "#/components/parameters/pageNum" - }, { - "$ref" : "#/components/parameters/pretty" - }, { - "$ref" : "#/components/parameters/envelope" - } ], - "responses" : { - "200" : { - "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/PaginatedServiceAccountGroup" - }, - "x-xgen-version" : "2023-10-01" - } - }, - "description" : "OK" - }, - "401" : { - "$ref" : "#/components/responses/unauthorized" - }, - "403" : { - "$ref" : "#/components/responses/forbidden" - }, - "500" : { - "$ref" : "#/components/responses/internalServerError" - } - }, - "security" : [ { - "DigestAuth" : [ ] - } ], - "summary" : "Return All Service Account projects", - "tags" : [ "Organizations" ] - } - }, - "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets" : { - "post" : { - "description" : "Create Service Account secret.", - "operationId" : "createServiceAccountSecret", - "parameters" : [ { - "$ref" : "#/components/parameters/orgId" - }, { - "description" : "Id of the service account.", - "in" : "path", - "name" : "serviceAccountId", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "$ref" : "#/components/parameters/envelope" - }, { - "$ref" : "#/components/parameters/pretty" - } ], - "requestBody" : { - "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/ServiceAccountSecretRequest" - } - } - }, - "description" : "Details to create secret in the specified service account.", - "required" : true - }, - "responses" : { - "201" : { - "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/ServiceAccountSecret" - }, - "x-xgen-version" : "2023-10-01" - } - }, - "description" : "Created" - }, - "400" : { - "$ref" : "#/components/responses/badRequest" - }, - "401" : { - "$ref" : "#/components/responses/unauthorized" - }, - "500" : { - "$ref" : "#/components/responses/internalServerError" - } - }, - "security" : [ { - "DigestAuth" : [ ] - } ], - "summary" : "Service Account Secret Creation", - "tags" : [ "Organizations" ] - } - }, - "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets/{secretId}" : { - "delete" : { - "description" : "Delete Service Account Secret.", - "operationId" : "deleteServiceAccountSecret", - "parameters" : [ { - "description" : "Id of the service account.", - "in" : "path", - "name" : "serviceAccountId", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "description" : "Id of the secret.", - "in" : "path", - "name" : "secretId", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "$ref" : "#/components/parameters/orgId" - }, { - "$ref" : "#/components/parameters/envelope" - }, { - "$ref" : "#/components/parameters/pretty" - } ], - "responses" : { - "204" : { - "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "x-xgen-version" : "2023-10-01" - } - }, - "description" : "This endpoint does not return a response body." - }, - "401" : { - "$ref" : "#/components/responses/unauthorized" - }, - "404" : { - "$ref" : "#/components/responses/notFound" - }, - "500" : { - "$ref" : "#/components/responses/internalServerError" - } - }, - "security" : [ { - "DigestAuth" : [ ] - } ], - "summary" : "Service Account Secret Deletion.", - "tags" : [ "Organizations" ] - } - }, "/api/atlas/v2/orgs/{orgId}/settings" : { "get" : { "description" : "Returns details about the specified organization's settings. To use this resource, the requesting API Key must have the Organization Owner role.", @@ -20541,6 +20267,9 @@ }, "description" : "OK" }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, "401" : { "$ref" : "#/components/responses/unauthorized" }, @@ -21167,12 +20896,15 @@ }, "/api/atlas/v2/orgs/{orgId}/users/{userId}" : { "delete" : { + "deprecated" : true, "description" : "Removes one MongoDB Cloud user from the specified organization. To use this resource, the requesting API Key must have the Organization User Admin role.", "operationId" : "removeOrganizationUser", "parameters" : [ { "$ref" : "#/components/parameters/envelope" }, { "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" }, { "description" : "Unique 24-hexadecimal digit string that identifies the user to be deleted.", "in" : "path", @@ -21216,8 +20948,9 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Remove One MongoDB Cloud User from One Organization", - "tags" : [ "Organizations" ] + "summary" : "Remove One MongoDB Cloud User From One Organization", + "tags" : [ "Organizations" ], + "x-sunset" : "2026-01-01" } }, "/api/atlas/v2/orgs/{orgId}/users/{userId}/roles" : { @@ -21965,7 +21698,7 @@ "diskIOPS" : { "type" : "integer", "format" : "int32", - "description" : "Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.\n\n Change this parameter only if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" to \"AWS\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" to \"M30\"` or greater (not including `Mxx_NVME` tiers).\n\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType\" to \"PROVISIONED\"`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1." + "description" : "Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.\n\n Change this parameter if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" to \"AWS\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" to \"M30\"` or greater (not including `Mxx_NVME` tiers).\n\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType\" to \"PROVISIONED\"`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1." }, "ebsVolumeType" : { "type" : "string", @@ -21994,7 +21727,7 @@ "diskIOPS" : { "type" : "integer", "format" : "int32", - "description" : "Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.\n\n You can set different IOPS values on different shards when provisioned IOPS are supported.\n\n Change this parameter only if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" to \"AWS\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" to \"M30\"` or greater (not including `Mxx_NVME` tiers).\n\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType\" to \"PROVISIONED\"`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1." + "description" : "Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.\n\n You can set different IOPS values on different shards when provisioned IOPS are supported.\n\n Change this parameter if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" to \"AWS\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" to \"M30\"` or greater (not including `Mxx_NVME` tiers).\n\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType\" to \"PROVISIONED\"`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1." }, "diskSizeGB" : { "type" : "number", @@ -22325,6 +22058,26 @@ "description" : "Configuration of nodes that comprise the cluster.", "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] }, + "configServerManagementMode" : { + "type" : "string", + "default" : "ATLAS_MANAGED", + "description" : "Config Server Management Mode for creating or updating a sharded cluster.\n\nWhen configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings.\n\nWhen configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server.", + "enum" : [ "ATLAS_MANAGED", "FIXED_TO_DEDICATED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + } + }, + "configServerType" : { + "type" : "string", + "description" : "Describes a sharded cluster's config server type.", + "enum" : [ "DEDICATED", "EMBEDDED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + }, + "readOnly" : true + }, "connectionStrings" : { "$ref" : "#/components/schemas/ClusterConnectionStrings" }, @@ -22360,6 +22113,17 @@ "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" } }, + "featureCompatibilityVersion" : { + "type" : "string", + "description" : "Feature compatibility version of the cluster.", + "readOnly" : true + }, + "featureCompatibilityVersionExpirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Feature compatibility version expiration date.", + "readOnly" : true + }, "globalClusterSelfManagedSharding" : { "type" : "boolean", "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen 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.\n\nWhen 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.\n\nThis setting cannot be changed once the cluster is deployed.", @@ -22406,6 +22170,9 @@ }, "readOnly" : true }, + "mongoDBEmployeeAccessGrant" : { + "$ref" : "#/components/schemas/EmployeeAccessGrantView" + }, "mongoDBMajorVersion" : { "type" : "string", "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", @@ -22425,7 +22192,7 @@ "description" : "Human-readable label that identifies the advanced cluster.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, "paused" : { "type" : "boolean", @@ -22439,6 +22206,16 @@ "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" } }, + "replicaSetScalingStrategy" : { + "type" : "string", + "default" : "WORKLOAD_TYPE", + "description" : "Set this field to configure the replica set scaling mode for your cluster.\n\nBy default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes.\n\nWhen configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads.\n\nWhen configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads.", + "enum" : [ "SEQUENTIAL", "WORKLOAD_TYPE", "NODE_TYPE" ], + "externalDocs" : { + "description" : "Modify the Replica Set Scaling Mode", + "url" : "https://dochub.mongodb.org/core/scale-nodes" + } + }, "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.", @@ -23309,6 +23086,257 @@ }, "title" : "mappings" }, + "ApiAtlasInvalidPolicyErrorDetailView" : { + "type" : "object", + "properties" : { + "detail" : { + "type" : "string", + "description" : "A string that provides a detailed description of a validation error.", + "readOnly" : true + } + } + }, + "ApiAtlasInvalidPolicyView" : { + "type" : "object", + "properties" : { + "body" : { + "type" : "string", + "description" : "A string that defines the permissions for the policy. The syntax used is the Cedar Policy language.", + "example" : " forbid (\n principal,\n action == cloud::Action::\"cluster.createEdit\",\n resource\n ) when {\n context.cluster.regions.contains(cloud::region::\"aws:us-east-1\")\n };\n", + "readOnly" : true + }, + "errors" : { + "type" : "array", + "description" : "List of validation errors.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasInvalidPolicyErrorDetailView" + }, + "readOnly" : true + } + } + }, + "ApiAtlasInvalidResourcePolicyCreateErrorView" : { + "type" : "object", + "properties" : { + "errorType" : { + "type" : "string", + "description" : "Human-readable label that displays the type of an error.", + "enum" : [ "POLICY_PARSING_ERROR", "POLICY_HAS_FAILED_VALIDATIONS", "POLICY_HAS_INVALID_PRINCIPAL", "POLICY_HAS_BODY_EXCEEDING_MAX_SIZE", "POLICY_HAS_UNEXPECTED_ENTITIES" ] + }, + "invalidPolicies" : { + "type" : "array", + "description" : "List of invalid policies containing details of their validation errors.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasInvalidPolicyView" + }, + "readOnly" : true + } + } + }, + "ApiAtlasNonCompliantResourceView" : { + "type" : "object", + "properties" : { + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization the resource belongs to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resourceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the non-compliant resource.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resourcePoliciesCausingNonCompliance" : { + "type" : "array", + "description" : "List of resource policies causing the resource to be considered non-compliant.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasResourcePolicyMetadataView" + }, + "readOnly" : true + }, + "resourceType" : { + "type" : "string", + "description" : "Human-readable label that displays the type of a resource.", + "enum" : [ "PROJECT", "CLUSTER" ], + "readOnly" : true + } + } + }, + "ApiAtlasPolicyCreateView" : { + "type" : "object", + "properties" : { + "body" : { + "type" : "string", + "description" : "A string that defines the permissions for the policy. The syntax used is the Cedar Policy language.", + "example" : " forbid (\n principal,\n action == cloud::Action::\"cluster.createEdit\",\n resource\n ) when {\n context.cluster.regions.contains(cloud::region::\"aws:us-east-1\")\n };\n" + } + }, + "required" : [ "body" ] + }, + "ApiAtlasPolicyMetadataView" : { + "type" : "object", + "properties" : { + "policyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "ApiAtlasPolicyView" : { + "type" : "object", + "properties" : { + "body" : { + "type" : "string", + "description" : "A string that defines the permissions for the policy. The syntax used is the Cedar Policy language.", + "example" : " forbid (\n principal,\n action == cloud::Action::\"cluster.createEdit\",\n resource\n ) when {\n context.cluster.regions.contains(cloud::region::\"aws:us-east-1\")\n };\n", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "ApiAtlasResourcePolicyCreateView" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that describes the atlas resource policy." + }, + "policies" : { + "type" : "array", + "description" : "List of policies that make up the atlas resource policy.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasPolicyCreateView" + } + } + }, + "required" : [ "name", "policies" ] + }, + "ApiAtlasResourcePolicyEditView" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that describes the atlas resource policy." + }, + "policies" : { + "type" : "array", + "description" : "List of policies that make up the atlas resource policy.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasPolicyCreateView" + } + } + } + }, + "ApiAtlasResourcePolicyMetadataView" : { + "type" : "object", + "properties" : { + "policiesCausingNonCompliance" : { + "type" : "array", + "description" : "List of policies that are in conflict with the current state of the resource.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasPolicyMetadataView" + }, + "readOnly" : true + }, + "resourcePolicyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the atlas resource policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resourcePolicyName" : { + "type" : "string", + "description" : "Human-readable label that describes the atlas resource policy.", + "readOnly" : true + } + } + }, + "ApiAtlasResourcePolicyView" : { + "type" : "object", + "properties" : { + "createdByUser" : { + "$ref" : "#/components/schemas/ApiAtlasUserMetadataView" + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time in UTC when the atlas resource policy was created.", + "example" : "2022-01-01T00:00:00Z", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the atlas resource policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastUpdatedByUser" : { + "$ref" : "#/components/schemas/ApiAtlasUserMetadataView" + }, + "lastUpdatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time in UTC when the atlas resource policy was last updated.", + "example" : "2022-01-01T00:00:00Z", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that describes the atlas resource policy.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization the atlas resource policy belongs to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "policies" : { + "type" : "array", + "description" : "List of policies that make up the atlas resource policy.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasPolicyView" + }, + "readOnly" : true + }, + "version" : { + "type" : "string", + "description" : "A string that identifies the version of the atlas resource policy.", + "example" : "v1", + "readOnly" : true + } + } + }, "ApiAtlasSnapshotScheduleView" : { "type" : "object", "properties" : { @@ -23385,6 +23413,27 @@ }, "required" : [ "clusterCheckpointIntervalMin", "clusterId", "dailySnapshotRetentionDays", "groupId", "monthlySnapshotRetentionMonths", "pointInTimeWindowHours", "snapshotIntervalHours", "snapshotRetentionDays", "weeklySnapshotRetentionWeeks" ] }, + "ApiAtlasUserMetadataView" : { + "type" : "object", + "description" : "The user that last updated the atlas resource policy.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies a user.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that describes a user.", + "readOnly" : true + } + }, + "readOnly" : true + }, "ApiBSONTimestampView" : { "type" : "object", "description" : "BSON timestamp that indicates when the checkpoint token entry in the oplog occurred.", @@ -23441,6 +23490,9 @@ "ApiError" : { "type" : "object", "properties" : { + "badRequestDetail" : { + "$ref" : "#/components/schemas/BadRequestDetail" + }, "detail" : { "type" : "string", "description" : "Describes the specific conditions or reasons that cause each type of error." @@ -23451,24 +23503,30 @@ "description" : "HTTP status code returned with this error.", "externalDocs" : { "url" : "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status" - } + }, + "readOnly" : true }, "errorCode" : { "type" : "string", - "description" : "Application error code returned with this error." + "description" : "Application error code returned with this error.", + "readOnly" : true }, "parameters" : { "type" : "array", "description" : "Parameters used to give more information about the error.", "items" : { - "type" : "object" - } + "type" : "object", + "readOnly" : true + }, + "readOnly" : true }, "reason" : { "type" : "string", - "description" : "Application error message returned with this error." + "description" : "Application error message returned with this error.", + "readOnly" : true } - } + }, + "required" : [ "error", "errorCode" ] }, "ApiHostView_Atlas" : { "type" : "object", @@ -23724,6 +23782,24 @@ } } }, + "ApiPrivateDownloadDeliveryUrl" : { + "type" : "object", + "description" : "One Uniform Resource Locator (URL) that points to the compressed snapshot files for manual download and the corresponding private endpoint.", + "properties" : { + "deliveryUrl" : { + "type" : "string", + "description" : "One Uniform Resource Locator that points to the compressed snapshot files for manual download." + }, + "endpointId" : { + "type" : "string", + "description" : "Unique 22-character alphanumeric string that identifies the private endpoint.", + "example" : "vpce-3bf78b0ddee411ba1", + "maxLength" : 22, + "minLength" : 22, + "pattern" : "^vpce-[0-9a-f]{17}$" + } + } + }, "ApiPublicUsageDetailsQueryRequest" : { "type" : "object", "description" : "Request body for an Invoice Usage Details query with filtering, pagination, and sort.", @@ -23817,7 +23893,12 @@ "ApiStreamsAWSRegionView" : { "type" : "string", "description" : "Atlas Streams AWS Regions.", - "enum" : [ "VIRGINIA_USA" ] + "enum" : [ "SYDNEY_AUS", "MUMBAI_IND", "FRANKFURT_DEU", "DUBLIN_IRL", "LONDON_GBR", "VIRGINIA_USA", "OREGON_USA", "SAOPAULO_BRA", "MONTREAL_CAN", "TOKYO_JPN", "SINGAPORE_SGP" ] + }, + "ApiStreamsAzureRegionView" : { + "type" : "string", + "description" : "Atlas Streams Azure Regions.", + "enum" : [ "VIRGINIA_USA", "AMSTERDAM_NLD" ] }, "ApiUserEventTypeViewForNdsGroup" : { "type" : "string", @@ -24041,6 +24122,15 @@ "required" : [ "created", "eventTypeName", "id" ], "title" : "API User Events" }, + "ApiVersion" : { + "type" : "object", + "properties" : { + "version" : { + "type" : "string", + "description" : "Object representing a version of the Atlas Admin API." + } + } + }, "AppServiceAlertConfigViewForNdsGroup" : { "type" : "object", "description" : "App Services metric alert configuration allows to select which app service conditions and events trigger alerts and how users are notified.", @@ -24463,7 +24553,9 @@ "enum" : [ "AVERAGE" ] }, "operator" : { - "$ref" : "#/components/schemas/Operator" + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, "threshold" : { "type" : "number", @@ -24503,6 +24595,11 @@ "description" : "Atlas Data Federation Azure Regions.", "enum" : [ "VIRGINIA_USA", "AMSTERDAM_NLD" ] }, + "AtlasDataFederationGCPRegion" : { + "type" : "string", + "description" : "Atlas Data Federation GCP Regions.", + "enum" : [ "IOWA_USA", "BELGIUM_EU" ] + }, "AtlasOrganization" : { "type" : "object", "description" : "Details that describe the organization.", @@ -24543,6 +24640,122 @@ }, "required" : [ "name" ] }, + "AtlasResourcePolicyAuditForOrg" : { + "type" : "object", + "description" : "Atlas resource policy audits indicate org level changes to resource policies", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "RESOURCE_POLICY_CREATED", "RESOURCE_POLICY_MODIFIED", "RESOURCE_POLICY_DELETED" ], + "example" : "RESOURCE_POLICY_CREATED", + "title" : "Atlas Resource Policy Audit Types" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "resourcePolicyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the resource policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Atlas Resource Policy Audits" + }, "AtlasSearchAnalyzer" : { "type" : "object", "properties" : { @@ -25058,6 +25271,15 @@ "AzureHardwareSpec" : { "type" : "object", "properties" : { + "diskIOPS" : { + "type" : "integer", + "format" : "int32", + "description" : "Target throughput desired for storage attached to your Azure-provisioned cluster. Change this parameter if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" : \"Azure\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : \"M40\"` or greater not including `Mxx_NVME` tiers.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://www.mongodb.com/docs/atlas/customize-storage/#extend-iops-on-azure" + } + }, "instanceSize" : { "type" : "string", "description" : "Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts of the node type.", @@ -25074,6 +25296,15 @@ "AzureHardwareSpec20240805" : { "type" : "object", "properties" : { + "diskIOPS" : { + "type" : "integer", + "format" : "int32", + "description" : "Target throughput desired for storage attached to your Azure-provisioned cluster. Change this parameter if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" : \"Azure\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : \"M40\"` or greater not including `Mxx_NVME` tiers.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://www.mongodb.com/docs/atlas/customize-storage/#extend-iops-on-azure" + } + }, "diskSizeGB" : { "type" : "number", "format" : "double", @@ -25201,7 +25432,7 @@ "status" : { "type" : "string", "description" : "State of the Encryption At Rest private endpoint.", - "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "ACTIVE", "FAILED" ], + "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "ACTIVE", "FAILED", "PENDING_RECREATION", "DELETING" ], "readOnly" : true } }, @@ -25534,7 +25765,7 @@ "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to create an online archive.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "collName" : { @@ -25618,7 +25849,7 @@ "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to create an online archive.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "collName" : { @@ -25721,7 +25952,7 @@ "description" : "Human-readable label that identifies the cluster containing the snapshots you want to retrieve.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -25878,7 +26109,7 @@ "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\"`.\n\nIf the target cluster doesn't have backup enabled, two resources return parameters with empty values:\n\n- **Get All Snapshots** endpoint returns an empty results array without **clusterId** elements\n- **Get a Snapshot** endpoint doesn't return a **clusterId** parameter.\n\nTo return a response with the **clusterId** parameter, either use the **delivery.targetClusterName** parameter or enable backup on the target cluster.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, "targetGroupId" : { "type" : "string", @@ -26139,6 +26370,20 @@ } } }, + "BadRequestDetail" : { + "type" : "object", + "description" : "Bad request detail.", + "properties" : { + "fields" : { + "type" : "array", + "description" : "Describes all violations in a client request.", + "items" : { + "$ref" : "#/components/schemas/FieldViolation" + } + } + }, + "readOnly" : true + }, "BaseAtlasDataLakeRegion" : { "type" : "object", "description" : "Name of the region to which the data lake routes client connections.", @@ -26146,6 +26391,8 @@ "$ref" : "#/components/schemas/ApiAtlasDataLakeAWSRegionView" }, { "$ref" : "#/components/schemas/AtlasDataFederationAzureRegion" + }, { + "$ref" : "#/components/schemas/AtlasDataFederationGCPRegion" } ] }, "BaseCloudProviderInstanceSize" : { @@ -26213,6 +26460,8 @@ "description" : "Name of the cloud provider region hosting Atlas Stream Processing.", "oneOf" : [ { "$ref" : "#/components/schemas/ApiStreamsAWSRegionView" + }, { + "$ref" : "#/components/schemas/ApiStreamsAzureRegionView" } ] }, "BasicBSONList" : { @@ -27102,7 +27351,7 @@ "description" : "Human-readable label that identifies the cluster.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "nodeCount" : { @@ -27154,6 +27403,11 @@ "format" : "date-time", "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." }, + "description" : { + "type" : "string", + "description" : "Description of this database user.", + "maxLength" : 100 + }, "groupId" : { "type" : "string", "description" : "Unique 24-hexadecimal digit string that identifies the project.", @@ -27332,6 +27586,123 @@ "description" : "Details that describe the features linked to the Amazon Web Services (AWS) Identity and Access Management (IAM) role.", "required" : [ "providerName" ] }, + "CloudProviderAccessAWSIAMRoleRequest" : { + "type" : "object", + "description" : "Details that describe the features linked to the Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "properties" : { + "atlasAWSAccountArn" : { + "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.", + "example" : "arn:aws:iam::772401394250:role/my-test-aws-role", + "maxLength" : 2048, + "minLength" : 20, + "readOnly" : true + }, + "atlasAssumedRoleExternalId" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique external ID that MongoDB Cloud uses when it assumes the IAM role in your Amazon Web Services (AWS) account.", + "readOnly" : true + }, + "authorizedDate" : { + "type" : "string", + "format" : "date-time", + "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.", + "readOnly" : true + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "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.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider of the role.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "roleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + }, + "required" : [ "providerName" ] + }, + "CloudProviderAccessAWSIAMRoleRequestUpdate" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessRoleRequestUpdate" + }, { + "type" : "object", + "properties" : { + "atlasAWSAccountArn" : { + "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.", + "example" : "arn:aws:iam::772401394250:role/my-test-aws-role", + "maxLength" : 2048, + "minLength" : 20, + "readOnly" : true + }, + "atlasAssumedRoleExternalId" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique external ID that MongoDB Cloud uses when it assumes the IAM role in your Amazon Web Services (AWS) account.", + "readOnly" : true + }, + "authorizedDate" : { + "type" : "string", + "format" : "date-time", + "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.", + "readOnly" : true + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "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.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "iamAssumedRoleArn" : { + "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", + "maxLength" : 2048, + "minLength" : 20 + }, + "roleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + } ], + "description" : "Details that describe the features linked to the Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "required" : [ "providerName" ] + }, "CloudProviderAccessAzureServicePrincipal" : { "type" : "object", "allOf" : [ { @@ -27394,6 +27765,130 @@ "description" : "Details that describe the features linked to the Azure Service Principal.", "required" : [ "providerName" ] }, + "CloudProviderAccessAzureServicePrincipalRequest" : { + "type" : "object", + "description" : "Details that describe the features linked to the Azure Service Principal.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "atlasAzureAppId" : { + "type" : "string", + "description" : "Azure Active Directory Application ID of Atlas.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this Azure Service Principal was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Azure Service Principal.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "lastUpdatedDate" : { + "type" : "string", + "format" : "date-time", + "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.", + "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.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "tenantId" : { + "type" : "string", + "description" : "UUID String that identifies the Azure Active Directory Tenant ID.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + } + }, + "required" : [ "providerName" ] + }, + "CloudProviderAccessAzureServicePrincipalRequestUpdate" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessRoleRequestUpdate" + }, { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "atlasAzureAppId" : { + "type" : "string", + "description" : "Azure Active Directory Application ID of Atlas.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this Azure Service Principal was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Azure Service Principal.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "lastUpdatedDate" : { + "type" : "string", + "format" : "date-time", + "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.", + "readOnly" : true + }, + "servicePrincipalId" : { + "type" : "string", + "description" : "UUID string that identifies the Azure Service Principal.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "tenantId" : { + "type" : "string", + "description" : "UUID String that identifies the Azure Active Directory Tenant ID.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + } + } + } ], + "description" : "Details that describe the features linked to the Azure Service Principal.", + "required" : [ "providerName" ] + }, "CloudProviderAccessDataLakeFeatureUsage" : { "type" : "object", "allOf" : [ { @@ -27520,6 +28015,92 @@ } } }, + "CloudProviderAccessGCPServiceAccount" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, { + "type" : "object", + "properties" : { + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this Google Service Account was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Google Service Account.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "gcpServiceAccountForAtlas" : { + "type" : "string", + "description" : "Email address for the Google Service Account created by Atlas.", + "maxLength" : 82, + "minLength" : 57, + "pattern" : "^mongodb-atlas-[0-9a-z]{16}@p-[0-9a-z]{24}.iam.gserviceaccount.com$" + }, + "roleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + } ], + "description" : "Details that describe the features linked to the GCP Service Account.", + "required" : [ "providerName" ] + }, + "CloudProviderAccessGCPServiceAccountRequest" : { + "type" : "object", + "description" : "Details that describe the features linked to the GCP Service Account.", + "properties" : { + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this GCP Service Account was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this GCP Service Account.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "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" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "readOnly" : true + } + }, + "required" : [ "providerName" ] + }, + "CloudProviderAccessGCPServiceAccountRequestUpdate" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessRoleRequestUpdate" + } ], + "description" : "Details that describe the features linked to the GCP Service Account.", + "required" : [ "providerName" ] + }, "CloudProviderAccessPushBasedLogExportFeatureUsage" : { "type" : "object", "allOf" : [ { @@ -27540,20 +28121,63 @@ "discriminator" : { "mapping" : { "AWS" : "#/components/schemas/CloudProviderAccessAWSIAMRole", - "AZURE" : "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + "AZURE" : "#/components/schemas/CloudProviderAccessAzureServicePrincipal", + "GCP" : "#/components/schemas/CloudProviderAccessGCPServiceAccount" + }, + "propertyName" : "providerName" + }, + "properties" : { + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider of the role.", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, + "required" : [ "providerName" ] + }, + "CloudProviderAccessRoleRequest" : { + "type" : "object", + "description" : "Cloud provider access role.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/CloudProviderAccessAWSIAMRoleRequest", + "AZURE" : "#/components/schemas/CloudProviderAccessAzureServicePrincipalRequest", + "GCP" : "#/components/schemas/CloudProviderAccessGCPServiceAccountRequest" }, "propertyName" : "providerName" }, "oneOf" : [ { - "$ref" : "#/components/schemas/CloudProviderAccessAWSIAMRole" + "$ref" : "#/components/schemas/CloudProviderAccessAWSIAMRoleRequest" + }, { + "$ref" : "#/components/schemas/CloudProviderAccessAzureServicePrincipalRequest" }, { - "$ref" : "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + "$ref" : "#/components/schemas/CloudProviderAccessGCPServiceAccountRequest" } ], "properties" : { "providerName" : { "type" : "string", "description" : "Human-readable label that identifies the cloud provider of the role.", - "enum" : [ "AWS", "AZURE" ] + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, + "required" : [ "providerName" ] + }, + "CloudProviderAccessRoleRequestUpdate" : { + "type" : "object", + "description" : "Cloud provider access role.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/CloudProviderAccessAWSIAMRoleRequestUpdate", + "AZURE" : "#/components/schemas/CloudProviderAccessAzureServicePrincipalRequestUpdate", + "GCP" : "#/components/schemas/CloudProviderAccessGCPServiceAccountRequestUpdate" + }, + "propertyName" : "providerName" + }, + "properties" : { + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider of the role.", + "enum" : [ "AWS", "AZURE", "GCP" ] } }, "required" : [ "providerName" ] @@ -27567,6 +28191,13 @@ "items" : { "$ref" : "#/components/schemas/CloudProviderAccessAWSIAMRole" } + }, + "azureServicePrincipals" : { + "type" : "array", + "description" : "List that contains the Azure Service Principals registered with MongoDB Cloud.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + } } } }, @@ -27949,7 +28580,7 @@ "example" : "cluster1", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -28042,6 +28673,7 @@ }, "diskGBEnabled" : { "type" : "boolean", + "default" : false, "description" : "Flag that indicates whether someone enabled disk auto-scaling for this cluster." } }, @@ -28071,10 +28703,12 @@ "properties" : { "enabled" : { "type" : "boolean", + "default" : false, "description" : "Flag that indicates whether cluster tier auto-scaling is enabled. Set to `true` to enable cluster tier auto-scaling. If enabled, you must specify a value for **providerSettings.autoScaling.compute.maxInstanceSize** also. Set to `false` to disable cluster tier auto-scaling." }, "scaleDownEnabled" : { "type" : "boolean", + "default" : false, "description" : "Flag that indicates whether the cluster tier can scale down. This is required if **autoScaling.compute.enabled** is `true`. If you enable this option, specify a value for **providerSettings.autoScaling.compute.minInstanceSize**." } } @@ -28109,14 +28743,14 @@ "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.", + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to Atlas through the interface endpoint that the key names. If the cluster uses an optimized connection string, `awsPrivateLinkSrv` contains the optimized connection string. If the cluster has the non-optimized (legacy) connection string, `awsPrivateLinkSrv` contains the non-optimized connection string even if an optimized connection string is also present.", "externalDocs" : { "description" : "Network Peering Connection", "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" }, "readOnly" : true }, - "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.", + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to Atlas through the interface endpoint that the key names. If the cluster uses an optimized connection string, `awsPrivateLinkSrv` contains the optimized connection string. If the cluster has the non-optimized (legacy) connection string, `awsPrivateLinkSrv` contains the non-optimized connection string even if an optimized connection string is also present.", "externalDocs" : { "description" : "Network Peering Connection", "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" @@ -28196,6 +28830,26 @@ "description" : "Configuration of nodes that comprise the cluster.", "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] }, + "configServerManagementMode" : { + "type" : "string", + "default" : "ATLAS_MANAGED", + "description" : "Config Server Management Mode for creating or updating a sharded cluster.\n\nWhen configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings.\n\nWhen configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server.", + "enum" : [ "ATLAS_MANAGED", "FIXED_TO_DEDICATED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + } + }, + "configServerType" : { + "type" : "string", + "description" : "Describes a sharded cluster's config server type.", + "enum" : [ "DEDICATED", "EMBEDDED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + }, + "readOnly" : true + }, "connectionStrings" : { "$ref" : "#/components/schemas/ClusterConnectionStrings" }, @@ -28224,6 +28878,17 @@ "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" } }, + "featureCompatibilityVersion" : { + "type" : "string", + "description" : "Feature compatibility version of the cluster.", + "readOnly" : true + }, + "featureCompatibilityVersionExpirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Feature compatibility version expiration date.", + "readOnly" : true + }, "globalClusterSelfManagedSharding" : { "type" : "boolean", "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen 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.\n\nWhen 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.\n\nThis setting cannot be changed once the cluster is deployed.", @@ -28270,6 +28935,9 @@ }, "readOnly" : true }, + "mongoDBEmployeeAccessGrant" : { + "$ref" : "#/components/schemas/EmployeeAccessGrantView" + }, "mongoDBMajorVersion" : { "type" : "string", "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", @@ -28289,7 +28957,7 @@ "description" : "Human-readable label that identifies the cluster.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, "paused" : { "type" : "boolean", @@ -28303,6 +28971,24 @@ "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" } }, + "redactClientLogData" : { + "type" : "boolean", + "description" : "Enable or disable log redaction.", + "externalDocs" : { + "description" : "This options corresponds to the ``security.redactClientLogData`` cluster parameter.\n\nThis setting configures the ``mongod`` or ``mongos`` to redact any message accompanying a given log event before logging. This prevents the program from writing potentially sensitive data stored on the database to the diagnostic log. Metadata such as error or operation codes, line numbers, and source file names are still visible in the logs.\n\nUse ``redactClientLogData`` in conjunction with Encryption at Rest and TLS/SSL (Transport Encryption) to assist compliance with regulatory requirements.", + "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.redactClientLogData" + } + }, + "replicaSetScalingStrategy" : { + "type" : "string", + "default" : "WORKLOAD_TYPE", + "description" : "Set this field to configure the replica set scaling mode for your cluster.\n\nBy default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes.\n\nWhen configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads.\n\nWhen configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads.", + "enum" : [ "SEQUENTIAL", "WORKLOAD_TYPE", "NODE_TYPE" ], + "externalDocs" : { + "description" : "Modify the Replica Set Scaling Mode", + "url" : "https://dochub.mongodb.org/core/scale-nodes" + } + }, "replicationSpecs" : { "type" : "array", "description" : "List of settings that configure your cluster regions. This array has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations.", @@ -28412,6 +29098,16 @@ "ClusterDescriptionProcessArgs" : { "type" : "object", "properties" : { + "changeStreamOptionsPreAndPostImagesExpireAfterSeconds" : { + "type" : "integer", + "format" : "int32", + "default" : -1, + "description" : "The minimum pre- and post-image retention time in seconds.", + "externalDocs" : { + "description" : "This option corresponds to the ``changeStreamOptions.preAndPostImages.expireAfterSeconds`` cluster parameter. This setting controls the retention policy of change stream pre- and post-images. Pre- and post-images are the versions of a document before and after document modification, respectively. ``expireAfterSeconds`` controls how long MongoDB retains pre- and post-images. When set to -1 (off), MongoDB uses the default retention policy: pre- and post-images are retained until the corresponding change stream events are removed from the oplog. To set the minimum pre- and post-image retention time, specify an integer value greater than zero. Setting this too low could increase the risk of interrupting Realm sync or triggers processing. The default value is -1 (off).", + "url" : "https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/changeStreamOptions/#mongodb-parameter-param.changeStreamOptions.preAndPostImages.expireAfterSeconds" + } + }, "chunkMigrationConcurrency" : { "type" : "integer", "format" : "int32", @@ -28421,6 +29117,15 @@ "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.chunkMigrationConcurrency" } }, + "defaultMaxTimeMS" : { + "type" : "integer", + "format" : "int32", + "description" : "Default time limit in milliseconds for individual read operations to complete.", + "externalDocs" : { + "description" : "This option corresponds to the defaultMaxTimeMS cluster parameter.", + "url" : "https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/defaultMaxTimeMS/" + } + }, "defaultReadConcern" : { "type" : "string", "default" : "available", @@ -28451,7 +29156,7 @@ }, "javascriptEnabled" : { "type" : "boolean", - "description" : "Flag that indicates whether the cluster allows execution of operations that perform server-side executions of JavaScript.", + "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" @@ -28539,6 +29244,16 @@ "ClusterDescriptionProcessArgs20240805" : { "type" : "object", "properties" : { + "changeStreamOptionsPreAndPostImagesExpireAfterSeconds" : { + "type" : "integer", + "format" : "int32", + "default" : -1, + "description" : "The minimum pre- and post-image retention time in seconds.", + "externalDocs" : { + "description" : "This option corresponds to the ``changeStreamOptions.preAndPostImages.expireAfterSeconds`` cluster parameter. This setting controls the retention policy of change stream pre- and post-images. Pre- and post-images are the versions of a document before and after document modification, respectively. ``expireAfterSeconds`` controls how long MongoDB retains pre- and post-images. When set to -1 (off), MongoDB uses the default retention policy: pre- and post-images are retained until the corresponding change stream events are removed from the oplog. To set the minimum pre- and post-image retention time, specify an integer value greater than zero. Setting this too low could increase the risk of interrupting Realm sync or triggers processing. The default value is -1 (off).", + "url" : "https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/changeStreamOptions/#mongodb-parameter-param.changeStreamOptions.preAndPostImages.expireAfterSeconds" + } + }, "chunkMigrationConcurrency" : { "type" : "integer", "format" : "int32", @@ -28548,6 +29263,15 @@ "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.chunkMigrationConcurrency" } }, + "defaultMaxTimeMS" : { + "type" : "integer", + "format" : "int32", + "description" : "Default time limit in milliseconds for individual read operations to complete.", + "externalDocs" : { + "description" : "This option corresponds to the defaultMaxTimeMS cluster parameter.", + "url" : "https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/defaultMaxTimeMS/" + } + }, "defaultWriteConcern" : { "type" : "string", "description" : "Default level of acknowledgment requested from MongoDB for write operations when none is specified by the driver.", @@ -28558,7 +29282,7 @@ }, "javascriptEnabled" : { "type" : "boolean", - "description" : "Flag that indicates whether the cluster allows execution of operations that perform server-side executions of JavaScript.", + "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" @@ -28825,7 +29549,7 @@ "description" : "Human-readable label that identifies the cluster that undergoes outage simulation.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "groupId" : { @@ -29419,7 +30143,8 @@ "discriminator" : { "mapping" : { "AWS" : "#/components/schemas/AWSCreateDataProcessRegionView", - "AZURE" : "#/components/schemas/AzureCreateDataProcessRegionView" + "AZURE" : "#/components/schemas/AzureCreateDataProcessRegionView", + "GCP" : "#/components/schemas/GCPCreateDataProcessRegionView" }, "propertyName" : "cloudProvider" }, @@ -29916,11 +30641,11 @@ }, "roleId" : { "type" : "string", - "description" : "Unique identifier of the role that Data Federation can use to access the data stores.Required if specifying cloudProviderConfig." + "description" : "Unique identifier of the role that Data Federation can use to access the data stores. Required if specifying cloudProviderConfig." }, "servicePrincipalId" : { "type" : "string", - "description" : "The ID of the Service Principal for which there is an access policyfor Atlas to access Azure resources.", + "description" : "The ID of the Service Principal for which there is an access policy for Atlas to access Azure resources.", "readOnly" : true }, "tenantId" : { @@ -29931,6 +30656,22 @@ }, "required" : [ "roleId" ] }, + "DataFederationGCPCloudProviderConfig" : { + "type" : "object", + "description" : "Configuration for running Data Federation in GCP.", + "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" : { + "type" : "string", + "description" : "Unique identifier of the role that Data Federation can use to access the data stores. Required if specifying cloudProviderConfig." + } + }, + "required" : [ "roleId" ] + }, "DataFederationLimit" : { "type" : "object", "description" : "Details of user managed limits.", @@ -29938,6 +30679,7 @@ "mapping" : { "atlas.project.deployment.clusters" : "#/components/schemas/DefaultLimit", "atlas.project.deployment.nodesPerPrivateLinkRegion" : "#/components/schemas/DefaultLimit", + "atlas.project.deployment.salesSoldM0s" : "#/components/schemas/DefaultLimit", "atlas.project.deployment.serverlessMTMs" : "#/components/schemas/DefaultLimit", "atlas.project.security.databaseAccess.customRoles" : "#/components/schemas/DefaultLimit", "atlas.project.security.databaseAccess.users" : "#/components/schemas/DefaultLimit", @@ -30278,9 +31020,12 @@ }, "azure" : { "$ref" : "#/components/schemas/DataFederationAzureCloudProviderConfig" + }, + "gcp" : { + "$ref" : "#/components/schemas/DataFederationGCPCloudProviderConfig" } }, - "title" : "Data Lake Cloud Provider" + "title" : "Data Federation Cloud Provider" }, "DataLakeDLSAWSStore" : { "type" : "object", @@ -30321,7 +31066,7 @@ "cloudProvider" : { "type" : "string", "description" : "Name of the cloud service that hosts the Federated Database Instance's infrastructure.", - "enum" : [ "AWS", "AZURE" ] + "enum" : [ "AWS", "AZURE", "GCP" ] }, "region" : { "$ref" : "#/components/schemas/BaseAtlasDataLakeRegion" @@ -30743,7 +31488,7 @@ "example" : "cluster1", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -30985,7 +31730,9 @@ "enum" : [ "AVERAGE" ] }, "operator" : { - "$ref" : "#/components/schemas/Operator" + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, "threshold" : { "type" : "number", @@ -31028,7 +31775,8 @@ "discriminator" : { "mapping" : { "AWS" : "#/components/schemas/AWSDataProcessRegionView", - "AZURE" : "#/components/schemas/AzureDataProcessRegionView" + "AZURE" : "#/components/schemas/AzureDataProcessRegionView", + "GCP" : "#/components/schemas/GCPDataProcessRegionView" }, "propertyName" : "cloudProvider" }, @@ -31036,7 +31784,7 @@ "cloudProvider" : { "type" : "string", "description" : "Human-readable label that identifies the Cloud service provider where you store your archived data.", - "enum" : [ "AWS", "AZURE" ], + "enum" : [ "AWS", "AZURE", "GCP" ], "readOnly" : true } }, @@ -31263,7 +32011,7 @@ "action" : { "type" : "string", "description" : "Human-readable label that identifies the privilege action.", - "enum" : [ "FIND", "INSERT", "REMOVE", "UPDATE", "BYPASS_DOCUMENT_VALIDATION", "USE_UUID", "KILL_OP", "CREATE_COLLECTION", "CREATE_INDEX", "DROP_COLLECTION", "ENABLE_PROFILER", "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", "STORAGE_GET_CONFIG", "STORAGE_SET_CONFIG", "FLUSH_ROUTER_CONFIG", "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" ] + "enum" : [ "FIND", "INSERT", "REMOVE", "UPDATE", "BYPASS_DOCUMENT_VALIDATION", "USE_UUID", "KILL_OP", "CREATE_COLLECTION", "CREATE_INDEX", "DROP_COLLECTION", "ENABLE_PROFILER", "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", "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", @@ -31542,7 +32290,7 @@ "title" : "Cps Backup Event Types" }, { "type" : "string", - "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEXES_RESTORE_FAILED" ], + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEXES_RESTORE_FAILED", "FTS_INDEXES_SYNONYM_MAPPING_INVALID" ], "title" : "FTS Index Audit Types" }, { "type" : "string", @@ -31685,7 +32433,7 @@ "title" : "Encryption Event Types" }, { "type" : "string", - "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEXES_RESTORE_FAILED" ], + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEXES_RESTORE_FAILED", "FTS_INDEXES_SYNONYM_MAPPING_INVALID" ], "title" : "FTS Index Audit Types" }, { "type" : "string", @@ -31950,7 +32698,7 @@ "title" : "Tenant Backup Event Types" }, { "type" : "string", - "enum" : [ "CLUSTER_VERSION_FIXED", "CLUSTER_VERSION_UNFIXED", "CLUSTER_FCV_FIXED", "CLUSTER_FCV_UNFIXED", "AGENT_VERSION_FIXED", "AGENT_VERSION_UNFIXED", "FIXED_VERSION_UPDATED", "FIXED_AGENT_VERSION_UPDATED", "CLUSTER_FCV_DOWNGRADED" ], + "enum" : [ "CLUSTER_VERSION_FIXED", "CLUSTER_VERSION_UNFIXED", "CLUSTER_FCV_FIXED", "CLUSTER_FCV_UNFIXED", "CLUSTER_FCV_EXPIRATION_DATE_UPDATED", "AGENT_VERSION_FIXED", "AGENT_VERSION_UNFIXED", "FIXED_VERSION_UPDATED", "FIXED_AGENT_VERSION_UPDATED", "CLUSTER_FCV_DOWNGRADED", "CLUSTER_BINARY_VERSION_DOWNGRADED", "CLUSTER_BINARY_VERSION_UPGRADED" ], "title" : "Version Audit Types" } ] }, @@ -32274,7 +33022,6 @@ }, "hostnameSchemaType" : { "type" : "string", - "default" : "PUBLIC", "description" : "The network type to use between the migration host and the destination cluster.", "enum" : [ "PUBLIC", "PRIVATE_LINK", "VPC_PEERING" ] }, @@ -32398,28 +33145,19 @@ "createdAt" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when someone created this export job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "description" : "Date and time when a user or Atlas created the Export Job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", "readOnly" : true }, "customData" : { "type" : "array", - "description" : "Collection of key-value pairs that represent custom data for the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes.", + "description" : "Collection of key-value pairs that represent custom data for the metadata file that MongoDB Cloud uploads when the Export Job finishes.", "items" : { "$ref" : "#/components/schemas/BackupLabel" } }, - "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\"`.", - "items" : { - "type" : "string", - "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download." - }, - "readOnly" : true - }, "exportBucketId" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket to export to.", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -32432,7 +33170,7 @@ "finishedAt" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when this export job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "description" : "Date and time when this Export Job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", "readOnly" : true }, "id" : { @@ -32458,7 +33196,7 @@ }, "prefix" : { "type" : "string", - "description" : "Full path on the cloud provider bucket to the folder where the snapshot is exported.", + "description" : "Prefix used for all blob storage objects uploaded as part of the Export Job.", "pattern" : "/exported_snapshots/\\{ORG-NAME\\}/\\{PROJECT-NAME\\}/\\{CLUSTER-NAME\\}/\\{SNAPSHOT-INITIATION-DATE\\}/\\{TIMESTAMP\\}", "readOnly" : true }, @@ -32472,7 +33210,7 @@ }, "state" : { "type" : "string", - "description" : "State of the export job.", + "description" : "State of the Export Job.", "enum" : [ "Cancelled", "Failed", "InProgress", "Queued", "Successful" ], "readOnly" : true } @@ -32491,7 +33229,7 @@ }, "exportBucketId" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket to export to.", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -32692,7 +33430,15 @@ "properties" : { "downloadUrl" : { "type" : "string", - "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", + "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.", + "items" : { + "$ref" : "#/components/schemas/ApiPrivateDownloadDeliveryUrl" + }, "readOnly" : true }, "replicaSetName" : { @@ -33120,7 +33866,7 @@ "description" : "One or more Uniform Resource Locators (URLs) that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", "items" : { "type" : "string", - "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download." + "description" : "One Uniform Resource Locator that points to the compressed snapshot files for manual download." }, "readOnly" : true }, @@ -33189,6 +33935,14 @@ "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`.", "minimum" : 1199145600 }, + "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.", + "items" : { + "$ref" : "#/components/schemas/ApiPrivateDownloadDeliveryUrl" + }, + "readOnly" : true + }, "snapshotId" : { "type" : "string", "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", @@ -33202,7 +33956,7 @@ "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.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, "targetGroupId" : { "type" : "string", @@ -33242,7 +33996,7 @@ "description" : "Human-readable label that identifies the cluster with the Snapshot you want to return.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "copySettings" : { @@ -33343,7 +34097,7 @@ "description" : "Human-readable label that identifies the cluster with the Snapshot you want to return.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "copySettings" : { @@ -33438,9 +34192,15 @@ "additionalProperties" : { "type" : "object", "description" : "The stats associated with the stream processor.", + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor" + }, "readOnly" : true }, "description" : "The stats associated with the stream processor.", + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor" + }, "readOnly" : true }, "EARPrivateEndpoint" : { @@ -33483,7 +34243,7 @@ "status" : { "type" : "string", "description" : "State of the Encryption At Rest private endpoint.", - "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "ACTIVE", "FAILED" ], + "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "ACTIVE", "FAILED", "PENDING_RECREATION", "DELETING" ], "readOnly" : true } }, @@ -33523,6 +34283,36 @@ "required" : [ "typeName" ], "title" : "Email Notification" }, + "EmployeeAccessGrantView" : { + "type" : "object", + "description" : "MongoDB employee granted access level and expiration for a cluster.", + "properties" : { + "expirationTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Expiration date for the employee access grant." + }, + "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.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "required" : [ "expirationTime", "grantType" ] + }, "EncryptionAtRest" : { "type" : "object", "properties" : { @@ -33537,27 +34327,6 @@ } } }, - "EncryptionAtRestPrivateEndpointRequest" : { - "type" : "object", - "description" : "Create or delete private endpoints from the specified regions list.", - "properties" : { - "cloudProvider" : { - "type" : "string", - "description" : "Cloud service provider name.", - "enum" : [ "AZURE" ] - }, - "regions" : { - "type" : "array", - "description" : "List of regions.", - "items" : { - "type" : "string" - }, - "uniqueItems" : true - } - }, - "required" : [ "cloudProvider" ], - "title" : "Encryption At Rest Private Endpoints setup." - }, "EncryptionKeyAlertConfigViewForNdsGroup" : { "type" : "object", "description" : "Encryption key alert configuration allows to select thresholds which trigger alerts and how users are notified.", @@ -33783,7 +34552,7 @@ "title" : "Export Bucket Audit Types" }, { "type" : "string", - "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEX_CREATED", "FTS_INDEX_UPDATED", "FTS_INDEX_DELETED", "FTS_INDEX_CLEANED_UP", "FTS_INDEXES_RESTORED", "FTS_INDEXES_RESTORE_FAILED" ], + "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" : "FTS Index Audit Types" }, { "type" : "string", @@ -33803,7 +34572,7 @@ "title" : "Group Integration 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_ENOUGH_DISK_SPACE", "HOST_NOT_ENOUGH_DISK_SPACE" ], + "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_ENOUGH_DISK_SPACE", "HOST_NOT_ENOUGH_DISK_SPACE" ], "title" : "Host Event Types" }, { "type" : "string", @@ -33815,7 +34584,7 @@ "title" : "Index Build 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_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_SSL_ROTATED", "CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER", "CLUSTER_INSTANCE_SSL_REVOKED", "RELOAD_SSL_ON_PROCESSES", "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", "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", "MOVE_SKIPPED", "PROXY_RESTARTED", "PROXY_PANICKED", "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", "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", "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", "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", "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", "PENDING_INDEXES_DELETED", "PENDING_INDEXES_CANCELED", "PROCESS_RESTART_REQUESTED", "AUTO_HEALING_ACTION", "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", "CLUSTER_FORCE_RECONFIG_REQUESTED", "PROJECT_BYPASSED_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", "ATLAS_SQL_SCHEDULED_UPDATE_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_MODIFIED", "ATLAS_SQL_SCHEDULED_UPDATE_REMOVED" ], + "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_SSL_ROTATED", "CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER", "CLUSTER_INSTANCE_SSL_REVOKED", "RELOAD_SSL_ON_PROCESSES", "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", "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", "MOVE_SKIPPED", "PROXY_RESTARTED", "PROXY_PANICKED", "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", "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", "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", "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", "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", "CLUSTER_FORCE_RECONFIG_REQUESTED", "PROJECT_BYPASSED_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" ], "title" : "NDS Audit Types" }, { "type" : "string", @@ -33915,7 +34684,7 @@ "title" : "User Event Types" }, { "type" : "string", - "enum" : [ "CLUSTER_VERSION_FIXED", "CLUSTER_VERSION_UNFIXED", "CLUSTER_FCV_FIXED", "CLUSTER_FCV_UNFIXED", "AGENT_VERSION_FIXED", "AGENT_VERSION_UNFIXED", "FIXED_VERSION_UPDATED", "FIXED_AGENT_VERSION_UPDATED", "CLUSTER_FCV_DOWNGRADED" ], + "enum" : [ "CLUSTER_VERSION_FIXED", "CLUSTER_VERSION_UNFIXED", "CLUSTER_FCV_FIXED", "CLUSTER_FCV_UNFIXED", "CLUSTER_FCV_EXPIRATION_DATE_UPDATED", "AGENT_VERSION_FIXED", "AGENT_VERSION_UNFIXED", "FIXED_VERSION_UPDATED", "FIXED_AGENT_VERSION_UPDATED", "CLUSTER_FCV_DOWNGRADED", "CLUSTER_BINARY_VERSION_DOWNGRADED", "CLUSTER_BINARY_VERSION_UPGRADED" ], "title" : "Version Audit Types" }, { "type" : "string", @@ -33985,6 +34754,10 @@ "type" : "string", "enum" : [ "GROUP_TAGS_MODIFIED" ], "title" : "Resource Event Types" + }, { + "type" : "string", + "enum" : [ "RESOURCE_POLICY_CREATED", "RESOURCE_POLICY_MODIFIED", "RESOURCE_POLICY_DELETED" ], + "title" : "Atlas Resource Policy Audit Types" } ] }, "EventViewForNdsGroup" : { @@ -34063,6 +34836,8 @@ "$ref" : "#/components/schemas/UserEventViewForOrg" }, { "$ref" : "#/components/schemas/ResourceEventViewForOrg" + }, { + "$ref" : "#/components/schemas/AtlasResourcePolicyAuditForOrg" } ] }, "ExampleResourceResponse20230101" : { @@ -34123,7 +34898,7 @@ }, "ExportStatus" : { "type" : "object", - "description" : "State of the export job for the collections on the replica set only.", + "description" : "State of the Export Job.", "properties" : { "exportedCollections" : { "type" : "integer", @@ -34158,7 +34933,7 @@ "FTSIndexAuditTypeView" : { "type" : "string", "description" : "Unique identifier of event type.", - "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEX_CREATED", "FTS_INDEX_UPDATED", "FTS_INDEX_DELETED", "FTS_INDEX_CLEANED_UP", "FTS_INDEXES_RESTORED", "FTS_INDEXES_RESTORE_FAILED" ], + "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" ], "example" : "FTS_INDEX_CREATED", "title" : "FTS Index Audit Types" }, @@ -35064,37 +35839,53 @@ }, "title" : "Field Transformation" }, - "ForNdsGroup" : { + "FieldViolation" : { "type" : "object", - "description" : "ReplicaSet Event identifies different activities about replica set of mongod instances.", "properties" : { - "created" : { + "description" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "description" : "A description of why the request element is bad." }, - "eventTypeName" : { - "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroup" + "field" : { + "type" : "string", + "description" : "A path that leads to a field in the request body." + } + }, + "required" : [ "description", "field" ] + }, + "FlexBackupRestoreJob20250101" : { + "type" : "object", + "description" : "Details for one restore job of a flex cluster.", + "properties" : { + "deliveryType" : { + "type" : "string", + "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", + "enum" : [ "RESTORE", "DOWNLOAD" ], + "readOnly" : true }, - "groupId" : { + "expirationDate" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, + "instanceName" : { + "type" : "string", + "description" : "Human-readable label that identifies the source instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "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.", @@ -35107,485 +35898,317 @@ }, "readOnly" : true }, - "orgId" : { + "projectId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "port" : { - "type" : "integer", - "format" : "int32", - "description" : "IANA port on which the MongoDB process listens for requests.", - "example" : 27017, + "restoreFinishedDate" : { + "type" : "string", + "format" : "date-time", + "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.", "readOnly" : true }, - "raw" : { - "$ref" : "#/components/schemas/raw" - }, - "replicaSetName" : { + "restoreScheduledDate" : { "type" : "string", - "description" : "Human-readable label of the replica set associated with the event.", - "example" : "event-replica-set", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "shardName" : { + "snapshotFinishedDate" : { "type" : "string", - "description" : "Human-readable label of the shard associated with the event.", - "example" : "event-sh-01", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true - } - }, - "required" : [ "created", "eventTypeName", "id" ], - "title" : "ReplicaSet Events" - }, - "GCPCloudProviderContainer" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/CloudProviderContainer" - }, { - "type" : "object", - "properties" : { - "atlasCidrBlock" : { - "type" : "string", - "description" : "IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.\n\nThese CIDR blocks must fall within the ranges reserved per RFC 1918. GCP further limits the block to a lower bound of the `/18` range.\n\nTo modify the CIDR block, the target project cannot have:\n\n- Any M10 or greater clusters\n- Any other VPC peering connections\n\n 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.\n\n **Example:** A project in an Google Cloud (GCP) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets.", - "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" - }, - "gcpProjectId" : { - "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.", - "maxLength" : 26, - "minLength" : 26, - "pattern" : "^p-[0-9a-z]{24}$", - "readOnly" : true - }, - "networkName" : { - "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.", - "maxLength" : 36, - "minLength" : 36, - "pattern" : "^nt-[0-9a-f]{24}-[0-9a-z]{8}$", - "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.", - "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.", - "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" ] - } - } - } - } ], - "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", - "required" : [ "atlasCidrBlock" ], - "title" : "GCP" - }, - "GCPComputeAutoScaling" : { - "type" : "object", - "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", - "properties" : { - "maxInstanceSize" : { + }, + "snapshotId" : { "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" ], - "title" : "GCP Instance Sizes" + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "minInstanceSize" : { + "snapshotUrl" : { "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" ], - "title" : "GCP Instance Sizes" - } - }, - "title" : "GCP" - }, - "GCPConsumerForwardingRule" : { - "type" : "object", - "properties" : { - "endpointName" : { + "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" : "Human-readable label that identifies the Google Cloud consumer forwarding rule that you created.", - "externalDocs" : { - "description" : "Google Cloud Forwarding Rule Concepts", - "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" - }, + "description" : "Phase of the restore workflow for this job at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], "readOnly" : true }, - "ipAddress" : { + "targetDeploymentItemName" : { "type" : "string", - "description" : "One Private Internet Protocol version 4 (IPv4) address to which this Google Cloud consumer forwarding rule resolves.", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "description" : "Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another USS instance or Dedicated cluster tier.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", "readOnly" : true }, - "status" : { + "targetProjectId" : { "type" : "string", - "description" : "State of the MongoDB Cloud endpoint group when MongoDB Cloud received this request.", - "enum" : [ "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true } - } + }, + "title" : "Flex Backup Restore Job" }, - "GCPEndpointService" : { + "FlexBackupRestoreJobCreate20250101" : { "type" : "object", - "description" : "Group of Private Endpoint Service settings.", + "description" : "Details to create one restore job of a flex cluster.", "properties" : { - "cloudProvider" : { + "_snapshotId" : { "type" : "string", - "description" : "Cloud service provider that serves the requested endpoint service.", - "enum" : [ "AWS", "AZURE", "GCP" ], - "readOnly" : true + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true }, - "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" - }, - "items" : { - "type" : "string", - "description" : "One Google Cloud network endpoint group that corresponds to the Private Service Connect endpoint service." - } + "_targetDeploymentItemName" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another flex cluster or dedicated cluster tier.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", + "writeOnly" : true }, - "errorMessage" : { + "_targetProjectId" : { "type" : "string", - "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "deliveryType" : { + "type" : "string", + "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", + "enum" : [ "RESTORE", "DOWNLOAD" ], + "readOnly" : true + }, + "expirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "regionName" : { + "instanceName" : { "type" : "string", - "description" : "Cloud provider region that manages this Private Endpoint Service.", + "description" : "Human-readable label that identifies the source instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, - "serviceAttachmentNames" : { + "links" : { "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.", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", "externalDocs" : { - "description" : "Google Cloud Private Service Connect Service Attachments", - "url" : "https://cloud.google.com/vpc/docs/private-service-connect#service-attachments" + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" }, "items" : { - "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.", - "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\\-]+" - } + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true }, - "status" : { + "projectId" : { "type" : "string", - "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", - "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true - } - }, - "required" : [ "cloudProvider" ], - "title" : "GCP" - }, - "GCPHardwareSpec" : { - "type" : "object", - "properties" : { - "instanceSize" : { + }, + "restoreFinishedDate" : { "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" ], - "title" : "GCP Instance Sizes" + "format" : "date-time", + "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.", + "readOnly" : true }, - "nodeCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." - } - } - }, - "GCPHardwareSpec20240805" : { - "type" : "object", - "properties" : { - "diskSizeGB" : { - "type" : "number", - "format" : "double", - "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", - "maximum" : 4096, - "minimum" : 10 - }, - "instanceSize" : { - "type" : "string", - "description" : "Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as \"base nodes\") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.", - "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], - "title" : "GCP Instance Sizes" - }, - "nodeCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." - } - } - }, - "GCPNetworkPeeringConnectionSettings" : { - "type" : "object", - "description" : "Group of Network Peering connection settings.", - "properties" : { - "containerId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" - }, - "errorMessage" : { + "restoreScheduledDate" : { "type" : "string", - "description" : "Details of the error returned when requesting a GCP network peering resource. The resource returns `null` if the request succeeded.", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "gcpProjectId" : { - "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.", - "maxLength" : 30, - "minLength" : 6, - "pattern" : "^[a-z][0-9a-z-]{4,28}[0-9a-z]{1}" - }, - "id" : { + "snapshotFinishedDate" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "networkName" : { - "type" : "string", - "description" : "Human-readable label that identifies the network to peer with the MongoDB Cloud VPC.", - "maxLength" : 63, - "minLength" : 1, - "pattern" : "[a-z]([-a-z0-9]{0,62}[a-z0-9]{0,1})?" - }, - "providerName" : { + "snapshotUrl" : { "type" : "string", - "description" : "Cloud service provider that serves the requested network peering connection.", - "enum" : [ "AWS", "AZURE", "GCP" ] + "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" : "State of the network peering connection at the time you made the request.", - "enum" : [ "ADDING_PEER", "WAITING_FOR_USER", "AVAILABLE", "FAILED", "DELETING" ], + "description" : "Phase of the restore workflow for this job at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], "readOnly" : true } }, - "required" : [ "containerId", "gcpProjectId", "networkName" ], - "title" : "GCP" - }, - "GCPRegionConfig" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/CloudRegionConfig" - }, { - "type" : "object", - "properties" : { - "analyticsAutoScaling" : { - "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" - }, - "analyticsSpecs" : { - "$ref" : "#/components/schemas/DedicatedHardwareSpec" - }, - "autoScaling" : { - "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" - }, - "readOnlySpecs" : { - "$ref" : "#/components/schemas/DedicatedHardwareSpec" - } - } - } ], - "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", - "title" : "GCP Regional Replication Specifications" + "required" : [ "_snapshotId", "_targetDeploymentItemName" ], + "title" : "Create Flex Backup Restore Job" }, - "GCPRegionConfig20240805" : { + "FlexBackupSettings20250101" : { "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/CloudRegionConfig20240805" - }, { - "type" : "object", - "properties" : { - "analyticsAutoScaling" : { - "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" - }, - "analyticsSpecs" : { - "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" - }, - "autoScaling" : { - "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" - }, - "readOnlySpecs" : { - "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" - } + "description" : "Flex backup configuration", + "properties" : { + "enabled" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether backups are performed for this flex cluster. Backup uses [TODO](TODO) for flex clusters.", + "readOnly" : true } - } ], - "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", - "title" : "GCP Regional Replication Specifications" + }, + "readOnly" : true, + "title" : "Flex Backup Configuration" }, - "GeoSharding" : { + "FlexBackupSnapshot20250101" : { "type" : "object", + "description" : "Details for one snapshot of a flex cluster.", "properties" : { - "customZoneMapping" : { - "type" : "object", - "additionalProperties" : { - "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `id` property.\n\nThis parameter returns an empty object if no custom zones exist.", - "readOnly" : true - }, - "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `id` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "expiration" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "managedNamespaces" : { - "type" : "array", - "description" : "List that contains a namespace for a Global Cluster. MongoDB Cloud manages this cluster.", - "items" : { - "$ref" : "#/components/schemas/ManagedNamespaces" - }, + "finishTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "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 - } - } - }, - "GeoSharding20240805" : { - "type" : "object", - "properties" : { - "customZoneMapping" : { - "type" : "object", - "additionalProperties" : { - "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.\n\nThis parameter returns an empty object if no custom zones exist.", - "readOnly" : true - }, - "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "managedNamespaces" : { + "links" : { "type" : "array", - "description" : "List that contains a namespace for a Global Cluster. MongoDB Cloud manages this cluster.", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, "items" : { - "$ref" : "#/components/schemas/ManagedNamespaces" + "$ref" : "#/components/schemas/Link" }, "readOnly" : true }, - "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.", + "mongoDBVersion" : { + "type" : "string", + "description" : "MongoDB host version that the snapshot runs.", "readOnly" : true - } - } - }, - "GoogleCloudKMS" : { - "type" : "object", - "description" : "Details that define the configuration of Encryption at Rest using Google Cloud Key Management Service (KMS).", - "externalDocs" : { - "description" : "Google Cloud Key Management Service", - "url" : "https://www.mongodb.com/docs/atlas/security-gcp-kms/" - }, - "properties" : { - "enabled" : { - "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" : { + "scheduledTime" : { "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" + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will take the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true }, - "serviceAccountKey" : { + "startTime" : { "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.", - "externalDocs" : { - "description" : "Google Cloud Authentication", - "url" : "https://cloud.google.com/docs/authentication/getting-started" - }, - "writeOnly" : true - }, - "valid" : { - "type" : "boolean", - "description" : "Flag that indicates whether the Google Cloud Key Management Service (KMS) encryption key can encrypt and decrypt data.", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began taking the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true - } - } - }, - "GreaterThanDaysThresholdView" : { - "type" : "object", - "description" : "Threshold value that triggers an alert.", - "properties" : { - "operator" : { - "type" : "string", - "description" : "Comparison operator to apply when checking the current metric value.", - "enum" : [ "GREATER_THAN" ] - }, - "threshold" : { - "type" : "integer", - "format" : "int32", - "description" : "Value of metric that, when exceeded, triggers an alert." }, - "units" : { + "status" : { "type" : "string", - "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", - "enum" : [ "DAYS" ] + "description" : "Phase of the workflow for this snapshot at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true } - } + }, + "title" : "Flex Backup Snapshot" }, - "GreaterThanRawThreshold" : { + "FlexBackupSnapshotDownloadCreate20250101" : { "type" : "object", - "description" : "A Limit that triggers an alert when greater than a number.", + "description" : "Details for one backup snapshot download of a flex cluster.", "properties" : { - "operator" : { + "_snapshotId" : { "type" : "string", - "description" : "Comparison operator to apply when checking the current metric value.", - "enum" : [ "GREATER_THAN" ] - }, - "threshold" : { - "type" : "integer", - "format" : "int32", - "description" : "Value of metric that, when exceeded, triggers an alert." + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to download.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true }, - "units" : { - "$ref" : "#/components/schemas/RawMetricUnits" + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true } }, - "title" : "Greater Than Raw Threshold" + "required" : [ "_snapshotId" ], + "title" : "Flex Backup Snapshot Download Create" }, - "GreaterThanRawThresholdAlertConfigViewForNdsGroup" : { + "FlexClusterDescription20250101" : { "type" : "object", + "description" : "Group of settings that configure a MongoDB Flex cluster.", "properties" : { - "created" : { + "backupSettings" : { + "$ref" : "#/components/schemas/FlexBackupSettings20250101" + }, + "clusterType" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Flex cluster topology.", + "enum" : [ "REPLICASET", "LOADBALANCED" ], "readOnly" : true }, - "enabled" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + "connectionStrings" : { + "$ref" : "#/components/schemas/FlexConnectionStrings20250101" }, - "eventTypeName" : { - "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this instance. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true }, "groupId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "description" : "Unique 24-hexadecimal character string that identifies the project.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -35594,7 +36217,7 @@ }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "description" : "Unique 24-hexadecimal digit string that identifies the instance.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -35613,76 +36236,60 @@ }, "readOnly" : true }, - "matchers" : { - "type" : "array", - "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", - "items" : { - "$ref" : "#/components/schemas/ReplicaSetMatcher" - } + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the instance runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true }, - "notifications" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "readOnly" : true + }, + "providerSettings" : { + "$ref" : "#/components/schemas/FlexProviderSettings20250101" + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of this instance.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { "type" : "array", - "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, "items" : { - "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + "$ref" : "#/components/schemas/ResourceTag" } }, - "threshold" : { - "$ref" : "#/components/schemas/GreaterThanRawThreshold" + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." }, - "updated" : { + "versionReleaseSystem" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions.", + "enum" : [ "LTS" ], "readOnly" : true } }, - "required" : [ "eventTypeName", "notifications" ] - }, - "GreaterThanTimeThreshold" : { - "type" : "object", - "description" : "A Limit that triggers an alert when greater than a time period.", - "properties" : { - "operator" : { - "type" : "string", - "description" : "Comparison operator to apply when checking the current metric value.", - "enum" : [ "GREATER_THAN" ] - }, - "threshold" : { - "type" : "integer", - "format" : "int32", - "description" : "Value of metric that, when exceeded, triggers an alert." - }, - "units" : { - "$ref" : "#/components/schemas/TimeMetricUnits" - } - }, - "title" : "Greater Than Time Threshold" + "required" : [ "providerSettings" ], + "title" : "Flex Cluster Description" }, - "Group" : { + "FlexClusterDescriptionCreate20250101" : { "type" : "object", + "description" : "Settings that you can specify when you create a flex cluster.", "properties" : { - "clusterCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Quantity of MongoDB Cloud clusters deployed in this project.", - "readOnly" : true - }, - "created" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created this project. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true - }, - "id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, "links" : { "type" : "array", "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", @@ -35697,111 +36304,899 @@ }, "name" : { "type" : "string", - "description" : "Human-readable label that identifies the project included in the MongoDB Cloud organization.", + "description" : "Human-readable label that identifies the instance.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" - }, - "orgId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud organization to which the project belongs.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "writeOnly" : true }, - "regionUsageRestrictions" : { - "type" : "string", - "default" : "COMMERCIAL_FEDRAMP_REGIONS_ONLY", - "description" : "Applies to Atlas for Government only.\n\nIn Commercial Atlas, this field will be rejected in requests and missing in responses.\n\nThis field sets restrictions on available regions in the project.\n\n| Value | Available Regions |\n|-----------------------------------|------------|\n| `COMMERCIAL_FEDRAMP_REGIONS_ONLY` | Only allows deployments in FedRAMP Moderate regions.|\n| `GOV_REGIONS_ONLY` | Only allows deployments in GovCloud regions.|", - "enum" : [ "COMMERCIAL_FEDRAMP_REGIONS_ONLY", "GOV_REGIONS_ONLY" ], - "externalDocs" : { - "url" : "https://www.mongodb.com/docs/atlas/government/overview/supported-regions/#supported-cloud-providers-and-regions" - } + "providerSettings" : { + "$ref" : "#/components/schemas/FlexProviderSettingsCreate20250101" }, "tags" : { "type" : "array", - "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the project.", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.", "externalDocs" : { "description" : "Resource Tags", - "url" : "https://www.mongodb.com/docs/atlas/tags" + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" }, "items" : { "$ref" : "#/components/schemas/ResourceTag" } }, - "withDefaultAlertsSettings" : { + "terminationProtectionEnabled" : { "type" : "boolean", - "description" : "Flag that indicates whether to create the project with default alert settings.", - "writeOnly" : true + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." } }, - "required" : [ "clusterCount", "created", "name", "orgId" ] - }, - "GroupAlertsConfig" : { - "type" : "object", - "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/StreamProcessorAlertConfigViewForNdsGroup" - } ] + "required" : [ "name", "providerSettings" ], + "title" : "Flex Cluster Description Create" }, - "GroupIPAddresses" : { + "FlexConnectionStrings20250101" : { "type" : "object", - "description" : "List of IP addresses in a project.", + "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, "properties" : { - "groupId" : { + "standard" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "description" : "Public connection string that you can use to connect to this cluster. This connection string uses the mongodb:// protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, "readOnly" : true }, - "services" : { - "$ref" : "#/components/schemas/GroupService" + "standardSrv" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this flex cluster. This connection string uses the `mongodb+srv://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true } }, - "title" : "Group IP Address" + "readOnly" : true, + "title" : "Flex Cluster Connection Strings" }, - "GroupInvitation" : { + "FlexProviderSettings20250101" : { "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB flex cluster.", "properties" : { - "createdAt" : { + "backingProviderName" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud sent the invitation. This parameter expresses its value in ISO 8601 format in UTC.", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the flex cluster.", + "enum" : [ "AWS", "AZURE", "GCP" ], "readOnly" : true }, - "expiresAt" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud expires the invitation. This parameter expresses its value in ISO 8601 format in UTC.", + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity available to the flex cluster expressed in gigabytes.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "default" : "FLEX", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "FLEX" ], + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB flex cluster. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Cloud Service Provider Settings for a Flex Cluster" + }, + "FlexProviderSettingsCreate20250101" : { + "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB flex cluster.", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the flex cluster.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "writeOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity available to the flex cluster expressed in gigabytes.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "default" : "FLEX", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "FLEX" ], + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB flex cluster. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).", + "writeOnly" : true + } + }, + "required" : [ "backingProviderName", "regionName" ], + "title" : "Cloud Service Provider Settings for a Flex Cluster", + "writeOnly" : true + }, + "ForNdsGroup" : { + "type" : "object", + "description" : "ReplicaSet Event identifies different activities about replica set of mongod instances.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "ReplicaSet Events" + }, + "GCPCloudProviderContainer" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, { + "type" : "object", + "properties" : { + "atlasCidrBlock" : { + "type" : "string", + "description" : "IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.\n\nThese CIDR blocks must fall within the ranges reserved per RFC 1918. GCP further limits the block to a lower bound of the `/18` range.\n\nTo modify the CIDR block, the target project cannot have:\n\n- Any M10 or greater clusters\n- Any other VPC peering connections\n\n 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.\n\n **Example:** A project in an Google Cloud (GCP) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets.", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + }, + "gcpProjectId" : { + "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.", + "maxLength" : 26, + "minLength" : 26, + "pattern" : "^p-[0-9a-z]{24}$", + "readOnly" : true + }, + "networkName" : { + "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.", + "maxLength" : 36, + "minLength" : 36, + "pattern" : "^nt-[0-9a-f]{24}-[0-9a-z]{8}$", + "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.", + "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.", + "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" ] + } + } + } + } ], + "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", + "required" : [ "atlasCidrBlock" ], + "title" : "GCP" + }, + "GCPComputeAutoScaling" : { + "type" : "object", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", + "properties" : { + "maxInstanceSize" : { + "type" : "string", + "description" : "Maximum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "minInstanceSize" : { + "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" ], + "title" : "GCP Instance Sizes" + } + }, + "title" : "GCP" + }, + "GCPConsumerForwardingRule" : { + "type" : "object", + "properties" : { + "endpointName" : { + "type" : "string", + "description" : "Human-readable label that identifies the Google Cloud consumer forwarding rule that you created.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "One Private Internet Protocol version 4 (IPv4) address to which this Google Cloud consumer forwarding rule resolves.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the MongoDB Cloud endpoint group when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + } + }, + "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" ] + } + } + } ] + }, + "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.", + "enum" : [ "CENTRAL_US", "WESTERN_EUROPE" ], + "readOnly" : true + } + } + } ] + }, + "GCPEndpointService" : { + "type" : "object", + "description" : "Group of Private Endpoint Service settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "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" + }, + "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" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "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" + }, + "items" : { + "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.", + "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\\-]+" + } + }, + "status" : { + "type" : "string", + "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "GCP" + }, + "GCPHardwareSpec" : { + "type" : "object", + "properties" : { + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts 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" ], + "title" : "GCP Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "GCPHardwareSpec20240805" : { + "type" : "object", + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as \"base nodes\") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "GCPNetworkPeeringConnectionSettings" : { + "type" : "object", + "description" : "Group of Network Peering connection settings.", + "properties" : { + "containerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "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" : { + "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.", + "maxLength" : 30, + "minLength" : 6, + "pattern" : "^[a-z][0-9a-z-]{4,28}[0-9a-z]{1}" + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "networkName" : { + "type" : "string", + "description" : "Human-readable label that identifies the network to peer with the MongoDB Cloud VPC.", + "maxLength" : 63, + "minLength" : 1, + "pattern" : "[a-z]([-a-z0-9]{0,62}[a-z0-9]{0,1})?" + }, + "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.", + "enum" : [ "ADDING_PEER", "WAITING_FOR_USER", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "containerId", "gcpProjectId", "networkName" ], + "title" : "GCP" + }, + "GCPRegionConfig" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "GCP Regional Replication Specifications" + }, + "GCPRegionConfig20240805" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20240805" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "GCP Regional Replication Specifications" + }, + "GeoSharding" : { + "type" : "object", + "properties" : { + "customZoneMapping" : { + "type" : "object", + "additionalProperties" : { + "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `id` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `id` property.\n\nThis 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.", + "items" : { + "$ref" : "#/components/schemas/ManagedNamespaces" + }, + "readOnly" : true + }, + "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 + } + } + }, + "GeoSharding20240805" : { + "type" : "object", + "properties" : { + "customZoneMapping" : { + "type" : "object", + "additionalProperties" : { + "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.\n\nThis 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.", + "items" : { + "$ref" : "#/components/schemas/ManagedNamespaces" + }, + "readOnly" : true + }, + "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 + } + } + }, + "GoogleCloudKMS" : { + "type" : "object", + "description" : "Details that define the configuration of Encryption at Rest using Google Cloud Key Management Service (KMS).", + "externalDocs" : { + "description" : "Google Cloud Key Management Service", + "url" : "https://www.mongodb.com/docs/atlas/security-gcp-kms/" + }, + "properties" : { + "enabled" : { + "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" + }, + "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.", + "externalDocs" : { + "description" : "Google Cloud Authentication", + "url" : "https://cloud.google.com/docs/authentication/getting-started" + }, + "writeOnly" : true + }, + "valid" : { + "type" : "boolean", + "description" : "Flag that indicates whether the Google Cloud Key Management Service (KMS) encryption key can encrypt and decrypt data.", + "readOnly" : true + } + } + }, + "GreaterThanDaysThresholdView" : { + "type" : "object", + "description" : "Threshold value that triggers an alert.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "GREATER_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "DAYS" ] + } + } + }, + "GreaterThanRawThreshold" : { + "type" : "object", + "description" : "A Limit that triggers an alert when greater than a number.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "GREATER_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/RawMetricUnits" + } + }, + "title" : "Greater Than Raw Threshold" + }, + "GreaterThanRawThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ReplicaSetMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/GreaterThanRawThreshold" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ] + }, + "GreaterThanTimeThreshold" : { + "type" : "object", + "description" : "A Limit that triggers an alert when greater than a time period.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "GREATER_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "title" : "Greater Than Time Threshold" + }, + "Group" : { + "type" : "object", + "properties" : { + "clusterCount" : { + "type" : "integer", + "format" : "int64", + "description" : "Quantity of MongoDB Cloud clusters deployed in this project.", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this project. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the project included in the MongoDB Cloud organization.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud organization to which the project belongs.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "regionUsageRestrictions" : { + "type" : "string", + "default" : "COMMERCIAL_FEDRAMP_REGIONS_ONLY", + "description" : "Applies to Atlas for Government only.\n\nIn Commercial Atlas, this field will be rejected in requests and missing in responses.\n\nThis field sets restrictions on available regions in the project.\n\n| Value | Available Regions |\n|-----------------------------------|------------|\n| `COMMERCIAL_FEDRAMP_REGIONS_ONLY` | Only allows deployments in FedRAMP Moderate regions.|\n| `GOV_REGIONS_ONLY` | Only allows deployments in GovCloud regions.|", + "enum" : [ "COMMERCIAL_FEDRAMP_REGIONS_ONLY", "GOV_REGIONS_ONLY" ], + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/government/overview/supported-regions/#supported-cloud-providers-and-regions" + } + }, + "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" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "withDefaultAlertsSettings" : { + "type" : "boolean", + "description" : "Flag that indicates whether to create the project with default alert settings.", + "writeOnly" : true + } + }, + "required" : [ "clusterCount", "created", "name", "orgId" ] + }, + "GroupAlertsConfig" : { + "type" : "object", + "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/StreamProcessorAlertConfigViewForNdsGroup" + } ] + }, + "GroupIPAddresses" : { + "type" : "object", + "description" : "List of IP addresses in a project.", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "services" : { + "$ref" : "#/components/schemas/GroupService" + } + }, + "title" : "Group IP Address" + }, + "GroupInvitation" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud sent the invitation. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud expires the invitation. This parameter expresses its value in ISO 8601 format in UTC.", "readOnly" : true }, "groupId" : { @@ -35941,22 +37336,27 @@ "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "pattern" : "^([a-f0-9]{24})$" }, "destinationOrgPrivateApiKey" : { "type" : "string", - "description" : "Unique string that identifies the private part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.", + "description" : "Unique string that identifies the private part of the API Key used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.", "example" : "55c3bbb6-b4bb-0be1-e66d20841f3e", - "readOnly" : true + "externalDocs" : { + "description" : "Grant Programmatic Access to Atlas", + "url" : "https://dochub.mongodb.org/core/atlas-create-prog-api-key" + } }, "destinationOrgPublicApiKey" : { "type" : "string", - "description" : "Unique string that identifies the public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.", + "description" : "Unique string that identifies the public part of the API Key used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.", "example" : "zmmrboas", + "externalDocs" : { + "description" : "Grant Programmatic Access to Atlas", + "url" : "https://dochub.mongodb.org/core/atlas-create-prog-api-key" + }, "maxLength" : 8, - "minLength" : 8, - "readOnly" : true + "minLength" : 8 } } }, @@ -36023,7 +37423,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/EventViewForNdsGroup" }, @@ -36056,6 +37456,28 @@ } } }, + "GroupRoleAssignment" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to which these roles belong.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "groupRoles" : { + "type" : "array", + "description" : "One or more project level roles assigned to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_OWNER", "GROUP_CLUSTER_MANAGER", "GROUP_STREAM_PROCESSING_OWNER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR" ] + }, + "uniqueItems" : true + } + } + }, "GroupService" : { "type" : "object", "description" : "List of IP addresses in a project categorized by services.", @@ -36075,37 +37497,37 @@ "GroupServiceAccount" : { "type" : "object", "properties" : { + "clientId" : { + "type" : "string", + "description" : "The Client ID of the Service Account.", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + }, "createdAt" : { "type" : "string", "format" : "date-time", - "description" : "Service account creation time." + "description" : "The date that the Service Account was created on." }, "description" : { "type" : "string", - "description" : "Description of the service account." - }, - "id" : { - "type" : "string", - "description" : "ID for the service account.", - "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + "description" : "Human readable description for the Service Account." }, "name" : { "type" : "string", - "description" : "Name for service account." + "description" : "Human-readable name for the Service Account." }, "roles" : { "type" : "array", - "description" : "Roles assigned to the Service Account group.", + "description" : "A list of Project roles associated with the Service Account.", "items" : { "type" : "string", - "description" : "Project roles associated with the service account.", + "description" : "Project roles available for Service Accounts.", "enum" : [ "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" ] }, "uniqueItems" : true }, "secrets" : { "type" : "array", - "description" : "List of secrets.", + "description" : "A list of secrets associated with the specified Service Account.", "items" : { "$ref" : "#/components/schemas/ServiceAccountSecret" }, @@ -36118,73 +37540,74 @@ "properties" : { "description" : { "type" : "string", - "description" : "Human readable description for the service account.", + "description" : "Human readable description for the Service Account.", "maxLength" : 250, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "name" : { "type" : "string", - "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "description" : "Human-readable name for the Service Account. The name is modifiable and does not have to be unique.", "maxLength" : 64, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "roles" : { "type" : "array", - "description" : "Project roles associated with the service account.", + "description" : "A list of project-level roles for the Service Account.", "items" : { "type" : "string", - "description" : "Project roles associated with the service account.", + "description" : "Project roles available for Service Accounts.", "enum" : [ "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" ] } }, "secretExpiresAfterHours" : { "type" : "integer", "format" : "int32", - "description" : "Secret expiration time." + "description" : "The expiration time of the new Service Account secret. The expiration is provided in hours." } }, - "required" : [ "description", "name", "secretExpiresAfterHours" ] + "required" : [ "description", "name", "roles", "secretExpiresAfterHours" ] }, "GroupServiceAccountRoleAssignment" : { "type" : "object", "properties" : { "roles" : { "type" : "array", - "description" : "Group access roles.", + "description" : "The Project permissions for the Service Account in the specified Project.", "items" : { "type" : "string", - "description" : "Project roles associated with the service account.", + "description" : "Project roles available for Service Accounts.", "enum" : [ "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" ] }, "uniqueItems" : true } - } + }, + "required" : [ "roles" ] }, "GroupServiceAccountUpdateRequest" : { "type" : "object", "properties" : { "description" : { "type" : "string", - "description" : "Human readable description for the service account.", + "description" : "Human readable description for the Service Account.", "maxLength" : 250, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "name" : { "type" : "string", - "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "description" : "Human-readable name for the Service Account. The name is modifiable and does not have to be unique.", "maxLength" : 64, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "roles" : { "type" : "array", - "description" : "Project roles associated with the service account.", + "description" : "A list of Project roles associated with the Service Account.", "items" : { "type" : "string", - "description" : "Project roles associated with the service account.", + "description" : "Project roles available for Service Accounts.", "enum" : [ "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" ] } } @@ -36428,7 +37851,7 @@ "example" : "cluster1", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -36523,14 +37946,14 @@ "HostEventTypeViewForNdsGroup" : { "type" : "string", "description" : "Unique identifier of event type.", - "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_ENOUGH_DISK_SPACE", "HOST_NOT_ENOUGH_DISK_SPACE" ], + "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_ENOUGH_DISK_SPACE", "HOST_NOT_ENOUGH_DISK_SPACE" ], "example" : "HOST_DOWN", "title" : "Host Event Types" }, "HostEventTypeViewForNdsGroupAlertable" : { "type" : "string", "description" : "Event type that triggers an alert.", - "enum" : [ "HOST_DOWN", "HOST_HAS_INDEX_SUGGESTIONS", "HOST_MONGOT_CRASHING_OOM", "HOST_NOT_ENOUGH_DISK_SPACE" ], + "enum" : [ "HOST_DOWN", "HOST_HAS_INDEX_SUGGESTIONS", "HOST_MONGOT_CRASHING_OOM", "HOST_MONGOT_STOP_REPLICATION", "HOST_NOT_ENOUGH_DISK_SPACE" ], "example" : "HOST_DOWN", "title" : "Host Event Types" }, @@ -36816,6 +38239,7 @@ "OPCOUNTER_REPL_INSERT" : "#/components/schemas/RawMetricAlertView", "OPCOUNTER_REPL_UPDATE" : "#/components/schemas/RawMetricAlertView", "OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricAlertView", + "OPERATIONS_QUERIES_KILLED" : "#/components/schemas/RawMetricAlertView", "OPERATIONS_SCAN_AND_ORDER" : "#/components/schemas/RawMetricAlertView", "OPERATION_THROTTLING_REJECTED_OPERATIONS" : "#/components/schemas/RawMetricAlertView", "OPLOG_MASTER_LAG_TIME_DIFF" : "#/components/schemas/TimeMetricAlertView", @@ -36885,7 +38309,7 @@ "example" : "cluster1", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -37194,6 +38618,7 @@ "OPCOUNTER_REPL_INSERT" : "#/components/schemas/RawMetricEventView", "OPCOUNTER_REPL_UPDATE" : "#/components/schemas/RawMetricEventView", "OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricEventView", + "OPERATIONS_QUERIES_KILLED" : "#/components/schemas/RawMetricEventView", "OPERATIONS_SCAN_AND_ORDER" : "#/components/schemas/RawMetricEventView", "OPERATION_THROTTLING_REJECTED_OPERATIONS" : "#/components/schemas/RawMetricEventView", "OPLOG_MASTER_LAG_TIME_DIFF" : "#/components/schemas/TimeMetricEventView", @@ -37499,6 +38924,7 @@ "OPCOUNTER_REPL_INSERT" : "#/components/schemas/RawMetricThresholdView", "OPCOUNTER_REPL_UPDATE" : "#/components/schemas/RawMetricThresholdView", "OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "OPERATIONS_QUERIES_KILLED" : "#/components/schemas/RawMetricThresholdView", "OPERATIONS_SCAN_AND_ORDER" : "#/components/schemas/RawMetricThresholdView", "OPERATION_THROTTLING_REJECTED_OPERATIONS" : "#/components/schemas/RawMetricThresholdView", "OPLOG_MASTER_LAG_TIME_DIFF" : "#/components/schemas/TimeMetricThresholdView", @@ -37545,7 +38971,9 @@ "enum" : [ "AVERAGE" ] }, "operator" : { - "$ref" : "#/components/schemas/Operator" + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, "threshold" : { "type" : "number", @@ -37897,7 +39325,7 @@ "description" : "Human-readable label that identifies the cluster that incurred the charge.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -37951,7 +39379,7 @@ "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.", - "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_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", "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_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_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" ], + "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_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", "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_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_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_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" ], "readOnly" : true }, "startDate" : { @@ -38241,6 +39669,323 @@ "description" : "Configuration of nodes that comprise the cluster.", "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] }, + "configServerManagementMode" : { + "type" : "string", + "default" : "ATLAS_MANAGED", + "description" : "Config Server Management Mode for creating or updating a sharded cluster.\n\nWhen configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings.\n\nWhen configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server.", + "enum" : [ "ATLAS_MANAGED", "FIXED_TO_DEDICATED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + } + }, + "configServerType" : { + "type" : "string", + "description" : "Describes a sharded cluster's config server type.", + "enum" : [ "DEDICATED", "EMBEDDED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + }, + "readOnly" : true + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/ClusterConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "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.", + "maximum" : 4096, + "minimum" : 10 + }, + "diskWarmingMode" : { + "type" : "string", + "default" : "FULLY_WARMED", + "description" : "Disk warming mode selection.", + "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], + "externalDocs" : { + "description" : "Reduce Secondary Disk Warming Impact", + "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" + } + }, + "encryptionAtRestProvider" : { + "type" : "string", + "description" : "Cloud service provider that manages your customer keys to provide an additional layer of Encryption at Rest for the cluster.", + "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "featureCompatibilityVersion" : { + "type" : "string", + "description" : "Feature compatibility version of the cluster.", + "readOnly" : true + }, + "featureCompatibilityVersionExpirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Feature compatibility version expiration date.", + "readOnly" : true + }, + "globalClusterSelfManagedSharding" : { + "type" : "boolean", + "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen 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.\n\nWhen 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.\n\nThis 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" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "labels" : { + "type" : "array", + "deprecated" : true, + "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBEmployeeAccessGrant" : { + "$ref" : "#/components/schemas/EmployeeAccessGrantView" + }, + "mongoDBMajorVersion" : { + "type" : "string", + "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", + "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-" + } + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the cluster runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)" + }, + "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.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "mongoURIUpdated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated the connection string. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "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.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + }, + "numShards" : { + "type" : "integer", + "format" : "int32", + "default" : 1, + "description" : "Number of shards up to 50 to deploy for a sharded cluster. The resource returns `1` to indicate a replica set and values of `2` and higher to indicate a sharded cluster. The returned value equals the number of shards in the cluster.", + "externalDocs" : { + "description" : "Sharding", + "url" : "https://docs.mongodb.com/manual/sharding/" + }, + "maximum" : 50, + "minimum" : 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", + "default" : "WORKLOAD_TYPE", + "description" : "Set this field to configure the replica set scaling mode for your cluster.\n\nBy default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes.\n\nWhen configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads.\n\nWhen configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads.", + "enum" : [ "SEQUENTIAL", "WORKLOAD_TYPE", "NODE_TYPE" ], + "externalDocs" : { + "description" : "Modify the Replica Set Scaling Mode", + "url" : "https://dochub.mongodb.org/core/scale-nodes" + } + }, + "replicationFactor" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "deprecated" : true, + "description" : "Number of members that belong to the replica set. Each member retains a copy of your databases, providing high availability and data redundancy. Use **replicationSpecs** instead.", + "enum" : [ 3, 5, 7 ] + }, + "replicationSpec" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RegionSpec" + }, + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "title" : "Region Configuration" + }, + "replicationSpecs" : { + "type" : "array", + "description" : "List of settings that configure your cluster regions.\n\n- For Global Clusters, each object in the array represents one zone where MongoDB Cloud deploys your clusters nodes.\n- For non-Global sharded clusters and replica sets, the single object represents where MongoDB Cloud deploys your clusters nodes.", + "items" : { + "$ref" : "#/components/schemas/LegacyReplicationSpec" + } + }, + "rootCertType" : { + "type" : "string", + "default" : "ISRGROOTX1", + "description" : "Root Certificate Authority that MongoDB Atlas clusters uses. MongoDB Cloud supports Internet Security Research Group.", + "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.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the cluster.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", + "enum" : [ "LTS", "CONTINUOUS" ] + } + }, + "title" : "Cluster Description" + }, + "LegacyAtlasTenantClusterUpgradeRequest" : { + "type" : "object", + "description" : "Request containing target state of tenant cluster to be upgraded", + "properties" : { + "acceptDataRisksAndForceReplicaSetReconfig" : { + "type" : "string", + "format" : "date-time", + "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", + "externalDocs" : { + "description" : "Reconfiguring a Replica Set during a regional outage", + "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + } + }, + "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", + "default" : "ATLAS_MANAGED", + "description" : "Config Server Management Mode for creating or updating a sharded cluster.\n\nWhen configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings.\n\nWhen configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server.", + "enum" : [ "ATLAS_MANAGED", "FIXED_TO_DEDICATED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + } + }, + "configServerType" : { + "type" : "string", + "description" : "Describes a sharded cluster's config server type.", + "enum" : [ "DEDICATED", "EMBEDDED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + }, + "readOnly" : true + }, "connectionStrings" : { "$ref" : "#/components/schemas/ClusterConnectionStrings" }, @@ -38276,6 +40021,17 @@ "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" } }, + "featureCompatibilityVersion" : { + "type" : "string", + "description" : "Feature compatibility version of the cluster.", + "readOnly" : true + }, + "featureCompatibilityVersionExpirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Feature compatibility version expiration date.", + "readOnly" : true + }, "globalClusterSelfManagedSharding" : { "type" : "boolean", "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen 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.\n\nWhen 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.\n\nThis setting cannot be changed once the cluster is deployed.", @@ -38322,6 +40078,9 @@ }, "readOnly" : true }, + "mongoDBEmployeeAccessGrant" : { + "$ref" : "#/components/schemas/EmployeeAccessGrantView" + }, "mongoDBMajorVersion" : { "type" : "string", "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", @@ -38364,7 +40123,7 @@ "description" : "Human-readable label that identifies the cluster.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, "numShards" : { "type" : "integer", @@ -38397,259 +40156,16 @@ "providerSettings" : { "$ref" : "#/components/schemas/ClusterProviderSettings" }, - "replicationFactor" : { - "type" : "integer", - "format" : "int32", - "default" : 3, - "deprecated" : true, - "description" : "Number of members that belong to the replica set. Each member retains a copy of your databases, providing high availability and data redundancy. Use **replicationSpecs** instead.", - "enum" : [ 3, 5, 7 ] - }, - "replicationSpec" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/RegionSpec" - }, - "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", - "title" : "Region Configuration" - }, - "replicationSpecs" : { - "type" : "array", - "description" : "List of settings that configure your cluster regions.\n\n- For Global Clusters, each object in the array represents one zone where MongoDB Cloud deploys your clusters nodes.\n- For non-Global sharded clusters and replica sets, the single object represents where MongoDB Cloud deploys your clusters nodes.", - "items" : { - "$ref" : "#/components/schemas/LegacyReplicationSpec" - } - }, - "rootCertType" : { - "type" : "string", - "default" : "ISRGROOTX1", - "description" : "Root Certificate Authority that MongoDB Atlas clusters uses. MongoDB Cloud supports Internet Security Research Group.", - "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.", - "externalDocs" : { - "description" : "Connection string URI format.", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, - "readOnly" : true - }, - "stateName" : { + "replicaSetScalingStrategy" : { "type" : "string", - "description" : "Human-readable label that indicates the current operating condition of the cluster.", - "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], - "readOnly" : true - }, - "tags" : { - "type" : "array", - "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "default" : "WORKLOAD_TYPE", + "description" : "Set this field to configure the replica set scaling mode for your cluster.\n\nBy default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes.\n\nWhen configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads.\n\nWhen configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads.", + "enum" : [ "SEQUENTIAL", "WORKLOAD_TYPE", "NODE_TYPE" ], "externalDocs" : { - "description" : "Resource Tags", - "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" - }, - "items" : { - "$ref" : "#/components/schemas/ResourceTag" - } - }, - "terminationProtectionEnabled" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." - }, - "versionReleaseSystem" : { - "type" : "string", - "default" : "LTS", - "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", - "enum" : [ "LTS", "CONTINUOUS" ] - } - }, - "title" : "Cluster Description" - }, - "LegacyAtlasTenantClusterUpgradeRequest" : { - "type" : "object", - "description" : "Request containing target state of tenant cluster to be upgraded", - "properties" : { - "acceptDataRisksAndForceReplicaSetReconfig" : { - "type" : "string", - "format" : "date-time", - "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", - "externalDocs" : { - "description" : "Reconfiguring a Replica Set during a regional outage", - "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + "description" : "Modify the Replica Set Scaling Mode", + "url" : "https://dochub.mongodb.org/core/scale-nodes" } }, - "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" ] - }, - "connectionStrings" : { - "$ref" : "#/components/schemas/ClusterConnectionStrings" - }, - "createDate" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", - "readOnly" : true - }, - "diskSizeGB" : { - "type" : "number", - "format" : "double", - "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.", - "maximum" : 4096, - "minimum" : 10 - }, - "diskWarmingMode" : { - "type" : "string", - "default" : "FULLY_WARMED", - "description" : "Disk warming mode selection.", - "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], - "externalDocs" : { - "description" : "Reduce Secondary Disk Warming Impact", - "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" - } - }, - "encryptionAtRestProvider" : { - "type" : "string", - "description" : "Cloud service provider that manages your customer keys to provide an additional layer of Encryption at Rest for the cluster.", - "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], - "externalDocs" : { - "description" : "Encryption at Rest using Customer Key Management", - "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" - } - }, - "globalClusterSelfManagedSharding" : { - "type" : "boolean", - "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen 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.\n\nWhen 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.\n\nThis 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" : { - "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the project.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "labels" : { - "type" : "array", - "deprecated" : true, - "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", - "items" : { - "$ref" : "#/components/schemas/ComponentLabel" - } - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - }, - "mongoDBMajorVersion" : { - "type" : "string", - "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", - "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-" - } - }, - "mongoDBVersion" : { - "type" : "string", - "description" : "Version of MongoDB that the cluster runs.", - "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)" - }, - "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.", - "externalDocs" : { - "description" : "Connection string URI format.", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, - "readOnly" : true - }, - "mongoURIUpdated" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when someone last updated the connection string. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", - "readOnly" : true - }, - "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.", - "externalDocs" : { - "description" : "Connection string URI format.", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "Human-readable label that identifies the cluster.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - }, - "numShards" : { - "type" : "integer", - "format" : "int32", - "default" : 1, - "description" : "Number of shards up to 50 to deploy for a sharded cluster. The resource returns `1` to indicate a replica set and values of `2` and higher to indicate a sharded cluster. The returned value equals the number of shards in the cluster.", - "externalDocs" : { - "description" : "Sharding", - "url" : "https://docs.mongodb.com/manual/sharding/" - }, - "maximum" : 50, - "minimum" : 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" - }, "replicationFactor" : { "type" : "integer", "format" : "int32", @@ -39196,6 +40712,10 @@ "type" : "string", "enum" : [ "INSTANCE_NAME", "PROCESSOR_NAME" ], "title" : "Streams Matcher Fields" + }, { + "type" : "string", + "enum" : [ "RULE_ID" ], + "title" : "Log Ingestion Matcher Fields" } ] }, "MatcherHostType" : { @@ -39846,7 +41366,7 @@ "NDSAuditTypeViewForNdsGroup" : { "type" : "string", "description" : "Unique identifier of event type.", - "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_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_SSL_ROTATED", "CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER", "CLUSTER_INSTANCE_SSL_REVOKED", "RELOAD_SSL_ON_PROCESSES", "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", "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", "MOVE_SKIPPED", "PROXY_RESTARTED", "PROXY_PANICKED", "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", "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", "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", "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", "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", "PENDING_INDEXES_DELETED", "PENDING_INDEXES_CANCELED", "PROCESS_RESTART_REQUESTED", "AUTO_HEALING_ACTION", "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", "CLUSTER_FORCE_RECONFIG_REQUESTED", "PROJECT_BYPASSED_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", "ATLAS_SQL_SCHEDULED_UPDATE_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_MODIFIED", "ATLAS_SQL_SCHEDULED_UPDATE_REMOVED" ], + "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_SSL_ROTATED", "CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER", "CLUSTER_INSTANCE_SSL_REVOKED", "RELOAD_SSL_ON_PROCESSES", "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", "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", "MOVE_SKIPPED", "PROXY_RESTARTED", "PROXY_PANICKED", "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", "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", "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", "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", "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", "CLUSTER_FORCE_RECONFIG_REQUESTED", "PROJECT_BYPASSED_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" ], "example" : "CLUSTER_CREATED", "title" : "NDS Audit Types" }, @@ -40743,7 +42263,7 @@ "example" : "cluster1", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -40985,7 +42505,9 @@ "enum" : [ "AVERAGE" ] }, "operator" : { - "$ref" : "#/components/schemas/Operator" + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, "threshold" : { "type" : "number", @@ -41169,6 +42691,54 @@ "required" : [ "typeName" ], "title" : "OpsGenie Notification" }, + "OrgActiveUserResponse" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OrgUserResponse" + }, { + "type" : "object", + "properties" : { + "country" : { + "type" : "string", + "description" : "Two alphabet characters that identifies MongoDB Cloud user's geographic location. This parameter uses the ISO 3166-1a2 code format.", + "example" : "US", + "pattern" : "^([A-Z]{2})$", + "readOnly" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the current account. This value is in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "firstName" : { + "type" : "string", + "description" : "First or given name that belongs to the MongoDB Cloud user.", + "example" : "John", + "readOnly" : true + }, + "lastAuth" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the current account last authenticated. This value is in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "lastName" : { + "type" : "string", + "description" : "Last name, family name, or surname that belongs to the MongoDB Cloud user.", + "example" : "Doe", + "readOnly" : true + }, + "mobileNumber" : { + "type" : "string", + "description" : "Mobile phone number that belongs to the MongoDB Cloud user.", + "pattern" : "(?:(?:\\\\+?1\\\\s*(?:[.-]\\\\s*)?)?(?:(\\\\s*([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9])\\\\s*)|([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9]))\\\\s*(?:[.-]\\\\s*)?)([2-9]1[02-9]|[2-9][02-9]1|[2-9][02-9]{2})\\\\s*(?:[.-]\\\\s*)?([0-9]{4})$", + "readOnly" : true + } + } + } ], + "required" : [ "createdAt", "firstName", "id", "lastName", "orgMembershipStatus", "roles", "username" ] + }, "OrgEventTypeViewForOrg" : { "type" : "string", "description" : "Unique identifier of event type.", @@ -41450,7 +43020,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/EventViewForOrg" }, @@ -41465,40 +43035,69 @@ } } }, + "OrgPendingUserResponse" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OrgUserResponse" + }, { + "type" : "object", + "properties" : { + "invitationCreatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud sent the invitation. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "invitationExpiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the invitation from MongoDB Cloud expires. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "inviterUsername" : { + "type" : "string", + "format" : "email", + "description" : "Username of the MongoDB Cloud user who sent the invitation to join the organization.", + "readOnly" : true + } + } + } ], + "required" : [ "id", "invitationCreatedAt", "invitationExpiresAt", "inviterUsername", "orgMembershipStatus", "roles", "username" ] + }, "OrgServiceAccount" : { "type" : "object", "properties" : { + "clientId" : { + "type" : "string", + "description" : "The Client ID of the Service Account.", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + }, "createdAt" : { "type" : "string", "format" : "date-time", - "description" : "Service account creation time." + "description" : "The date that the Service Account was created on." }, "description" : { "type" : "string", - "description" : "Description of the service account." - }, - "id" : { - "type" : "string", - "description" : "ID for the service account.", - "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + "description" : "Human readable description for the Service Account." }, "name" : { "type" : "string", - "description" : "Name for service account." + "description" : "Human-readable name for the Service Account." }, "roles" : { "type" : "array", - "description" : "Organization roles assigned to the Service Account.", + "description" : "A list of Organization roles associated with the Service Account.", "items" : { "type" : "string", - "description" : "Organization roles associated with the service account.", + "description" : "Organization roles available for Service Accounts.", "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] }, "uniqueItems" : true }, "secrets" : { "type" : "array", - "description" : "List of secrets.", + "description" : "A list of secrets associated with the specified Service Account.", "items" : { "$ref" : "#/components/schemas/ServiceAccountSecret" }, @@ -41511,63 +43110,215 @@ "properties" : { "description" : { "type" : "string", - "description" : "Human readable description for the service account.", + "description" : "Human readable description for the Service Account.", "maxLength" : 250, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "name" : { "type" : "string", - "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "description" : "Human-readable name for the Service Account. The name is modifiable and does not have to be unique.", "maxLength" : 64, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "roles" : { "type" : "array", - "description" : "Organization roles associated with the service account.", + "description" : "A list of organization-level roles for the Service Account.", "items" : { "type" : "string", - "description" : "Organization roles associated with the service account.", + "description" : "Organization roles available for Service Accounts.", "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] } }, "secretExpiresAfterHours" : { "type" : "integer", "format" : "int32", - "description" : "Secret expiration time." + "description" : "The expiration time of the new Service Account secret. The expiration is provided in hours." } }, - "required" : [ "description", "name", "secretExpiresAfterHours" ] + "required" : [ "description", "name", "roles", "secretExpiresAfterHours" ] }, "OrgServiceAccountUpdateRequest" : { "type" : "object", "properties" : { "description" : { "type" : "string", - "description" : "Human readable description for the service account.", + "description" : "Human readable description for the Service Account.", "maxLength" : 250, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "name" : { "type" : "string", - "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "description" : "Human-readable name for the Service Account. The name is modifiable and does not have to be unique.", "maxLength" : 64, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "roles" : { "type" : "array", - "description" : "Organization roles associated with the Service account.", + "description" : "A list of organization-level roles for the Service Account.", "items" : { "type" : "string", - "description" : "Organization roles associated with the service account.", + "description" : "Organization roles available for Service Accounts.", "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] } } } }, + "OrgUserRequest" : { + "type" : "object", + "properties" : { + "roles" : { + "$ref" : "#/components/schemas/OrgUserRolesRequest" + }, + "teamIds" : { + "type" : "array", + "description" : "List of unique 24-hexadecimal digit strings that identifies the teams to which this MongoDB Cloud user belongs.", + "items" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "uniqueItems" : true, + "writeOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address that represents the username of the MongoDB Cloud user.", + "writeOnly" : true + } + }, + "required" : [ "roles", "username" ] + }, + "OrgUserResponse" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "ACTIVE" : "#/components/schemas/OrgActiveUserResponse", + "PENDING" : "#/components/schemas/OrgPendingUserResponse" + }, + "propertyName" : "orgMembershipStatus" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/OrgPendingUserResponse" + }, { + "$ref" : "#/components/schemas/OrgActiveUserResponse" + } ], + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgMembershipStatus" : { + "type" : "string", + "description" : "String enum that indicates whether the MongoDB Cloud user has a pending invitation to join the organization or they are already active in the organization.", + "enum" : [ "PENDING", "ACTIVE" ], + "readOnly" : true + }, + "roles" : { + "$ref" : "#/components/schemas/OrgUserRolesResponse" + }, + "teamIds" : { + "type" : "array", + "description" : "List of unique 24-hexadecimal digit strings that identifies the teams to which this MongoDB Cloud user belongs.", + "items" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address that represents the username of the MongoDB Cloud user.", + "readOnly" : true + } + }, + "required" : [ "id", "orgMembershipStatus", "roles", "username" ] + }, + "OrgUserRolesRequest" : { + "type" : "object", + "description" : "Organization and project level roles to assign the MongoDB Cloud user within one organization.", + "properties" : { + "groupRoleAssignments" : { + "type" : "array", + "description" : "List of project level role assignments to assign the MongoDB Cloud user.", + "items" : { + "$ref" : "#/components/schemas/GroupRoleAssignment" + } + }, + "orgRoles" : { + "type" : "array", + "description" : "One or more organization level roles to assign the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_READ_ONLY", "ORG_MEMBER" ] + }, + "minItems" : 1, + "uniqueItems" : true + } + }, + "required" : [ "orgRoles" ], + "writeOnly" : true + }, + "OrgUserRolesResponse" : { + "type" : "object", + "description" : "Organization and project level roles assigned to one MongoDB Cloud user within one organization.", + "properties" : { + "groupRoleAssignments" : { + "type" : "array", + "description" : "List of project level role assignments assigned to the MongoDB Cloud user.", + "items" : { + "$ref" : "#/components/schemas/GroupRoleAssignment" + } + }, + "orgRoles" : { + "type" : "array", + "description" : "One or more organization level roles assigned to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_READ_ONLY", "ORG_MEMBER" ] + }, + "uniqueItems" : true + } + }, + "readOnly" : true + }, + "OrgUserUpdateRequest" : { + "type" : "object", + "properties" : { + "roles" : { + "$ref" : "#/components/schemas/OrgUserRolesRequest" + }, + "teamIds" : { + "type" : "array", + "description" : "List of unique 24-hexadecimal digit strings that identifies the teams to assign the MongoDB Cloud user.", + "items" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "uniqueItems" : true, + "writeOnly" : true + } + } + }, "OrganizationInvitation" : { "type" : "object", "properties" : { @@ -41772,7 +43523,7 @@ }, "restrictEmployeeAccess" : { "type" : "boolean", - "description" : "Flag that indicates whether to block MongoDB Support from accessing Atlas infrastructure 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/." + "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/." } } }, @@ -41919,7 +43670,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/AdvancedClusterDescription" }, @@ -41951,7 +43702,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/GroupAlertsConfig" }, @@ -41983,7 +43734,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/AlertViewForNdsGroup" }, @@ -42015,7 +43766,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ApiKeyUserDetails" }, @@ -42047,7 +43798,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/CloudAppUser" }, @@ -42079,7 +43830,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ApiAtlasCheckpointView" }, @@ -42112,7 +43863,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/CloudDatabaseUser" }, @@ -42144,7 +43895,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/DiskBackupExportJob" }, @@ -42176,7 +43927,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/EARPrivateEndpoint" }, @@ -42191,7 +43942,7 @@ } } }, - "PaginatedApiAtlasProviderRegionsView" : { + "PaginatedApiAtlasFlexBackupRestoreJob20250101View" : { "type" : "object", "properties" : { "links" : { @@ -42208,9 +43959,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/CloudProviderRegions" + "$ref" : "#/components/schemas/FlexBackupRestoreJob20250101" }, "readOnly" : true }, @@ -42223,7 +43974,7 @@ } } }, - "PaginatedApiAtlasServerlessBackupRestoreJobView" : { + "PaginatedApiAtlasFlexBackupSnapshot20240710View" : { "type" : "object", "properties" : { "links" : { @@ -42240,9 +43991,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" + "$ref" : "#/components/schemas/FlexBackupSnapshot20250101" }, "readOnly" : true }, @@ -42255,7 +44006,7 @@ } } }, - "PaginatedApiAtlasServerlessBackupSnapshotView" : { + "PaginatedApiAtlasProviderRegionsView" : { "type" : "object", "properties" : { "links" : { @@ -42272,9 +44023,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/ServerlessBackupSnapshot" + "$ref" : "#/components/schemas/CloudProviderRegions" }, "readOnly" : true }, @@ -42287,7 +44038,7 @@ } } }, - "PaginatedApiAtlasUSSBackupRestoreJob20250101View" : { + "PaginatedApiAtlasServerlessBackupRestoreJobView" : { "type" : "object", "properties" : { "links" : { @@ -42304,9 +44055,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/USSBackupRestoreJob20250101" + "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" }, "readOnly" : true }, @@ -42319,7 +44070,7 @@ } } }, - "PaginatedApiAtlasUSSBackupSnapshot20240710View" : { + "PaginatedApiAtlasServerlessBackupSnapshotView" : { "type" : "object", "properties" : { "links" : { @@ -42336,9 +44087,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/USSBackupSnapshot20250101" + "$ref" : "#/components/schemas/ServerlessBackupSnapshot" }, "readOnly" : true }, @@ -42368,7 +44119,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/BillingInvoiceMetadata" }, @@ -42400,7 +44151,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/BillingInvoice" }, @@ -42432,7 +44183,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/StreamsConnection" }, @@ -42447,6 +44198,38 @@ } } }, + "PaginatedApiStreamsPrivateLinkView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", + "items" : { + "$ref" : "#/components/schemas/StreamsPrivateLinkConnection" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, "PaginatedApiStreamsStreamProcessorWithStatsView" : { "type" : "object", "properties" : { @@ -42464,7 +44247,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/StreamsProcessorWithStats" }, @@ -42496,7 +44279,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/StreamsTenant" }, @@ -42528,7 +44311,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/UserAccessListResponse" }, @@ -42543,6 +44326,38 @@ } } }, + "PaginatedApiVersions" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ApiVersion" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, "PaginatedAppUserView" : { "type" : "object", "properties" : { @@ -42560,7 +44375,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/CloudAppUser" }, @@ -42592,7 +44407,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/Group" }, @@ -42624,7 +44439,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/MdbAvailableVersion" }, @@ -42656,7 +44471,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" }, @@ -42688,7 +44503,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/DiskBackupSnapshotExportBucket" }, @@ -42720,7 +44535,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/DiskBackupSnapshot" }, @@ -42752,7 +44567,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/DiskBackupReplicaSet" }, @@ -42784,7 +44599,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/DiskBackupSnapshotRestoreJob" }, @@ -42816,7 +44631,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/DiskBackupShardedClusterSnapshot" }, @@ -42849,7 +44664,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/CloudProviderContainer" }, @@ -42882,7 +44697,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ClusterDescription20240805" }, @@ -42914,7 +44729,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ConnectedOrgConfig" }, @@ -42947,7 +44762,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" }, @@ -42979,7 +44794,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/MesurementsDatabase" }, @@ -43011,7 +44826,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/MeasurementDiskPartition" }, @@ -43043,7 +44858,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/EventTypeDetails" }, @@ -43075,7 +44890,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/FederationIdentityProvider" }, @@ -43090,9 +44905,41 @@ } } }, + "PaginatedFlexClusters20250101" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", + "items" : { + "type" : "object" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, "PaginatedGroupServiceAccounts" : { "type" : "object", - "description" : "List of Service Accounts", + "description" : "A list of Project Service Accounts.", "properties" : { "links" : { "type" : "array", @@ -43108,7 +44955,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/GroupServiceAccount" }, @@ -43140,7 +44987,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ApiHostView_Atlas" }, @@ -43172,7 +45019,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ThirdPartyIntegration" }, @@ -43204,7 +45051,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/LegacyAtlasCluster" }, @@ -43236,7 +45083,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/NetworkPermissionEntry" }, @@ -43268,7 +45115,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/BackupOnlineArchive" }, @@ -43300,7 +45147,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/OrgGroup" }, @@ -43317,7 +45164,7 @@ }, "PaginatedOrgServiceAccounts" : { "type" : "object", - "description" : "List of Service Accounts", + "description" : "A list of Organization Service Accounts.", "properties" : { "links" : { "type" : "array", @@ -43333,7 +45180,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/OrgServiceAccount" }, @@ -43365,7 +45212,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/AtlasOrganization" }, @@ -43397,7 +45244,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/IngestionPipelineRun" }, @@ -43429,7 +45276,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/PrivateNetworkEndpointIdEntry" }, @@ -43461,7 +45308,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/PublicApiUsageDetailsLineItemView" }, @@ -43493,7 +45340,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/BackupRestoreJob" }, @@ -43526,7 +45373,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/AuthFederationRoleMapping" }, @@ -43558,7 +45405,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ServerlessInstanceDescription" }, @@ -43575,7 +45422,7 @@ }, "PaginatedServiceAccountGroup" : { "type" : "object", - "description" : "List of Service Account projects.", + "description" : "A list of projects associated with the Service Account.", "properties" : { "links" : { "type" : "array", @@ -43591,7 +45438,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ServiceAccountGroup" }, @@ -43606,7 +45453,7 @@ } } }, - "PaginatedSnapshotView" : { + "PaginatedServiceAccountIPAccessEntryView" : { "type" : "object", "properties" : { "links" : { @@ -43623,9 +45470,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/BackupSnapshot" + "$ref" : "#/components/schemas/ServiceAccountIPAccessListEntry" }, "readOnly" : true }, @@ -43638,7 +45485,7 @@ } } }, - "PaginatedTeamRoleView" : { + "PaginatedSnapshotView" : { "type" : "object", "properties" : { "links" : { @@ -43655,9 +45502,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/TeamRole" + "$ref" : "#/components/schemas/BackupSnapshot" }, "readOnly" : true }, @@ -43670,7 +45517,7 @@ } } }, - "PaginatedTeamView" : { + "PaginatedTeamRoleView" : { "type" : "object", "properties" : { "links" : { @@ -43687,9 +45534,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/TeamResponse" + "$ref" : "#/components/schemas/TeamRole" }, "readOnly" : true }, @@ -43702,7 +45549,7 @@ } } }, - "PaginatedTenantRestoreView" : { + "PaginatedTeamView" : { "type" : "object", "properties" : { "links" : { @@ -43719,9 +45566,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/TenantRestore" + "$ref" : "#/components/schemas/TeamResponse" }, "readOnly" : true }, @@ -43734,7 +45581,7 @@ } } }, - "PaginatedTenantSnapshotView" : { + "PaginatedTenantRestoreView" : { "type" : "object", "properties" : { "links" : { @@ -43751,9 +45598,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/BackupTenantSnapshot" + "$ref" : "#/components/schemas/TenantRestore" }, "readOnly" : true }, @@ -43766,7 +45613,7 @@ } } }, - "PaginatedUSSInstance20250101" : { + "PaginatedTenantSnapshotView" : { "type" : "object", "properties" : { "links" : { @@ -43783,9 +45630,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "type" : "object" + "$ref" : "#/components/schemas/BackupTenantSnapshot" }, "readOnly" : true }, @@ -43815,7 +45662,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/UserCert" }, @@ -44322,6 +46169,14 @@ "PrivateNetworkEndpointIdEntry" : { "type" : "object", "properties" : { + "azureConnectionName" : { + "type" : "string", + "description" : "Connection name that identifies the Azure private endpoint connection." + }, + "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." @@ -44330,6 +46185,11 @@ "type" : "string", "description" : "Human-readable label to identify customer's VPC endpoint DNS name." }, + "customerEndpointIPAddress" : { + "type" : "string", + "description" : "IP address used to connect to the Azure private endpoint.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + }, "endpointId" : { "type" : "string", "description" : "Unique 22-character alphanumeric string that identifies the private endpoint.", @@ -44342,6 +46202,10 @@ "minLength" : 22, "pattern" : "^vpce-[0-9a-f]{17}$" }, + "errorMessage" : { + "type" : "string", + "description" : "Error message describing a failure approving the private endpoint request." + }, "provider" : { "type" : "string", "default" : "AWS", @@ -44352,6 +46216,11 @@ "type" : "string", "description" : "Human-readable label to identify the region of customer's VPC endpoint." }, + "status" : { + "type" : "string", + "description" : "Status of the private endpoint connection request.", + "enum" : [ "PENDING", "OK", "FAILED", "DELETING" ] + }, "type" : { "type" : "string", "default" : "DATA_LAKE", @@ -44408,20 +46277,6 @@ "required" : [ "enabled", "serviceDiscovery", "username" ], "title" : "PROMETHEUS" }, - "ProxyInfo" : { - "type" : "object", - "description" : "VPC Proxy Information.", - "properties" : { - "authKey" : { - "type" : "string", - "description" : "Authentication key for the proxy." - }, - "dnsName" : { - "type" : "string", - "description" : "DNS name to use to reach the proxy/s." - } - } - }, "PublicApiUsageDetailsLineItemView" : { "type" : "object", "properties" : { @@ -44519,7 +46374,9 @@ "enum" : [ "AVERAGE" ] }, "operator" : { - "$ref" : "#/components/schemas/Operator" + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, "threshold" : { "type" : "number", @@ -44567,7 +46424,7 @@ "example" : "cluster1", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -44809,7 +46666,9 @@ "enum" : [ "AVERAGE" ] }, "operator" : { - "$ref" : "#/components/schemas/Operator" + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, "threshold" : { "type" : "number", @@ -44987,7 +46846,7 @@ "example" : "cluster1", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -45267,472 +47126,69 @@ } }, "zoneName" : { - "type" : "string", - "description" : "Human-readable label that identifies the zone in a Global Cluster. Provide this value only if `\"clusterType\" : \"GEOSHARDED\"`." - } - }, - "title" : "Replication Specifications" - }, - "ReplicationSpec20240805" : { - "type" : "object", - "description" : "Details that explain how MongoDB Cloud replicates data on the specified MongoDB database.", - "properties" : { - "id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a shard in a Cluster. If you include existing shard replication configurations in the request, you must specify this parameter. If you add a new shard to an existing Cluster, you may specify this parameter. The request deletes any existing shards in the Cluster that you exclude from the request.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "regionConfigs" : { - "type" : "array", - "description" : "Hardware specifications for nodes set for a given region. 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**.\n\n**Example:**\n\nIf you set `\"replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize\" : \"M30\"`, set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : `\"M30\"` if you have electable nodes and `\"replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize\" : `\"M30\"` if you have read-only nodes.", - "items" : { - "$ref" : "#/components/schemas/CloudRegionConfig20240805" - } - }, - "zoneId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the zone in a Global Cluster. This value can be used to configure Global Cluster backup policies.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "zoneName" : { - "type" : "string", - "description" : "Human-readable label that describes the zone this shard belongs to in a Global Cluster. Provide this value only if \"clusterType\" : \"GEOSHARDED\" but not \"selfManagedSharding\" : true." - } - }, - "title" : "Replication Specifications" - }, - "RequestAccepted" : { - "type" : "object", - "description" : "Accepted" - }, - "ResourceEventTypeView" : { - "type" : "string", - "description" : "Unique identifier of event type.", - "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], - "example" : "TAGS_MODIFIED", - "title" : "Resource Event Types" - }, - "ResourceEventTypeViewForOrg" : { - "type" : "string", - "description" : "Unique identifier of event type.", - "enum" : [ "GROUP_TAGS_MODIFIED" ], - "example" : "GROUP_TAGS_MODIFIED", - "title" : "Resource Event Types" - }, - "ResourceEventViewForNdsGroup" : { - "type" : "object", - "description" : "Resource event reflects different activities about resources.", - "properties" : { - "apiKeyId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "created" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true - }, - "eventTypeName" : { - "$ref" : "#/components/schemas/ResourceEventTypeView" - }, - "groupId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "isGlobalAdmin" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", - "readOnly" : true - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - }, - "orgId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "publicKey" : { - "type" : "string", - "format" : "email", - "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "example" : "test.user@mongodb.com", - "readOnly" : true - }, - "raw" : { - "$ref" : "#/components/schemas/raw" - }, - "remoteAddress" : { - "type" : "string", - "description" : "IPv4 or IPv6 address from which the user triggered this event.", - "example" : "216.172.40.186", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", - "readOnly" : true - }, - "resourceId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the resource associated with the event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "resourceType" : { - "type" : "string", - "description" : "Unique identifier of resource type.", - "example" : "cluster" - }, - "userId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "username" : { - "type" : "string", - "format" : "email", - "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", - "example" : "test.user@mongodb.com", - "readOnly" : true - } - }, - "required" : [ "created", "eventTypeName", "id", "resourceType" ], - "title" : "Resource Events" - }, - "ResourceEventViewForOrg" : { - "type" : "object", - "description" : "Resource event reflects different activities about resources.", - "properties" : { - "apiKeyId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "created" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true - }, - "eventTypeName" : { - "$ref" : "#/components/schemas/ResourceEventTypeViewForOrg" - }, - "groupId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "isGlobalAdmin" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", - "readOnly" : true - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - }, - "orgId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "publicKey" : { - "type" : "string", - "format" : "email", - "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "example" : "test.user@mongodb.com", - "readOnly" : true - }, - "raw" : { - "$ref" : "#/components/schemas/raw" - }, - "remoteAddress" : { - "type" : "string", - "description" : "IPv4 or IPv6 address from which the user triggered this event.", - "example" : "216.172.40.186", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", - "readOnly" : true - }, - "resourceId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the resource associated with the event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "resourceType" : { - "type" : "string", - "description" : "Unique identifier of resource type.", - "example" : "cluster" - }, - "userId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "username" : { - "type" : "string", - "format" : "email", - "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", - "example" : "test.user@mongodb.com", - "readOnly" : true - } - }, - "required" : [ "created", "eventTypeName", "id", "resourceType" ], - "title" : "Resource Events" - }, - "ResourceTag" : { - "type" : "object", - "description" : "Key-value pair that tags and categorizes a MongoDB Cloud organization, project, or cluster. For example, `environment : production`.", - "properties" : { - "key" : { - "type" : "string", - "description" : "Constant that defines the set of the tag. For example, `environment` in the `environment : production` tag.", - "maxLength" : 255, - "minLength" : 1 - }, - "value" : { - "type" : "string", - "description" : "Variable that belongs to the set of the tag. For example, `production` in the `environment : production` tag.", - "maxLength" : 255, - "minLength" : 1 - } - }, - "required" : [ "key", "value" ], - "title" : "Resource Tag" - }, - "RestoreJobFileHash" : { - "type" : "object", - "description" : "Key and value pair that map one restore file to one hashed checksum. This parameter applies after you download the corresponding **delivery.url**.", - "properties" : { - "fileName" : { - "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.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - }, - "typeName" : { - "type" : "string", - "description" : "Human-readable label that identifies the hashing algorithm used to compute the hash value.", - "enum" : [ "SHA1" ], - "readOnly" : true - } - }, - "readOnly" : true - }, - "RoleAssignment" : { - "type" : "object", - "properties" : { - "groupId" : { - "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", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" - }, - "orgId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization to which this role belongs. Each element within **roleAssignments** can have a value for **orgId** or **groupId**, but not both.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" - }, - "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.\n\nOrganization Roles\n\n* ORG_OWNER\n* ORG_MEMBER\n* ORG_GROUP_CREATOR\n* ORG_BILLING_ADMIN\n* ORG_READ_ONLY\n\nProject Roles\n\n* GROUP_CLUSTER_MANAGER\n* GROUP_DATA_ACCESS_ADMIN\n* GROUP_DATA_ACCESS_READ_ONLY\n* GROUP_DATA_ACCESS_READ_WRITE\n* GROUP_OWNER\n* GROUP_READ_ONLY\n* GROUP_SEARCH_INDEX_EDITOR\n* GROUP_STREAM_PROCESSING_OWNER\n\n", - "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] - } - } - }, - "SMSNotification" : { - "type" : "object", - "description" : "SMS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", - "properties" : { - "delayMin" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." - }, - "intervalMin" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", - "minimum" : 5 - }, - "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" : { - "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" ] + "type" : "string", + "description" : "Human-readable label that identifies the zone in a Global Cluster. Provide this value only if `\"clusterType\" : \"GEOSHARDED\"`." } }, - "required" : [ "typeName" ], - "title" : "SMS Notification" + "title" : "Replication Specifications" }, - "SampleDatasetStatus" : { + "ReplicationSpec20240805" : { "type" : "object", + "description" : "Details that explain how MongoDB Cloud replicates data on the specified MongoDB database.", "properties" : { - "_id" : { + "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies this sample dataset.", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a shard in a Cluster. If you include existing shard replication configurations in the request, you must specify this parameter. If you add a new shard to an existing Cluster, you may specify this parameter. The request deletes any existing shards in the Cluster that you exclude from the request.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "clusterName" : { - "type" : "string", - "description" : "Human-readable label that identifies the cluster into which you loaded the sample dataset.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "readOnly" : true - }, - "completeDate" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when the sample dataset load job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", - "readOnly" : true - }, - "createDate" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when you started the sample dataset load job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", - "readOnly" : true + "regionConfigs" : { + "type" : "array", + "description" : "Hardware specifications for nodes set for a given region. 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**.\n\n**Example:**\n\nIf you set `\"replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize\" : \"M30\"`, set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : `\"M30\"` if you have electable nodes and `\"replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize\" : `\"M30\"` if you have read-only nodes.", + "items" : { + "$ref" : "#/components/schemas/CloudRegionConfig20240805" + } }, - "errorMessage" : { + "zoneId" : { "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.", + "description" : "Unique 24-hexadecimal digit string that identifies the zone in a Global Cluster. This value can be used to configure Global Cluster backup policies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "state" : { + "zoneName" : { "type" : "string", - "description" : "Status of the sample dataset load job.", - "enum" : [ "WORKING", "FAILED", "COMPLETED" ], - "readOnly" : true + "description" : "Human-readable label that describes the zone this shard belongs to in a Global Cluster. Provide this value only if \"clusterType\" : \"GEOSHARDED\" but not \"selfManagedSharding\" : true." } - } + }, + "title" : "Replication Specifications" }, - "SearchDeploymentAuditTypeView" : { + "RequestAccepted" : { + "type" : "object", + "description" : "Accepted" + }, + "ResourceEventTypeView" : { "type" : "string", "description" : "Unique identifier of event type.", - "enum" : [ "SEARCH_DEPLOYMENT_CREATED", "SEARCH_DEPLOYMENT_UPDATED", "SEARCH_DEPLOYMENT_DELETED" ], - "example" : "SEARCH_DEPLOYMENT_CREATED", - "title" : "Search Deployment Audit Types" + "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], + "example" : "TAGS_MODIFIED", + "title" : "Resource Event Types" }, - "SearchDeploymentAuditView" : { + "ResourceEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "GROUP_TAGS_MODIFIED" ], + "example" : "GROUP_TAGS_MODIFIED", + "title" : "Resource Event Types" + }, + "ResourceEventViewForNdsGroup" : { "type" : "object", - "description" : "Indicates activities on decoupled search nodes.", + "description" : "Resource event reflects different activities about resources.", "properties" : { "apiKeyId" : { "type" : "string", @@ -45750,7 +47206,7 @@ "readOnly" : true }, "eventTypeName" : { - "$ref" : "#/components/schemas/SearchDeploymentAuditTypeView" + "$ref" : "#/components/schemas/ResourceEventTypeView" }, "groupId" : { "type" : "string", @@ -45801,6 +47257,7 @@ "type" : "string", "format" : "email", "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true }, "raw" : { @@ -45813,6 +47270,20 @@ "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", "readOnly" : true }, + "resourceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the resource associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resourceType" : { + "type" : "string", + "description" : "Unique identifier of resource type.", + "example" : "cluster" + }, "userId" : { "type" : "string", "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", @@ -45830,541 +47301,159 @@ "readOnly" : true } }, - "required" : [ "created", "eventTypeName", "id" ], - "title" : "Search Deployment Audits" - }, - "SearchHostStatusDetail" : { - "type" : "object", - "properties" : { - "hostname" : { - "type" : "string", - "description" : "Hostname that corresponds to the status detail." - }, - "mainIndex" : { - "$ref" : "#/components/schemas/SearchMainIndexStatusDetail" - }, - "queryable" : { - "type" : "boolean", - "description" : "Flag that indicates whether the index is queryable on the host." - }, - "stagedIndex" : { - "$ref" : "#/components/schemas/SearchStagedIndexStatusDetail" - }, - "status" : { - "type" : "string", - "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", - "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] - } - }, - "title" : "Search Host Status Detail" - }, - "SearchIndex" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/ClusterSearchIndex" - }, { - "type" : "object", - "properties" : { - "analyzer" : { - "type" : "string", - "default" : "lucene.standard", - "description" : "Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves a variety of changes made to the text in fields:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\n MongoDB Cloud uses the selected process to build the Atlas Search index.", - "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ], - "externalDocs" : { - "description" : "Atlas Search Analyzers", - "url" : "https://dochub.mongodb.org/core/analyzers--fts" - } - }, - "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" - }, - "items" : { - "$ref" : "#/components/schemas/ApiAtlasFTSAnalyzersViewManual" - } - }, - "mappings" : { - "$ref" : "#/components/schemas/ApiAtlasFTSMappingsViewManual" - }, - "searchAnalyzer" : { - "type" : "string", - "default" : "lucene.standard", - "description" : "Method applied to identify words when searching this index.", - "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] - }, - "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" - }, - "items" : { - "$ref" : "#/components/schemas/SearchSynonymMappingDefinition" - } - } - } - } ], - "required" : [ "collectionName", "database", "name" ] - }, - "SearchIndexCreateRequest" : { - "type" : "object", - "discriminator" : { - "mapping" : { - "search" : "#/components/schemas/TextSearchIndexCreateRequest", - "vectorSearch" : "#/components/schemas/VectorSearchIndexCreateRequest" - }, - "propertyName" : "type" - }, - "properties" : { - "collectionName" : { - "type" : "string", - "description" : "Label that identifies the collection to create an Atlas Search index in." - }, - "database" : { - "type" : "string", - "description" : "Label that identifies the database that contains the collection to create an Atlas Search index in." - }, - "name" : { - "type" : "string", - "description" : "Label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique." - }, - "type" : { - "type" : "string", - "description" : "Type of the index. The default type is search.", - "enum" : [ "search", "vectorSearch" ] - } - }, - "required" : [ "collectionName", "database", "name" ] - }, - "SearchIndexDefinition" : { - "type" : "object", - "description" : "The search index definition set by the user.", - "title" : "Search Index Definition" - }, - "SearchIndexDefinitionVersion" : { - "type" : "object", - "description" : "Object which includes the version number of the index definition and the time that the index definition was created.", - "properties" : { - "createdAt" : { - "type" : "string", - "format" : "date-time", - "description" : "The time at which this index definition was created." - }, - "version" : { - "type" : "integer", - "format" : "int64", - "description" : "The version number associated with this index definition when it was created." - } - }, - "title" : "Search Index Definition Version" + "required" : [ "created", "eventTypeName", "id", "resourceType" ], + "title" : "Resource Events" }, - "SearchIndexResponse" : { + "ResourceEventViewForOrg" : { "type" : "object", - "discriminator" : { - "mapping" : { - "search" : "#/components/schemas/TextSearchIndexResponse", - "vectorSearch" : "#/components/schemas/VectorSearchIndexResponse" - }, - "propertyName" : "type" - }, + "description" : "Resource event reflects different activities about resources.", "properties" : { - "collectionName" : { - "type" : "string", - "description" : "Label that identifies the collection that contains one or more Atlas Search indexes." - }, - "database" : { - "type" : "string", - "description" : "Label that identifies the database that contains the collection with one or more Atlas Search indexes." - }, - "indexID" : { + "apiKeyId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies this Atlas Search index.", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" - }, - "latestDefinition" : { - "$ref" : "#/components/schemas/SearchIndexDefinition" - }, - "latestDefinitionVersion" : { - "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" - }, - "name" : { - "type" : "string", - "description" : "Label that identifies this index. Within each namespace, the names of all indexes must be unique." - }, - "queryable" : { - "type" : "boolean", - "description" : "Flag that indicates whether the index is queryable on all hosts." - }, - "status" : { - "type" : "string", - "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", - "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] - }, - "statusDetail" : { - "type" : "array", - "description" : "List of documents detailing index status on each host.", - "items" : { - "$ref" : "#/components/schemas/SearchHostStatusDetail" - } - }, - "type" : { - "type" : "string", - "description" : "Type of the index. The default type is search.", - "enum" : [ "search", "vectorSearch" ] - } - }, - "title" : "Search Index Response" - }, - "SearchIndexUpdateRequest" : { - "type" : "object", - "properties" : { - "definition" : { - "type" : "object", - "description" : "The index definition to update the search index to.", - "oneOf" : [ { - "$ref" : "#/components/schemas/TextSearchIndexDefinition" - }, { - "$ref" : "#/components/schemas/VectorSearchIndexDefinition" - } ] - } - }, - "required" : [ "definition" ], - "title" : "Search Index Update Request" - }, - "SearchMainIndexStatusDetail" : { - "type" : "object", - "description" : "Contains status information about the active index.", - "properties" : { - "definition" : { - "$ref" : "#/components/schemas/SearchIndexDefinition" - }, - "definitionVersion" : { - "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" - }, - "message" : { - "type" : "string", - "description" : "Optional message describing an error." - }, - "queryable" : { - "type" : "boolean", - "description" : "Flag that indicates whether the index generation is queryable on the host." - }, - "status" : { - "type" : "string", - "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", - "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] - } - }, - "title" : "Search Main Index Status Detail" - }, - "SearchMappings" : { - "type" : "object", - "description" : "Index specifications for the collection's fields.", - "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/field-mapping-definition-fts#static-and-dynamic-mappings" - } - }, - "fields" : { - "type" : "object", - "additionalProperties" : { - "type" : "object", - "description" : "One or more field specifications for the Atlas Search index. Required if **mappings.dynamic** is omitted or set to **false**.", - "externalDocs" : { - "description" : "Atlas Search Index", - "url" : "https://dochub.mongodb.org/core/index-definitions-fts" - }, - "x-additionalPropertiesName" : "Field Name" - }, - "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" - }, - "x-additionalPropertiesName" : "Field Name" - } - }, - "title" : "Mappings" - }, - "SearchStagedIndexStatusDetail" : { - "type" : "object", - "description" : "Contains status information about an index building in the background.", - "properties" : { - "definition" : { - "$ref" : "#/components/schemas/SearchIndexDefinition" - }, - "definitionVersion" : { - "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" - }, - "message" : { - "type" : "string", - "description" : "Optional message describing an error." - }, - "queryable" : { - "type" : "boolean", - "description" : "Flag that indicates whether the index generation is queryable on the host." + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "status" : { - "type" : "string", - "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", - "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] - } - }, - "title" : "Search Staged Index Status Detail" - }, - "SearchSynonymMappingDefinition" : { - "type" : "object", - "description" : "Synonyms used for this full text index.", - "properties" : { - "analyzer" : { + "created" : { "type" : "string", - "description" : "Specific pre-defined method chosen to apply to the synonyms to be searched.", - "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true }, - "name" : { - "type" : "string", - "description" : "Label that identifies the synonym definition. Each **synonym.name** must be unique within the same index definition." + "eventTypeName" : { + "$ref" : "#/components/schemas/ResourceEventTypeViewForOrg" }, - "source" : { - "$ref" : "#/components/schemas/SynonymSource" - } - }, - "required" : [ "analyzer", "name", "source" ], - "title" : "Synonym Mapping Definition" - }, - "ServerlessAWSTenantEndpoint" : { - "type" : "object", - "description" : "View for a serverless AWS tenant endpoint.", - "properties" : { - "_id" : { + "groupId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "cloudProviderEndpointId" : { - "type" : "string", - "description" : "Unique string that identifies the private endpoint's network interface.", - "pattern" : "^vpce-[0-9a-f]{17}$", - "readOnly" : true - }, - "comment" : { - "type" : "string", - "description" : "Human-readable comment associated with the private endpoint.", - "maxLength" : 80, - "readOnly" : true - }, - "endpointServiceName" : { + "id" : { "type" : "string", - "description" : "Unique string that identifies the Amazon Web Services (AWS) PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", - "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "errorMessage" : { - "type" : "string", - "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", "readOnly" : true }, - "providerName" : { - "type" : "string", - "description" : "Human-readable label that identifies the cloud service provider.", - "enum" : [ "AWS" ], + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, "readOnly" : true }, - "status" : { - "type" : "string", - "description" : "Human-readable label that indicates the current operating status of the private endpoint.", - "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], - "readOnly" : true - } - }, - "title" : "AWS" - }, - "ServerlessAWSTenantEndpointUpdate" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" - }, { - "type" : "object", - "properties" : { - "cloudProviderEndpointId" : { - "type" : "string", - "description" : "Unique string that identifies the private endpoint's network interface.", - "pattern" : "^vpce-[0-9a-f]{17}$", - "writeOnly" : true - } - } - } ], - "description" : "Updates to a serverless AWS tenant endpoint.", - "required" : [ "providerName" ], - "title" : "AWS" - }, - "ServerlessAzureTenantEndpoint" : { - "type" : "object", - "description" : "View for a serverless Azure tenant endpoint.", - "properties" : { - "_id" : { + "orgId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "cloudProviderEndpointId" : { - "type" : "string", - "description" : "Unique string that identifies the Azure private endpoint's network interface that someone added to this private endpoint service.", - "pattern" : "^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\\.Network/privateEndpoints/[-\\w._()]+$", - "readOnly" : true - }, - "comment" : { + "publicKey" : { "type" : "string", - "description" : "Human-readable comment associated with the private endpoint.", - "maxLength" : 80, + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true }, - "endpointServiceName" : { - "type" : "string", - "description" : "Unique string that identifies the Azure private endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", - "pattern" : "^pls_[0-9a-f]{24}$", - "readOnly" : true + "raw" : { + "$ref" : "#/components/schemas/raw" }, - "errorMessage" : { + "remoteAddress" : { "type" : "string", - "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", "readOnly" : true }, - "privateEndpointIpAddress" : { + "resourceId" : { "type" : "string", - "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "description" : "Unique 24-hexadecimal digit string that identifies the resource associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "privateLinkServiceResourceId" : { + "resourceType" : { "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 + "description" : "Unique identifier of resource type.", + "example" : "cluster" }, - "providerName" : { + "userId" : { "type" : "string", - "description" : "Human-readable label that identifies the cloud service provider.", - "enum" : [ "AZURE" ], + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "status" : { + "username" : { "type" : "string", - "description" : "Human-readable label that indicates the current operating status of the private endpoint.", - "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true } }, - "title" : "Azure" - }, - "ServerlessAzureTenantEndpointUpdate" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" - }, { - "type" : "object", - "properties" : { - "cloudProviderEndpointId" : { - "type" : "string", - "description" : "Unique string that identifies the Azure private endpoint's network interface for this private endpoint service.", - "pattern" : "^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\\.Network/privateEndpoints/[-\\w._()]+$", - "writeOnly" : true - }, - "privateEndpointIpAddress" : { - "type" : "string", - "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", - "writeOnly" : true - } - } - } ], - "description" : "Updates to a serverless Azure tenant endpoint.", - "required" : [ "providerName" ], - "title" : "AZURE" + "required" : [ "created", "eventTypeName", "id", "resourceType" ], + "title" : "Resource Events" }, - "ServerlessBackupRestoreJob" : { + "ResourceTag" : { "type" : "object", + "description" : "Key-value pair that tags and categorizes a MongoDB Cloud organization, project, or cluster. For example, `environment : production`.", "properties" : { - "cancelled" : { - "type" : "boolean", - "description" : "Flag that indicates whether someone canceled this restore job.", - "readOnly" : true - }, - "deliveryType" : { + "key" : { "type" : "string", - "description" : "Human-readable label that categorizes the restore job to create.", - "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\"`.", - "items" : { - "type" : "string", - "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download." - }, - "readOnly" : true - }, - "desiredTimestamp" : { - "$ref" : "#/components/schemas/ApiBSONTimestampView" - }, - "expired" : { - "type" : "boolean", - "description" : "Flag that indicates whether the restore job expired.", - "readOnly" : true + "description" : "Constant that defines the set of the tag. For example, `environment` in the `environment : production` tag.", + "maxLength" : 255, + "minLength" : 1 }, - "expiresAt" : { + "value" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when the restore job expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true - }, - "failed" : { - "type" : "boolean", - "description" : "Flag that indicates whether the restore job failed.", - "readOnly" : true - }, - "finishedAt" : { + "description" : "Variable that belongs to the set of the tag. For example, `production` in the `environment : production` tag.", + "maxLength" : 255, + "minLength" : 1 + } + }, + "required" : [ "key", "value" ], + "title" : "Resource Tag" + }, + "RestoreJobFileHash" : { + "type" : "object", + "description" : "Key and value pair that map one restore file to one hashed checksum. This parameter applies after you download the corresponding **delivery.url**.", + "properties" : { + "fileName" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when the restore job completed. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Human-readable label that identifies the hashed file.", "readOnly" : true }, - "id" : { + "hash" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the restore job.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "description" : "Hashed checksum that maps to the restore file.", "readOnly" : true }, "links" : { @@ -46379,87 +47468,173 @@ }, "readOnly" : true }, - "oplogInc" : { - "type" : "integer", - "format" : "int32", - "description" : "Oplog operation number from which you want to restore this snapshot. This number represents the second part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", - "example" : 1, - "minimum" : 1 + "typeName" : { + "type" : "string", + "description" : "Human-readable label that identifies the hashing algorithm used to compute the hash value.", + "enum" : [ "SHA1" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "RoleAssignment" : { + "type" : "object", + "properties" : { + "groupId" : { + "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", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" }, - "oplogTs" : { + "orgId" : { + "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", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "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.\n\nOrganization Roles\n\n* ORG_OWNER\n* ORG_MEMBER\n* ORG_GROUP_CREATOR\n* ORG_BILLING_ADMIN\n* ORG_READ_ONLY\n\nProject Roles\n\n* GROUP_CLUSTER_MANAGER\n* GROUP_DATA_ACCESS_ADMIN\n* GROUP_DATA_ACCESS_READ_ONLY\n* GROUP_DATA_ACCESS_READ_WRITE\n* GROUP_OWNER\n* GROUP_READ_ONLY\n* GROUP_SEARCH_INDEX_EDITOR\n* GROUP_STREAM_PROCESSING_OWNER\n\n", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + } + }, + "SMSNotification" : { + "type" : "object", + "description" : "SMS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { "type" : "integer", "format" : "int32", - "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`.", - "minimum" : 1199145600 + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." }, - "pointInTimeUTCSeconds" : { + "intervalMin" : { "type" : "integer", "format" : "int32", - "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`.", - "minimum" : 1199145600 + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 }, - "snapshotId" : { + "mobileNumber" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "description" : "Mobile phone number to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"SMS\"`.", + "example" : "1233337892" + }, + "notifierId" : { + "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" ] + } + }, + "required" : [ "typeName" ], + "title" : "SMS Notification" + }, + "SampleDatasetStatus" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies this sample dataset.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "targetClusterName" : { + "clusterName" : { "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\"`.", + "description" : "Human-readable label that identifies the cluster into which you loaded the sample dataset.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "readOnly" : true }, - "targetGroupId" : { + "completeDate" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the target project for the specified **targetClusterName**.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" + "format" : "date-time", + "description" : "Date and time when the sample dataset load job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true }, - "timestamp" : { + "createDate" : { "type" : "string", "format" : "date-time", - "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.", + "description" : "Date and time when you started the sample dataset load job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "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.", + "enum" : [ "WORKING", "FAILED", "COMPLETED" ], "readOnly" : true } - }, - "required" : [ "deliveryType", "targetClusterName", "targetGroupId" ] + } }, - "ServerlessBackupSnapshot" : { + "SearchDeploymentAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "SEARCH_DEPLOYMENT_CREATED", "SEARCH_DEPLOYMENT_UPDATED", "SEARCH_DEPLOYMENT_DELETED" ], + "example" : "SEARCH_DEPLOYMENT_CREATED", + "title" : "Search Deployment Audit Types" + }, + "SearchDeploymentAuditView" : { "type" : "object", + "description" : "Indicates activities on decoupled search nodes.", "properties" : { - "createdAt" : { + "apiKeyId" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "expiresAt" : { + "created" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "frequencyType" : { + "eventTypeName" : { + "$ref" : "#/components/schemas/SearchDeploymentAuditTypeView" + }, + "groupId" : { "type" : "string", - "description" : "Human-readable label that identifies how often this snapshot triggers.", - "enum" : [ "hourly", "daily", "weekly", "monthly" ], + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, "links" : { "type" : "array", "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", @@ -46472,450 +47647,445 @@ }, "readOnly" : true }, - "mongodVersion" : { + "orgId" : { "type" : "string", - "description" : "Version of the MongoDB host that this snapshot backs up.", - "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "serverlessInstanceName" : { + "publicKey" : { "type" : "string", - "description" : "Human-readable label given to the serverless instance from which MongoDB Cloud took this snapshot.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", "readOnly" : true }, - "snapshotType" : { + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { "type" : "string", - "description" : "Human-readable label that identifies when this snapshot triggers.", - "enum" : [ "onDemand", "scheduled" ], + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", "readOnly" : true }, - "status" : { + "userId" : { "type" : "string", - "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", - "enum" : [ "queued", "inProgress", "completed", "failed" ], + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "storageSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "Number of bytes taken to store the backup snapshot.", + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true } - } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Search Deployment Audits" }, - "ServerlessConnectionStringsPrivateEndpointItem" : { + "SearchHostStatusDetail" : { "type" : "object", - "description" : "Details of a private endpoint deployed for this serverless instance.", "properties" : { - "endpointId" : { + "hostname" : { "type" : "string", - "description" : "Unique string that the cloud provider uses to identify the private endpoint.", - "readOnly" : true + "description" : "Hostname that corresponds to the status detail." }, - "providerName" : { - "type" : "string", - "description" : "Cloud provider where the private endpoint is deployed.", - "enum" : [ "AWS", "AZURE" ], - "readOnly" : true + "mainIndex" : { + "$ref" : "#/components/schemas/SearchMainIndexStatusDetail" }, - "region" : { + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on the host." + }, + "stagedIndex" : { + "$ref" : "#/components/schemas/SearchStagedIndexStatusDetail" + }, + "status" : { "type" : "string", - "description" : "Region where the private endpoint is deployed.", - "readOnly" : true + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] } }, - "title" : "Serverless Instance Private Endpoint Connection Strings Endpoint" + "title" : "Search Host Status Detail" }, - "ServerlessConnectionStringsPrivateEndpointList" : { + "SearchIndex" : { "type" : "object", - "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/" + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, { + "type" : "object", + "properties" : { + "analyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves a variety of changes made to the text in fields:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\n MongoDB Cloud uses the selected process to build the Atlas Search index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ], + "externalDocs" : { + "description" : "Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/analyzers--fts" + } + }, + "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" + }, + "items" : { + "$ref" : "#/components/schemas/ApiAtlasFTSAnalyzersViewManual" + } + }, + "mappings" : { + "$ref" : "#/components/schemas/ApiAtlasFTSMappingsViewManual" + }, + "searchAnalyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Method applied to identify words when searching this index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] + }, + "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" + }, + "items" : { + "$ref" : "#/components/schemas/SearchSynonymMappingDefinition" + } + } + } + } ], + "required" : [ "collectionName", "database", "name" ] + }, + "SearchIndexCreateRequest" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "search" : "#/components/schemas/TextSearchIndexCreateRequest", + "vectorSearch" : "#/components/schemas/VectorSearchIndexCreateRequest" + }, + "propertyName" : "type" }, "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**.", - "items" : { - "$ref" : "#/components/schemas/ServerlessConnectionStringsPrivateEndpointItem" - }, - "readOnly" : true + "collectionName" : { + "type" : "string", + "description" : "Label that identifies the collection to create an Atlas Search index in." }, - "srvConnectionString" : { + "database" : { "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 + "description" : "Label that identifies the database that contains the collection to create an Atlas Search index in." + }, + "name" : { + "type" : "string", + "description" : "Label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique." }, "type" : { "type" : "string", - "description" : "MongoDB process type to which your application connects.", - "enum" : [ "MONGOS" ], - "readOnly" : true + "description" : "Type of the index. The default type is search.", + "enum" : [ "search", "vectorSearch" ] } }, - "title" : "Serverless Instance Private Endpoint Connection String" + "required" : [ "collectionName", "database", "name" ] }, - "ServerlessEventTypeViewAlertable" : { - "type" : "string", - "description" : "Event type that triggers an alert.", - "enum" : [ "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], - "example" : "OUTSIDE_SERVERLESS_METRIC_THRESHOLD", - "title" : "Serverless Event Types" + "SearchIndexDefinition" : { + "type" : "object", + "description" : "The search index definition set by the user.", + "title" : "Search Index Definition" + }, + "SearchIndexDefinitionVersion" : { + "type" : "object", + "description" : "Object which includes the version number of the index definition and the time that the index definition was created.", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "The time at which this index definition was created." + }, + "version" : { + "type" : "integer", + "format" : "int64", + "description" : "The version number associated with this index definition when it was created." + } + }, + "title" : "Search Index Definition Version" }, - "ServerlessInstanceDescription" : { + "SearchIndexResponse" : { "type" : "object", - "description" : "Group of settings that configure a MongoDB serverless instance.", - "properties" : { - "connectionStrings" : { - "$ref" : "#/components/schemas/ServerlessInstanceDescriptionConnectionStrings" + "discriminator" : { + "mapping" : { + "search" : "#/components/schemas/TextSearchIndexResponse", + "vectorSearch" : "#/components/schemas/VectorSearchIndexResponse" }, - "createDate" : { + "propertyName" : "type" + }, + "properties" : { + "collectionName" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", - "readOnly" : true + "description" : "Label that identifies the collection that contains one or more Atlas Search indexes." }, - "groupId" : { + "database" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the project.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "description" : "Label that identifies the database that contains the collection with one or more Atlas Search indexes." }, - "id" : { + "indexID" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the serverless instance.", + "description" : "Unique 24-hexadecimal digit string that identifies this Atlas Search index.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "pattern" : "^([a-f0-9]{24})$" }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true + "latestDefinition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" }, - "mongoDBVersion" : { - "type" : "string", - "description" : "Version of MongoDB that the serverless instance runs.", - "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", - "readOnly" : true + "latestDefinitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" }, "name" : { "type" : "string", - "description" : "Human-readable label that identifies the serverless instance.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - }, - "providerSettings" : { - "$ref" : "#/components/schemas/ServerlessProviderSettings" + "description" : "Label that identifies this index. Within each namespace, the names of all indexes must be unique." }, - "serverlessBackupOptions" : { - "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on all hosts." }, - "stateName" : { + "status" : { "type" : "string", - "description" : "Human-readable label that indicates the current operating condition of the serverless instance.", - "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], - "readOnly" : true + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] }, - "tags" : { + "statusDetail" : { "type" : "array", - "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", + "description" : "List of documents detailing index status on each host.", "items" : { - "$ref" : "#/components/schemas/ResourceTag" + "$ref" : "#/components/schemas/SearchHostStatusDetail" } }, - "terminationProtectionEnabled" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." + "type" : { + "type" : "string", + "description" : "Type of the index. The default type is search.", + "enum" : [ "search", "vectorSearch" ] } }, - "required" : [ "providerSettings" ], - "title" : "Serverless Instance Description" + "title" : "Search Index Response" }, - "ServerlessInstanceDescriptionConnectionStrings" : { + "SearchIndexUpdateRequest" : { "type" : "object", - "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", - "externalDocs" : { - "description" : "Connection string URI format.", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, "properties" : { - "privateEndpoint" : { - "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.", - "items" : { - "$ref" : "#/components/schemas/ServerlessConnectionStringsPrivateEndpointList" - }, - "readOnly" : true - }, - "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.", - "externalDocs" : { - "description" : "Connection String URI Format", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, - "readOnly" : true + "definition" : { + "type" : "object", + "description" : "The index definition to update the search index to.", + "oneOf" : [ { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + }, { + "$ref" : "#/components/schemas/VectorSearchIndexDefinition" + } ] } }, - "readOnly" : true, - "title" : "Serverless Instance Connection Strings" + "required" : [ "definition" ], + "title" : "Search Index Update Request" }, - "ServerlessInstanceDescriptionCreate" : { + "SearchMainIndexStatusDetail" : { "type" : "object", - "description" : "Settings that you can specify when you create a serverless instance.", + "description" : "Contains status information about the active index.", "properties" : { - "name" : { - "type" : "string", - "description" : "Human-readable label that identifies the serverless instance.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "writeOnly" : true - }, - "providerSettings" : { - "$ref" : "#/components/schemas/ServerlessProviderSettings" + "definition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" }, - "serverlessBackupOptions" : { - "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" }, - "stateName" : { + "message" : { "type" : "string", - "description" : "Human-readable label that indicates the current operating condition of the serverless instance.", - "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], - "readOnly" : true - }, - "tags" : { - "type" : "array", - "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", - "items" : { - "$ref" : "#/components/schemas/ResourceTag" - } + "description" : "Optional message describing an error." }, - "terminationProtectionEnabled" : { + "queryable" : { "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." + "description" : "Flag that indicates whether the index generation is queryable on the host." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] } }, - "required" : [ "name", "providerSettings" ], - "title" : "Serverless Instance Description Create" + "title" : "Search Main Index Status Detail" }, - "ServerlessInstanceDescriptionUpdate" : { + "SearchMappings" : { "type" : "object", - "description" : "Settings that you can update when you request a serverless cluster update.", + "description" : "Index specifications for the collection's fields.", "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.", - "items" : { - "$ref" : "#/components/schemas/ResourceTag" + "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/field-mapping-definition-fts#static-and-dynamic-mappings" } }, - "terminationProtectionEnabled" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." + "fields" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "One or more field specifications for the Atlas Search index. Required if **mappings.dynamic** is omitted or set to **false**.", + "externalDocs" : { + "description" : "Atlas Search Index", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "x-additionalPropertiesName" : "Field Name" + }, + "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" + }, + "x-additionalPropertiesName" : "Field Name" } }, - "title" : "Serverless Instance Description Update" + "title" : "Mappings" }, - "ServerlessMetricAlertConfigViewForNdsGroup" : { + "SearchStagedIndexStatusDetail" : { "type" : "object", - "description" : "Serverless metric alert configuration allows to select which serverless database metrics trigger alerts and how users are notified.", + "description" : "Contains status information about an index building in the background.", "properties" : { - "created" : { + "definition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" + }, + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "message" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "description" : "Optional message describing an error." }, - "enabled" : { + "queryable" : { "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + "description" : "Flag that indicates whether the index generation is queryable on the host." }, - "eventTypeName" : { - "$ref" : "#/components/schemas/ServerlessEventTypeViewAlertable" + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Search Staged Index Status Detail" + }, + "SearchSynonymMappingDefinition" : { + "type" : "object", + "description" : "Synonyms used for this full text index.", + "properties" : { + "analyzer" : { + "type" : "string", + "description" : "Specific pre-defined method chosen to apply to the synonyms to be searched.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] }, - "groupId" : { + "name" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "description" : "Label that identifies the synonym definition. Each **synonym.name** must be unique within the same index definition." }, - "id" : { + "source" : { + "$ref" : "#/components/schemas/SynonymSource" + } + }, + "required" : [ "analyzer", "name", "source" ], + "title" : "Synonym Mapping Definition" + }, + "ServerlessAWSTenantEndpoint" : { + "type" : "object", + "description" : "View for a serverless AWS tenant endpoint.", + "properties" : { + "_id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - }, - "matchers" : { - "type" : "array", - "description" : "Matching conditions for target resources.", - "items" : { - "$ref" : "#/components/schemas/AlertMatcher" - } - }, - "metricThreshold" : { - "$ref" : "#/components/schemas/ServerlessMetricThreshold" - }, - "notifications" : { - "type" : "array", - "description" : "List that contains the targets that MongoDB Cloud sends notifications.", - "items" : { - "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" - } - }, - "updated" : { + "cloudProviderEndpointId" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Unique string that identifies the private endpoint's network interface.", + "pattern" : "^vpce-[0-9a-f]{17}$", "readOnly" : true - } - }, - "required" : [ "eventTypeName", "notifications" ], - "title" : "Serverless Alert Configuration" - }, - "ServerlessMetricThreshold" : { - "type" : "object", - "description" : "Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.", - "discriminator" : { - "mapping" : { - "SERVERLESS_AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", - "SERVERLESS_AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", - "SERVERLESS_AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", - "SERVERLESS_CONNECTIONS" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricThresholdView", - "SERVERLESS_NETWORK_BYTES_IN" : "#/components/schemas/DataMetricThresholdView", - "SERVERLESS_NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricThresholdView", - "SERVERLESS_NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_OPCOUNTER_CMD" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_OPCOUNTER_QUERY" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_TOTAL_READ_UNITS" : "#/components/schemas/RPUMetricThresholdView", - "SERVERLESS_TOTAL_WRITE_UNITS" : "#/components/schemas/RPUMetricThresholdView" }, - "propertyName" : "metricName" - }, - "properties" : { - "metricName" : { + "comment" : { "type" : "string", - "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "readOnly" : true }, - "mode" : { + "endpointServiceName" : { "type" : "string", - "description" : "MongoDB Cloud computes the current metric value as an average.", - "enum" : [ "AVERAGE" ] - }, - "operator" : { - "$ref" : "#/components/schemas/Operator" - }, - "threshold" : { - "type" : "number", - "format" : "double", - "description" : "Value of metric that, when exceeded, triggers an alert." + "description" : "Unique string that identifies the Amazon Web Services (AWS) PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}", + "readOnly" : true }, - "units" : { - "type" : "string", - "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", - "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] - } - }, - "required" : [ "metricName" ], - "title" : "Serverless Metric Threshold" - }, - "ServerlessMetricUnits" : { - "type" : "string", - "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", - "enum" : [ "RPU", "THOUSAND_RPU", "MILLION_RPU", "WPU", "THOUSAND_WPU", "MILLION_WPU" ], - "example" : "RPU", - "title" : "Serverless Metric Units" - }, - "ServerlessProviderSettings" : { - "type" : "object", - "description" : "Group of cloud provider settings that configure the provisioned MongoDB serverless instance.", - "properties" : { - "backingProviderName" : { + "errorMessage" : { "type" : "string", - "description" : "Cloud service provider on which MongoDB Cloud provisioned the serverless instance.", - "enum" : [ "AWS", "AZURE", "GCP" ] + "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", + "readOnly" : true }, "providerName" : { "type" : "string", - "default" : "SERVERLESS", "description" : "Human-readable label that identifies the cloud service provider.", - "enum" : [ "SERVERLESS" ] + "enum" : [ "AWS" ], + "readOnly" : true }, - "regionName" : { + "status" : { "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/)." + "description" : "Human-readable label that indicates the current operating status of the private endpoint.", + "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true } }, - "required" : [ "backingProviderName", "regionName" ], - "title" : "Cloud Service Provider Settings for a Serverless Instance" + "title" : "AWS" }, - "ServerlessTenantCreateRequest" : { + "ServerlessAWSTenantEndpointUpdate" : { "type" : "object", - "properties" : { - "comment" : { - "type" : "string", - "description" : "Human-readable comment associated with the private endpoint.", - "maxLength" : 80, - "writeOnly" : true + "allOf" : [ { + "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" + }, { + "type" : "object", + "properties" : { + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface.", + "pattern" : "^vpce-[0-9a-f]{17}$", + "writeOnly" : true + } } - } + } ], + "description" : "Updates to a serverless AWS tenant endpoint.", + "required" : [ "providerName" ], + "title" : "AWS" }, - "ServerlessTenantEndpoint" : { + "ServerlessAzureTenantEndpoint" : { "type" : "object", - "oneOf" : [ { - "$ref" : "#/components/schemas/ServerlessAWSTenantEndpoint" - }, { - "$ref" : "#/components/schemas/ServerlessAzureTenantEndpoint" - } ], + "description" : "View for a serverless Azure tenant endpoint.", "properties" : { "_id" : { "type" : "string", @@ -46928,7 +48098,8 @@ }, "cloudProviderEndpointId" : { "type" : "string", - "description" : "Unique string that identifies the private endpoint's network interface.", + "description" : "Unique string that identifies the Azure private endpoint's network interface that someone added to this private endpoint service.", + "pattern" : "^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\\.Network/privateEndpoints/[-\\w._()]+$", "readOnly" : true }, "comment" : { @@ -46939,8 +48110,8 @@ }, "endpointServiceName" : { "type" : "string", - "description" : "Unique string that identifies the PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", - "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}|pls_[0-9a-f]{24}$", + "description" : "Unique string that identifies the Azure private endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^pls_[0-9a-f]{24}$", "readOnly" : true }, "errorMessage" : { @@ -46948,112 +48119,113 @@ "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", "readOnly" : true }, - "status" : { + "privateEndpointIpAddress" : { "type" : "string", - "description" : "Human-readable label that indicates the current operating status of the private endpoint.", - "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", "readOnly" : true - } - } - }, - "ServerlessTenantEndpointUpdate" : { - "type" : "object", - "description" : "Update view for a serverless tenant endpoint.", - "discriminator" : { - "mapping" : { - "AWS" : "#/components/schemas/ServerlessAWSTenantEndpointUpdate", - "AZURE" : "#/components/schemas/ServerlessAzureTenantEndpointUpdate" }, - "propertyName" : "providerName" - }, - "properties" : { - "comment" : { + "privateLinkServiceResourceId" : { "type" : "string", - "description" : "Human-readable comment associated with the private endpoint.", - "maxLength" : 80, - "writeOnly" : true + "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 provider of the tenant endpoint.", - "enum" : [ "AWS", "AZURE" ], - "writeOnly" : true + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "AZURE" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating status of the private endpoint.", + "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true } }, - "required" : [ "providerName" ] - }, - "ServiceAccountEventTypeViewForNdsGroup" : { - "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" ], - "title" : "Service Account Event Types" - }, - "ServiceAccountEventTypeViewForOrg" : { - "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" ], - "title" : "Service Account Event Types" + "title" : "Azure" }, - "ServiceAccountGroup" : { + "ServerlessAzureTenantEndpointUpdate" : { "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "allOf" : [ { + "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" + }, { + "type" : "object", + "properties" : { + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure private endpoint's network interface for this private endpoint service.", + "pattern" : "^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\\.Network/privateEndpoints/[-\\w._()]+$", + "writeOnly" : true + }, + "privateEndpointIpAddress" : { + "type" : "string", + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "writeOnly" : true + } } - } + } ], + "description" : "Updates to a serverless Azure tenant endpoint.", + "required" : [ "providerName" ], + "title" : "AZURE" }, - "ServiceAccountGroupEvents" : { + "ServerlessBackupRestoreJob" : { "type" : "object", - "description" : "Service Account event identifies different activities around user api keys.", "properties" : { - "apiKeyId" : { + "cancelled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone canceled this restore job.", + "readOnly" : true + }, + "deliveryType" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "description" : "Human-readable label that categorizes the restore job to create.", + "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\"`.", + "items" : { + "type" : "string", + "description" : "One Uniform Resource Locator that points to the compressed snapshot files for manual download." + }, "readOnly" : true }, - "created" : { + "desiredTimestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "expired" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job expired.", + "readOnly" : true + }, + "expiresAt" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Date and time when the restore job expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "eventTypeName" : { - "$ref" : "#/components/schemas/ServiceAccountEventTypeViewForNdsGroup" + "failed" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job failed.", + "readOnly" : true }, - "groupId" : { + "finishedAt" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "format" : "date-time", + "description" : "Date and time when the restore job completed. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "description" : "Unique 24-hexadecimal character string that identifies the restore job.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "isGlobalAdmin" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", - "readOnly" : true - }, "links" : { "type" : "array", "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", @@ -47066,98 +48238,87 @@ }, "readOnly" : true }, - "orgId" : { + "oplogInc" : { + "type" : "integer", + "format" : "int32", + "description" : "Oplog operation number from which you want to restore this snapshot. This number represents the second part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", + "example" : 1, + "minimum" : 1 + }, + "oplogTs" : { + "type" : "integer", + "format" : "int32", + "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`.", + "minimum" : 1199145600 + }, + "pointInTimeUTCSeconds" : { + "type" : "integer", + "format" : "int32", + "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`.", + "minimum" : 1199145600 + }, + "snapshotId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "publicKey" : { - "type" : "string", - "format" : "email", - "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "example" : "test.user@mongodb.com", - "readOnly" : true - }, - "raw" : { - "$ref" : "#/components/schemas/raw" + "pattern" : "^([a-f0-9]{24})$" }, - "remoteAddress" : { + "targetClusterName" : { "type" : "string", - "description" : "IPv4 or IPv6 address from which the user triggered this event.", - "example" : "216.172.40.186", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", - "readOnly" : true + "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\"`.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, - "userId" : { + "targetGroupId" : { "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.", + "description" : "Unique 24-hexadecimal digit string that identifies the target project for the specified **targetClusterName**.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "pattern" : "^([a-f0-9]{24})$" }, - "username" : { + "timestamp" : { "type" : "string", - "format" : "email", - "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", - "example" : "test.user@mongodb.com", + "format" : "date-time", + "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.", "readOnly" : true } }, - "required" : [ "created", "eventTypeName", "id" ], - "title" : "ServiceAccount Events" + "required" : [ "deliveryType", "targetClusterName", "targetGroupId" ] }, - "ServiceAccountOrgEvents" : { + "ServerlessBackupSnapshot" : { "type" : "object", - "description" : "Service Account event identifies different activities around user api keys.", "properties" : { - "apiKeyId" : { + "createdAt" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "created" : { + "expiresAt" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "eventTypeName" : { - "$ref" : "#/components/schemas/ServiceAccountEventTypeViewForOrg" - }, - "groupId" : { + "frequencyType" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "description" : "Human-readable label that identifies how often this snapshot triggers.", + "enum" : [ "hourly", "daily", "weekly", "monthly" ], "readOnly" : true }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "isGlobalAdmin" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", - "readOnly" : true - }, "links" : { "type" : "array", "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", @@ -47170,332 +48331,278 @@ }, "readOnly" : true }, - "orgId" : { + "mongodVersion" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "description" : "Version of the MongoDB host that this snapshot backs up.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", "readOnly" : true }, - "publicKey" : { + "serverlessInstanceName" : { "type" : "string", - "format" : "email", - "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "example" : "test.user@mongodb.com", + "description" : "Human-readable label given to the serverless instance from which MongoDB Cloud took this snapshot.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, - "raw" : { - "$ref" : "#/components/schemas/raw" - }, - "remoteAddress" : { + "snapshotType" : { "type" : "string", - "description" : "IPv4 or IPv6 address from which the user triggered this event.", - "example" : "216.172.40.186", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "description" : "Human-readable label that identifies when this snapshot triggers.", + "enum" : [ "onDemand", "scheduled" ], "readOnly" : true }, - "userId" : { + "status" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", + "enum" : [ "queued", "inProgress", "completed", "failed" ], "readOnly" : true }, - "username" : { - "type" : "string", - "format" : "email", - "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", - "example" : "test.user@mongodb.com", + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of bytes taken to store the backup snapshot.", "readOnly" : true } - }, - "required" : [ "created", "eventTypeName", "id" ], - "title" : "ServiceAccount Events" + } }, - "ServiceAccountSecret" : { + "ServerlessConnectionStringsPrivateEndpointItem" : { "type" : "object", + "description" : "Details of a private endpoint deployed for this serverless instance.", "properties" : { - "createdAt" : { + "endpointId" : { "type" : "string", - "format" : "date-time", - "description" : "Timestamp representing creation time.", + "description" : "Unique string that the cloud provider uses to identify the private endpoint.", "readOnly" : true }, - "expiresAt" : { + "providerName" : { "type" : "string", - "format" : "date-time", - "description" : "Timestamp representing secret expiration time.", + "description" : "Cloud provider where the private endpoint is deployed.", + "enum" : [ "AWS", "AZURE" ], "readOnly" : true }, - "id" : { + "region" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the secret.", - "example" : "32b6e34b3d91647abb20e7b8", - "pattern" : "^([a-f0-9]{24})$", + "description" : "Region where the private endpoint is deployed.", "readOnly" : true - }, - "lastUsedAt" : { - "type" : "string", - "format" : "date-time", - "description" : "Timestamp representing last secret usage.", + } + }, + "title" : "Serverless Instance Private Endpoint Connection Strings Endpoint" + }, + "ServerlessConnectionStringsPrivateEndpointList" : { + "type" : "object", + "description" : "Private endpoint connection string that you can use to connect to this serverless instance through a private endpoint.", + "externalDocs" : { + "description" : "Private Endpoint for Serverless Instance", + "url" : "https://docs.atlas.mongodb.com/security-serverless-private-endpoint/" + }, + "properties" : { + "endpoints" : { + "type" : "array", + "description" : "List that contains the private endpoints through which you connect to MongoDB Cloud when you use **connectionStrings.privateEndpoint[n].srvConnectionString**.", + "items" : { + "$ref" : "#/components/schemas/ServerlessConnectionStringsPrivateEndpointItem" + }, "readOnly" : true }, - "maskedSecretValue" : { + "srvConnectionString" : { "type" : "string", - "description" : "Service Account secret with masked values of the first 20 characters.", - "example" : "mdb_ic_sk_...12ce", + "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 }, - "secret" : { + "type" : { "type" : "string", - "description" : "Secret for the service account. It will be returned only the first time after service account creation.", - "pattern" : "^mdb_sa_sk_[0-9a-zA-Z]{40}$", + "description" : "MongoDB process type to which your application connects.", + "enum" : [ "MONGOS" ], "readOnly" : true } }, - "required" : [ "createdAt", "expiresAt", "id" ] + "title" : "Serverless Instance Private Endpoint Connection String" }, - "ServiceAccountSecretRequest" : { - "type" : "object", - "properties" : { - "secretExpiresAfterHours" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of hours representing validity duration for secret." - } - }, - "required" : [ "secretExpiresAfterHours" ] + "ServerlessEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], + "example" : "OUTSIDE_SERVERLESS_METRIC_THRESHOLD", + "title" : "Serverless Event Types" }, - "ShardEntry" : { + "ServerlessInstanceDescription" : { "type" : "object", - "description" : "Sharding configuration for a collection to be sharded on the destination cluster.", + "description" : "Group of settings that configure a MongoDB serverless instance.", "properties" : { - "collection" : { + "connectionStrings" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescriptionConnectionStrings" + }, + "createDate" : { "type" : "string", - "description" : "Human-readable label that identifies the collection to be sharded on the destination cluster.", - "writeOnly" : true + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true }, - "database" : { + "groupId" : { "type" : "string", - "description" : "Human-readable label that identifies the database that contains the collection to be sharded on the destination cluster.", - "writeOnly" : true + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "shardCollection" : { - "$ref" : "#/components/schemas/ShardKeys" - } - }, - "required" : [ "collection", "database", "shardCollection" ] - }, - "ShardKeys" : { - "type" : "object", - "description" : "Document that configures the shard key on the destination cluster.", - "properties" : { - "key" : { - "type" : "array", - "description" : "List of fields to use for the shard key.", - "items" : { - "type" : "object", - "additionalProperties" : { - "type" : "object" - } - }, - "uniqueItems" : true, - "writeOnly" : true - } - }, - "writeOnly" : true - }, - "ShardingRequest" : { - "type" : "object", - "description" : "Document that configures sharding on the destination cluster when migrating from a replica set source to a sharded cluster destination on MongoDB 6.0 or higher. If you don't wish to shard any collections on the destination cluster, leave this empty.", - "properties" : { - "createSupportingIndexes" : { - "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 + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the serverless instance.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "shardingEntries" : { + "links" : { "type" : "array", - "description" : "List of shard configurations to shard destination collections. Atlas shards only those collections that you include in the sharding entries array.", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, "items" : { - "$ref" : "#/components/schemas/ShardEntry" + "$ref" : "#/components/schemas/Link" }, - "uniqueItems" : true, - "writeOnly" : true - } - }, - "required" : [ "createSupportingIndexes" ], - "writeOnly" : true - }, - "Slack" : { - "type" : "object", - "description" : "Details to integrate one Slack account with one MongoDB Cloud project.", - "properties" : { - "apiToken" : { + "readOnly" : true + }, + "mongoDBVersion" : { "type" : "string", - "description" : "Key that allows MongoDB Cloud to access your Slack account.\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.\n\n**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" + "description" : "Version of MongoDB that the serverless instance runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true }, - "channelName" : { + "name" : { "type" : "string", - "description" : "Name of the Slack channel to which MongoDB Cloud sends alert notifications.", - "example" : "alerts", - "maxLength" : 80, + "description" : "Human-readable label that identifies the serverless instance.", + "maxLength" : 64, "minLength" : 1, - "nullable" : true + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, - "id" : { - "type" : "string", - "description" : "Integration id.", - "nullable" : true + "providerSettings" : { + "$ref" : "#/components/schemas/ServerlessProviderSettings" }, - "teamName" : { - "type" : "string", - "description" : "Human-readable label that identifies your Slack team. Set this parameter when you configure a legacy Slack integration.", - "example" : "MongoDB" + "serverlessBackupOptions" : { + "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" }, - "type" : { + "stateName" : { "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" : "Human-readable label that indicates the current operating condition of the serverless instance.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." } }, - "required" : [ "apiToken", "channelName" ], - "title" : "SLACK" + "required" : [ "providerSettings" ], + "title" : "Serverless Instance Description" }, - "SlackNotification" : { + "ServerlessInstanceDescriptionConnectionStrings" : { "type" : "object", - "description" : "Slack notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, "properties" : { - "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", - "format" : "int32", - "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." - }, - "integrationId" : { - "type" : "string", - "description" : "The id of the associated integration, the credentials of which to use for requests.", - "example" : "32b6e34b3d91647abb20e7b8" - }, - "intervalMin" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", - "minimum" : 5 - }, - "notifierId" : { - "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" + "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.", + "items" : { + "$ref" : "#/components/schemas/ServerlessConnectionStringsPrivateEndpointList" + }, + "readOnly" : true }, - "typeName" : { + "standardSrv" : { "type" : "string", - "description" : "Human-readable label that displays the alert notification type.", - "enum" : [ "SLACK" ] + "description" : "Public connection string that you can use to connect to this serverless instance. This connection string uses the `mongodb+srv://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true } }, - "required" : [ "typeName" ], - "title" : "Slack Notification" + "readOnly" : true, + "title" : "Serverless Instance Connection Strings" }, - "Source" : { + "ServerlessInstanceDescriptionCreate" : { "type" : "object", - "description" : "Document that describes the source of the migration.", + "description" : "Settings that you can specify when you create a serverless instance.", "properties" : { - "caCertificatePath" : { + "name" : { "type" : "string", - "description" : "Path to the CA certificate that signed SSL certificates use to authenticate to the source cluster." + "description" : "Human-readable label that identifies the serverless instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "writeOnly" : true }, - "clusterName" : { - "type" : "string", - "description" : "Label that identifies the source cluster name." + "providerSettings" : { + "$ref" : "#/components/schemas/ServerlessProviderSettings" }, - "groupId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the source project.", - "example" : "9b43a5b329223c3a1591a678", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" + "serverlessBackupOptions" : { + "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" }, - "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." + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the serverless instance.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true }, - "password" : { - "type" : "string", - "description" : "Password that authenticates the username to the source cluster.", - "writeOnly" : true + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } }, - "ssl" : { + "terminationProtectionEnabled" : { "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 - } - }, - "required" : [ "clusterName", "groupId", "managedAuthentication", "ssl" ] - }, - "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/" + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." } }, - "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/" - } + "required" : [ "name", "providerSettings" ], + "title" : "Serverless Instance Description Create" }, - "StreamConfig" : { + "ServerlessInstanceDescriptionUpdate" : { "type" : "object", - "description" : "Configuration options for an Atlas Stream Processing Instance.", - "nullable" : true, + "description" : "Settings that you can update when you request a serverless cluster update.", "properties" : { - "links" : { + "serverlessBackupOptions" : { + "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" + }, + "tags" : { "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true + "$ref" : "#/components/schemas/ResourceTag" + } }, - "tier" : { - "type" : "string", - "description" : "Selected tier for the Stream Instance. Configures Memory / VCPU allowances.", - "enum" : [ "SP30", "SP10" ], - "title" : "Stream Instance Tier" + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." } - } + }, + "title" : "Serverless Instance Description Update" }, - "StreamProcessorAlertConfigViewForNdsGroup" : { + "ServerlessMetricAlertConfigViewForNdsGroup" : { "type" : "object", - "description" : "Host metric alert configuration allows to select which Atlas streams processors trigger alerts and how users are notified.", + "description" : "Serverless metric alert configuration allows to select which serverless database metrics trigger alerts and how users are notified.", "properties" : { "created" : { "type" : "string", @@ -47509,7 +48616,7 @@ "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." }, "eventTypeName" : { - "$ref" : "#/components/schemas/StreamProcessorEventTypeViewAlertable" + "$ref" : "#/components/schemas/ServerlessEventTypeViewAlertable" }, "groupId" : { "type" : "string", @@ -47543,11 +48650,14 @@ }, "matchers" : { "type" : "array", - "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration.", + "description" : "Matching conditions for target resources.", "items" : { - "$ref" : "#/components/schemas/StreamsMatcher" + "$ref" : "#/components/schemas/AlertMatcher" } }, + "metricThreshold" : { + "$ref" : "#/components/schemas/ServerlessMetricThreshold" + }, "notifications" : { "type" : "array", "description" : "List that contains the targets that MongoDB Cloud sends notifications.", @@ -47563,157 +48673,215 @@ } }, "required" : [ "eventTypeName", "notifications" ], - "title" : "Stream Processor Alert Configuration" + "title" : "Serverless Alert Configuration" }, - "StreamProcessorAlertViewForNdsGroup" : { + "ServerlessMetricThreshold" : { "type" : "object", - "description" : "Stream Processor alert notifies about activities on Stream Processor in AtlasStreams.", + "description" : "Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.", + "discriminator" : { + "mapping" : { + "SERVERLESS_AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_CONNECTIONS" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_BYTES_IN" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_CMD" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_QUERY" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_TOTAL_READ_UNITS" : "#/components/schemas/RPUMetricThresholdView", + "SERVERLESS_TOTAL_WRITE_UNITS" : "#/components/schemas/RPUMetricThresholdView" + }, + "propertyName" : "metricName" + }, "properties" : { - "acknowledgedUntil" : { + "metricName" : { "type" : "string", - "format" : "date-time", - "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.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." }, - "acknowledgementComment" : { + "mode" : { "type" : "string", - "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", - "example" : "Expiration on 3/19. Silencing for 7days.", - "maxLength" : 200 + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] }, - "acknowledgingUsername" : { + "operator" : { "type" : "string", - "format" : "email", - "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", - "readOnly" : true + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, - "alertConfigId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." }, - "created" : { + "units" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true - }, - "eventTypeName" : { - "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroupAlertable" - }, - "groupId" : { + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] + } + }, + "required" : [ "metricName" ], + "title" : "Serverless Metric Threshold" + }, + "ServerlessMetricUnits" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "RPU", "THOUSAND_RPU", "MILLION_RPU", "WPU", "THOUSAND_WPU", "MILLION_WPU" ], + "example" : "RPU", + "title" : "Serverless Metric Units" + }, + "ServerlessProviderSettings" : { + "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB serverless instance.", + "properties" : { + "backingProviderName" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "description" : "Cloud service provider on which MongoDB Cloud provisioned the serverless instance.", + "enum" : [ "AWS", "AZURE", "GCP" ] }, - "id" : { + "providerName" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies this alert.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "default" : "SERVERLESS", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "SERVERLESS" ] }, - "instanceName" : { + "regionName" : { "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.", - "example" : "foobar", - "readOnly" : true - }, - "lastNotified" : { + "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/)." + } + }, + "required" : [ "backingProviderName", "regionName" ], + "title" : "Cloud Service Provider Settings for a Serverless Instance" + }, + "ServerlessTenantCreateRequest" : { + "type" : "object", + "properties" : { + "comment" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", - "readOnly" : true - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - }, - "orgId" : { + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "writeOnly" : true + } + } + }, + "ServerlessTenantEndpoint" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/ServerlessAWSTenantEndpoint" + }, { + "$ref" : "#/components/schemas/ServerlessAzureTenantEndpoint" + } ], + "properties" : { + "_id" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "processorErrorMsg" : { + "cloudProviderEndpointId" : { "type" : "string", - "description" : "The error message associated with the Stream Processor to which this alert applies.", - "example" : "MongoServerError: Failed to start stream processor: (Location77175) Could not connect to the Kafka topic with kafka error code: -195, message: Local: Broker transport failure.: (Location77175)", + "description" : "Unique string that identifies the private endpoint's network interface.", "readOnly" : true }, - "processorName" : { + "comment" : { "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.", - "example" : "foobar", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, "readOnly" : true }, - "processorState" : { + "endpointServiceName" : { "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.", - "example" : "STARTED", + "description" : "Unique string that identifies the PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}|pls_[0-9a-f]{24}$", "readOnly" : true }, - "resolved" : { + "errorMessage" : { "type" : "string", - "format" : "date-time", - "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\"`.", + "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", "readOnly" : true }, "status" : { "type" : "string", - "description" : "State of this alert at the time you requested its details.", - "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], - "example" : "OPEN", + "description" : "Human-readable label that indicates the current operating status of the private endpoint.", + "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], "readOnly" : true + } + } + }, + "ServerlessTenantEndpointUpdate" : { + "type" : "object", + "description" : "Update view for a serverless tenant endpoint.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/ServerlessAWSTenantEndpointUpdate", + "AZURE" : "#/components/schemas/ServerlessAzureTenantEndpointUpdate" }, - "updated" : { + "propertyName" : "providerName" + }, + "properties" : { + "comment" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "writeOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider of the tenant endpoint.", + "enum" : [ "AWS", "AZURE" ], + "writeOnly" : true } }, - "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], - "title" : "Stream Processor Alerts" + "required" : [ "providerName" ] }, - "StreamProcessorEventTypeViewAlertable" : { + "ServiceAccountEventTypeViewForNdsGroup" : { "type" : "string", - "description" : "Event type that triggers an alert.", - "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], - "example" : "STREAM_PROCESSOR_STATE_IS_FAILED", - "title" : "Stream Processor Event Types" + "description" : "Unique identifier of event type.", + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" }, - "StreamProcessorEventTypeViewForNdsGroup" : { + "ServiceAccountEventTypeViewForOrg" : { "type" : "string", "description" : "Unique identifier of event type.", - "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], - "example" : "STREAM_PROCESSOR_STATE_IS_FAILED", - "title" : "Stream Processor Event Types" + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" }, - "StreamProcessorEventViewForNdsGroup" : { + "ServiceAccountGroup" : { "type" : "object", - "description" : "Stream Processor event identifies different activities about a stream processor in Atlas Streams.", "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies your project. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "ServiceAccountGroupEvents" : { + "type" : "object", + "description" : "Service Account event identifies different activities around user api keys.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, "created" : { "type" : "string", "format" : "date-time", @@ -47721,7 +48889,7 @@ "readOnly" : true }, "eventTypeName" : { - "$ref" : "#/components/schemas/StreamProcessorEventTypeViewForNdsGroup" + "$ref" : "#/components/schemas/ServiceAccountEventTypeViewForNdsGroup" }, "groupId" : { "type" : "string", @@ -47741,10 +48909,10 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "instanceName" : { - "type" : "string", - "description" : "Name of the stream processing instance associated with the event.", - "example" : "foobar", + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", "readOnly" : true }, "links" : { @@ -47768,159 +48936,96 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "processorErrorMsg" : { - "type" : "string", - "description" : "Error message linked to the stream processor associated with the event.", - "example" : "invalid auth", - "readOnly" : true - }, - "processorName" : { - "type" : "string", - "description" : "Name of the stream processor associated with the event.", - "example" : "foobar", - "readOnly" : true - }, - "processorState" : { + "publicKey" : { "type" : "string", - "description" : "State of the stream processor associated with the event.", - "example" : "FAILED", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true }, "raw" : { "$ref" : "#/components/schemas/raw" - } - }, - "required" : [ "created", "eventTypeName", "id" ], - "title" : "Stream Processor Events" - }, - "StreamsClusterConnection" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/StreamsConnection" - }, { - "type" : "object", - "properties" : { - "clusterName" : { - "type" : "string", - "description" : "Name of the cluster configured for this connection." - }, - "dbRoleToExecute" : { - "$ref" : "#/components/schemas/DBRoleToExecute" - } - } - } ] - }, - "StreamsConnection" : { - "type" : "object", - "description" : "Settings that define a connection to an external data store.", - "discriminator" : { - "mapping" : { - "Cluster" : "#/components/schemas/StreamsClusterConnection", - "Kafka" : "#/components/schemas/StreamsKafkaConnection", - "Sample" : "#/components/schemas/StreamsSampleConnection" }, - "propertyName" : "type" - }, - "oneOf" : [ { - "$ref" : "#/components/schemas/StreamsSampleConnection" - }, { - "$ref" : "#/components/schemas/StreamsClusterConnection" - }, { - "$ref" : "#/components/schemas/StreamsKafkaConnection" - } ], - "properties" : { - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", "readOnly" : true }, - "name" : { + "userId" : { "type" : "string", - "description" : "Human-readable label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source." + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "type" : { + "username" : { "type" : "string", - "description" : "Type of the connection. Can be either Cluster or Kafka.", - "enum" : [ "Kafka", "Cluster", "Sample" ] + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true } }, - "readOnly" : true + "required" : [ "created", "eventTypeName", "id" ], + "title" : "ServiceAccount Events" }, - "StreamsDLQ" : { + "ServiceAccountIPAccessListEntry" : { "type" : "object", - "description" : "Dead letter queue for the stream processor.", "properties" : { - "coll" : { + "cidrBlock" : { "type" : "string", - "description" : "Name of the collection that will be used for the DLQ." + "description" : "Range of network addresses in the access list for the Service Account. This parameter requires the range to be expressed in Classless Inter-Domain Routing (CIDR) notation of Internet Protocol version 4 or version 6 addresses. You can set a value for this parameter or **ipAddress**, but not for both in the same request.", + "example" : "203.0.113.0/24", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" }, - "connectionName" : { + "createdAt" : { "type" : "string", - "description" : "Connection name that will be used to write DLQ messages to. Has to be an Atlas connection." + "format" : "date-time", + "description" : "Date MongoDB Cloud added the entry was added to the Access List.", + "readOnly" : true }, - "db" : { + "ipAddress" : { "type" : "string", - "description" : "Name of the database that will be used for the DLQ." + "description" : "Network address in the access list for the Service Account. This parameter requires the address to be expressed as one Internet Protocol version 4 or version 6 address. You can set a value for this parameter or **cidrBlock**, but not for both in the same request.", + "example" : "203.0.113.10", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - } - } - }, - "StreamsDataProcessRegion" : { - "type" : "object", - "description" : "Information about the cloud provider region in which MongoDB Cloud processes the stream.", - "properties" : { - "cloudProvider" : { + "lastUsedAddress" : { "type" : "string", - "description" : "Label that identifies the cloud service provider where MongoDB Cloud performs stream processing. Currently, this parameter supports AWS only.", - "enum" : [ "AWS", "GCP", "AZURE", "TENANT", "SERVERLESS" ] + "description" : "Network address that issued the most recent request to the API. This parameter requires the address to be expressed as one Internet Protocol version 4 or version 6 address. The resource returns this parameter after this IP address makes at least one request.", + "readOnly" : true }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, + "lastUsedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date when MongoDB Cloud received the most recent request that originated from this Internet Protocol version 4 or version 6 address. The resource returns this parameter when at least one request originates from this IP address. MongoDB Cloud updates this parameter each time a client accesses the permitted resource, with a delay of up to 5 minutes.", "readOnly" : true }, - "region" : { - "$ref" : "#/components/schemas/BaseStreamsRegion" + "requestCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of requests that has originated from this network address.", + "readOnly" : true } - }, - "required" : [ "cloudProvider", "region" ] - }, - "StreamsEventTypeViewForNdsGroup" : { - "type" : "string", - "description" : "Unique identifier of event type.", - "enum" : [ "MAX_PROCESSOR_COUNT_REACHED" ], - "example" : "MAX_PROCESSOR_COUNT_REACHED", - "title" : "Streams Event Types" + } }, - "StreamsEventViewForNdsGroup" : { + "ServiceAccountOrgEvents" : { "type" : "object", - "description" : "Streams event identifies different activities about Atlas Streams.", + "description" : "Service Account event identifies different activities around user api keys.", "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, "created" : { "type" : "string", "format" : "date-time", @@ -47928,7 +49033,7 @@ "readOnly" : true }, "eventTypeName" : { - "$ref" : "#/components/schemas/StreamsEventTypeViewForNdsGroup" + "$ref" : "#/components/schemas/ServiceAccountEventTypeViewForOrg" }, "groupId" : { "type" : "string", @@ -47948,10 +49053,10 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "instanceName" : { - "type" : "string", - "description" : "Name of the stream processing instance associated with the event.", - "example" : "foobar", + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", "readOnly" : true }, "links" : { @@ -47975,387 +49080,217 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, "raw" : { "$ref" : "#/components/schemas/raw" - } - }, - "required" : [ "created", "eventTypeName", "id" ], - "title" : "Streams Events" - }, - "StreamsKafkaAuthentication" : { - "type" : "object", - "description" : "User credentials required to connect to a Kafka Cluster. Includes the authentication type, as well as the parameters for that authentication mode.", - "properties" : { - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true }, - "mechanism" : { + "remoteAddress" : { "type" : "string", - "description" : "Style of authentication. Can be one of PLAIN, SCRAM-256, or SCRAM-512." + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true }, - "password" : { + "userId" : { "type" : "string", - "format" : "password", - "description" : "Password of the account to connect to the Kafka cluster.", - "writeOnly" : true + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, "username" : { "type" : "string", - "description" : "Username of the account to connect to the Kafka cluster." - } - } - }, - "StreamsKafkaConnection" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/StreamsConnection" - }, { - "type" : "object", - "properties" : { - "authentication" : { - "$ref" : "#/components/schemas/StreamsKafkaAuthentication" - }, - "bootstrapServers" : { - "type" : "string", - "description" : "Comma separated list of server addresses." - }, - "config" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "description" : "A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.", - "example" : "{\"group.protocol.type\":\"consumer\",\"debug\":\"queue, msg, protocol\"}" - }, - "description" : "A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.", - "example" : { - "debug" : "queue, msg, protocol", - "group.protocol.type" : "consumer" - } - }, - "networking" : { - "$ref" : "#/components/schemas/StreamsKafkaNetworking" - }, - "proxyInfo" : { - "$ref" : "#/components/schemas/ProxyInfo" - }, - "security" : { - "$ref" : "#/components/schemas/StreamsKafkaSecurity" - } - } - } ] - }, - "StreamsKafkaNetworking" : { - "type" : "object", - "description" : "Networking Access Type can either be 'PUBLIC' (default) or VPC. VPC type is in public preview, please file a support ticket to enable VPC Network Access", - "properties" : { - "access" : { - "$ref" : "#/components/schemas/StreamsKafkaNetworkingAccess" - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true } - } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "ServiceAccount Events" }, - "StreamsKafkaNetworkingAccess" : { + "ServiceAccountSecret" : { "type" : "object", - "description" : "Information about the networking access.", "properties" : { - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "The date that the secret was created on.", "readOnly" : true }, - "name" : { + "expiresAt" : { "type" : "string", - "description" : "Id of the vpc peer when the type is VPC." + "format" : "date-time", + "description" : "The date for the expiration of the secret.", + "readOnly" : true }, - "type" : { + "id" : { "type" : "string", - "description" : "Selected networking type. Either PUBLIC or VPC. Defaults to PUBLIC", - "enum" : [ "PUBLIC", "VPC" ], - "title" : "Networking Access Type" - } - } - }, - "StreamsKafkaSecurity" : { - "type" : "object", - "description" : "Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use.", - "properties" : { - "brokerPublicCertificate" : { + "description" : "Unique 24-hexadecimal digit string that identifies the secret.", + "example" : "32b6e34b3d91647abb20e7b8", + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastUsedAt" : { "type" : "string", - "description" : "A trusted, public x509 certificate for connecting to Kafka over SSL." + "format" : "date-time", + "description" : "The last time the secret was used.", + "readOnly" : true }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, + "maskedSecretValue" : { + "type" : "string", + "description" : "The masked Service Account secret.", + "example" : "mdb_ic_sk_...12ce", "readOnly" : true }, - "protocol" : { + "secret" : { "type" : "string", - "description" : "Describes the transport type. Can be either PLAINTEXT or SSL." + "description" : "The secret for the Service Account. It will be returned only the first time after creation.", + "pattern" : "^mdb_sa_sk_[0-9a-zA-Z_-]{40}$", + "readOnly" : true } - } + }, + "required" : [ "createdAt", "expiresAt", "id" ] }, - "StreamsMatcher" : { + "ServiceAccountSecretRequest" : { "type" : "object", - "description" : "Rules to apply when comparing a stream processing instance or stream processor against this alert configuration.", "properties" : { - "fieldName" : { - "$ref" : "#/components/schemas/StreamsMatcherField" - }, - "operator" : { + "secretExpiresAfterHours" : { + "type" : "integer", + "format" : "int32", + "description" : "The expiration time of the new Service Account secret. The expiration is provided in hours." + } + }, + "required" : [ "secretExpiresAfterHours" ] + }, + "ShardEntry" : { + "type" : "object", + "description" : "Sharding configuration for a collection to be sharded on the destination cluster.", + "properties" : { + "collection" : { "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" ] + "description" : "Human-readable label that identifies the collection to be sharded on the destination cluster.", + "writeOnly" : true }, - "value" : { + "database" : { "type" : "string", - "description" : "Value to match or exceed using the specified **matchers.operator**.", - "example" : "event-replica-set" + "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" } }, - "required" : [ "fieldName", "operator", "value" ], - "title" : "Matchers" - }, - "StreamsMatcherField" : { - "type" : "string", - "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", - "enum" : [ "INSTANCE_NAME", "PROCESSOR_NAME" ], - "example" : "INSTANCE_NAME", - "title" : "Streams Matcher Fields" + "required" : [ "collection", "database", "shardCollection" ] }, - "StreamsOptions" : { + "ShardKeys" : { "type" : "object", - "description" : "Optional configuration for the stream processor.", + "description" : "Document that configures the shard key on the destination cluster.", "properties" : { - "dlq" : { - "$ref" : "#/components/schemas/StreamsDLQ" - }, - "links" : { + "key" : { "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, + "description" : "List of fields to use for the shard key.", "items" : { - "$ref" : "#/components/schemas/Link" + "type" : "object", + "additionalProperties" : { + "type" : "object" + } }, - "readOnly" : true + "uniqueItems" : true, + "writeOnly" : true } - } + }, + "writeOnly" : true }, - "StreamsProcessor" : { + "ShardingRequest" : { "type" : "object", - "description" : "An atlas stream processor.", + "description" : "Document that configures sharding on the destination cluster when migrating from a replica set source to a sharded cluster destination on MongoDB 6.0 or higher. If you don't wish to shard any collections on the destination cluster, leave this empty.", "properties" : { - "_id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the stream processor.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "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 }, - "links" : { + "shardingEntries" : { "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, + "description" : "List of shard configurations to shard destination collections. Atlas shards only those collections that you include in the sharding entries array.", "items" : { - "$ref" : "#/components/schemas/Link" + "$ref" : "#/components/schemas/ShardEntry" }, - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "Human-readable name of the stream processor." - }, - "options" : { - "$ref" : "#/components/schemas/StreamsOptions" - }, - "pipeline" : { - "type" : "array", - "description" : "Stream aggregation pipeline you want to apply to your streaming data.", - "items" : { - "$ref" : "#/components/schemas/Document" - } + "uniqueItems" : true, + "writeOnly" : true } - } + }, + "required" : [ "createSupportingIndexes" ], + "writeOnly" : true }, - "StreamsProcessorWithStats" : { + "Slack" : { "type" : "object", - "description" : "An atlas stream processor with optional stats.", + "description" : "Details to integrate one Slack account with one MongoDB Cloud project.", "properties" : { - "_id" : { + "apiToken" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the stream processor.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true + "description" : "Key that allows MongoDB Cloud to access your Slack account.\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.\n\n**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" }, - "name" : { + "channelName" : { "type" : "string", - "description" : "Human-readable name of the stream processor.", - "readOnly" : true + "description" : "Name of the Slack channel to which MongoDB Cloud sends alert notifications.", + "example" : "alerts", + "maxLength" : 80, + "minLength" : 1, + "nullable" : true }, - "pipeline" : { - "type" : "array", - "description" : "Stream aggregation pipeline you want to apply to your streaming data.", - "items" : { - "$ref" : "#/components/schemas/Document" - }, - "readOnly" : true + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true }, - "state" : { + "teamName" : { "type" : "string", - "description" : "The state of the stream processor.", - "readOnly" : true + "description" : "Human-readable label that identifies your Slack team. Set this parameter when you configure a legacy Slack integration.", + "example" : "MongoDB" }, - "stats" : { - "type" : "object", - "additionalProperties" : { - "type" : "object", - "description" : "The stats associated with the stream processor.", - "readOnly" : true - }, - "description" : "The stats associated with the stream processor.", - "readOnly" : 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" : [ "SLACK" ] } }, - "required" : [ "_id", "name", "pipeline", "state" ] - }, - "StreamsSampleConnection" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/StreamsConnection" - } ] + "required" : [ "apiToken", "channelName" ], + "title" : "SLACK" }, - "StreamsTenant" : { + "SlackNotification" : { "type" : "object", + "description" : "Slack notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", "properties" : { - "_id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the project.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "connections" : { - "type" : "array", - "description" : "List of connections configured in the stream instance.", - "items" : { - "$ref" : "#/components/schemas/StreamsConnection" - }, - "readOnly" : true - }, - "dataProcessRegion" : { - "$ref" : "#/components/schemas/StreamsDataProcessRegion" - }, - "groupId" : { + "apiToken" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the project.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "hostnames" : { - "type" : "array", - "description" : "List that contains the hostnames assigned to the stream instance.", - "items" : { - "type" : "string", - "description" : "Unique hostname assigned to the stream instance.", - "readOnly" : true - }, - "readOnly" : true - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true + "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" }, - "name" : { + "channelName" : { "type" : "string", - "description" : "Human-readable label that identifies the stream instance." + "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" }, - "streamConfig" : { - "$ref" : "#/components/schemas/StreamConfig" - } - } - }, - "SummaryNotification" : { - "type" : "object", - "description" : "Summary notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", - "properties" : { "delayMin" : { "type" : "integer", "format" : "int32", "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." }, - "emailAddress" : { + "integrationId" : { "type" : "string", - "format" : "email", - "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:\n\n- specific MongoDB Cloud users (`\"notifications.[n].typeName\" : \"USER\"`)\n- MongoDB Cloud users with specific project roles (`\"notifications.[n].typeName\" : \"GROUP\"`)\n- MongoDB Cloud users with specific organization roles (`\"notifications.[n].typeName\" : \"ORG\"`)\n- MongoDB Cloud teams (`\"notifications.[n].typeName\" : \"TEAM\"`)\n\nTo send emails to one MongoDB Cloud user or grouping of users, set the **notifications.[n].emailEnabled** parameter." + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" }, "intervalMin" : { "type" : "integer", @@ -48371,68 +49306,74 @@ "typeName" : { "type" : "string", "description" : "Human-readable label that displays the alert notification type.", - "enum" : [ "SUMMARY" ] + "enum" : [ "SLACK" ] } }, "required" : [ "typeName" ], - "title" : "Summary Notification" + "title" : "Slack Notification" }, - "SynonymMappingStatusDetail" : { + "Source" : { "type" : "object", - "description" : "Contains the status of the index's synonym mappings on each search host. This field (and its subfields) only appear if the index has synonyms defined.", + "description" : "Document that describes the source of the migration.", "properties" : { - "message" : { + "caCertificatePath" : { "type" : "string", - "description" : "Optional message describing an error." + "description" : "Path to the CA certificate that signed SSL certificates use to authenticate to the source cluster." }, - "queryable" : { + "clusterName" : { + "type" : "string", + "description" : "Label that identifies the source cluster name." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the source project.", + "example" : "9b43a5b329223c3a1591a678", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "managedAuthentication" : { "type" : "boolean", - "description" : "Flag that indicates whether the synonym mapping is queryable on a host." + "description" : "Flag that indicates whether MongoDB Automation manages authentication to the source cluster. If true, do not provide values for username and password." }, - "status" : { + "password" : { "type" : "string", - "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", - "enum" : [ "FAILED", "BUILDING", "READY" ] + "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 } }, - "title" : "Synonym Mapping Status Detail" + "required" : [ "clusterName", "groupId", "managedAuthentication", "ssl" ] }, - "SynonymMappingStatusDetailMap" : { + "StorageEngine" : { "type" : "object", "additionalProperties" : { - "$ref" : "#/components/schemas/SynonymMappingStatusDetail" - }, - "x-additionalPropertiesName" : "Synonym Mapping Name" - }, - "SynonymSource" : { - "type" : "object", - "description" : "Data set that stores words and their applicable synonyms.", - "properties" : { - "collection" : { - "type" : "string", - "description" : "Label that identifies the MongoDB collection that stores words and their applicable synonyms." + "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/" } }, - "required" : [ "collection" ] + "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/" + } }, - "SystemStatus" : { + "StreamConfig" : { "type" : "object", + "description" : "Configuration options for an Atlas Stream Processing Instance.", + "nullable" : true, "properties" : { - "apiKey" : { - "$ref" : "#/components/schemas/ApiKey" - }, - "appName" : { - "type" : "string", - "description" : "Human-readable label that identifies the service from which you requested this response.", - "enum" : [ "MongoDB Atlas" ], - "readOnly" : true - }, - "build" : { - "type" : "string", - "description" : "Unique 40-hexadecimal digit hash that identifies the latest git commit merged for this application.", - "example" : "83be55e140f493c88e7f578aae96548dd881587b", - "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.", @@ -48445,43 +49386,44 @@ }, "readOnly" : true }, - "throttling" : { - "type" : "boolean", - "description" : "Flag that indicates whether someone enabled throttling on this service.", - "readOnly" : true - } - }, - "required" : [ "apiKey", "appName", "build", "throttling" ] - }, - "TargetOrg" : { - "type" : "object", - "properties" : { - "linkToken" : { + "tier" : { "type" : "string", - "description" : "Link token that contains all the information required to complete the link." - } - }, - "required" : [ "linkToken" ] - }, - "TargetOrgRequest" : { - "type" : "object", - "properties" : { - "accessListIps" : { - "type" : "array", - "description" : "IP address access list entries associated with the API key.", - "items" : { - "type" : "string", - "description" : "One IP address access list entry associated with the API key." - } + "description" : "Selected tier for the Stream Instance. Configures Memory / VCPU allowances.", + "enum" : [ "SP30", "SP10" ], + "title" : "Stream Instance Tier" } } }, - "Team" : { + "StreamProcessorAlertConfigViewForNdsGroup" : { "type" : "object", + "description" : "Host metric alert configuration allows to select which Atlas streams processors trigger alerts and how users are notified.", "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/StreamProcessorEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies this team.", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -48500,30 +49442,54 @@ }, "readOnly" : true }, - "name" : { - "type" : "string", - "description" : "Human-readable label that identifies the team." + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration.", + "items" : { + "$ref" : "#/components/schemas/StreamsMatcher" + } }, - "usernames" : { + "notifications" : { "type" : "array", - "description" : "List that contains the MongoDB Cloud users in this team.", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", "items" : { - "type" : "string", - "format" : "email", - "description" : "List that contains email addresses that identify MongoDB Cloud users to in this team." - }, - "uniqueItems" : true + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true } }, - "required" : [ "name" ] + "required" : [ "eventTypeName", "notifications" ], + "title" : "Stream Processor Alert Configuration" }, - "TeamEvent" : { + "StreamProcessorAlertViewForNdsGroup" : { "type" : "object", - "description" : "Team event identifies different activities around organization teams.", + "description" : "Stream Processor alert notifies about activities on Stream Processor in AtlasStreams.", "properties" : { - "apiKeyId" : { + "acknowledgedUntil" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "format" : "date-time", + "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.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -48533,15 +49499,15 @@ "created" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, "eventTypeName" : { - "$ref" : "#/components/schemas/TeamEventTypeView" + "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroupAlertable" }, "groupId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -48550,17 +49516,23 @@ }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "isGlobalAdmin" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "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.", + "example" : "foobar", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", "readOnly" : true }, "links" : { @@ -48577,86 +49549,72 @@ }, "orgId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "publicKey" : { + "processorErrorMsg" : { "type" : "string", - "format" : "email", - "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "example" : "test.user@mongodb.com", + "description" : "The error message associated with the Stream Processor to which this alert applies.", + "example" : "MongoServerError: Failed to start stream processor: (Location77175) Could not connect to the Kafka topic with kafka error code: -195, message: Local: Broker transport failure.: (Location77175)", "readOnly" : true }, - "raw" : { - "$ref" : "#/components/schemas/raw" + "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.", + "example" : "foobar", + "readOnly" : true }, - "remoteAddress" : { + "processorState" : { "type" : "string", - "description" : "IPv4 or IPv6 address from which the user triggered this event.", - "example" : "216.172.40.186", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "description" : "The state of the Stream Processor to which this alert applies. The resource returns this parameter for alerts of events impacting Stream Processors.", + "example" : "STARTED", "readOnly" : true }, - "teamId" : { + "resolved" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization team associated with this event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "format" : "date-time", + "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\"`.", "readOnly" : true }, - "userId" : { + "status" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", "readOnly" : true }, - "username" : { + "updated" : { "type" : "string", - "format" : "email", - "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", - "example" : "test.user@mongodb.com", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true } }, - "required" : [ "created", "eventTypeName", "id" ], - "title" : "Team Events" + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Stream Processor Alerts" }, - "TeamEventTypeView" : { + "StreamProcessorEventTypeViewAlertable" : { "type" : "string", - "description" : "Unique identifier of event type.", - "enum" : [ "TEAM_CREATED", "TEAM_DELETED", "TEAM_UPDATED", "TEAM_NAME_CHANGED", "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], - "example" : "TEAM_ADDED_TO_GROUP", - "title" : "Team Event Types" + "description" : "Event type that triggers an alert.", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "example" : "STREAM_PROCESSOR_STATE_IS_FAILED", + "title" : "Stream Processor Event Types" }, - "TeamEventTypeViewForNdsGroup" : { + "StreamProcessorEventTypeViewForNdsGroup" : { "type" : "string", "description" : "Unique identifier of event type.", - "enum" : [ "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], - "example" : "TEAM_ADDED_TO_GROUP", - "title" : "Team Event Types" + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "example" : "STREAM_PROCESSOR_STATE_IS_FAILED", + "title" : "Stream Processor Event Types" }, - "TeamEventViewForNdsGroup" : { + "StreamProcessorEventViewForNdsGroup" : { "type" : "object", - "description" : "Team event identifies different activities around organization teams.", + "description" : "Stream Processor event identifies different activities about a stream processor in Atlas Streams.", "properties" : { - "apiKeyId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, "created" : { "type" : "string", "format" : "date-time", @@ -48664,7 +49622,7 @@ "readOnly" : true }, "eventTypeName" : { - "$ref" : "#/components/schemas/TeamEventTypeViewForNdsGroup" + "$ref" : "#/components/schemas/StreamProcessorEventTypeViewForNdsGroup" }, "groupId" : { "type" : "string", @@ -48684,10 +49642,10 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "isGlobalAdmin" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "instanceName" : { + "type" : "string", + "description" : "Name of the stream processing instance associated with the event.", + "example" : "foobar", "readOnly" : true }, "links" : { @@ -48711,113 +49669,297 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "publicKey" : { + "processorErrorMsg" : { "type" : "string", - "format" : "email", - "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "example" : "test.user@mongodb.com", + "description" : "Error message linked to the stream processor associated with the event.", + "example" : "invalid auth", + "readOnly" : true + }, + "processorName" : { + "type" : "string", + "description" : "Name of the stream processor associated with the event.", + "example" : "foobar", + "readOnly" : true + }, + "processorState" : { + "type" : "string", + "description" : "State of the stream processor associated with the event.", + "example" : "FAILED", "readOnly" : true }, "raw" : { "$ref" : "#/components/schemas/raw" + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Stream Processor Events" + }, + "StreamsClusterConnection" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/StreamsConnection" + }, { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Name of the cluster configured for this connection." + }, + "dbRoleToExecute" : { + "$ref" : "#/components/schemas/DBRoleToExecute" + } + } + } ] + }, + "StreamsConnection" : { + "type" : "object", + "description" : "Settings that define a connection to an external data store.", + "discriminator" : { + "mapping" : { + "Cluster" : "#/components/schemas/StreamsClusterConnection", + "Kafka" : "#/components/schemas/StreamsKafkaConnection", + "Sample" : "#/components/schemas/StreamsSampleConnection" }, - "remoteAddress" : { + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/StreamsSampleConnection" + }, { + "$ref" : "#/components/schemas/StreamsClusterConnection" + }, { + "$ref" : "#/components/schemas/StreamsKafkaConnection" + } ], + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { "type" : "string", - "description" : "IPv4 or IPv6 address from which the user triggered this event.", - "example" : "216.172.40.186", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "description" : "Human-readable label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source." + }, + "type" : { + "type" : "string", + "description" : "Type of the connection. Can be either Cluster or Kafka.", + "enum" : [ "Kafka", "Cluster", "Sample" ] + } + }, + "readOnly" : true + }, + "StreamsDLQ" : { + "type" : "object", + "description" : "Dead letter queue for the stream processor.", + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/reference/glossary/#std-term-dead-letter-queue" + }, + "properties" : { + "coll" : { + "type" : "string", + "description" : "Name of the collection to use for the DLQ." + }, + "connectionName" : { + "type" : "string", + "description" : "Name of the connection to write DLQ messages to. Must be an Atlas connection." + }, + "db" : { + "type" : "string", + "description" : "Name of the database to use for the DLQ." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, "readOnly" : true + } + } + }, + "StreamsDataProcessRegion" : { + "type" : "object", + "description" : "Information about the cloud provider region in which MongoDB Cloud processes the stream.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Label that identifies the cloud service provider where MongoDB Cloud performs stream processing. Currently, this parameter supports AWS only.", + "enum" : [ "AWS", "GCP", "AZURE", "TENANT", "SERVERLESS" ] }, - "teamId" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "region" : { + "$ref" : "#/components/schemas/BaseStreamsRegion" + } + }, + "required" : [ "cloudProvider", "region" ] + }, + "StreamsEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "MAX_PROCESSOR_COUNT_REACHED" ], + "example" : "MAX_PROCESSOR_COUNT_REACHED", + "title" : "Streams Event Types" + }, + "StreamsEventViewForNdsGroup" : { + "type" : "object", + "description" : "Streams event identifies different activities about Atlas Streams.", + "properties" : { + "created" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization team associated with this event.", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/StreamsEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "userId" : { + "id" : { "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.", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "username" : { + "instanceName" : { "type" : "string", - "format" : "email", - "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", - "example" : "test.user@mongodb.com", + "description" : "Name of the stream processing instance associated with the event.", + "example" : "foobar", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" } }, "required" : [ "created", "eventTypeName", "id" ], - "title" : "Team Events" + "title" : "Streams Events" }, - "TeamNotification" : { + "StreamsKafkaAuthentication" : { "type" : "object", - "description" : "Team notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "description" : "User credentials required to connect to a Kafka Cluster. Includes the authentication type, as well as the parameters for that authentication mode.", "properties" : { - "delayMin" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." - }, - "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:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" - }, - "intervalMin" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", - "minimum" : 5 - }, - "notifierId" : { - "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:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true }, - "teamId" : { + "mechanism" : { "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", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" + "description" : "Style of authentication. Can be one of PLAIN, SCRAM-256, or SCRAM-512." }, - "teamName" : { + "password" : { "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" + "format" : "password", + "description" : "Password of the account to connect to the Kafka cluster.", + "writeOnly" : true }, - "typeName" : { + "username" : { "type" : "string", - "description" : "Human-readable label that displays the alert notification type.", - "enum" : [ "TEAM" ] + "description" : "Username of the account to connect to the Kafka cluster." } - }, - "required" : [ "typeName" ], - "title" : "Team Notification" + } }, - "TeamResponse" : { + "StreamsKafkaConnection" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/StreamsConnection" + }, { + "type" : "object", + "properties" : { + "authentication" : { + "$ref" : "#/components/schemas/StreamsKafkaAuthentication" + }, + "bootstrapServers" : { + "type" : "string", + "description" : "Comma separated list of server addresses." + }, + "config" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.", + "example" : "{\"group.protocol.type\":\"consumer\",\"debug\":\"queue, msg, protocol\"}" + }, + "description" : "A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.", + "example" : { + "debug" : "queue, msg, protocol", + "group.protocol.type" : "consumer" + } + }, + "networking" : { + "$ref" : "#/components/schemas/StreamsKafkaNetworking" + }, + "security" : { + "$ref" : "#/components/schemas/StreamsKafkaSecurity" + } + } + } ] + }, + "StreamsKafkaNetworking" : { "type" : "object", + "description" : "Networking Access Type can either be 'PUBLIC' (default) or VPC. VPC type is in public preview, please file a support ticket to enable VPC Network Access", "properties" : { - "id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies this team.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "access" : { + "$ref" : "#/components/schemas/StreamsKafkaNetworkingAccess" }, "links" : { "type" : "array", @@ -48830,16 +49972,21 @@ "$ref" : "#/components/schemas/Link" }, "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "Human-readable label that identifies the team." } } }, - "TeamRole" : { + "StreamsKafkaNetworkingAccess" : { "type" : "object", + "description" : "Information about the networking access.", "properties" : { + "connectionId" : { + "type" : "string", + "description" : "Reserved. Will be used by PRIVATE_LINK connection type.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, "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.", @@ -48852,28 +49999,26 @@ }, "readOnly" : true }, - "roleNames" : { - "type" : "array", - "description" : "One or more organization- or project-level roles to assign to the MongoDB Cloud user.", - "items" : { - "type" : "string", - "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] - }, - "uniqueItems" : true + "name" : { + "type" : "string", + "description" : "Reserved. Will be used by PRIVATE_LINK connection type." }, - "teamId" : { + "type" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the team.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" + "description" : "Selected networking type. Either PUBLIC, VPC or PRIVATE_LINK. Defaults to PUBLIC. For VPC, ensure that VPC peering exists and connectivity has been established between Atlas VPC and the VPC where Kafka cluster is hosted for the connection to function properly. PRIVATE_LINK support is coming soon.", + "enum" : [ "PUBLIC", "VPC", "PRIVATE_LINK" ], + "title" : "Networking Access Type" } } }, - "TeamUpdate" : { + "StreamsKafkaSecurity" : { "type" : "object", + "description" : "Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use.", "properties" : { + "brokerPublicCertificate" : { + "type" : "string", + "description" : "A trusted, public x509 certificate for connecting to Kafka over SSL." + }, "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.", @@ -48886,108 +50031,83 @@ }, "readOnly" : true }, - "name" : { - "type" : "string", - "description" : "Human-readable label that identifies the team.", - "writeOnly" : true - } - }, - "required" : [ "name" ] - }, - "TenantHardwareSpec" : { - "type" : "object", - "properties" : { - "instanceSize" : { + "protocol" : { "type" : "string", - "description" : "Hardware specification for the instances in this M0/M2/M5 tier cluster.", - "enum" : [ "M0", "M2", "M5" ], - "title" : "Tenant Instance Sizes" + "description" : "Describes the transport type. Can be either PLAINTEXT or SSL." } } }, - "TenantHardwareSpec20240805" : { + "StreamsMatcher" : { "type" : "object", + "description" : "Rules to apply when comparing a stream processing instance or stream processor against this alert configuration.", "properties" : { - "diskSizeGB" : { - "type" : "number", - "format" : "double", - "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", - "maximum" : 4096, - "minimum" : 10 + "fieldName" : { + "$ref" : "#/components/schemas/StreamsMatcherField" }, - "instanceSize" : { + "operator" : { "type" : "string", - "description" : "Hardware specification for the instances in this M0/M2/M5 tier cluster.", - "enum" : [ "M0", "M2", "M5" ], - "title" : "Tenant Instance Sizes" + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" } - } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" }, - "TenantRegionConfig" : { - "type" : "object", - "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`.", - "enum" : [ "AWS", "GCP", "AZURE" ] - } - } - } ], - "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", - "title" : "Tenant Regional Replication Specifications" + "StreamsMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "INSTANCE_NAME", "PROCESSOR_NAME" ], + "example" : "INSTANCE_NAME", + "title" : "Streams Matcher Fields" }, - "TenantRegionConfig20240805" : { + "StreamsOptions" : { "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/CloudRegionConfig20240805" - }, { - "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`.", - "enum" : [ "AWS", "GCP", "AZURE" ] - } + "description" : "Optional configuration for the stream processor.", + "properties" : { + "dlq" : { + "$ref" : "#/components/schemas/StreamsDLQ" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true } - } ], - "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", - "title" : "Tenant Regional Replication Specifications" + } }, - "TenantRestore" : { + "StreamsPrivateLinkConnection" : { "type" : "object", + "description" : "Container for metadata needed to create a Private Link connection.", "properties" : { - "clusterName" : { + "_id" : { "type" : "string", - "description" : "Human-readable label that identifies the source cluster.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "readOnly" : true + "description" : "The ID of the Private Link connection." }, - "deliveryType" : { + "dnsDomain" : { "type" : "string", - "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", - "enum" : [ "RESTORE", "DOWNLOAD" ], - "readOnly" : true + "description" : "Domain name of Confluent cluster." }, - "expirationDate" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "dnsSubDomain" : { + "type" : "array", + "description" : "Sub-Domain name of Confluent cluster. These are typically your availability zones.", + "items" : { + "type" : "string" + } }, - "id" : { + "interfaceEndpointId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "description" : "Interface endpoint ID that is created from the service endpoint ID provided." }, "links" : { "type" : "array", @@ -49001,354 +50121,451 @@ }, "readOnly" : true }, - "projectId" : { + "provider" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "description" : "Provider where the Kafka cluster is deployed." }, - "restoreFinishedDate" : { + "region" : { "type" : "string", - "format" : "date-time", - "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.", - "readOnly" : true + "description" : "Domain name of Confluent cluster." }, - "restoreScheduledDate" : { + "serviceEndpointId" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "description" : "AWS Service Endpoint ID." }, - "snapshotFinishedDate" : { + "state" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "description" : "State the connection is in." }, - "snapshotId" : { + "vendor" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "description" : "Vendor who manages the Kafka cluster." + } + } + }, + "StreamsProcessor" : { + "type" : "object", + "description" : "An atlas stream processor.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the stream processor.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" - }, - "snapshotUrl" : { - "type" : "string", - "description" : "Internet address from which you can download the compressed snapshot files. The resource returns this parameter when `\"deliveryType\" : \"DOWNLOAD\"`.", + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "status" : { - "type" : "string", - "description" : "Phase of the restore workflow for this job at the time this resource made this request.", - "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, "readOnly" : true }, - "targetDeploymentItemName" : { + "name" : { "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.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + "description" : "Human-readable name of the stream processor." }, - "targetProjectId" : { - "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", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" + "options" : { + "$ref" : "#/components/schemas/StreamsOptions" + }, + "pipeline" : { + "type" : "array", + "description" : "Stream aggregation pipeline you want to apply to your streaming data.", + "externalDocs" : { + "description" : "Supported Aggregation Pipeline Stages", + "url" : "https://www.mongodb.com/docs/atlas/atlas-stream-processing/stream-aggregation/#std-label-stream-aggregation" + }, + "items" : { + "$ref" : "#/components/schemas/Document" + } } - }, - "required" : [ "snapshotId", "targetDeploymentItemName" ] + } }, - "TextSearchHostStatusDetail" : { + "StreamsProcessorWithStats" : { "type" : "object", + "description" : "An atlas stream processor with optional stats.", "properties" : { - "hostname" : { + "_id" : { "type" : "string", - "description" : "Hostname that corresponds to the status detail." + "description" : "Unique 24-hexadecimal character string that identifies the stream processor.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "mainIndex" : { - "$ref" : "#/components/schemas/TextSearchIndexStatusDetail" + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true }, - "queryable" : { - "type" : "boolean", - "description" : "Flag that indicates whether the index is queryable on the host." + "name" : { + "type" : "string", + "description" : "Human-readable name of the stream processor.", + "readOnly" : true }, - "stagedIndex" : { - "$ref" : "#/components/schemas/TextSearchIndexStatusDetail" + "options" : { + "$ref" : "#/components/schemas/StreamsOptions" }, - "status" : { + "pipeline" : { + "type" : "array", + "description" : "Stream aggregation pipeline you want to apply to your streaming data.", + "items" : { + "$ref" : "#/components/schemas/Document" + }, + "readOnly" : true + }, + "state" : { "type" : "string", - "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", - "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + "description" : "The state of the stream processor. Commonly occurring states are 'CREATED', 'STARTED', 'STOPPED' and 'FAILED'.", + "readOnly" : true + }, + "stats" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "The stats associated with the stream processor.", + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor" + }, + "readOnly" : true + }, + "description" : "The stats associated with the stream processor.", + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor" + }, + "readOnly" : true } }, - "title" : "Text Search Host Status Detail" + "required" : [ "_id", "name", "pipeline", "state" ] }, - "TextSearchIndexCreateRequest" : { + "StreamsSampleConnection" : { "type" : "object", "allOf" : [ { - "$ref" : "#/components/schemas/SearchIndexCreateRequest" - }, { - "type" : "object", - "properties" : { - "definition" : { - "$ref" : "#/components/schemas/TextSearchIndexDefinition" - } + "$ref" : "#/components/schemas/StreamsConnection" + } ] + }, + "StreamsSampleConnections" : { + "type" : "object", + "description" : "Sample connections to add to SPI.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "solar" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to add a 'sample_stream_solar' connection." } - } ], - "description" : "Text Search Index Create Request", - "required" : [ "collectionName", "database", "definition", "name" ] + } }, - "TextSearchIndexDefinition" : { + "StreamsTenant" : { "type" : "object", - "description" : "The text search index definition set by the user.", "properties" : { - "analyzer" : { + "_id" : { "type" : "string", - "default" : "lucene.standard", - "description" : "Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves making the following changes to the text in fields:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\n MongoDB Cloud uses the process you select to build the Atlas Search index.", - "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ], - "externalDocs" : { - "description" : "Atlas Search Analyzers", - "url" : "https://dochub.mongodb.org/core/analyzers--fts" - } + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "analyzers" : { + "connections" : { "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" - }, + "description" : "List of connections configured in the stream instance.", "items" : { - "$ref" : "#/components/schemas/AtlasSearchAnalyzer" - } + "$ref" : "#/components/schemas/StreamsConnection" + }, + "readOnly" : true }, - "mappings" : { - "$ref" : "#/components/schemas/SearchMappings" + "dataProcessRegion" : { + "$ref" : "#/components/schemas/StreamsDataProcessRegion" }, - "searchAnalyzer" : { + "groupId" : { "type" : "string", - "default" : "lucene.standard", - "description" : "Method applied to identify words when searching this index.", - "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "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 Stored Source Fields.", - "example" : { - "include | exclude" : [ "field1", "field2" ] + "hostnames" : { + "type" : "array", + "description" : "List that contains the hostnames assigned to the stream instance.", + "items" : { + "type" : "string", + "description" : "Unique hostname assigned to the stream instance.", + "readOnly" : true }, - "externalDocs" : { - "description" : "Stored Source Fields", - "url" : "https://dochub.mongodb.org/core/atlas-search-stored-source" - } + "readOnly" : true }, - "synonyms" : { + "links" : { "type" : "array", - "description" : "Rule sets that map words to their synonyms in this index.", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", "externalDocs" : { - "description" : "Synonym Mapping", - "url" : "https://dochub.mongodb.org/core/fts-synonym-mappings" + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" }, "items" : { - "$ref" : "#/components/schemas/SearchSynonymMappingDefinition" - } - } - }, - "required" : [ "mappings" ], - "title" : "Text Search Index Definition" - }, - "TextSearchIndexResponse" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/SearchIndexResponse" - }, { - "type" : "object", - "properties" : { - "latestDefinition" : { - "$ref" : "#/components/schemas/TextSearchIndexDefinition" - }, - "statusDetail" : { - "type" : "array", - "description" : "List of documents detailing index status on each host.", - "items" : { - "$ref" : "#/components/schemas/TextSearchHostStatusDetail" - } - }, - "synonymMappingStatus" : { - "type" : "string", - "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", - "enum" : [ "FAILED", "BUILDING", "READY" ] - }, - "synonymMappingStatusDetail" : { - "type" : "array", - "description" : "A list of documents describing the status of the index's synonym mappings on each search host. Only appears if the index has synonyms defined.", - "items" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/SynonymMappingStatusDetail" - } - } - } + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the stream instance." + }, + "sampleConnections" : { + "$ref" : "#/components/schemas/StreamsSampleConnections" + }, + "streamConfig" : { + "$ref" : "#/components/schemas/StreamConfig" } - } ], - "title" : "Text Search Index Response" + } }, - "TextSearchIndexStatusDetail" : { + "SummaryNotification" : { "type" : "object", - "description" : "Contains status information about a text search index.", + "description" : "Summary notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", "properties" : { - "definition" : { - "$ref" : "#/components/schemas/TextSearchIndexDefinition" + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." }, - "definitionVersion" : { - "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + "emailAddress" : { + "type" : "string", + "format" : "email", + "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:\n\n- specific MongoDB Cloud users (`\"notifications.[n].typeName\" : \"USER\"`)\n- MongoDB Cloud users with specific project roles (`\"notifications.[n].typeName\" : \"GROUP\"`)\n- MongoDB Cloud users with specific organization roles (`\"notifications.[n].typeName\" : \"ORG\"`)\n- MongoDB Cloud teams (`\"notifications.[n].typeName\" : \"TEAM\"`)\n\nTo send emails to one MongoDB Cloud user or grouping of users, set the **notifications.[n].emailEnabled** parameter." + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "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" ] + } + }, + "required" : [ "typeName" ], + "title" : "Summary Notification" + }, + "SynonymMappingStatusDetail" : { + "type" : "object", + "description" : "Contains the status of the index's synonym mappings on each search host. This field (and its subfields) only appear if the index has synonyms defined.", + "properties" : { "message" : { "type" : "string", "description" : "Optional message describing an error." }, "queryable" : { "type" : "boolean", - "description" : "Flag that indicates whether the index generation is queryable on the host." + "description" : "Flag that indicates whether the synonym mapping is queryable on a host." }, "status" : { - "type" : "string", - "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", - "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] - }, - "synonymMappingStatus" : { "type" : "string", "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", "enum" : [ "FAILED", "BUILDING", "READY" ] - }, - "synonymMappingStatusDetail" : { - "type" : "array", - "description" : "List of synonym statuses by mapping.", - "items" : { - "$ref" : "#/components/schemas/SynonymMappingStatusDetailMap" - } } }, - "title" : "Text Search Index Status Detail" + "title" : "Synonym Mapping Status Detail" }, - "ThirdPartyIntegration" : { + "SynonymMappingStatusDetailMap" : { "type" : "object", - "description" : "Collection of settings that describe third-party integrations.", - "discriminator" : { - "mapping" : { - "DATADOG" : "#/components/schemas/Datadog", - "MICROSOFT_TEAMS" : "#/components/schemas/MicrosoftTeams", - "NEW_RELIC" : "#/components/schemas/NewRelic", - "OPS_GENIE" : "#/components/schemas/OpsGenie", - "PAGER_DUTY" : "#/components/schemas/PagerDuty", - "PROMETHEUS" : "#/components/schemas/Prometheus", - "SLACK" : "#/components/schemas/Slack", - "VICTOR_OPS" : "#/components/schemas/VictorOps", - "WEBHOOK" : "#/components/schemas/Webhook" - }, - "propertyName" : "type" + "additionalProperties" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetail" }, + "x-additionalPropertiesName" : "Synonym Mapping Name" + }, + "SynonymSource" : { + "type" : "object", + "description" : "Data set that stores words and their applicable synonyms.", "properties" : { - "id" : { - "type" : "string", - "description" : "Integration id.", - "nullable" : true - }, - "type" : { + "collection" : { "type" : "string", - "description" : "Integration type", - "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], - "title" : "Integration Type" + "description" : "Label that identifies the MongoDB collection that stores words and their applicable synonyms." } }, - "title" : "Third-Party Integration" + "required" : [ "collection" ] }, - "TimeMetricAlertView" : { + "SystemStatus" : { "type" : "object", "properties" : { - "acknowledgedUntil" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + "apiKey" : { + "$ref" : "#/components/schemas/ApiKey" }, - "acknowledgementComment" : { + "appName" : { "type" : "string", - "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", - "example" : "Expiration on 3/19. Silencing for 7days.", - "maxLength" : 200 + "description" : "Human-readable label that identifies the service from which you requested this response.", + "enum" : [ "MongoDB Atlas" ], + "readOnly" : true }, - "acknowledgingUsername" : { + "build" : { "type" : "string", - "format" : "email", - "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "description" : "Unique 40-hexadecimal digit hash that identifies the latest git commit merged for this application.", + "example" : "83be55e140f493c88e7f578aae96548dd881587b", "readOnly" : true }, - "alertConfigId" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "throttling" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled throttling on this service.", + "readOnly" : true + } + }, + "required" : [ "apiKey", "appName", "build", "throttling" ] + }, + "TargetOrg" : { + "type" : "object", + "properties" : { + "linkToken" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "description" : "Link token that contains all the information required to complete the link." + } + }, + "required" : [ "linkToken" ] + }, + "TargetOrgRequest" : { + "type" : "object", + "properties" : { + "accessListIps" : { + "type" : "array", + "description" : "IP address access list entries associated with the API key.", + "items" : { + "type" : "string", + "description" : "One IP address access list entry associated with the API key." + } + } + } + }, + "Team" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this team.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "clusterName" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { "type" : "string", - "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", - "example" : "cluster1", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "description" : "Human-readable label that identifies the team." + }, + "usernames" : { + "type" : "array", + "description" : "List that contains the MongoDB Cloud users in this team.", + "items" : { + "type" : "string", + "format" : "email", + "description" : "List that contains email addresses that identify MongoDB Cloud users to in this team." + }, + "uniqueItems" : true + } + }, + "required" : [ "name" ] + }, + "TeamEvent" : { + "type" : "object", + "description" : "Team event identifies different activities around organization teams.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, "created" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "currentValue" : { - "$ref" : "#/components/schemas/TimeMetricValueView" - }, "eventTypeName" : { - "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + "$ref" : "#/components/schemas/TeamEventTypeView" }, "groupId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "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.", - "example" : "cloud-test.mongodb.com:27017", - "readOnly" : true - }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "lastNotified" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", "readOnly" : true }, "links" : { @@ -49363,51 +50580,78 @@ }, "readOnly" : true }, - "metricName" : { - "type" : "string", - "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", - "example" : "ASSERT_USER", - "readOnly" : true - }, "orgId" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "replicaSetName" : { + "publicKey" : { "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.", - "example" : "event-replica-set", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true }, - "resolved" : { + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { "type" : "string", - "format" : "date-time", - "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\"`.", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", "readOnly" : true }, - "status" : { + "teamId" : { "type" : "string", - "description" : "State of this alert at the time you requested its details.", - "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], - "example" : "OPEN", + "description" : "Unique 24-hexadecimal digit string that identifies the organization team associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "updated" : { + "userId" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true } }, - "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Team Events" }, - "TimeMetricEventView" : { + "TeamEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TEAM_CREATED", "TEAM_DELETED", "TEAM_UPDATED", "TEAM_NAME_CHANGED", "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "example" : "TEAM_ADDED_TO_GROUP", + "title" : "Team Event Types" + }, + "TeamEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "example" : "TEAM_ADDED_TO_GROUP", + "title" : "Team Event Types" + }, + "TeamEventViewForNdsGroup" : { "type" : "object", + "description" : "Team event identifies different activities around organization teams.", "properties" : { "apiKeyId" : { "type" : "string", @@ -49424,11 +50668,8 @@ "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "currentValue" : { - "$ref" : "#/components/schemas/TimeMetricValueView" - }, "eventTypeName" : { - "$ref" : "#/components/schemas/HostMetricEventTypeView" + "$ref" : "#/components/schemas/TeamEventTypeViewForNdsGroup" }, "groupId" : { "type" : "string", @@ -49466,11 +50707,6 @@ }, "readOnly" : true }, - "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" : { "type" : "string", "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", @@ -49480,13 +50716,6 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "port" : { - "type" : "integer", - "format" : "int32", - "description" : "IANA port on which the MongoDB process listens for requests.", - "example" : 27017, - "readOnly" : true - }, "publicKey" : { "type" : "string", "format" : "email", @@ -49504,16 +50733,13 @@ "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", "readOnly" : true }, - "replicaSetName" : { - "type" : "string", - "description" : "Human-readable label of the replica set associated with the event.", - "example" : "event-replica-set", - "readOnly" : true - }, - "shardName" : { + "teamId" : { "type" : "string", - "description" : "Human-readable label of the shard associated with the event.", - "example" : "event-sh-01", + "description" : "Unique 24-hexadecimal digit string that identifies the organization team associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, "userId" : { @@ -49533,250 +50759,220 @@ "readOnly" : true } }, - "required" : [ "created", "eventTypeName", "id" ] + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Team Events" }, - "TimeMetricThresholdView" : { + "TeamNotification" : { "type" : "object", + "description" : "Team notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", "properties" : { - "metricName" : { - "type" : "string", - "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." }, - "mode" : { + "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:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { "type" : "string", - "description" : "MongoDB Cloud computes the current metric value as an average.", - "enum" : [ "AVERAGE" ] + "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" }, - "operator" : { - "$ref" : "#/components/schemas/Operator" + "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:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" }, - "threshold" : { - "type" : "number", - "format" : "double", - "description" : "Value of metric that, when exceeded, triggers an alert." + "teamId" : { + "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", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" }, - "units" : { - "$ref" : "#/components/schemas/TimeMetricUnits" - } - }, - "required" : [ "metricName" ] - }, - "TimeMetricUnits" : { - "type" : "string", - "default" : "HOURS", - "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", - "enum" : [ "NANOSECONDS", "MILLISECONDS", "MILLION_MINUTES", "SECONDS", "MINUTES", "HOURS", "DAYS" ], - "title" : "Time Metric Units" - }, - "TimeMetricValueView" : { - "type" : "object", - "description" : "Measurement of the **metricName** recorded at the time of the event.", - "properties" : { - "number" : { - "type" : "number", - "format" : "double", - "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", - "readOnly" : true + "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" }, - "units" : { - "$ref" : "#/components/schemas/TimeMetricUnits" - } - }, - "readOnly" : true, - "title" : "Time Metric Value" - }, - "TokenFilterEnglishPossessive" : { - "type" : "object", - "description" : "Filter that removes possessives (trailing 's) from words.", - "properties" : { - "type" : { + "typeName" : { "type" : "string", - "description" : "Human-readable label that identifies this token filter type.", - "enum" : [ "englishPossessive" ] + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "TEAM" ] } }, - "required" : [ "type" ], - "title" : "englishPossessive" + "required" : [ "typeName" ], + "title" : "Team Notification" }, - "TokenFilterFlattenGraph" : { + "TeamResponse" : { "type" : "object", - "description" : "Filter that transforms a token filter graph, such as the token filter graph that the wordDelimiterGraph token filter produces, into a flat form suitable for indexing.", "properties" : { - "type" : { + "id" : { "type" : "string", - "description" : "Human-readable label that identifies this token filter type.", - "enum" : [ "flattenGraph" ] + "description" : "Unique 24-hexadecimal digit string that identifies this team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the team." } - }, - "required" : [ "type" ], - "title" : "flattenGraph" + } }, - "TokenFilterPorterStemming" : { + "TeamRole" : { "type" : "object", - "description" : "Filter that uses the porter stemming algorithm to remove the common morphological and inflectional suffixes from words in English. It expects lowercase text and doesn't work as expected for uppercase text.", "properties" : { - "type" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "roleNames" : { + "type" : "array", + "description" : "One or more organization- or project-level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "teamId" : { "type" : "string", - "description" : "Human-readable label that identifies this token filter type.", - "enum" : [ "porterStemming" ] + "description" : "Unique 24-hexadecimal character string that identifies the team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" } - }, - "required" : [ "type" ], - "title" : "porterStemming" + } }, - "TokenFilterSpanishPluralStemming" : { + "TeamUpdate" : { "type" : "object", - "description" : "Filter that stems Spanish plural words. It expects lowercase text.", "properties" : { - "type" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { "type" : "string", - "description" : "Human-readable label that identifies this token filter type.", - "enum" : [ "spanishPluralStemming" ] + "description" : "Human-readable label that identifies the team.", + "writeOnly" : true } }, - "required" : [ "type" ], - "title" : "spanishPluralStemming" + "required" : [ "name" ] }, - "TokenFilterStempel" : { + "TenantHardwareSpec" : { "type" : "object", - "description" : "Filter that uses Lucene's default Polish stemmer table to stem words in the Polish language. It expects lowercase text.", - "externalDocs" : { - "description" : "Default Polish stemmer table", - "url" : "https://lucene.apache.org/core/9_2_0/analysis/stempel/org/apache/lucene/analysis/pl/PolishAnalyzer.html#DEFAULT_STEMMER_FILE" - }, "properties" : { - "type" : { + "instanceSize" : { "type" : "string", - "description" : "Human-readable label that identifies this token filter type.", - "enum" : [ "stempel" ] + "description" : "Hardware specification for the instances in this M0/M2/M5 tier cluster.", + "enum" : [ "M0", "M2", "M5" ], + "title" : "Tenant Instance Sizes" } - }, - "required" : [ "type" ], - "title" : "stempel" + } }, - "TokenFilterWordDelimiterGraph" : { + "TenantHardwareSpec20240805" : { "type" : "object", - "description" : "Filter that splits tokens into sub-tokens based on configured rules.", "properties" : { - "delimiterOptions" : { - "type" : "object", - "description" : "Object that contains the rules that determine how to split words into sub-words.", - "properties" : { - "concatenateAll" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether to concatenate runs." - }, - "concatenateNumbers" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether to concatenate runs of sub-numbers." - }, - "concatenateWords" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether to concatenate runs of sub-words." - }, - "generateNumberParts" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether to split tokens based on sub-numbers. For example, if `true`, this option splits `100-2` into `100` and `2`." - }, - "generateWordParts" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether to split tokens based on sub-words." - }, - "ignoreKeywords" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether to skip tokens with the `keyword` attribute set to `true`" - }, - "preserveOriginal" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether to generate tokens of the original words." - }, - "splitOnCaseChange" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether to split tokens based on letter-case transitions." - }, - "splitOnNumerics" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether to split tokens based on letter-number transitions." - }, - "stemEnglishPossessive" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether to remove trailing possessives from each sub-word." - } - } - }, - "protectedWords" : { - "type" : "object", - "description" : "Object that contains options for protected words.", - "properties" : { - "ignoreCase" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether to ignore letter case sensitivity for protected words." - }, - "words" : { - "type" : "array", - "description" : "List that contains the tokens to protect from delimination.", - "items" : { - "type" : "string" - } - } - }, - "required" : [ "words" ] + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 }, - "type" : { + "instanceSize" : { "type" : "string", - "description" : "Human-readable label that identifies this token filter type.", - "enum" : [ "wordDelimiterGraph" ] + "description" : "Hardware specification for the instances in this M0/M2/M5 tier cluster.", + "enum" : [ "M0", "M2", "M5" ], + "title" : "Tenant Instance Sizes" } - }, - "required" : [ "type" ], - "title" : "wordDelimiterGraph" + } }, - "TokenFilterkStemming" : { + "TenantRegionConfig" : { "type" : "object", - "description" : "Filter that combines algorithmic stemming with a built-in dictionary for the English language to stem words.", - "properties" : { - "type" : { - "type" : "string", - "description" : "Human-readable label that identifies this token filter type.", - "enum" : [ "kStemming" ] + "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`.", + "enum" : [ "AWS", "GCP", "AZURE" ] + } } - }, - "required" : [ "type" ], - "title" : "kStemming" + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Tenant Regional Replication Specifications" }, - "TriggerIngestionPipelineRequest" : { + "TenantRegionConfig20240805" : { "type" : "object", - "properties" : { - "datasetRetentionPolicy" : { - "$ref" : "#/components/schemas/DatasetRetentionPolicy" - }, - "snapshotId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "writeOnly" : true + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20240805" + }, { + "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`.", + "enum" : [ "AWS", "GCP", "AZURE" ] + } } - }, - "required" : [ "snapshotId" ] + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Tenant Regional Replication Specifications" }, - "USSBackupRestoreJob20250101" : { + "TenantRestore" : { "type" : "object", - "description" : "Details for one restore job of a USS instance.", "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the source cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "readOnly" : true + }, "deliveryType" : { "type" : "string", "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", @@ -49798,14 +50994,6 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "instanceName" : { - "type" : "string", - "description" : "Human-readable label that identifies the source instance.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "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.", @@ -49851,8 +51039,7 @@ "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "pattern" : "^([a-f0-9]{24})$" }, "snapshotUrl" : { "type" : "string", @@ -49867,176 +51054,311 @@ }, "targetDeploymentItemName" : { "type" : "string", - "description" : "Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another USS instance or Dedicated cluster tier.", + "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.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", - "readOnly" : true + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" }, "targetProjectId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the cluster to which you want to restore the snapshot.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "pattern" : "^([a-f0-9]{24})$" } }, - "title" : "USS Backup Restore Job" + "required" : [ "snapshotId", "targetDeploymentItemName" ] + }, + "TenantWithSampleConnections" : { + "type" : "object" }, - "USSBackupRestoreJobCreate20250101" : { + "TextSearchHostStatusDetail" : { "type" : "object", - "description" : "Details to create one restore job of a USS instance.", "properties" : { - "_snapshotId" : { + "hostname" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "writeOnly" : true + "description" : "Hostname that corresponds to the status detail." }, - "_targetDeploymentItemName" : { - "type" : "string", - "description" : "Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another USS instance or Dedicated cluster tier.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", - "writeOnly" : true + "mainIndex" : { + "$ref" : "#/components/schemas/TextSearchIndexStatusDetail" }, - "_targetProjectId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "writeOnly" : true + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on the host." }, - "deliveryType" : { - "type" : "string", - "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", - "enum" : [ "RESTORE", "DOWNLOAD" ], - "readOnly" : true + "stagedIndex" : { + "$ref" : "#/components/schemas/TextSearchIndexStatusDetail" }, - "expirationDate" : { + "status" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true - }, - "id" : { + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Text Search Host Status Detail" + }, + "TextSearchIndexCreateRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexCreateRequest" + }, { + "type" : "object", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + } + } + } ], + "description" : "Text Search Index Create Request", + "required" : [ "collectionName", "database", "definition", "name" ] + }, + "TextSearchIndexDefinition" : { + "type" : "object", + "description" : "The text search index definition set by the user.", + "properties" : { + "analyzer" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "default" : "lucene.standard", + "description" : "Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves making the following changes to the text in fields:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\n MongoDB Cloud uses the process you select to build the Atlas Search index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ], + "externalDocs" : { + "description" : "Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/analyzers--fts" + } }, - "instanceName" : { + "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" + }, + "items" : { + "$ref" : "#/components/schemas/AtlasSearchAnalyzer" + } + }, + "mappings" : { + "$ref" : "#/components/schemas/SearchMappings" + }, + "searchAnalyzer" : { "type" : "string", - "description" : "Human-readable label that identifies the source instance.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "readOnly" : true + "default" : "lucene.standard", + "description" : "Method applied to identify words when searching this index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] }, - "links" : { + "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 Stored Source Fields.", + "example" : { + "include | exclude" : [ "field1", "field2" ] + }, + "externalDocs" : { + "description" : "Stored Source Fields", + "url" : "https://dochub.mongodb.org/core/atlas-search-stored-source" + } + }, + "synonyms" : { "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.", + "description" : "Rule sets that map words to their synonyms in this index.", "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + "description" : "Synonym Mapping", + "url" : "https://dochub.mongodb.org/core/fts-synonym-mappings" }, "items" : { - "$ref" : "#/components/schemas/Link" + "$ref" : "#/components/schemas/SearchSynonymMappingDefinition" + } + } + }, + "required" : [ "mappings" ], + "title" : "Text Search Index Definition" + }, + "TextSearchIndexResponse" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexResponse" + }, { + "type" : "object", + "properties" : { + "latestDefinition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" }, - "readOnly" : true + "statusDetail" : { + "type" : "array", + "description" : "List of documents detailing index status on each host.", + "items" : { + "$ref" : "#/components/schemas/TextSearchHostStatusDetail" + } + }, + "synonymMappingStatus" : { + "type" : "string", + "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", + "enum" : [ "FAILED", "BUILDING", "READY" ] + }, + "synonymMappingStatusDetail" : { + "type" : "array", + "description" : "A list of documents describing the status of the index's synonym mappings on each search host. Only appears if the index has synonyms defined.", + "items" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetail" + } + } + } + } + } ], + "title" : "Text Search Index Response" + }, + "TextSearchIndexStatusDetail" : { + "type" : "object", + "description" : "Contains status information about a text search index.", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" }, - "projectId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" }, - "restoreFinishedDate" : { + "message" : { "type" : "string", - "format" : "date-time", - "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.", - "readOnly" : true + "description" : "Optional message describing an error." }, - "restoreScheduledDate" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index generation is queryable on the host." }, - "snapshotFinishedDate" : { + "status" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] }, - "snapshotUrl" : { + "synonymMappingStatus" : { "type" : "string", - "description" : "Internet address from which you can download the compressed snapshot files. The resource returns this parameter when `\"deliveryType\" : \"DOWNLOAD\"`.", - "readOnly" : true + "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", + "enum" : [ "FAILED", "BUILDING", "READY" ] }, - "status" : { - "type" : "string", - "description" : "Phase of the restore workflow for this job at the time this resource made this request.", - "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], - "readOnly" : true + "synonymMappingStatusDetail" : { + "type" : "array", + "description" : "List of synonym statuses by mapping.", + "items" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetailMap" + } } }, - "required" : [ "_snapshotId", "_targetDeploymentItemName" ], - "title" : "Create USS Backup Restore Job" + "title" : "Text Search Index Status Detail" }, - "USSBackupSettings20250101" : { + "ThirdPartyIntegration" : { "type" : "object", - "description" : "USS backup configuration", + "description" : "Collection of settings that describe third-party integrations.", + "discriminator" : { + "mapping" : { + "DATADOG" : "#/components/schemas/Datadog", + "MICROSOFT_TEAMS" : "#/components/schemas/MicrosoftTeams", + "NEW_RELIC" : "#/components/schemas/NewRelic", + "OPS_GENIE" : "#/components/schemas/OpsGenie", + "PAGER_DUTY" : "#/components/schemas/PagerDuty", + "PROMETHEUS" : "#/components/schemas/Prometheus", + "SLACK" : "#/components/schemas/Slack", + "VICTOR_OPS" : "#/components/schemas/VictorOps", + "WEBHOOK" : "#/components/schemas/Webhook" + }, + "propertyName" : "type" + }, "properties" : { - "enabled" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether backups are performed for this USS instance. Backup uses [TODO](TODO) for USS instances.", - "readOnly" : true + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "type" : { + "type" : "string", + "description" : "Integration type", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" } }, - "readOnly" : true, - "title" : "USS backup configuration" + "title" : "Third-Party Integration" }, - "USSBackupSnapshot20250101" : { + "TimeMetricAlertView" : { "type" : "object", - "description" : "Details for one snapshot of a USS instance.", "properties" : { - "expiration" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "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.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "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.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "readOnly" : true + }, + "created" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "finishTime" : { + "currentValue" : { + "$ref" : "#/components/schemas/TimeMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "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.", + "example" : "cloud-test.mongodb.com:27017", "readOnly" : true }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, "links" : { "type" : "array", "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", @@ -50049,116 +51371,76 @@ }, "readOnly" : true }, - "mongoDBVersion" : { + "metricName" : { "type" : "string", - "description" : "MongoDB host version that the snapshot runs.", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", "readOnly" : true }, - "scheduledTime" : { + "orgId" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud will take the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "startTime" : { + "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.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when MongoDB Cloud began taking the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "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\"`.", "readOnly" : true }, "status" : { "type" : "string", - "description" : "Phase of the workflow for this snapshot at the time this resource made this request.", - "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true } }, - "title" : "USS Backup Snapshot" + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] }, - "USSBackupSnapshotDownloadCreate20250101" : { + "TimeMetricEventView" : { "type" : "object", - "description" : "Details for one backup snapshot download of a USS instance.", "properties" : { - "_snapshotId" : { + "apiKeyId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to download.", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", - "writeOnly" : true - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - } - }, - "required" : [ "_snapshotId" ], - "title" : "USS Backup Snapshot Download Create" - }, - "USSConnectionStrings20250101" : { - "type" : "object", - "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", - "externalDocs" : { - "description" : "Connection string URI format.", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, - "properties" : { - "standard" : { - "type" : "string", - "description" : "Public connection string that you can use to connect to this cluster. This connection string uses the mongodb:// protocol.", - "externalDocs" : { - "description" : "Connection String URI Format", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, - "readOnly" : true - }, - "standardSrv" : { - "type" : "string", - "description" : "Public connection string that you can use to connect to this USS instance. This connection string uses the `mongodb+srv://` protocol.", - "externalDocs" : { - "description" : "Connection String URI Format", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, "readOnly" : true - } - }, - "readOnly" : true, - "title" : "USS Instance Connection Strings" - }, - "USSInstanceDescription20250101" : { - "type" : "object", - "description" : "Group of settings that configure a MongoDB USS instance.", - "properties" : { - "backupSettings" : { - "$ref" : "#/components/schemas/USSBackupSettings20250101" }, - "clusterType" : { + "created" : { "type" : "string", - "description" : "USS instance topology.", - "enum" : [ "REPLICASET", "LOADBALANCED" ], + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "connectionStrings" : { - "$ref" : "#/components/schemas/USSConnectionStrings20250101" + "currentValue" : { + "$ref" : "#/components/schemas/TimeMetricValueView" }, - "createDate" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created this instance. This parameter expresses its value in ISO 8601 format in UTC.", - "readOnly" : true + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" }, "groupId" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the project.", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -50167,13 +51449,19 @@ }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the instance.", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, "links" : { "type" : "array", "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", @@ -50186,167 +51474,314 @@ }, "readOnly" : true }, - "mongoDBVersion" : { + "metricName" : { "type" : "string", - "description" : "Version of MongoDB that the instance runs.", - "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", "readOnly" : true }, - "name" : { + "orgId" : { "type" : "string", - "description" : "Human-readable label that identifies the instance.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "providerSettings" : { - "$ref" : "#/components/schemas/USSProviderSettings20250101" + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true }, - "stateName" : { + "publicKey" : { "type" : "string", - "description" : "Human-readable label that indicates the current operating condition of this instance.", - "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true }, - "tags" : { - "type" : "array", - "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.", - "externalDocs" : { - "description" : "Resource Tags", - "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" - }, - "items" : { - "$ref" : "#/components/schemas/ResourceTag" - } + "raw" : { + "$ref" : "#/components/schemas/raw" }, - "terminationProtectionEnabled" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true }, - "versionReleaseSystem" : { + "replicaSetName" : { "type" : "string", - "default" : "LTS", - "description" : "Method by which the cluster maintains the MongoDB versions.", - "enum" : [ "LTS" ], + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true } }, - "required" : [ "providerSettings" ], - "title" : "USS Instance Description" + "required" : [ "created", "eventTypeName", "id" ] }, - "USSInstanceDescriptionCreate20250101" : { + "TimeMetricThresholdView" : { "type" : "object", - "description" : "Settings that you can specify when you create a USS instance.", "properties" : { - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." }, - "name" : { + "mode" : { "type" : "string", - "description" : "Human-readable label that identifies the instance.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "writeOnly" : true + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] }, - "providerSettings" : { - "$ref" : "#/components/schemas/USSProviderSettingsCreate20250101" + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, - "tags" : { - "type" : "array", - "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.", - "externalDocs" : { - "description" : "Resource Tags", - "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" - }, - "items" : { - "$ref" : "#/components/schemas/ResourceTag" - } + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." }, - "terminationProtectionEnabled" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" } }, - "required" : [ "name", "providerSettings" ], - "title" : "USS Instance Description Create" + "required" : [ "metricName" ] + }, + "TimeMetricUnits" : { + "type" : "string", + "default" : "HOURS", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "NANOSECONDS", "MILLISECONDS", "MILLION_MINUTES", "SECONDS", "MINUTES", "HOURS", "DAYS" ], + "title" : "Time Metric Units" }, - "USSProviderSettings20250101" : { + "TimeMetricValueView" : { "type" : "object", - "description" : "Group of cloud provider settings that configure the provisioned MongoDB USS instance.", + "description" : "Measurement of the **metricName** recorded at the time of the event.", "properties" : { - "backingProviderName" : { - "type" : "string", - "description" : "Cloud service provider on which MongoDB Cloud provisioned the USS instance.", - "enum" : [ "AWS", "AZURE", "GCP" ], - "readOnly" : true - }, - "diskSizeGB" : { + "number" : { "type" : "number", "format" : "double", - "description" : "Storage capacity available to the USS instance expressed in gigabytes.", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", "readOnly" : true }, - "providerName" : { + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "readOnly" : true, + "title" : "Time Metric Value" + }, + "TokenFilterEnglishPossessive" : { + "type" : "object", + "description" : "Filter that removes possessives (trailing 's) from words.", + "properties" : { + "type" : { "type" : "string", - "default" : "USS", - "description" : "Human-readable label that identifies the cloud service provider.", - "enum" : [ "USS" ], - "readOnly" : true - }, - "regionName" : { + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "englishPossessive" ] + } + }, + "required" : [ "type" ], + "title" : "englishPossessive" + }, + "TokenFilterFlattenGraph" : { + "type" : "object", + "description" : "Filter that transforms a token filter graph, such as the token filter graph that the wordDelimiterGraph token filter produces, into a flat form suitable for indexing.", + "properties" : { + "type" : { "type" : "string", - "description" : "Human-readable label that identifies the geographic location of your MongoDB USS 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/).", - "readOnly" : true + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "flattenGraph" ] } }, - "readOnly" : true, - "title" : "Cloud Service Provider Settings for a USS Instance" + "required" : [ "type" ], + "title" : "flattenGraph" }, - "USSProviderSettingsCreate20250101" : { + "TokenFilterPorterStemming" : { "type" : "object", - "description" : "Group of cloud provider settings that configure the provisioned MongoDB USS instance.", + "description" : "Filter that uses the porter stemming algorithm to remove the common morphological and inflectional suffixes from words in English. It expects lowercase text and doesn't work as expected for uppercase text.", "properties" : { - "backingProviderName" : { + "type" : { "type" : "string", - "description" : "Cloud service provider on which MongoDB Cloud provisioned the serverless instance.", - "enum" : [ "AWS", "AZURE", "GCP" ], - "writeOnly" : true + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "porterStemming" ] + } + }, + "required" : [ "type" ], + "title" : "porterStemming" + }, + "TokenFilterSpanishPluralStemming" : { + "type" : "object", + "description" : "Filter that stems Spanish plural words. It expects lowercase text.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "spanishPluralStemming" ] + } + }, + "required" : [ "type" ], + "title" : "spanishPluralStemming" + }, + "TokenFilterStempel" : { + "type" : "object", + "description" : "Filter that uses Lucene's default Polish stemmer table to stem words in the Polish language. It expects lowercase text.", + "externalDocs" : { + "description" : "Default Polish stemmer table", + "url" : "https://lucene.apache.org/core/9_2_0/analysis/stempel/org/apache/lucene/analysis/pl/PolishAnalyzer.html#DEFAULT_STEMMER_FILE" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "stempel" ] + } + }, + "required" : [ "type" ], + "title" : "stempel" + }, + "TokenFilterWordDelimiterGraph" : { + "type" : "object", + "description" : "Filter that splits tokens into sub-tokens based on configured rules.", + "properties" : { + "delimiterOptions" : { + "type" : "object", + "description" : "Object that contains the rules that determine how to split words into sub-words.", + "properties" : { + "concatenateAll" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to concatenate runs." + }, + "concatenateNumbers" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to concatenate runs of sub-numbers." + }, + "concatenateWords" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to concatenate runs of sub-words." + }, + "generateNumberParts" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on sub-numbers. For example, if `true`, this option splits `100-2` into `100` and `2`." + }, + "generateWordParts" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on sub-words." + }, + "ignoreKeywords" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to skip tokens with the `keyword` attribute set to `true`" + }, + "preserveOriginal" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to generate tokens of the original words." + }, + "splitOnCaseChange" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on letter-case transitions." + }, + "splitOnNumerics" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on letter-number transitions." + }, + "stemEnglishPossessive" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to remove trailing possessives from each sub-word." + } + } }, - "diskSizeGB" : { - "type" : "number", - "format" : "double", - "description" : "Storage capacity available to the USS instance expressed in gigabytes.", - "readOnly" : true + "protectedWords" : { + "type" : "object", + "description" : "Object that contains options for protected words.", + "properties" : { + "ignoreCase" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to ignore letter case sensitivity for protected words." + }, + "words" : { + "type" : "array", + "description" : "List that contains the tokens to protect from delimination.", + "items" : { + "type" : "string" + } + } + }, + "required" : [ "words" ] }, - "providerName" : { + "type" : { "type" : "string", - "default" : "USS", - "description" : "Human-readable label that identifies the cloud service provider.", - "enum" : [ "USS" ], - "readOnly" : true + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "wordDelimiterGraph" ] + } + }, + "required" : [ "type" ], + "title" : "wordDelimiterGraph" + }, + "TokenFilterkStemming" : { + "type" : "object", + "description" : "Filter that combines algorithmic stemming with a built-in dictionary for the English language to stem words.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "kStemming" ] + } + }, + "required" : [ "type" ], + "title" : "kStemming" + }, + "TriggerIngestionPipelineRequest" : { + "type" : "object", + "properties" : { + "datasetRetentionPolicy" : { + "$ref" : "#/components/schemas/DatasetRetentionPolicy" }, - "regionName" : { + "snapshotId" : { "type" : "string", - "description" : "Human-readable label that identifies the geographic location of your MongoDB USS 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/).", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "writeOnly" : true } }, - "required" : [ "backingProviderName", "regionName" ], - "title" : "Cloud Service Provider Settings for a USS Instance", - "writeOnly" : true + "required" : [ "snapshotId" ] }, "UpdateAtlasOrganizationApiKey" : { "type" : "object", @@ -50984,7 +52419,7 @@ "description" : "Human-readable label that identifies the cluster or MongoDB Atlas Data Lake that this database user can access.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, "type" : { "type" : "string", @@ -51040,6 +52475,32 @@ "required" : [ "match" ], "title" : "User to Distinguished Name Mapping" }, + "VPCPeeringActionChallenge" : { + "type" : "object", + "description" : "Container for elements used to challenge the user before taking certain actions on VPC Peering connections.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "requesterAccountId" : { + "type" : "string", + "description" : "The AWS requester account ID." + }, + "requesterVpcId" : { + "type" : "string", + "description" : "The AWS requester VPC ID." + } + } + }, "VectorSearchHostStatusDetail" : { "type" : "object", "properties" : { diff --git a/tools/cli/test/data/split/dev/openapi-v2-2023-11-15.yaml b/tools/cli/test/data/split/dev/openapi-v2-2023-11-15.yaml index 95494e69b1..29eb9eac8b 100644 --- a/tools/cli/test/data/split/dev/openapi-v2-2023-11-15.yaml +++ b/tools/cli/test/data/split/dev/openapi-v2-2023-11-15.yaml @@ -13,13 +13,15 @@ info: ``` To learn more, see [Get Started with the Atlas Administration API](https://www.mongodb.com/docs/atlas/configure-api-access/). For support, see [MongoDB Support](https://www.mongodb.com/support/get-started). + + You can also explore the various endpoints available through the Atlas Administration API in MongoDB's [Postman workspace](https://www.postman.com/mongodb-devrel/workspace/mongodb-atlas-administration-apis/). license: name: CC BY-NC-SA 3.0 US url: https://creativecommons.org/licenses/by-nc-sa/3.0/us/ termsOfService: https://www.mongodb.com/mongodb-management-service-terms-and-conditions title: MongoDB Atlas Administration API version: "2.0" - x-xgen-sha: 09d9d18db2111c955a8e01702a27ca2763417782 + x-xgen-sha: e6ba3136dbd0be2a81dd4ed21b9e6c470edd4420 servers: - url: https://cloud.mongodb.com tags: @@ -82,8 +84,12 @@ tags: \ resource requires your project ID. Changes to federated database instance configurations\ \ can affect costs." name: Data Federation -- description: "Returns, adds, edits, and removes Atlas Data Lake Pipelines and associated\ +- description: "Returns, edits, and removes Atlas Data Lake Pipelines and associated\ \ runs." + externalDocs: + description: Data Lake Pipelines are deprecated. Please see Data Lake Deprecation + Guide. + url: https://dochub.mongodb.org/core/data-lake-deprecation name: Data Lake Pipelines - description: "Returns, adds, edits, and removes database users." name: Database Users @@ -158,6 +164,8 @@ tags: - description: "You can continually push logs from mongod, mongos, and audit logs\ \ to an AWS S3 bucket. Atlas exports logs every 5 minutes." name: Push-Based Log Export +- description: Configure and manage Atlas Resource Policies within your organization. + name: Resource Policies - description: Creates one index to a database deployment in a rolling manner. You can't create a rolling index on an `M0` free cluster or `M2/M5` shared cluster. name: Rolling Index @@ -173,6 +181,13 @@ tags: description: Set Up a Private Endpoint for a Serverless Instance Tutorial url: https://dochub.mongodb.org/core/serverless-private-endpoint name: Serverless Private Endpoints +- description: Endpoints for managing Service Accounts and secrets. Service Accounts + are used for programmatic access to the Atlas Admin API through the OAuth 2.0 + Client Credentials flow. This feature is available as a Preview feature. + externalDocs: + description: Get Started with the Atlas Administration API + url: https://www.mongodb.com/docs/atlas/configure-api-access/ + name: Service Accounts - description: Returns and adds restore jobs for shared-tier database deployments. name: Shared-Tier Restore Jobs - description: Returns and requests to download shared-tier database deployment snapshots. @@ -2350,9 +2365,9 @@ paths: /api/atlas/v2/groups/{groupId}/backup/exportBuckets: get: deprecated: true - description: "Returns all AWS S3 buckets and Azure Blob Storage Containers associated\ - \ with the specified Project. To use this resource, the requesting API Key\ - \ must have the Project Read Only role." + description: "Returns all Export Buckets associated with the specified Project.\ + \ To use this resource, the requesting API Key must have the Project Read\ + \ Only role." operationId: listExportBuckets parameters: - $ref: "#/components/parameters/envelope" @@ -2375,17 +2390,17 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Return All AWS S3 Buckets and Azure Blob Storage Containers Used for - Cloud Backup Snapshot Exports + summary: Return All Snapshot Export Buckets tags: - Cloud Backups - x-sunset: 2025-05-30 + x-sunset: 2026-05-30 post: deprecated: true - description: "Grants MongoDB Cloud access to the specified AWS S3 Bucket or\ - \ Azure Blob Storage Container. This enables this Export Bucket to receive\ - \ Atlas Cloud Backup Snapshots. To use this resource, the requesting API Key\ - \ must have the Project Owner role." + description: "Creates a Snapshot Export Bucket for an AWS S3 Bucket or Azure\ + \ Blob Storage Container. Once created, an snapshots can be exported to the\ + \ Export Bucket and its referenced AWS S3 Bucket or Azure Blob Storage Container.\ + \ To use this resource, the requesting API Key must have the Project Owner\ + \ role." operationId: createExportBucket parameters: - $ref: "#/components/parameters/envelope" @@ -2398,8 +2413,8 @@ paths: $ref: "#/components/schemas/DiskBackupSnapshotAWSExportBucket" x-sunset: 2025-05-30 x-xgen-version: 2023-01-01 - description: Grants MongoDB Cloud access to the specified AWS S3 Bucket or - Azure Blob Storage Container. + description: Specifies the role and AWS S3 Bucket or Azure Blob Storage Container + that the Export Bucket should reference. required: true responses: "200": @@ -2419,25 +2434,22 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Grant Access to AWS S3 Bucket or Azure Blob Storage Container for Cloud - Backup Snapshot Exports + summary: Create One Snapshot Export Bucket tags: - Cloud Backups - x-sunset: 2025-05-30 + x-sunset: 2026-05-30 /api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}: delete: - description: "Revoke MongoDB Cloud access to the specified AWS S3 Bucket or\ - \ Azure Blob Storage Container. This prevents this Export Bucket from receiving\ - \ Atlas Cloud Backup Snapshots. 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 API Key must have the Project Owner\ - \ role." + 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 API Key must have the Project\ + \ Owner role." operationId: deleteExportBucket parameters: - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/groupId" - - description: Unique string that identifies the AWS S3 Bucket or Azure Blob - Storage Container to which you export your Snapshots. + - description: Unique 24-hexadecimal character string that identifies the Export + Bucket. in: path name: exportBucketId required: true @@ -2465,15 +2477,14 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Revoke Access to AWS S3 Bucket or Azure Blob Storage Container for - Cloud Backup Snapshot Exports + summary: Delete One Snapshot Export Bucket tags: - Cloud Backups get: deprecated: true - description: "Returns one AWS S3 Bucket or Azure Blob Storage Container associated\ - \ with the specified Project. To use this resource, the requesting API Key\ - \ must have the Project Read Only role." + description: "Returns one Export Bucket associated with the specified Project.\ + \ To use this resource, the requesting API Key must have the Project Read\ + \ Only role." operationId: getExportBucket parameters: - $ref: "#/components/parameters/envelope" @@ -2505,11 +2516,10 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Return One AWS S3 Bucket or Azure Blob Storage Container Used for Cloud - Backup Snapshot Exports + summary: Return One Snapshot Export Bucket tags: - Cloud Backups - x-sunset: 2025-05-30 + x-sunset: 2026-05-30 /api/atlas/v2/groups/{groupId}/backupCompliancePolicy: get: description: "Returns the Backup Compliance Policy settings with the specified\ @@ -2628,7 +2638,7 @@ paths: content: application/vnd.atlas.2023-01-01+json: schema: - $ref: "#/components/schemas/CloudProviderAccessRole" + $ref: "#/components/schemas/CloudProviderAccessRoleRequest" description: Creates one role for the specified cloud provider. required: true responses: @@ -2667,6 +2677,8 @@ paths: type: string enum: - AWS + - AZURE + - GCP - description: Unique 24-hexadecimal digit string that identifies the role. in: path name: roleId @@ -2733,7 +2745,8 @@ paths: description: "Grants access to the specified project for the specified access\ \ role. To use this resource, the requesting API Key must have the Project\ \ Owner role. This API endpoint is one step in a procedure to create unified\ - \ access for MongoDB Cloud services." + \ 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/ @@ -2755,7 +2768,7 @@ paths: content: application/vnd.atlas.2023-01-01+json: schema: - $ref: "#/components/schemas/CloudProviderAccessRole" + $ref: "#/components/schemas/CloudProviderAccessRoleRequestUpdate" description: Grants access to the specified project for the specified access role. required: true @@ -3014,7 +3027,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster. in: query @@ -3062,7 +3075,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -3110,7 +3123,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-02-01+json: @@ -3144,7 +3157,7 @@ paths: x-sunset: 2026-03-01 /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports: get: - description: "Returns all Cloud Backup snapshot export jobs associated with\ + description: "Returns all Cloud Backup Snapshot Export Jobs associated with\ \ the specified Atlas cluster. To use this resource, the requesting API Key\ \ must have the Project Atlas Admin role." operationId: listBackupExportJobs @@ -3163,7 +3176,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -3178,11 +3191,11 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Return All Cloud Backup Snapshot Export Jobs + summary: Return All Snapshot Export Jobs tags: - Cloud Backups post: - description: "Exports one backup snapshot for dedicated Atlas cluster using\ + description: "Exports one backup Snapshot for dedicated Atlas cluster using\ \ Cloud Backups to an Export Bucket. To use this resource, the requesting\ \ API Key must have the Project Atlas Admin role." operationId: createBackupExportJob @@ -3197,7 +3210,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -3225,12 +3238,12 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Create One Cloud Backup Snapshot Export Job + summary: Create One Snapshot Export Job tags: - Cloud Backups /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}: get: - description: "Returns one Cloud Backup snapshot export job associated with the\ + description: "Returns one Cloud Backup Snapshot Export Job associated with the\ \ specified Atlas cluster. To use this resource, the requesting API Key must\ \ have the Project Atlas Admin role." operationId: getBackupExportJob @@ -3245,13 +3258,18 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - - description: Unique string that identifies the export job to return. + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + - description: Unique 24-hexadecimal character string that identifies the Export + Job. in: path name: exportId required: true schema: type: string + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" responses: "200": content: @@ -3266,7 +3284,7 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Return One Cloud Backup Snapshot Export Job + summary: Return One Snapshot Export Job tags: - Cloud Backups /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs: @@ -3291,7 +3309,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -3327,7 +3345,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -3376,7 +3394,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the restore job to remove. in: path @@ -3424,7 +3442,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the restore job to return. in: path @@ -3471,7 +3489,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -3491,7 +3509,7 @@ paths: summary: Remove All Cloud Backup Schedules tags: - Cloud Backups - x-sunset: 2025-08-05 + x-sunset: 2026-05-30 get: deprecated: true description: "Returns the cloud backup schedule for the specified cluster within\ @@ -3511,7 +3529,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -3529,7 +3547,7 @@ paths: summary: Return One Cloud Backup Schedule tags: - Cloud Backups - x-sunset: 2025-08-05 + x-sunset: 2026-05-30 patch: deprecated: true description: "Updates the cloud backup schedule for one cluster within the specified\ @@ -3549,7 +3567,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -3579,7 +3597,7 @@ paths: summary: Update Cloud Backup Schedule for One Cluster tags: - Cloud Backups - x-sunset: 2025-08-05 + x-sunset: 2026-05-30 /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots: get: description: "Returns all snapshots of one cluster from the specified project.\ @@ -3601,7 +3619,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -3639,7 +3657,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -3684,7 +3702,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -3729,7 +3747,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -3777,7 +3795,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -3814,7 +3832,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -3860,7 +3878,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -3906,7 +3924,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -3961,7 +3979,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/groupId" - $ref: "#/components/parameters/pretty" @@ -4015,7 +4033,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/groupId" - $ref: "#/components/parameters/pretty" @@ -4064,7 +4082,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/groupId" - $ref: "#/components/parameters/pretty" @@ -4101,7 +4119,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/groupId" - $ref: "#/components/parameters/pretty" @@ -4152,7 +4170,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -4190,7 +4208,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -4243,7 +4261,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -4290,7 +4308,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -4329,7 +4347,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -4367,7 +4385,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-11-15+json: @@ -4421,7 +4439,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-11-15+json: @@ -4475,7 +4493,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-11-15+json: @@ -4530,7 +4548,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -4584,7 +4602,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Name of the collection that contains one or more Atlas Search indexes. in: path @@ -4642,7 +4660,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: "Unique 24-hexadecimal digit string that identifies the Atlas\ \ Search index. Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/)\ \ endpoint to find the IDs of all Atlas Search indexes." @@ -4697,7 +4715,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - 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/)\ @@ -4751,7 +4769,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - 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/)\ @@ -4816,7 +4834,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -4860,7 +4878,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -4902,7 +4920,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-02-01+json: @@ -4954,7 +4972,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - $ref: "#/components/parameters/groupId" - description: Human-readable label that identifies the database that contains the collection. @@ -5011,7 +5029,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-02-01+json: @@ -5066,7 +5084,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -5181,7 +5199,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5220,7 +5238,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -5298,7 +5316,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Flag that indicates whether to download logs for queries against your online archive only or both your online archive and cluster. in: query @@ -5365,7 +5383,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "204": content: @@ -5416,7 +5434,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5469,7 +5487,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -5520,7 +5538,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5561,7 +5579,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5602,7 +5620,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -5655,7 +5673,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5701,7 +5719,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -5754,7 +5772,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5807,7 +5825,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5857,7 +5875,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -5905,7 +5923,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the restore job. in: path @@ -5952,7 +5970,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5990,7 +6008,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -6028,7 +6046,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -6074,7 +6092,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -6125,7 +6143,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -6163,7 +6181,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -6217,7 +6235,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: "Human-readable label that specifies whether to return only completed,\ \ incomplete, or all snapshots. By default, MongoDB Cloud only returns completed\ \ snapshots." @@ -6272,7 +6290,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -6326,7 +6344,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -6379,7 +6397,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -6434,7 +6452,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -6468,7 +6486,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Human-readable label that identifies the cluster topology to retrieve metrics for. in: path @@ -6517,7 +6535,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Human-readable label that identifies the cluster topology to retrieve metrics for. in: path @@ -6638,18 +6656,22 @@ paths: externalDocs: description: Set up Database Auditing url: https://docs.atlas.mongodb.com/database-auditing/ - - description: Date and time when the period specifies the inclusive ending - point for the range of log messages to retrieve. This parameter expresses - its value in the number of seconds that have elapsed since the UNIX epoch. + - description: "Specifies the date and time for the ending point of the range\ + \ of log messages to retrieve, in the number of seconds that have elapsed\ + \ since the UNIX epoch. This value will default to 24 hours after the start\ + \ date. If the start date is also unspecified, the value will default to\ + \ the time of the request." in: query name: endDate schema: type: integer format: int64 minimum: 1199145600 - - description: Date and time when the period specifies the inclusive starting - point for the range of log messages to retrieve. This parameter expresses - its value in the number of seconds that have elapsed since the UNIX epoch. + - description: "Specifies the date and time for the starting point of the range\ + \ of log messages to retrieve, in the number of seconds that have elapsed\ + \ since the UNIX epoch. This value will default to 24 hours prior to the\ + \ end date. If the end date is also unspecified, the value will default\ + \ to 24 hours prior to the time of the request." in: query name: startDate schema: @@ -8115,7 +8137,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: "Date and time when to stop retrieving database history. If you\ \ specify **end**, you must also specify **start**. This parameter uses\ \ UNIX epoch time in milliseconds." @@ -8334,6 +8356,9 @@ paths: - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/pretty" - $ref: "#/components/parameters/groupId" + - $ref: "#/components/parameters/includeCount" + - $ref: "#/components/parameters/itemsPerPage" + - $ref: "#/components/parameters/pageNum" - description: Human-readable label that identifies the cloud provider for the private endpoints to return. in: path @@ -8431,14 +8456,6 @@ paths: maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" - requestBody: - content: - application/vnd.atlas.2023-01-01+json: - schema: - $ref: "#/components/schemas/EncryptionAtRestPrivateEndpointRequest" - description: Cloud provider of the private endpoints to delete and the list - of cloud provider regions in which to delete the private endpoints. - required: true responses: "204": content: @@ -8493,6 +8510,8 @@ paths: description: OK "403": $ref: "#/components/responses/forbidden" + "404": + $ref: "#/components/responses/notFound" "500": $ref: "#/components/responses/internalServerError" security: @@ -8524,7 +8543,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" style: form - description: |- Category of incident recorded at this moment in time. @@ -9151,7 +9170,7 @@ paths: summary: Return All Project Invitations tags: - Projects - x-sunset: 2024-10-04 + x-sunset: 2024-11-04 patch: deprecated: true description: "Updates the details of one pending invitation to the specified\ @@ -9192,7 +9211,7 @@ paths: summary: Update One Project Invitation tags: - Projects - x-sunset: 2024-10-04 + x-sunset: 2024-11-04 post: deprecated: true description: "Invites one MongoDB Cloud user to join the specified project.\ @@ -9228,7 +9247,7 @@ paths: summary: Invite One MongoDB Cloud User to Join One Project tags: - Projects - x-sunset: 2024-10-04 + x-sunset: 2024-11-04 /api/atlas/v2/groups/{groupId}/invites/{invitationId}: delete: deprecated: true @@ -9266,7 +9285,7 @@ paths: summary: Cancel One Project Invitation tags: - Projects - x-sunset: 2024-10-04 + x-sunset: 2024-11-04 get: deprecated: true description: "Returns the details of one pending invitation to the specified\ @@ -9305,7 +9324,7 @@ paths: summary: Return One Project Invitation tags: - Projects - x-sunset: 2024-10-04 + x-sunset: 2024-11-04 patch: deprecated: true description: "Updates the details of one pending invitation to the specified\ @@ -9355,7 +9374,7 @@ paths: summary: Update One Project Invitation by Invitation ID tags: - Projects - x-sunset: 2024-10-04 + x-sunset: 2024-11-04 /api/atlas/v2/groups/{groupId}/ipAddresses: get: description: "Returns all IP addresses for this project. To use this resource,\ @@ -9431,7 +9450,7 @@ paths: | Limit Name | Description | Default | API Override Limit | | --- | --- | --- | --- | - | atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 | + | atlas.project.deployment.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 | @@ -9443,6 +9462,7 @@ paths: | 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 | in: path name: limitName required: true @@ -9462,6 +9482,7 @@ paths: - 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" @@ -9496,7 +9517,7 @@ paths: | Limit Name | Description | Default | API Override Limit | | --- | --- | --- | --- | - | atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 | + | atlas.project.deployment.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 | @@ -9508,6 +9529,7 @@ paths: | 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 | in: path name: limitName required: true @@ -9527,6 +9549,7 @@ paths: - 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" @@ -9565,7 +9588,7 @@ paths: | Limit Name | Description | Default | API Override Limit | | --- | --- | --- | --- | - | atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 | + | atlas.project.deployment.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 | @@ -9577,6 +9600,7 @@ paths: | 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 | in: path name: limitName required: true @@ -9596,6 +9620,7 @@ paths: - 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" @@ -10373,6 +10398,7 @@ paths: - Network Peering /api/atlas/v2/groups/{groupId}/pipelines: get: + deprecated: true description: "Returns a list of Data Lake Pipelines. To use this resource, the\ \ requesting API Key must have the Project Read Only role." operationId: listPipelines @@ -10400,8 +10426,14 @@ paths: summary: Return All Data Lake Pipelines from One Project tags: - Data Lake Pipelines + x-sunset: 2025-09-09 post: + deprecated: true description: Creates one Data Lake Pipeline. + externalDocs: + description: Data Lake Pipelines are deprecated. Please see Data Lake Deprecation + Guide. + url: https://dochub.mongodb.org/core/data-lake-deprecation operationId: createPipeline parameters: - $ref: "#/components/parameters/envelope" @@ -10434,8 +10466,10 @@ paths: summary: Create One Data Lake Pipeline tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}: delete: + deprecated: true description: Removes one Data Lake Pipeline. operationId: deletePipeline parameters: @@ -10469,7 +10503,9 @@ paths: summary: Remove One Data Lake Pipeline tags: - Data Lake Pipelines + x-sunset: 2025-09-09 get: + deprecated: true description: "Returns the details of one Data Lake Pipeline within the specified\ \ project. To use this resource, the requesting API Key must have the Project\ \ Read Only role." @@ -10506,7 +10542,9 @@ paths: summary: Return One Data Lake Pipeline tags: - Data Lake Pipelines + x-sunset: 2025-09-09 patch: + deprecated: true description: Updates one Data Lake Pipeline. operationId: updatePipeline parameters: @@ -10551,8 +10589,10 @@ paths: summary: Update One Data Lake Pipeline tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules: get: + deprecated: true description: "Returns a list of backup schedule policy items that you can use\ \ as a Data Lake Pipeline source. To use this resource, the requesting API\ \ Key must have the Project Read Only role." @@ -10591,8 +10631,10 @@ paths: summary: Return Available Ingestion Schedules for One Data Lake Pipeline tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots: get: + deprecated: true description: "Returns a list of backup snapshots that you can use to trigger\ \ an on demand pipeline run. To use this resource, the requesting API Key\ \ must have the Project Read Only role." @@ -10642,8 +10684,10 @@ paths: summary: Return Available Backup Snapshots for One Data Lake Pipeline tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause: post: + deprecated: true description: "Pauses ingestion for a Data Lake Pipeline within the specified\ \ project. To use this resource, the requesting API Key must have the Project\ \ Read Only role." @@ -10680,8 +10724,10 @@ paths: summary: Pause One Data Lake Pipeline tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume: post: + deprecated: true description: "Resumes ingestion for a Data Lake Pipeline within the specified\ \ project. To use this resource, the requesting API Key must have the Project\ \ Read Only role." @@ -10718,8 +10764,10 @@ paths: summary: Resume One Data Lake Pipeline tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs: get: + deprecated: true description: "Returns a list of past Data Lake Pipeline runs. To use this resource,\ \ the requesting API Key must have the Project Read Only role." operationId: listPipelineRuns @@ -10766,8 +10814,10 @@ paths: summary: Return All Data Lake Pipeline Runs from One Project tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}: delete: + deprecated: true description: Deletes dataset that Atlas generated during the specified pipeline run. operationId: deletePipelineRunDataset @@ -10814,7 +10864,9 @@ paths: summary: Delete Pipeline Run Dataset tags: - Data Lake Pipelines + x-sunset: 2025-09-09 get: + deprecated: true description: "Returns the details of one Data Lake Pipeline run within the specified\ \ project. To use this resource, the requesting API Key must have the Project\ \ Read Only role." @@ -10862,8 +10914,10 @@ paths: summary: Return One Data Lake Pipeline Run tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger: post: + deprecated: true description: Triggers a Data Lake Pipeline ingestion of a specified snapshot. operationId: triggerSnapshotIngestion parameters: @@ -10905,6 +10959,7 @@ paths: summary: Trigger on demand snapshot ingestion tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService: post: description: "Creates one private endpoint service for the specified cloud service\ @@ -11036,7 +11091,7 @@ paths: schema: type: string maxLength: 64 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -11078,7 +11133,7 @@ paths: schema: type: string maxLength: 64 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -11122,7 +11177,7 @@ paths: schema: type: string maxLength: 64 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be removed. in: path @@ -11168,7 +11223,7 @@ paths: schema: type: string maxLength: 64 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the tenant endpoint. in: path @@ -11213,7 +11268,7 @@ paths: schema: type: string maxLength: 64 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be updated. in: path @@ -12235,6 +12290,8 @@ paths: - 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 maxItems: 10 minItems: 1 uniqueItems: true @@ -12319,6 +12376,8 @@ paths: - CACHE_BYTES_WRITTEN_FROM - CACHE_DIRTY_BYTES - CACHE_USED_BYTES + - CACHE_FILL_RATIO + - DIRTY_FILL_RATIO - COMPUTED_MEMORY - CONNECTIONS - CURSORS_TOTAL_OPEN @@ -12400,6 +12459,7 @@ paths: - 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 @@ -12942,7 +13002,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "201": content: @@ -13087,7 +13147,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -13125,7 +13185,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -13175,7 +13235,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the restore job to return. in: path @@ -13226,7 +13286,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -13263,7 +13323,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -13308,7 +13368,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/pretty" responses: @@ -13341,7 +13401,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Value that we want to set for the Serverless Auto Indexing toggle. in: query name: enable @@ -13385,15 +13445,15 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: - "204": + "202": content: application/vnd.atlas.2023-01-01+json: schema: - $ref: "#/components/schemas/NoBody" + $ref: "#/components/schemas/RequestAccepted" x-xgen-version: 2023-01-01 - description: This endpoint does not return a response body. + description: Accepted "400": $ref: "#/components/responses/badRequest" "404": @@ -13424,7 +13484,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -13462,7 +13522,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -13489,222 +13549,6 @@ paths: summary: Update One Serverless Instance in One Project tags: - Serverless Instances - /api/atlas/v2/groups/{groupId}/serviceAccounts: - get: - description: Returns list of Service Accounts for a project with service account - details. - operationId: listProjectServiceAccounts - parameters: - - $ref: "#/components/parameters/groupId" - - $ref: "#/components/parameters/itemsPerPage" - - $ref: "#/components/parameters/pageNum" - - $ref: "#/components/parameters/pretty" - - $ref: "#/components/parameters/envelope" - responses: - "200": - content: - application/vnd.atlas.2023-10-01+json: - schema: - $ref: "#/components/schemas/PaginatedGroupServiceAccounts" - x-xgen-version: 2023-10-01 - description: OK - "401": - $ref: "#/components/responses/unauthorized" - "403": - $ref: "#/components/responses/forbidden" - "500": - $ref: "#/components/responses/internalServerError" - security: - - DigestAuth: [] - summary: Return All project Service Accounts - tags: - - Groups - post: - description: Creates and assigns the specified Service Account to the specified - Project. - operationId: createProjectServiceAccount - parameters: - - $ref: "#/components/parameters/groupId" - - $ref: "#/components/parameters/envelope" - - $ref: "#/components/parameters/pretty" - requestBody: - content: - application/vnd.atlas.2023-10-01+json: - schema: - $ref: "#/components/schemas/GroupServiceAccountRequest" - x-xgen-version: 2023-10-01 - description: Details to create service account and add to the specified project. - required: true - responses: - "201": - content: - application/vnd.atlas.2023-10-01+json: - schema: - $ref: "#/components/schemas/GroupServiceAccount" - x-xgen-version: 2023-10-01 - description: Created - "400": - $ref: "#/components/responses/badRequest" - "401": - $ref: "#/components/responses/unauthorized" - "500": - $ref: "#/components/responses/internalServerError" - security: - - DigestAuth: [] - summary: Create and Assign one Service Account to one project - tags: - - Groups - /api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}: - delete: - description: Removes one Service Account from the specified project. - operationId: deleteProjectServiceAccount - parameters: - - description: Id of the service account. - in: path - name: serviceAccountId - required: true - schema: - type: string - - $ref: "#/components/parameters/groupId" - - $ref: "#/components/parameters/envelope" - - $ref: "#/components/parameters/pretty" - responses: - "204": - content: - application/vnd.atlas.2023-10-01+json: - schema: - $ref: "#/components/schemas/NoBody" - x-xgen-version: 2023-10-01 - description: This endpoint does not return a response body. - x-xgen-version: 2023-10-01 - "401": - $ref: "#/components/responses/unauthorized" - "404": - $ref: "#/components/responses/notFound" - "500": - $ref: "#/components/responses/internalServerError" - security: - - DigestAuth: [] - summary: Unassign One Service Account from One Project. - tags: - - Groups - get: - description: Get project Service Account Details. - operationId: getProjectServiceAccount - parameters: - - $ref: "#/components/parameters/groupId" - - description: Id of the service account. - in: path - name: serviceAccountId - required: true - schema: - type: string - - $ref: "#/components/parameters/envelope" - - $ref: "#/components/parameters/pretty" - responses: - "200": - content: - application/vnd.atlas.2023-10-01+json: - schema: - $ref: "#/components/schemas/GroupServiceAccount" - x-xgen-version: 2023-10-01 - description: OK - "401": - $ref: "#/components/responses/unauthorized" - "404": - $ref: "#/components/responses/notFound" - "500": - $ref: "#/components/responses/internalServerError" - security: - - DigestAuth: [] - summary: Service Account Fetching - tags: - - Groups - patch: - description: Update Service Account in Project. - operationId: updateProjectServiceAccount - parameters: - - description: Id of the service account. - in: path - name: serviceAccountId - required: true - schema: - type: string - - $ref: "#/components/parameters/groupId" - - $ref: "#/components/parameters/envelope" - - $ref: "#/components/parameters/pretty" - requestBody: - content: - application/vnd.atlas.2023-10-01+json: - schema: - $ref: "#/components/schemas/GroupServiceAccountUpdateRequest" - description: Details to update service account in the specified Project. - required: true - responses: - "200": - content: - application/vnd.atlas.2023-10-01+json: - schema: - $ref: "#/components/schemas/GroupServiceAccount" - x-xgen-version: 2023-10-01 - description: OK - "400": - $ref: "#/components/responses/badRequest" - "401": - $ref: "#/components/responses/unauthorized" - "404": - $ref: "#/components/responses/notFound" - "500": - $ref: "#/components/responses/internalServerError" - security: - - DigestAuth: [] - summary: Service Account Update in Project - tags: - - Groups - post: - description: Assigns the specified organization Service Account to the specified - project. - operationId: addProjectServiceAccount - parameters: - - description: Id of the service account. - in: path - name: serviceAccountId - required: true - schema: - type: string - - $ref: "#/components/parameters/groupId" - - $ref: "#/components/parameters/envelope" - - $ref: "#/components/parameters/pretty" - requestBody: - content: - application/vnd.atlas.2023-10-01+json: - schema: - type: array - items: - $ref: "#/components/schemas/GroupServiceAccountRoleAssignment" - x-xgen-version: 2023-10-01 - description: Service Account Roles to be assigned to the specified project. - required: true - responses: - "204": - content: - application/vnd.atlas.2023-10-01+json: - schema: - $ref: "#/components/schemas/NoBody" - x-xgen-version: 2023-10-01 - description: This endpoint does not return a response body. - x-xgen-version: 2023-10-01 - "401": - $ref: "#/components/responses/unauthorized" - "404": - $ref: "#/components/responses/notFound" - "500": - $ref: "#/components/responses/internalServerError" - security: - - DigestAuth: [] - summary: Assign One Service Account to One Project - tags: - - Groups /api/atlas/v2/groups/{groupId}/settings: get: description: "Returns details about the specified project's settings. To use\ @@ -13841,19 +13685,305 @@ paths: x-xgen-changelog: "2023-09-11": "The MongoDB Atlas Streams Processing API is now exposed as\ \ part of private preview, but is subject to change until GA." - /api/atlas/v2/groups/{groupId}/streams/{tenantName}: + /api/atlas/v2/groups/{groupId}/streams/privateLinkConnections: + get: + description: "Returns all Private Link connections for the specified project.To\ + \ use this resource, the requesting API Key must have the Project Data Access\ + \ roles, Project Owner role or Project Stream Processing Owner role." + operationId: listPrivateLinkConnections + parameters: + - $ref: "#/components/parameters/groupId" + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/itemsPerPage" + - $ref: "#/components/parameters/pageNum" + - $ref: "#/components/parameters/pretty" + responses: + "200": + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/PaginatedApiStreamsPrivateLinkView" + x-xgen-version: 2023-02-01 + description: OK + "401": + $ref: "#/components/responses/unauthorized" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Return All Private Link + tags: + - Streams + x-xgen-changelog: + "2024-10-02": "The MongoDB Atlas Streams Processing Private Link API is now\ + \ exposed as part of private preview, but is subject to change until GA." + post: + description: "Creates one Private Link in the specified project. To use this\ + \ resource, the requesting API Key must have the Project Owner or Project\ + \ Stream Processing Owner role." + operationId: createPrivateLinkConnection + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/pretty" + - $ref: "#/components/parameters/groupId" + requestBody: + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/StreamsPrivateLinkConnection" + description: Details to create one Private Link connection for a project. + project. + required: true + responses: + "200": + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/StreamsPrivateLinkConnection" + x-xgen-version: 2023-02-01 + description: OK + "400": + $ref: "#/components/responses/badRequest" + "401": + $ref: "#/components/responses/unauthorized" + "409": + $ref: "#/components/responses/unauthorized" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Create One Private Link connection + tags: + - Streams + x-xgen-changelog: + "2024-10-02": "The MongoDB Atlas Streams Processing Private Link API is now\ + \ exposed as part of private preview, but is subject to change until GA." + /api/atlas/v2/groups/{groupId}/streams/privateLinkConnections/{connectionId}: delete: - description: "Delete one stream instance in the specified project. To use this\ - \ resource, the requesting API Key must have the Project Data Access Admin\ - \ role, Project Owner role or Project Stream Processing Owner role." - operationId: deleteStreamInstance + description: "Deletes one Private Link in the specified project. To use this\ + \ resource, the requesting API Key must have the Project Owner or Project\ + \ Stream Processing Owner role." + operationId: deletePrivateLinkConnection parameters: - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/pretty" - $ref: "#/components/parameters/groupId" - - description: Human-readable label that identifies the stream instance to delete. + - description: Unique ID that identifies the Private Link connection. in: path - name: tenantName + name: connectionId + required: true + schema: + type: string + responses: + "202": + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/NoBody" + x-xgen-version: 2023-02-01 + description: Accepted + "401": + $ref: "#/components/responses/unauthorized" + "403": + $ref: "#/components/responses/forbidden" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Delete One Private Link connection + tags: + - Streams + x-xgen-changelog: + "2024-10-02": "The MongoDB Atlas Streams Processing Private Link API is now\ + \ exposed as part of private preview, but is subject to change until GA." + get: + description: "Returns the details of one Private Link connection within the\ + \ project. To use this resource, the requesting API Key must have the Project\ + \ Read Only role." + operationId: getPrivateLinkConnection + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/groupId" + - description: Unique ID that identifies the Private Link connection. + in: path + name: connectionId + required: true + schema: + type: string + responses: + "200": + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/StreamsPrivateLinkConnection" + x-xgen-version: 2023-02-01 + description: OK + "401": + $ref: "#/components/responses/unauthorized" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Return One PrivateLink Connection + tags: + - Streams + x-xgen-changelog: + "2024-10-02": "The MongoDB Atlas Streams Processing Private Link API is now\ + \ exposed as part of private preview, but is subject to change until GA." + /api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections: + get: + description: Returns a list of incoming VPC Peering Connections. + operationId: getVPCPeeringConnections + parameters: + - $ref: "#/components/parameters/groupId" + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/itemsPerPage" + - $ref: "#/components/parameters/pageNum" + - $ref: "#/components/parameters/pretty" + responses: + "200": + content: + application/vnd.atlas.2023-02-01+json: + x-xgen-version: 2023-02-01 + description: OK + "401": + $ref: "#/components/responses/unauthorized" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Return All VPC Peering Connections. + tags: + - Streams + /api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}: + delete: + description: Deletes an incoming VPC Peering connection. + operationId: deleteVPCPeeringConnection + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/groupId" + - description: The VPC Peering Connection id. + in: path + name: id + required: true + schema: + type: string + responses: + "202": + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/NoBody" + x-xgen-version: 2023-02-01 + description: Accepted + "401": + $ref: "#/components/responses/unauthorized" + "403": + $ref: "#/components/responses/forbidden" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Deletes an incoming VPC Peering connection. + tags: + - Streams + /api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:accept: + post: + description: Requests the acceptance of an incoming VPC Peering connection. + operationId: acceptVPCPeeringConnection + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/groupId" + - description: The VPC Peering Connection id. + in: path + name: id + required: true + schema: + type: string + requestBody: + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/VPCPeeringActionChallenge" + description: "Challenge values for VPC Peering requester account ID, and requester\ + \ VPC ID." + required: true + responses: + "202": + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/NoBody" + x-xgen-version: 2023-02-01 + description: Accepted + "401": + $ref: "#/components/responses/unauthorized" + "403": + $ref: "#/components/responses/forbidden" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Requests the acceptance of an incoming VPC Peering connection. + tags: + - Streams + /api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:reject: + post: + description: Requests the rejection of an incoming VPC Peering connection. + operationId: rejectVPCPeeringConnection + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/groupId" + - description: The VPC Peering Connection id. + in: path + name: id + required: true + schema: + type: string + responses: + "202": + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/NoBody" + x-xgen-version: 2023-02-01 + description: Accepted + "401": + $ref: "#/components/responses/unauthorized" + "403": + $ref: "#/components/responses/forbidden" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Requests the rejection of an incoming VPC Peering connection. + tags: + - Streams + /api/atlas/v2/groups/{groupId}/streams/{tenantName}: + delete: + description: "Delete one stream instance in the specified project. To use this\ + \ resource, the requesting API Key must have the Project Data Access Admin\ + \ role, Project Owner role or Project Stream Processing Owner role." + operationId: deleteStreamInstance + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/pretty" + - $ref: "#/components/parameters/groupId" + - description: Human-readable label that identifies the stream instance to delete. + in: path + name: tenantName required: true schema: type: string @@ -16224,284 +16354,6 @@ paths: summary: Create One Link-Token tags: - Cloud Migration Service - /api/atlas/v2/orgs/{orgId}/serviceAccounts: - get: - description: Returns list of Service Accounts with service account details. - operationId: listServiceAccounts - parameters: - - $ref: "#/components/parameters/orgId" - - $ref: "#/components/parameters/itemsPerPage" - - $ref: "#/components/parameters/pageNum" - - $ref: "#/components/parameters/pretty" - - $ref: "#/components/parameters/envelope" - responses: - "200": - content: - application/vnd.atlas.2023-10-01+json: - schema: - $ref: "#/components/schemas/PaginatedOrgServiceAccounts" - x-xgen-version: 2023-10-01 - description: OK - "401": - $ref: "#/components/responses/unauthorized" - "403": - $ref: "#/components/responses/forbidden" - "500": - $ref: "#/components/responses/internalServerError" - security: - - DigestAuth: [] - summary: Return All Service Accounts - tags: - - Organizations - post: - description: Create Service Account containing client id and client secrets. - operationId: createServiceAccount - parameters: - - $ref: "#/components/parameters/orgId" - - $ref: "#/components/parameters/envelope" - - $ref: "#/components/parameters/pretty" - requestBody: - content: - application/vnd.atlas.2023-10-01+json: - schema: - $ref: "#/components/schemas/OrgServiceAccountRequest" - description: Details to create service account in the specified organization. - required: true - responses: - "201": - content: - application/vnd.atlas.2023-10-01+json: - schema: - $ref: "#/components/schemas/OrgServiceAccount" - x-xgen-version: 2023-10-01 - description: Created - "400": - $ref: "#/components/responses/badRequest" - "401": - $ref: "#/components/responses/unauthorized" - "500": - $ref: "#/components/responses/internalServerError" - security: - - DigestAuth: [] - summary: Service Account Creation - tags: - - Organizations - /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}: - delete: - description: Delete Service Account. - operationId: deleteServiceAccount - parameters: - - description: Id of the service account. - in: path - name: serviceAccountId - required: true - schema: - type: string - - $ref: "#/components/parameters/orgId" - - $ref: "#/components/parameters/envelope" - - $ref: "#/components/parameters/pretty" - responses: - "204": - content: - application/vnd.atlas.2023-10-01+json: - x-xgen-version: 2023-10-01 - description: This endpoint does not return a response body. - "401": - $ref: "#/components/responses/unauthorized" - "404": - $ref: "#/components/responses/notFound" - "500": - $ref: "#/components/responses/internalServerError" - security: - - DigestAuth: [] - summary: Service Account Deletion. - tags: - - Organizations - get: - description: Get Service Account Details. - operationId: getServiceAccount - parameters: - - $ref: "#/components/parameters/orgId" - - description: Id of the service account. - in: path - name: serviceAccountId - required: true - schema: - type: string - - $ref: "#/components/parameters/envelope" - - $ref: "#/components/parameters/pretty" - responses: - "200": - content: - application/vnd.atlas.2023-10-01+json: - schema: - $ref: "#/components/schemas/OrgServiceAccount" - x-xgen-version: 2023-10-01 - description: OK - "401": - $ref: "#/components/responses/unauthorized" - "404": - $ref: "#/components/responses/notFound" - "500": - $ref: "#/components/responses/internalServerError" - security: - - DigestAuth: [] - summary: Service Account Fetching - tags: - - Organizations - patch: - description: Update Service Account. - operationId: updateServiceAccount - parameters: - - description: Id of the service account. - in: path - name: serviceAccountId - required: true - schema: - type: string - - $ref: "#/components/parameters/orgId" - - $ref: "#/components/parameters/envelope" - - $ref: "#/components/parameters/pretty" - requestBody: - content: - application/vnd.atlas.2023-10-01+json: - schema: - $ref: "#/components/schemas/OrgServiceAccountUpdateRequest" - description: Details to update service account in the specified organization. - required: true - responses: - "200": - content: - application/vnd.atlas.2023-10-01+json: - schema: - $ref: "#/components/schemas/OrgServiceAccount" - x-xgen-version: 2023-10-01 - description: OK - "400": - $ref: "#/components/responses/badRequest" - "401": - $ref: "#/components/responses/unauthorized" - "404": - $ref: "#/components/responses/notFound" - "500": - $ref: "#/components/responses/internalServerError" - security: - - DigestAuth: [] - summary: Service Account Update - tags: - - Organizations - /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/groups: - get: - description: Returns list of Service Account projects. - operationId: listServiceAccountProjects - parameters: - - $ref: "#/components/parameters/orgId" - - description: Id of the service account. - in: path - name: serviceAccountId - required: true - schema: - type: string - - $ref: "#/components/parameters/itemsPerPage" - - $ref: "#/components/parameters/pageNum" - - $ref: "#/components/parameters/pretty" - - $ref: "#/components/parameters/envelope" - responses: - "200": - content: - application/vnd.atlas.2023-10-01+json: - schema: - $ref: "#/components/schemas/PaginatedServiceAccountGroup" - x-xgen-version: 2023-10-01 - description: OK - "401": - $ref: "#/components/responses/unauthorized" - "403": - $ref: "#/components/responses/forbidden" - "500": - $ref: "#/components/responses/internalServerError" - security: - - DigestAuth: [] - summary: Return All Service Account projects - tags: - - Organizations - /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets: - post: - description: Create Service Account secret. - operationId: createServiceAccountSecret - parameters: - - $ref: "#/components/parameters/orgId" - - description: Id of the service account. - in: path - name: serviceAccountId - required: true - schema: - type: string - - $ref: "#/components/parameters/envelope" - - $ref: "#/components/parameters/pretty" - requestBody: - content: - application/vnd.atlas.2023-10-01+json: - schema: - $ref: "#/components/schemas/ServiceAccountSecretRequest" - description: Details to create secret in the specified service account. - required: true - responses: - "201": - content: - application/vnd.atlas.2023-10-01+json: - schema: - $ref: "#/components/schemas/ServiceAccountSecret" - x-xgen-version: 2023-10-01 - description: Created - "400": - $ref: "#/components/responses/badRequest" - "401": - $ref: "#/components/responses/unauthorized" - "500": - $ref: "#/components/responses/internalServerError" - security: - - DigestAuth: [] - summary: Service Account Secret Creation - tags: - - Organizations - /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets/{secretId}: - delete: - description: Delete Service Account Secret. - operationId: deleteServiceAccountSecret - parameters: - - description: Id of the service account. - in: path - name: serviceAccountId - required: true - schema: - type: string - - description: Id of the secret. - in: path - name: secretId - required: true - schema: - type: string - - $ref: "#/components/parameters/orgId" - - $ref: "#/components/parameters/envelope" - - $ref: "#/components/parameters/pretty" - responses: - "204": - content: - application/vnd.atlas.2023-10-01+json: - x-xgen-version: 2023-10-01 - description: This endpoint does not return a response body. - "401": - $ref: "#/components/responses/unauthorized" - "404": - $ref: "#/components/responses/notFound" - "500": - $ref: "#/components/responses/internalServerError" - security: - - DigestAuth: [] - summary: Service Account Secret Deletion. - tags: - - Organizations /api/atlas/v2/orgs/{orgId}/settings: get: description: "Returns details about the specified organization's settings. To\ @@ -16556,6 +16408,8 @@ paths: $ref: "#/components/schemas/OrganizationSettings" x-xgen-version: 2023-01-01 description: OK + "400": + $ref: "#/components/responses/badRequest" "401": $ref: "#/components/responses/unauthorized" "403": @@ -17030,6 +16884,7 @@ paths: - Organizations /api/atlas/v2/orgs/{orgId}/users/{userId}: delete: + deprecated: true description: "Removes one MongoDB Cloud user from the specified organization.\ \ To use this resource, the requesting API Key must have the Organization\ \ User Admin role." @@ -17037,6 +16892,7 @@ paths: parameters: - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/orgId" + - $ref: "#/components/parameters/pretty" - description: Unique 24-hexadecimal digit string that identifies the user to be deleted. in: path @@ -17067,9 +16923,10 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Remove One MongoDB Cloud User from One Organization + summary: Remove One MongoDB Cloud User From One Organization tags: - Organizations + x-sunset: 2026-01-01 /api/atlas/v2/orgs/{orgId}/users/{userId}/roles: put: description: "Updates the roles of the specified user in the specified organization.\ @@ -17896,7 +17753,7 @@ components: description: |- Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. - Change this parameter only if you: + 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). @@ -17972,7 +17829,7 @@ components: You can set different IOPS values on different shards when provisioned IOPS are supported. - Change this parameter only if you: + 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). @@ -18403,6 +18260,31 @@ components: - REPLICASET - SHARDED - GEOSHARDED + configServerManagementMode: + type: string + default: ATLAS_MANAGED + description: |- + Config Server Management Mode for creating or updating a sharded cluster. + + When configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings. + + When configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server. + enum: + - ATLAS_MANAGED + - FIXED_TO_DEDICATED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + configServerType: + type: string + description: Describes a sharded cluster's config server type. + enum: + - DEDICATED + - EMBEDDED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + readOnly: true connectionStrings: $ref: "#/components/schemas/ClusterConnectionStrings" createDate: @@ -18450,6 +18332,15 @@ components: externalDocs: description: Encryption at Rest using Customer Key Management url: https://www.mongodb.com/docs/atlas/security-kms-encryption/ + featureCompatibilityVersion: + type: string + description: Feature compatibility version of the cluster. + readOnly: true + featureCompatibilityVersionExpirationDate: + type: string + format: date-time + description: Feature compatibility version expiration date. + readOnly: true globalClusterSelfManagedSharding: type: boolean description: |- @@ -18500,6 +18391,8 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true + mongoDBEmployeeAccessGrant: + $ref: "#/components/schemas/EmployeeAccessGrantView" mongoDBMajorVersion: type: string description: |- @@ -18521,7 +18414,7 @@ components: description: Human-readable label that identifies the advanced cluster. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" paused: type: boolean description: Flag that indicates whether the cluster is paused. @@ -18532,6 +18425,24 @@ components: externalDocs: description: Continuous Cloud Backups url: https://docs.atlas.mongodb.com/backup/cloud-backup/overview/ + replicaSetScalingStrategy: + type: string + default: WORKLOAD_TYPE + description: |- + Set this field to configure the replica set scaling mode for your cluster. + + By default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes. + + When configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads. + + When configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads. + enum: + - SEQUENTIAL + - WORKLOAD_TYPE + - NODE_TYPE + externalDocs: + description: Modify the Replica Set Scaling Mode + url: https://dochub.mongodb.org/core/scale-nodes replicationSpecs: type: array description: "List of settings that configure your cluster regions. For\ @@ -19410,6 +19321,246 @@ components: description: Atlas Search Index url: https://dochub.mongodb.org/core/index-definitions-fts title: mappings + ApiAtlasInvalidPolicyErrorDetailView: + type: object + properties: + detail: + type: string + description: A string that provides a detailed description of a validation + error. + readOnly: true + ApiAtlasInvalidPolicyView: + type: object + properties: + body: + type: string + description: A string that defines the permissions for the policy. The syntax + used is the Cedar Policy language. + example: |2 + forbid ( + principal, + action == cloud::Action::"cluster.createEdit", + resource + ) when { + context.cluster.regions.contains(cloud::region::"aws:us-east-1") + }; + readOnly: true + errors: + type: array + description: List of validation errors. + items: + $ref: "#/components/schemas/ApiAtlasInvalidPolicyErrorDetailView" + readOnly: true + ApiAtlasInvalidResourcePolicyCreateErrorView: + type: object + properties: + errorType: + type: string + description: Human-readable label that displays the type of an error. + enum: + - POLICY_PARSING_ERROR + - POLICY_HAS_FAILED_VALIDATIONS + - POLICY_HAS_INVALID_PRINCIPAL + - POLICY_HAS_BODY_EXCEEDING_MAX_SIZE + - POLICY_HAS_UNEXPECTED_ENTITIES + invalidPolicies: + type: array + description: List of invalid policies containing details of their validation + errors. + items: + $ref: "#/components/schemas/ApiAtlasInvalidPolicyView" + readOnly: true + ApiAtlasNonCompliantResourceView: + type: object + properties: + orgId: + type: string + description: Unique 24-hexadecimal character string that identifies the + organization the resource belongs to. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + resourceId: + type: string + description: Unique 24-hexadecimal character string that identifies the + non-compliant resource. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + resourcePoliciesCausingNonCompliance: + type: array + description: List of resource policies causing the resource to be considered + non-compliant. + items: + $ref: "#/components/schemas/ApiAtlasResourcePolicyMetadataView" + readOnly: true + resourceType: + type: string + description: Human-readable label that displays the type of a resource. + enum: + - PROJECT + - CLUSTER + readOnly: true + ApiAtlasPolicyCreateView: + type: object + properties: + body: + type: string + description: A string that defines the permissions for the policy. The syntax + used is the Cedar Policy language. + example: |2 + forbid ( + principal, + action == cloud::Action::"cluster.createEdit", + resource + ) when { + context.cluster.regions.contains(cloud::region::"aws:us-east-1") + }; + required: + - body + ApiAtlasPolicyMetadataView: + type: object + properties: + policyId: + type: string + description: Unique 24-hexadecimal character string that identifies the + policy. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + ApiAtlasPolicyView: + type: object + properties: + body: + type: string + description: A string that defines the permissions for the policy. The syntax + used is the Cedar Policy language. + example: |2 + forbid ( + principal, + action == cloud::Action::"cluster.createEdit", + resource + ) when { + context.cluster.regions.contains(cloud::region::"aws:us-east-1") + }; + readOnly: true + id: + type: string + description: Unique 24-hexadecimal character string that identifies the + policy. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + ApiAtlasResourcePolicyCreateView: + type: object + properties: + name: + type: string + description: Human-readable label that describes the atlas resource policy. + policies: + type: array + description: List of policies that make up the atlas resource policy. + items: + $ref: "#/components/schemas/ApiAtlasPolicyCreateView" + required: + - name + - policies + ApiAtlasResourcePolicyEditView: + type: object + properties: + name: + type: string + description: Human-readable label that describes the atlas resource policy. + policies: + type: array + description: List of policies that make up the atlas resource policy. + items: + $ref: "#/components/schemas/ApiAtlasPolicyCreateView" + ApiAtlasResourcePolicyMetadataView: + type: object + properties: + policiesCausingNonCompliance: + type: array + description: List of policies that are in conflict with the current state + of the resource. + items: + $ref: "#/components/schemas/ApiAtlasPolicyMetadataView" + readOnly: true + resourcePolicyId: + type: string + description: Unique 24-hexadecimal character string that identifies the + atlas resource policy. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + resourcePolicyName: + type: string + description: Human-readable label that describes the atlas resource policy. + readOnly: true + ApiAtlasResourcePolicyView: + type: object + properties: + createdByUser: + $ref: "#/components/schemas/ApiAtlasUserMetadataView" + createdDate: + type: string + format: date-time + description: Date and time in UTC when the atlas resource policy was created. + example: 2022-01-01T00:00:00Z + readOnly: true + id: + type: string + description: Unique 24-hexadecimal character string that identifies the + atlas resource policy. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + lastUpdatedByUser: + $ref: "#/components/schemas/ApiAtlasUserMetadataView" + lastUpdatedDate: + type: string + format: date-time + description: Date and time in UTC when the atlas resource policy was last + updated. + example: 2022-01-01T00:00:00Z + readOnly: true + name: + type: string + description: Human-readable label that describes the atlas resource policy. + readOnly: true + orgId: + type: string + description: Unique 24-hexadecimal character string that identifies the + organization the atlas resource policy belongs to. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + policies: + type: array + description: List of policies that make up the atlas resource policy. + items: + $ref: "#/components/schemas/ApiAtlasPolicyView" + readOnly: true + version: + type: string + description: A string that identifies the version of the atlas resource + policy. + example: v1 + readOnly: true ApiAtlasSnapshotScheduleView: type: object properties: @@ -19546,6 +19697,23 @@ components: - snapshotIntervalHours - snapshotRetentionDays - weeklySnapshotRetentionWeeks + ApiAtlasUserMetadataView: + type: object + description: The user that last updated the atlas resource policy. + properties: + id: + type: string + description: Unique 24-hexadecimal character string that identifies a user. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + name: + type: string + description: Human-readable label that describes a user. + readOnly: true + readOnly: true ApiBSONTimestampView: type: object description: BSON timestamp that indicates when the checkpoint token entry in @@ -19602,6 +19770,8 @@ components: ApiError: type: object properties: + badRequestDetail: + $ref: "#/components/schemas/BadRequestDetail" detail: type: string description: Describes the specific conditions or reasons that cause each @@ -19612,17 +19782,25 @@ components: description: HTTP status code returned with this error. externalDocs: url: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status + readOnly: true 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. items: type: object + readOnly: true + readOnly: true reason: type: string description: Application error message returned with this error. + readOnly: true + required: + - error + - errorCode ApiHostView_Atlas: type: object properties: @@ -19911,6 +20089,23 @@ components: \ and **period** in the same request. This parameter expresses its value\ \ in the ISO 8601 timestamp format in UTC." readOnly: true + ApiPrivateDownloadDeliveryUrl: + type: object + description: One Uniform Resource Locator (URL) that points to the compressed + snapshot files for manual download and the corresponding private endpoint. + properties: + deliveryUrl: + type: string + description: One Uniform Resource Locator that points to the compressed + snapshot files for manual download. + endpointId: + type: string + description: Unique 22-character alphanumeric string that identifies the + private endpoint. + example: vpce-3bf78b0ddee411ba1 + maxLength: 22 + minLength: 22 + pattern: "^vpce-[0-9a-f]{17}$" ApiPublicUsageDetailsQueryRequest: type: object description: "Request body for an Invoice Usage Details query with filtering,\ @@ -20022,7 +20217,23 @@ components: type: string description: Atlas Streams AWS Regions. enum: + - SYDNEY_AUS + - MUMBAI_IND + - FRANKFURT_DEU + - DUBLIN_IRL + - LONDON_GBR - VIRGINIA_USA + - OREGON_USA + - SAOPAULO_BRA + - MONTREAL_CAN + - TOKYO_JPN + - SINGAPORE_SGP + ApiStreamsAzureRegionView: + type: string + description: Atlas Streams Azure Regions. + enum: + - VIRGINIA_USA + - AMSTERDAM_NLD ApiUserEventTypeViewForNdsGroup: type: string description: Unique identifier of event type. @@ -20269,6 +20480,12 @@ components: - eventTypeName - id title: API User Events + ApiVersion: + type: object + properties: + version: + type: string + description: Object representing a version of the Atlas Admin API. AppServiceAlertConfigViewForNdsGroup: type: object description: App Services metric alert configuration allows to select which @@ -20750,7 +20967,12 @@ components: enum: - AVERAGE operator: - $ref: "#/components/schemas/Operator" + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - LESS_THAN + - GREATER_THAN threshold: type: number format: double @@ -20828,6 +21050,12 @@ components: enum: - VIRGINIA_USA - AMSTERDAM_NLD + AtlasDataFederationGCPRegion: + type: string + description: Atlas Data Federation GCP Regions. + enum: + - IOWA_USA + - BELGIUM_EU AtlasOrganization: type: object description: Details that describe the organization. @@ -20863,6 +21091,128 @@ components: pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" required: - name + AtlasResourcePolicyAuditForOrg: + type: object + description: Atlas resource policy audits indicate org level changes to resource + policies + properties: + apiKeyId: + type: string + description: "Unique 24-hexadecimal digit string that identifies the [API\ + \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\ + \ triggered the event. If this resource returns this parameter, it doesn't\ + \ return the **userId** parameter." + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + created: + type: string + format: date-time + description: Date and time when this event occurred. This parameter expresses + its value in the ISO 8601 timestamp format in UTC. + readOnly: true + eventTypeName: + type: string + description: Unique identifier of event type. + enum: + - RESOURCE_POLICY_CREATED + - RESOURCE_POLICY_MODIFIED + - RESOURCE_POLICY_DELETED + example: RESOURCE_POLICY_CREATED + title: Atlas Resource Policy Audit Types + groupId: + type: string + description: Unique 24-hexadecimal digit string that identifies the project + in which the event occurred. The **eventId** identifies the specific event. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + id: + type: string + description: Unique 24-hexadecimal digit string that identifies the event. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + isGlobalAdmin: + type: boolean + default: false + description: Flag that indicates whether a MongoDB employee triggered the + specified event. + readOnly: true + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + orgId: + type: string + description: Unique 24-hexadecimal digit string that identifies the organization + to which these events apply. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + publicKey: + type: string + format: email + description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\ + \ that triggered the event. If this resource returns this parameter, it\ + \ doesn't return the **username** parameter." + readOnly: true + raw: + $ref: "#/components/schemas/raw" + remoteAddress: + type: string + description: IPv4 or IPv6 address from which the user triggered this event. + example: 216.172.40.186 + pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + readOnly: true + resourcePolicyId: + type: string + description: Unique 24-hexadecimal character string that identifies the + resource policy. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + userId: + type: string + description: "Unique 24-hexadecimal digit string that identifies the console\ + \ user who triggered the event. If this resource returns this parameter,\ + \ it doesn't return the **apiKeyId** parameter." + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + username: + type: string + format: email + description: "Email address for the user who triggered this event. If this\ + \ resource returns this parameter, it doesn't return the **publicApiKey**\ + \ parameter." + example: test.user@mongodb.com + readOnly: true + required: + - created + - eventTypeName + - id + title: Atlas Resource Policy Audits AtlasSearchAnalyzer: type: object properties: @@ -21584,6 +21934,21 @@ components: AzureHardwareSpec: type: object properties: + diskIOPS: + type: integer + format: int32 + description: |- + Target throughput desired for storage attached to your Azure-provisioned cluster. Change this parameter if you: + + - set `"replicationSpecs[n].regionConfigs[m].providerName" : "Azure"`. + - set `"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize" : "M40"` or greater not including `Mxx_NVME` tiers. + + The maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**. + This parameter defaults to the cluster tier's standard IOPS value. + Changing this value impacts cluster cost. + externalDocs: + description: Programmatic API Keys + url: https://www.mongodb.com/docs/atlas/customize-storage/#extend-iops-on-azure instanceSize: type: string description: Hardware specification for the instance sizes in this region. @@ -21621,6 +21986,21 @@ components: AzureHardwareSpec20240805: type: object properties: + diskIOPS: + type: integer + format: int32 + description: |- + Target throughput desired for storage attached to your Azure-provisioned cluster. Change this parameter if you: + + - set `"replicationSpecs[n].regionConfigs[m].providerName" : "Azure"`. + - set `"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize" : "M40"` or greater not including `Mxx_NVME` tiers. + + The maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**. + This parameter defaults to the cluster tier's standard IOPS value. + Changing this value impacts cluster cost. + externalDocs: + description: Programmatic API Keys + url: https://www.mongodb.com/docs/atlas/customize-storage/#extend-iops-on-azure diskSizeGB: type: number format: double @@ -21836,6 +22216,8 @@ components: - PENDING_ACCEPTANCE - ACTIVE - FAILED + - PENDING_RECREATION + - DELETING readOnly: true title: Azure Key Vault EAR Private Endpoint AzureNetworkPeeringConnectionSettings: @@ -22270,7 +22652,7 @@ components: the collection for which you want to create an online archive. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true collName: type: string @@ -22382,7 +22764,7 @@ components: the collection for which you want to create an online archive. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true collName: type: string @@ -22521,7 +22903,7 @@ components: the snapshots you want to retrieve. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -22734,7 +23116,7 @@ components: To return a response with the **clusterId** parameter, either use the **delivery.targetClusterName** parameter or enable backup on the target cluster. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" targetGroupId: type: string description: "Unique 24-hexadecimal digit string that identifies the project\ @@ -23006,12 +23388,23 @@ components: - FAILED - COMPLETED readOnly: true + BadRequestDetail: + type: object + description: Bad request detail. + properties: + fields: + type: array + description: Describes all violations in a client request. + items: + $ref: "#/components/schemas/FieldViolation" + readOnly: true BaseAtlasDataLakeRegion: type: object description: Name of the region to which the data lake routes client connections. oneOf: - $ref: "#/components/schemas/ApiAtlasDataLakeAWSRegionView" - $ref: "#/components/schemas/AtlasDataFederationAzureRegion" + - $ref: "#/components/schemas/AtlasDataFederationGCPRegion" BaseCloudProviderInstanceSize: type: object description: "Minimum instance size to which your cluster can automatically\ @@ -23139,6 +23532,7 @@ components: description: Name of the cloud provider region hosting Atlas Stream Processing. oneOf: - $ref: "#/components/schemas/ApiStreamsAWSRegionView" + - $ref: "#/components/schemas/ApiStreamsAzureRegionView" BasicBSONList: type: array description: "List that contains the search criteria that the query uses. To\ @@ -24226,7 +24620,7 @@ components: description: Human-readable label that identifies the cluster. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true nodeCount: type: integer @@ -24287,6 +24681,10 @@ components: 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. + description: + type: string + description: Description of this database user. + maxLength: 100 groupId: type: string description: Unique 24-hexadecimal digit string that identifies the project. @@ -24554,6 +24952,127 @@ components: (AWS) Identity and Access Management (IAM) role. required: - providerName + CloudProviderAccessAWSIAMRoleRequest: + type: object + description: Details that describe the features linked to the Amazon Web Services + (AWS) Identity and Access Management (IAM) role. + properties: + atlasAWSAccountArn: + 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. + example: arn:aws:iam::772401394250:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + readOnly: true + atlasAssumedRoleExternalId: + type: string + format: uuid + description: Unique external ID that MongoDB Cloud uses when it assumes + the IAM role in your Amazon Web Services (AWS) account. + readOnly: true + authorizedDate: + type: string + format: date-time + 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. + readOnly: true + createdDate: + type: string + format: date-time + 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. + readOnly: true + featureUsages: + type: array + description: List that contains application features associated with this + Amazon Web Services (AWS) Identity and Access Management (IAM) role. + items: + $ref: "#/components/schemas/CloudProviderAccessFeatureUsage" + readOnly: true + providerName: + type: string + description: Human-readable label that identifies the cloud provider of + the role. + enum: + - AWS + - AZURE + - GCP + roleId: + type: string + description: Unique 24-hexadecimal digit string that identifies the role. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + required: + - providerName + CloudProviderAccessAWSIAMRoleRequestUpdate: + type: object + allOf: + - $ref: "#/components/schemas/CloudProviderAccessRoleRequestUpdate" + - type: object + properties: + atlasAWSAccountArn: + 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. + example: arn:aws:iam::772401394250:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + readOnly: true + atlasAssumedRoleExternalId: + type: string + format: uuid + description: Unique external ID that MongoDB Cloud uses when it assumes + the IAM role in your Amazon Web Services (AWS) account. + readOnly: true + authorizedDate: + type: string + format: date-time + 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. + readOnly: true + createdDate: + type: string + format: date-time + 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. + readOnly: true + featureUsages: + type: array + description: List that contains application features associated with this + Amazon Web Services (AWS) Identity and Access Management (IAM) role. + items: + $ref: "#/components/schemas/CloudProviderAccessFeatureUsage" + readOnly: true + iamAssumedRoleArn: + 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 + maxLength: 2048 + minLength: 20 + roleId: + type: string + description: Unique 24-hexadecimal digit string that identifies the role. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + description: Details that describe the features linked to the Amazon Web Services + (AWS) Identity and Access Management (IAM) role. + required: + - providerName CloudProviderAccessAzureServicePrincipal: type: object allOf: @@ -24615,6 +25134,133 @@ components: Principal. required: - providerName + CloudProviderAccessAzureServicePrincipalRequest: + type: object + description: Details that describe the features linked to the Azure Service + Principal. + properties: + _id: + type: string + description: Unique 24-hexadecimal digit string that identifies the role. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + atlasAzureAppId: + type: string + description: Azure Active Directory Application ID of Atlas. + maxLength: 36 + minLength: 32 + pattern: "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\\ + b-[0-9a-fA-F]{12}$" + createdDate: + type: string + format: date-time + description: Date and time when this Azure Service Principal was created. + This parameter expresses its value in the ISO 8601 timestamp format in + UTC. + readOnly: true + featureUsages: + type: array + description: List that contains application features associated with this + Azure Service Principal. + items: + $ref: "#/components/schemas/CloudProviderAccessFeatureUsage" + readOnly: true + lastUpdatedDate: + type: string + format: date-time + 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. + 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. + maxLength: 36 + minLength: 32 + pattern: "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\\ + b-[0-9a-fA-F]{12}$" + tenantId: + type: string + description: UUID String that identifies the Azure Active Directory Tenant + ID. + maxLength: 36 + minLength: 32 + pattern: "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\\ + b-[0-9a-fA-F]{12}$" + required: + - providerName + CloudProviderAccessAzureServicePrincipalRequestUpdate: + type: object + allOf: + - $ref: "#/components/schemas/CloudProviderAccessRoleRequestUpdate" + - type: object + properties: + _id: + type: string + description: Unique 24-hexadecimal digit string that identifies the role. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + atlasAzureAppId: + type: string + description: Azure Active Directory Application ID of Atlas. + maxLength: 36 + minLength: 32 + pattern: "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\\ + b-[0-9a-fA-F]{12}$" + createdDate: + type: string + format: date-time + description: Date and time when this Azure Service Principal was created. + This parameter expresses its value in the ISO 8601 timestamp format + in UTC. + readOnly: true + featureUsages: + type: array + description: List that contains application features associated with this + Azure Service Principal. + items: + $ref: "#/components/schemas/CloudProviderAccessFeatureUsage" + readOnly: true + lastUpdatedDate: + type: string + format: date-time + 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. + readOnly: true + servicePrincipalId: + type: string + description: UUID string that identifies the Azure Service Principal. + maxLength: 36 + minLength: 32 + pattern: "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\\ + b-[0-9a-fA-F]{12}$" + tenantId: + type: string + description: UUID String that identifies the Azure Active Directory Tenant + ID. + maxLength: 36 + minLength: 32 + pattern: "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\\ + b-[0-9a-fA-F]{12}$" + description: Details that describe the features linked to the Azure Service + Principal. + required: + - providerName CloudProviderAccessDataLakeFeatureUsage: type: object allOf: @@ -24727,6 +25373,85 @@ components: minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true + CloudProviderAccessGCPServiceAccount: + type: object + allOf: + - $ref: "#/components/schemas/CloudProviderAccessRole" + - type: object + properties: + createdDate: + type: string + format: date-time + description: Date and time when this Google Service Account was created. + This parameter expresses its value in the ISO 8601 timestamp format + in UTC. + readOnly: true + featureUsages: + type: array + description: List that contains application features associated with this + Google Service Account. + items: + $ref: "#/components/schemas/CloudProviderAccessFeatureUsage" + readOnly: true + gcpServiceAccountForAtlas: + type: string + description: Email address for the Google Service Account created by Atlas. + maxLength: 82 + minLength: 57 + pattern: "^mongodb-atlas-[0-9a-z]{16}@p-[0-9a-z]{24}.iam.gserviceaccount.com$" + roleId: + type: string + description: Unique 24-hexadecimal digit string that identifies the role. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + description: Details that describe the features linked to the GCP Service Account. + required: + - providerName + CloudProviderAccessGCPServiceAccountRequest: + type: object + description: Details that describe the features linked to the GCP Service Account. + properties: + createdDate: + type: string + format: date-time + description: Date and time when this GCP Service Account was created. This + parameter expresses its value in the ISO 8601 timestamp format in UTC. + readOnly: true + featureUsages: + type: array + description: List that contains application features associated with this + GCP Service Account. + items: + $ref: "#/components/schemas/CloudProviderAccessFeatureUsage" + readOnly: true + 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: + type: string + description: Unique 24-hexadecimal digit string that identifies the role. + readOnly: true + required: + - providerName + CloudProviderAccessGCPServiceAccountRequestUpdate: + type: object + allOf: + - $ref: "#/components/schemas/CloudProviderAccessRoleRequestUpdate" + description: Details that describe the features linked to the GCP Service Account. + required: + - providerName CloudProviderAccessPushBasedLogExportFeatureUsage: type: object allOf: @@ -24745,10 +25470,52 @@ components: mapping: AWS: "#/components/schemas/CloudProviderAccessAWSIAMRole" AZURE: "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + GCP: "#/components/schemas/CloudProviderAccessGCPServiceAccount" + propertyName: providerName + properties: + providerName: + type: string + description: Human-readable label that identifies the cloud provider of + the role. + enum: + - AWS + - AZURE + - GCP + required: + - providerName + CloudProviderAccessRoleRequest: + type: object + description: Cloud provider access role. + discriminator: + mapping: + AWS: "#/components/schemas/CloudProviderAccessAWSIAMRoleRequest" + AZURE: "#/components/schemas/CloudProviderAccessAzureServicePrincipalRequest" + GCP: "#/components/schemas/CloudProviderAccessGCPServiceAccountRequest" propertyName: providerName oneOf: - - $ref: "#/components/schemas/CloudProviderAccessAWSIAMRole" - - $ref: "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + - $ref: "#/components/schemas/CloudProviderAccessAWSIAMRoleRequest" + - $ref: "#/components/schemas/CloudProviderAccessAzureServicePrincipalRequest" + - $ref: "#/components/schemas/CloudProviderAccessGCPServiceAccountRequest" + properties: + providerName: + type: string + description: Human-readable label that identifies the cloud provider of + the role. + enum: + - AWS + - AZURE + - GCP + required: + - providerName + CloudProviderAccessRoleRequestUpdate: + type: object + description: Cloud provider access role. + discriminator: + mapping: + AWS: "#/components/schemas/CloudProviderAccessAWSIAMRoleRequestUpdate" + AZURE: "#/components/schemas/CloudProviderAccessAzureServicePrincipalRequestUpdate" + GCP: "#/components/schemas/CloudProviderAccessGCPServiceAccountRequestUpdate" + propertyName: providerName properties: providerName: type: string @@ -24757,6 +25524,7 @@ components: enum: - AWS - AZURE + - GCP required: - providerName CloudProviderAccessRoles: @@ -24768,6 +25536,12 @@ components: registered and authorized with MongoDB Cloud. items: $ref: "#/components/schemas/CloudProviderAccessAWSIAMRole" + azureServicePrincipals: + type: array + description: List that contains the Azure Service Principals registered + with MongoDB Cloud. + items: + $ref: "#/components/schemas/CloudProviderAccessAzureServicePrincipal" CloudProviderAzureAutoScaling: type: object description: Range of instance sizes to which your cluster can scale. @@ -25436,7 +26210,7 @@ components: example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -25540,6 +26314,7 @@ components: $ref: "#/components/schemas/ClusterComputeAutoScaling" diskGBEnabled: type: boolean + default: false description: Flag that indicates whether someone enabled disk auto-scaling for this cluster. title: Automatic Cluster Scaling Settings @@ -25566,12 +26341,14 @@ components: properties: enabled: type: boolean + default: false description: "Flag that indicates whether cluster tier auto-scaling is enabled.\ \ Set to `true` to enable cluster tier auto-scaling. If enabled, you must\ \ specify a value for **providerSettings.autoScaling.compute.maxInstanceSize**\ \ also. Set to `false` to disable cluster tier auto-scaling." scaleDownEnabled: type: boolean + default: false description: "Flag that indicates whether the cluster tier can scale down.\ \ This is required if **autoScaling.compute.enabled** is `true`. If you\ \ enable this option, specify a value for **providerSettings.autoScaling.compute.minInstanceSize**." @@ -25609,20 +26386,28 @@ components: 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. + description: "Private endpoint-aware connection strings that use AWS-hosted\ + \ clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies\ + \ an Amazon Web Services (AWS) interface endpoint. Each value identifies\ + \ the related `mongodb://` connection string that you use to connect\ + \ to Atlas through the interface endpoint that the key names. If the\ + \ cluster uses an optimized connection string, `awsPrivateLinkSrv` contains\ + \ the optimized connection string. If the cluster has the non-optimized\ + \ (legacy) connection string, `awsPrivateLinkSrv` contains the non-optimized\ + \ connection string even if an optimized connection string is also present." externalDocs: description: Network Peering Connection url: https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/ readOnly: true - 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. + description: "Private endpoint-aware connection strings that use AWS-hosted\ + \ clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies\ + \ an Amazon Web Services (AWS) interface endpoint. Each value identifies\ + \ the related `mongodb://` connection string that you use to connect to\ + \ Atlas through the interface endpoint that the key names. If the cluster\ + \ uses an optimized connection string, `awsPrivateLinkSrv` contains the\ + \ optimized connection string. If the cluster has the non-optimized (legacy)\ + \ connection string, `awsPrivateLinkSrv` contains the non-optimized connection\ + \ string even if an optimized connection string is also present." externalDocs: description: Network Peering Connection url: https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/ @@ -25724,6 +26509,31 @@ components: - REPLICASET - SHARDED - GEOSHARDED + configServerManagementMode: + type: string + default: ATLAS_MANAGED + description: |- + Config Server Management Mode for creating or updating a sharded cluster. + + When configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings. + + When configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server. + enum: + - ATLAS_MANAGED + - FIXED_TO_DEDICATED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + configServerType: + type: string + description: Describes a sharded cluster's config server type. + enum: + - DEDICATED + - EMBEDDED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + readOnly: true connectionStrings: $ref: "#/components/schemas/ClusterConnectionStrings" createDate: @@ -25757,6 +26567,15 @@ components: externalDocs: description: Encryption at Rest using Customer Key Management url: https://www.mongodb.com/docs/atlas/security-kms-encryption/ + featureCompatibilityVersion: + type: string + description: Feature compatibility version of the cluster. + readOnly: true + featureCompatibilityVersionExpirationDate: + type: string + format: date-time + description: Feature compatibility version expiration date. + readOnly: true globalClusterSelfManagedSharding: type: boolean description: |- @@ -25807,6 +26626,8 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true + mongoDBEmployeeAccessGrant: + $ref: "#/components/schemas/EmployeeAccessGrantView" mongoDBMajorVersion: type: string description: |- @@ -25828,7 +26649,7 @@ components: description: Human-readable label that identifies the cluster. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" paused: type: boolean description: Flag that indicates whether the cluster is paused. @@ -25839,6 +26660,35 @@ components: externalDocs: description: Continuous Cloud Backups url: https://docs.atlas.mongodb.com/backup/cloud-backup/overview/ + redactClientLogData: + type: boolean + description: Enable or disable log redaction. + externalDocs: + description: |- + This options corresponds to the ``security.redactClientLogData`` cluster parameter. + + This setting configures the ``mongod`` or ``mongos`` to redact any message accompanying a given log event before logging. This prevents the program from writing potentially sensitive data stored on the database to the diagnostic log. Metadata such as error or operation codes, line numbers, and source file names are still visible in the logs. + + Use ``redactClientLogData`` in conjunction with Encryption at Rest and TLS/SSL (Transport Encryption) to assist compliance with regulatory requirements. + url: https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.redactClientLogData + replicaSetScalingStrategy: + type: string + default: WORKLOAD_TYPE + description: |- + Set this field to configure the replica set scaling mode for your cluster. + + By default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes. + + When configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads. + + When configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads. + enum: + - SEQUENTIAL + - WORKLOAD_TYPE + - NODE_TYPE + externalDocs: + description: Modify the Replica Set Scaling Mode + url: https://dochub.mongodb.org/core/scale-nodes replicationSpecs: type: array description: List of settings that configure your cluster regions. This @@ -25964,6 +26814,24 @@ components: ClusterDescriptionProcessArgs: type: object properties: + changeStreamOptionsPreAndPostImagesExpireAfterSeconds: + type: integer + format: int32 + default: -1 + description: The minimum pre- and post-image retention time in seconds. + externalDocs: + description: "This option corresponds to the ``changeStreamOptions.preAndPostImages.expireAfterSeconds``\ + \ cluster parameter. This setting controls the retention policy of change\ + \ stream pre- and post-images. Pre- and post-images are the versions\ + \ of a document before and after document modification, respectively.\ + \ ``expireAfterSeconds`` controls how long MongoDB retains pre- and\ + \ post-images. When set to -1 (off), MongoDB uses the default retention\ + \ policy: pre- and post-images are retained until the corresponding\ + \ change stream events are removed from the oplog. To set the minimum\ + \ pre- and post-image retention time, specify an integer value greater\ + \ than zero. Setting this too low could increase the risk of interrupting\ + \ Realm sync or triggers processing. The default value is -1 (off)." + url: https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/changeStreamOptions/#mongodb-parameter-param.changeStreamOptions.preAndPostImages.expireAfterSeconds chunkMigrationConcurrency: type: integer format: int32 @@ -25974,6 +26842,14 @@ components: description: This option corresponds to the `chunkMigrationConcurrency` `mongod` configuration file option. url: https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.chunkMigrationConcurrency + defaultMaxTimeMS: + type: integer + format: int32 + description: Default time limit in milliseconds for individual read operations + to complete. + externalDocs: + description: This option corresponds to the defaultMaxTimeMS cluster parameter. + url: https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/defaultMaxTimeMS/ defaultReadConcern: type: string default: available @@ -26010,8 +26886,10 @@ components: url: https://docs.mongodb.com/upcoming/reference/parameters/#mongodb-parameter-param.failIndexKeyTooLong javascriptEnabled: type: boolean - description: Flag that indicates whether the cluster allows execution of - operations that perform server-side executions of JavaScript. + 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. @@ -26104,6 +26982,24 @@ components: ClusterDescriptionProcessArgs20240805: type: object properties: + changeStreamOptionsPreAndPostImagesExpireAfterSeconds: + type: integer + format: int32 + default: -1 + description: The minimum pre- and post-image retention time in seconds. + externalDocs: + description: "This option corresponds to the ``changeStreamOptions.preAndPostImages.expireAfterSeconds``\ + \ cluster parameter. This setting controls the retention policy of change\ + \ stream pre- and post-images. Pre- and post-images are the versions\ + \ of a document before and after document modification, respectively.\ + \ ``expireAfterSeconds`` controls how long MongoDB retains pre- and\ + \ post-images. When set to -1 (off), MongoDB uses the default retention\ + \ policy: pre- and post-images are retained until the corresponding\ + \ change stream events are removed from the oplog. To set the minimum\ + \ pre- and post-image retention time, specify an integer value greater\ + \ than zero. Setting this too low could increase the risk of interrupting\ + \ Realm sync or triggers processing. The default value is -1 (off)." + url: https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/changeStreamOptions/#mongodb-parameter-param.changeStreamOptions.preAndPostImages.expireAfterSeconds chunkMigrationConcurrency: type: integer format: int32 @@ -26114,6 +27010,14 @@ components: description: This option corresponds to the `chunkMigrationConcurrency` `mongod` configuration file option. url: https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.chunkMigrationConcurrency + defaultMaxTimeMS: + type: integer + format: int32 + description: Default time limit in milliseconds for individual read operations + to complete. + externalDocs: + description: This option corresponds to the defaultMaxTimeMS cluster parameter. + url: https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/defaultMaxTimeMS/ defaultWriteConcern: type: string description: Default level of acknowledgment requested from MongoDB for @@ -26124,8 +27028,10 @@ components: url: https://docs.mongodb.com/manual/reference/write-concern/ javascriptEnabled: type: boolean - description: Flag that indicates whether the cluster allows execution of - operations that perform server-side executions of JavaScript. + 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. @@ -26410,7 +27316,7 @@ components: outage simulation. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true groupId: type: string @@ -27225,6 +28131,7 @@ components: mapping: AWS: "#/components/schemas/AWSCreateDataProcessRegionView" AZURE: "#/components/schemas/AzureCreateDataProcessRegionView" + GCP: "#/components/schemas/GCPCreateDataProcessRegionView" propertyName: cloudProvider properties: cloudProvider: @@ -27707,11 +28614,11 @@ components: roleId: type: string description: Unique identifier of the role that Data Federation can use - to access the data stores.Required if specifying cloudProviderConfig. + to access the data stores. Required if specifying cloudProviderConfig. servicePrincipalId: type: string description: The ID of the Service Principal for which there is an access - policyfor Atlas to access Azure resources. + policy for Atlas to access Azure resources. readOnly: true tenantId: type: string @@ -27720,6 +28627,22 @@ components: readOnly: true required: - roleId + DataFederationGCPCloudProviderConfig: + type: object + description: Configuration for running Data Federation in GCP. + 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: + type: string + description: Unique identifier of the role that Data Federation can use + to access the data stores. Required if specifying cloudProviderConfig. + required: + - roleId DataFederationLimit: type: object description: Details of user managed limits. @@ -27727,6 +28650,7 @@ components: mapping: atlas.project.deployment.clusters: "#/components/schemas/DefaultLimit" atlas.project.deployment.nodesPerPrivateLinkRegion: "#/components/schemas/DefaultLimit" + atlas.project.deployment.salesSoldM0s: "#/components/schemas/DefaultLimit" atlas.project.deployment.serverlessMTMs: "#/components/schemas/DefaultLimit" atlas.project.security.databaseAccess.customRoles: "#/components/schemas/DefaultLimit" atlas.project.security.databaseAccess.users: "#/components/schemas/DefaultLimit" @@ -28097,7 +29021,9 @@ components: $ref: "#/components/schemas/DataLakeAWSCloudProviderConfig" azure: $ref: "#/components/schemas/DataFederationAzureCloudProviderConfig" - title: Data Lake Cloud Provider + gcp: + $ref: "#/components/schemas/DataFederationGCPCloudProviderConfig" + title: Data Federation Cloud Provider DataLakeDLSAWSStore: type: object allOf: @@ -28222,6 +29148,7 @@ components: enum: - AWS - AZURE + - GCP region: $ref: "#/components/schemas/BaseAtlasDataLakeRegion" required: @@ -28698,7 +29625,7 @@ components: example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -28957,7 +29884,12 @@ components: enum: - AVERAGE operator: - $ref: "#/components/schemas/Operator" + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - LESS_THAN + - GREATER_THAN threshold: type: number format: double @@ -29005,6 +29937,7 @@ components: mapping: AWS: "#/components/schemas/AWSDataProcessRegionView" AZURE: "#/components/schemas/AzureDataProcessRegionView" + GCP: "#/components/schemas/GCPDataProcessRegionView" propertyName: cloudProvider properties: cloudProvider: @@ -29014,6 +29947,7 @@ components: enum: - AWS - AZURE + - GCP readOnly: true readOnly: true DataProtectionSettings: @@ -29305,6 +30239,8 @@ components: - SQL_SET_SCHEMA - VIEW_ALL_HISTORY - OUT_TO_S3 + - OUT_TO_AZURE + - OUT_TO_GCS - STORAGE_GET_CONFIG - STORAGE_SET_CONFIG - FLUSH_ROUTER_CONFIG @@ -29664,6 +30600,7 @@ components: - FTS_INDEX_BUILD_COMPLETE - FTS_INDEX_BUILD_FAILED - FTS_INDEXES_RESTORE_FAILED + - FTS_INDEXES_SYNONYM_MAPPING_INVALID title: FTS Index Audit Types - type: string enum: @@ -29864,6 +30801,7 @@ components: - FTS_INDEX_BUILD_COMPLETE - FTS_INDEX_BUILD_FAILED - FTS_INDEXES_RESTORE_FAILED + - FTS_INDEXES_SYNONYM_MAPPING_INVALID title: FTS Index Audit Types - type: string enum: @@ -30319,11 +31257,14 @@ components: - CLUSTER_VERSION_UNFIXED - CLUSTER_FCV_FIXED - CLUSTER_FCV_UNFIXED + - CLUSTER_FCV_EXPIRATION_DATE_UPDATED - AGENT_VERSION_FIXED - AGENT_VERSION_UNFIXED - FIXED_VERSION_UPDATED - FIXED_AGENT_VERSION_UPDATED - CLUSTER_FCV_DOWNGRADED + - CLUSTER_BINARY_VERSION_DOWNGRADED + - CLUSTER_BINARY_VERSION_UPGRADED title: Version Audit Types groupId: type: string @@ -30711,7 +31652,6 @@ components: pattern: "^([a-f0-9]{24})$" hostnameSchemaType: type: string - default: PUBLIC description: The network type to use between the migration host and the destination cluster. enum: @@ -30912,30 +31852,19 @@ components: createdAt: type: string format: date-time - description: Date and time when someone created this export job. MongoDB - Cloud represents this timestamp in ISO 8601 format in UTC. + description: Date and time when a user or Atlas created the Export Job. + MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. readOnly: true customData: type: array description: Collection of key-value pairs that represent custom data for - the metadata file that MongoDB Cloud uploads to the bucket when the export - job finishes. + the metadata file that MongoDB Cloud uploads when the Export Job finishes. items: $ref: "#/components/schemas/BackupLabel" - 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\"`." - items: - type: string - description: One Uniform Resource Locator that point to the compressed - snapshot files for manual download. - readOnly: true exportBucketId: type: string description: Unique 24-hexadecimal character string that identifies the - Export Bucket to export to. + Export Bucket. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 @@ -30946,7 +31875,7 @@ components: finishedAt: type: string format: date-time - description: Date and time when this export job completed. MongoDB Cloud + description: Date and time when this Export Job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. readOnly: true id: @@ -30971,8 +31900,8 @@ components: readOnly: true prefix: type: string - description: Full path on the cloud provider bucket to the folder where - the snapshot is exported. + description: Prefix used for all blob storage objects uploaded as part of + the Export Job. pattern: "/exported_snapshots/\\{ORG-NAME\\}/\\{PROJECT-NAME\\}/\\{CLUSTER-NAME\\\ }/\\{SNAPSHOT-INITIATION-DATE\\}/\\{TIMESTAMP\\}" readOnly: true @@ -30986,7 +31915,7 @@ components: pattern: "^([a-f0-9]{24})$" state: type: string - description: State of the export job. + description: State of the Export Job. enum: - Cancelled - Failed @@ -31009,7 +31938,7 @@ components: exportBucketId: type: string description: Unique 24-hexadecimal character string that identifies the - Export Bucket to export to. + Export Bucket. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 @@ -31216,10 +32145,19 @@ components: properties: downloadUrl: type: string - description: "One Uniform Resource Locator that point to the compressed\ + 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." + items: + $ref: "#/components/schemas/ApiPrivateDownloadDeliveryUrl" + readOnly: true replicaSetName: type: string description: Human-readable label that identifies the replica set on the @@ -31671,7 +32609,7 @@ components: \ this parameter when `\"deliveryType\" : \"download\"`." items: type: string - description: One Uniform Resource Locator that point to the compressed + description: One Uniform Resource Locator that points to the compressed snapshot files for manual download. readOnly: true desiredTimestamp: @@ -31743,6 +32681,15 @@ components: \ when `\"deliveryType\" : \"pointInTime\"` and **pointInTimeUTCSeconds**\ \ exceeds `0`." minimum: 1199145600 + 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." + items: + $ref: "#/components/schemas/ApiPrivateDownloadDeliveryUrl" + readOnly: true snapshotId: type: string description: Unique 24-hexadecimal character string that identifies the @@ -31759,7 +32706,7 @@ components: and `pointInTime` restore types. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" targetGroupId: type: string description: Unique 24-hexadecimal digit string that identifies the target @@ -31800,7 +32747,7 @@ components: you want to return. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true copySettings: type: array @@ -31894,7 +32841,7 @@ components: you want to return. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true copySettings: type: array @@ -31980,8 +32927,12 @@ components: additionalProperties: type: object description: The stats associated with the stream processor. + externalDocs: + url: https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor readOnly: true description: The stats associated with the stream processor. + externalDocs: + url: https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor readOnly: true EARPrivateEndpoint: type: object @@ -32076,6 +33027,8 @@ components: - PENDING_ACCEPTANCE - ACTIVE - FAILED + - PENDING_RECREATION + - DELETING readOnly: true title: Encryption At Rest Private Endpoint EmailNotification: @@ -32122,6 +33075,36 @@ components: required: - typeName title: Email Notification + EmployeeAccessGrantView: + type: object + description: MongoDB employee granted access level and expiration for a cluster. + properties: + expirationTime: + type: string + format: date-time + description: Expiration date for the employee access grant. + 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." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + readOnly: true + required: + - expirationTime + - grantType EncryptionAtRest: type: object properties: @@ -32131,24 +33114,6 @@ components: $ref: "#/components/schemas/AzureKeyVault" googleCloudKms: $ref: "#/components/schemas/GoogleCloudKMS" - EncryptionAtRestPrivateEndpointRequest: - type: object - description: Create or delete private endpoints from the specified regions list. - properties: - cloudProvider: - type: string - description: Cloud service provider name. - enum: - - AZURE - regions: - type: array - description: List of regions. - items: - type: string - uniqueItems: true - required: - - cloudProvider - title: Encryption At Rest Private Endpoints setup. EncryptionKeyAlertConfigViewForNdsGroup: type: object description: Encryption key alert configuration allows to select thresholds which @@ -32495,6 +33460,7 @@ components: - FTS_INDEX_CLEANED_UP - FTS_INDEXES_RESTORED - FTS_INDEXES_RESTORE_FAILED + - FTS_INDEXES_SYNONYM_MAPPING_INVALID title: FTS Index Audit Types - type: string enum: @@ -32548,6 +33514,8 @@ components: - HOST_HAS_INDEX_SUGGESTIONS - HOST_MONGOT_RECOVERED_OOM - HOST_MONGOT_CRASHING_OOM + - HOST_MONGOT_RESUME_REPLICATION + - HOST_MONGOT_STOP_REPLICATION - HOST_ENOUGH_DISK_SPACE - HOST_NOT_ENOUGH_DISK_SPACE title: Host Event Types @@ -32585,6 +33553,7 @@ components: - 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 @@ -32662,6 +33631,8 @@ components: - 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 @@ -32691,6 +33662,9 @@ components: - 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 @@ -32749,9 +33723,13 @@ components: - 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 title: NDS Audit Types - type: string enum: @@ -32948,11 +33926,14 @@ components: - CLUSTER_VERSION_UNFIXED - CLUSTER_FCV_FIXED - CLUSTER_FCV_UNFIXED + - CLUSTER_FCV_EXPIRATION_DATE_UPDATED - AGENT_VERSION_FIXED - AGENT_VERSION_UNFIXED - FIXED_VERSION_UPDATED - FIXED_AGENT_VERSION_UPDATED - CLUSTER_FCV_DOWNGRADED + - CLUSTER_BINARY_VERSION_DOWNGRADED + - CLUSTER_BINARY_VERSION_UPGRADED title: Version Audit Types - type: string enum: @@ -33228,6 +34209,12 @@ components: enum: - GROUP_TAGS_MODIFIED title: Resource Event Types + - type: string + enum: + - RESOURCE_POLICY_CREATED + - RESOURCE_POLICY_MODIFIED + - RESOURCE_POLICY_DELETED + title: Atlas Resource Policy Audit Types EventViewForNdsGroup: type: object oneOf: @@ -33269,6 +34256,7 @@ components: - $ref: "#/components/schemas/TeamEvent" - $ref: "#/components/schemas/UserEventViewForOrg" - $ref: "#/components/schemas/ResourceEventViewForOrg" + - $ref: "#/components/schemas/AtlasResourcePolicyAuditForOrg" ExampleResourceResponse20230101: type: object properties: @@ -33318,8 +34306,7 @@ components: - description ExportStatus: type: object - description: State of the export job for the collections on the replica set - only. + description: State of the Export Job. properties: exportedCollections: type: integer @@ -33365,6 +34352,7 @@ components: - FTS_INDEX_CLEANED_UP - FTS_INDEXES_RESTORED - FTS_INDEXES_RESTORE_FAILED + - FTS_INDEXES_SYNONYM_MAPPING_INVALID example: FTS_INDEX_CREATED title: FTS Index Audit Types FTSIndexAuditView: @@ -34292,37 +35280,52 @@ components: enum: - EXCLUDE title: Field Transformation - ForNdsGroup: + FieldViolation: type: object - description: ReplicaSet Event identifies different activities about replica - set of mongod instances. properties: - created: + description: type: string - format: date-time - description: Date and time when this event occurred. This parameter expresses - its value in the ISO 8601 timestamp format in UTC. + 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. + required: + - description + - field + FlexBackupRestoreJob20250101: + type: object + description: Details for one restore job of a flex cluster. + properties: + deliveryType: + type: string + description: Means by which this resource returns the snapshot to the requesting + MongoDB Cloud user. + enum: + - RESTORE + - DOWNLOAD readOnly: true - eventTypeName: - $ref: "#/components/schemas/ReplicaSetEventTypeViewForNdsGroup" - groupId: + expirationDate: type: string - description: Unique 24-hexadecimal digit string that identifies the project - in which the event occurred. The **eventId** identifies the specific event. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" + format: date-time + description: Date and time when the download link no longer works. This + parameter expresses its value in the ISO 8601 timestamp format in UTC. readOnly: true id: type: string - description: Unique 24-hexadecimal digit string that identifies the event. + description: Unique 24-hexadecimal digit string that identifies the restore + job. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true + instanceName: + type: string + description: Human-readable label that identifies the source instance. + maxLength: 64 + minLength: 1 + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + readOnly: true links: type: array description: "List of one or more Uniform Resource Locators (URLs) that\ @@ -34334,656 +35337,296 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true - orgId: + projectId: type: string - description: Unique 24-hexadecimal digit string that identifies the organization - to which these events apply. + description: Unique 24-hexadecimal digit string that identifies the project + from which the restore job originated. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true - port: - type: integer - format: int32 - description: IANA port on which the MongoDB process listens for requests. - example: 27017 - readOnly: true - raw: - $ref: "#/components/schemas/raw" - replicaSetName: + restoreFinishedDate: type: string - description: Human-readable label of the replica set associated with the - event. - example: event-replica-set + format: date-time + 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. readOnly: true - shardName: + restoreScheduledDate: type: string - description: Human-readable label of the shard associated with the event. - example: event-sh-01 + format: date-time + description: Date and time when MongoDB Cloud will restore this snapshot. + This parameter expresses its value in the ISO 8601 timestamp format in + UTC. readOnly: true - required: - - created - - eventTypeName - - id - title: ReplicaSet Events - GCPCloudProviderContainer: - type: object - allOf: - - $ref: "#/components/schemas/CloudProviderContainer" - - type: object - properties: - atlasCidrBlock: - type: string - description: |- - IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project. - - These CIDR blocks must fall within the ranges reserved per RFC 1918. GCP further limits the block to a lower bound of the `/18` range. - - To modify the CIDR block, the target project cannot have: - - - Any M10 or greater clusters - - Any other VPC peering connections - - You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project. - - **Example:** A project in an Google Cloud (GCP) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets. - pattern: "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" - gcpProjectId: - 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. - maxLength: 26 - minLength: 26 - pattern: "^p-[0-9a-z]{24}$" - readOnly: true - networkName: - 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. - maxLength: 36 - minLength: 36 - pattern: "^nt-[0-9a-f]{24}-[0-9a-z]{8}$" - 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." - 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." - 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 - description: Collection of settings that configures the network container for - a virtual private connection on Amazon Web Services. - required: - - atlasCidrBlock - title: GCP - GCPComputeAutoScaling: - type: object - description: Collection of settings that configures how a cluster might scale - its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling - is unavailable for clusters using Low CPU or NVME storage classes. - properties: - maxInstanceSize: - type: string - description: Maximum instance size to which your cluster can automatically - scale. - enum: - - M10 - - M20 - - M30 - - M40 - - M50 - - M60 - - M80 - - M140 - - M200 - - M250 - - M300 - - M400 - - R40 - - R50 - - R60 - - R80 - - R200 - - R300 - - R400 - - R600 - title: GCP Instance Sizes - minInstanceSize: + snapshotFinishedDate: 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 - title: GCP Instance Sizes - title: GCP - GCPConsumerForwardingRule: - type: object - properties: - endpointName: + format: date-time + description: Date and time when MongoDB Cloud completed writing this snapshot. + This parameter expresses its value in the ISO 8601 timestamp format in + UTC. + readOnly: true + snapshotId: type: string - description: Human-readable label that identifies the Google Cloud consumer - forwarding rule that you created. - externalDocs: - description: Google Cloud Forwarding Rule Concepts - url: https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts + description: Unique 24-hexadecimal digit string that identifies the snapshot + to restore. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" readOnly: true - ipAddress: + snapshotUrl: type: string - description: One Private Internet Protocol version 4 (IPv4) address to which - this Google Cloud consumer forwarding rule resolves. - pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + 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: State of the MongoDB Cloud endpoint group when MongoDB Cloud - received this request. + description: Phase of the restore workflow for this job at the time this + resource made this request. enum: - - INITIATING - - AVAILABLE + - PENDING + - QUEUED + - RUNNING - FAILED - - DELETING + - COMPLETED readOnly: true - GCPEndpointService: + targetDeploymentItemName: + type: string + description: Human-readable label that identifies the instance or cluster + on the target project to which you want to restore the snapshot. You can + restore the snapshot to another USS instance or Dedicated cluster tier. + maxLength: 64 + minLength: 1 + pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + readOnly: true + targetProjectId: + type: string + description: Unique 24-hexadecimal digit string that identifies the project + that contains the instance or cluster to which you want to restore the + snapshot. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + title: Flex Backup Restore Job + FlexBackupRestoreJobCreate20250101: type: object - description: Group of Private Endpoint Service settings. + description: Details to create one restore job of a flex cluster. properties: - cloudProvider: + _snapshotId: type: string - description: Cloud service provider that serves the requested endpoint service. + description: Unique 24-hexadecimal digit string that identifies the snapshot + to restore. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + writeOnly: true + _targetDeploymentItemName: + type: string + description: Human-readable label that identifies the instance or cluster + on the target project to which you want to restore the snapshot. You can + restore the snapshot to another flex cluster or dedicated cluster tier. + maxLength: 64 + minLength: 1 + pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + writeOnly: true + _targetProjectId: + type: string + description: Unique 24-hexadecimal digit string that identifies the project + that contains the instance or cluster to which you want to restore the + snapshot. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + writeOnly: true + deliveryType: + type: string + description: Means by which this resource returns the snapshot to the requesting + MongoDB Cloud user. enum: - - AWS - - AZURE - - GCP + - RESTORE + - DOWNLOAD readOnly: true - 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 - items: - type: string - description: One Google Cloud network endpoint group that corresponds - to the Private Service Connect endpoint service. - errorMessage: + expirationDate: type: string - description: Error message returned when requesting private connection resource. - The resource returns `null` if the request succeeded. + format: date-time + description: Date and time when the download link no longer works. This + parameter expresses its value in the ISO 8601 timestamp format in UTC. readOnly: true id: type: string - description: Unique 24-hexadecimal digit string that identifies the Private - Endpoint Service. + description: Unique 24-hexadecimal digit string that identifies the restore + job. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true - regionName: + instanceName: type: string - description: Cloud provider region that manages this Private Endpoint Service. + description: Human-readable label that identifies the source instance. + maxLength: 64 + minLength: 1 + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true - serviceAttachmentNames: + links: 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. + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." externalDocs: - description: Google Cloud Private Service Connect Service Attachments - url: https://cloud.google.com/vpc/docs/private-service-connect#service-attachments + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 items: - 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. - 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\\-]+" - status: + $ref: "#/components/schemas/Link" + readOnly: true + projectId: type: string - description: State of the Private Endpoint Service connection when MongoDB - Cloud received this request. - enum: - - INITIATING - - AVAILABLE - - WAITING_FOR_USER - - FAILED - - DELETING - readOnly: true - required: - - cloudProvider - title: GCP - GCPHardwareSpec: - type: object - properties: - instanceSize: - type: string - description: Hardware specification for the instance sizes in this region. - Each instance size has a default storage and memory capacity. The instance - size you select applies to all the data-bearing hosts 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 - title: GCP Instance Sizes - nodeCount: - type: integer - format: int32 - description: Number of nodes of the given type for MongoDB Cloud to deploy - to the region. - GCPHardwareSpec20240805: - type: object - properties: - diskSizeGB: - type: number - format: double - description: "Storage capacity of instance data volumes expressed in gigabytes.\ - \ Increase this number to add capacity.\n\n This value must be equal for\ - \ all shards and node types.\n\n This value is not configurable on M0/M2/M5\ - \ clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\ - \n If you specify a disk size below the minimum (10 GB), this parameter\ - \ defaults to the minimum disk size value. \n\n Storage charge calculations\ - \ depend on whether you choose the default value or a custom value.\n\n\ - \ The maximum value for disk storage cannot exceed 50 times the maximum\ - \ RAM for the selected cluster. If you require more storage space, consider\ - \ upgrading your cluster to a higher tier." - maximum: 4096 - minimum: 10 - instanceSize: - type: string - description: Hardware specification for the instance sizes in this region - in this shard. Each instance size has a default storage and memory capacity. - Electable nodes and read-only nodes (known as "base nodes") within a single - shard must use the same instance size. Analytics nodes can scale independently - from base nodes within a shard. Both base nodes and analytics nodes can - scale independently from their equivalents in other shards. - enum: - - M10 - - M20 - - M30 - - M40 - - M50 - - M60 - - M80 - - M140 - - M200 - - M250 - - M300 - - M400 - - R40 - - R50 - - R60 - - R80 - - R200 - - R300 - - R400 - - R600 - title: GCP Instance Sizes - nodeCount: - type: integer - format: int32 - description: Number of nodes of the given type for MongoDB Cloud to deploy - to the region. - GCPNetworkPeeringConnectionSettings: - type: object - description: Group of Network Peering connection settings. - properties: - containerId: - type: string - description: Unique 24-hexadecimal digit string that identifies the MongoDB - Cloud network container that contains the specified network peering connection. + description: Unique 24-hexadecimal digit string that identifies the project + from which the restore job originated. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" - 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: + restoreFinishedDate: 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. - maxLength: 30 - minLength: 6 - pattern: "^[a-z][0-9a-z-]{4,28}[0-9a-z]{1}" - id: + format: date-time + 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. + readOnly: true + restoreScheduledDate: type: string - description: Unique 24-hexadecimal digit string that identifies the network - peering connection. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" + format: date-time + description: Date and time when MongoDB Cloud will restore this snapshot. + This parameter expresses its value in the ISO 8601 timestamp format in + UTC. readOnly: true - networkName: + snapshotFinishedDate: type: string - description: Human-readable label that identifies the network to peer with - the MongoDB Cloud VPC. - maxLength: 63 - minLength: 1 - pattern: "[a-z]([-a-z0-9]{0,62}[a-z0-9]{0,1})?" - providerName: + format: date-time + description: Date and time when MongoDB Cloud completed writing this snapshot. + This parameter expresses its value in the ISO 8601 timestamp format in + UTC. + readOnly: true + snapshotUrl: type: string - description: Cloud service provider that serves the requested network peering - connection. - enum: - - AWS - - AZURE - - GCP + 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: State of the network peering connection at the time you made - the request. + description: Phase of the restore workflow for this job at the time this + resource made this request. enum: - - ADDING_PEER - - WAITING_FOR_USER - - AVAILABLE + - PENDING + - QUEUED + - RUNNING - FAILED - - DELETING + - COMPLETED readOnly: true required: - - containerId - - gcpProjectId - - networkName - title: GCP - GCPRegionConfig: - type: object - allOf: - - $ref: "#/components/schemas/CloudRegionConfig" - - type: object - properties: - analyticsAutoScaling: - $ref: "#/components/schemas/AdvancedAutoScalingSettings" - analyticsSpecs: - $ref: "#/components/schemas/DedicatedHardwareSpec" - autoScaling: - $ref: "#/components/schemas/AdvancedAutoScalingSettings" - readOnlySpecs: - $ref: "#/components/schemas/DedicatedHardwareSpec" - description: Details that explain how MongoDB Cloud replicates data in one region - on the specified MongoDB database. - title: GCP Regional Replication Specifications - GCPRegionConfig20240805: - type: object - allOf: - - $ref: "#/components/schemas/CloudRegionConfig20240805" - - type: object - properties: - analyticsAutoScaling: - $ref: "#/components/schemas/AdvancedAutoScalingSettings" - analyticsSpecs: - $ref: "#/components/schemas/DedicatedHardwareSpec20240805" - autoScaling: - $ref: "#/components/schemas/AdvancedAutoScalingSettings" - readOnlySpecs: - $ref: "#/components/schemas/DedicatedHardwareSpec20240805" - description: Details that explain how MongoDB Cloud replicates data in one region - on the specified MongoDB database. - title: GCP Regional Replication Specifications - GeoSharding: + - _snapshotId + - _targetDeploymentItemName + title: Create Flex Backup Restore Job + FlexBackupSettings20250101: type: object + description: Flex backup configuration properties: - customZoneMapping: - type: object - additionalProperties: - 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 - 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. - items: - $ref: "#/components/schemas/ManagedNamespaces" - readOnly: true - selfManagedSharding: + enabled: 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. + default: true + description: "Flag that indicates whether backups are performed for this\ + \ flex cluster. Backup uses [TODO](TODO) for flex clusters." readOnly: true - GeoSharding20240805: + readOnly: true + title: Flex Backup Configuration + FlexBackupSnapshot20250101: type: object + description: Details for one snapshot of a flex cluster. properties: - customZoneMapping: - type: object - additionalProperties: - type: string - description: |- - List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone. - - The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property. - - This parameter returns an empty object if no custom zones exist. - readOnly: true - description: |- - List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone. - - The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property. - - This parameter returns an empty object if no custom zones exist. - readOnly: true - managedNamespaces: - type: array - description: List that contains a namespace for a Global Cluster. MongoDB - Cloud manages this cluster. - items: - $ref: "#/components/schemas/ManagedNamespaces" - readOnly: true - 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. + expiration: + type: string + format: date-time + description: Date and time when the download link no longer works. This + parameter expresses its value in the ISO 8601 timestamp format in UTC. readOnly: true - GoogleCloudKMS: - type: object - description: Details that define the configuration of Encryption at Rest using - Google Cloud Key Management Service (KMS). - externalDocs: - description: Google Cloud Key Management Service - url: https://www.mongodb.com/docs/atlas/security-gcp-kms/ - properties: - enabled: - 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: + finishTime: 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 - serviceAccountKey: + format: date-time + description: Date and time when MongoDB Cloud completed writing this snapshot. + This parameter expresses its value in the ISO 8601 timestamp format in + UTC. + readOnly: true + id: type: string - description: 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. + description: Unique 24-hexadecimal digit string that identifies the snapshot. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." externalDocs: - description: Google Cloud Authentication - url: https://cloud.google.com/docs/authentication/getting-started - writeOnly: true - valid: - type: boolean - description: Flag that indicates whether the Google Cloud Key Management - Service (KMS) encryption key can encrypt and decrypt data. + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" readOnly: true - GreaterThanDaysThresholdView: - type: object - description: Threshold value that triggers an alert. - properties: - operator: - type: string - description: Comparison operator to apply when checking the current metric - value. - enum: - - GREATER_THAN - threshold: - type: integer - format: int32 - description: "Value of metric that, when exceeded, triggers an alert." - units: + mongoDBVersion: type: string - description: "Element used to express the quantity. This can be an element\ - \ of time, storage capacity, and the like." - enum: - - DAYS - GreaterThanRawThreshold: - type: object - description: A Limit that triggers an alert when greater than a number. - properties: - operator: + description: MongoDB host version that the snapshot runs. + readOnly: true + scheduledTime: type: string - description: Comparison operator to apply when checking the current metric - value. - enum: - - GREATER_THAN - threshold: - type: integer - format: int32 - description: "Value of metric that, when exceeded, triggers an alert." - units: - $ref: "#/components/schemas/RawMetricUnits" - title: Greater Than Raw Threshold - GreaterThanRawThresholdAlertConfigViewForNdsGroup: - type: object - properties: - created: + format: date-time + description: Date and time when MongoDB Cloud will take the snapshot. This + parameter expresses its value in the ISO 8601 timestamp format in UTC. + readOnly: true + startTime: type: string format: date-time - description: Date and time when MongoDB Cloud created the alert configuration. - This parameter expresses its value in the ISO 8601 timestamp format - in UTC. + description: Date and time when MongoDB Cloud began taking the snapshot. + This parameter expresses its value in the ISO 8601 timestamp format in + UTC. readOnly: true - enabled: - type: boolean - default: false - description: Flag that indicates whether someone enabled this alert configuration - for the specified project. - eventTypeName: - $ref: "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" - groupId: + status: type: string - description: Unique 24-hexadecimal digit string that identifies the project - that owns this alert configuration. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" + description: Phase of the workflow for this snapshot at the time this resource + made this request. + enum: + - PENDING + - QUEUED + - RUNNING + - FAILED + - COMPLETED readOnly: true - id: + title: Flex Backup Snapshot + FlexBackupSnapshotDownloadCreate20250101: + type: object + description: Details for one backup snapshot download of a flex cluster. + properties: + _snapshotId: type: string - description: Unique 24-hexadecimal digit string that identifies this alert - configuration. + description: Unique 24-hexadecimal digit string that identifies the snapshot + to download. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" - readOnly: true + writeOnly: true links: type: array description: "List of one or more Uniform Resource Locators (URLs) that\ @@ -34995,67 +35638,42 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true - matchers: - type: array - description: "List of rules that determine whether MongoDB Cloud checks\ - \ an object for the alert configuration. You can filter using the matchers\ - \ array if the **eventTypeName** specifies an event for a host, replica\ - \ set, or sharded cluster." - items: - $ref: "#/components/schemas/ReplicaSetMatcher" - notifications: - type: array - description: List that contains the targets that MongoDB Cloud sends notifications. - items: - $ref: "#/components/schemas/AlertsNotificationRootForGroup" - threshold: - $ref: "#/components/schemas/GreaterThanRawThreshold" - updated: - type: string - format: date-time - description: Date and time when someone last updated this alert configuration. - This parameter expresses its value in the ISO 8601 timestamp format - in UTC. - readOnly: true required: - - eventTypeName - - notifications - GreaterThanTimeThreshold: + - _snapshotId + title: Flex Backup Snapshot Download Create + FlexClusterDescription20250101: type: object - description: A Limit that triggers an alert when greater than a time period. + description: Group of settings that configure a MongoDB Flex cluster. properties: - operator: + backupSettings: + $ref: "#/components/schemas/FlexBackupSettings20250101" + clusterType: type: string - description: Comparison operator to apply when checking the current metric - value. + description: Flex cluster topology. enum: - - GREATER_THAN - threshold: - type: integer - format: int32 - description: "Value of metric that, when exceeded, triggers an alert." - units: - $ref: "#/components/schemas/TimeMetricUnits" - title: Greater Than Time Threshold - Group: - type: object - properties: - clusterCount: - type: integer - format: int64 - description: Quantity of MongoDB Cloud clusters deployed in this project. + - REPLICASET + - LOADBALANCED readOnly: true - created: + connectionStrings: + $ref: "#/components/schemas/FlexConnectionStrings20250101" + createDate: type: string format: date-time - description: Date and time when MongoDB Cloud created this project. This - parameter expresses its value in the ISO 8601 timestamp format in UTC. + description: Date and time when MongoDB Cloud created this instance. This + parameter expresses its value in ISO 8601 format in UTC. + readOnly: true + groupId: + type: string + description: Unique 24-hexadecimal character string that identifies the + project. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" readOnly: true id: type: string - description: Unique 24-hexadecimal digit string that identifies the MongoDB - Cloud project. + description: Unique 24-hexadecimal digit string that identifies the instance. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 @@ -35072,18 +35690,1021 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true + mongoDBVersion: + type: string + description: Version of MongoDB that the instance runs. + pattern: "([\\d]+\\.[\\d]+\\.[\\d]+)" + readOnly: true name: type: string - description: Human-readable label that identifies the project included in - the MongoDB Cloud organization. + description: Human-readable label that identifies the instance. maxLength: 64 minLength: 1 - pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" - orgId: + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + readOnly: true + providerSettings: + $ref: "#/components/schemas/FlexProviderSettings20250101" + stateName: type: string - description: Unique 24-hexadecimal digit string that identifies the MongoDB - Cloud organization to which the project belongs. - example: 32b6e34b3d91647abb20e7b8 + description: Human-readable label that indicates the current operating condition + of this instance. + enum: + - IDLE + - CREATING + - UPDATING + - DELETING + - REPAIRING + readOnly: true + tags: + type: array + description: List that contains key-value pairs between 1 to 255 characters + in length for tagging and categorizing the instance. + externalDocs: + description: Resource Tags + url: https://dochub.mongodb.org/core/add-cluster-tag-atlas + items: + $ref: "#/components/schemas/ResourceTag" + terminationProtectionEnabled: + type: boolean + default: false + description: "Flag that indicates whether termination protection is enabled\ + \ on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster.\ + \ If set to `false`, MongoDB Cloud will delete the cluster." + versionReleaseSystem: + type: string + default: LTS + description: Method by which the cluster maintains the MongoDB versions. + enum: + - LTS + readOnly: true + required: + - providerSettings + title: Flex Cluster Description + FlexClusterDescriptionCreate20250101: + type: object + description: Settings that you can specify when you create a flex cluster. + properties: + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + name: + type: string + description: Human-readable label that identifies the instance. + maxLength: 64 + minLength: 1 + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + writeOnly: true + providerSettings: + $ref: "#/components/schemas/FlexProviderSettingsCreate20250101" + tags: + type: array + description: List that contains key-value pairs between 1 to 255 characters + in length for tagging and categorizing the instance. + externalDocs: + description: Resource Tags + url: https://dochub.mongodb.org/core/add-cluster-tag-atlas + items: + $ref: "#/components/schemas/ResourceTag" + terminationProtectionEnabled: + type: boolean + default: false + description: "Flag that indicates whether termination protection is enabled\ + \ on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster.\ + \ If set to `false`, MongoDB Cloud will delete the cluster." + required: + - name + - providerSettings + title: Flex Cluster Description Create + FlexConnectionStrings20250101: + type: object + description: Collection of Uniform Resource Locators that point to the MongoDB + database. + externalDocs: + description: Connection string URI format. + url: https://docs.mongodb.com/manual/reference/connection-string/ + properties: + standard: + type: string + description: Public connection string that you can use to connect to this + cluster. This connection string uses the mongodb:// protocol. + externalDocs: + description: Connection String URI Format + url: https://docs.mongodb.com/manual/reference/connection-string/ + readOnly: true + standardSrv: + type: string + description: Public connection string that you can use to connect to this + flex cluster. This connection string uses the `mongodb+srv://` protocol. + externalDocs: + description: Connection String URI Format + url: https://docs.mongodb.com/manual/reference/connection-string/ + readOnly: true + readOnly: true + title: Flex Cluster Connection Strings + FlexProviderSettings20250101: + type: object + description: Group of cloud provider settings that configure the provisioned + MongoDB flex cluster. + properties: + backingProviderName: + type: string + description: Cloud service provider on which MongoDB Cloud provisioned the + flex cluster. + enum: + - AWS + - AZURE + - GCP + readOnly: true + diskSizeGB: + type: number + format: double + description: Storage capacity available to the flex cluster expressed in + gigabytes. + readOnly: true + providerName: + type: string + default: FLEX + description: Human-readable label that identifies the cloud service provider. + enum: + - FLEX + readOnly: true + regionName: + type: string + description: "Human-readable label that identifies the geographic location\ + \ of your MongoDB flex cluster. The region you choose can affect network\ + \ latency for clients accessing your databases. For a complete list of\ + \ region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws),\ + \ [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/)." + readOnly: true + readOnly: true + title: Cloud Service Provider Settings for a Flex Cluster + FlexProviderSettingsCreate20250101: + type: object + description: Group of cloud provider settings that configure the provisioned + MongoDB flex cluster. + properties: + backingProviderName: + type: string + description: Cloud service provider on which MongoDB Cloud provisioned the + flex cluster. + enum: + - AWS + - AZURE + - GCP + writeOnly: true + diskSizeGB: + type: number + format: double + description: Storage capacity available to the flex cluster expressed in + gigabytes. + readOnly: true + providerName: + type: string + default: FLEX + description: Human-readable label that identifies the cloud service provider. + enum: + - FLEX + readOnly: true + regionName: + type: string + description: "Human-readable label that identifies the geographic location\ + \ of your MongoDB flex cluster. The region you choose can affect network\ + \ latency for clients accessing your databases. For a complete list of\ + \ region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws),\ + \ [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/)." + writeOnly: true + required: + - backingProviderName + - regionName + title: Cloud Service Provider Settings for a Flex Cluster + writeOnly: true + ForNdsGroup: + type: object + description: ReplicaSet Event identifies different activities about replica + set of mongod instances. + properties: + created: + type: string + format: date-time + description: Date and time when this event occurred. This parameter expresses + its value in the ISO 8601 timestamp format in UTC. + readOnly: true + eventTypeName: + $ref: "#/components/schemas/ReplicaSetEventTypeViewForNdsGroup" + groupId: + type: string + description: Unique 24-hexadecimal digit string that identifies the project + in which the event occurred. The **eventId** identifies the specific event. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + id: + type: string + description: Unique 24-hexadecimal digit string that identifies the event. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + orgId: + type: string + description: Unique 24-hexadecimal digit string that identifies the organization + to which these events apply. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + port: + type: integer + format: int32 + description: IANA port on which the MongoDB process listens for requests. + example: 27017 + readOnly: true + raw: + $ref: "#/components/schemas/raw" + replicaSetName: + type: string + description: Human-readable label of the replica set associated with the + event. + example: event-replica-set + readOnly: true + shardName: + type: string + description: Human-readable label of the shard associated with the event. + example: event-sh-01 + readOnly: true + required: + - created + - eventTypeName + - id + title: ReplicaSet Events + GCPCloudProviderContainer: + type: object + allOf: + - $ref: "#/components/schemas/CloudProviderContainer" + - type: object + properties: + atlasCidrBlock: + type: string + description: |- + IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project. + + These CIDR blocks must fall within the ranges reserved per RFC 1918. GCP further limits the block to a lower bound of the `/18` range. + + To modify the CIDR block, the target project cannot have: + + - Any M10 or greater clusters + - Any other VPC peering connections + + You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project. + + **Example:** A project in an Google Cloud (GCP) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets. + pattern: "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + gcpProjectId: + 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. + maxLength: 26 + minLength: 26 + pattern: "^p-[0-9a-z]{24}$" + readOnly: true + networkName: + 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. + maxLength: 36 + minLength: 36 + pattern: "^nt-[0-9a-f]{24}-[0-9a-z]{8}$" + 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." + 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." + 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 + description: Collection of settings that configures the network container for + a virtual private connection on Amazon Web Services. + required: + - atlasCidrBlock + title: GCP + GCPComputeAutoScaling: + type: object + description: Collection of settings that configures how a cluster might scale + its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling + is unavailable for clusters using Low CPU or NVME storage classes. + properties: + maxInstanceSize: + type: string + description: Maximum instance size to which your cluster can automatically + scale. + enum: + - M10 + - M20 + - M30 + - M40 + - M50 + - M60 + - M80 + - M140 + - M200 + - M250 + - M300 + - M400 + - R40 + - R50 + - R60 + - R80 + - R200 + - R300 + - R400 + - R600 + title: GCP Instance Sizes + minInstanceSize: + 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 + title: GCP Instance Sizes + title: GCP + GCPConsumerForwardingRule: + type: object + properties: + endpointName: + type: string + description: Human-readable label that identifies the Google Cloud consumer + forwarding rule that you created. + externalDocs: + description: Google Cloud Forwarding Rule Concepts + url: https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts + readOnly: true + ipAddress: + type: string + description: One Private Internet Protocol version 4 (IPv4) address to which + this Google Cloud consumer forwarding rule resolves. + pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + readOnly: true + status: + type: string + description: State of the MongoDB Cloud endpoint group when MongoDB Cloud + received this request. + enum: + - INITIATING + - AVAILABLE + - FAILED + - DELETING + readOnly: true + 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 + 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. + enum: + - CENTRAL_US + - WESTERN_EUROPE + readOnly: true + GCPEndpointService: + type: object + description: Group of Private Endpoint Service settings. + properties: + cloudProvider: + type: string + description: Cloud service provider that serves the requested endpoint service. + enum: + - AWS + - AZURE + - GCP + readOnly: true + 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 + 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: + type: string + description: Unique 24-hexadecimal digit string that identifies the Private + Endpoint Service. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + 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 + items: + 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. + 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\\-]+" + status: + type: string + description: State of the Private Endpoint Service connection when MongoDB + Cloud received this request. + enum: + - INITIATING + - AVAILABLE + - WAITING_FOR_USER + - FAILED + - DELETING + readOnly: true + required: + - cloudProvider + title: GCP + GCPHardwareSpec: + type: object + properties: + instanceSize: + type: string + description: Hardware specification for the instance sizes in this region. + Each instance size has a default storage and memory capacity. The instance + size you select applies to all the data-bearing hosts 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 + title: GCP Instance Sizes + nodeCount: + type: integer + format: int32 + description: Number of nodes of the given type for MongoDB Cloud to deploy + to the region. + GCPHardwareSpec20240805: + type: object + properties: + diskSizeGB: + type: number + format: double + description: "Storage capacity of instance data volumes expressed in gigabytes.\ + \ Increase this number to add capacity.\n\n This value must be equal for\ + \ all shards and node types.\n\n This value is not configurable on M0/M2/M5\ + \ clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\ + \n If you specify a disk size below the minimum (10 GB), this parameter\ + \ defaults to the minimum disk size value. \n\n Storage charge calculations\ + \ depend on whether you choose the default value or a custom value.\n\n\ + \ The maximum value for disk storage cannot exceed 50 times the maximum\ + \ RAM for the selected cluster. If you require more storage space, consider\ + \ upgrading your cluster to a higher tier." + maximum: 4096 + minimum: 10 + instanceSize: + type: string + description: Hardware specification for the instance sizes in this region + in this shard. Each instance size has a default storage and memory capacity. + Electable nodes and read-only nodes (known as "base nodes") within a single + shard must use the same instance size. Analytics nodes can scale independently + from base nodes within a shard. Both base nodes and analytics nodes can + scale independently from their equivalents in other shards. + enum: + - M10 + - M20 + - M30 + - M40 + - M50 + - M60 + - M80 + - M140 + - M200 + - M250 + - M300 + - M400 + - R40 + - R50 + - R60 + - R80 + - R200 + - R300 + - R400 + - R600 + title: GCP Instance Sizes + nodeCount: + type: integer + format: int32 + description: Number of nodes of the given type for MongoDB Cloud to deploy + to the region. + GCPNetworkPeeringConnectionSettings: + type: object + description: Group of Network Peering connection settings. + properties: + containerId: + type: string + description: Unique 24-hexadecimal digit string that identifies the MongoDB + Cloud network container that contains the specified network peering connection. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + 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: + 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. + maxLength: 30 + minLength: 6 + pattern: "^[a-z][0-9a-z-]{4,28}[0-9a-z]{1}" + id: + type: string + description: Unique 24-hexadecimal digit string that identifies the network + peering connection. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + networkName: + type: string + description: Human-readable label that identifies the network to peer with + the MongoDB Cloud VPC. + maxLength: 63 + minLength: 1 + pattern: "[a-z]([-a-z0-9]{0,62}[a-z0-9]{0,1})?" + 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. + enum: + - ADDING_PEER + - WAITING_FOR_USER + - AVAILABLE + - FAILED + - DELETING + readOnly: true + required: + - containerId + - gcpProjectId + - networkName + title: GCP + GCPRegionConfig: + type: object + allOf: + - $ref: "#/components/schemas/CloudRegionConfig" + - type: object + properties: + analyticsAutoScaling: + $ref: "#/components/schemas/AdvancedAutoScalingSettings" + analyticsSpecs: + $ref: "#/components/schemas/DedicatedHardwareSpec" + autoScaling: + $ref: "#/components/schemas/AdvancedAutoScalingSettings" + readOnlySpecs: + $ref: "#/components/schemas/DedicatedHardwareSpec" + description: Details that explain how MongoDB Cloud replicates data in one region + on the specified MongoDB database. + title: GCP Regional Replication Specifications + GCPRegionConfig20240805: + type: object + allOf: + - $ref: "#/components/schemas/CloudRegionConfig20240805" + - type: object + properties: + analyticsAutoScaling: + $ref: "#/components/schemas/AdvancedAutoScalingSettings" + analyticsSpecs: + $ref: "#/components/schemas/DedicatedHardwareSpec20240805" + autoScaling: + $ref: "#/components/schemas/AdvancedAutoScalingSettings" + readOnlySpecs: + $ref: "#/components/schemas/DedicatedHardwareSpec20240805" + description: Details that explain how MongoDB Cloud replicates data in one region + on the specified MongoDB database. + title: GCP Regional Replication Specifications + GeoSharding: + type: object + properties: + customZoneMapping: + type: object + additionalProperties: + 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 + 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. + items: + $ref: "#/components/schemas/ManagedNamespaces" + readOnly: true + 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 + GeoSharding20240805: + type: object + properties: + customZoneMapping: + type: object + additionalProperties: + type: string + description: |- + List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone. + + The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property. + + This parameter returns an empty object if no custom zones exist. + readOnly: true + description: |- + List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone. + + The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property. + + This parameter returns an empty object if no custom zones exist. + readOnly: true + managedNamespaces: + type: array + description: List that contains a namespace for a Global Cluster. MongoDB + Cloud manages this cluster. + items: + $ref: "#/components/schemas/ManagedNamespaces" + readOnly: true + 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 + GoogleCloudKMS: + type: object + description: Details that define the configuration of Encryption at Rest using + Google Cloud Key Management Service (KMS). + externalDocs: + description: Google Cloud Key Management Service + url: https://www.mongodb.com/docs/atlas/security-gcp-kms/ + properties: + enabled: + 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 + 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. + externalDocs: + description: Google Cloud Authentication + url: https://cloud.google.com/docs/authentication/getting-started + writeOnly: true + valid: + type: boolean + description: Flag that indicates whether the Google Cloud Key Management + Service (KMS) encryption key can encrypt and decrypt data. + readOnly: true + GreaterThanDaysThresholdView: + type: object + description: Threshold value that triggers an alert. + properties: + operator: + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - GREATER_THAN + threshold: + type: integer + format: int32 + description: "Value of metric that, when exceeded, triggers an alert." + units: + type: string + description: "Element used to express the quantity. This can be an element\ + \ of time, storage capacity, and the like." + enum: + - DAYS + GreaterThanRawThreshold: + type: object + description: A Limit that triggers an alert when greater than a number. + properties: + operator: + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - GREATER_THAN + threshold: + type: integer + format: int32 + description: "Value of metric that, when exceeded, triggers an alert." + units: + $ref: "#/components/schemas/RawMetricUnits" + title: Greater Than Raw Threshold + GreaterThanRawThresholdAlertConfigViewForNdsGroup: + type: object + properties: + created: + type: string + format: date-time + description: Date and time when MongoDB Cloud created the alert configuration. + This parameter expresses its value in the ISO 8601 timestamp format + in UTC. + readOnly: true + enabled: + type: boolean + default: false + description: Flag that indicates whether someone enabled this alert configuration + for the specified project. + eventTypeName: + $ref: "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" + groupId: + type: string + description: Unique 24-hexadecimal digit string that identifies the project + that owns this alert configuration. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + id: + type: string + description: Unique 24-hexadecimal digit string that identifies this alert + configuration. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + matchers: + type: array + description: "List of rules that determine whether MongoDB Cloud checks\ + \ an object for the alert configuration. You can filter using the matchers\ + \ array if the **eventTypeName** specifies an event for a host, replica\ + \ set, or sharded cluster." + items: + $ref: "#/components/schemas/ReplicaSetMatcher" + notifications: + type: array + description: List that contains the targets that MongoDB Cloud sends notifications. + items: + $ref: "#/components/schemas/AlertsNotificationRootForGroup" + threshold: + $ref: "#/components/schemas/GreaterThanRawThreshold" + updated: + type: string + format: date-time + description: Date and time when someone last updated this alert configuration. + This parameter expresses its value in the ISO 8601 timestamp format + in UTC. + readOnly: true + required: + - eventTypeName + - notifications + GreaterThanTimeThreshold: + type: object + description: A Limit that triggers an alert when greater than a time period. + properties: + operator: + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - GREATER_THAN + threshold: + type: integer + format: int32 + description: "Value of metric that, when exceeded, triggers an alert." + units: + $ref: "#/components/schemas/TimeMetricUnits" + title: Greater Than Time Threshold + Group: + type: object + properties: + clusterCount: + type: integer + format: int64 + description: Quantity of MongoDB Cloud clusters deployed in this project. + readOnly: true + created: + type: string + format: date-time + description: Date and time when MongoDB Cloud created this project. This + parameter expresses its value in the ISO 8601 timestamp format in UTC. + readOnly: true + id: + type: string + description: Unique 24-hexadecimal digit string that identifies the MongoDB + Cloud project. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + name: + type: string + description: Human-readable label that identifies the project included in + the MongoDB Cloud organization. + maxLength: 64 + minLength: 1 + pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + orgId: + type: string + description: Unique 24-hexadecimal digit string that identifies the MongoDB + Cloud organization to which the project belongs. + example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" @@ -35332,25 +36953,26 @@ components: maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" - readOnly: true destinationOrgPrivateApiKey: type: string - description: "Unique string that identifies the private part of the [API\ - \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) used\ - \ to verify access to the destination organization. This parameter is\ - \ required only when you authenticate with Programmatic API Keys." + description: Unique string that identifies the private part of the API Key + used to verify access to the destination organization. This parameter + is required only when you authenticate with Programmatic API Keys. example: 55c3bbb6-b4bb-0be1-e66d20841f3e - readOnly: true + externalDocs: + description: Grant Programmatic Access to Atlas + url: https://dochub.mongodb.org/core/atlas-create-prog-api-key destinationOrgPublicApiKey: type: string - description: "Unique string that identifies the public part of the [API\ - \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) used\ - \ to verify access to the destination organization. This parameter is\ - \ required only when you authenticate with Programmatic API Keys." + description: Unique string that identifies the public part of the API Key + used to verify access to the destination organization. This parameter + is required only when you authenticate with Programmatic API Keys. example: zmmrboas + externalDocs: + description: Grant Programmatic Access to Atlas + url: https://dochub.mongodb.org/core/atlas-create-prog-api-key maxLength: 8 minLength: 8 - readOnly: true GroupNotification: type: object description: Group notification configuration for MongoDB Cloud to send information @@ -35440,7 +37062,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/EventViewForNdsGroup" @@ -35488,6 +37110,33 @@ components: - GROUP_READ_ONLY - GROUP_SEARCH_INDEX_EDITOR - GROUP_STREAM_PROCESSING_OWNER + GroupRoleAssignment: + type: object + properties: + groupId: + type: string + description: Unique 24-hexadecimal digit string that identifies the project + to which these roles belong. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + groupRoles: + type: array + description: One or more project level roles assigned to the MongoDB Cloud + user. + items: + type: string + enum: + - GROUP_OWNER + - GROUP_CLUSTER_MANAGER + - GROUP_STREAM_PROCESSING_OWNER + - GROUP_DATA_ACCESS_ADMIN + - GROUP_DATA_ACCESS_READ_WRITE + - GROUP_DATA_ACCESS_READ_ONLY + - GROUP_READ_ONLY + - GROUP_SEARCH_INDEX_EDITOR + uniqueItems: true GroupService: type: object description: List of IP addresses in a project categorized by services. @@ -35503,26 +37152,26 @@ components: GroupServiceAccount: type: object properties: + clientId: + type: string + description: The Client ID of the Service Account. + pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" createdAt: type: string format: date-time - description: Service account creation time. + description: The date that the Service Account was created on. description: type: string - description: Description of the service account. - id: - type: string - description: ID for the service account. - pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" + description: Human readable description for the Service Account. name: type: string - description: Name for service account. + description: Human-readable name for the Service Account. roles: type: array - description: Roles assigned to the Service Account group. + description: A list of Project roles associated with the Service Account. items: type: string - description: Project roles associated with the service account. + description: Project roles available for Service Accounts. enum: - GROUP_OWNER - GROUP_READ_ONLY @@ -35535,7 +37184,7 @@ components: uniqueItems: true secrets: type: array - description: List of secrets. + description: A list of secrets associated with the specified Service Account. items: $ref: "#/components/schemas/ServiceAccountSecret" uniqueItems: true @@ -35544,23 +37193,23 @@ components: properties: description: type: string - description: Human readable description for the service account. + description: Human readable description for the Service Account. maxLength: 250 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" name: type: string - description: Human-readable name for the service account. The name is modifiable + description: Human-readable name for the Service Account. The name is modifiable and does not have to be unique. maxLength: 64 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" roles: type: array - description: Project roles associated with the service account. + description: A list of project-level roles for the Service Account. items: type: string - description: Project roles associated with the service account. + description: Project roles available for Service Accounts. enum: - GROUP_OWNER - GROUP_READ_ONLY @@ -35573,20 +37222,23 @@ components: secretExpiresAfterHours: type: integer format: int32 - description: Secret expiration time. + description: The expiration time of the new Service Account secret. The + expiration is provided in hours. required: - description - name + - roles - secretExpiresAfterHours GroupServiceAccountRoleAssignment: type: object properties: roles: type: array - description: Group access roles. + description: The Project permissions for the Service Account in the specified + Project. items: type: string - description: Project roles associated with the service account. + description: Project roles available for Service Accounts. enum: - GROUP_OWNER - GROUP_READ_ONLY @@ -35597,28 +37249,30 @@ components: - GROUP_SEARCH_INDEX_EDITOR - GROUP_STREAM_PROCESSING_OWNER uniqueItems: true + required: + - roles GroupServiceAccountUpdateRequest: type: object properties: description: type: string - description: Human readable description for the service account. + description: Human readable description for the Service Account. maxLength: 250 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" name: type: string - description: Human-readable name for the service account. The name is modifiable + description: Human-readable name for the Service Account. The name is modifiable and does not have to be unique. maxLength: 64 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" roles: type: array - description: Project roles associated with the service account. + description: A list of Project roles associated with the Service Account. items: type: string - description: Project roles associated with the service account. + description: Project roles available for Service Accounts. enum: - GROUP_OWNER - GROUP_READ_ONLY @@ -35882,7 +37536,7 @@ components: example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -36001,6 +37655,8 @@ components: - HOST_HAS_INDEX_SUGGESTIONS - HOST_MONGOT_RECOVERED_OOM - HOST_MONGOT_CRASHING_OOM + - HOST_MONGOT_RESUME_REPLICATION + - HOST_MONGOT_STOP_REPLICATION - HOST_ENOUGH_DISK_SPACE - HOST_NOT_ENOUGH_DISK_SPACE example: HOST_DOWN @@ -36012,6 +37668,7 @@ components: - HOST_DOWN - HOST_HAS_INDEX_SUGGESTIONS - HOST_MONGOT_CRASHING_OOM + - HOST_MONGOT_STOP_REPLICATION - HOST_NOT_ENOUGH_DISK_SPACE example: HOST_DOWN title: Host Event Types @@ -36308,6 +37965,7 @@ components: OPCOUNTER_REPL_INSERT: "#/components/schemas/RawMetricAlertView" OPCOUNTER_REPL_UPDATE: "#/components/schemas/RawMetricAlertView" OPCOUNTER_UPDATE: "#/components/schemas/RawMetricAlertView" + OPERATIONS_QUERIES_KILLED: "#/components/schemas/RawMetricAlertView" OPERATIONS_SCAN_AND_ORDER: "#/components/schemas/RawMetricAlertView" OPERATION_THROTTLING_REJECTED_OPERATIONS: "#/components/schemas/RawMetricAlertView" OPLOG_MASTER_LAG_TIME_DIFF: "#/components/schemas/TimeMetricAlertView" @@ -36382,7 +38040,7 @@ components: example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -36711,6 +38369,7 @@ components: OPCOUNTER_REPL_INSERT: "#/components/schemas/RawMetricEventView" OPCOUNTER_REPL_UPDATE: "#/components/schemas/RawMetricEventView" OPCOUNTER_UPDATE: "#/components/schemas/RawMetricEventView" + OPERATIONS_QUERIES_KILLED: "#/components/schemas/RawMetricEventView" OPERATIONS_SCAN_AND_ORDER: "#/components/schemas/RawMetricEventView" OPERATION_THROTTLING_REJECTED_OPERATIONS: "#/components/schemas/RawMetricEventView" OPLOG_MASTER_LAG_TIME_DIFF: "#/components/schemas/TimeMetricEventView" @@ -37016,6 +38675,7 @@ components: OPCOUNTER_REPL_INSERT: "#/components/schemas/RawMetricThresholdView" OPCOUNTER_REPL_UPDATE: "#/components/schemas/RawMetricThresholdView" OPCOUNTER_UPDATE: "#/components/schemas/RawMetricThresholdView" + OPERATIONS_QUERIES_KILLED: "#/components/schemas/RawMetricThresholdView" OPERATIONS_SCAN_AND_ORDER: "#/components/schemas/RawMetricThresholdView" OPERATION_THROTTLING_REJECTED_OPERATIONS: "#/components/schemas/RawMetricThresholdView" OPLOG_MASTER_LAG_TIME_DIFF: "#/components/schemas/TimeMetricThresholdView" @@ -37060,7 +38720,12 @@ components: enum: - AVERAGE operator: - $ref: "#/components/schemas/Operator" + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - LESS_THAN + - GREATER_THAN threshold: type: number format: double @@ -37537,7 +39202,7 @@ components: the charge. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -37973,6 +39638,21 @@ components: - ATLAS_AWS_STREAM_PROCESSING_DATA_TRANSFER - ATLAS_AZURE_STREAM_PROCESSING_DATA_TRANSFER - ATLAS_AWS_STREAM_PROCESSING_VPC_PEERING + - 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 readOnly: true startDate: type: string @@ -38298,6 +39978,371 @@ components: - REPLICASET - SHARDED - GEOSHARDED + configServerManagementMode: + type: string + default: ATLAS_MANAGED + description: |- + Config Server Management Mode for creating or updating a sharded cluster. + + When configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings. + + When configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server. + enum: + - ATLAS_MANAGED + - FIXED_TO_DEDICATED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + configServerType: + type: string + description: Describes a sharded cluster's config server type. + enum: + - DEDICATED + - EMBEDDED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + readOnly: true + connectionStrings: + $ref: "#/components/schemas/ClusterConnectionStrings" + createDate: + type: string + format: date-time + description: Date and time when MongoDB Cloud created this serverless instance. + MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. + readOnly: true + diskSizeGB: + type: number + format: double + 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." + maximum: 4096 + minimum: 10 + diskWarmingMode: + type: string + default: FULLY_WARMED + description: Disk warming mode selection. + enum: + - FULLY_WARMED + - VISIBLE_EARLIER + externalDocs: + description: Reduce Secondary Disk Warming Impact + url: https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact + encryptionAtRestProvider: + type: string + description: Cloud service provider that manages your customer keys to provide + an additional layer of Encryption at Rest for the cluster. + enum: + - NONE + - AWS + - AZURE + - GCP + externalDocs: + description: Encryption at Rest using Customer Key Management + url: https://www.mongodb.com/docs/atlas/security-kms-encryption/ + featureCompatibilityVersion: + type: string + description: Feature compatibility version of the cluster. + readOnly: true + featureCompatibilityVersionExpirationDate: + type: string + format: date-time + description: Feature compatibility version expiration date. + 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: + type: string + description: Unique 24-hexadecimal character string that identifies the + project. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + id: + type: string + description: Unique 24-hexadecimal digit string that identifies the cluster. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + labels: + type: array + deprecated: true + description: |- + Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels. + + Cluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead. + items: + $ref: "#/components/schemas/ComponentLabel" + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + 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- + mongoDBVersion: + type: string + description: Version of MongoDB that the cluster runs. + pattern: "([\\d]+\\.[\\d]+\\.[\\d]+)" + 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." + externalDocs: + description: Connection string URI format. + url: https://docs.mongodb.com/manual/reference/connection-string/ + readOnly: true + mongoURIUpdated: + type: string + format: date-time + description: Date and time when someone last updated the connection string. + MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. + readOnly: true + 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." + externalDocs: + description: Connection string URI format. + url: https://docs.mongodb.com/manual/reference/connection-string/ + readOnly: true + name: + type: string + description: Human-readable label that identifies the cluster. + maxLength: 64 + minLength: 1 + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + numShards: + type: integer + format: int32 + default: 1 + description: Number of shards up to 50 to deploy for a sharded cluster. + The resource returns `1` to indicate a replica set and values of `2` and + higher to indicate a sharded cluster. The returned value equals the number + of shards in the cluster. + externalDocs: + description: Sharding + url: https://docs.mongodb.com/manual/sharding/ + maximum: 50 + minimum: 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 + default: WORKLOAD_TYPE + description: |- + Set this field to configure the replica set scaling mode for your cluster. + + By default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes. + + When configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads. + + When configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads. + enum: + - SEQUENTIAL + - WORKLOAD_TYPE + - NODE_TYPE + externalDocs: + description: Modify the Replica Set Scaling Mode + url: https://dochub.mongodb.org/core/scale-nodes + replicationFactor: + type: integer + format: int32 + default: 3 + deprecated: true + description: "Number of members that belong to the replica set. Each member\ + \ retains a copy of your databases, providing high availability and data\ + \ redundancy. Use **replicationSpecs** instead." + enum: + - 3 + - 5 + - 7 + replicationSpec: + type: object + additionalProperties: + $ref: "#/components/schemas/RegionSpec" + description: Physical location where MongoDB Cloud provisions cluster nodes. + title: Region Configuration + 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. + items: + $ref: "#/components/schemas/LegacyReplicationSpec" + rootCertType: + type: string + default: ISRGROOTX1 + description: Root Certificate Authority that MongoDB Atlas clusters uses. + MongoDB Cloud supports Internet Security Research Group. + 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. + externalDocs: + description: Connection string URI format. + url: https://docs.mongodb.com/manual/reference/connection-string/ + readOnly: true + stateName: + type: string + description: Human-readable label that indicates the current operating condition + of the cluster. + enum: + - IDLE + - CREATING + - UPDATING + - DELETING + - REPAIRING + readOnly: true + tags: + type: array + description: List that contains key-value pairs between 1 to 255 characters + in length for tagging and categorizing the cluster. + externalDocs: + description: Resource Tags + url: https://dochub.mongodb.org/core/add-cluster-tag-atlas + items: + $ref: "#/components/schemas/ResourceTag" + terminationProtectionEnabled: + type: boolean + default: false + description: "Flag that indicates whether termination protection is enabled\ + \ on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster.\ + \ If set to `false`, MongoDB Cloud will delete the cluster." + versionReleaseSystem: + type: string + default: LTS + description: "Method by which the cluster maintains the MongoDB versions.\ + \ If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**." + enum: + - LTS + - CONTINUOUS + title: Cluster Description + LegacyAtlasTenantClusterUpgradeRequest: + type: object + description: Request containing target state of tenant cluster to be upgraded + properties: + acceptDataRisksAndForceReplicaSetReconfig: + type: string + format: date-time + description: "If reconfiguration is necessary to regain a primary due to\ + \ a regional outage, submit this field alongside your topology reconfiguration\ + \ to request a new regional outage resistant topology. Forced reconfigurations\ + \ during an outage of the majority of electable nodes carry a risk of\ + \ data loss if replicated writes (even majority committed writes) have\ + \ not been replicated to the new primary node. MongoDB Atlas docs contain\ + \ more information. To proceed with an operation which carries that risk,\ + \ set **acceptDataRisksAndForceReplicaSetReconfig** to the current date." + externalDocs: + description: Reconfiguring a Replica Set during a regional outage + url: https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set + 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 + default: ATLAS_MANAGED + description: |- + Config Server Management Mode for creating or updating a sharded cluster. + + When configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings. + + When configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server. + enum: + - ATLAS_MANAGED + - FIXED_TO_DEDICATED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + configServerType: + type: string + description: Describes a sharded cluster's config server type. + enum: + - DEDICATED + - EMBEDDED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + readOnly: true connectionStrings: $ref: "#/components/schemas/ClusterConnectionStrings" createDate: @@ -38342,6 +40387,15 @@ components: externalDocs: description: Encryption at Rest using Customer Key Management url: https://www.mongodb.com/docs/atlas/security-kms-encryption/ + featureCompatibilityVersion: + type: string + description: Feature compatibility version of the cluster. + readOnly: true + featureCompatibilityVersionExpirationDate: + type: string + format: date-time + description: Feature compatibility version expiration date. + readOnly: true globalClusterSelfManagedSharding: type: boolean description: |- @@ -38392,6 +40446,8 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true + mongoDBEmployeeAccessGrant: + $ref: "#/components/schemas/EmployeeAccessGrantView" mongoDBMajorVersion: type: string description: |- @@ -38438,7 +40494,7 @@ components: description: Human-readable label that identifies the cluster. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" numShards: type: integer format: int32 @@ -38470,292 +40526,24 @@ components: \ use MongoDB Cloud backups." providerSettings: $ref: "#/components/schemas/ClusterProviderSettings" - replicationFactor: - type: integer - format: int32 - default: 3 - deprecated: true - description: "Number of members that belong to the replica set. Each member\ - \ retains a copy of your databases, providing high availability and data\ - \ redundancy. Use **replicationSpecs** instead." - enum: - - 3 - - 5 - - 7 - replicationSpec: - type: object - additionalProperties: - $ref: "#/components/schemas/RegionSpec" - description: Physical location where MongoDB Cloud provisions cluster nodes. - title: Region Configuration - 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. - items: - $ref: "#/components/schemas/LegacyReplicationSpec" - rootCertType: - type: string - default: ISRGROOTX1 - description: Root Certificate Authority that MongoDB Atlas clusters uses. - MongoDB Cloud supports Internet Security Research Group. - 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. - externalDocs: - description: Connection string URI format. - url: https://docs.mongodb.com/manual/reference/connection-string/ - readOnly: true - stateName: - type: string - description: Human-readable label that indicates the current operating condition - of the cluster. - enum: - - IDLE - - CREATING - - UPDATING - - DELETING - - REPAIRING - readOnly: true - tags: - type: array - description: List that contains key-value pairs between 1 to 255 characters - in length for tagging and categorizing the cluster. - externalDocs: - description: Resource Tags - url: https://dochub.mongodb.org/core/add-cluster-tag-atlas - items: - $ref: "#/components/schemas/ResourceTag" - terminationProtectionEnabled: - type: boolean - default: false - description: "Flag that indicates whether termination protection is enabled\ - \ on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster.\ - \ If set to `false`, MongoDB Cloud will delete the cluster." - versionReleaseSystem: - type: string - default: LTS - description: "Method by which the cluster maintains the MongoDB versions.\ - \ If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**." - enum: - - LTS - - CONTINUOUS - title: Cluster Description - LegacyAtlasTenantClusterUpgradeRequest: - type: object - description: Request containing target state of tenant cluster to be upgraded - properties: - acceptDataRisksAndForceReplicaSetReconfig: - type: string - format: date-time - description: "If reconfiguration is necessary to regain a primary due to\ - \ a regional outage, submit this field alongside your topology reconfiguration\ - \ to request a new regional outage resistant topology. Forced reconfigurations\ - \ during an outage of the majority of electable nodes carry a risk of\ - \ data loss if replicated writes (even majority committed writes) have\ - \ not been replicated to the new primary node. MongoDB Atlas docs contain\ - \ more information. To proceed with an operation which carries that risk,\ - \ set **acceptDataRisksAndForceReplicaSetReconfig** to the current date." - externalDocs: - description: Reconfiguring a Replica Set during a regional outage - url: https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set - 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 - connectionStrings: - $ref: "#/components/schemas/ClusterConnectionStrings" - createDate: - type: string - format: date-time - description: Date and time when MongoDB Cloud created this serverless instance. - MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. - readOnly: true - diskSizeGB: - type: number - format: double - 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." - maximum: 4096 - minimum: 10 - diskWarmingMode: - type: string - default: FULLY_WARMED - description: Disk warming mode selection. - enum: - - FULLY_WARMED - - VISIBLE_EARLIER - externalDocs: - description: Reduce Secondary Disk Warming Impact - url: https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact - encryptionAtRestProvider: - type: string - description: Cloud service provider that manages your customer keys to provide - an additional layer of Encryption at Rest for the cluster. - enum: - - NONE - - AWS - - AZURE - - GCP - externalDocs: - description: Encryption at Rest using Customer Key Management - url: https://www.mongodb.com/docs/atlas/security-kms-encryption/ - 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: - type: string - description: Unique 24-hexadecimal character string that identifies the - project. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - id: + replicaSetScalingStrategy: type: string - description: Unique 24-hexadecimal digit string that identifies the cluster. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - labels: - type: array - deprecated: true + default: WORKLOAD_TYPE 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. + Set this field to configure the replica set scaling mode for your cluster. - Cluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead. - items: - $ref: "#/components/schemas/ComponentLabel" - links: - type: array - description: "List of one or more Uniform Resource Locators (URLs) that\ - \ point to API sub-resources, related API resources, or both. RFC 5988\ - \ outlines these relationships." - externalDocs: - description: Web Linking Specification (RFC 5988) - url: https://datatracker.ietf.org/doc/html/rfc5988 - items: - $ref: "#/components/schemas/Link" - readOnly: true - mongoDBMajorVersion: - type: string - description: |- - MongoDB major version of the cluster. + By default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes. - 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). + When configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads. - 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- - mongoDBVersion: - type: string - description: Version of MongoDB that the cluster runs. - pattern: "([\\d]+\\.[\\d]+\\.[\\d]+)" - 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." - externalDocs: - description: Connection string URI format. - url: https://docs.mongodb.com/manual/reference/connection-string/ - readOnly: true - mongoURIUpdated: - type: string - format: date-time - description: Date and time when someone last updated the connection string. - MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. - readOnly: true - 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." - externalDocs: - description: Connection string URI format. - url: https://docs.mongodb.com/manual/reference/connection-string/ - readOnly: true - name: - type: string - description: Human-readable label that identifies the cluster. - maxLength: 64 - minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - numShards: - type: integer - format: int32 - default: 1 - description: Number of shards up to 50 to deploy for a sharded cluster. - The resource returns `1` to indicate a replica set and values of `2` and - higher to indicate a sharded cluster. The returned value equals the number - of shards in the cluster. - externalDocs: - description: Sharding - url: https://docs.mongodb.com/manual/sharding/ - maximum: 50 - minimum: 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. + When configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads. + enum: + - SEQUENTIAL + - WORKLOAD_TYPE + - NODE_TYPE externalDocs: - description: 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" + description: Modify the Replica Set Scaling Mode + url: https://dochub.mongodb.org/core/scale-nodes replicationFactor: type: integer format: int32 @@ -39318,6 +41106,10 @@ components: - INSTANCE_NAME - PROCESSOR_NAME title: Streams Matcher Fields + - type: string + enum: + - RULE_ID + title: Log Ingestion Matcher Fields MatcherHostType: type: string description: Value to match or exceed using the specified **matchers.operator**. @@ -40032,6 +41824,7 @@ components: - 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 @@ -40109,6 +41902,8 @@ components: - 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 @@ -40138,6 +41933,9 @@ components: - 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 @@ -40196,9 +41994,13 @@ components: - 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 example: CLUSTER_CREATED title: NDS Audit Types NDSAuditTypeViewForOrg: @@ -41174,7 +42976,7 @@ components: example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -41433,7 +43235,12 @@ components: enum: - AVERAGE operator: - $ref: "#/components/schemas/Operator" + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - LESS_THAN + - GREATER_THAN threshold: type: number format: double @@ -41623,6 +43430,57 @@ components: required: - typeName title: OpsGenie Notification + OrgActiveUserResponse: + type: object + allOf: + - $ref: "#/components/schemas/OrgUserResponse" + - type: object + properties: + country: + type: string + description: Two alphabet characters that identifies MongoDB Cloud user's + geographic location. This parameter uses the ISO 3166-1a2 code format. + example: US + pattern: "^([A-Z]{2})$" + readOnly: true + createdAt: + type: string + format: date-time + description: Date and time when MongoDB Cloud created the current account. + This value is in the ISO 8601 timestamp format in UTC. + readOnly: true + firstName: + type: string + description: First or given name that belongs to the MongoDB Cloud user. + example: John + readOnly: true + lastAuth: + type: string + format: date-time + description: Date and time when the current account last authenticated. + This value is in the ISO 8601 timestamp format in UTC. + readOnly: true + lastName: + type: string + description: "Last name, family name, or surname that belongs to the MongoDB\ + \ Cloud user." + example: Doe + readOnly: true + mobileNumber: + type: string + description: Mobile phone number that belongs to the MongoDB Cloud user. + pattern: "(?:(?:\\\\+?1\\\\s*(?:[.-]\\\\s*)?)?(?:(\\\\s*([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9])\\\ + \\s*)|([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9]))\\\\s*(?:[.-]\\\\\ + s*)?)([2-9]1[02-9]|[2-9][02-9]1|[2-9][02-9]{2})\\\\s*(?:[.-]\\\\s*)?([0-9]{4})$" + readOnly: true + required: + - createdAt + - firstName + - id + - lastName + - orgMembershipStatus + - roles + - username OrgEventTypeViewForOrg: type: string description: Unique identifier of event type. @@ -41973,7 +43831,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/EventViewForOrg" @@ -41985,29 +43843,61 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true + OrgPendingUserResponse: + type: object + allOf: + - $ref: "#/components/schemas/OrgUserResponse" + - type: object + properties: + invitationCreatedAt: + type: string + format: date-time + description: Date and time when MongoDB Cloud sent the invitation. MongoDB + Cloud represents this timestamp in ISO 8601 format in UTC. + readOnly: true + invitationExpiresAt: + type: string + format: date-time + description: Date and time when the invitation from MongoDB Cloud expires. + MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. + readOnly: true + inviterUsername: + type: string + format: email + description: Username of the MongoDB Cloud user who sent the invitation + to join the organization. + readOnly: true + required: + - id + - invitationCreatedAt + - invitationExpiresAt + - inviterUsername + - orgMembershipStatus + - roles + - username OrgServiceAccount: type: object properties: + clientId: + type: string + description: The Client ID of the Service Account. + pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" createdAt: type: string format: date-time - description: Service account creation time. + description: The date that the Service Account was created on. description: type: string - description: Description of the service account. - id: - type: string - description: ID for the service account. - pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" + description: Human readable description for the Service Account. name: type: string - description: Name for service account. + description: Human-readable name for the Service Account. roles: type: array - description: Organization roles assigned to the Service Account. + description: A list of Organization roles associated with the Service Account. items: type: string - description: Organization roles associated with the service account. + description: Organization roles available for Service Accounts. enum: - ORG_MEMBER - ORG_READ_ONLY @@ -42018,7 +43908,7 @@ components: uniqueItems: true secrets: type: array - description: List of secrets. + description: A list of secrets associated with the specified Service Account. items: $ref: "#/components/schemas/ServiceAccountSecret" uniqueItems: true @@ -42027,23 +43917,23 @@ components: properties: description: type: string - description: Human readable description for the service account. + description: Human readable description for the Service Account. maxLength: 250 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" name: type: string - description: Human-readable name for the service account. The name is modifiable + description: Human-readable name for the Service Account. The name is modifiable and does not have to be unique. maxLength: 64 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" roles: type: array - description: Organization roles associated with the service account. + description: A list of organization-level roles for the Service Account. items: type: string - description: Organization roles associated with the service account. + description: Organization roles available for Service Accounts. enum: - ORG_MEMBER - ORG_READ_ONLY @@ -42054,33 +43944,35 @@ components: secretExpiresAfterHours: type: integer format: int32 - description: Secret expiration time. + description: The expiration time of the new Service Account secret. The + expiration is provided in hours. required: - description - name + - roles - secretExpiresAfterHours OrgServiceAccountUpdateRequest: type: object properties: description: type: string - description: Human readable description for the service account. + description: Human readable description for the Service Account. maxLength: 250 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" name: type: string - description: Human-readable name for the service account. The name is modifiable + description: Human-readable name for the Service Account. The name is modifiable and does not have to be unique. maxLength: 64 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" roles: type: array - description: Organization roles associated with the Service account. + description: A list of organization-level roles for the Service Account. items: type: string - description: Organization roles associated with the service account. + description: Organization roles available for Service Accounts. enum: - ORG_MEMBER - ORG_READ_ONLY @@ -42088,6 +43980,158 @@ components: - ORG_BILLING_READ_ONLY - ORG_GROUP_CREATOR - ORG_OWNER + OrgUserRequest: + type: object + properties: + roles: + $ref: "#/components/schemas/OrgUserRolesRequest" + teamIds: + type: array + description: List of unique 24-hexadecimal digit strings that identifies + the teams to which this MongoDB Cloud user belongs. + items: + type: string + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + uniqueItems: true + writeOnly: true + username: + type: string + format: email + description: Email address that represents the username of the MongoDB Cloud + user. + writeOnly: true + required: + - roles + - username + OrgUserResponse: + type: object + discriminator: + mapping: + ACTIVE: "#/components/schemas/OrgActiveUserResponse" + PENDING: "#/components/schemas/OrgPendingUserResponse" + propertyName: orgMembershipStatus + oneOf: + - $ref: "#/components/schemas/OrgPendingUserResponse" + - $ref: "#/components/schemas/OrgActiveUserResponse" + properties: + id: + type: string + description: Unique 24-hexadecimal digit string that identifies the MongoDB + Cloud user. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + orgMembershipStatus: + type: string + description: String enum that indicates whether the MongoDB Cloud user has + a pending invitation to join the organization or they are already active + in the organization. + enum: + - PENDING + - ACTIVE + readOnly: true + roles: + $ref: "#/components/schemas/OrgUserRolesResponse" + teamIds: + type: array + description: List of unique 24-hexadecimal digit strings that identifies + the teams to which this MongoDB Cloud user belongs. + items: + type: string + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + uniqueItems: true + username: + type: string + format: email + description: Email address that represents the username of the MongoDB Cloud + user. + readOnly: true + required: + - id + - orgMembershipStatus + - roles + - username + OrgUserRolesRequest: + type: object + description: Organization and project level roles to assign the MongoDB Cloud + user within one organization. + properties: + groupRoleAssignments: + type: array + description: List of project level role assignments to assign the MongoDB + Cloud user. + items: + $ref: "#/components/schemas/GroupRoleAssignment" + orgRoles: + type: array + description: One or more organization level roles to assign the MongoDB + Cloud user. + items: + type: string + enum: + - ORG_OWNER + - ORG_GROUP_CREATOR + - ORG_BILLING_ADMIN + - ORG_BILLING_READ_ONLY + - ORG_READ_ONLY + - ORG_MEMBER + minItems: 1 + uniqueItems: true + required: + - orgRoles + writeOnly: true + OrgUserRolesResponse: + type: object + description: Organization and project level roles assigned to one MongoDB Cloud + user within one organization. + properties: + groupRoleAssignments: + type: array + description: List of project level role assignments assigned to the MongoDB + Cloud user. + items: + $ref: "#/components/schemas/GroupRoleAssignment" + orgRoles: + type: array + description: One or more organization level roles assigned to the MongoDB + Cloud user. + items: + type: string + enum: + - ORG_OWNER + - ORG_GROUP_CREATOR + - ORG_BILLING_ADMIN + - ORG_BILLING_READ_ONLY + - ORG_READ_ONLY + - ORG_MEMBER + uniqueItems: true + readOnly: true + OrgUserUpdateRequest: + type: object + properties: + roles: + $ref: "#/components/schemas/OrgUserRolesRequest" + teamIds: + type: array + description: List of unique 24-hexadecimal digit strings that identifies + the teams to assign the MongoDB Cloud user. + items: + type: string + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + uniqueItems: true + writeOnly: true OrganizationInvitation: type: object properties: @@ -42299,10 +44343,11 @@ components: restrictEmployeeAccess: type: boolean description: "Flag that indicates whether to block MongoDB Support from\ - \ accessing Atlas infrastructure 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/." + \ 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/." OutboundControlPlaneCloudProviderIPAddresses: type: object description: "List of outbound IP addresses from the Atlas control plane, categorized\ @@ -42475,7 +44520,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/AdvancedClusterDescription" @@ -42503,7 +44548,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/GroupAlertsConfig" @@ -42531,7 +44576,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/AlertViewForNdsGroup" @@ -42559,7 +44604,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ApiKeyUserDetails" @@ -42587,7 +44632,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/CloudAppUser" @@ -42615,7 +44660,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ApiAtlasCheckpointView" @@ -42645,7 +44690,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/CloudDatabaseUser" @@ -42673,7 +44718,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/DiskBackupExportJob" @@ -42701,7 +44746,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/EARPrivateEndpoint" @@ -42713,7 +44758,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedApiAtlasProviderRegionsView: + PaginatedApiAtlasFlexBackupRestoreJob20250101View: type: object properties: links: @@ -42729,10 +44774,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/CloudProviderRegions" + $ref: "#/components/schemas/FlexBackupRestoreJob20250101" readOnly: true totalCount: type: integer @@ -42741,7 +44786,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedApiAtlasServerlessBackupRestoreJobView: + PaginatedApiAtlasFlexBackupSnapshot20240710View: type: object properties: links: @@ -42757,10 +44802,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/ServerlessBackupRestoreJob" + $ref: "#/components/schemas/FlexBackupSnapshot20250101" readOnly: true totalCount: type: integer @@ -42769,7 +44814,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedApiAtlasServerlessBackupSnapshotView: + PaginatedApiAtlasProviderRegionsView: type: object properties: links: @@ -42785,10 +44830,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/ServerlessBackupSnapshot" + $ref: "#/components/schemas/CloudProviderRegions" readOnly: true totalCount: type: integer @@ -42797,7 +44842,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedApiAtlasUSSBackupRestoreJob20250101View: + PaginatedApiAtlasServerlessBackupRestoreJobView: type: object properties: links: @@ -42813,10 +44858,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/USSBackupRestoreJob20250101" + $ref: "#/components/schemas/ServerlessBackupRestoreJob" readOnly: true totalCount: type: integer @@ -42825,7 +44870,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedApiAtlasUSSBackupSnapshot20240710View: + PaginatedApiAtlasServerlessBackupSnapshotView: type: object properties: links: @@ -42841,10 +44886,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/USSBackupSnapshot20250101" + $ref: "#/components/schemas/ServerlessBackupSnapshot" readOnly: true totalCount: type: integer @@ -42869,7 +44914,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/BillingInvoiceMetadata" @@ -42897,7 +44942,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/BillingInvoice" @@ -42925,7 +44970,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/StreamsConnection" @@ -42937,6 +44982,34 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true + PaginatedApiStreamsPrivateLinkView: + type: object + properties: + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + results: + type: array + description: List of returned documents that MongoDB Cloud provides when + completing this request. + items: + $ref: "#/components/schemas/StreamsPrivateLinkConnection" + readOnly: true + totalCount: + type: integer + format: int32 + description: Total number of documents available. MongoDB Cloud omits this + value if `includeCount` is set to `false`. + minimum: 0 + readOnly: true PaginatedApiStreamsStreamProcessorWithStatsView: type: object properties: @@ -42953,7 +45026,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/StreamsProcessorWithStats" @@ -42981,7 +45054,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/StreamsTenant" @@ -43009,7 +45082,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/UserAccessListResponse" @@ -43021,6 +45094,34 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true + PaginatedApiVersions: + type: object + properties: + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + results: + type: array + description: List of returned documents that MongoDB Cloud provides when + completing this request. + items: + $ref: "#/components/schemas/ApiVersion" + readOnly: true + totalCount: + type: integer + format: int32 + description: Total number of documents available. MongoDB Cloud omits this + value if `includeCount` is set to `false`. + minimum: 0 + readOnly: true PaginatedAppUserView: type: object properties: @@ -43037,7 +45138,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/CloudAppUser" @@ -43065,7 +45166,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/Group" @@ -43093,7 +45194,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/MdbAvailableVersion" @@ -43121,7 +45222,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/DiskBackupSnapshotAWSExportBucket" @@ -43149,7 +45250,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/DiskBackupSnapshotExportBucket" @@ -43177,7 +45278,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/DiskBackupSnapshot" @@ -43205,7 +45306,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/DiskBackupReplicaSet" @@ -43233,7 +45334,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/DiskBackupSnapshotRestoreJob" @@ -43261,7 +45362,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/DiskBackupShardedClusterSnapshot" @@ -43290,7 +45391,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/CloudProviderContainer" @@ -43319,7 +45420,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ClusterDescription20240805" @@ -43347,7 +45448,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ConnectedOrgConfig" @@ -43376,7 +45477,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/BaseNetworkPeeringConnectionSettings" @@ -43404,7 +45505,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/MesurementsDatabase" @@ -43432,7 +45533,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/MeasurementDiskPartition" @@ -43460,7 +45561,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/EventTypeDetails" @@ -43488,7 +45589,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/FederationIdentityProvider" @@ -43500,9 +45601,37 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true + PaginatedFlexClusters20250101: + type: object + properties: + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + results: + type: array + description: List of returned documents that MongoDB Cloud provides when + completing this request. + items: + type: object + readOnly: true + totalCount: + type: integer + format: int32 + description: Total number of documents available. MongoDB Cloud omits this + value if `includeCount` is set to `false`. + minimum: 0 + readOnly: true PaginatedGroupServiceAccounts: type: object - description: List of Service Accounts + description: A list of Project Service Accounts. properties: links: type: array @@ -43517,7 +45646,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/GroupServiceAccount" @@ -43545,7 +45674,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ApiHostView_Atlas" @@ -43573,7 +45702,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ThirdPartyIntegration" @@ -43601,7 +45730,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/LegacyAtlasCluster" @@ -43629,7 +45758,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/NetworkPermissionEntry" @@ -43657,7 +45786,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/BackupOnlineArchive" @@ -43685,7 +45814,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/OrgGroup" @@ -43699,7 +45828,7 @@ components: readOnly: true PaginatedOrgServiceAccounts: type: object - description: List of Service Accounts + description: A list of Organization Service Accounts. properties: links: type: array @@ -43714,7 +45843,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/OrgServiceAccount" @@ -43742,7 +45871,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/AtlasOrganization" @@ -43770,7 +45899,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/IngestionPipelineRun" @@ -43798,7 +45927,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/PrivateNetworkEndpointIdEntry" @@ -43826,7 +45955,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/PublicApiUsageDetailsLineItemView" @@ -43854,7 +45983,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/BackupRestoreJob" @@ -43884,7 +46013,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/AuthFederationRoleMapping" @@ -43912,7 +46041,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ServerlessInstanceDescription" @@ -43926,7 +46055,7 @@ components: readOnly: true PaginatedServiceAccountGroup: type: object - description: List of Service Account projects. + description: A list of projects associated with the Service Account. properties: links: type: array @@ -43941,7 +46070,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ServiceAccountGroup" @@ -43953,7 +46082,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedSnapshotView: + PaginatedServiceAccountIPAccessEntryView: type: object properties: links: @@ -43969,10 +46098,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/BackupSnapshot" + $ref: "#/components/schemas/ServiceAccountIPAccessListEntry" readOnly: true totalCount: type: integer @@ -43981,7 +46110,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedTeamRoleView: + PaginatedSnapshotView: type: object properties: links: @@ -43997,10 +46126,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/TeamRole" + $ref: "#/components/schemas/BackupSnapshot" readOnly: true totalCount: type: integer @@ -44009,7 +46138,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedTeamView: + PaginatedTeamRoleView: type: object properties: links: @@ -44025,10 +46154,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/TeamResponse" + $ref: "#/components/schemas/TeamRole" readOnly: true totalCount: type: integer @@ -44037,7 +46166,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedTenantRestoreView: + PaginatedTeamView: type: object properties: links: @@ -44053,10 +46182,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/TenantRestore" + $ref: "#/components/schemas/TeamResponse" readOnly: true totalCount: type: integer @@ -44065,7 +46194,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedTenantSnapshotView: + PaginatedTenantRestoreView: type: object properties: links: @@ -44081,10 +46210,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/BackupTenantSnapshot" + $ref: "#/components/schemas/TenantRestore" readOnly: true totalCount: type: integer @@ -44093,7 +46222,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedUSSInstance20250101: + PaginatedTenantSnapshotView: type: object properties: links: @@ -44109,10 +46238,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - type: object + $ref: "#/components/schemas/BackupTenantSnapshot" readOnly: true totalCount: type: integer @@ -44137,7 +46266,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/UserCert" @@ -44625,6 +46754,13 @@ components: PrivateNetworkEndpointIdEntry: type: object properties: + azureConnectionName: + type: string + description: Connection name that identifies the Azure private endpoint + connection. + 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. @@ -44632,6 +46768,10 @@ components: type: string description: Human-readable label to identify customer's VPC endpoint DNS name. + customerEndpointIPAddress: + type: string + description: IP address used to connect to the Azure private endpoint. + pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" endpointId: type: string description: Unique 22-character alphanumeric string that identifies the @@ -44644,6 +46784,10 @@ components: maxLength: 22 minLength: 22 pattern: "^vpce-[0-9a-f]{17}$" + errorMessage: + type: string + description: Error message describing a failure approving the private endpoint + request. provider: type: string default: AWS @@ -44655,6 +46799,14 @@ components: type: string description: Human-readable label to identify the region of customer's VPC endpoint. + status: + type: string + description: Status of the private endpoint connection request. + enum: + - PENDING + - OK + - FAILED + - DELETING type: type: string default: DATA_LAKE @@ -44724,16 +46876,6 @@ components: - serviceDiscovery - username title: PROMETHEUS - ProxyInfo: - type: object - description: VPC Proxy Information. - properties: - authKey: - type: string - description: Authentication key for the proxy. - dnsName: - type: string - description: DNS name to use to reach the proxy/s. PublicApiUsageDetailsLineItemView: type: object properties: @@ -44825,7 +46967,12 @@ components: enum: - AVERAGE operator: - $ref: "#/components/schemas/Operator" + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - LESS_THAN + - GREATER_THAN threshold: type: number format: double @@ -44876,7 +47023,7 @@ components: example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -45135,7 +47282,12 @@ components: enum: - AVERAGE operator: - $ref: "#/components/schemas/Operator" + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - LESS_THAN + - GREATER_THAN threshold: type: number format: double @@ -45325,7 +47477,7 @@ components: example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -46126,7 +48278,7 @@ components: you loaded the sample dataset. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true completeDate: type: string @@ -46940,7 +49092,7 @@ components: \ this parameter when `\"deliveryType\" : \"download\"`." items: type: string - description: One Uniform Resource Locator that point to the compressed + description: One Uniform Resource Locator that points to the compressed snapshot files for manual download. readOnly: true desiredTimestamp: @@ -47027,7 +49179,7 @@ components: parameter when `"deliveryType":` `"automated"`. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" targetGroupId: type: string description: Unique 24-hexadecimal digit string that identifies the target @@ -47102,7 +49254,7 @@ components: which MongoDB Cloud took this snapshot. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true snapshotType: type: string @@ -47234,7 +49386,7 @@ components: description: Human-readable label that identifies the serverless instance. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" providerSettings: $ref: "#/components/schemas/ServerlessProviderSettings" serverlessBackupOptions: @@ -47303,7 +49455,7 @@ components: description: Human-readable label that identifies the serverless instance. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" writeOnly: true providerSettings: $ref: "#/components/schemas/ServerlessProviderSettings" @@ -47467,7 +49619,12 @@ components: enum: - AVERAGE operator: - $ref: "#/components/schemas/Operator" + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - LESS_THAN + - GREATER_THAN threshold: type: number format: double @@ -47677,7 +49834,11 @@ components: properties: groupId: type: string - description: Unique 24-hexadecimal digit string that identifies the project. + description: "Unique 24-hexadecimal digit string that identifies your project.\ + \ **NOTE**: Groups and projects are synonymous terms. Your group id is\ + \ the same as your project id. For existing groups, your group/project\ + \ id remains the same. The resource and corresponding endpoints use the\ + \ term groups." example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 @@ -47790,6 +49951,54 @@ components: - eventTypeName - id title: ServiceAccount Events + ServiceAccountIPAccessListEntry: + type: object + properties: + cidrBlock: + type: string + description: "Range of network addresses in the access list for the Service\ + \ Account. This parameter requires the range to be expressed in Classless\ + \ Inter-Domain Routing (CIDR) notation of Internet Protocol version 4\ + \ or version 6 addresses. You can set a value for this parameter or **ipAddress**,\ + \ but not for both in the same request." + example: 203.0.113.0/24 + pattern: "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + createdAt: + type: string + format: date-time + description: Date MongoDB Cloud added the entry was added to the Access + List. + readOnly: true + ipAddress: + type: string + description: "Network address in the access list for the Service Account.\ + \ This parameter requires the address to be expressed as one Internet\ + \ Protocol version 4 or version 6 address. You can set a value for this\ + \ parameter or **cidrBlock**, but not for both in the same request." + example: 203.0.113.10 + pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + 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 makes at least one request. + readOnly: true + lastUsedAt: + type: string + format: date-time + description: "Date when MongoDB Cloud received the most recent request that\ + \ originated from this Internet Protocol version 4 or version 6 address.\ + \ The resource returns this parameter when at least one request originates\ + \ from this IP address. MongoDB Cloud updates this parameter each time\ + \ a client accesses the permitted resource, with a delay of up to 5 minutes." + readOnly: true + requestCount: + type: integer + format: int32 + description: The number of requests that has originated from this network + address. + readOnly: true ServiceAccountOrgEvents: type: object description: Service Account event identifies different activities around user @@ -47903,35 +50112,34 @@ components: createdAt: type: string format: date-time - description: Timestamp representing creation time. + description: The date that the secret was created on. readOnly: true expiresAt: type: string format: date-time - description: Timestamp representing secret expiration time. + description: The date for the expiration of the secret. readOnly: true id: type: string - description: Unique 24-hexadecimal character string that identifies the - secret. + description: Unique 24-hexadecimal digit string that identifies the secret. example: 32b6e34b3d91647abb20e7b8 pattern: "^([a-f0-9]{24})$" readOnly: true lastUsedAt: type: string format: date-time - description: Timestamp representing last secret usage. + description: The last time the secret was used. readOnly: true maskedSecretValue: type: string - description: Service Account secret with masked values of the first 20 characters. + description: The masked Service Account secret. example: mdb_ic_sk_...12ce readOnly: true secret: type: string - description: Secret for the service account. It will be returned only the - first time after service account creation. - pattern: "^mdb_sa_sk_[0-9a-zA-Z]{40}$" + description: The secret for the Service Account. It will be returned only + the first time after creation. + pattern: "^mdb_sa_sk_[0-9a-zA-Z_-]{40}$" readOnly: true required: - createdAt @@ -47943,7 +50151,8 @@ components: secretExpiresAfterHours: type: integer format: int32 - description: Number of hours representing validity duration for secret. + description: The expiration time of the new Service Account secret. The + expiration is provided in hours. required: - secretExpiresAfterHours ShardEntry: @@ -48566,17 +50775,19 @@ components: StreamsDLQ: type: object description: Dead letter queue for the stream processor. + externalDocs: + url: https://www.mongodb.com/docs/atlas/reference/glossary/#std-term-dead-letter-queue properties: coll: type: string - description: Name of the collection that will be used for the DLQ. + description: Name of the collection to use for the DLQ. connectionName: type: string - description: Connection name that will be used to write DLQ messages to. - Has to be an Atlas connection. + description: Name of the connection to write DLQ messages to. Must be an + Atlas connection. db: type: string - description: Name of the database that will be used for the DLQ. + description: Name of the database to use for the DLQ. links: type: array description: "List of one or more Uniform Resource Locators (URLs) that\ @@ -48745,8 +50956,6 @@ components: group.protocol.type: consumer networking: $ref: "#/components/schemas/StreamsKafkaNetworking" - proxyInfo: - $ref: "#/components/schemas/ProxyInfo" security: $ref: "#/components/schemas/StreamsKafkaSecurity" StreamsKafkaNetworking: @@ -48772,6 +50981,13 @@ components: type: object description: Information about the networking access. properties: + connectionId: + type: string + description: Reserved. Will be used by PRIVATE_LINK connection type. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" links: type: array description: "List of one or more Uniform Resource Locators (URLs) that\ @@ -48785,14 +51001,18 @@ components: readOnly: true name: type: string - description: Id of the vpc peer when the type is VPC. + description: Reserved. Will be used by PRIVATE_LINK connection type. type: type: string - description: Selected networking type. Either PUBLIC or VPC. Defaults to - PUBLIC + description: "Selected networking type. Either PUBLIC, VPC or PRIVATE_LINK.\ + \ Defaults to PUBLIC. For VPC, ensure that VPC peering exists and connectivity\ + \ has been established between Atlas VPC and the VPC where Kafka cluster\ + \ is hosted for the connection to function properly. PRIVATE_LINK support\ + \ is coming soon." enum: - PUBLIC - VPC + - PRIVATE_LINK title: Networking Access Type StreamsKafkaSecurity: type: object @@ -48871,6 +51091,52 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true + StreamsPrivateLinkConnection: + type: object + description: Container for metadata needed to create a Private Link connection. + properties: + _id: + type: string + description: The ID of the Private Link connection. + dnsDomain: + type: string + description: Domain name of Confluent cluster. + dnsSubDomain: + type: array + description: Sub-Domain name of Confluent cluster. These are typically your + availability zones. + items: + type: string + interfaceEndpointId: + type: string + description: Interface endpoint ID that is created from the service endpoint + ID provided. + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + provider: + type: string + description: Provider where the Kafka cluster is deployed. + region: + type: string + description: Domain name of Confluent cluster. + serviceEndpointId: + type: string + description: AWS Service Endpoint ID. + state: + type: string + description: State the connection is in. + vendor: + type: string + description: Vendor who manages the Kafka cluster. StreamsProcessor: type: object description: An atlas stream processor. @@ -48904,6 +51170,9 @@ components: type: array description: Stream aggregation pipeline you want to apply to your streaming data. + externalDocs: + description: Supported Aggregation Pipeline Stages + url: https://www.mongodb.com/docs/atlas/atlas-stream-processing/stream-aggregation/#std-label-stream-aggregation items: $ref: "#/components/schemas/Document" StreamsProcessorWithStats: @@ -48934,6 +51203,8 @@ components: type: string description: Human-readable name of the stream processor. readOnly: true + options: + $ref: "#/components/schemas/StreamsOptions" pipeline: type: array description: Stream aggregation pipeline you want to apply to your streaming @@ -48943,15 +51214,20 @@ components: readOnly: true state: type: string - description: The state of the stream processor. + description: "The state of the stream processor. Commonly occurring states\ + \ are 'CREATED', 'STARTED', 'STOPPED' and 'FAILED'." readOnly: true stats: type: object additionalProperties: type: object description: The stats associated with the stream processor. + externalDocs: + url: https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor readOnly: true description: The stats associated with the stream processor. + externalDocs: + url: https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor readOnly: true required: - _id @@ -48962,6 +51238,26 @@ components: type: object allOf: - $ref: "#/components/schemas/StreamsConnection" + StreamsSampleConnections: + type: object + description: Sample connections to add to SPI. + properties: + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + solar: + type: boolean + default: false + description: Flag that indicates whether to add a 'sample_stream_solar' + connection. StreamsTenant: type: object properties: @@ -49013,6 +51309,8 @@ components: name: type: string description: Human-readable label that identifies the stream instance. + sampleConnections: + $ref: "#/components/schemas/StreamsSampleConnections" streamConfig: $ref: "#/components/schemas/StreamConfig" SummaryNotification: @@ -49673,7 +51971,7 @@ components: description: Human-readable label that identifies the source cluster. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true deliveryType: type: string @@ -49783,6 +52081,8 @@ components: required: - snapshotId - targetDeploymentItemName + TenantWithSampleConnections: + type: object TextSearchHostStatusDetail: type: object properties: @@ -49999,808 +52299,199 @@ components: type: array description: List of documents detailing index status on each host. items: - $ref: "#/components/schemas/TextSearchHostStatusDetail" - synonymMappingStatus: - type: string - description: Status that describes this index's synonym mappings. This - status appears only if the index has synonyms defined. - enum: - - FAILED - - BUILDING - - READY - synonymMappingStatusDetail: - type: array - description: A list of documents describing the status of the index's - synonym mappings on each search host. Only appears if the index has - synonyms defined. - items: - type: object - additionalProperties: - $ref: "#/components/schemas/SynonymMappingStatusDetail" - title: Text Search Index Response - TextSearchIndexStatusDetail: - type: object - description: Contains status information about a text search index. - properties: - definition: - $ref: "#/components/schemas/TextSearchIndexDefinition" - definitionVersion: - $ref: "#/components/schemas/SearchIndexDefinitionVersion" - message: - type: string - description: Optional message describing an error. - queryable: - type: boolean - description: Flag that indicates whether the index generation is queryable - on the host. - status: - type: string - description: | - Condition of the search index when you made this request. - - | Status | Index Condition | - |---|---| - | DELETING | The index is being deleted. | - | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. | - | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. | - | PENDING | Atlas has not yet started building the index. | - | BUILDING | Atlas is building or re-building the index after an edit. | - | READY | The index is ready and can support queries. | - enum: - - DELETING - - FAILED - - STALE - - PENDING - - BUILDING - - READY - - DOES_NOT_EXIST - synonymMappingStatus: - type: string - description: Status that describes this index's synonym mappings. This status - appears only if the index has synonyms defined. - enum: - - FAILED - - BUILDING - - READY - synonymMappingStatusDetail: - type: array - description: List of synonym statuses by mapping. - items: - $ref: "#/components/schemas/SynonymMappingStatusDetailMap" - title: Text Search Index Status Detail - ThirdPartyIntegration: - type: object - description: Collection of settings that describe third-party integrations. - discriminator: - mapping: - DATADOG: "#/components/schemas/Datadog" - MICROSOFT_TEAMS: "#/components/schemas/MicrosoftTeams" - NEW_RELIC: "#/components/schemas/NewRelic" - OPS_GENIE: "#/components/schemas/OpsGenie" - PAGER_DUTY: "#/components/schemas/PagerDuty" - PROMETHEUS: "#/components/schemas/Prometheus" - SLACK: "#/components/schemas/Slack" - VICTOR_OPS: "#/components/schemas/VictorOps" - WEBHOOK: "#/components/schemas/Webhook" - propertyName: type - properties: - id: - type: string - description: Integration id. - nullable: true - type: - type: string - description: Integration type - enum: - - PAGER_DUTY - - SLACK - - DATADOG - - NEW_RELIC - - OPS_GENIE - - VICTOR_OPS - - WEBHOOK - - HIP_CHAT - - PROMETHEUS - - MICROSOFT_TEAMS - title: Integration Type - title: Third-Party Integration - TimeMetricAlertView: - type: object - properties: - acknowledgedUntil: - type: string - format: date-time - description: |- - Date and time until which this alert has been acknowledged. This parameter expresses its value in the 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. - acknowledgementComment: - type: string - description: Comment that a MongoDB Cloud user submitted when acknowledging - the alert. - example: Expiration on 3/19. Silencing for 7days. - maxLength: 200 - acknowledgingUsername: - type: string - format: email - description: MongoDB Cloud username of the person who acknowledged the alert. - The response returns this parameter if a MongoDB Cloud user previously - acknowledged this alert. - readOnly: true - alertConfigId: - type: string - description: Unique 24-hexadecimal digit string that identifies the alert - configuration that sets this alert. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - clusterName: - 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." - example: cluster1 - maxLength: 64 - minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - readOnly: true - created: - type: string - format: date-time - description: Date and time when MongoDB Cloud created this alert. This parameter - expresses its value in the ISO 8601 timestamp format - in UTC. - readOnly: true - currentValue: - $ref: "#/components/schemas/TimeMetricValueView" - eventTypeName: - $ref: "#/components/schemas/HostMetricEventTypeViewAlertable" - groupId: - type: string - description: Unique 24-hexadecimal digit string that identifies the project - that owns this alert. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - 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. - example: cloud-test.mongodb.com:27017 - readOnly: true - id: - type: string - description: Unique 24-hexadecimal digit string that identifies this alert. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - lastNotified: - type: string - format: date-time - description: Date and time that any notifications were last sent for this - alert. This parameter expresses its value in the ISO 8601 timestamp format - in UTC. The resource returns this parameter if MongoDB Cloud has sent - notifications for this alert. - readOnly: true - links: - type: array - description: "List of one or more Uniform Resource Locators (URLs) that\ - \ point to API sub-resources, related API resources, or both. RFC 5988\ - \ outlines these relationships." - externalDocs: - description: Web Linking Specification (RFC 5988) - url: https://datatracker.ietf.org/doc/html/rfc5988 - items: - $ref: "#/components/schemas/Link" - readOnly: true - 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. - example: ASSERT_USER - readOnly: true - orgId: - type: string - description: Unique 24-hexadecimal character string that identifies the - organization that owns the project to which this alert applies. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - 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." - example: event-replica-set - readOnly: true - resolved: - type: string - format: date-time - description: "Date and time that this alert changed to `\"status\" : \"\ - CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp\ - \ format in UTC. The resource returns this parameter once `\"status\"\ - \ : \"CLOSED\"`." - readOnly: true - status: - type: string - description: State of this alert at the time you requested its details. - enum: - - CANCELLED - - CLOSED - - OPEN - - TRACKING - example: OPEN - readOnly: true - updated: - type: string - format: date-time - description: Date and time when someone last updated this alert. This parameter - expresses its value in the ISO 8601 timestamp format - in UTC. - readOnly: true - required: - - alertConfigId - - created - - eventTypeName - - id - - status - - updated - TimeMetricEventView: - type: object - properties: - apiKeyId: - type: string - description: "Unique 24-hexadecimal digit string that identifies the [API\ - \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\ - \ triggered the event. If this resource returns this parameter, it doesn't\ - \ return the **userId** parameter." - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - created: - type: string - format: date-time - description: Date and time when this event occurred. This parameter expresses - its value in the ISO 8601 timestamp format in UTC. - readOnly: true - currentValue: - $ref: "#/components/schemas/TimeMetricValueView" - eventTypeName: - $ref: "#/components/schemas/HostMetricEventTypeView" - groupId: - type: string - description: Unique 24-hexadecimal digit string that identifies the project - in which the event occurred. The **eventId** identifies the specific event. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - id: - type: string - description: Unique 24-hexadecimal digit string that identifies the event. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - isGlobalAdmin: - type: boolean - default: false - description: Flag that indicates whether a MongoDB employee triggered the - specified event. - readOnly: true - links: - type: array - description: "List of one or more Uniform Resource Locators (URLs) that\ - \ point to API sub-resources, related API resources, or both. RFC 5988\ - \ outlines these relationships." - externalDocs: - description: Web Linking Specification (RFC 5988) - url: https://datatracker.ietf.org/doc/html/rfc5988 - items: - $ref: "#/components/schemas/Link" - readOnly: true - 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: - type: string - description: Unique 24-hexadecimal digit string that identifies the organization - to which these events apply. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - port: - type: integer - format: int32 - description: IANA port on which the MongoDB process listens for requests. - example: 27017 - readOnly: true - publicKey: - type: string - format: email - description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\ - \ that triggered the event. If this resource returns this parameter, it\ - \ doesn't return the **username** parameter." - example: test.user@mongodb.com - readOnly: true - raw: - $ref: "#/components/schemas/raw" - remoteAddress: - type: string - description: IPv4 or IPv6 address from which the user triggered this event. - example: 216.172.40.186 - pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" - readOnly: true - replicaSetName: - type: string - description: Human-readable label of the replica set associated with the - event. - example: event-replica-set - readOnly: true - shardName: - type: string - description: Human-readable label of the shard associated with the event. - example: event-sh-01 - readOnly: true - userId: - type: string - description: "Unique 24-hexadecimal digit string that identifies the console\ - \ user who triggered the event. If this resource returns this parameter,\ - \ it doesn't return the **apiKeyId** parameter." - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - username: - type: string - format: email - description: "Email address for the user who triggered this event. If this\ - \ resource returns this parameter, it doesn't return the **publicApiKey**\ - \ parameter." - example: test.user@mongodb.com - readOnly: true - required: - - created - - eventTypeName - - id - TimeMetricThresholdView: - 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: - $ref: "#/components/schemas/Operator" - threshold: - type: number - format: double - description: "Value of metric that, when exceeded, triggers an alert." - units: - $ref: "#/components/schemas/TimeMetricUnits" - required: - - metricName - TimeMetricUnits: - type: string - default: HOURS - description: "Element used to express the quantity. This can be an element of\ - \ time, storage capacity, and the like." - enum: - - NANOSECONDS - - MILLISECONDS - - MILLION_MINUTES - - SECONDS - - MINUTES - - HOURS - - DAYS - title: Time Metric Units - TimeMetricValueView: - type: object - description: Measurement of the **metricName** recorded at the time of the event. - properties: - number: - type: number - format: double - description: Amount of the **metricName** recorded at the time of the event. - This value triggered the alert. - readOnly: true - units: - $ref: "#/components/schemas/TimeMetricUnits" - readOnly: true - title: Time Metric Value - TokenFilterEnglishPossessive: - type: object - description: Filter that removes possessives (trailing 's) from words. - properties: - type: - type: string - description: Human-readable label that identifies this token filter type. - enum: - - englishPossessive - required: - - type - title: englishPossessive - TokenFilterFlattenGraph: - type: object - description: "Filter that transforms a token filter graph, such as the token\ - \ filter graph that the wordDelimiterGraph token filter produces, into a flat\ - \ form suitable for indexing." - properties: - type: - type: string - description: Human-readable label that identifies this token filter type. - enum: - - flattenGraph - required: - - type - title: flattenGraph - TokenFilterPorterStemming: + $ref: "#/components/schemas/TextSearchHostStatusDetail" + synonymMappingStatus: + type: string + description: Status that describes this index's synonym mappings. This + status appears only if the index has synonyms defined. + enum: + - FAILED + - BUILDING + - READY + synonymMappingStatusDetail: + type: array + description: A list of documents describing the status of the index's + synonym mappings on each search host. Only appears if the index has + synonyms defined. + items: + type: object + additionalProperties: + $ref: "#/components/schemas/SynonymMappingStatusDetail" + title: Text Search Index Response + TextSearchIndexStatusDetail: type: object - 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. + description: Contains status information about a text search index. properties: - type: + definition: + $ref: "#/components/schemas/TextSearchIndexDefinition" + definitionVersion: + $ref: "#/components/schemas/SearchIndexDefinitionVersion" + message: type: string - description: Human-readable label that identifies this token filter type. - enum: - - porterStemming - required: - - type - title: porterStemming - TokenFilterSpanishPluralStemming: - type: object - description: Filter that stems Spanish plural words. It expects lowercase text. - properties: - type: + description: Optional message describing an error. + queryable: + type: boolean + description: Flag that indicates whether the index generation is queryable + on the host. + status: type: string - description: Human-readable label that identifies this token filter type. + description: | + Condition of the search index when you made this request. + + | Status | Index Condition | + |---|---| + | DELETING | The index is being deleted. | + | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. | + | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. | + | PENDING | Atlas has not yet started building the index. | + | BUILDING | Atlas is building or re-building the index after an edit. | + | READY | The index is ready and can support queries. | enum: - - spanishPluralStemming - required: - - type - title: spanishPluralStemming - TokenFilterStempel: - type: object - description: Filter that uses Lucene's default Polish stemmer table to stem - words in the Polish language. It expects lowercase text. - externalDocs: - description: Default Polish stemmer table - url: https://lucene.apache.org/core/9_2_0/analysis/stempel/org/apache/lucene/analysis/pl/PolishAnalyzer.html#DEFAULT_STEMMER_FILE - properties: - type: + - DELETING + - FAILED + - STALE + - PENDING + - BUILDING + - READY + - DOES_NOT_EXIST + synonymMappingStatus: type: string - description: Human-readable label that identifies this token filter type. + description: Status that describes this index's synonym mappings. This status + appears only if the index has synonyms defined. enum: - - stempel - required: - - type - title: stempel - TokenFilterWordDelimiterGraph: + - FAILED + - BUILDING + - READY + synonymMappingStatusDetail: + type: array + description: List of synonym statuses by mapping. + items: + $ref: "#/components/schemas/SynonymMappingStatusDetailMap" + title: Text Search Index Status Detail + ThirdPartyIntegration: type: object - description: Filter that splits tokens into sub-tokens based on configured rules. + description: Collection of settings that describe third-party integrations. + discriminator: + mapping: + DATADOG: "#/components/schemas/Datadog" + MICROSOFT_TEAMS: "#/components/schemas/MicrosoftTeams" + NEW_RELIC: "#/components/schemas/NewRelic" + OPS_GENIE: "#/components/schemas/OpsGenie" + PAGER_DUTY: "#/components/schemas/PagerDuty" + PROMETHEUS: "#/components/schemas/Prometheus" + SLACK: "#/components/schemas/Slack" + VICTOR_OPS: "#/components/schemas/VictorOps" + WEBHOOK: "#/components/schemas/Webhook" + propertyName: type properties: - delimiterOptions: - type: object - description: Object that contains the rules that determine how to split - words into sub-words. - properties: - concatenateAll: - type: boolean - default: false - description: Flag that indicates whether to concatenate runs. - concatenateNumbers: - type: boolean - default: false - description: Flag that indicates whether to concatenate runs of sub-numbers. - concatenateWords: - type: boolean - default: false - description: Flag that indicates whether to concatenate runs of sub-words. - generateNumberParts: - type: boolean - default: true - description: "Flag that indicates whether to split tokens based on sub-numbers.\ - \ For example, if `true`, this option splits `100-2` into `100` and\ - \ `2`." - generateWordParts: - type: boolean - default: true - description: Flag that indicates whether to split tokens based on sub-words. - ignoreKeywords: - type: boolean - default: false - description: Flag that indicates whether to skip tokens with the `keyword` - attribute set to `true` - preserveOriginal: - type: boolean - default: true - description: Flag that indicates whether to generate tokens of the original - words. - splitOnCaseChange: - type: boolean - default: true - description: Flag that indicates whether to split tokens based on letter-case - transitions. - splitOnNumerics: - type: boolean - default: true - description: Flag that indicates whether to split tokens based on letter-number - transitions. - stemEnglishPossessive: - type: boolean - default: true - description: Flag that indicates whether to remove trailing possessives - from each sub-word. - protectedWords: - type: object - description: Object that contains options for protected words. - properties: - ignoreCase: - type: boolean - default: true - description: Flag that indicates whether to ignore letter case sensitivity - for protected words. - words: - type: array - description: List that contains the tokens to protect from delimination. - items: - type: string - required: - - words - type: + id: type: string - description: Human-readable label that identifies this token filter type. - enum: - - wordDelimiterGraph - required: - - type - title: wordDelimiterGraph - TokenFilterkStemming: - type: object - description: Filter that combines algorithmic stemming with a built-in dictionary - for the English language to stem words. - properties: + description: Integration id. + nullable: true type: type: string - description: Human-readable label that identifies this token filter type. + description: Integration type enum: - - kStemming - required: - - type - title: kStemming - TriggerIngestionPipelineRequest: - type: object - properties: - datasetRetentionPolicy: - $ref: "#/components/schemas/DatasetRetentionPolicy" - snapshotId: - type: string - description: Unique 24-hexadecimal character string that identifies the - snapshot. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - writeOnly: true - required: - - snapshotId - USSBackupRestoreJob20250101: + - PAGER_DUTY + - SLACK + - DATADOG + - NEW_RELIC + - OPS_GENIE + - VICTOR_OPS + - WEBHOOK + - HIP_CHAT + - PROMETHEUS + - MICROSOFT_TEAMS + title: Integration Type + title: Third-Party Integration + TimeMetricAlertView: type: object - description: Details for one restore job of a USS instance. properties: - deliveryType: - type: string - description: Means by which this resource returns the snapshot to the requesting - MongoDB Cloud user. - enum: - - RESTORE - - DOWNLOAD - readOnly: true - expirationDate: - type: string - format: date-time - description: Date and time when the download link no longer works. This - parameter expresses its value in the ISO 8601 timestamp format in UTC. - readOnly: true - id: - type: string - description: Unique 24-hexadecimal digit string that identifies the restore - job. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - instanceName: - type: string - description: Human-readable label that identifies the source instance. - maxLength: 64 - minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - readOnly: true - links: - type: array - description: "List of one or more Uniform Resource Locators (URLs) that\ - \ point to API sub-resources, related API resources, or both. RFC 5988\ - \ outlines these relationships." - externalDocs: - description: Web Linking Specification (RFC 5988) - url: https://datatracker.ietf.org/doc/html/rfc5988 - items: - $ref: "#/components/schemas/Link" - readOnly: true - projectId: - type: string - description: Unique 24-hexadecimal digit string that identifies the project - from which the restore job originated. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - restoreFinishedDate: + acknowledgedUntil: type: string format: date-time - 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. - readOnly: true - restoreScheduledDate: + 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. + acknowledgementComment: type: string - format: date-time - description: Date and time when MongoDB Cloud will restore this snapshot. - This parameter expresses its value in the ISO 8601 timestamp format in - UTC. - readOnly: true - snapshotFinishedDate: + description: Comment that a MongoDB Cloud user submitted when acknowledging + the alert. + example: Expiration on 3/19. Silencing for 7days. + maxLength: 200 + acknowledgingUsername: type: string - format: date-time - description: Date and time when MongoDB Cloud completed writing this snapshot. - This parameter expresses its value in the ISO 8601 timestamp format in - UTC. + format: email + description: MongoDB Cloud username of the person who acknowledged the alert. + The response returns this parameter if a MongoDB Cloud user previously + acknowledged this alert. readOnly: true - snapshotId: + alertConfigId: type: string - description: Unique 24-hexadecimal digit string that identifies the snapshot - to restore. + description: Unique 24-hexadecimal digit string that identifies the alert + configuration that sets this alert. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true - 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. - enum: - - PENDING - - QUEUED - - RUNNING - - FAILED - - COMPLETED - readOnly: true - targetDeploymentItemName: + clusterName: type: string - description: Human-readable label that identifies the instance or cluster - on the target project to which you want to restore the snapshot. You can - restore the snapshot to another USS instance or Dedicated cluster tier. + description: "Human-readable label that identifies the cluster to which\ + \ this alert applies. This resource returns this parameter for alerts\ + \ of events impacting backups, replica sets, or sharded clusters." + example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true - targetProjectId: + created: type: string - description: Unique 24-hexadecimal digit string that identifies the project - that contains the instance or cluster to which you want to restore the - snapshot. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" + format: date-time + description: Date and time when MongoDB Cloud created this alert. This parameter + expresses its value in the ISO 8601 timestamp format + in UTC. readOnly: true - title: USS Backup Restore Job - USSBackupRestoreJobCreate20250101: - type: object - description: Details to create one restore job of a USS instance. - properties: - _snapshotId: - type: string - description: Unique 24-hexadecimal digit string that identifies the snapshot - to restore. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - writeOnly: true - _targetDeploymentItemName: - type: string - description: Human-readable label that identifies the instance or cluster - on the target project to which you want to restore the snapshot. You can - restore the snapshot to another USS instance or Dedicated cluster tier. - maxLength: 64 - minLength: 1 - pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" - writeOnly: true - _targetProjectId: + currentValue: + $ref: "#/components/schemas/TimeMetricValueView" + eventTypeName: + $ref: "#/components/schemas/HostMetricEventTypeViewAlertable" + groupId: type: string description: Unique 24-hexadecimal digit string that identifies the project - that contains the instance or cluster to which you want to restore the - snapshot. + that owns this alert. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" - writeOnly: true - deliveryType: - type: string - description: Means by which this resource returns the snapshot to the requesting - MongoDB Cloud user. - enum: - - RESTORE - - DOWNLOAD readOnly: true - expirationDate: + hostnameAndPort: type: string - format: date-time - description: Date and time when the download link no longer works. This - parameter expresses its value in the ISO 8601 timestamp format in UTC. + description: Hostname and port of the host to which this alert applies. + The resource returns this parameter for alerts of events impacting hosts + or replica sets. + example: cloud-test.mongodb.com:27017 readOnly: true id: type: string - description: Unique 24-hexadecimal digit string that identifies the restore - job. + description: Unique 24-hexadecimal digit string that identifies this alert. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true - instanceName: + lastNotified: type: string - description: Human-readable label that identifies the source instance. - maxLength: 64 - minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + format: date-time + 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. readOnly: true links: type: array @@ -50813,94 +52504,114 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true - projectId: + metricName: type: string - description: Unique 24-hexadecimal digit string that identifies the project - from which the restore job originated. + 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. + example: ASSERT_USER + readOnly: true + orgId: + type: string + description: Unique 24-hexadecimal character string that identifies the + organization that owns the project to which this alert applies. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true - restoreFinishedDate: - type: string - format: date-time - 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. - readOnly: true - restoreScheduledDate: + replicaSetName: type: string - format: date-time - description: Date and time when MongoDB Cloud will restore this snapshot. - This parameter expresses its value in the ISO 8601 timestamp format in - UTC. + description: "Name of the replica set to which this alert applies. The response\ + \ returns this parameter for alerts of events impacting backups, hosts,\ + \ or replica sets." + example: event-replica-set readOnly: true - snapshotFinishedDate: + resolved: type: string format: date-time - description: Date and time when MongoDB Cloud completed writing this snapshot. - This parameter expresses its value in the ISO 8601 timestamp format in - UTC. - readOnly: true - snapshotUrl: - type: string - description: "Internet address from which you can download the compressed\ - \ snapshot files. The resource returns this parameter when `\"deliveryType\"\ - \ : \"DOWNLOAD\"`." + 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\"`." readOnly: true status: type: string - description: Phase of the restore workflow for this job at the time this - resource made this request. + description: State of this alert at the time you requested its details. enum: - - PENDING - - QUEUED - - RUNNING - - FAILED - - COMPLETED + - CANCELLED + - CLOSED + - OPEN + - TRACKING + example: OPEN + readOnly: true + updated: + type: string + format: date-time + description: Date and time when someone last updated this alert. This parameter + expresses its value in the ISO 8601 timestamp format + in UTC. readOnly: true required: - - _snapshotId - - _targetDeploymentItemName - title: Create USS Backup Restore Job - USSBackupSettings20250101: + - alertConfigId + - created + - eventTypeName + - id + - status + - updated + TimeMetricEventView: type: object - description: USS backup configuration properties: - enabled: - type: boolean - default: true - description: "Flag that indicates whether backups are performed for this\ - \ USS instance. Backup uses [TODO](TODO) for USS instances." + apiKeyId: + type: string + description: "Unique 24-hexadecimal digit string that identifies the [API\ + \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\ + \ triggered the event. If this resource returns this parameter, it doesn't\ + \ return the **userId** parameter." + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" readOnly: true - readOnly: true - title: USS backup configuration - USSBackupSnapshot20250101: - type: object - description: Details for one snapshot of a USS instance. - properties: - expiration: + created: type: string format: date-time - description: Date and time when the download link no longer works. This - parameter expresses its value in the ISO 8601 timestamp format in UTC. + description: Date and time when this event occurred. This parameter expresses + its value in the ISO 8601 timestamp format in UTC. readOnly: true - finishTime: + currentValue: + $ref: "#/components/schemas/TimeMetricValueView" + eventTypeName: + $ref: "#/components/schemas/HostMetricEventTypeView" + groupId: type: string - format: date-time - description: Date and time when MongoDB Cloud completed writing this snapshot. - This parameter expresses its value in the ISO 8601 timestamp format in - UTC. + description: Unique 24-hexadecimal digit string that identifies the project + in which the event occurred. The **eventId** identifies the specific event. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" readOnly: true id: type: string - description: Unique 24-hexadecimal digit string that identifies the snapshot. + description: Unique 24-hexadecimal digit string that identifies the event. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true + isGlobalAdmin: + type: boolean + default: false + description: Flag that indicates whether a MongoDB employee triggered the + specified event. + readOnly: true links: type: array description: "List of one or more Uniform Resource Locators (URLs) that\ @@ -50912,307 +52623,307 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true - mongoDBVersion: - type: string - description: MongoDB host version that the snapshot runs. - readOnly: true - scheduledTime: - type: string - format: date-time - description: Date and time when MongoDB Cloud will take the snapshot. This - parameter expresses its value in the ISO 8601 timestamp format in UTC. - readOnly: true - startTime: - type: string - format: date-time - description: Date and time when MongoDB Cloud began taking the snapshot. - This parameter expresses its value in the ISO 8601 timestamp format in - UTC. - readOnly: true - status: + metricName: type: string - description: Phase of the workflow for this snapshot at the time this resource - made this request. - enum: - - PENDING - - QUEUED - - RUNNING - - FAILED - - COMPLETED + description: Human-readable label of the metric associated with the **alertId**. + This field may change type of **currentValue** field. readOnly: true - title: USS Backup Snapshot - USSBackupSnapshotDownloadCreate20250101: - type: object - description: Details for one backup snapshot download of a USS instance. - properties: - _snapshotId: + orgId: type: string - description: Unique 24-hexadecimal digit string that identifies the snapshot - to download. + description: Unique 24-hexadecimal digit string that identifies the organization + to which these events apply. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" - writeOnly: true - links: - type: array - description: "List of one or more Uniform Resource Locators (URLs) that\ - \ point to API sub-resources, related API resources, or both. RFC 5988\ - \ outlines these relationships." - externalDocs: - description: Web Linking Specification (RFC 5988) - url: https://datatracker.ietf.org/doc/html/rfc5988 - items: - $ref: "#/components/schemas/Link" readOnly: true - required: - - _snapshotId - title: USS Backup Snapshot Download Create - USSConnectionStrings20250101: - type: object - description: Collection of Uniform Resource Locators that point to the MongoDB - database. - externalDocs: - description: Connection string URI format. - url: https://docs.mongodb.com/manual/reference/connection-string/ - properties: - standard: - type: string - description: Public connection string that you can use to connect to this - cluster. This connection string uses the mongodb:// protocol. - externalDocs: - description: Connection String URI Format - url: https://docs.mongodb.com/manual/reference/connection-string/ + port: + type: integer + format: int32 + description: IANA port on which the MongoDB process listens for requests. + example: 27017 readOnly: true - standardSrv: + publicKey: type: string - description: Public connection string that you can use to connect to this - USS instance. This connection string uses the `mongodb+srv://` protocol. - externalDocs: - description: Connection String URI Format - url: https://docs.mongodb.com/manual/reference/connection-string/ + format: email + description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\ + \ that triggered the event. If this resource returns this parameter, it\ + \ doesn't return the **username** parameter." + example: test.user@mongodb.com readOnly: true - readOnly: true - title: USS Instance Connection Strings - USSInstanceDescription20250101: - type: object - description: Group of settings that configure a MongoDB USS instance. - properties: - backupSettings: - $ref: "#/components/schemas/USSBackupSettings20250101" - clusterType: + raw: + $ref: "#/components/schemas/raw" + remoteAddress: type: string - description: USS instance topology. - enum: - - REPLICASET - - LOADBALANCED + description: IPv4 or IPv6 address from which the user triggered this event. + example: 216.172.40.186 + pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" readOnly: true - connectionStrings: - $ref: "#/components/schemas/USSConnectionStrings20250101" - createDate: + replicaSetName: type: string - format: date-time - description: Date and time when MongoDB Cloud created this instance. This - parameter expresses its value in ISO 8601 format in UTC. + description: Human-readable label of the replica set associated with the + event. + example: event-replica-set readOnly: true - groupId: + shardName: type: string - description: Unique 24-hexadecimal character string that identifies the - project. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" + description: Human-readable label of the shard associated with the event. + example: event-sh-01 readOnly: true - id: + userId: type: string - description: Unique 24-hexadecimal digit string that identifies the instance. + description: "Unique 24-hexadecimal digit string that identifies the console\ + \ user who triggered the event. If this resource returns this parameter,\ + \ it doesn't return the **apiKeyId** parameter." example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true - links: - type: array - description: "List of one or more Uniform Resource Locators (URLs) that\ - \ point to API sub-resources, related API resources, or both. RFC 5988\ - \ outlines these relationships." - externalDocs: - description: Web Linking Specification (RFC 5988) - url: https://datatracker.ietf.org/doc/html/rfc5988 - items: - $ref: "#/components/schemas/Link" - readOnly: true - mongoDBVersion: + username: type: string - description: Version of MongoDB that the instance runs. - pattern: "([\\d]+\\.[\\d]+\\.[\\d]+)" + format: email + description: "Email address for the user who triggered this event. If this\ + \ resource returns this parameter, it doesn't return the **publicApiKey**\ + \ parameter." + example: test.user@mongodb.com readOnly: true - name: + required: + - created + - eventTypeName + - id + TimeMetricThresholdView: + type: object + properties: + metricName: type: string - description: Human-readable label that identifies the instance. - maxLength: 64 - minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - readOnly: true - providerSettings: - $ref: "#/components/schemas/USSProviderSettings20250101" - stateName: + description: Human-readable label that identifies the metric against which + MongoDB Cloud checks the configured **metricThreshold.threshold**. + mode: type: string - description: Human-readable label that indicates the current operating condition - of this instance. + description: MongoDB Cloud computes the current metric value as an average. enum: - - IDLE - - CREATING - - UPDATING - - DELETING - - REPAIRING - readOnly: true - tags: - type: array - description: List that contains key-value pairs between 1 to 255 characters - in length for tagging and categorizing the instance. - externalDocs: - description: Resource Tags - url: https://dochub.mongodb.org/core/add-cluster-tag-atlas - items: - $ref: "#/components/schemas/ResourceTag" - terminationProtectionEnabled: - type: boolean - default: false - description: "Flag that indicates whether termination protection is enabled\ - \ on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster.\ - \ If set to `false`, MongoDB Cloud will delete the cluster." - versionReleaseSystem: + - AVERAGE + operator: type: string - default: LTS - description: Method by which the cluster maintains the MongoDB versions. + description: Comparison operator to apply when checking the current metric + value. enum: - - LTS - readOnly: true + - LESS_THAN + - GREATER_THAN + threshold: + type: number + format: double + description: "Value of metric that, when exceeded, triggers an alert." + units: + $ref: "#/components/schemas/TimeMetricUnits" required: - - providerSettings - title: USS Instance Description - USSInstanceDescriptionCreate20250101: + - metricName + TimeMetricUnits: + type: string + default: HOURS + description: "Element used to express the quantity. This can be an element of\ + \ time, storage capacity, and the like." + enum: + - NANOSECONDS + - MILLISECONDS + - MILLION_MINUTES + - SECONDS + - MINUTES + - HOURS + - DAYS + title: Time Metric Units + TimeMetricValueView: type: object - description: Settings that you can specify when you create a USS instance. + description: Measurement of the **metricName** recorded at the time of the event. properties: - links: - type: array - description: "List of one or more Uniform Resource Locators (URLs) that\ - \ point to API sub-resources, related API resources, or both. RFC 5988\ - \ outlines these relationships." - externalDocs: - description: Web Linking Specification (RFC 5988) - url: https://datatracker.ietf.org/doc/html/rfc5988 - items: - $ref: "#/components/schemas/Link" + number: + type: number + format: double + description: Amount of the **metricName** recorded at the time of the event. + This value triggered the alert. readOnly: true - name: + units: + $ref: "#/components/schemas/TimeMetricUnits" + readOnly: true + title: Time Metric Value + TokenFilterEnglishPossessive: + type: object + description: Filter that removes possessives (trailing 's) from words. + properties: + type: type: string - description: Human-readable label that identifies the instance. - maxLength: 64 - minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - writeOnly: true - providerSettings: - $ref: "#/components/schemas/USSProviderSettingsCreate20250101" - tags: - type: array - description: List that contains key-value pairs between 1 to 255 characters - in length for tagging and categorizing the instance. - externalDocs: - description: Resource Tags - url: https://dochub.mongodb.org/core/add-cluster-tag-atlas - items: - $ref: "#/components/schemas/ResourceTag" - terminationProtectionEnabled: - type: boolean - default: false - description: "Flag that indicates whether termination protection is enabled\ - \ on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster.\ - \ If set to `false`, MongoDB Cloud will delete the cluster." + description: Human-readable label that identifies this token filter type. + enum: + - englishPossessive required: - - name - - providerSettings - title: USS Instance Description Create - USSProviderSettings20250101: + - type + title: englishPossessive + TokenFilterFlattenGraph: type: object - description: Group of cloud provider settings that configure the provisioned - MongoDB USS instance. + description: "Filter that transforms a token filter graph, such as the token\ + \ filter graph that the wordDelimiterGraph token filter produces, into a flat\ + \ form suitable for indexing." properties: - backingProviderName: + type: type: string - description: Cloud service provider on which MongoDB Cloud provisioned the - USS instance. + description: Human-readable label that identifies this token filter type. enum: - - AWS - - AZURE - - GCP - readOnly: true - diskSizeGB: - type: number - format: double - description: Storage capacity available to the USS instance expressed in - gigabytes. - readOnly: true - providerName: + - flattenGraph + required: + - type + title: flattenGraph + TokenFilterPorterStemming: + type: object + description: Filter that uses the porter stemming algorithm to remove the common + morphological and inflectional suffixes from words in English. It expects + lowercase text and doesn't work as expected for uppercase text. + properties: + type: type: string - default: USS - description: Human-readable label that identifies the cloud service provider. + description: Human-readable label that identifies this token filter type. enum: - - USS - readOnly: true - regionName: + - porterStemming + required: + - type + title: porterStemming + TokenFilterSpanishPluralStemming: + type: object + description: Filter that stems Spanish plural words. It expects lowercase text. + properties: + type: type: string - description: "Human-readable label that identifies the geographic location\ - \ of your MongoDB USS 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/)." - readOnly: true - readOnly: true - title: Cloud Service Provider Settings for a USS Instance - USSProviderSettingsCreate20250101: + description: Human-readable label that identifies this token filter type. + enum: + - spanishPluralStemming + required: + - type + title: spanishPluralStemming + TokenFilterStempel: type: object - description: Group of cloud provider settings that configure the provisioned - MongoDB USS instance. + description: Filter that uses Lucene's default Polish stemmer table to stem + words in the Polish language. It expects lowercase text. + externalDocs: + description: Default Polish stemmer table + url: https://lucene.apache.org/core/9_2_0/analysis/stempel/org/apache/lucene/analysis/pl/PolishAnalyzer.html#DEFAULT_STEMMER_FILE properties: - backingProviderName: + type: type: string - description: Cloud service provider on which MongoDB Cloud provisioned the - serverless instance. + description: Human-readable label that identifies this token filter type. enum: - - AWS - - AZURE - - GCP - writeOnly: true - diskSizeGB: - type: number - format: double - description: Storage capacity available to the USS instance expressed in - gigabytes. - readOnly: true - providerName: + - stempel + required: + - type + title: stempel + TokenFilterWordDelimiterGraph: + type: object + description: Filter that splits tokens into sub-tokens based on configured rules. + properties: + delimiterOptions: + type: object + description: Object that contains the rules that determine how to split + words into sub-words. + properties: + concatenateAll: + type: boolean + default: false + description: Flag that indicates whether to concatenate runs. + concatenateNumbers: + type: boolean + default: false + description: Flag that indicates whether to concatenate runs of sub-numbers. + concatenateWords: + type: boolean + default: false + description: Flag that indicates whether to concatenate runs of sub-words. + generateNumberParts: + type: boolean + default: true + description: "Flag that indicates whether to split tokens based on sub-numbers.\ + \ For example, if `true`, this option splits `100-2` into `100` and\ + \ `2`." + generateWordParts: + type: boolean + default: true + description: Flag that indicates whether to split tokens based on sub-words. + ignoreKeywords: + type: boolean + default: false + description: Flag that indicates whether to skip tokens with the `keyword` + attribute set to `true` + preserveOriginal: + type: boolean + default: true + description: Flag that indicates whether to generate tokens of the original + words. + splitOnCaseChange: + type: boolean + default: true + description: Flag that indicates whether to split tokens based on letter-case + transitions. + splitOnNumerics: + type: boolean + default: true + description: Flag that indicates whether to split tokens based on letter-number + transitions. + stemEnglishPossessive: + type: boolean + default: true + description: Flag that indicates whether to remove trailing possessives + from each sub-word. + protectedWords: + type: object + description: Object that contains options for protected words. + properties: + ignoreCase: + type: boolean + default: true + description: Flag that indicates whether to ignore letter case sensitivity + for protected words. + words: + type: array + description: List that contains the tokens to protect from delimination. + items: + type: string + required: + - words + type: type: string - default: USS - description: Human-readable label that identifies the cloud service provider. + description: Human-readable label that identifies this token filter type. enum: - - USS - readOnly: true - regionName: + - wordDelimiterGraph + required: + - type + title: wordDelimiterGraph + TokenFilterkStemming: + type: object + description: Filter that combines algorithmic stemming with a built-in dictionary + for the English language to stem words. + properties: + type: type: string - description: "Human-readable label that identifies the geographic location\ - \ of your MongoDB USS 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/)." + description: Human-readable label that identifies this token filter type. + enum: + - kStemming + required: + - type + title: kStemming + TriggerIngestionPipelineRequest: + type: object + properties: + datasetRetentionPolicy: + $ref: "#/components/schemas/DatasetRetentionPolicy" + snapshotId: + type: string + description: Unique 24-hexadecimal character string that identifies the + snapshot. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" writeOnly: true required: - - backingProviderName - - regionName - title: Cloud Service Provider Settings for a USS Instance - writeOnly: true + - snapshotId UpdateAtlasOrganizationApiKey: type: object properties: @@ -51927,7 +53638,7 @@ components: Atlas Data Lake that this database user can access. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" type: type: string description: Category of resource that this database user can access. @@ -51986,6 +53697,28 @@ components: required: - match title: User to Distinguished Name Mapping + VPCPeeringActionChallenge: + type: object + description: Container for elements used to challenge the user before taking + certain actions on VPC Peering connections. + properties: + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + requesterAccountId: + type: string + description: The AWS requester account ID. + requesterVpcId: + type: string + description: The AWS requester VPC ID. VectorSearchHostStatusDetail: type: object properties: diff --git a/tools/cli/test/data/split/dev/openapi-v2-2024-05-30.json b/tools/cli/test/data/split/dev/openapi-v2-2024-05-30.json index f8422bfd44..ea7bb74152 100644 --- a/tools/cli/test/data/split/dev/openapi-v2-2024-05-30.json +++ b/tools/cli/test/data/split/dev/openapi-v2-2024-05-30.json @@ -1,7 +1,7 @@ { "openapi" : "3.0.1", "info" : { - "description" : "The MongoDB Atlas Administration API allows developers to manage all components in MongoDB Atlas.\n\nThe Atlas Administration API uses HTTP Digest Authentication to authenticate requests. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request. For example, to [return database access history](#tag/Access-Tracking/operation/listAccessLogsByClusterName) with [cURL](https://en.wikipedia.org/wiki/CURL), run the following command in the terminal:\n\n```\ncurl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true\"\n```\n\nTo learn more, see [Get Started with the Atlas Administration API](https://www.mongodb.com/docs/atlas/configure-api-access/). For support, see [MongoDB Support](https://www.mongodb.com/support/get-started).", + "description" : "The MongoDB Atlas Administration API allows developers to manage all components in MongoDB Atlas.\n\nThe Atlas Administration API uses HTTP Digest Authentication to authenticate requests. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request. For example, to [return database access history](#tag/Access-Tracking/operation/listAccessLogsByClusterName) with [cURL](https://en.wikipedia.org/wiki/CURL), run the following command in the terminal:\n\n```\ncurl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-05-30+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true\"\n```\n\nTo learn more, see [Get Started with the Atlas Administration API](https://www.mongodb.com/docs/atlas/configure-api-access/). For support, see [MongoDB Support](https://www.mongodb.com/support/get-started).\n\nYou can also explore the various endpoints available through the Atlas Administration API in MongoDB's [Postman workspace](https://www.postman.com/mongodb-devrel/workspace/mongodb-atlas-administration-apis/).", "license" : { "name" : "CC BY-NC-SA 3.0 US", "url" : "https://creativecommons.org/licenses/by-nc-sa/3.0/us/" @@ -9,7 +9,7 @@ "termsOfService" : "https://www.mongodb.com/mongodb-management-service-terms-and-conditions", "title" : "MongoDB Atlas Administration API", "version" : "2.0", - "x-xgen-sha" : "09d9d18db2111c955a8e01702a27ca2763417782" + "x-xgen-sha" : "e6ba3136dbd0be2a81dd4ed21b9e6c470edd4420" }, "servers" : [ { "url" : "https://cloud.mongodb.com" @@ -57,7 +57,11 @@ "description" : "Returns, adds, edits, and removes Federated Database Instances. This resource requires your project ID. Changes to federated database instance configurations can affect costs.", "name" : "Data Federation" }, { - "description" : "Returns, adds, edits, and removes Atlas Data Lake Pipelines and associated runs.", + "description" : "Returns, edits, and removes Atlas Data Lake Pipelines and associated runs.", + "externalDocs" : { + "description" : "Data Lake Pipelines are deprecated. Please see Data Lake Deprecation Guide.", + "url" : "https://dochub.mongodb.org/core/data-lake-deprecation" + }, "name" : "Data Lake Pipelines" }, { "description" : "Returns, adds, edits, and removes database users.", @@ -119,6 +123,9 @@ }, { "description" : "You can continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket. Atlas exports logs every 5 minutes.", "name" : "Push-Based Log Export" + }, { + "description" : "Configure and manage Atlas Resource Policies within your organization.", + "name" : "Resource Policies" }, { "description" : "Creates one index to a database deployment in a rolling manner. You can't create a rolling index on an `M0` free cluster or `M2/M5` shared cluster.", "name" : "Rolling Index" @@ -135,6 +142,13 @@ "url" : "https://dochub.mongodb.org/core/serverless-private-endpoint" }, "name" : "Serverless Private Endpoints" + }, { + "description" : "Endpoints for managing Service Accounts and secrets. Service Accounts are used for programmatic access to the Atlas Admin API through the OAuth 2.0 Client Credentials flow. This feature is available as a Preview feature.", + "externalDocs" : { + "description" : "Get Started with the Atlas Administration API", + "url" : "https://www.mongodb.com/docs/atlas/configure-api-access/" + }, + "name" : "Service Accounts" }, { "description" : "Returns and adds restore jobs for shared-tier database deployments.", "name" : "Shared-Tier Restore Jobs" @@ -2866,7 +2880,7 @@ }, "/api/atlas/v2/groups/{groupId}/backup/exportBuckets" : { "get" : { - "description" : "Returns all AWS S3 buckets and Azure Blob Storage Containers associated with the specified Project. To use this resource, the requesting API Key must have the Project Read Only role. Deprecated versions: v2-{2023-01-01}", + "description" : "Returns all Export Buckets associated with the specified Project. To use this resource, the requesting API Key must have the Project Read Only role. Deprecated versions: v2-{2023-01-01}", "operationId" : "listExportBuckets", "parameters" : [ { "$ref" : "#/components/parameters/envelope" @@ -2903,11 +2917,11 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Return All AWS S3 Buckets and Azure Blob Storage Containers Used for Cloud Backup Snapshot Exports", + "summary" : "Return All Snapshot Export Buckets", "tags" : [ "Cloud Backups" ] }, "post" : { - "description" : "Grants MongoDB Cloud access to the specified AWS S3 Bucket or Azure Blob Storage Container. This enables this Export Bucket to receive Atlas Cloud Backup Snapshots. To use this resource, the requesting API Key must have the Project Owner role. Deprecated versions: v2-{2023-01-01}", + "description" : "Creates a Snapshot Export Bucket for an AWS S3 Bucket or Azure Blob Storage Container. Once created, an snapshots can be exported to the Export Bucket and its referenced AWS S3 Bucket or Azure Blob Storage Container. To use this resource, the requesting API Key must have the Project Owner role. Deprecated versions: v2-{2023-01-01}", "operationId" : "createExportBucket", "parameters" : [ { "$ref" : "#/components/parameters/envelope" @@ -2945,7 +2959,7 @@ "x-xgen-version" : "2024-05-30" } }, - "description" : "Grants MongoDB Cloud access to the specified AWS S3 Bucket or Azure Blob Storage Container.", + "description" : "Specifies the role and AWS S3 Bucket or Azure Blob Storage Container that the Export Bucket should reference.", "required" : true }, "responses" : { @@ -3006,20 +3020,20 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Grant Access to AWS S3 Bucket or Azure Blob Storage Container for Cloud Backup Snapshot Exports", + "summary" : "Create One Snapshot Export Bucket", "tags" : [ "Cloud Backups" ] } }, "/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}" : { "delete" : { - "description" : "Revoke MongoDB Cloud access to the specified AWS S3 Bucket or Azure Blob Storage Container. This prevents this Export Bucket from receiving Atlas Cloud Backup Snapshots. 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 API Key must have the Project Owner role.", + "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 API Key must have the Project Owner role.", "operationId" : "deleteExportBucket", "parameters" : [ { "$ref" : "#/components/parameters/envelope" }, { "$ref" : "#/components/parameters/groupId" }, { - "description" : "Unique string that identifies the AWS S3 Bucket or Azure Blob Storage Container to which you export your Snapshots.", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", "in" : "path", "name" : "exportBucketId", "required" : true, @@ -3059,11 +3073,11 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Revoke Access to AWS S3 Bucket or Azure Blob Storage Container for Cloud Backup Snapshot Exports", + "summary" : "Delete One Snapshot Export Bucket", "tags" : [ "Cloud Backups" ] }, "get" : { - "description" : "Returns one AWS S3 Bucket or Azure Blob Storage Container associated with the specified Project. To use this resource, the requesting API Key must have the Project Read Only role. Deprecated versions: v2-{2023-01-01}", + "description" : "Returns one Export Bucket associated with the specified Project. To use this resource, the requesting API Key must have the Project Read Only role. Deprecated versions: v2-{2023-01-01}", "operationId" : "getExportBucket", "parameters" : [ { "$ref" : "#/components/parameters/envelope" @@ -3137,7 +3151,7 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Return One AWS S3 Bucket or Azure Blob Storage Container Used for Cloud Backup Snapshot Exports", + "summary" : "Return One Snapshot Export Bucket", "tags" : [ "Cloud Backups" ] } }, @@ -3296,7 +3310,7 @@ "content" : { "application/vnd.atlas.2023-01-01+json" : { "schema" : { - "$ref" : "#/components/schemas/CloudProviderAccessRole" + "$ref" : "#/components/schemas/CloudProviderAccessRoleRequest" } } }, @@ -3346,7 +3360,7 @@ "required" : true, "schema" : { "type" : "string", - "enum" : [ "AWS" ] + "enum" : [ "AWS", "AZURE", "GCP" ] } }, { "description" : "Unique 24-hexadecimal digit string that identifies the role.", @@ -3434,7 +3448,7 @@ "tags" : [ "Cloud Provider Access" ] }, "patch" : { - "description" : "Grants access to the specified project for the specified access role. To use this resource, the requesting API Key must have the Project Owner role. This API endpoint is one step in a procedure to create unified access for MongoDB Cloud services.", + "description" : "Grants access to the specified project for the specified access role. To use this resource, the requesting API Key must have the Project Owner role. This API endpoint is one step in a procedure to create unified access for MongoDB Cloud services. 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/" @@ -3462,7 +3476,7 @@ "content" : { "application/vnd.atlas.2023-01-01+json" : { "schema" : { - "$ref" : "#/components/schemas/CloudProviderAccessRole" + "$ref" : "#/components/schemas/CloudProviderAccessRoleRequestUpdate" } } }, @@ -3813,7 +3827,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster.", @@ -3873,7 +3887,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -3927,7 +3941,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -3979,7 +3993,7 @@ }, "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports" : { "get" : { - "description" : "Returns all Cloud Backup snapshot export jobs associated with the specified Atlas cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role.", + "description" : "Returns all Cloud Backup Snapshot Export Jobs associated with the specified Atlas cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role.", "operationId" : "listBackupExportJobs", "parameters" : [ { "$ref" : "#/components/parameters/envelope" @@ -4002,7 +4016,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -4027,11 +4041,11 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Return All Cloud Backup Snapshot Export Jobs", + "summary" : "Return All Snapshot Export Jobs", "tags" : [ "Cloud Backups" ] }, "post" : { - "description" : "Exports one backup snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. To use this resource, the requesting API Key must have the Project Atlas Admin role.", + "description" : "Exports one backup Snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. To use this resource, the requesting API Key must have the Project Atlas Admin role.", "operationId" : "createBackupExportJob", "parameters" : [ { "$ref" : "#/components/parameters/envelope" @@ -4046,7 +4060,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -4091,13 +4105,13 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Create One Cloud Backup Snapshot Export Job", + "summary" : "Create One Snapshot Export Job", "tags" : [ "Cloud Backups" ] } }, "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}" : { "get" : { - "description" : "Returns one Cloud Backup snapshot export job associated with the specified Atlas cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role.", + "description" : "Returns one Cloud Backup Snapshot Export Job associated with the specified Atlas cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role.", "operationId" : "getBackupExportJob", "parameters" : [ { "$ref" : "#/components/parameters/envelope" @@ -4112,15 +4126,19 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { - "description" : "Unique string that identifies the export job to return.", + "description" : "Unique 24-hexadecimal character string that identifies the Export Job.", "in" : "path", "name" : "exportId", "required" : true, "schema" : { - "type" : "string" + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" } } ], "responses" : { @@ -4145,7 +4163,7 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Return One Cloud Backup Snapshot Export Job", + "summary" : "Return One Snapshot Export Job", "tags" : [ "Cloud Backups" ] } }, @@ -4174,7 +4192,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -4220,7 +4238,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -4288,7 +4306,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the restore job to remove.", @@ -4348,7 +4366,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the restore job to return.", @@ -4406,7 +4424,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -4436,7 +4454,7 @@ } ], "summary" : "Remove All Cloud Backup Schedules", "tags" : [ "Cloud Backups" ], - "x-sunset" : "2025-08-05" + "x-sunset" : "2026-05-30" }, "get" : { "deprecated" : true, @@ -4457,7 +4475,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -4484,7 +4502,7 @@ } ], "summary" : "Return One Cloud Backup Schedule", "tags" : [ "Cloud Backups" ], - "x-sunset" : "2025-08-05" + "x-sunset" : "2026-05-30" }, "patch" : { "deprecated" : true, @@ -4505,7 +4523,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -4546,7 +4564,7 @@ } ], "summary" : "Update Cloud Backup Schedule for One Cluster", "tags" : [ "Cloud Backups" ], - "x-sunset" : "2025-08-05" + "x-sunset" : "2026-05-30" } }, "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots" : { @@ -4574,7 +4592,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -4623,7 +4641,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -4685,7 +4703,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -4742,7 +4760,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -4804,7 +4822,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -4855,7 +4873,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -4915,7 +4933,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -4975,7 +4993,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -5042,7 +5060,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "$ref" : "#/components/parameters/envelope" @@ -5113,7 +5131,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "$ref" : "#/components/parameters/envelope" @@ -5181,7 +5199,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "$ref" : "#/components/parameters/envelope" @@ -5232,7 +5250,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "$ref" : "#/components/parameters/envelope" @@ -5300,7 +5318,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -5351,7 +5369,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -5420,7 +5438,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -5480,7 +5498,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -5532,7 +5550,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -5582,7 +5600,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -5654,7 +5672,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -5728,7 +5746,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -5798,7 +5816,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -5869,7 +5887,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Name of the collection that contains one or more Atlas Search indexes.", @@ -5942,7 +5960,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the Atlas Search index. Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes.", @@ -6008,7 +6026,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "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.", @@ -6071,7 +6089,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "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.", @@ -6153,7 +6171,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -6207,7 +6225,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -6259,7 +6277,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -6325,7 +6343,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "$ref" : "#/components/parameters/groupId" @@ -6396,7 +6414,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -6466,7 +6484,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -6620,7 +6638,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -6670,7 +6688,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -6763,7 +6781,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Flag that indicates whether to download logs for queries against your online archive only or both your online archive and cluster.", @@ -6842,7 +6860,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -6906,7 +6924,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -6973,7 +6991,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -7045,7 +7063,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -7101,7 +7119,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -7157,7 +7175,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -7224,7 +7242,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -7279,7 +7297,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -7346,7 +7364,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -7408,7 +7426,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -7458,7 +7476,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -7521,7 +7539,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", @@ -7583,7 +7601,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -7635,7 +7653,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -7684,7 +7702,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -7747,7 +7765,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -7816,7 +7834,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -7882,7 +7900,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -7951,7 +7969,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Name of the collection that contains one or more Atlas Search indexes.", @@ -8035,7 +8053,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Name of the collection that contains one or more Atlas Search indexes.", @@ -8112,7 +8130,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Name of the collection that contains one or more Atlas Search indexes.", @@ -8189,7 +8207,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Name of the collection that contains one or more Atlas Search indexes.", @@ -8282,7 +8300,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the Atlas Search index. Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes.", @@ -8346,7 +8364,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "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.", @@ -8420,7 +8438,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "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.", @@ -8497,7 +8515,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -8544,7 +8562,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -8610,7 +8628,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Human-readable label that specifies whether to return only completed, incomplete, or all snapshots. By default, MongoDB Cloud only returns completed snapshots.", @@ -8668,7 +8686,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -8729,7 +8747,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -8787,7 +8805,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -8857,7 +8875,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -8901,7 +8919,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Human-readable label that identifies the cluster topology to retrieve metrics for.", @@ -8962,7 +8980,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Human-readable label that identifies the cluster topology to retrieve metrics for.", @@ -9052,7 +9070,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -9120,7 +9138,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -9192,7 +9210,7 @@ } } }, { - "description" : "Date and time when the period specifies the inclusive ending point for the range of log messages to retrieve. This parameter expresses its value in the number of seconds that have elapsed since the UNIX epoch.", + "description" : "Specifies the date and time for the ending point of the range of log messages to retrieve, in the number of seconds that have elapsed since the UNIX epoch. This value will default to 24 hours after the start date. If the start date is also unspecified, the value will default to the time of the request.", "in" : "query", "name" : "endDate", "schema" : { @@ -9201,7 +9219,7 @@ "minimum" : 1199145600 } }, { - "description" : "Date and time when the period specifies the inclusive starting point for the range of log messages to retrieve. This parameter expresses its value in the number of seconds that have elapsed since the UNIX epoch.", + "description" : "Specifies the date and time for the starting point of the range of log messages to retrieve, in the number of seconds that have elapsed since the UNIX epoch. This value will default to 24 hours prior to the end date. If the end date is also unspecified, the value will default to 24 hours prior to the time of the request.", "in" : "query", "name" : "startDate", "schema" : { @@ -11009,7 +11027,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Date and time when to stop retrieving database history. If you specify **end**, you must also specify **start**. This parameter uses UNIX epoch time in milliseconds.", @@ -11272,6 +11290,12 @@ "$ref" : "#/components/parameters/pretty" }, { "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" }, { "description" : "Human-readable label that identifies the cloud provider for the private endpoints to return.", "in" : "path", @@ -11394,17 +11418,6 @@ "pattern" : "^([a-f0-9]{24})$" } } ], - "requestBody" : { - "content" : { - "application/vnd.atlas.2023-01-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/EncryptionAtRestPrivateEndpointRequest" - } - } - }, - "description" : "Cloud provider of the private endpoints to delete and the list of cloud provider regions in which to delete the private endpoints.", - "required" : true - }, "responses" : { "204" : { "content" : { @@ -11475,6 +11488,9 @@ "403" : { "$ref" : "#/components/responses/forbidden" }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, "500" : { "$ref" : "#/components/responses/internalServerError" } @@ -11512,7 +11528,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, "style" : "form" @@ -12230,7 +12246,7 @@ } ], "summary" : "Return All Project Invitations", "tags" : [ "Projects" ], - "x-sunset" : "2024-10-04" + "x-sunset" : "2024-11-04" }, "patch" : { "deprecated" : true, @@ -12284,7 +12300,7 @@ } ], "summary" : "Update One Project Invitation", "tags" : [ "Projects" ], - "x-sunset" : "2024-10-04" + "x-sunset" : "2024-11-04" }, "post" : { "deprecated" : true, @@ -12332,7 +12348,7 @@ } ], "summary" : "Invite One MongoDB Cloud User to Join One Project", "tags" : [ "Projects" ], - "x-sunset" : "2024-10-04" + "x-sunset" : "2024-11-04" } }, "/api/atlas/v2/groups/{groupId}/invites/{invitationId}" : { @@ -12380,7 +12396,7 @@ } ], "summary" : "Cancel One Project Invitation", "tags" : [ "Projects" ], - "x-sunset" : "2024-10-04" + "x-sunset" : "2024-11-04" }, "get" : { "deprecated" : true, @@ -12431,7 +12447,7 @@ } ], "summary" : "Return One Project Invitation", "tags" : [ "Projects" ], - "x-sunset" : "2024-10-04" + "x-sunset" : "2024-11-04" }, "patch" : { "deprecated" : true, @@ -12494,7 +12510,7 @@ } ], "summary" : "Update One Project Invitation by Invitation ID", "tags" : [ "Projects" ], - "x-sunset" : "2024-10-04" + "x-sunset" : "2024-11-04" } }, "/api/atlas/v2/groups/{groupId}/ipAddresses" : { @@ -12591,13 +12607,13 @@ "description" : "Removes the specified project limit. Depending on the limit, Atlas either resets the limit to its default value or removes the limit entirely. To use this resource, the requesting API Key must have the Project Owner role.", "operationId" : "deleteProjectLimit", "parameters" : [ { - "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", + "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| 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 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n| atlas.project.deployment.salesSoldM0s | Limit on the number of M0 clusters in this project if the org is sales-sold | 100 | 100 |\n", "in" : "path", "name" : "limitName", "required" : true, "schema" : { "type" : "string", - "enum" : [ "atlas.project.security.databaseAccess.users", "atlas.project.deployment.clusters", "atlas.project.deployment.serverlessMTMs", "atlas.project.security.databaseAccess.customRoles", "atlas.project.security.networkAccess.entries", "atlas.project.security.networkAccess.crossRegionEntries", "atlas.project.deployment.nodesPerPrivateLinkRegion", "dataFederation.bytesProcessed.query", "dataFederation.bytesProcessed.daily", "dataFederation.bytesProcessed.weekly", "dataFederation.bytesProcessed.monthly", "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", "atlas.project.deployment.privateServiceConnectionsSubnetMask" ] + "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" @@ -12641,13 +12657,13 @@ "description" : "Returns the specified limit for the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "getProjectLimit", "parameters" : [ { - "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", + "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| 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 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n| atlas.project.deployment.salesSoldM0s | Limit on the number of M0 clusters in this project if the org is sales-sold | 100 | 100 |\n", "in" : "path", "name" : "limitName", "required" : true, "schema" : { "type" : "string", - "enum" : [ "atlas.project.security.databaseAccess.users", "atlas.project.deployment.clusters", "atlas.project.deployment.serverlessMTMs", "atlas.project.security.databaseAccess.customRoles", "atlas.project.security.networkAccess.entries", "atlas.project.security.networkAccess.crossRegionEntries", "atlas.project.deployment.nodesPerPrivateLinkRegion", "dataFederation.bytesProcessed.query", "dataFederation.bytesProcessed.daily", "dataFederation.bytesProcessed.weekly", "dataFederation.bytesProcessed.monthly", "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", "atlas.project.deployment.privateServiceConnectionsSubnetMask" ] + "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" @@ -12694,13 +12710,13 @@ "description" : "Sets the specified project limit. To use this resource, the requesting API Key must have the Project Owner role.\n\n**NOTE**: Increasing the following configuration limits might lead to slower response times in the MongoDB Cloud UI or increased user management overhead leading to authentication or authorization re-architecture. If possible, we recommend that you create additional projects to gain access to more of these resources for a more sustainable growth pattern.", "operationId" : "setProjectLimit", "parameters" : [ { - "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", + "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| 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 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n| atlas.project.deployment.salesSoldM0s | Limit on the number of M0 clusters in this project if the org is sales-sold | 100 | 100 |\n", "in" : "path", "name" : "limitName", "required" : true, "schema" : { "type" : "string", - "enum" : [ "atlas.project.security.databaseAccess.users", "atlas.project.deployment.clusters", "atlas.project.deployment.serverlessMTMs", "atlas.project.security.databaseAccess.customRoles", "atlas.project.security.networkAccess.entries", "atlas.project.security.networkAccess.crossRegionEntries", "atlas.project.deployment.nodesPerPrivateLinkRegion", "dataFederation.bytesProcessed.query", "dataFederation.bytesProcessed.daily", "dataFederation.bytesProcessed.weekly", "dataFederation.bytesProcessed.monthly", "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", "atlas.project.deployment.privateServiceConnectionsSubnetMask" ] + "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" @@ -13683,6 +13699,7 @@ }, "/api/atlas/v2/groups/{groupId}/pipelines" : { "get" : { + "deprecated" : true, "description" : "Returns a list of Data Lake Pipelines. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "listPipelines", "parameters" : [ { @@ -13719,10 +13736,16 @@ "DigestAuth" : [ ] } ], "summary" : "Return All Data Lake Pipelines from One Project", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" }, "post" : { + "deprecated" : true, "description" : "Creates one Data Lake Pipeline.", + "externalDocs" : { + "description" : "Data Lake Pipelines are deprecated. Please see Data Lake Deprecation Guide.", + "url" : "https://dochub.mongodb.org/core/data-lake-deprecation" + }, "operationId" : "createPipeline", "parameters" : [ { "$ref" : "#/components/parameters/envelope" @@ -13769,11 +13792,13 @@ "DigestAuth" : [ ] } ], "summary" : "Create One Data Lake Pipeline", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}" : { "delete" : { + "deprecated" : true, "description" : "Removes one Data Lake Pipeline.", "operationId" : "deletePipeline", "parameters" : [ { @@ -13818,9 +13843,11 @@ "DigestAuth" : [ ] } ], "summary" : "Remove One Data Lake Pipeline", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" }, "get" : { + "deprecated" : true, "description" : "Returns the details of one Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "getPipeline", "parameters" : [ { @@ -13867,9 +13894,11 @@ "DigestAuth" : [ ] } ], "summary" : "Return One Data Lake Pipeline", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" }, "patch" : { + "deprecated" : true, "description" : "Updates one Data Lake Pipeline.", "operationId" : "updatePipeline", "parameters" : [ { @@ -13931,11 +13960,13 @@ "DigestAuth" : [ ] } ], "summary" : "Update One Data Lake Pipeline", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules" : { "get" : { + "deprecated" : true, "description" : "Returns a list of backup schedule policy items that you can use as a Data Lake Pipeline source. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "listPipelineSchedules", "parameters" : [ { @@ -13985,11 +14016,13 @@ "DigestAuth" : [ ] } ], "summary" : "Return Available Ingestion Schedules for One Data Lake Pipeline", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots" : { "get" : { + "deprecated" : true, "description" : "Returns a list of backup snapshots that you can use to trigger an on demand pipeline run. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "listPipelineSnapshots", "parameters" : [ { @@ -14051,11 +14084,13 @@ "DigestAuth" : [ ] } ], "summary" : "Return Available Backup Snapshots for One Data Lake Pipeline", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause" : { "post" : { + "deprecated" : true, "description" : "Pauses ingestion for a Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "pausePipeline", "parameters" : [ { @@ -14102,11 +14137,13 @@ "DigestAuth" : [ ] } ], "summary" : "Pause One Data Lake Pipeline", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume" : { "post" : { + "deprecated" : true, "description" : "Resumes ingestion for a Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "resumePipeline", "parameters" : [ { @@ -14153,11 +14190,13 @@ "DigestAuth" : [ ] } ], "summary" : "Resume One Data Lake Pipeline", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs" : { "get" : { + "deprecated" : true, "description" : "Returns a list of past Data Lake Pipeline runs. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "listPipelineRuns", "parameters" : [ { @@ -14219,11 +14258,13 @@ "DigestAuth" : [ ] } ], "summary" : "Return All Data Lake Pipeline Runs from One Project", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}" : { "delete" : { + "deprecated" : true, "description" : "Deletes dataset that Atlas generated during the specified pipeline run.", "operationId" : "deletePipelineRunDataset", "parameters" : [ { @@ -14282,9 +14323,11 @@ "DigestAuth" : [ ] } ], "summary" : "Delete Pipeline Run Dataset", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" }, "get" : { + "deprecated" : true, "description" : "Returns the details of one Data Lake Pipeline run within the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "getPipelineRun", "parameters" : [ { @@ -14343,11 +14386,13 @@ "DigestAuth" : [ ] } ], "summary" : "Return One Data Lake Pipeline Run", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger" : { "post" : { + "deprecated" : true, "description" : "Triggers a Data Lake Pipeline ingestion of a specified snapshot.", "operationId" : "triggerSnapshotIngestion", "parameters" : [ { @@ -14405,7 +14450,8 @@ "DigestAuth" : [ ] } ], "summary" : "Trigger on demand snapshot ingestion", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService" : { @@ -14565,7 +14611,7 @@ "schema" : { "type" : "string", "maxLength" : 64, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -14618,7 +14664,7 @@ "schema" : { "type" : "string", "maxLength" : 64, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -14677,7 +14723,7 @@ "schema" : { "type" : "string", "maxLength" : 64, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be removed.", @@ -14734,7 +14780,7 @@ "schema" : { "type" : "string", "maxLength" : 64, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the tenant endpoint.", @@ -14791,7 +14837,7 @@ "schema" : { "type" : "string", "maxLength" : 64, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be updated.", @@ -15967,7 +16013,7 @@ "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" ] + "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" ] }, "maxItems" : 10, "minItems" : 1, @@ -16046,7 +16092,7 @@ "items" : { "type" : "string", "description" : "One measurement requested for this MongoDB process.", - "enum" : [ "ASSERT_MSG", "ASSERT_REGULAR", "ASSERT_USER", "ASSERT_WARNING", "BACKGROUND_FLUSH_AVG", "CACHE_BYTES_READ_INTO", "CACHE_BYTES_WRITTEN_FROM", "CACHE_DIRTY_BYTES", "CACHE_USED_BYTES", "COMPUTED_MEMORY", "CONNECTIONS", "CURSORS_TOTAL_OPEN", "CURSORS_TOTAL_TIMED_OUT", "DB_DATA_SIZE_TOTAL", "DB_STORAGE_TOTAL", "DOCUMENT_METRICS_DELETED", "DOCUMENT_METRICS_INSERTED", "DOCUMENT_METRICS_RETURNED", "DOCUMENT_METRICS_UPDATED", "EXTRA_INFO_PAGE_FAULTS", "FTS_DISK_UTILIZATION", "FTS_MEMORY_MAPPED", "FTS_MEMORY_RESIDENT", "FTS_MEMORY_VIRTUAL", "FTS_PROCESS_CPU_KERNEL", "FTS_PROCESS_CPU_USER", "FTS_PROCESS_NORMALIZED_CPU_KERNEL", "FTS_PROCESS_NORMALIZED_CPU_USER", "GLOBAL_ACCESSES_NOT_IN_MEMORY", "GLOBAL_LOCK_CURRENT_QUEUE_READERS", "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL", "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS", "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN", "INDEX_COUNTERS_BTREE_ACCESSES", "INDEX_COUNTERS_BTREE_HITS", "INDEX_COUNTERS_BTREE_MISS_RATIO", "INDEX_COUNTERS_BTREE_MISSES", "JOURNALING_COMMITS_IN_WRITE_LOCK", "JOURNALING_MB", "JOURNALING_WRITE_DATA_FILES_MB", "MAX_PROCESS_CPU_CHILDREN_KERNEL", "MAX_PROCESS_CPU_CHILDREN_USER", "MAX_PROCESS_CPU_KERNEL", "MAX_PROCESS_CPU_USER", "MAX_PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL", "MAX_PROCESS_NORMALIZED_CPU_CHILDREN_USER", "MAX_PROCESS_NORMALIZED_CPU_KERNEL", "MAX_PROCESS_NORMALIZED_CPU_USER", "MAX_SWAP_USAGE_FREE", "MAX_SWAP_USAGE_USED ", "MAX_SYSTEM_CPU_GUEST", "MAX_SYSTEM_CPU_IOWAIT", "MAX_SYSTEM_CPU_IRQ", "MAX_SYSTEM_CPU_KERNEL", "MAX_SYSTEM_CPU_SOFTIRQ", "MAX_SYSTEM_CPU_STEAL", "MAX_SYSTEM_CPU_USER", "MAX_SYSTEM_MEMORY_AVAILABLE", "MAX_SYSTEM_MEMORY_FREE", "MAX_SYSTEM_MEMORY_USED", "MAX_SYSTEM_NETWORK_IN", "MAX_SYSTEM_NETWORK_OUT", "MAX_SYSTEM_NORMALIZED_CPU_GUEST", "MAX_SYSTEM_NORMALIZED_CPU_IOWAIT", "MAX_SYSTEM_NORMALIZED_CPU_IRQ", "MAX_SYSTEM_NORMALIZED_CPU_KERNEL", "MAX_SYSTEM_NORMALIZED_CPU_NICE", "MAX_SYSTEM_NORMALIZED_CPU_SOFTIRQ", "MAX_SYSTEM_NORMALIZED_CPU_STEAL", "MAX_SYSTEM_NORMALIZED_CPU_USER", "MEMORY_MAPPED", "MEMORY_RESIDENT", "MEMORY_VIRTUAL", "NETWORK_BYTES_IN", "NETWORK_BYTES_OUT", "NETWORK_NUM_REQUESTS", "OP_EXECUTION_TIME_COMMANDS", "OP_EXECUTION_TIME_READS", "OP_EXECUTION_TIME_WRITES", "OPCOUNTER_CMD", "OPCOUNTER_DELETE", "OPCOUNTER_GETMORE", "OPCOUNTER_INSERT", "OPCOUNTER_QUERY", "OPCOUNTER_REPL_CMD", "OPCOUNTER_REPL_DELETE", "OPCOUNTER_REPL_INSERT", "OPCOUNTER_REPL_UPDATE", "OPCOUNTER_UPDATE", "OPERATIONS_SCAN_AND_ORDER", "OPLOG_MASTER_LAG_TIME_DIFF", "OPLOG_MASTER_TIME", "OPLOG_RATE_GB_PER_HOUR", "OPLOG_SLAVE_LAG_MASTER_TIME", "OPLOG_REPLICATION_LAG", "PROCESS_CPU_CHILDREN_KERNEL", "PROCESS_CPU_CHILDREN_USER", "PROCESS_CPU_KERNEL", "PROCESS_CPU_USER", "PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL", "PROCESS_NORMALIZED_CPU_CHILDREN_USER", "PROCESS_NORMALIZED_CPU_KERNEL", "PROCESS_NORMALIZED_CPU_USER", "QUERY_EXECUTOR_SCANNED", "QUERY_EXECUTOR_SCANNED_OBJECTS", "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED", "QUERY_TARGETING_SCANNED_PER_RETURNED", "RESTARTS_IN_LAST_HOUR", "SWAP_USAGE_FREE", "SWAP_USAGE_USED", "SYSTEM_CPU_GUEST", "SYSTEM_CPU_IOWAIT", "SYSTEM_CPU_IRQ", "SYSTEM_CPU_KERNEL", "SYSTEM_CPU_NICE", "SYSTEM_CPU_SOFTIRQ", "SYSTEM_CPU_STEAL", "SYSTEM_CPU_USER", "SYSTEM_MEMORY_AVAILABLE", "SYSTEM_MEMORY_FREE", "SYSTEM_MEMORY_USED", "SYSTEM_NETWORK_IN", "SYSTEM_NETWORK_OUT", "SYSTEM_NORMALIZED_CPU_GUEST", "SYSTEM_NORMALIZED_CPU_IOWAIT", "SYSTEM_NORMALIZED_CPU_IRQ", "SYSTEM_NORMALIZED_CPU_KERNEL", "SYSTEM_NORMALIZED_CPU_NICE", "SYSTEM_NORMALIZED_CPU_SOFTIRQ", "SYSTEM_NORMALIZED_CPU_STEAL", "SYSTEM_NORMALIZED_CPU_USER", "TICKETS_AVAILABLE_READS", "TICKETS_AVAILABLE_WRITE", "OPERATION_THROTTLING_REJECTED_OPERATIONS" ] + "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_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" ] }, "maxItems" : 10, "minItems" : 1, @@ -16616,7 +16662,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -16817,7 +16863,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -16866,7 +16912,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -16934,7 +16980,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the restore job to return.", @@ -17002,7 +17048,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -17051,7 +17097,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -17110,7 +17156,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "$ref" : "#/components/parameters/envelope" @@ -17156,7 +17202,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Value that we want to set for the Serverless Auto Indexing toggle.", @@ -17214,20 +17260,20 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { - "204" : { + "202" : { "content" : { "application/vnd.atlas.2023-01-01+json" : { "schema" : { - "$ref" : "#/components/schemas/NoBody" + "$ref" : "#/components/schemas/RequestAccepted" }, "x-xgen-version" : "2023-01-01" } }, - "description" : "This endpoint does not return a response body." + "description" : "Accepted" }, "400" : { "$ref" : "#/components/responses/badRequest" @@ -17266,7 +17312,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -17318,7 +17364,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -17361,29 +17407,25 @@ "tags" : [ "Serverless Instances" ] } }, - "/api/atlas/v2/groups/{groupId}/serviceAccounts" : { + "/api/atlas/v2/groups/{groupId}/settings" : { "get" : { - "description" : "Returns list of Service Accounts for a project with service account details.", - "operationId" : "listProjectServiceAccounts", + "description" : "Returns details about the specified project's settings. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "getProjectSettings", "parameters" : [ { - "$ref" : "#/components/parameters/groupId" - }, { - "$ref" : "#/components/parameters/itemsPerPage" + "$ref" : "#/components/parameters/envelope" }, { - "$ref" : "#/components/parameters/pageNum" + "$ref" : "#/components/parameters/groupId" }, { "$ref" : "#/components/parameters/pretty" - }, { - "$ref" : "#/components/parameters/envelope" } ], "responses" : { "200" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2023-01-01+json" : { "schema" : { - "$ref" : "#/components/schemas/PaginatedGroupServiceAccounts" + "$ref" : "#/components/schemas/GroupSettings" }, - "x-xgen-version" : "2023-10-01" + "x-xgen-version" : "2023-01-01" } }, "description" : "OK" @@ -17394,148 +17436,6 @@ "403" : { "$ref" : "#/components/responses/forbidden" }, - "500" : { - "$ref" : "#/components/responses/internalServerError" - } - }, - "security" : [ { - "DigestAuth" : [ ] - } ], - "summary" : "Return All project Service Accounts", - "tags" : [ "Groups" ] - }, - "post" : { - "description" : "Creates and assigns the specified Service Account to the specified Project.", - "operationId" : "createProjectServiceAccount", - "parameters" : [ { - "$ref" : "#/components/parameters/groupId" - }, { - "$ref" : "#/components/parameters/envelope" - }, { - "$ref" : "#/components/parameters/pretty" - } ], - "requestBody" : { - "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/GroupServiceAccountRequest" - }, - "x-xgen-version" : "2023-10-01" - } - }, - "description" : "Details to create service account and add to the specified project.", - "required" : true - }, - "responses" : { - "201" : { - "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/GroupServiceAccount" - }, - "x-xgen-version" : "2023-10-01" - } - }, - "description" : "Created" - }, - "400" : { - "$ref" : "#/components/responses/badRequest" - }, - "401" : { - "$ref" : "#/components/responses/unauthorized" - }, - "500" : { - "$ref" : "#/components/responses/internalServerError" - } - }, - "security" : [ { - "DigestAuth" : [ ] - } ], - "summary" : "Create and Assign one Service Account to one project", - "tags" : [ "Groups" ] - } - }, - "/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}" : { - "delete" : { - "description" : "Removes one Service Account from the specified project.", - "operationId" : "deleteProjectServiceAccount", - "parameters" : [ { - "description" : "Id of the service account.", - "in" : "path", - "name" : "serviceAccountId", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "$ref" : "#/components/parameters/groupId" - }, { - "$ref" : "#/components/parameters/envelope" - }, { - "$ref" : "#/components/parameters/pretty" - } ], - "responses" : { - "204" : { - "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/NoBody" - }, - "x-xgen-version" : "2023-10-01" - } - }, - "description" : "This endpoint does not return a response body.", - "x-xgen-version" : "2023-10-01" - }, - "401" : { - "$ref" : "#/components/responses/unauthorized" - }, - "404" : { - "$ref" : "#/components/responses/notFound" - }, - "500" : { - "$ref" : "#/components/responses/internalServerError" - } - }, - "security" : [ { - "DigestAuth" : [ ] - } ], - "summary" : "Unassign One Service Account from One Project.", - "tags" : [ "Groups" ] - }, - "get" : { - "description" : "Get project Service Account Details.", - "operationId" : "getProjectServiceAccount", - "parameters" : [ { - "$ref" : "#/components/parameters/groupId" - }, { - "description" : "Id of the service account.", - "in" : "path", - "name" : "serviceAccountId", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "$ref" : "#/components/parameters/envelope" - }, { - "$ref" : "#/components/parameters/pretty" - } ], - "responses" : { - "200" : { - "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/GroupServiceAccount" - }, - "x-xgen-version" : "2023-10-01" - } - }, - "description" : "OK" - }, - "401" : { - "$ref" : "#/components/responses/unauthorized" - }, "404" : { "$ref" : "#/components/responses/notFound" }, @@ -17546,143 +17446,30 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Service Account Fetching", - "tags" : [ "Groups" ] + "summary" : "Return One Project Settings", + "tags" : [ "Projects" ] }, "patch" : { - "description" : "Update Service Account in Project.", - "operationId" : "updateProjectServiceAccount", + "description" : "Updates the settings of the specified project. You can update any of the options available. MongoDB cloud only updates the options provided in the request. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "updateProjectSettings", "parameters" : [ { - "description" : "Id of the service account.", - "in" : "path", - "name" : "serviceAccountId", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "$ref" : "#/components/parameters/groupId" - }, { "$ref" : "#/components/parameters/envelope" - }, { - "$ref" : "#/components/parameters/pretty" - } ], - "requestBody" : { - "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/GroupServiceAccountUpdateRequest" - } - } - }, - "description" : "Details to update service account in the specified Project.", - "required" : true - }, - "responses" : { - "200" : { - "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/GroupServiceAccount" - }, - "x-xgen-version" : "2023-10-01" - } - }, - "description" : "OK" - }, - "400" : { - "$ref" : "#/components/responses/badRequest" - }, - "401" : { - "$ref" : "#/components/responses/unauthorized" - }, - "404" : { - "$ref" : "#/components/responses/notFound" - }, - "500" : { - "$ref" : "#/components/responses/internalServerError" - } - }, - "security" : [ { - "DigestAuth" : [ ] - } ], - "summary" : "Service Account Update in Project", - "tags" : [ "Groups" ] - }, - "post" : { - "description" : "Assigns the specified organization Service Account to the specified project.", - "operationId" : "addProjectServiceAccount", - "parameters" : [ { - "description" : "Id of the service account.", - "in" : "path", - "name" : "serviceAccountId", - "required" : true, - "schema" : { - "type" : "string" - } }, { "$ref" : "#/components/parameters/groupId" - }, { - "$ref" : "#/components/parameters/envelope" }, { "$ref" : "#/components/parameters/pretty" } ], "requestBody" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2023-01-01+json" : { "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/GroupServiceAccountRoleAssignment" - } - }, - "x-xgen-version" : "2023-10-01" + "$ref" : "#/components/schemas/GroupSettings" + } } }, - "description" : "Service Account Roles to be assigned to the specified project.", + "description" : "Settings to update.", "required" : true }, - "responses" : { - "204" : { - "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/NoBody" - }, - "x-xgen-version" : "2023-10-01" - } - }, - "description" : "This endpoint does not return a response body.", - "x-xgen-version" : "2023-10-01" - }, - "401" : { - "$ref" : "#/components/responses/unauthorized" - }, - "404" : { - "$ref" : "#/components/responses/notFound" - }, - "500" : { - "$ref" : "#/components/responses/internalServerError" - } - }, - "security" : [ { - "DigestAuth" : [ ] - } ], - "summary" : "Assign One Service Account to One Project", - "tags" : [ "Groups" ] - } - }, - "/api/atlas/v2/groups/{groupId}/settings" : { - "get" : { - "description" : "Returns details about the specified project's settings. To use this resource, the requesting API Key must have the Project Read Only role.", - "operationId" : "getProjectSettings", - "parameters" : [ { - "$ref" : "#/components/parameters/envelope" - }, { - "$ref" : "#/components/parameters/groupId" - }, { - "$ref" : "#/components/parameters/pretty" - } ], "responses" : { "200" : { "content" : { @@ -17711,51 +17498,92 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Return One Project Settings", + "summary" : "Update One Project Settings", "tags" : [ "Projects" ] - }, - "patch" : { - "description" : "Updates the settings of the specified project. You can update any of the options available. MongoDB cloud only updates the options provided in the request. To use this resource, the requesting API Key must have the Project Owner role.", - "operationId" : "updateProjectSettings", + } + }, + "/api/atlas/v2/groups/{groupId}/streams" : { + "get" : { + "description" : "Returns all stream instances for the specified project.", + "operationId" : "listStreamInstances", "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { "$ref" : "#/components/parameters/envelope" }, { - "$ref" : "#/components/parameters/groupId" + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiStreamsTenantView" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Project Stream Instances", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "post" : { + "description" : "Creates one stream instance in the specified project. To use this resource, the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role.", + "operationId" : "createStreamInstance", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" }, { "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" } ], "requestBody" : { "content" : { - "application/vnd.atlas.2023-01-01+json" : { + "application/vnd.atlas.2023-02-01+json" : { "schema" : { - "$ref" : "#/components/schemas/GroupSettings" + "$ref" : "#/components/schemas/StreamsTenant" } } }, - "description" : "Settings to update.", + "description" : "Details to create one streams instance in the specified project.", "required" : true }, "responses" : { "200" : { "content" : { - "application/vnd.atlas.2023-01-01+json" : { + "application/vnd.atlas.2023-02-01+json" : { "schema" : { - "$ref" : "#/components/schemas/GroupSettings" + "$ref" : "#/components/schemas/StreamsTenant" }, - "x-xgen-version" : "2023-01-01" + "x-xgen-version" : "2023-02-01" } }, "description" : "OK" }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, "401" : { "$ref" : "#/components/responses/unauthorized" }, - "403" : { - "$ref" : "#/components/responses/forbidden" - }, - "404" : { - "$ref" : "#/components/responses/notFound" - }, "500" : { "$ref" : "#/components/responses/internalServerError" } @@ -17763,14 +17591,17 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Update One Project Settings", - "tags" : [ "Projects" ] + "summary" : "Create One Stream Instance", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + } } }, - "/api/atlas/v2/groups/{groupId}/streams" : { + "/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections" : { "get" : { - "description" : "Returns all stream instances for the specified project.", - "operationId" : "listStreamInstances", + "description" : "Returns all Private Link connections for the specified project.To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role.", + "operationId" : "listPrivateLinkConnections", "parameters" : [ { "$ref" : "#/components/parameters/groupId" }, { @@ -17787,7 +17618,7 @@ "content" : { "application/vnd.atlas.2023-02-01+json" : { "schema" : { - "$ref" : "#/components/schemas/PaginatedApiStreamsTenantView" + "$ref" : "#/components/schemas/PaginatedApiStreamsPrivateLinkView" }, "x-xgen-version" : "2023-02-01" } @@ -17797,6 +17628,9 @@ "401" : { "$ref" : "#/components/responses/unauthorized" }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, "500" : { "$ref" : "#/components/responses/internalServerError" } @@ -17804,15 +17638,15 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Return All Project Stream Instances", + "summary" : "Return All Private Link", "tags" : [ "Streams" ], "x-xgen-changelog" : { - "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + "2024-10-02" : "The MongoDB Atlas Streams Processing Private Link API is now exposed as part of private preview, but is subject to change until GA." } }, "post" : { - "description" : "Creates one stream instance in the specified project. To use this resource, the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role.", - "operationId" : "createStreamInstance", + "description" : "Creates one Private Link in the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Stream Processing Owner role.", + "operationId" : "createPrivateLinkConnection", "parameters" : [ { "$ref" : "#/components/parameters/envelope" }, { @@ -17824,11 +17658,11 @@ "content" : { "application/vnd.atlas.2023-02-01+json" : { "schema" : { - "$ref" : "#/components/schemas/StreamsTenant" + "$ref" : "#/components/schemas/StreamsPrivateLinkConnection" } } }, - "description" : "Details to create one streams instance in the specified project.", + "description" : "Details to create one Private Link connection for a project. project.", "required" : true }, "responses" : { @@ -17836,7 +17670,7 @@ "content" : { "application/vnd.atlas.2023-02-01+json" : { "schema" : { - "$ref" : "#/components/schemas/StreamsTenant" + "$ref" : "#/components/schemas/StreamsPrivateLinkConnection" }, "x-xgen-version" : "2023-02-01" } @@ -17849,6 +17683,9 @@ "401" : { "$ref" : "#/components/responses/unauthorized" }, + "409" : { + "$ref" : "#/components/responses/unauthorized" + }, "500" : { "$ref" : "#/components/responses/internalServerError" } @@ -17856,13 +17693,310 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Create One Stream Instance", + "summary" : "Create One Private Link connection", "tags" : [ "Streams" ], "x-xgen-changelog" : { - "2023-09-11" : "The MongoDB Atlas Streams Processing API is now exposed as part of private preview, but is subject to change until GA." + "2024-10-02" : "The MongoDB Atlas Streams Processing Private Link API is now exposed as part of private preview, but is subject to change until GA." } } }, + "/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections/{connectionId}" : { + "delete" : { + "description" : "Deletes one Private Link in the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Stream Processing Owner role.", + "operationId" : "deletePrivateLinkConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique ID that identifies the Private Link connection.", + "in" : "path", + "name" : "connectionId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Accepted" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete One Private Link connection", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2024-10-02" : "The MongoDB Atlas Streams Processing Private Link API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "get" : { + "description" : "Returns the details of one Private Link connection within the project. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "getPrivateLinkConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique ID that identifies the Private Link connection.", + "in" : "path", + "name" : "connectionId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsPrivateLinkConnection" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One PrivateLink Connection", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2024-10-02" : "The MongoDB Atlas Streams Processing Private Link API is now exposed as part of private preview, but is subject to change until GA." + } + } + }, + "/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections" : { + "get" : { + "description" : "Returns a list of incoming VPC Peering Connections.", + "operationId" : "getVPCPeeringConnections", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All VPC Peering Connections.", + "tags" : [ "Streams" ] + } + }, + "/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}" : { + "delete" : { + "description" : "Deletes an incoming VPC Peering connection.", + "operationId" : "deleteVPCPeeringConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "The VPC Peering Connection id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Accepted" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Deletes an incoming VPC Peering connection.", + "tags" : [ "Streams" ] + } + }, + "/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:accept" : { + "post" : { + "description" : "Requests the acceptance of an incoming VPC Peering connection.", + "operationId" : "acceptVPCPeeringConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "The VPC Peering Connection id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/VPCPeeringActionChallenge" + } + } + }, + "description" : "Challenge values for VPC Peering requester account ID, and requester VPC ID.", + "required" : true + }, + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Accepted" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Requests the acceptance of an incoming VPC Peering connection.", + "tags" : [ "Streams" ] + } + }, + "/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:reject" : { + "post" : { + "description" : "Requests the rejection of an incoming VPC Peering connection.", + "operationId" : "rejectVPCPeeringConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "The VPC Peering Connection id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Accepted" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Requests the rejection of an incoming VPC Peering connection.", + "tags" : [ "Streams" ] + } + }, "/api/atlas/v2/groups/{groupId}/streams/{tenantName}" : { "delete" : { "description" : "Delete one stream instance in the specified project. To use this resource, the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role.", @@ -21326,414 +21460,6 @@ "tags" : [ "Cloud Migration Service" ] } }, - "/api/atlas/v2/orgs/{orgId}/serviceAccounts" : { - "get" : { - "description" : "Returns list of Service Accounts with service account details.", - "operationId" : "listServiceAccounts", - "parameters" : [ { - "$ref" : "#/components/parameters/orgId" - }, { - "$ref" : "#/components/parameters/itemsPerPage" - }, { - "$ref" : "#/components/parameters/pageNum" - }, { - "$ref" : "#/components/parameters/pretty" - }, { - "$ref" : "#/components/parameters/envelope" - } ], - "responses" : { - "200" : { - "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/PaginatedOrgServiceAccounts" - }, - "x-xgen-version" : "2023-10-01" - } - }, - "description" : "OK" - }, - "401" : { - "$ref" : "#/components/responses/unauthorized" - }, - "403" : { - "$ref" : "#/components/responses/forbidden" - }, - "500" : { - "$ref" : "#/components/responses/internalServerError" - } - }, - "security" : [ { - "DigestAuth" : [ ] - } ], - "summary" : "Return All Service Accounts", - "tags" : [ "Organizations" ] - }, - "post" : { - "description" : "Create Service Account containing client id and client secrets.", - "operationId" : "createServiceAccount", - "parameters" : [ { - "$ref" : "#/components/parameters/orgId" - }, { - "$ref" : "#/components/parameters/envelope" - }, { - "$ref" : "#/components/parameters/pretty" - } ], - "requestBody" : { - "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/OrgServiceAccountRequest" - } - } - }, - "description" : "Details to create service account in the specified organization.", - "required" : true - }, - "responses" : { - "201" : { - "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/OrgServiceAccount" - }, - "x-xgen-version" : "2023-10-01" - } - }, - "description" : "Created" - }, - "400" : { - "$ref" : "#/components/responses/badRequest" - }, - "401" : { - "$ref" : "#/components/responses/unauthorized" - }, - "500" : { - "$ref" : "#/components/responses/internalServerError" - } - }, - "security" : [ { - "DigestAuth" : [ ] - } ], - "summary" : "Service Account Creation", - "tags" : [ "Organizations" ] - } - }, - "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}" : { - "delete" : { - "description" : "Delete Service Account.", - "operationId" : "deleteServiceAccount", - "parameters" : [ { - "description" : "Id of the service account.", - "in" : "path", - "name" : "serviceAccountId", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "$ref" : "#/components/parameters/orgId" - }, { - "$ref" : "#/components/parameters/envelope" - }, { - "$ref" : "#/components/parameters/pretty" - } ], - "responses" : { - "204" : { - "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "x-xgen-version" : "2023-10-01" - } - }, - "description" : "This endpoint does not return a response body." - }, - "401" : { - "$ref" : "#/components/responses/unauthorized" - }, - "404" : { - "$ref" : "#/components/responses/notFound" - }, - "500" : { - "$ref" : "#/components/responses/internalServerError" - } - }, - "security" : [ { - "DigestAuth" : [ ] - } ], - "summary" : "Service Account Deletion.", - "tags" : [ "Organizations" ] - }, - "get" : { - "description" : "Get Service Account Details.", - "operationId" : "getServiceAccount", - "parameters" : [ { - "$ref" : "#/components/parameters/orgId" - }, { - "description" : "Id of the service account.", - "in" : "path", - "name" : "serviceAccountId", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "$ref" : "#/components/parameters/envelope" - }, { - "$ref" : "#/components/parameters/pretty" - } ], - "responses" : { - "200" : { - "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/OrgServiceAccount" - }, - "x-xgen-version" : "2023-10-01" - } - }, - "description" : "OK" - }, - "401" : { - "$ref" : "#/components/responses/unauthorized" - }, - "404" : { - "$ref" : "#/components/responses/notFound" - }, - "500" : { - "$ref" : "#/components/responses/internalServerError" - } - }, - "security" : [ { - "DigestAuth" : [ ] - } ], - "summary" : "Service Account Fetching", - "tags" : [ "Organizations" ] - }, - "patch" : { - "description" : "Update Service Account.", - "operationId" : "updateServiceAccount", - "parameters" : [ { - "description" : "Id of the service account.", - "in" : "path", - "name" : "serviceAccountId", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "$ref" : "#/components/parameters/orgId" - }, { - "$ref" : "#/components/parameters/envelope" - }, { - "$ref" : "#/components/parameters/pretty" - } ], - "requestBody" : { - "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/OrgServiceAccountUpdateRequest" - } - } - }, - "description" : "Details to update service account in the specified organization.", - "required" : true - }, - "responses" : { - "200" : { - "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/OrgServiceAccount" - }, - "x-xgen-version" : "2023-10-01" - } - }, - "description" : "OK" - }, - "400" : { - "$ref" : "#/components/responses/badRequest" - }, - "401" : { - "$ref" : "#/components/responses/unauthorized" - }, - "404" : { - "$ref" : "#/components/responses/notFound" - }, - "500" : { - "$ref" : "#/components/responses/internalServerError" - } - }, - "security" : [ { - "DigestAuth" : [ ] - } ], - "summary" : "Service Account Update", - "tags" : [ "Organizations" ] - } - }, - "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/groups" : { - "get" : { - "description" : "Returns list of Service Account projects.", - "operationId" : "listServiceAccountProjects", - "parameters" : [ { - "$ref" : "#/components/parameters/orgId" - }, { - "description" : "Id of the service account.", - "in" : "path", - "name" : "serviceAccountId", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "$ref" : "#/components/parameters/itemsPerPage" - }, { - "$ref" : "#/components/parameters/pageNum" - }, { - "$ref" : "#/components/parameters/pretty" - }, { - "$ref" : "#/components/parameters/envelope" - } ], - "responses" : { - "200" : { - "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/PaginatedServiceAccountGroup" - }, - "x-xgen-version" : "2023-10-01" - } - }, - "description" : "OK" - }, - "401" : { - "$ref" : "#/components/responses/unauthorized" - }, - "403" : { - "$ref" : "#/components/responses/forbidden" - }, - "500" : { - "$ref" : "#/components/responses/internalServerError" - } - }, - "security" : [ { - "DigestAuth" : [ ] - } ], - "summary" : "Return All Service Account projects", - "tags" : [ "Organizations" ] - } - }, - "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets" : { - "post" : { - "description" : "Create Service Account secret.", - "operationId" : "createServiceAccountSecret", - "parameters" : [ { - "$ref" : "#/components/parameters/orgId" - }, { - "description" : "Id of the service account.", - "in" : "path", - "name" : "serviceAccountId", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "$ref" : "#/components/parameters/envelope" - }, { - "$ref" : "#/components/parameters/pretty" - } ], - "requestBody" : { - "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/ServiceAccountSecretRequest" - } - } - }, - "description" : "Details to create secret in the specified service account.", - "required" : true - }, - "responses" : { - "201" : { - "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/ServiceAccountSecret" - }, - "x-xgen-version" : "2023-10-01" - } - }, - "description" : "Created" - }, - "400" : { - "$ref" : "#/components/responses/badRequest" - }, - "401" : { - "$ref" : "#/components/responses/unauthorized" - }, - "500" : { - "$ref" : "#/components/responses/internalServerError" - } - }, - "security" : [ { - "DigestAuth" : [ ] - } ], - "summary" : "Service Account Secret Creation", - "tags" : [ "Organizations" ] - } - }, - "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets/{secretId}" : { - "delete" : { - "description" : "Delete Service Account Secret.", - "operationId" : "deleteServiceAccountSecret", - "parameters" : [ { - "description" : "Id of the service account.", - "in" : "path", - "name" : "serviceAccountId", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "description" : "Id of the secret.", - "in" : "path", - "name" : "secretId", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "$ref" : "#/components/parameters/orgId" - }, { - "$ref" : "#/components/parameters/envelope" - }, { - "$ref" : "#/components/parameters/pretty" - } ], - "responses" : { - "204" : { - "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "x-xgen-version" : "2023-10-01" - } - }, - "description" : "This endpoint does not return a response body." - }, - "401" : { - "$ref" : "#/components/responses/unauthorized" - }, - "404" : { - "$ref" : "#/components/responses/notFound" - }, - "500" : { - "$ref" : "#/components/responses/internalServerError" - } - }, - "security" : [ { - "DigestAuth" : [ ] - } ], - "summary" : "Service Account Secret Deletion.", - "tags" : [ "Organizations" ] - } - }, "/api/atlas/v2/orgs/{orgId}/settings" : { "get" : { "description" : "Returns details about the specified organization's settings. To use this resource, the requesting API Key must have the Organization Owner role.", @@ -21809,6 +21535,9 @@ }, "description" : "OK" }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, "401" : { "$ref" : "#/components/responses/unauthorized" }, @@ -22435,12 +22164,15 @@ }, "/api/atlas/v2/orgs/{orgId}/users/{userId}" : { "delete" : { + "deprecated" : true, "description" : "Removes one MongoDB Cloud user from the specified organization. To use this resource, the requesting API Key must have the Organization User Admin role.", "operationId" : "removeOrganizationUser", "parameters" : [ { "$ref" : "#/components/parameters/envelope" }, { "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" }, { "description" : "Unique 24-hexadecimal digit string that identifies the user to be deleted.", "in" : "path", @@ -22484,8 +22216,9 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Remove One MongoDB Cloud User from One Organization", - "tags" : [ "Organizations" ] + "summary" : "Remove One MongoDB Cloud User From One Organization", + "tags" : [ "Organizations" ], + "x-sunset" : "2026-01-01" } }, "/api/atlas/v2/orgs/{orgId}/users/{userId}/roles" : { @@ -23233,7 +22966,7 @@ "diskIOPS" : { "type" : "integer", "format" : "int32", - "description" : "Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.\n\n Change this parameter only if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" to \"AWS\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" to \"M30\"` or greater (not including `Mxx_NVME` tiers).\n\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType\" to \"PROVISIONED\"`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1." + "description" : "Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.\n\n Change this parameter if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" to \"AWS\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" to \"M30\"` or greater (not including `Mxx_NVME` tiers).\n\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType\" to \"PROVISIONED\"`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1." }, "ebsVolumeType" : { "type" : "string", @@ -23262,7 +22995,7 @@ "diskIOPS" : { "type" : "integer", "format" : "int32", - "description" : "Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.\n\n You can set different IOPS values on different shards when provisioned IOPS are supported.\n\n Change this parameter only if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" to \"AWS\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" to \"M30\"` or greater (not including `Mxx_NVME` tiers).\n\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType\" to \"PROVISIONED\"`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1." + "description" : "Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.\n\n You can set different IOPS values on different shards when provisioned IOPS are supported.\n\n Change this parameter if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" to \"AWS\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" to \"M30\"` or greater (not including `Mxx_NVME` tiers).\n\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType\" to \"PROVISIONED\"`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1." }, "diskSizeGB" : { "type" : "number", @@ -23593,6 +23326,26 @@ "description" : "Configuration of nodes that comprise the cluster.", "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] }, + "configServerManagementMode" : { + "type" : "string", + "default" : "ATLAS_MANAGED", + "description" : "Config Server Management Mode for creating or updating a sharded cluster.\n\nWhen configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings.\n\nWhen configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server.", + "enum" : [ "ATLAS_MANAGED", "FIXED_TO_DEDICATED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + } + }, + "configServerType" : { + "type" : "string", + "description" : "Describes a sharded cluster's config server type.", + "enum" : [ "DEDICATED", "EMBEDDED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + }, + "readOnly" : true + }, "connectionStrings" : { "$ref" : "#/components/schemas/ClusterConnectionStrings" }, @@ -23628,6 +23381,17 @@ "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" } }, + "featureCompatibilityVersion" : { + "type" : "string", + "description" : "Feature compatibility version of the cluster.", + "readOnly" : true + }, + "featureCompatibilityVersionExpirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Feature compatibility version expiration date.", + "readOnly" : true + }, "globalClusterSelfManagedSharding" : { "type" : "boolean", "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen 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.\n\nWhen 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.\n\nThis setting cannot be changed once the cluster is deployed.", @@ -23674,6 +23438,9 @@ }, "readOnly" : true }, + "mongoDBEmployeeAccessGrant" : { + "$ref" : "#/components/schemas/EmployeeAccessGrantView" + }, "mongoDBMajorVersion" : { "type" : "string", "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", @@ -23693,7 +23460,7 @@ "description" : "Human-readable label that identifies the advanced cluster.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, "paused" : { "type" : "boolean", @@ -23707,6 +23474,16 @@ "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" } }, + "replicaSetScalingStrategy" : { + "type" : "string", + "default" : "WORKLOAD_TYPE", + "description" : "Set this field to configure the replica set scaling mode for your cluster.\n\nBy default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes.\n\nWhen configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads.\n\nWhen configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads.", + "enum" : [ "SEQUENTIAL", "WORKLOAD_TYPE", "NODE_TYPE" ], + "externalDocs" : { + "description" : "Modify the Replica Set Scaling Mode", + "url" : "https://dochub.mongodb.org/core/scale-nodes" + } + }, "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.", @@ -24577,6 +24354,257 @@ }, "title" : "mappings" }, + "ApiAtlasInvalidPolicyErrorDetailView" : { + "type" : "object", + "properties" : { + "detail" : { + "type" : "string", + "description" : "A string that provides a detailed description of a validation error.", + "readOnly" : true + } + } + }, + "ApiAtlasInvalidPolicyView" : { + "type" : "object", + "properties" : { + "body" : { + "type" : "string", + "description" : "A string that defines the permissions for the policy. The syntax used is the Cedar Policy language.", + "example" : " forbid (\n principal,\n action == cloud::Action::\"cluster.createEdit\",\n resource\n ) when {\n context.cluster.regions.contains(cloud::region::\"aws:us-east-1\")\n };\n", + "readOnly" : true + }, + "errors" : { + "type" : "array", + "description" : "List of validation errors.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasInvalidPolicyErrorDetailView" + }, + "readOnly" : true + } + } + }, + "ApiAtlasInvalidResourcePolicyCreateErrorView" : { + "type" : "object", + "properties" : { + "errorType" : { + "type" : "string", + "description" : "Human-readable label that displays the type of an error.", + "enum" : [ "POLICY_PARSING_ERROR", "POLICY_HAS_FAILED_VALIDATIONS", "POLICY_HAS_INVALID_PRINCIPAL", "POLICY_HAS_BODY_EXCEEDING_MAX_SIZE", "POLICY_HAS_UNEXPECTED_ENTITIES" ] + }, + "invalidPolicies" : { + "type" : "array", + "description" : "List of invalid policies containing details of their validation errors.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasInvalidPolicyView" + }, + "readOnly" : true + } + } + }, + "ApiAtlasNonCompliantResourceView" : { + "type" : "object", + "properties" : { + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization the resource belongs to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resourceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the non-compliant resource.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resourcePoliciesCausingNonCompliance" : { + "type" : "array", + "description" : "List of resource policies causing the resource to be considered non-compliant.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasResourcePolicyMetadataView" + }, + "readOnly" : true + }, + "resourceType" : { + "type" : "string", + "description" : "Human-readable label that displays the type of a resource.", + "enum" : [ "PROJECT", "CLUSTER" ], + "readOnly" : true + } + } + }, + "ApiAtlasPolicyCreateView" : { + "type" : "object", + "properties" : { + "body" : { + "type" : "string", + "description" : "A string that defines the permissions for the policy. The syntax used is the Cedar Policy language.", + "example" : " forbid (\n principal,\n action == cloud::Action::\"cluster.createEdit\",\n resource\n ) when {\n context.cluster.regions.contains(cloud::region::\"aws:us-east-1\")\n };\n" + } + }, + "required" : [ "body" ] + }, + "ApiAtlasPolicyMetadataView" : { + "type" : "object", + "properties" : { + "policyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "ApiAtlasPolicyView" : { + "type" : "object", + "properties" : { + "body" : { + "type" : "string", + "description" : "A string that defines the permissions for the policy. The syntax used is the Cedar Policy language.", + "example" : " forbid (\n principal,\n action == cloud::Action::\"cluster.createEdit\",\n resource\n ) when {\n context.cluster.regions.contains(cloud::region::\"aws:us-east-1\")\n };\n", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "ApiAtlasResourcePolicyCreateView" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that describes the atlas resource policy." + }, + "policies" : { + "type" : "array", + "description" : "List of policies that make up the atlas resource policy.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasPolicyCreateView" + } + } + }, + "required" : [ "name", "policies" ] + }, + "ApiAtlasResourcePolicyEditView" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that describes the atlas resource policy." + }, + "policies" : { + "type" : "array", + "description" : "List of policies that make up the atlas resource policy.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasPolicyCreateView" + } + } + } + }, + "ApiAtlasResourcePolicyMetadataView" : { + "type" : "object", + "properties" : { + "policiesCausingNonCompliance" : { + "type" : "array", + "description" : "List of policies that are in conflict with the current state of the resource.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasPolicyMetadataView" + }, + "readOnly" : true + }, + "resourcePolicyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the atlas resource policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resourcePolicyName" : { + "type" : "string", + "description" : "Human-readable label that describes the atlas resource policy.", + "readOnly" : true + } + } + }, + "ApiAtlasResourcePolicyView" : { + "type" : "object", + "properties" : { + "createdByUser" : { + "$ref" : "#/components/schemas/ApiAtlasUserMetadataView" + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time in UTC when the atlas resource policy was created.", + "example" : "2022-01-01T00:00:00Z", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the atlas resource policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastUpdatedByUser" : { + "$ref" : "#/components/schemas/ApiAtlasUserMetadataView" + }, + "lastUpdatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time in UTC when the atlas resource policy was last updated.", + "example" : "2022-01-01T00:00:00Z", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that describes the atlas resource policy.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization the atlas resource policy belongs to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "policies" : { + "type" : "array", + "description" : "List of policies that make up the atlas resource policy.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasPolicyView" + }, + "readOnly" : true + }, + "version" : { + "type" : "string", + "description" : "A string that identifies the version of the atlas resource policy.", + "example" : "v1", + "readOnly" : true + } + } + }, "ApiAtlasSnapshotScheduleView" : { "type" : "object", "properties" : { @@ -24653,6 +24681,27 @@ }, "required" : [ "clusterCheckpointIntervalMin", "clusterId", "dailySnapshotRetentionDays", "groupId", "monthlySnapshotRetentionMonths", "pointInTimeWindowHours", "snapshotIntervalHours", "snapshotRetentionDays", "weeklySnapshotRetentionWeeks" ] }, + "ApiAtlasUserMetadataView" : { + "type" : "object", + "description" : "The user that last updated the atlas resource policy.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies a user.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that describes a user.", + "readOnly" : true + } + }, + "readOnly" : true + }, "ApiBSONTimestampView" : { "type" : "object", "description" : "BSON timestamp that indicates when the checkpoint token entry in the oplog occurred.", @@ -24709,6 +24758,9 @@ "ApiError" : { "type" : "object", "properties" : { + "badRequestDetail" : { + "$ref" : "#/components/schemas/BadRequestDetail" + }, "detail" : { "type" : "string", "description" : "Describes the specific conditions or reasons that cause each type of error." @@ -24719,24 +24771,30 @@ "description" : "HTTP status code returned with this error.", "externalDocs" : { "url" : "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status" - } + }, + "readOnly" : true }, "errorCode" : { "type" : "string", - "description" : "Application error code returned with this error." + "description" : "Application error code returned with this error.", + "readOnly" : true }, "parameters" : { "type" : "array", "description" : "Parameters used to give more information about the error.", "items" : { - "type" : "object" - } + "type" : "object", + "readOnly" : true + }, + "readOnly" : true }, "reason" : { "type" : "string", - "description" : "Application error message returned with this error." + "description" : "Application error message returned with this error.", + "readOnly" : true } - } + }, + "required" : [ "error", "errorCode" ] }, "ApiHostView_Atlas" : { "type" : "object", @@ -24992,6 +25050,24 @@ } } }, + "ApiPrivateDownloadDeliveryUrl" : { + "type" : "object", + "description" : "One Uniform Resource Locator (URL) that points to the compressed snapshot files for manual download and the corresponding private endpoint.", + "properties" : { + "deliveryUrl" : { + "type" : "string", + "description" : "One Uniform Resource Locator that points to the compressed snapshot files for manual download." + }, + "endpointId" : { + "type" : "string", + "description" : "Unique 22-character alphanumeric string that identifies the private endpoint.", + "example" : "vpce-3bf78b0ddee411ba1", + "maxLength" : 22, + "minLength" : 22, + "pattern" : "^vpce-[0-9a-f]{17}$" + } + } + }, "ApiPublicUsageDetailsQueryRequest" : { "type" : "object", "description" : "Request body for an Invoice Usage Details query with filtering, pagination, and sort.", @@ -25085,7 +25161,12 @@ "ApiStreamsAWSRegionView" : { "type" : "string", "description" : "Atlas Streams AWS Regions.", - "enum" : [ "VIRGINIA_USA" ] + "enum" : [ "SYDNEY_AUS", "MUMBAI_IND", "FRANKFURT_DEU", "DUBLIN_IRL", "LONDON_GBR", "VIRGINIA_USA", "OREGON_USA", "SAOPAULO_BRA", "MONTREAL_CAN", "TOKYO_JPN", "SINGAPORE_SGP" ] + }, + "ApiStreamsAzureRegionView" : { + "type" : "string", + "description" : "Atlas Streams Azure Regions.", + "enum" : [ "VIRGINIA_USA", "AMSTERDAM_NLD" ] }, "ApiUserEventTypeViewForNdsGroup" : { "type" : "string", @@ -25309,6 +25390,15 @@ "required" : [ "created", "eventTypeName", "id" ], "title" : "API User Events" }, + "ApiVersion" : { + "type" : "object", + "properties" : { + "version" : { + "type" : "string", + "description" : "Object representing a version of the Atlas Admin API." + } + } + }, "AppServiceAlertConfigViewForNdsGroup" : { "type" : "object", "description" : "App Services metric alert configuration allows to select which app service conditions and events trigger alerts and how users are notified.", @@ -25731,7 +25821,9 @@ "enum" : [ "AVERAGE" ] }, "operator" : { - "$ref" : "#/components/schemas/Operator" + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, "threshold" : { "type" : "number", @@ -25771,6 +25863,11 @@ "description" : "Atlas Data Federation Azure Regions.", "enum" : [ "VIRGINIA_USA", "AMSTERDAM_NLD" ] }, + "AtlasDataFederationGCPRegion" : { + "type" : "string", + "description" : "Atlas Data Federation GCP Regions.", + "enum" : [ "IOWA_USA", "BELGIUM_EU" ] + }, "AtlasOrganization" : { "type" : "object", "description" : "Details that describe the organization.", @@ -25811,6 +25908,122 @@ }, "required" : [ "name" ] }, + "AtlasResourcePolicyAuditForOrg" : { + "type" : "object", + "description" : "Atlas resource policy audits indicate org level changes to resource policies", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "RESOURCE_POLICY_CREATED", "RESOURCE_POLICY_MODIFIED", "RESOURCE_POLICY_DELETED" ], + "example" : "RESOURCE_POLICY_CREATED", + "title" : "Atlas Resource Policy Audit Types" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "resourcePolicyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the resource policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Atlas Resource Policy Audits" + }, "AtlasSearchAnalyzer" : { "type" : "object", "properties" : { @@ -26326,6 +26539,15 @@ "AzureHardwareSpec" : { "type" : "object", "properties" : { + "diskIOPS" : { + "type" : "integer", + "format" : "int32", + "description" : "Target throughput desired for storage attached to your Azure-provisioned cluster. Change this parameter if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" : \"Azure\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : \"M40\"` or greater not including `Mxx_NVME` tiers.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://www.mongodb.com/docs/atlas/customize-storage/#extend-iops-on-azure" + } + }, "instanceSize" : { "type" : "string", "description" : "Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts of the node type.", @@ -26342,6 +26564,15 @@ "AzureHardwareSpec20240805" : { "type" : "object", "properties" : { + "diskIOPS" : { + "type" : "integer", + "format" : "int32", + "description" : "Target throughput desired for storage attached to your Azure-provisioned cluster. Change this parameter if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" : \"Azure\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : \"M40\"` or greater not including `Mxx_NVME` tiers.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://www.mongodb.com/docs/atlas/customize-storage/#extend-iops-on-azure" + } + }, "diskSizeGB" : { "type" : "number", "format" : "double", @@ -26469,7 +26700,7 @@ "status" : { "type" : "string", "description" : "State of the Encryption At Rest private endpoint.", - "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "ACTIVE", "FAILED" ], + "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "ACTIVE", "FAILED", "PENDING_RECREATION", "DELETING" ], "readOnly" : true } }, @@ -26802,7 +27033,7 @@ "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to create an online archive.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "collName" : { @@ -26886,7 +27117,7 @@ "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to create an online archive.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "collName" : { @@ -26989,7 +27220,7 @@ "description" : "Human-readable label that identifies the cluster containing the snapshots you want to retrieve.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -27146,7 +27377,7 @@ "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\"`.\n\nIf the target cluster doesn't have backup enabled, two resources return parameters with empty values:\n\n- **Get All Snapshots** endpoint returns an empty results array without **clusterId** elements\n- **Get a Snapshot** endpoint doesn't return a **clusterId** parameter.\n\nTo return a response with the **clusterId** parameter, either use the **delivery.targetClusterName** parameter or enable backup on the target cluster.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, "targetGroupId" : { "type" : "string", @@ -27407,6 +27638,20 @@ } } }, + "BadRequestDetail" : { + "type" : "object", + "description" : "Bad request detail.", + "properties" : { + "fields" : { + "type" : "array", + "description" : "Describes all violations in a client request.", + "items" : { + "$ref" : "#/components/schemas/FieldViolation" + } + } + }, + "readOnly" : true + }, "BaseAtlasDataLakeRegion" : { "type" : "object", "description" : "Name of the region to which the data lake routes client connections.", @@ -27414,6 +27659,8 @@ "$ref" : "#/components/schemas/ApiAtlasDataLakeAWSRegionView" }, { "$ref" : "#/components/schemas/AtlasDataFederationAzureRegion" + }, { + "$ref" : "#/components/schemas/AtlasDataFederationGCPRegion" } ] }, "BaseCloudProviderInstanceSize" : { @@ -27481,6 +27728,8 @@ "description" : "Name of the cloud provider region hosting Atlas Stream Processing.", "oneOf" : [ { "$ref" : "#/components/schemas/ApiStreamsAWSRegionView" + }, { + "$ref" : "#/components/schemas/ApiStreamsAzureRegionView" } ] }, "BasicBSONList" : { @@ -28370,7 +28619,7 @@ "description" : "Human-readable label that identifies the cluster.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "nodeCount" : { @@ -28422,6 +28671,11 @@ "format" : "date-time", "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." }, + "description" : { + "type" : "string", + "description" : "Description of this database user.", + "maxLength" : 100 + }, "groupId" : { "type" : "string", "description" : "Unique 24-hexadecimal digit string that identifies the project.", @@ -28600,6 +28854,123 @@ "description" : "Details that describe the features linked to the Amazon Web Services (AWS) Identity and Access Management (IAM) role.", "required" : [ "providerName" ] }, + "CloudProviderAccessAWSIAMRoleRequest" : { + "type" : "object", + "description" : "Details that describe the features linked to the Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "properties" : { + "atlasAWSAccountArn" : { + "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.", + "example" : "arn:aws:iam::772401394250:role/my-test-aws-role", + "maxLength" : 2048, + "minLength" : 20, + "readOnly" : true + }, + "atlasAssumedRoleExternalId" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique external ID that MongoDB Cloud uses when it assumes the IAM role in your Amazon Web Services (AWS) account.", + "readOnly" : true + }, + "authorizedDate" : { + "type" : "string", + "format" : "date-time", + "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.", + "readOnly" : true + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "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.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider of the role.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "roleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + }, + "required" : [ "providerName" ] + }, + "CloudProviderAccessAWSIAMRoleRequestUpdate" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessRoleRequestUpdate" + }, { + "type" : "object", + "properties" : { + "atlasAWSAccountArn" : { + "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.", + "example" : "arn:aws:iam::772401394250:role/my-test-aws-role", + "maxLength" : 2048, + "minLength" : 20, + "readOnly" : true + }, + "atlasAssumedRoleExternalId" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique external ID that MongoDB Cloud uses when it assumes the IAM role in your Amazon Web Services (AWS) account.", + "readOnly" : true + }, + "authorizedDate" : { + "type" : "string", + "format" : "date-time", + "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.", + "readOnly" : true + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "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.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "iamAssumedRoleArn" : { + "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", + "maxLength" : 2048, + "minLength" : 20 + }, + "roleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + } ], + "description" : "Details that describe the features linked to the Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "required" : [ "providerName" ] + }, "CloudProviderAccessAzureServicePrincipal" : { "type" : "object", "allOf" : [ { @@ -28662,6 +29033,130 @@ "description" : "Details that describe the features linked to the Azure Service Principal.", "required" : [ "providerName" ] }, + "CloudProviderAccessAzureServicePrincipalRequest" : { + "type" : "object", + "description" : "Details that describe the features linked to the Azure Service Principal.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "atlasAzureAppId" : { + "type" : "string", + "description" : "Azure Active Directory Application ID of Atlas.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this Azure Service Principal was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Azure Service Principal.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "lastUpdatedDate" : { + "type" : "string", + "format" : "date-time", + "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.", + "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.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "tenantId" : { + "type" : "string", + "description" : "UUID String that identifies the Azure Active Directory Tenant ID.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + } + }, + "required" : [ "providerName" ] + }, + "CloudProviderAccessAzureServicePrincipalRequestUpdate" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessRoleRequestUpdate" + }, { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "atlasAzureAppId" : { + "type" : "string", + "description" : "Azure Active Directory Application ID of Atlas.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this Azure Service Principal was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Azure Service Principal.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "lastUpdatedDate" : { + "type" : "string", + "format" : "date-time", + "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.", + "readOnly" : true + }, + "servicePrincipalId" : { + "type" : "string", + "description" : "UUID string that identifies the Azure Service Principal.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "tenantId" : { + "type" : "string", + "description" : "UUID String that identifies the Azure Active Directory Tenant ID.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + } + } + } ], + "description" : "Details that describe the features linked to the Azure Service Principal.", + "required" : [ "providerName" ] + }, "CloudProviderAccessDataLakeFeatureUsage" : { "type" : "object", "allOf" : [ { @@ -28788,6 +29283,92 @@ } } }, + "CloudProviderAccessGCPServiceAccount" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, { + "type" : "object", + "properties" : { + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this Google Service Account was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Google Service Account.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "gcpServiceAccountForAtlas" : { + "type" : "string", + "description" : "Email address for the Google Service Account created by Atlas.", + "maxLength" : 82, + "minLength" : 57, + "pattern" : "^mongodb-atlas-[0-9a-z]{16}@p-[0-9a-z]{24}.iam.gserviceaccount.com$" + }, + "roleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + } ], + "description" : "Details that describe the features linked to the GCP Service Account.", + "required" : [ "providerName" ] + }, + "CloudProviderAccessGCPServiceAccountRequest" : { + "type" : "object", + "description" : "Details that describe the features linked to the GCP Service Account.", + "properties" : { + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this GCP Service Account was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this GCP Service Account.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "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" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "readOnly" : true + } + }, + "required" : [ "providerName" ] + }, + "CloudProviderAccessGCPServiceAccountRequestUpdate" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessRoleRequestUpdate" + } ], + "description" : "Details that describe the features linked to the GCP Service Account.", + "required" : [ "providerName" ] + }, "CloudProviderAccessPushBasedLogExportFeatureUsage" : { "type" : "object", "allOf" : [ { @@ -28808,20 +29389,63 @@ "discriminator" : { "mapping" : { "AWS" : "#/components/schemas/CloudProviderAccessAWSIAMRole", - "AZURE" : "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + "AZURE" : "#/components/schemas/CloudProviderAccessAzureServicePrincipal", + "GCP" : "#/components/schemas/CloudProviderAccessGCPServiceAccount" + }, + "propertyName" : "providerName" + }, + "properties" : { + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider of the role.", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, + "required" : [ "providerName" ] + }, + "CloudProviderAccessRoleRequest" : { + "type" : "object", + "description" : "Cloud provider access role.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/CloudProviderAccessAWSIAMRoleRequest", + "AZURE" : "#/components/schemas/CloudProviderAccessAzureServicePrincipalRequest", + "GCP" : "#/components/schemas/CloudProviderAccessGCPServiceAccountRequest" }, "propertyName" : "providerName" }, "oneOf" : [ { - "$ref" : "#/components/schemas/CloudProviderAccessAWSIAMRole" + "$ref" : "#/components/schemas/CloudProviderAccessAWSIAMRoleRequest" + }, { + "$ref" : "#/components/schemas/CloudProviderAccessAzureServicePrincipalRequest" }, { - "$ref" : "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + "$ref" : "#/components/schemas/CloudProviderAccessGCPServiceAccountRequest" } ], "properties" : { "providerName" : { "type" : "string", "description" : "Human-readable label that identifies the cloud provider of the role.", - "enum" : [ "AWS", "AZURE" ] + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, + "required" : [ "providerName" ] + }, + "CloudProviderAccessRoleRequestUpdate" : { + "type" : "object", + "description" : "Cloud provider access role.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/CloudProviderAccessAWSIAMRoleRequestUpdate", + "AZURE" : "#/components/schemas/CloudProviderAccessAzureServicePrincipalRequestUpdate", + "GCP" : "#/components/schemas/CloudProviderAccessGCPServiceAccountRequestUpdate" + }, + "propertyName" : "providerName" + }, + "properties" : { + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider of the role.", + "enum" : [ "AWS", "AZURE", "GCP" ] } }, "required" : [ "providerName" ] @@ -28835,6 +29459,13 @@ "items" : { "$ref" : "#/components/schemas/CloudProviderAccessAWSIAMRole" } + }, + "azureServicePrincipals" : { + "type" : "array", + "description" : "List that contains the Azure Service Principals registered with MongoDB Cloud.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + } } } }, @@ -29217,7 +29848,7 @@ "example" : "cluster1", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -29310,6 +29941,7 @@ }, "diskGBEnabled" : { "type" : "boolean", + "default" : false, "description" : "Flag that indicates whether someone enabled disk auto-scaling for this cluster." } }, @@ -29339,10 +29971,12 @@ "properties" : { "enabled" : { "type" : "boolean", + "default" : false, "description" : "Flag that indicates whether cluster tier auto-scaling is enabled. Set to `true` to enable cluster tier auto-scaling. If enabled, you must specify a value for **providerSettings.autoScaling.compute.maxInstanceSize** also. Set to `false` to disable cluster tier auto-scaling." }, "scaleDownEnabled" : { "type" : "boolean", + "default" : false, "description" : "Flag that indicates whether the cluster tier can scale down. This is required if **autoScaling.compute.enabled** is `true`. If you enable this option, specify a value for **providerSettings.autoScaling.compute.minInstanceSize**." } } @@ -29377,14 +30011,14 @@ "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.", + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to Atlas through the interface endpoint that the key names. If the cluster uses an optimized connection string, `awsPrivateLinkSrv` contains the optimized connection string. If the cluster has the non-optimized (legacy) connection string, `awsPrivateLinkSrv` contains the non-optimized connection string even if an optimized connection string is also present.", "externalDocs" : { "description" : "Network Peering Connection", "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" }, "readOnly" : true }, - "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.", + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to Atlas through the interface endpoint that the key names. If the cluster uses an optimized connection string, `awsPrivateLinkSrv` contains the optimized connection string. If the cluster has the non-optimized (legacy) connection string, `awsPrivateLinkSrv` contains the non-optimized connection string even if an optimized connection string is also present.", "externalDocs" : { "description" : "Network Peering Connection", "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" @@ -29464,6 +30098,26 @@ "description" : "Configuration of nodes that comprise the cluster.", "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] }, + "configServerManagementMode" : { + "type" : "string", + "default" : "ATLAS_MANAGED", + "description" : "Config Server Management Mode for creating or updating a sharded cluster.\n\nWhen configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings.\n\nWhen configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server.", + "enum" : [ "ATLAS_MANAGED", "FIXED_TO_DEDICATED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + } + }, + "configServerType" : { + "type" : "string", + "description" : "Describes a sharded cluster's config server type.", + "enum" : [ "DEDICATED", "EMBEDDED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + }, + "readOnly" : true + }, "connectionStrings" : { "$ref" : "#/components/schemas/ClusterConnectionStrings" }, @@ -29492,6 +30146,17 @@ "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" } }, + "featureCompatibilityVersion" : { + "type" : "string", + "description" : "Feature compatibility version of the cluster.", + "readOnly" : true + }, + "featureCompatibilityVersionExpirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Feature compatibility version expiration date.", + "readOnly" : true + }, "globalClusterSelfManagedSharding" : { "type" : "boolean", "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen 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.\n\nWhen 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.\n\nThis setting cannot be changed once the cluster is deployed.", @@ -29538,6 +30203,9 @@ }, "readOnly" : true }, + "mongoDBEmployeeAccessGrant" : { + "$ref" : "#/components/schemas/EmployeeAccessGrantView" + }, "mongoDBMajorVersion" : { "type" : "string", "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", @@ -29557,7 +30225,7 @@ "description" : "Human-readable label that identifies the cluster.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, "paused" : { "type" : "boolean", @@ -29571,6 +30239,24 @@ "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" } }, + "redactClientLogData" : { + "type" : "boolean", + "description" : "Enable or disable log redaction.", + "externalDocs" : { + "description" : "This options corresponds to the ``security.redactClientLogData`` cluster parameter.\n\nThis setting configures the ``mongod`` or ``mongos`` to redact any message accompanying a given log event before logging. This prevents the program from writing potentially sensitive data stored on the database to the diagnostic log. Metadata such as error or operation codes, line numbers, and source file names are still visible in the logs.\n\nUse ``redactClientLogData`` in conjunction with Encryption at Rest and TLS/SSL (Transport Encryption) to assist compliance with regulatory requirements.", + "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.redactClientLogData" + } + }, + "replicaSetScalingStrategy" : { + "type" : "string", + "default" : "WORKLOAD_TYPE", + "description" : "Set this field to configure the replica set scaling mode for your cluster.\n\nBy default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes.\n\nWhen configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads.\n\nWhen configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads.", + "enum" : [ "SEQUENTIAL", "WORKLOAD_TYPE", "NODE_TYPE" ], + "externalDocs" : { + "description" : "Modify the Replica Set Scaling Mode", + "url" : "https://dochub.mongodb.org/core/scale-nodes" + } + }, "replicationSpecs" : { "type" : "array", "description" : "List of settings that configure your cluster regions. This array has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations.", @@ -29680,6 +30366,16 @@ "ClusterDescriptionProcessArgs" : { "type" : "object", "properties" : { + "changeStreamOptionsPreAndPostImagesExpireAfterSeconds" : { + "type" : "integer", + "format" : "int32", + "default" : -1, + "description" : "The minimum pre- and post-image retention time in seconds.", + "externalDocs" : { + "description" : "This option corresponds to the ``changeStreamOptions.preAndPostImages.expireAfterSeconds`` cluster parameter. This setting controls the retention policy of change stream pre- and post-images. Pre- and post-images are the versions of a document before and after document modification, respectively. ``expireAfterSeconds`` controls how long MongoDB retains pre- and post-images. When set to -1 (off), MongoDB uses the default retention policy: pre- and post-images are retained until the corresponding change stream events are removed from the oplog. To set the minimum pre- and post-image retention time, specify an integer value greater than zero. Setting this too low could increase the risk of interrupting Realm sync or triggers processing. The default value is -1 (off).", + "url" : "https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/changeStreamOptions/#mongodb-parameter-param.changeStreamOptions.preAndPostImages.expireAfterSeconds" + } + }, "chunkMigrationConcurrency" : { "type" : "integer", "format" : "int32", @@ -29689,6 +30385,15 @@ "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.chunkMigrationConcurrency" } }, + "defaultMaxTimeMS" : { + "type" : "integer", + "format" : "int32", + "description" : "Default time limit in milliseconds for individual read operations to complete.", + "externalDocs" : { + "description" : "This option corresponds to the defaultMaxTimeMS cluster parameter.", + "url" : "https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/defaultMaxTimeMS/" + } + }, "defaultReadConcern" : { "type" : "string", "default" : "available", @@ -29719,7 +30424,7 @@ }, "javascriptEnabled" : { "type" : "boolean", - "description" : "Flag that indicates whether the cluster allows execution of operations that perform server-side executions of JavaScript.", + "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" @@ -29807,6 +30512,16 @@ "ClusterDescriptionProcessArgs20240805" : { "type" : "object", "properties" : { + "changeStreamOptionsPreAndPostImagesExpireAfterSeconds" : { + "type" : "integer", + "format" : "int32", + "default" : -1, + "description" : "The minimum pre- and post-image retention time in seconds.", + "externalDocs" : { + "description" : "This option corresponds to the ``changeStreamOptions.preAndPostImages.expireAfterSeconds`` cluster parameter. This setting controls the retention policy of change stream pre- and post-images. Pre- and post-images are the versions of a document before and after document modification, respectively. ``expireAfterSeconds`` controls how long MongoDB retains pre- and post-images. When set to -1 (off), MongoDB uses the default retention policy: pre- and post-images are retained until the corresponding change stream events are removed from the oplog. To set the minimum pre- and post-image retention time, specify an integer value greater than zero. Setting this too low could increase the risk of interrupting Realm sync or triggers processing. The default value is -1 (off).", + "url" : "https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/changeStreamOptions/#mongodb-parameter-param.changeStreamOptions.preAndPostImages.expireAfterSeconds" + } + }, "chunkMigrationConcurrency" : { "type" : "integer", "format" : "int32", @@ -29816,6 +30531,15 @@ "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.chunkMigrationConcurrency" } }, + "defaultMaxTimeMS" : { + "type" : "integer", + "format" : "int32", + "description" : "Default time limit in milliseconds for individual read operations to complete.", + "externalDocs" : { + "description" : "This option corresponds to the defaultMaxTimeMS cluster parameter.", + "url" : "https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/defaultMaxTimeMS/" + } + }, "defaultWriteConcern" : { "type" : "string", "description" : "Default level of acknowledgment requested from MongoDB for write operations when none is specified by the driver.", @@ -29826,7 +30550,7 @@ }, "javascriptEnabled" : { "type" : "boolean", - "description" : "Flag that indicates whether the cluster allows execution of operations that perform server-side executions of JavaScript.", + "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" @@ -30093,7 +30817,7 @@ "description" : "Human-readable label that identifies the cluster that undergoes outage simulation.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "groupId" : { @@ -30687,7 +31411,8 @@ "discriminator" : { "mapping" : { "AWS" : "#/components/schemas/AWSCreateDataProcessRegionView", - "AZURE" : "#/components/schemas/AzureCreateDataProcessRegionView" + "AZURE" : "#/components/schemas/AzureCreateDataProcessRegionView", + "GCP" : "#/components/schemas/GCPCreateDataProcessRegionView" }, "propertyName" : "cloudProvider" }, @@ -31184,11 +31909,11 @@ }, "roleId" : { "type" : "string", - "description" : "Unique identifier of the role that Data Federation can use to access the data stores.Required if specifying cloudProviderConfig." + "description" : "Unique identifier of the role that Data Federation can use to access the data stores. Required if specifying cloudProviderConfig." }, "servicePrincipalId" : { "type" : "string", - "description" : "The ID of the Service Principal for which there is an access policyfor Atlas to access Azure resources.", + "description" : "The ID of the Service Principal for which there is an access policy for Atlas to access Azure resources.", "readOnly" : true }, "tenantId" : { @@ -31199,6 +31924,22 @@ }, "required" : [ "roleId" ] }, + "DataFederationGCPCloudProviderConfig" : { + "type" : "object", + "description" : "Configuration for running Data Federation in GCP.", + "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" : { + "type" : "string", + "description" : "Unique identifier of the role that Data Federation can use to access the data stores. Required if specifying cloudProviderConfig." + } + }, + "required" : [ "roleId" ] + }, "DataFederationLimit" : { "type" : "object", "description" : "Details of user managed limits.", @@ -31206,6 +31947,7 @@ "mapping" : { "atlas.project.deployment.clusters" : "#/components/schemas/DefaultLimit", "atlas.project.deployment.nodesPerPrivateLinkRegion" : "#/components/schemas/DefaultLimit", + "atlas.project.deployment.salesSoldM0s" : "#/components/schemas/DefaultLimit", "atlas.project.deployment.serverlessMTMs" : "#/components/schemas/DefaultLimit", "atlas.project.security.databaseAccess.customRoles" : "#/components/schemas/DefaultLimit", "atlas.project.security.databaseAccess.users" : "#/components/schemas/DefaultLimit", @@ -31546,9 +32288,12 @@ }, "azure" : { "$ref" : "#/components/schemas/DataFederationAzureCloudProviderConfig" + }, + "gcp" : { + "$ref" : "#/components/schemas/DataFederationGCPCloudProviderConfig" } }, - "title" : "Data Lake Cloud Provider" + "title" : "Data Federation Cloud Provider" }, "DataLakeDLSAWSStore" : { "type" : "object", @@ -31589,7 +32334,7 @@ "cloudProvider" : { "type" : "string", "description" : "Name of the cloud service that hosts the Federated Database Instance's infrastructure.", - "enum" : [ "AWS", "AZURE" ] + "enum" : [ "AWS", "AZURE", "GCP" ] }, "region" : { "$ref" : "#/components/schemas/BaseAtlasDataLakeRegion" @@ -32011,7 +32756,7 @@ "example" : "cluster1", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -32253,7 +32998,9 @@ "enum" : [ "AVERAGE" ] }, "operator" : { - "$ref" : "#/components/schemas/Operator" + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, "threshold" : { "type" : "number", @@ -32296,7 +33043,8 @@ "discriminator" : { "mapping" : { "AWS" : "#/components/schemas/AWSDataProcessRegionView", - "AZURE" : "#/components/schemas/AzureDataProcessRegionView" + "AZURE" : "#/components/schemas/AzureDataProcessRegionView", + "GCP" : "#/components/schemas/GCPDataProcessRegionView" }, "propertyName" : "cloudProvider" }, @@ -32304,7 +33052,7 @@ "cloudProvider" : { "type" : "string", "description" : "Human-readable label that identifies the Cloud service provider where you store your archived data.", - "enum" : [ "AWS", "AZURE" ], + "enum" : [ "AWS", "AZURE", "GCP" ], "readOnly" : true } }, @@ -32531,7 +33279,7 @@ "action" : { "type" : "string", "description" : "Human-readable label that identifies the privilege action.", - "enum" : [ "FIND", "INSERT", "REMOVE", "UPDATE", "BYPASS_DOCUMENT_VALIDATION", "USE_UUID", "KILL_OP", "CREATE_COLLECTION", "CREATE_INDEX", "DROP_COLLECTION", "ENABLE_PROFILER", "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", "STORAGE_GET_CONFIG", "STORAGE_SET_CONFIG", "FLUSH_ROUTER_CONFIG", "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" ] + "enum" : [ "FIND", "INSERT", "REMOVE", "UPDATE", "BYPASS_DOCUMENT_VALIDATION", "USE_UUID", "KILL_OP", "CREATE_COLLECTION", "CREATE_INDEX", "DROP_COLLECTION", "ENABLE_PROFILER", "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", "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", @@ -32810,7 +33558,7 @@ "title" : "Cps Backup Event Types" }, { "type" : "string", - "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEXES_RESTORE_FAILED" ], + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEXES_RESTORE_FAILED", "FTS_INDEXES_SYNONYM_MAPPING_INVALID" ], "title" : "FTS Index Audit Types" }, { "type" : "string", @@ -32953,7 +33701,7 @@ "title" : "Encryption Event Types" }, { "type" : "string", - "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEXES_RESTORE_FAILED" ], + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEXES_RESTORE_FAILED", "FTS_INDEXES_SYNONYM_MAPPING_INVALID" ], "title" : "FTS Index Audit Types" }, { "type" : "string", @@ -33218,7 +33966,7 @@ "title" : "Tenant Backup Event Types" }, { "type" : "string", - "enum" : [ "CLUSTER_VERSION_FIXED", "CLUSTER_VERSION_UNFIXED", "CLUSTER_FCV_FIXED", "CLUSTER_FCV_UNFIXED", "AGENT_VERSION_FIXED", "AGENT_VERSION_UNFIXED", "FIXED_VERSION_UPDATED", "FIXED_AGENT_VERSION_UPDATED", "CLUSTER_FCV_DOWNGRADED" ], + "enum" : [ "CLUSTER_VERSION_FIXED", "CLUSTER_VERSION_UNFIXED", "CLUSTER_FCV_FIXED", "CLUSTER_FCV_UNFIXED", "CLUSTER_FCV_EXPIRATION_DATE_UPDATED", "AGENT_VERSION_FIXED", "AGENT_VERSION_UNFIXED", "FIXED_VERSION_UPDATED", "FIXED_AGENT_VERSION_UPDATED", "CLUSTER_FCV_DOWNGRADED", "CLUSTER_BINARY_VERSION_DOWNGRADED", "CLUSTER_BINARY_VERSION_UPGRADED" ], "title" : "Version Audit Types" } ] }, @@ -33542,7 +34290,6 @@ }, "hostnameSchemaType" : { "type" : "string", - "default" : "PUBLIC", "description" : "The network type to use between the migration host and the destination cluster.", "enum" : [ "PUBLIC", "PRIVATE_LINK", "VPC_PEERING" ] }, @@ -33666,28 +34413,19 @@ "createdAt" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when someone created this export job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "description" : "Date and time when a user or Atlas created the Export Job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", "readOnly" : true }, "customData" : { "type" : "array", - "description" : "Collection of key-value pairs that represent custom data for the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes.", + "description" : "Collection of key-value pairs that represent custom data for the metadata file that MongoDB Cloud uploads when the Export Job finishes.", "items" : { "$ref" : "#/components/schemas/BackupLabel" } }, - "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\"`.", - "items" : { - "type" : "string", - "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download." - }, - "readOnly" : true - }, "exportBucketId" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket to export to.", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -33700,7 +34438,7 @@ "finishedAt" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when this export job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "description" : "Date and time when this Export Job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", "readOnly" : true }, "id" : { @@ -33726,7 +34464,7 @@ }, "prefix" : { "type" : "string", - "description" : "Full path on the cloud provider bucket to the folder where the snapshot is exported.", + "description" : "Prefix used for all blob storage objects uploaded as part of the Export Job.", "pattern" : "/exported_snapshots/\\{ORG-NAME\\}/\\{PROJECT-NAME\\}/\\{CLUSTER-NAME\\}/\\{SNAPSHOT-INITIATION-DATE\\}/\\{TIMESTAMP\\}", "readOnly" : true }, @@ -33740,7 +34478,7 @@ }, "state" : { "type" : "string", - "description" : "State of the export job.", + "description" : "State of the Export Job.", "enum" : [ "Cancelled", "Failed", "InProgress", "Queued", "Successful" ], "readOnly" : true } @@ -33759,7 +34497,7 @@ }, "exportBucketId" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket to export to.", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -33960,7 +34698,15 @@ "properties" : { "downloadUrl" : { "type" : "string", - "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", + "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.", + "items" : { + "$ref" : "#/components/schemas/ApiPrivateDownloadDeliveryUrl" + }, "readOnly" : true }, "replicaSetName" : { @@ -34388,7 +35134,7 @@ "description" : "One or more Uniform Resource Locators (URLs) that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", "items" : { "type" : "string", - "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download." + "description" : "One Uniform Resource Locator that points to the compressed snapshot files for manual download." }, "readOnly" : true }, @@ -34457,6 +35203,14 @@ "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`.", "minimum" : 1199145600 }, + "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.", + "items" : { + "$ref" : "#/components/schemas/ApiPrivateDownloadDeliveryUrl" + }, + "readOnly" : true + }, "snapshotId" : { "type" : "string", "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", @@ -34470,7 +35224,7 @@ "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.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, "targetGroupId" : { "type" : "string", @@ -34510,7 +35264,7 @@ "description" : "Human-readable label that identifies the cluster with the Snapshot you want to return.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "copySettings" : { @@ -34611,7 +35365,7 @@ "description" : "Human-readable label that identifies the cluster with the Snapshot you want to return.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "copySettings" : { @@ -34706,9 +35460,15 @@ "additionalProperties" : { "type" : "object", "description" : "The stats associated with the stream processor.", + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor" + }, "readOnly" : true }, "description" : "The stats associated with the stream processor.", + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor" + }, "readOnly" : true }, "EARPrivateEndpoint" : { @@ -34751,7 +35511,7 @@ "status" : { "type" : "string", "description" : "State of the Encryption At Rest private endpoint.", - "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "ACTIVE", "FAILED" ], + "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "ACTIVE", "FAILED", "PENDING_RECREATION", "DELETING" ], "readOnly" : true } }, @@ -34791,6 +35551,36 @@ "required" : [ "typeName" ], "title" : "Email Notification" }, + "EmployeeAccessGrantView" : { + "type" : "object", + "description" : "MongoDB employee granted access level and expiration for a cluster.", + "properties" : { + "expirationTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Expiration date for the employee access grant." + }, + "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.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "required" : [ "expirationTime", "grantType" ] + }, "EncryptionAtRest" : { "type" : "object", "properties" : { @@ -34805,27 +35595,6 @@ } } }, - "EncryptionAtRestPrivateEndpointRequest" : { - "type" : "object", - "description" : "Create or delete private endpoints from the specified regions list.", - "properties" : { - "cloudProvider" : { - "type" : "string", - "description" : "Cloud service provider name.", - "enum" : [ "AZURE" ] - }, - "regions" : { - "type" : "array", - "description" : "List of regions.", - "items" : { - "type" : "string" - }, - "uniqueItems" : true - } - }, - "required" : [ "cloudProvider" ], - "title" : "Encryption At Rest Private Endpoints setup." - }, "EncryptionKeyAlertConfigViewForNdsGroup" : { "type" : "object", "description" : "Encryption key alert configuration allows to select thresholds which trigger alerts and how users are notified.", @@ -35051,7 +35820,7 @@ "title" : "Export Bucket Audit Types" }, { "type" : "string", - "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEX_CREATED", "FTS_INDEX_UPDATED", "FTS_INDEX_DELETED", "FTS_INDEX_CLEANED_UP", "FTS_INDEXES_RESTORED", "FTS_INDEXES_RESTORE_FAILED" ], + "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" : "FTS Index Audit Types" }, { "type" : "string", @@ -35071,7 +35840,7 @@ "title" : "Group Integration 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_ENOUGH_DISK_SPACE", "HOST_NOT_ENOUGH_DISK_SPACE" ], + "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_ENOUGH_DISK_SPACE", "HOST_NOT_ENOUGH_DISK_SPACE" ], "title" : "Host Event Types" }, { "type" : "string", @@ -35083,7 +35852,7 @@ "title" : "Index Build 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_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_SSL_ROTATED", "CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER", "CLUSTER_INSTANCE_SSL_REVOKED", "RELOAD_SSL_ON_PROCESSES", "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", "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", "MOVE_SKIPPED", "PROXY_RESTARTED", "PROXY_PANICKED", "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", "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", "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", "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", "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", "PENDING_INDEXES_DELETED", "PENDING_INDEXES_CANCELED", "PROCESS_RESTART_REQUESTED", "AUTO_HEALING_ACTION", "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", "CLUSTER_FORCE_RECONFIG_REQUESTED", "PROJECT_BYPASSED_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", "ATLAS_SQL_SCHEDULED_UPDATE_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_MODIFIED", "ATLAS_SQL_SCHEDULED_UPDATE_REMOVED" ], + "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_SSL_ROTATED", "CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER", "CLUSTER_INSTANCE_SSL_REVOKED", "RELOAD_SSL_ON_PROCESSES", "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", "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", "MOVE_SKIPPED", "PROXY_RESTARTED", "PROXY_PANICKED", "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", "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", "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", "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", "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", "CLUSTER_FORCE_RECONFIG_REQUESTED", "PROJECT_BYPASSED_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" ], "title" : "NDS Audit Types" }, { "type" : "string", @@ -35183,7 +35952,7 @@ "title" : "User Event Types" }, { "type" : "string", - "enum" : [ "CLUSTER_VERSION_FIXED", "CLUSTER_VERSION_UNFIXED", "CLUSTER_FCV_FIXED", "CLUSTER_FCV_UNFIXED", "AGENT_VERSION_FIXED", "AGENT_VERSION_UNFIXED", "FIXED_VERSION_UPDATED", "FIXED_AGENT_VERSION_UPDATED", "CLUSTER_FCV_DOWNGRADED" ], + "enum" : [ "CLUSTER_VERSION_FIXED", "CLUSTER_VERSION_UNFIXED", "CLUSTER_FCV_FIXED", "CLUSTER_FCV_UNFIXED", "CLUSTER_FCV_EXPIRATION_DATE_UPDATED", "AGENT_VERSION_FIXED", "AGENT_VERSION_UNFIXED", "FIXED_VERSION_UPDATED", "FIXED_AGENT_VERSION_UPDATED", "CLUSTER_FCV_DOWNGRADED", "CLUSTER_BINARY_VERSION_DOWNGRADED", "CLUSTER_BINARY_VERSION_UPGRADED" ], "title" : "Version Audit Types" }, { "type" : "string", @@ -35253,6 +36022,10 @@ "type" : "string", "enum" : [ "GROUP_TAGS_MODIFIED" ], "title" : "Resource Event Types" + }, { + "type" : "string", + "enum" : [ "RESOURCE_POLICY_CREATED", "RESOURCE_POLICY_MODIFIED", "RESOURCE_POLICY_DELETED" ], + "title" : "Atlas Resource Policy Audit Types" } ] }, "EventViewForNdsGroup" : { @@ -35331,6 +36104,8 @@ "$ref" : "#/components/schemas/UserEventViewForOrg" }, { "$ref" : "#/components/schemas/ResourceEventViewForOrg" + }, { + "$ref" : "#/components/schemas/AtlasResourcePolicyAuditForOrg" } ] }, "ExampleResourceResponse20230101" : { @@ -35391,7 +36166,7 @@ }, "ExportStatus" : { "type" : "object", - "description" : "State of the export job for the collections on the replica set only.", + "description" : "State of the Export Job.", "properties" : { "exportedCollections" : { "type" : "integer", @@ -35426,7 +36201,7 @@ "FTSIndexAuditTypeView" : { "type" : "string", "description" : "Unique identifier of event type.", - "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEX_CREATED", "FTS_INDEX_UPDATED", "FTS_INDEX_DELETED", "FTS_INDEX_CLEANED_UP", "FTS_INDEXES_RESTORED", "FTS_INDEXES_RESTORE_FAILED" ], + "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" ], "example" : "FTS_INDEX_CREATED", "title" : "FTS Index Audit Types" }, @@ -36332,37 +37107,53 @@ }, "title" : "Field Transformation" }, - "ForNdsGroup" : { + "FieldViolation" : { "type" : "object", - "description" : "ReplicaSet Event identifies different activities about replica set of mongod instances.", "properties" : { - "created" : { + "description" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "description" : "A description of why the request element is bad." }, - "eventTypeName" : { - "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroup" + "field" : { + "type" : "string", + "description" : "A path that leads to a field in the request body." + } + }, + "required" : [ "description", "field" ] + }, + "FlexBackupRestoreJob20250101" : { + "type" : "object", + "description" : "Details for one restore job of a flex cluster.", + "properties" : { + "deliveryType" : { + "type" : "string", + "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", + "enum" : [ "RESTORE", "DOWNLOAD" ], + "readOnly" : true }, - "groupId" : { + "expirationDate" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, + "instanceName" : { + "type" : "string", + "description" : "Human-readable label that identifies the source instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "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.", @@ -36375,485 +37166,317 @@ }, "readOnly" : true }, - "orgId" : { + "projectId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "port" : { - "type" : "integer", - "format" : "int32", - "description" : "IANA port on which the MongoDB process listens for requests.", - "example" : 27017, + "restoreFinishedDate" : { + "type" : "string", + "format" : "date-time", + "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.", "readOnly" : true }, - "raw" : { - "$ref" : "#/components/schemas/raw" - }, - "replicaSetName" : { + "restoreScheduledDate" : { "type" : "string", - "description" : "Human-readable label of the replica set associated with the event.", - "example" : "event-replica-set", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "shardName" : { + "snapshotFinishedDate" : { "type" : "string", - "description" : "Human-readable label of the shard associated with the event.", - "example" : "event-sh-01", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true - } - }, - "required" : [ "created", "eventTypeName", "id" ], - "title" : "ReplicaSet Events" - }, - "GCPCloudProviderContainer" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/CloudProviderContainer" - }, { - "type" : "object", - "properties" : { - "atlasCidrBlock" : { - "type" : "string", - "description" : "IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.\n\nThese CIDR blocks must fall within the ranges reserved per RFC 1918. GCP further limits the block to a lower bound of the `/18` range.\n\nTo modify the CIDR block, the target project cannot have:\n\n- Any M10 or greater clusters\n- Any other VPC peering connections\n\n 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.\n\n **Example:** A project in an Google Cloud (GCP) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets.", - "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" - }, - "gcpProjectId" : { - "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.", - "maxLength" : 26, - "minLength" : 26, - "pattern" : "^p-[0-9a-z]{24}$", - "readOnly" : true - }, - "networkName" : { - "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.", - "maxLength" : 36, - "minLength" : 36, - "pattern" : "^nt-[0-9a-f]{24}-[0-9a-z]{8}$", - "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.", - "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.", - "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" ] - } - } - } - } ], - "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", - "required" : [ "atlasCidrBlock" ], - "title" : "GCP" - }, - "GCPComputeAutoScaling" : { - "type" : "object", - "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", - "properties" : { - "maxInstanceSize" : { + }, + "snapshotId" : { "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" ], - "title" : "GCP Instance Sizes" + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "minInstanceSize" : { + "snapshotUrl" : { "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" ], - "title" : "GCP Instance Sizes" - } - }, - "title" : "GCP" - }, - "GCPConsumerForwardingRule" : { - "type" : "object", - "properties" : { - "endpointName" : { + "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" : "Human-readable label that identifies the Google Cloud consumer forwarding rule that you created.", - "externalDocs" : { - "description" : "Google Cloud Forwarding Rule Concepts", - "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" - }, + "description" : "Phase of the restore workflow for this job at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], "readOnly" : true }, - "ipAddress" : { + "targetDeploymentItemName" : { "type" : "string", - "description" : "One Private Internet Protocol version 4 (IPv4) address to which this Google Cloud consumer forwarding rule resolves.", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "description" : "Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another USS instance or Dedicated cluster tier.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", "readOnly" : true }, - "status" : { + "targetProjectId" : { "type" : "string", - "description" : "State of the MongoDB Cloud endpoint group when MongoDB Cloud received this request.", - "enum" : [ "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true } - } + }, + "title" : "Flex Backup Restore Job" }, - "GCPEndpointService" : { + "FlexBackupRestoreJobCreate20250101" : { "type" : "object", - "description" : "Group of Private Endpoint Service settings.", + "description" : "Details to create one restore job of a flex cluster.", "properties" : { - "cloudProvider" : { + "_snapshotId" : { "type" : "string", - "description" : "Cloud service provider that serves the requested endpoint service.", - "enum" : [ "AWS", "AZURE", "GCP" ], - "readOnly" : true + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true }, - "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" - }, - "items" : { - "type" : "string", - "description" : "One Google Cloud network endpoint group that corresponds to the Private Service Connect endpoint service." - } + "_targetDeploymentItemName" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another flex cluster or dedicated cluster tier.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", + "writeOnly" : true }, - "errorMessage" : { + "_targetProjectId" : { "type" : "string", - "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "deliveryType" : { + "type" : "string", + "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", + "enum" : [ "RESTORE", "DOWNLOAD" ], + "readOnly" : true + }, + "expirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "regionName" : { + "instanceName" : { "type" : "string", - "description" : "Cloud provider region that manages this Private Endpoint Service.", + "description" : "Human-readable label that identifies the source instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, - "serviceAttachmentNames" : { + "links" : { "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.", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", "externalDocs" : { - "description" : "Google Cloud Private Service Connect Service Attachments", - "url" : "https://cloud.google.com/vpc/docs/private-service-connect#service-attachments" + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" }, "items" : { - "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.", - "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\\-]+" - } + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true }, - "status" : { + "projectId" : { "type" : "string", - "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", - "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true - } - }, - "required" : [ "cloudProvider" ], - "title" : "GCP" - }, - "GCPHardwareSpec" : { - "type" : "object", - "properties" : { - "instanceSize" : { + }, + "restoreFinishedDate" : { "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" ], - "title" : "GCP Instance Sizes" + "format" : "date-time", + "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.", + "readOnly" : true }, - "nodeCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." - } - } - }, - "GCPHardwareSpec20240805" : { - "type" : "object", - "properties" : { - "diskSizeGB" : { - "type" : "number", - "format" : "double", - "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", - "maximum" : 4096, - "minimum" : 10 - }, - "instanceSize" : { - "type" : "string", - "description" : "Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as \"base nodes\") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.", - "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], - "title" : "GCP Instance Sizes" - }, - "nodeCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." - } - } - }, - "GCPNetworkPeeringConnectionSettings" : { - "type" : "object", - "description" : "Group of Network Peering connection settings.", - "properties" : { - "containerId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" - }, - "errorMessage" : { + "restoreScheduledDate" : { "type" : "string", - "description" : "Details of the error returned when requesting a GCP network peering resource. The resource returns `null` if the request succeeded.", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "gcpProjectId" : { - "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.", - "maxLength" : 30, - "minLength" : 6, - "pattern" : "^[a-z][0-9a-z-]{4,28}[0-9a-z]{1}" - }, - "id" : { + "snapshotFinishedDate" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "networkName" : { - "type" : "string", - "description" : "Human-readable label that identifies the network to peer with the MongoDB Cloud VPC.", - "maxLength" : 63, - "minLength" : 1, - "pattern" : "[a-z]([-a-z0-9]{0,62}[a-z0-9]{0,1})?" - }, - "providerName" : { + "snapshotUrl" : { "type" : "string", - "description" : "Cloud service provider that serves the requested network peering connection.", - "enum" : [ "AWS", "AZURE", "GCP" ] + "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" : "State of the network peering connection at the time you made the request.", - "enum" : [ "ADDING_PEER", "WAITING_FOR_USER", "AVAILABLE", "FAILED", "DELETING" ], + "description" : "Phase of the restore workflow for this job at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], "readOnly" : true } }, - "required" : [ "containerId", "gcpProjectId", "networkName" ], - "title" : "GCP" - }, - "GCPRegionConfig" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/CloudRegionConfig" - }, { - "type" : "object", - "properties" : { - "analyticsAutoScaling" : { - "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" - }, - "analyticsSpecs" : { - "$ref" : "#/components/schemas/DedicatedHardwareSpec" - }, - "autoScaling" : { - "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" - }, - "readOnlySpecs" : { - "$ref" : "#/components/schemas/DedicatedHardwareSpec" - } - } - } ], - "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", - "title" : "GCP Regional Replication Specifications" + "required" : [ "_snapshotId", "_targetDeploymentItemName" ], + "title" : "Create Flex Backup Restore Job" }, - "GCPRegionConfig20240805" : { + "FlexBackupSettings20250101" : { "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/CloudRegionConfig20240805" - }, { - "type" : "object", - "properties" : { - "analyticsAutoScaling" : { - "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" - }, - "analyticsSpecs" : { - "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" - }, - "autoScaling" : { - "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" - }, - "readOnlySpecs" : { - "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" - } + "description" : "Flex backup configuration", + "properties" : { + "enabled" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether backups are performed for this flex cluster. Backup uses [TODO](TODO) for flex clusters.", + "readOnly" : true } - } ], - "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", - "title" : "GCP Regional Replication Specifications" + }, + "readOnly" : true, + "title" : "Flex Backup Configuration" }, - "GeoSharding" : { + "FlexBackupSnapshot20250101" : { "type" : "object", + "description" : "Details for one snapshot of a flex cluster.", "properties" : { - "customZoneMapping" : { - "type" : "object", - "additionalProperties" : { - "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `id` property.\n\nThis parameter returns an empty object if no custom zones exist.", - "readOnly" : true - }, - "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `id` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "expiration" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "managedNamespaces" : { - "type" : "array", - "description" : "List that contains a namespace for a Global Cluster. MongoDB Cloud manages this cluster.", - "items" : { - "$ref" : "#/components/schemas/ManagedNamespaces" - }, + "finishTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "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 - } - } - }, - "GeoSharding20240805" : { - "type" : "object", - "properties" : { - "customZoneMapping" : { - "type" : "object", - "additionalProperties" : { - "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.\n\nThis parameter returns an empty object if no custom zones exist.", - "readOnly" : true - }, - "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "managedNamespaces" : { + "links" : { "type" : "array", - "description" : "List that contains a namespace for a Global Cluster. MongoDB Cloud manages this cluster.", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, "items" : { - "$ref" : "#/components/schemas/ManagedNamespaces" + "$ref" : "#/components/schemas/Link" }, "readOnly" : true }, - "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.", + "mongoDBVersion" : { + "type" : "string", + "description" : "MongoDB host version that the snapshot runs.", "readOnly" : true - } - } - }, - "GoogleCloudKMS" : { - "type" : "object", - "description" : "Details that define the configuration of Encryption at Rest using Google Cloud Key Management Service (KMS).", - "externalDocs" : { - "description" : "Google Cloud Key Management Service", - "url" : "https://www.mongodb.com/docs/atlas/security-gcp-kms/" - }, - "properties" : { - "enabled" : { - "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" : { + "scheduledTime" : { "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" + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will take the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true }, - "serviceAccountKey" : { + "startTime" : { "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.", - "externalDocs" : { - "description" : "Google Cloud Authentication", - "url" : "https://cloud.google.com/docs/authentication/getting-started" - }, - "writeOnly" : true - }, - "valid" : { - "type" : "boolean", - "description" : "Flag that indicates whether the Google Cloud Key Management Service (KMS) encryption key can encrypt and decrypt data.", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began taking the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true - } - } - }, - "GreaterThanDaysThresholdView" : { - "type" : "object", - "description" : "Threshold value that triggers an alert.", - "properties" : { - "operator" : { - "type" : "string", - "description" : "Comparison operator to apply when checking the current metric value.", - "enum" : [ "GREATER_THAN" ] - }, - "threshold" : { - "type" : "integer", - "format" : "int32", - "description" : "Value of metric that, when exceeded, triggers an alert." }, - "units" : { + "status" : { "type" : "string", - "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", - "enum" : [ "DAYS" ] + "description" : "Phase of the workflow for this snapshot at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true } - } + }, + "title" : "Flex Backup Snapshot" }, - "GreaterThanRawThreshold" : { + "FlexBackupSnapshotDownloadCreate20250101" : { "type" : "object", - "description" : "A Limit that triggers an alert when greater than a number.", + "description" : "Details for one backup snapshot download of a flex cluster.", "properties" : { - "operator" : { + "_snapshotId" : { "type" : "string", - "description" : "Comparison operator to apply when checking the current metric value.", - "enum" : [ "GREATER_THAN" ] - }, - "threshold" : { - "type" : "integer", - "format" : "int32", - "description" : "Value of metric that, when exceeded, triggers an alert." + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to download.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true }, - "units" : { - "$ref" : "#/components/schemas/RawMetricUnits" + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true } }, - "title" : "Greater Than Raw Threshold" + "required" : [ "_snapshotId" ], + "title" : "Flex Backup Snapshot Download Create" }, - "GreaterThanRawThresholdAlertConfigViewForNdsGroup" : { + "FlexClusterDescription20250101" : { "type" : "object", + "description" : "Group of settings that configure a MongoDB Flex cluster.", "properties" : { - "created" : { + "backupSettings" : { + "$ref" : "#/components/schemas/FlexBackupSettings20250101" + }, + "clusterType" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Flex cluster topology.", + "enum" : [ "REPLICASET", "LOADBALANCED" ], "readOnly" : true }, - "enabled" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + "connectionStrings" : { + "$ref" : "#/components/schemas/FlexConnectionStrings20250101" }, - "eventTypeName" : { - "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this instance. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true }, "groupId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "description" : "Unique 24-hexadecimal character string that identifies the project.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -36862,7 +37485,7 @@ }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "description" : "Unique 24-hexadecimal digit string that identifies the instance.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -36881,76 +37504,60 @@ }, "readOnly" : true }, - "matchers" : { - "type" : "array", - "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", - "items" : { - "$ref" : "#/components/schemas/ReplicaSetMatcher" - } + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the instance runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true }, - "notifications" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "readOnly" : true + }, + "providerSettings" : { + "$ref" : "#/components/schemas/FlexProviderSettings20250101" + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of this instance.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { "type" : "array", - "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, "items" : { - "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + "$ref" : "#/components/schemas/ResourceTag" } }, - "threshold" : { - "$ref" : "#/components/schemas/GreaterThanRawThreshold" + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." }, - "updated" : { + "versionReleaseSystem" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions.", + "enum" : [ "LTS" ], "readOnly" : true } }, - "required" : [ "eventTypeName", "notifications" ] - }, - "GreaterThanTimeThreshold" : { - "type" : "object", - "description" : "A Limit that triggers an alert when greater than a time period.", - "properties" : { - "operator" : { - "type" : "string", - "description" : "Comparison operator to apply when checking the current metric value.", - "enum" : [ "GREATER_THAN" ] - }, - "threshold" : { - "type" : "integer", - "format" : "int32", - "description" : "Value of metric that, when exceeded, triggers an alert." - }, - "units" : { - "$ref" : "#/components/schemas/TimeMetricUnits" - } - }, - "title" : "Greater Than Time Threshold" + "required" : [ "providerSettings" ], + "title" : "Flex Cluster Description" }, - "Group" : { + "FlexClusterDescriptionCreate20250101" : { "type" : "object", + "description" : "Settings that you can specify when you create a flex cluster.", "properties" : { - "clusterCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Quantity of MongoDB Cloud clusters deployed in this project.", - "readOnly" : true - }, - "created" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created this project. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true - }, - "id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, "links" : { "type" : "array", "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", @@ -36965,111 +37572,899 @@ }, "name" : { "type" : "string", - "description" : "Human-readable label that identifies the project included in the MongoDB Cloud organization.", + "description" : "Human-readable label that identifies the instance.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" - }, - "orgId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud organization to which the project belongs.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "writeOnly" : true }, - "regionUsageRestrictions" : { - "type" : "string", - "default" : "COMMERCIAL_FEDRAMP_REGIONS_ONLY", - "description" : "Applies to Atlas for Government only.\n\nIn Commercial Atlas, this field will be rejected in requests and missing in responses.\n\nThis field sets restrictions on available regions in the project.\n\n| Value | Available Regions |\n|-----------------------------------|------------|\n| `COMMERCIAL_FEDRAMP_REGIONS_ONLY` | Only allows deployments in FedRAMP Moderate regions.|\n| `GOV_REGIONS_ONLY` | Only allows deployments in GovCloud regions.|", - "enum" : [ "COMMERCIAL_FEDRAMP_REGIONS_ONLY", "GOV_REGIONS_ONLY" ], - "externalDocs" : { - "url" : "https://www.mongodb.com/docs/atlas/government/overview/supported-regions/#supported-cloud-providers-and-regions" - } + "providerSettings" : { + "$ref" : "#/components/schemas/FlexProviderSettingsCreate20250101" }, "tags" : { "type" : "array", - "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the project.", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.", "externalDocs" : { "description" : "Resource Tags", - "url" : "https://www.mongodb.com/docs/atlas/tags" + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" }, "items" : { "$ref" : "#/components/schemas/ResourceTag" } }, - "withDefaultAlertsSettings" : { + "terminationProtectionEnabled" : { "type" : "boolean", - "description" : "Flag that indicates whether to create the project with default alert settings.", - "writeOnly" : true + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." } }, - "required" : [ "clusterCount", "created", "name", "orgId" ] - }, - "GroupAlertsConfig" : { - "type" : "object", - "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/StreamProcessorAlertConfigViewForNdsGroup" - } ] + "required" : [ "name", "providerSettings" ], + "title" : "Flex Cluster Description Create" }, - "GroupIPAddresses" : { + "FlexConnectionStrings20250101" : { "type" : "object", - "description" : "List of IP addresses in a project.", + "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, "properties" : { - "groupId" : { + "standard" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "description" : "Public connection string that you can use to connect to this cluster. This connection string uses the mongodb:// protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, "readOnly" : true }, - "services" : { - "$ref" : "#/components/schemas/GroupService" + "standardSrv" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this flex cluster. This connection string uses the `mongodb+srv://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true } }, - "title" : "Group IP Address" + "readOnly" : true, + "title" : "Flex Cluster Connection Strings" }, - "GroupInvitation" : { + "FlexProviderSettings20250101" : { "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB flex cluster.", "properties" : { - "createdAt" : { + "backingProviderName" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud sent the invitation. This parameter expresses its value in ISO 8601 format in UTC.", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the flex cluster.", + "enum" : [ "AWS", "AZURE", "GCP" ], "readOnly" : true }, - "expiresAt" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud expires the invitation. This parameter expresses its value in ISO 8601 format in UTC.", + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity available to the flex cluster expressed in gigabytes.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "default" : "FLEX", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "FLEX" ], + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB flex cluster. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Cloud Service Provider Settings for a Flex Cluster" + }, + "FlexProviderSettingsCreate20250101" : { + "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB flex cluster.", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the flex cluster.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "writeOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity available to the flex cluster expressed in gigabytes.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "default" : "FLEX", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "FLEX" ], + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB flex cluster. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).", + "writeOnly" : true + } + }, + "required" : [ "backingProviderName", "regionName" ], + "title" : "Cloud Service Provider Settings for a Flex Cluster", + "writeOnly" : true + }, + "ForNdsGroup" : { + "type" : "object", + "description" : "ReplicaSet Event identifies different activities about replica set of mongod instances.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "ReplicaSet Events" + }, + "GCPCloudProviderContainer" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, { + "type" : "object", + "properties" : { + "atlasCidrBlock" : { + "type" : "string", + "description" : "IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.\n\nThese CIDR blocks must fall within the ranges reserved per RFC 1918. GCP further limits the block to a lower bound of the `/18` range.\n\nTo modify the CIDR block, the target project cannot have:\n\n- Any M10 or greater clusters\n- Any other VPC peering connections\n\n 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.\n\n **Example:** A project in an Google Cloud (GCP) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets.", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + }, + "gcpProjectId" : { + "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.", + "maxLength" : 26, + "minLength" : 26, + "pattern" : "^p-[0-9a-z]{24}$", + "readOnly" : true + }, + "networkName" : { + "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.", + "maxLength" : 36, + "minLength" : 36, + "pattern" : "^nt-[0-9a-f]{24}-[0-9a-z]{8}$", + "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.", + "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.", + "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" ] + } + } + } + } ], + "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", + "required" : [ "atlasCidrBlock" ], + "title" : "GCP" + }, + "GCPComputeAutoScaling" : { + "type" : "object", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", + "properties" : { + "maxInstanceSize" : { + "type" : "string", + "description" : "Maximum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "minInstanceSize" : { + "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" ], + "title" : "GCP Instance Sizes" + } + }, + "title" : "GCP" + }, + "GCPConsumerForwardingRule" : { + "type" : "object", + "properties" : { + "endpointName" : { + "type" : "string", + "description" : "Human-readable label that identifies the Google Cloud consumer forwarding rule that you created.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "One Private Internet Protocol version 4 (IPv4) address to which this Google Cloud consumer forwarding rule resolves.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the MongoDB Cloud endpoint group when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + } + }, + "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" ] + } + } + } ] + }, + "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.", + "enum" : [ "CENTRAL_US", "WESTERN_EUROPE" ], + "readOnly" : true + } + } + } ] + }, + "GCPEndpointService" : { + "type" : "object", + "description" : "Group of Private Endpoint Service settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "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" + }, + "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" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "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" + }, + "items" : { + "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.", + "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\\-]+" + } + }, + "status" : { + "type" : "string", + "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "GCP" + }, + "GCPHardwareSpec" : { + "type" : "object", + "properties" : { + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts 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" ], + "title" : "GCP Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "GCPHardwareSpec20240805" : { + "type" : "object", + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as \"base nodes\") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "GCPNetworkPeeringConnectionSettings" : { + "type" : "object", + "description" : "Group of Network Peering connection settings.", + "properties" : { + "containerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "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" : { + "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.", + "maxLength" : 30, + "minLength" : 6, + "pattern" : "^[a-z][0-9a-z-]{4,28}[0-9a-z]{1}" + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "networkName" : { + "type" : "string", + "description" : "Human-readable label that identifies the network to peer with the MongoDB Cloud VPC.", + "maxLength" : 63, + "minLength" : 1, + "pattern" : "[a-z]([-a-z0-9]{0,62}[a-z0-9]{0,1})?" + }, + "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.", + "enum" : [ "ADDING_PEER", "WAITING_FOR_USER", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "containerId", "gcpProjectId", "networkName" ], + "title" : "GCP" + }, + "GCPRegionConfig" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "GCP Regional Replication Specifications" + }, + "GCPRegionConfig20240805" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20240805" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "GCP Regional Replication Specifications" + }, + "GeoSharding" : { + "type" : "object", + "properties" : { + "customZoneMapping" : { + "type" : "object", + "additionalProperties" : { + "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `id` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `id` property.\n\nThis 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.", + "items" : { + "$ref" : "#/components/schemas/ManagedNamespaces" + }, + "readOnly" : true + }, + "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 + } + } + }, + "GeoSharding20240805" : { + "type" : "object", + "properties" : { + "customZoneMapping" : { + "type" : "object", + "additionalProperties" : { + "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.\n\nThis 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.", + "items" : { + "$ref" : "#/components/schemas/ManagedNamespaces" + }, + "readOnly" : true + }, + "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 + } + } + }, + "GoogleCloudKMS" : { + "type" : "object", + "description" : "Details that define the configuration of Encryption at Rest using Google Cloud Key Management Service (KMS).", + "externalDocs" : { + "description" : "Google Cloud Key Management Service", + "url" : "https://www.mongodb.com/docs/atlas/security-gcp-kms/" + }, + "properties" : { + "enabled" : { + "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" + }, + "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.", + "externalDocs" : { + "description" : "Google Cloud Authentication", + "url" : "https://cloud.google.com/docs/authentication/getting-started" + }, + "writeOnly" : true + }, + "valid" : { + "type" : "boolean", + "description" : "Flag that indicates whether the Google Cloud Key Management Service (KMS) encryption key can encrypt and decrypt data.", + "readOnly" : true + } + } + }, + "GreaterThanDaysThresholdView" : { + "type" : "object", + "description" : "Threshold value that triggers an alert.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "GREATER_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "DAYS" ] + } + } + }, + "GreaterThanRawThreshold" : { + "type" : "object", + "description" : "A Limit that triggers an alert when greater than a number.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "GREATER_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/RawMetricUnits" + } + }, + "title" : "Greater Than Raw Threshold" + }, + "GreaterThanRawThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ReplicaSetMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/GreaterThanRawThreshold" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ] + }, + "GreaterThanTimeThreshold" : { + "type" : "object", + "description" : "A Limit that triggers an alert when greater than a time period.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "GREATER_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "title" : "Greater Than Time Threshold" + }, + "Group" : { + "type" : "object", + "properties" : { + "clusterCount" : { + "type" : "integer", + "format" : "int64", + "description" : "Quantity of MongoDB Cloud clusters deployed in this project.", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this project. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the project included in the MongoDB Cloud organization.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud organization to which the project belongs.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "regionUsageRestrictions" : { + "type" : "string", + "default" : "COMMERCIAL_FEDRAMP_REGIONS_ONLY", + "description" : "Applies to Atlas for Government only.\n\nIn Commercial Atlas, this field will be rejected in requests and missing in responses.\n\nThis field sets restrictions on available regions in the project.\n\n| Value | Available Regions |\n|-----------------------------------|------------|\n| `COMMERCIAL_FEDRAMP_REGIONS_ONLY` | Only allows deployments in FedRAMP Moderate regions.|\n| `GOV_REGIONS_ONLY` | Only allows deployments in GovCloud regions.|", + "enum" : [ "COMMERCIAL_FEDRAMP_REGIONS_ONLY", "GOV_REGIONS_ONLY" ], + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/government/overview/supported-regions/#supported-cloud-providers-and-regions" + } + }, + "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" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "withDefaultAlertsSettings" : { + "type" : "boolean", + "description" : "Flag that indicates whether to create the project with default alert settings.", + "writeOnly" : true + } + }, + "required" : [ "clusterCount", "created", "name", "orgId" ] + }, + "GroupAlertsConfig" : { + "type" : "object", + "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/StreamProcessorAlertConfigViewForNdsGroup" + } ] + }, + "GroupIPAddresses" : { + "type" : "object", + "description" : "List of IP addresses in a project.", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "services" : { + "$ref" : "#/components/schemas/GroupService" + } + }, + "title" : "Group IP Address" + }, + "GroupInvitation" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud sent the invitation. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud expires the invitation. This parameter expresses its value in ISO 8601 format in UTC.", "readOnly" : true }, "groupId" : { @@ -37209,22 +38604,27 @@ "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "pattern" : "^([a-f0-9]{24})$" }, "destinationOrgPrivateApiKey" : { "type" : "string", - "description" : "Unique string that identifies the private part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.", + "description" : "Unique string that identifies the private part of the API Key used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.", "example" : "55c3bbb6-b4bb-0be1-e66d20841f3e", - "readOnly" : true + "externalDocs" : { + "description" : "Grant Programmatic Access to Atlas", + "url" : "https://dochub.mongodb.org/core/atlas-create-prog-api-key" + } }, "destinationOrgPublicApiKey" : { "type" : "string", - "description" : "Unique string that identifies the public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.", + "description" : "Unique string that identifies the public part of the API Key used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.", "example" : "zmmrboas", + "externalDocs" : { + "description" : "Grant Programmatic Access to Atlas", + "url" : "https://dochub.mongodb.org/core/atlas-create-prog-api-key" + }, "maxLength" : 8, - "minLength" : 8, - "readOnly" : true + "minLength" : 8 } } }, @@ -37291,7 +38691,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/EventViewForNdsGroup" }, @@ -37324,6 +38724,28 @@ } } }, + "GroupRoleAssignment" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to which these roles belong.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "groupRoles" : { + "type" : "array", + "description" : "One or more project level roles assigned to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_OWNER", "GROUP_CLUSTER_MANAGER", "GROUP_STREAM_PROCESSING_OWNER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR" ] + }, + "uniqueItems" : true + } + } + }, "GroupService" : { "type" : "object", "description" : "List of IP addresses in a project categorized by services.", @@ -37343,37 +38765,37 @@ "GroupServiceAccount" : { "type" : "object", "properties" : { + "clientId" : { + "type" : "string", + "description" : "The Client ID of the Service Account.", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + }, "createdAt" : { "type" : "string", "format" : "date-time", - "description" : "Service account creation time." + "description" : "The date that the Service Account was created on." }, "description" : { "type" : "string", - "description" : "Description of the service account." - }, - "id" : { - "type" : "string", - "description" : "ID for the service account.", - "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + "description" : "Human readable description for the Service Account." }, "name" : { "type" : "string", - "description" : "Name for service account." + "description" : "Human-readable name for the Service Account." }, "roles" : { "type" : "array", - "description" : "Roles assigned to the Service Account group.", + "description" : "A list of Project roles associated with the Service Account.", "items" : { "type" : "string", - "description" : "Project roles associated with the service account.", + "description" : "Project roles available for Service Accounts.", "enum" : [ "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" ] }, "uniqueItems" : true }, "secrets" : { "type" : "array", - "description" : "List of secrets.", + "description" : "A list of secrets associated with the specified Service Account.", "items" : { "$ref" : "#/components/schemas/ServiceAccountSecret" }, @@ -37386,73 +38808,74 @@ "properties" : { "description" : { "type" : "string", - "description" : "Human readable description for the service account.", + "description" : "Human readable description for the Service Account.", "maxLength" : 250, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "name" : { "type" : "string", - "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "description" : "Human-readable name for the Service Account. The name is modifiable and does not have to be unique.", "maxLength" : 64, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "roles" : { "type" : "array", - "description" : "Project roles associated with the service account.", + "description" : "A list of project-level roles for the Service Account.", "items" : { "type" : "string", - "description" : "Project roles associated with the service account.", + "description" : "Project roles available for Service Accounts.", "enum" : [ "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" ] } }, "secretExpiresAfterHours" : { "type" : "integer", "format" : "int32", - "description" : "Secret expiration time." + "description" : "The expiration time of the new Service Account secret. The expiration is provided in hours." } }, - "required" : [ "description", "name", "secretExpiresAfterHours" ] + "required" : [ "description", "name", "roles", "secretExpiresAfterHours" ] }, "GroupServiceAccountRoleAssignment" : { "type" : "object", "properties" : { "roles" : { "type" : "array", - "description" : "Group access roles.", + "description" : "The Project permissions for the Service Account in the specified Project.", "items" : { "type" : "string", - "description" : "Project roles associated with the service account.", + "description" : "Project roles available for Service Accounts.", "enum" : [ "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" ] }, "uniqueItems" : true } - } + }, + "required" : [ "roles" ] }, "GroupServiceAccountUpdateRequest" : { "type" : "object", "properties" : { "description" : { "type" : "string", - "description" : "Human readable description for the service account.", + "description" : "Human readable description for the Service Account.", "maxLength" : 250, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "name" : { "type" : "string", - "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "description" : "Human-readable name for the Service Account. The name is modifiable and does not have to be unique.", "maxLength" : 64, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "roles" : { "type" : "array", - "description" : "Project roles associated with the service account.", + "description" : "A list of Project roles associated with the Service Account.", "items" : { "type" : "string", - "description" : "Project roles associated with the service account.", + "description" : "Project roles available for Service Accounts.", "enum" : [ "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" ] } } @@ -37696,7 +39119,7 @@ "example" : "cluster1", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -37791,14 +39214,14 @@ "HostEventTypeViewForNdsGroup" : { "type" : "string", "description" : "Unique identifier of event type.", - "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_ENOUGH_DISK_SPACE", "HOST_NOT_ENOUGH_DISK_SPACE" ], + "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_ENOUGH_DISK_SPACE", "HOST_NOT_ENOUGH_DISK_SPACE" ], "example" : "HOST_DOWN", "title" : "Host Event Types" }, "HostEventTypeViewForNdsGroupAlertable" : { "type" : "string", "description" : "Event type that triggers an alert.", - "enum" : [ "HOST_DOWN", "HOST_HAS_INDEX_SUGGESTIONS", "HOST_MONGOT_CRASHING_OOM", "HOST_NOT_ENOUGH_DISK_SPACE" ], + "enum" : [ "HOST_DOWN", "HOST_HAS_INDEX_SUGGESTIONS", "HOST_MONGOT_CRASHING_OOM", "HOST_MONGOT_STOP_REPLICATION", "HOST_NOT_ENOUGH_DISK_SPACE" ], "example" : "HOST_DOWN", "title" : "Host Event Types" }, @@ -38084,6 +39507,7 @@ "OPCOUNTER_REPL_INSERT" : "#/components/schemas/RawMetricAlertView", "OPCOUNTER_REPL_UPDATE" : "#/components/schemas/RawMetricAlertView", "OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricAlertView", + "OPERATIONS_QUERIES_KILLED" : "#/components/schemas/RawMetricAlertView", "OPERATIONS_SCAN_AND_ORDER" : "#/components/schemas/RawMetricAlertView", "OPERATION_THROTTLING_REJECTED_OPERATIONS" : "#/components/schemas/RawMetricAlertView", "OPLOG_MASTER_LAG_TIME_DIFF" : "#/components/schemas/TimeMetricAlertView", @@ -38153,7 +39577,7 @@ "example" : "cluster1", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -38462,6 +39886,7 @@ "OPCOUNTER_REPL_INSERT" : "#/components/schemas/RawMetricEventView", "OPCOUNTER_REPL_UPDATE" : "#/components/schemas/RawMetricEventView", "OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricEventView", + "OPERATIONS_QUERIES_KILLED" : "#/components/schemas/RawMetricEventView", "OPERATIONS_SCAN_AND_ORDER" : "#/components/schemas/RawMetricEventView", "OPERATION_THROTTLING_REJECTED_OPERATIONS" : "#/components/schemas/RawMetricEventView", "OPLOG_MASTER_LAG_TIME_DIFF" : "#/components/schemas/TimeMetricEventView", @@ -38767,6 +40192,7 @@ "OPCOUNTER_REPL_INSERT" : "#/components/schemas/RawMetricThresholdView", "OPCOUNTER_REPL_UPDATE" : "#/components/schemas/RawMetricThresholdView", "OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "OPERATIONS_QUERIES_KILLED" : "#/components/schemas/RawMetricThresholdView", "OPERATIONS_SCAN_AND_ORDER" : "#/components/schemas/RawMetricThresholdView", "OPERATION_THROTTLING_REJECTED_OPERATIONS" : "#/components/schemas/RawMetricThresholdView", "OPLOG_MASTER_LAG_TIME_DIFF" : "#/components/schemas/TimeMetricThresholdView", @@ -38813,7 +40239,9 @@ "enum" : [ "AVERAGE" ] }, "operator" : { - "$ref" : "#/components/schemas/Operator" + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, "threshold" : { "type" : "number", @@ -39165,7 +40593,7 @@ "description" : "Human-readable label that identifies the cluster that incurred the charge.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -39219,7 +40647,7 @@ "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.", - "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_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", "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_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_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" ], + "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_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", "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_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_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_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" ], "readOnly" : true }, "startDate" : { @@ -39509,6 +40937,323 @@ "description" : "Configuration of nodes that comprise the cluster.", "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] }, + "configServerManagementMode" : { + "type" : "string", + "default" : "ATLAS_MANAGED", + "description" : "Config Server Management Mode for creating or updating a sharded cluster.\n\nWhen configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings.\n\nWhen configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server.", + "enum" : [ "ATLAS_MANAGED", "FIXED_TO_DEDICATED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + } + }, + "configServerType" : { + "type" : "string", + "description" : "Describes a sharded cluster's config server type.", + "enum" : [ "DEDICATED", "EMBEDDED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + }, + "readOnly" : true + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/ClusterConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "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.", + "maximum" : 4096, + "minimum" : 10 + }, + "diskWarmingMode" : { + "type" : "string", + "default" : "FULLY_WARMED", + "description" : "Disk warming mode selection.", + "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], + "externalDocs" : { + "description" : "Reduce Secondary Disk Warming Impact", + "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" + } + }, + "encryptionAtRestProvider" : { + "type" : "string", + "description" : "Cloud service provider that manages your customer keys to provide an additional layer of Encryption at Rest for the cluster.", + "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "featureCompatibilityVersion" : { + "type" : "string", + "description" : "Feature compatibility version of the cluster.", + "readOnly" : true + }, + "featureCompatibilityVersionExpirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Feature compatibility version expiration date.", + "readOnly" : true + }, + "globalClusterSelfManagedSharding" : { + "type" : "boolean", + "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen 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.\n\nWhen 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.\n\nThis 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" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "labels" : { + "type" : "array", + "deprecated" : true, + "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBEmployeeAccessGrant" : { + "$ref" : "#/components/schemas/EmployeeAccessGrantView" + }, + "mongoDBMajorVersion" : { + "type" : "string", + "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", + "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-" + } + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the cluster runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)" + }, + "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.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "mongoURIUpdated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated the connection string. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "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.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + }, + "numShards" : { + "type" : "integer", + "format" : "int32", + "default" : 1, + "description" : "Number of shards up to 50 to deploy for a sharded cluster. The resource returns `1` to indicate a replica set and values of `2` and higher to indicate a sharded cluster. The returned value equals the number of shards in the cluster.", + "externalDocs" : { + "description" : "Sharding", + "url" : "https://docs.mongodb.com/manual/sharding/" + }, + "maximum" : 50, + "minimum" : 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", + "default" : "WORKLOAD_TYPE", + "description" : "Set this field to configure the replica set scaling mode for your cluster.\n\nBy default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes.\n\nWhen configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads.\n\nWhen configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads.", + "enum" : [ "SEQUENTIAL", "WORKLOAD_TYPE", "NODE_TYPE" ], + "externalDocs" : { + "description" : "Modify the Replica Set Scaling Mode", + "url" : "https://dochub.mongodb.org/core/scale-nodes" + } + }, + "replicationFactor" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "deprecated" : true, + "description" : "Number of members that belong to the replica set. Each member retains a copy of your databases, providing high availability and data redundancy. Use **replicationSpecs** instead.", + "enum" : [ 3, 5, 7 ] + }, + "replicationSpec" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RegionSpec" + }, + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "title" : "Region Configuration" + }, + "replicationSpecs" : { + "type" : "array", + "description" : "List of settings that configure your cluster regions.\n\n- For Global Clusters, each object in the array represents one zone where MongoDB Cloud deploys your clusters nodes.\n- For non-Global sharded clusters and replica sets, the single object represents where MongoDB Cloud deploys your clusters nodes.", + "items" : { + "$ref" : "#/components/schemas/LegacyReplicationSpec" + } + }, + "rootCertType" : { + "type" : "string", + "default" : "ISRGROOTX1", + "description" : "Root Certificate Authority that MongoDB Atlas clusters uses. MongoDB Cloud supports Internet Security Research Group.", + "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.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the cluster.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", + "enum" : [ "LTS", "CONTINUOUS" ] + } + }, + "title" : "Cluster Description" + }, + "LegacyAtlasTenantClusterUpgradeRequest" : { + "type" : "object", + "description" : "Request containing target state of tenant cluster to be upgraded", + "properties" : { + "acceptDataRisksAndForceReplicaSetReconfig" : { + "type" : "string", + "format" : "date-time", + "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", + "externalDocs" : { + "description" : "Reconfiguring a Replica Set during a regional outage", + "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + } + }, + "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", + "default" : "ATLAS_MANAGED", + "description" : "Config Server Management Mode for creating or updating a sharded cluster.\n\nWhen configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings.\n\nWhen configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server.", + "enum" : [ "ATLAS_MANAGED", "FIXED_TO_DEDICATED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + } + }, + "configServerType" : { + "type" : "string", + "description" : "Describes a sharded cluster's config server type.", + "enum" : [ "DEDICATED", "EMBEDDED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + }, + "readOnly" : true + }, "connectionStrings" : { "$ref" : "#/components/schemas/ClusterConnectionStrings" }, @@ -39544,6 +41289,17 @@ "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" } }, + "featureCompatibilityVersion" : { + "type" : "string", + "description" : "Feature compatibility version of the cluster.", + "readOnly" : true + }, + "featureCompatibilityVersionExpirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Feature compatibility version expiration date.", + "readOnly" : true + }, "globalClusterSelfManagedSharding" : { "type" : "boolean", "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen 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.\n\nWhen 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.\n\nThis setting cannot be changed once the cluster is deployed.", @@ -39590,6 +41346,9 @@ }, "readOnly" : true }, + "mongoDBEmployeeAccessGrant" : { + "$ref" : "#/components/schemas/EmployeeAccessGrantView" + }, "mongoDBMajorVersion" : { "type" : "string", "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", @@ -39632,7 +41391,7 @@ "description" : "Human-readable label that identifies the cluster.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, "numShards" : { "type" : "integer", @@ -39665,259 +41424,16 @@ "providerSettings" : { "$ref" : "#/components/schemas/ClusterProviderSettings" }, - "replicationFactor" : { - "type" : "integer", - "format" : "int32", - "default" : 3, - "deprecated" : true, - "description" : "Number of members that belong to the replica set. Each member retains a copy of your databases, providing high availability and data redundancy. Use **replicationSpecs** instead.", - "enum" : [ 3, 5, 7 ] - }, - "replicationSpec" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/RegionSpec" - }, - "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", - "title" : "Region Configuration" - }, - "replicationSpecs" : { - "type" : "array", - "description" : "List of settings that configure your cluster regions.\n\n- For Global Clusters, each object in the array represents one zone where MongoDB Cloud deploys your clusters nodes.\n- For non-Global sharded clusters and replica sets, the single object represents where MongoDB Cloud deploys your clusters nodes.", - "items" : { - "$ref" : "#/components/schemas/LegacyReplicationSpec" - } - }, - "rootCertType" : { - "type" : "string", - "default" : "ISRGROOTX1", - "description" : "Root Certificate Authority that MongoDB Atlas clusters uses. MongoDB Cloud supports Internet Security Research Group.", - "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.", - "externalDocs" : { - "description" : "Connection string URI format.", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, - "readOnly" : true - }, - "stateName" : { + "replicaSetScalingStrategy" : { "type" : "string", - "description" : "Human-readable label that indicates the current operating condition of the cluster.", - "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], - "readOnly" : true - }, - "tags" : { - "type" : "array", - "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "default" : "WORKLOAD_TYPE", + "description" : "Set this field to configure the replica set scaling mode for your cluster.\n\nBy default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes.\n\nWhen configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads.\n\nWhen configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads.", + "enum" : [ "SEQUENTIAL", "WORKLOAD_TYPE", "NODE_TYPE" ], "externalDocs" : { - "description" : "Resource Tags", - "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" - }, - "items" : { - "$ref" : "#/components/schemas/ResourceTag" - } - }, - "terminationProtectionEnabled" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." - }, - "versionReleaseSystem" : { - "type" : "string", - "default" : "LTS", - "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", - "enum" : [ "LTS", "CONTINUOUS" ] - } - }, - "title" : "Cluster Description" - }, - "LegacyAtlasTenantClusterUpgradeRequest" : { - "type" : "object", - "description" : "Request containing target state of tenant cluster to be upgraded", - "properties" : { - "acceptDataRisksAndForceReplicaSetReconfig" : { - "type" : "string", - "format" : "date-time", - "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", - "externalDocs" : { - "description" : "Reconfiguring a Replica Set during a regional outage", - "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + "description" : "Modify the Replica Set Scaling Mode", + "url" : "https://dochub.mongodb.org/core/scale-nodes" } }, - "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" ] - }, - "connectionStrings" : { - "$ref" : "#/components/schemas/ClusterConnectionStrings" - }, - "createDate" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", - "readOnly" : true - }, - "diskSizeGB" : { - "type" : "number", - "format" : "double", - "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.", - "maximum" : 4096, - "minimum" : 10 - }, - "diskWarmingMode" : { - "type" : "string", - "default" : "FULLY_WARMED", - "description" : "Disk warming mode selection.", - "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], - "externalDocs" : { - "description" : "Reduce Secondary Disk Warming Impact", - "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" - } - }, - "encryptionAtRestProvider" : { - "type" : "string", - "description" : "Cloud service provider that manages your customer keys to provide an additional layer of Encryption at Rest for the cluster.", - "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], - "externalDocs" : { - "description" : "Encryption at Rest using Customer Key Management", - "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" - } - }, - "globalClusterSelfManagedSharding" : { - "type" : "boolean", - "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen 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.\n\nWhen 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.\n\nThis 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" : { - "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the project.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "labels" : { - "type" : "array", - "deprecated" : true, - "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", - "items" : { - "$ref" : "#/components/schemas/ComponentLabel" - } - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - }, - "mongoDBMajorVersion" : { - "type" : "string", - "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", - "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-" - } - }, - "mongoDBVersion" : { - "type" : "string", - "description" : "Version of MongoDB that the cluster runs.", - "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)" - }, - "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.", - "externalDocs" : { - "description" : "Connection string URI format.", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, - "readOnly" : true - }, - "mongoURIUpdated" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when someone last updated the connection string. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", - "readOnly" : true - }, - "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.", - "externalDocs" : { - "description" : "Connection string URI format.", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "Human-readable label that identifies the cluster.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - }, - "numShards" : { - "type" : "integer", - "format" : "int32", - "default" : 1, - "description" : "Number of shards up to 50 to deploy for a sharded cluster. The resource returns `1` to indicate a replica set and values of `2` and higher to indicate a sharded cluster. The returned value equals the number of shards in the cluster.", - "externalDocs" : { - "description" : "Sharding", - "url" : "https://docs.mongodb.com/manual/sharding/" - }, - "maximum" : 50, - "minimum" : 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" - }, "replicationFactor" : { "type" : "integer", "format" : "int32", @@ -40464,6 +41980,10 @@ "type" : "string", "enum" : [ "INSTANCE_NAME", "PROCESSOR_NAME" ], "title" : "Streams Matcher Fields" + }, { + "type" : "string", + "enum" : [ "RULE_ID" ], + "title" : "Log Ingestion Matcher Fields" } ] }, "MatcherHostType" : { @@ -41114,7 +42634,7 @@ "NDSAuditTypeViewForNdsGroup" : { "type" : "string", "description" : "Unique identifier of event type.", - "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_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_SSL_ROTATED", "CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER", "CLUSTER_INSTANCE_SSL_REVOKED", "RELOAD_SSL_ON_PROCESSES", "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", "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", "MOVE_SKIPPED", "PROXY_RESTARTED", "PROXY_PANICKED", "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", "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", "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", "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", "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", "PENDING_INDEXES_DELETED", "PENDING_INDEXES_CANCELED", "PROCESS_RESTART_REQUESTED", "AUTO_HEALING_ACTION", "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", "CLUSTER_FORCE_RECONFIG_REQUESTED", "PROJECT_BYPASSED_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", "ATLAS_SQL_SCHEDULED_UPDATE_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_MODIFIED", "ATLAS_SQL_SCHEDULED_UPDATE_REMOVED" ], + "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_SSL_ROTATED", "CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER", "CLUSTER_INSTANCE_SSL_REVOKED", "RELOAD_SSL_ON_PROCESSES", "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", "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", "MOVE_SKIPPED", "PROXY_RESTARTED", "PROXY_PANICKED", "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", "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", "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", "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", "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", "CLUSTER_FORCE_RECONFIG_REQUESTED", "PROJECT_BYPASSED_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" ], "example" : "CLUSTER_CREATED", "title" : "NDS Audit Types" }, @@ -42011,7 +43531,7 @@ "example" : "cluster1", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -42253,7 +43773,9 @@ "enum" : [ "AVERAGE" ] }, "operator" : { - "$ref" : "#/components/schemas/Operator" + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, "threshold" : { "type" : "number", @@ -42437,6 +43959,54 @@ "required" : [ "typeName" ], "title" : "OpsGenie Notification" }, + "OrgActiveUserResponse" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OrgUserResponse" + }, { + "type" : "object", + "properties" : { + "country" : { + "type" : "string", + "description" : "Two alphabet characters that identifies MongoDB Cloud user's geographic location. This parameter uses the ISO 3166-1a2 code format.", + "example" : "US", + "pattern" : "^([A-Z]{2})$", + "readOnly" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the current account. This value is in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "firstName" : { + "type" : "string", + "description" : "First or given name that belongs to the MongoDB Cloud user.", + "example" : "John", + "readOnly" : true + }, + "lastAuth" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the current account last authenticated. This value is in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "lastName" : { + "type" : "string", + "description" : "Last name, family name, or surname that belongs to the MongoDB Cloud user.", + "example" : "Doe", + "readOnly" : true + }, + "mobileNumber" : { + "type" : "string", + "description" : "Mobile phone number that belongs to the MongoDB Cloud user.", + "pattern" : "(?:(?:\\\\+?1\\\\s*(?:[.-]\\\\s*)?)?(?:(\\\\s*([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9])\\\\s*)|([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9]))\\\\s*(?:[.-]\\\\s*)?)([2-9]1[02-9]|[2-9][02-9]1|[2-9][02-9]{2})\\\\s*(?:[.-]\\\\s*)?([0-9]{4})$", + "readOnly" : true + } + } + } ], + "required" : [ "createdAt", "firstName", "id", "lastName", "orgMembershipStatus", "roles", "username" ] + }, "OrgEventTypeViewForOrg" : { "type" : "string", "description" : "Unique identifier of event type.", @@ -42718,7 +44288,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/EventViewForOrg" }, @@ -42733,40 +44303,69 @@ } } }, + "OrgPendingUserResponse" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OrgUserResponse" + }, { + "type" : "object", + "properties" : { + "invitationCreatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud sent the invitation. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "invitationExpiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the invitation from MongoDB Cloud expires. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "inviterUsername" : { + "type" : "string", + "format" : "email", + "description" : "Username of the MongoDB Cloud user who sent the invitation to join the organization.", + "readOnly" : true + } + } + } ], + "required" : [ "id", "invitationCreatedAt", "invitationExpiresAt", "inviterUsername", "orgMembershipStatus", "roles", "username" ] + }, "OrgServiceAccount" : { "type" : "object", "properties" : { + "clientId" : { + "type" : "string", + "description" : "The Client ID of the Service Account.", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + }, "createdAt" : { "type" : "string", "format" : "date-time", - "description" : "Service account creation time." + "description" : "The date that the Service Account was created on." }, "description" : { "type" : "string", - "description" : "Description of the service account." - }, - "id" : { - "type" : "string", - "description" : "ID for the service account.", - "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + "description" : "Human readable description for the Service Account." }, "name" : { "type" : "string", - "description" : "Name for service account." + "description" : "Human-readable name for the Service Account." }, "roles" : { "type" : "array", - "description" : "Organization roles assigned to the Service Account.", + "description" : "A list of Organization roles associated with the Service Account.", "items" : { "type" : "string", - "description" : "Organization roles associated with the service account.", + "description" : "Organization roles available for Service Accounts.", "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] }, "uniqueItems" : true }, "secrets" : { "type" : "array", - "description" : "List of secrets.", + "description" : "A list of secrets associated with the specified Service Account.", "items" : { "$ref" : "#/components/schemas/ServiceAccountSecret" }, @@ -42779,63 +44378,215 @@ "properties" : { "description" : { "type" : "string", - "description" : "Human readable description for the service account.", + "description" : "Human readable description for the Service Account.", "maxLength" : 250, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "name" : { "type" : "string", - "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "description" : "Human-readable name for the Service Account. The name is modifiable and does not have to be unique.", "maxLength" : 64, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "roles" : { "type" : "array", - "description" : "Organization roles associated with the service account.", + "description" : "A list of organization-level roles for the Service Account.", "items" : { "type" : "string", - "description" : "Organization roles associated with the service account.", + "description" : "Organization roles available for Service Accounts.", "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] } }, "secretExpiresAfterHours" : { "type" : "integer", "format" : "int32", - "description" : "Secret expiration time." + "description" : "The expiration time of the new Service Account secret. The expiration is provided in hours." } }, - "required" : [ "description", "name", "secretExpiresAfterHours" ] + "required" : [ "description", "name", "roles", "secretExpiresAfterHours" ] }, "OrgServiceAccountUpdateRequest" : { "type" : "object", "properties" : { "description" : { "type" : "string", - "description" : "Human readable description for the service account.", + "description" : "Human readable description for the Service Account.", "maxLength" : 250, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "name" : { "type" : "string", - "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "description" : "Human-readable name for the Service Account. The name is modifiable and does not have to be unique.", "maxLength" : 64, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "roles" : { "type" : "array", - "description" : "Organization roles associated with the Service account.", + "description" : "A list of organization-level roles for the Service Account.", "items" : { "type" : "string", - "description" : "Organization roles associated with the service account.", + "description" : "Organization roles available for Service Accounts.", "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] } } } }, + "OrgUserRequest" : { + "type" : "object", + "properties" : { + "roles" : { + "$ref" : "#/components/schemas/OrgUserRolesRequest" + }, + "teamIds" : { + "type" : "array", + "description" : "List of unique 24-hexadecimal digit strings that identifies the teams to which this MongoDB Cloud user belongs.", + "items" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "uniqueItems" : true, + "writeOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address that represents the username of the MongoDB Cloud user.", + "writeOnly" : true + } + }, + "required" : [ "roles", "username" ] + }, + "OrgUserResponse" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "ACTIVE" : "#/components/schemas/OrgActiveUserResponse", + "PENDING" : "#/components/schemas/OrgPendingUserResponse" + }, + "propertyName" : "orgMembershipStatus" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/OrgPendingUserResponse" + }, { + "$ref" : "#/components/schemas/OrgActiveUserResponse" + } ], + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgMembershipStatus" : { + "type" : "string", + "description" : "String enum that indicates whether the MongoDB Cloud user has a pending invitation to join the organization or they are already active in the organization.", + "enum" : [ "PENDING", "ACTIVE" ], + "readOnly" : true + }, + "roles" : { + "$ref" : "#/components/schemas/OrgUserRolesResponse" + }, + "teamIds" : { + "type" : "array", + "description" : "List of unique 24-hexadecimal digit strings that identifies the teams to which this MongoDB Cloud user belongs.", + "items" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address that represents the username of the MongoDB Cloud user.", + "readOnly" : true + } + }, + "required" : [ "id", "orgMembershipStatus", "roles", "username" ] + }, + "OrgUserRolesRequest" : { + "type" : "object", + "description" : "Organization and project level roles to assign the MongoDB Cloud user within one organization.", + "properties" : { + "groupRoleAssignments" : { + "type" : "array", + "description" : "List of project level role assignments to assign the MongoDB Cloud user.", + "items" : { + "$ref" : "#/components/schemas/GroupRoleAssignment" + } + }, + "orgRoles" : { + "type" : "array", + "description" : "One or more organization level roles to assign the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_READ_ONLY", "ORG_MEMBER" ] + }, + "minItems" : 1, + "uniqueItems" : true + } + }, + "required" : [ "orgRoles" ], + "writeOnly" : true + }, + "OrgUserRolesResponse" : { + "type" : "object", + "description" : "Organization and project level roles assigned to one MongoDB Cloud user within one organization.", + "properties" : { + "groupRoleAssignments" : { + "type" : "array", + "description" : "List of project level role assignments assigned to the MongoDB Cloud user.", + "items" : { + "$ref" : "#/components/schemas/GroupRoleAssignment" + } + }, + "orgRoles" : { + "type" : "array", + "description" : "One or more organization level roles assigned to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_READ_ONLY", "ORG_MEMBER" ] + }, + "uniqueItems" : true + } + }, + "readOnly" : true + }, + "OrgUserUpdateRequest" : { + "type" : "object", + "properties" : { + "roles" : { + "$ref" : "#/components/schemas/OrgUserRolesRequest" + }, + "teamIds" : { + "type" : "array", + "description" : "List of unique 24-hexadecimal digit strings that identifies the teams to assign the MongoDB Cloud user.", + "items" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "uniqueItems" : true, + "writeOnly" : true + } + } + }, "OrganizationInvitation" : { "type" : "object", "properties" : { @@ -43040,7 +44791,7 @@ }, "restrictEmployeeAccess" : { "type" : "boolean", - "description" : "Flag that indicates whether to block MongoDB Support from accessing Atlas infrastructure 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/." + "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/." } } }, @@ -43187,7 +44938,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/AdvancedClusterDescription" }, @@ -43219,7 +44970,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/GroupAlertsConfig" }, @@ -43251,7 +45002,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/AlertViewForNdsGroup" }, @@ -43283,7 +45034,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ApiKeyUserDetails" }, @@ -43315,7 +45066,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/CloudAppUser" }, @@ -43347,7 +45098,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ApiAtlasCheckpointView" }, @@ -43380,7 +45131,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/CloudDatabaseUser" }, @@ -43412,7 +45163,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/DiskBackupExportJob" }, @@ -43444,7 +45195,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/EARPrivateEndpoint" }, @@ -43459,7 +45210,7 @@ } } }, - "PaginatedApiAtlasProviderRegionsView" : { + "PaginatedApiAtlasFlexBackupRestoreJob20250101View" : { "type" : "object", "properties" : { "links" : { @@ -43476,9 +45227,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/CloudProviderRegions" + "$ref" : "#/components/schemas/FlexBackupRestoreJob20250101" }, "readOnly" : true }, @@ -43491,7 +45242,7 @@ } } }, - "PaginatedApiAtlasServerlessBackupRestoreJobView" : { + "PaginatedApiAtlasFlexBackupSnapshot20240710View" : { "type" : "object", "properties" : { "links" : { @@ -43508,9 +45259,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" + "$ref" : "#/components/schemas/FlexBackupSnapshot20250101" }, "readOnly" : true }, @@ -43523,7 +45274,7 @@ } } }, - "PaginatedApiAtlasServerlessBackupSnapshotView" : { + "PaginatedApiAtlasProviderRegionsView" : { "type" : "object", "properties" : { "links" : { @@ -43540,9 +45291,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/ServerlessBackupSnapshot" + "$ref" : "#/components/schemas/CloudProviderRegions" }, "readOnly" : true }, @@ -43555,7 +45306,7 @@ } } }, - "PaginatedApiAtlasUSSBackupRestoreJob20250101View" : { + "PaginatedApiAtlasServerlessBackupRestoreJobView" : { "type" : "object", "properties" : { "links" : { @@ -43572,9 +45323,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/USSBackupRestoreJob20250101" + "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" }, "readOnly" : true }, @@ -43587,7 +45338,7 @@ } } }, - "PaginatedApiAtlasUSSBackupSnapshot20240710View" : { + "PaginatedApiAtlasServerlessBackupSnapshotView" : { "type" : "object", "properties" : { "links" : { @@ -43604,9 +45355,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/USSBackupSnapshot20250101" + "$ref" : "#/components/schemas/ServerlessBackupSnapshot" }, "readOnly" : true }, @@ -43636,7 +45387,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/BillingInvoiceMetadata" }, @@ -43668,7 +45419,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/BillingInvoice" }, @@ -43700,7 +45451,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/StreamsConnection" }, @@ -43715,6 +45466,38 @@ } } }, + "PaginatedApiStreamsPrivateLinkView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", + "items" : { + "$ref" : "#/components/schemas/StreamsPrivateLinkConnection" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, "PaginatedApiStreamsStreamProcessorWithStatsView" : { "type" : "object", "properties" : { @@ -43732,7 +45515,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/StreamsProcessorWithStats" }, @@ -43764,7 +45547,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/StreamsTenant" }, @@ -43796,7 +45579,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/UserAccessListResponse" }, @@ -43811,6 +45594,38 @@ } } }, + "PaginatedApiVersions" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ApiVersion" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, "PaginatedAppUserView" : { "type" : "object", "properties" : { @@ -43828,7 +45643,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/CloudAppUser" }, @@ -43860,7 +45675,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/Group" }, @@ -43892,7 +45707,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/MdbAvailableVersion" }, @@ -43924,7 +45739,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" }, @@ -43956,7 +45771,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/DiskBackupSnapshotExportBucket" }, @@ -43988,7 +45803,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/DiskBackupSnapshot" }, @@ -44020,7 +45835,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/DiskBackupReplicaSet" }, @@ -44052,7 +45867,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/DiskBackupSnapshotRestoreJob" }, @@ -44084,7 +45899,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/DiskBackupShardedClusterSnapshot" }, @@ -44117,7 +45932,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/CloudProviderContainer" }, @@ -44150,7 +45965,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ClusterDescription20240805" }, @@ -44182,7 +45997,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ConnectedOrgConfig" }, @@ -44215,7 +46030,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" }, @@ -44247,7 +46062,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/MesurementsDatabase" }, @@ -44279,7 +46094,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/MeasurementDiskPartition" }, @@ -44311,7 +46126,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/EventTypeDetails" }, @@ -44343,7 +46158,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/FederationIdentityProvider" }, @@ -44358,9 +46173,41 @@ } } }, + "PaginatedFlexClusters20250101" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", + "items" : { + "type" : "object" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, "PaginatedGroupServiceAccounts" : { "type" : "object", - "description" : "List of Service Accounts", + "description" : "A list of Project Service Accounts.", "properties" : { "links" : { "type" : "array", @@ -44376,7 +46223,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/GroupServiceAccount" }, @@ -44408,7 +46255,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ApiHostView_Atlas" }, @@ -44440,7 +46287,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ThirdPartyIntegration" }, @@ -44472,7 +46319,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/LegacyAtlasCluster" }, @@ -44504,7 +46351,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/NetworkPermissionEntry" }, @@ -44536,7 +46383,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/BackupOnlineArchive" }, @@ -44568,7 +46415,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/OrgGroup" }, @@ -44585,7 +46432,7 @@ }, "PaginatedOrgServiceAccounts" : { "type" : "object", - "description" : "List of Service Accounts", + "description" : "A list of Organization Service Accounts.", "properties" : { "links" : { "type" : "array", @@ -44601,7 +46448,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/OrgServiceAccount" }, @@ -44633,7 +46480,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/AtlasOrganization" }, @@ -44665,7 +46512,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/IngestionPipelineRun" }, @@ -44697,7 +46544,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/PrivateNetworkEndpointIdEntry" }, @@ -44729,7 +46576,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/PublicApiUsageDetailsLineItemView" }, @@ -44761,7 +46608,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/BackupRestoreJob" }, @@ -44794,7 +46641,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/AuthFederationRoleMapping" }, @@ -44826,7 +46673,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ServerlessInstanceDescription" }, @@ -44843,7 +46690,7 @@ }, "PaginatedServiceAccountGroup" : { "type" : "object", - "description" : "List of Service Account projects.", + "description" : "A list of projects associated with the Service Account.", "properties" : { "links" : { "type" : "array", @@ -44859,7 +46706,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ServiceAccountGroup" }, @@ -44874,7 +46721,7 @@ } } }, - "PaginatedSnapshotView" : { + "PaginatedServiceAccountIPAccessEntryView" : { "type" : "object", "properties" : { "links" : { @@ -44891,9 +46738,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/BackupSnapshot" + "$ref" : "#/components/schemas/ServiceAccountIPAccessListEntry" }, "readOnly" : true }, @@ -44906,7 +46753,7 @@ } } }, - "PaginatedTeamRoleView" : { + "PaginatedSnapshotView" : { "type" : "object", "properties" : { "links" : { @@ -44923,9 +46770,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/TeamRole" + "$ref" : "#/components/schemas/BackupSnapshot" }, "readOnly" : true }, @@ -44938,7 +46785,7 @@ } } }, - "PaginatedTeamView" : { + "PaginatedTeamRoleView" : { "type" : "object", "properties" : { "links" : { @@ -44955,9 +46802,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/TeamResponse" + "$ref" : "#/components/schemas/TeamRole" }, "readOnly" : true }, @@ -44970,7 +46817,7 @@ } } }, - "PaginatedTenantRestoreView" : { + "PaginatedTeamView" : { "type" : "object", "properties" : { "links" : { @@ -44987,9 +46834,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/TenantRestore" + "$ref" : "#/components/schemas/TeamResponse" }, "readOnly" : true }, @@ -45002,7 +46849,7 @@ } } }, - "PaginatedTenantSnapshotView" : { + "PaginatedTenantRestoreView" : { "type" : "object", "properties" : { "links" : { @@ -45019,9 +46866,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/BackupTenantSnapshot" + "$ref" : "#/components/schemas/TenantRestore" }, "readOnly" : true }, @@ -45034,7 +46881,7 @@ } } }, - "PaginatedUSSInstance20250101" : { + "PaginatedTenantSnapshotView" : { "type" : "object", "properties" : { "links" : { @@ -45051,9 +46898,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "type" : "object" + "$ref" : "#/components/schemas/BackupTenantSnapshot" }, "readOnly" : true }, @@ -45083,7 +46930,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/UserCert" }, @@ -45590,6 +47437,14 @@ "PrivateNetworkEndpointIdEntry" : { "type" : "object", "properties" : { + "azureConnectionName" : { + "type" : "string", + "description" : "Connection name that identifies the Azure private endpoint connection." + }, + "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." @@ -45598,6 +47453,11 @@ "type" : "string", "description" : "Human-readable label to identify customer's VPC endpoint DNS name." }, + "customerEndpointIPAddress" : { + "type" : "string", + "description" : "IP address used to connect to the Azure private endpoint.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + }, "endpointId" : { "type" : "string", "description" : "Unique 22-character alphanumeric string that identifies the private endpoint.", @@ -45610,6 +47470,10 @@ "minLength" : 22, "pattern" : "^vpce-[0-9a-f]{17}$" }, + "errorMessage" : { + "type" : "string", + "description" : "Error message describing a failure approving the private endpoint request." + }, "provider" : { "type" : "string", "default" : "AWS", @@ -45620,6 +47484,11 @@ "type" : "string", "description" : "Human-readable label to identify the region of customer's VPC endpoint." }, + "status" : { + "type" : "string", + "description" : "Status of the private endpoint connection request.", + "enum" : [ "PENDING", "OK", "FAILED", "DELETING" ] + }, "type" : { "type" : "string", "default" : "DATA_LAKE", @@ -45676,20 +47545,6 @@ "required" : [ "enabled", "serviceDiscovery", "username" ], "title" : "PROMETHEUS" }, - "ProxyInfo" : { - "type" : "object", - "description" : "VPC Proxy Information.", - "properties" : { - "authKey" : { - "type" : "string", - "description" : "Authentication key for the proxy." - }, - "dnsName" : { - "type" : "string", - "description" : "DNS name to use to reach the proxy/s." - } - } - }, "PublicApiUsageDetailsLineItemView" : { "type" : "object", "properties" : { @@ -45787,7 +47642,9 @@ "enum" : [ "AVERAGE" ] }, "operator" : { - "$ref" : "#/components/schemas/Operator" + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, "threshold" : { "type" : "number", @@ -45835,7 +47692,7 @@ "example" : "cluster1", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -46077,7 +47934,9 @@ "enum" : [ "AVERAGE" ] }, "operator" : { - "$ref" : "#/components/schemas/Operator" + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, "threshold" : { "type" : "number", @@ -46255,7 +48114,7 @@ "example" : "cluster1", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -46535,472 +48394,69 @@ } }, "zoneName" : { - "type" : "string", - "description" : "Human-readable label that identifies the zone in a Global Cluster. Provide this value only if `\"clusterType\" : \"GEOSHARDED\"`." - } - }, - "title" : "Replication Specifications" - }, - "ReplicationSpec20240805" : { - "type" : "object", - "description" : "Details that explain how MongoDB Cloud replicates data on the specified MongoDB database.", - "properties" : { - "id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a shard in a Cluster. If you include existing shard replication configurations in the request, you must specify this parameter. If you add a new shard to an existing Cluster, you may specify this parameter. The request deletes any existing shards in the Cluster that you exclude from the request.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "regionConfigs" : { - "type" : "array", - "description" : "Hardware specifications for nodes set for a given region. 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**.\n\n**Example:**\n\nIf you set `\"replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize\" : \"M30\"`, set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : `\"M30\"` if you have electable nodes and `\"replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize\" : `\"M30\"` if you have read-only nodes.", - "items" : { - "$ref" : "#/components/schemas/CloudRegionConfig20240805" - } - }, - "zoneId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the zone in a Global Cluster. This value can be used to configure Global Cluster backup policies.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "zoneName" : { - "type" : "string", - "description" : "Human-readable label that describes the zone this shard belongs to in a Global Cluster. Provide this value only if \"clusterType\" : \"GEOSHARDED\" but not \"selfManagedSharding\" : true." - } - }, - "title" : "Replication Specifications" - }, - "RequestAccepted" : { - "type" : "object", - "description" : "Accepted" - }, - "ResourceEventTypeView" : { - "type" : "string", - "description" : "Unique identifier of event type.", - "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], - "example" : "TAGS_MODIFIED", - "title" : "Resource Event Types" - }, - "ResourceEventTypeViewForOrg" : { - "type" : "string", - "description" : "Unique identifier of event type.", - "enum" : [ "GROUP_TAGS_MODIFIED" ], - "example" : "GROUP_TAGS_MODIFIED", - "title" : "Resource Event Types" - }, - "ResourceEventViewForNdsGroup" : { - "type" : "object", - "description" : "Resource event reflects different activities about resources.", - "properties" : { - "apiKeyId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "created" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true - }, - "eventTypeName" : { - "$ref" : "#/components/schemas/ResourceEventTypeView" - }, - "groupId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "isGlobalAdmin" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", - "readOnly" : true - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - }, - "orgId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "publicKey" : { - "type" : "string", - "format" : "email", - "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "example" : "test.user@mongodb.com", - "readOnly" : true - }, - "raw" : { - "$ref" : "#/components/schemas/raw" - }, - "remoteAddress" : { - "type" : "string", - "description" : "IPv4 or IPv6 address from which the user triggered this event.", - "example" : "216.172.40.186", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", - "readOnly" : true - }, - "resourceId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the resource associated with the event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "resourceType" : { - "type" : "string", - "description" : "Unique identifier of resource type.", - "example" : "cluster" - }, - "userId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "username" : { - "type" : "string", - "format" : "email", - "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", - "example" : "test.user@mongodb.com", - "readOnly" : true - } - }, - "required" : [ "created", "eventTypeName", "id", "resourceType" ], - "title" : "Resource Events" - }, - "ResourceEventViewForOrg" : { - "type" : "object", - "description" : "Resource event reflects different activities about resources.", - "properties" : { - "apiKeyId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "created" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true - }, - "eventTypeName" : { - "$ref" : "#/components/schemas/ResourceEventTypeViewForOrg" - }, - "groupId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "isGlobalAdmin" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", - "readOnly" : true - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - }, - "orgId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "publicKey" : { - "type" : "string", - "format" : "email", - "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "example" : "test.user@mongodb.com", - "readOnly" : true - }, - "raw" : { - "$ref" : "#/components/schemas/raw" - }, - "remoteAddress" : { - "type" : "string", - "description" : "IPv4 or IPv6 address from which the user triggered this event.", - "example" : "216.172.40.186", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", - "readOnly" : true - }, - "resourceId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the resource associated with the event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "resourceType" : { - "type" : "string", - "description" : "Unique identifier of resource type.", - "example" : "cluster" - }, - "userId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "username" : { - "type" : "string", - "format" : "email", - "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", - "example" : "test.user@mongodb.com", - "readOnly" : true - } - }, - "required" : [ "created", "eventTypeName", "id", "resourceType" ], - "title" : "Resource Events" - }, - "ResourceTag" : { - "type" : "object", - "description" : "Key-value pair that tags and categorizes a MongoDB Cloud organization, project, or cluster. For example, `environment : production`.", - "properties" : { - "key" : { - "type" : "string", - "description" : "Constant that defines the set of the tag. For example, `environment` in the `environment : production` tag.", - "maxLength" : 255, - "minLength" : 1 - }, - "value" : { - "type" : "string", - "description" : "Variable that belongs to the set of the tag. For example, `production` in the `environment : production` tag.", - "maxLength" : 255, - "minLength" : 1 - } - }, - "required" : [ "key", "value" ], - "title" : "Resource Tag" - }, - "RestoreJobFileHash" : { - "type" : "object", - "description" : "Key and value pair that map one restore file to one hashed checksum. This parameter applies after you download the corresponding **delivery.url**.", - "properties" : { - "fileName" : { - "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.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - }, - "typeName" : { - "type" : "string", - "description" : "Human-readable label that identifies the hashing algorithm used to compute the hash value.", - "enum" : [ "SHA1" ], - "readOnly" : true - } - }, - "readOnly" : true - }, - "RoleAssignment" : { - "type" : "object", - "properties" : { - "groupId" : { - "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", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" - }, - "orgId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization to which this role belongs. Each element within **roleAssignments** can have a value for **orgId** or **groupId**, but not both.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" - }, - "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.\n\nOrganization Roles\n\n* ORG_OWNER\n* ORG_MEMBER\n* ORG_GROUP_CREATOR\n* ORG_BILLING_ADMIN\n* ORG_READ_ONLY\n\nProject Roles\n\n* GROUP_CLUSTER_MANAGER\n* GROUP_DATA_ACCESS_ADMIN\n* GROUP_DATA_ACCESS_READ_ONLY\n* GROUP_DATA_ACCESS_READ_WRITE\n* GROUP_OWNER\n* GROUP_READ_ONLY\n* GROUP_SEARCH_INDEX_EDITOR\n* GROUP_STREAM_PROCESSING_OWNER\n\n", - "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] - } - } - }, - "SMSNotification" : { - "type" : "object", - "description" : "SMS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", - "properties" : { - "delayMin" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." - }, - "intervalMin" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", - "minimum" : 5 - }, - "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" : { - "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" ] + "type" : "string", + "description" : "Human-readable label that identifies the zone in a Global Cluster. Provide this value only if `\"clusterType\" : \"GEOSHARDED\"`." } }, - "required" : [ "typeName" ], - "title" : "SMS Notification" + "title" : "Replication Specifications" }, - "SampleDatasetStatus" : { + "ReplicationSpec20240805" : { "type" : "object", + "description" : "Details that explain how MongoDB Cloud replicates data on the specified MongoDB database.", "properties" : { - "_id" : { + "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies this sample dataset.", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a shard in a Cluster. If you include existing shard replication configurations in the request, you must specify this parameter. If you add a new shard to an existing Cluster, you may specify this parameter. The request deletes any existing shards in the Cluster that you exclude from the request.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "clusterName" : { - "type" : "string", - "description" : "Human-readable label that identifies the cluster into which you loaded the sample dataset.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "readOnly" : true - }, - "completeDate" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when the sample dataset load job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", - "readOnly" : true - }, - "createDate" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when you started the sample dataset load job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", - "readOnly" : true + "regionConfigs" : { + "type" : "array", + "description" : "Hardware specifications for nodes set for a given region. 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**.\n\n**Example:**\n\nIf you set `\"replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize\" : \"M30\"`, set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : `\"M30\"` if you have electable nodes and `\"replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize\" : `\"M30\"` if you have read-only nodes.", + "items" : { + "$ref" : "#/components/schemas/CloudRegionConfig20240805" + } }, - "errorMessage" : { + "zoneId" : { "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.", + "description" : "Unique 24-hexadecimal digit string that identifies the zone in a Global Cluster. This value can be used to configure Global Cluster backup policies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "state" : { + "zoneName" : { "type" : "string", - "description" : "Status of the sample dataset load job.", - "enum" : [ "WORKING", "FAILED", "COMPLETED" ], - "readOnly" : true + "description" : "Human-readable label that describes the zone this shard belongs to in a Global Cluster. Provide this value only if \"clusterType\" : \"GEOSHARDED\" but not \"selfManagedSharding\" : true." } - } + }, + "title" : "Replication Specifications" }, - "SearchDeploymentAuditTypeView" : { + "RequestAccepted" : { + "type" : "object", + "description" : "Accepted" + }, + "ResourceEventTypeView" : { "type" : "string", "description" : "Unique identifier of event type.", - "enum" : [ "SEARCH_DEPLOYMENT_CREATED", "SEARCH_DEPLOYMENT_UPDATED", "SEARCH_DEPLOYMENT_DELETED" ], - "example" : "SEARCH_DEPLOYMENT_CREATED", - "title" : "Search Deployment Audit Types" + "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], + "example" : "TAGS_MODIFIED", + "title" : "Resource Event Types" }, - "SearchDeploymentAuditView" : { + "ResourceEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "GROUP_TAGS_MODIFIED" ], + "example" : "GROUP_TAGS_MODIFIED", + "title" : "Resource Event Types" + }, + "ResourceEventViewForNdsGroup" : { "type" : "object", - "description" : "Indicates activities on decoupled search nodes.", + "description" : "Resource event reflects different activities about resources.", "properties" : { "apiKeyId" : { "type" : "string", @@ -47018,7 +48474,7 @@ "readOnly" : true }, "eventTypeName" : { - "$ref" : "#/components/schemas/SearchDeploymentAuditTypeView" + "$ref" : "#/components/schemas/ResourceEventTypeView" }, "groupId" : { "type" : "string", @@ -47069,6 +48525,7 @@ "type" : "string", "format" : "email", "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true }, "raw" : { @@ -47081,6 +48538,20 @@ "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", "readOnly" : true }, + "resourceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the resource associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resourceType" : { + "type" : "string", + "description" : "Unique identifier of resource type.", + "example" : "cluster" + }, "userId" : { "type" : "string", "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", @@ -47098,541 +48569,159 @@ "readOnly" : true } }, - "required" : [ "created", "eventTypeName", "id" ], - "title" : "Search Deployment Audits" - }, - "SearchHostStatusDetail" : { - "type" : "object", - "properties" : { - "hostname" : { - "type" : "string", - "description" : "Hostname that corresponds to the status detail." - }, - "mainIndex" : { - "$ref" : "#/components/schemas/SearchMainIndexStatusDetail" - }, - "queryable" : { - "type" : "boolean", - "description" : "Flag that indicates whether the index is queryable on the host." - }, - "stagedIndex" : { - "$ref" : "#/components/schemas/SearchStagedIndexStatusDetail" - }, - "status" : { - "type" : "string", - "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", - "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] - } - }, - "title" : "Search Host Status Detail" - }, - "SearchIndex" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/ClusterSearchIndex" - }, { - "type" : "object", - "properties" : { - "analyzer" : { - "type" : "string", - "default" : "lucene.standard", - "description" : "Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves a variety of changes made to the text in fields:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\n MongoDB Cloud uses the selected process to build the Atlas Search index.", - "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ], - "externalDocs" : { - "description" : "Atlas Search Analyzers", - "url" : "https://dochub.mongodb.org/core/analyzers--fts" - } - }, - "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" - }, - "items" : { - "$ref" : "#/components/schemas/ApiAtlasFTSAnalyzersViewManual" - } - }, - "mappings" : { - "$ref" : "#/components/schemas/ApiAtlasFTSMappingsViewManual" - }, - "searchAnalyzer" : { - "type" : "string", - "default" : "lucene.standard", - "description" : "Method applied to identify words when searching this index.", - "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] - }, - "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" - }, - "items" : { - "$ref" : "#/components/schemas/SearchSynonymMappingDefinition" - } - } - } - } ], - "required" : [ "collectionName", "database", "name" ] - }, - "SearchIndexCreateRequest" : { - "type" : "object", - "discriminator" : { - "mapping" : { - "search" : "#/components/schemas/TextSearchIndexCreateRequest", - "vectorSearch" : "#/components/schemas/VectorSearchIndexCreateRequest" - }, - "propertyName" : "type" - }, - "properties" : { - "collectionName" : { - "type" : "string", - "description" : "Label that identifies the collection to create an Atlas Search index in." - }, - "database" : { - "type" : "string", - "description" : "Label that identifies the database that contains the collection to create an Atlas Search index in." - }, - "name" : { - "type" : "string", - "description" : "Label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique." - }, - "type" : { - "type" : "string", - "description" : "Type of the index. The default type is search.", - "enum" : [ "search", "vectorSearch" ] - } - }, - "required" : [ "collectionName", "database", "name" ] - }, - "SearchIndexDefinition" : { - "type" : "object", - "description" : "The search index definition set by the user.", - "title" : "Search Index Definition" - }, - "SearchIndexDefinitionVersion" : { - "type" : "object", - "description" : "Object which includes the version number of the index definition and the time that the index definition was created.", - "properties" : { - "createdAt" : { - "type" : "string", - "format" : "date-time", - "description" : "The time at which this index definition was created." - }, - "version" : { - "type" : "integer", - "format" : "int64", - "description" : "The version number associated with this index definition when it was created." - } - }, - "title" : "Search Index Definition Version" + "required" : [ "created", "eventTypeName", "id", "resourceType" ], + "title" : "Resource Events" }, - "SearchIndexResponse" : { + "ResourceEventViewForOrg" : { "type" : "object", - "discriminator" : { - "mapping" : { - "search" : "#/components/schemas/TextSearchIndexResponse", - "vectorSearch" : "#/components/schemas/VectorSearchIndexResponse" - }, - "propertyName" : "type" - }, + "description" : "Resource event reflects different activities about resources.", "properties" : { - "collectionName" : { - "type" : "string", - "description" : "Label that identifies the collection that contains one or more Atlas Search indexes." - }, - "database" : { - "type" : "string", - "description" : "Label that identifies the database that contains the collection with one or more Atlas Search indexes." - }, - "indexID" : { + "apiKeyId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies this Atlas Search index.", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" - }, - "latestDefinition" : { - "$ref" : "#/components/schemas/SearchIndexDefinition" - }, - "latestDefinitionVersion" : { - "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" - }, - "name" : { - "type" : "string", - "description" : "Label that identifies this index. Within each namespace, the names of all indexes must be unique." - }, - "queryable" : { - "type" : "boolean", - "description" : "Flag that indicates whether the index is queryable on all hosts." - }, - "status" : { - "type" : "string", - "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", - "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] - }, - "statusDetail" : { - "type" : "array", - "description" : "List of documents detailing index status on each host.", - "items" : { - "$ref" : "#/components/schemas/SearchHostStatusDetail" - } - }, - "type" : { - "type" : "string", - "description" : "Type of the index. The default type is search.", - "enum" : [ "search", "vectorSearch" ] - } - }, - "title" : "Search Index Response" - }, - "SearchIndexUpdateRequest" : { - "type" : "object", - "properties" : { - "definition" : { - "type" : "object", - "description" : "The index definition to update the search index to.", - "oneOf" : [ { - "$ref" : "#/components/schemas/TextSearchIndexDefinition" - }, { - "$ref" : "#/components/schemas/VectorSearchIndexDefinition" - } ] - } - }, - "required" : [ "definition" ], - "title" : "Search Index Update Request" - }, - "SearchMainIndexStatusDetail" : { - "type" : "object", - "description" : "Contains status information about the active index.", - "properties" : { - "definition" : { - "$ref" : "#/components/schemas/SearchIndexDefinition" - }, - "definitionVersion" : { - "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" - }, - "message" : { - "type" : "string", - "description" : "Optional message describing an error." - }, - "queryable" : { - "type" : "boolean", - "description" : "Flag that indicates whether the index generation is queryable on the host." - }, - "status" : { - "type" : "string", - "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", - "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] - } - }, - "title" : "Search Main Index Status Detail" - }, - "SearchMappings" : { - "type" : "object", - "description" : "Index specifications for the collection's fields.", - "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/field-mapping-definition-fts#static-and-dynamic-mappings" - } - }, - "fields" : { - "type" : "object", - "additionalProperties" : { - "type" : "object", - "description" : "One or more field specifications for the Atlas Search index. Required if **mappings.dynamic** is omitted or set to **false**.", - "externalDocs" : { - "description" : "Atlas Search Index", - "url" : "https://dochub.mongodb.org/core/index-definitions-fts" - }, - "x-additionalPropertiesName" : "Field Name" - }, - "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" - }, - "x-additionalPropertiesName" : "Field Name" - } - }, - "title" : "Mappings" - }, - "SearchStagedIndexStatusDetail" : { - "type" : "object", - "description" : "Contains status information about an index building in the background.", - "properties" : { - "definition" : { - "$ref" : "#/components/schemas/SearchIndexDefinition" - }, - "definitionVersion" : { - "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" - }, - "message" : { - "type" : "string", - "description" : "Optional message describing an error." - }, - "queryable" : { - "type" : "boolean", - "description" : "Flag that indicates whether the index generation is queryable on the host." + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "status" : { - "type" : "string", - "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", - "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] - } - }, - "title" : "Search Staged Index Status Detail" - }, - "SearchSynonymMappingDefinition" : { - "type" : "object", - "description" : "Synonyms used for this full text index.", - "properties" : { - "analyzer" : { + "created" : { "type" : "string", - "description" : "Specific pre-defined method chosen to apply to the synonyms to be searched.", - "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true }, - "name" : { - "type" : "string", - "description" : "Label that identifies the synonym definition. Each **synonym.name** must be unique within the same index definition." + "eventTypeName" : { + "$ref" : "#/components/schemas/ResourceEventTypeViewForOrg" }, - "source" : { - "$ref" : "#/components/schemas/SynonymSource" - } - }, - "required" : [ "analyzer", "name", "source" ], - "title" : "Synonym Mapping Definition" - }, - "ServerlessAWSTenantEndpoint" : { - "type" : "object", - "description" : "View for a serverless AWS tenant endpoint.", - "properties" : { - "_id" : { + "groupId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "cloudProviderEndpointId" : { - "type" : "string", - "description" : "Unique string that identifies the private endpoint's network interface.", - "pattern" : "^vpce-[0-9a-f]{17}$", - "readOnly" : true - }, - "comment" : { - "type" : "string", - "description" : "Human-readable comment associated with the private endpoint.", - "maxLength" : 80, - "readOnly" : true - }, - "endpointServiceName" : { + "id" : { "type" : "string", - "description" : "Unique string that identifies the Amazon Web Services (AWS) PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", - "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "errorMessage" : { - "type" : "string", - "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", "readOnly" : true }, - "providerName" : { - "type" : "string", - "description" : "Human-readable label that identifies the cloud service provider.", - "enum" : [ "AWS" ], + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, "readOnly" : true }, - "status" : { - "type" : "string", - "description" : "Human-readable label that indicates the current operating status of the private endpoint.", - "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], - "readOnly" : true - } - }, - "title" : "AWS" - }, - "ServerlessAWSTenantEndpointUpdate" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" - }, { - "type" : "object", - "properties" : { - "cloudProviderEndpointId" : { - "type" : "string", - "description" : "Unique string that identifies the private endpoint's network interface.", - "pattern" : "^vpce-[0-9a-f]{17}$", - "writeOnly" : true - } - } - } ], - "description" : "Updates to a serverless AWS tenant endpoint.", - "required" : [ "providerName" ], - "title" : "AWS" - }, - "ServerlessAzureTenantEndpoint" : { - "type" : "object", - "description" : "View for a serverless Azure tenant endpoint.", - "properties" : { - "_id" : { + "orgId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "cloudProviderEndpointId" : { - "type" : "string", - "description" : "Unique string that identifies the Azure private endpoint's network interface that someone added to this private endpoint service.", - "pattern" : "^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\\.Network/privateEndpoints/[-\\w._()]+$", - "readOnly" : true - }, - "comment" : { + "publicKey" : { "type" : "string", - "description" : "Human-readable comment associated with the private endpoint.", - "maxLength" : 80, + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true }, - "endpointServiceName" : { - "type" : "string", - "description" : "Unique string that identifies the Azure private endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", - "pattern" : "^pls_[0-9a-f]{24}$", - "readOnly" : true + "raw" : { + "$ref" : "#/components/schemas/raw" }, - "errorMessage" : { + "remoteAddress" : { "type" : "string", - "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", "readOnly" : true }, - "privateEndpointIpAddress" : { + "resourceId" : { "type" : "string", - "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "description" : "Unique 24-hexadecimal digit string that identifies the resource associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "privateLinkServiceResourceId" : { + "resourceType" : { "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 + "description" : "Unique identifier of resource type.", + "example" : "cluster" }, - "providerName" : { + "userId" : { "type" : "string", - "description" : "Human-readable label that identifies the cloud service provider.", - "enum" : [ "AZURE" ], + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "status" : { + "username" : { "type" : "string", - "description" : "Human-readable label that indicates the current operating status of the private endpoint.", - "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true } }, - "title" : "Azure" - }, - "ServerlessAzureTenantEndpointUpdate" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" - }, { - "type" : "object", - "properties" : { - "cloudProviderEndpointId" : { - "type" : "string", - "description" : "Unique string that identifies the Azure private endpoint's network interface for this private endpoint service.", - "pattern" : "^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\\.Network/privateEndpoints/[-\\w._()]+$", - "writeOnly" : true - }, - "privateEndpointIpAddress" : { - "type" : "string", - "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", - "writeOnly" : true - } - } - } ], - "description" : "Updates to a serverless Azure tenant endpoint.", - "required" : [ "providerName" ], - "title" : "AZURE" + "required" : [ "created", "eventTypeName", "id", "resourceType" ], + "title" : "Resource Events" }, - "ServerlessBackupRestoreJob" : { + "ResourceTag" : { "type" : "object", + "description" : "Key-value pair that tags and categorizes a MongoDB Cloud organization, project, or cluster. For example, `environment : production`.", "properties" : { - "cancelled" : { - "type" : "boolean", - "description" : "Flag that indicates whether someone canceled this restore job.", - "readOnly" : true - }, - "deliveryType" : { + "key" : { "type" : "string", - "description" : "Human-readable label that categorizes the restore job to create.", - "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\"`.", - "items" : { - "type" : "string", - "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download." - }, - "readOnly" : true - }, - "desiredTimestamp" : { - "$ref" : "#/components/schemas/ApiBSONTimestampView" - }, - "expired" : { - "type" : "boolean", - "description" : "Flag that indicates whether the restore job expired.", - "readOnly" : true + "description" : "Constant that defines the set of the tag. For example, `environment` in the `environment : production` tag.", + "maxLength" : 255, + "minLength" : 1 }, - "expiresAt" : { + "value" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when the restore job expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true - }, - "failed" : { - "type" : "boolean", - "description" : "Flag that indicates whether the restore job failed.", - "readOnly" : true - }, - "finishedAt" : { + "description" : "Variable that belongs to the set of the tag. For example, `production` in the `environment : production` tag.", + "maxLength" : 255, + "minLength" : 1 + } + }, + "required" : [ "key", "value" ], + "title" : "Resource Tag" + }, + "RestoreJobFileHash" : { + "type" : "object", + "description" : "Key and value pair that map one restore file to one hashed checksum. This parameter applies after you download the corresponding **delivery.url**.", + "properties" : { + "fileName" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when the restore job completed. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Human-readable label that identifies the hashed file.", "readOnly" : true }, - "id" : { + "hash" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the restore job.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "description" : "Hashed checksum that maps to the restore file.", "readOnly" : true }, "links" : { @@ -47647,87 +48736,173 @@ }, "readOnly" : true }, - "oplogInc" : { - "type" : "integer", - "format" : "int32", - "description" : "Oplog operation number from which you want to restore this snapshot. This number represents the second part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", - "example" : 1, - "minimum" : 1 + "typeName" : { + "type" : "string", + "description" : "Human-readable label that identifies the hashing algorithm used to compute the hash value.", + "enum" : [ "SHA1" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "RoleAssignment" : { + "type" : "object", + "properties" : { + "groupId" : { + "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", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" }, - "oplogTs" : { + "orgId" : { + "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", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "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.\n\nOrganization Roles\n\n* ORG_OWNER\n* ORG_MEMBER\n* ORG_GROUP_CREATOR\n* ORG_BILLING_ADMIN\n* ORG_READ_ONLY\n\nProject Roles\n\n* GROUP_CLUSTER_MANAGER\n* GROUP_DATA_ACCESS_ADMIN\n* GROUP_DATA_ACCESS_READ_ONLY\n* GROUP_DATA_ACCESS_READ_WRITE\n* GROUP_OWNER\n* GROUP_READ_ONLY\n* GROUP_SEARCH_INDEX_EDITOR\n* GROUP_STREAM_PROCESSING_OWNER\n\n", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + } + }, + "SMSNotification" : { + "type" : "object", + "description" : "SMS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { "type" : "integer", "format" : "int32", - "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`.", - "minimum" : 1199145600 + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." }, - "pointInTimeUTCSeconds" : { + "intervalMin" : { "type" : "integer", "format" : "int32", - "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`.", - "minimum" : 1199145600 + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 }, - "snapshotId" : { + "mobileNumber" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "description" : "Mobile phone number to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"SMS\"`.", + "example" : "1233337892" + }, + "notifierId" : { + "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" ] + } + }, + "required" : [ "typeName" ], + "title" : "SMS Notification" + }, + "SampleDatasetStatus" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies this sample dataset.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "targetClusterName" : { + "clusterName" : { "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\"`.", + "description" : "Human-readable label that identifies the cluster into which you loaded the sample dataset.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "readOnly" : true }, - "targetGroupId" : { + "completeDate" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the target project for the specified **targetClusterName**.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" + "format" : "date-time", + "description" : "Date and time when the sample dataset load job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true }, - "timestamp" : { + "createDate" : { "type" : "string", "format" : "date-time", - "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.", + "description" : "Date and time when you started the sample dataset load job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "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.", + "enum" : [ "WORKING", "FAILED", "COMPLETED" ], "readOnly" : true } - }, - "required" : [ "deliveryType", "targetClusterName", "targetGroupId" ] + } }, - "ServerlessBackupSnapshot" : { + "SearchDeploymentAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "SEARCH_DEPLOYMENT_CREATED", "SEARCH_DEPLOYMENT_UPDATED", "SEARCH_DEPLOYMENT_DELETED" ], + "example" : "SEARCH_DEPLOYMENT_CREATED", + "title" : "Search Deployment Audit Types" + }, + "SearchDeploymentAuditView" : { "type" : "object", + "description" : "Indicates activities on decoupled search nodes.", "properties" : { - "createdAt" : { + "apiKeyId" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "expiresAt" : { + "created" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "frequencyType" : { + "eventTypeName" : { + "$ref" : "#/components/schemas/SearchDeploymentAuditTypeView" + }, + "groupId" : { "type" : "string", - "description" : "Human-readable label that identifies how often this snapshot triggers.", - "enum" : [ "hourly", "daily", "weekly", "monthly" ], + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, "links" : { "type" : "array", "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", @@ -47740,450 +48915,445 @@ }, "readOnly" : true }, - "mongodVersion" : { + "orgId" : { "type" : "string", - "description" : "Version of the MongoDB host that this snapshot backs up.", - "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "serverlessInstanceName" : { + "publicKey" : { "type" : "string", - "description" : "Human-readable label given to the serverless instance from which MongoDB Cloud took this snapshot.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", "readOnly" : true }, - "snapshotType" : { + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { "type" : "string", - "description" : "Human-readable label that identifies when this snapshot triggers.", - "enum" : [ "onDemand", "scheduled" ], + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", "readOnly" : true }, - "status" : { + "userId" : { "type" : "string", - "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", - "enum" : [ "queued", "inProgress", "completed", "failed" ], + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "storageSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "Number of bytes taken to store the backup snapshot.", + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true } - } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Search Deployment Audits" }, - "ServerlessConnectionStringsPrivateEndpointItem" : { + "SearchHostStatusDetail" : { "type" : "object", - "description" : "Details of a private endpoint deployed for this serverless instance.", "properties" : { - "endpointId" : { + "hostname" : { "type" : "string", - "description" : "Unique string that the cloud provider uses to identify the private endpoint.", - "readOnly" : true + "description" : "Hostname that corresponds to the status detail." }, - "providerName" : { - "type" : "string", - "description" : "Cloud provider where the private endpoint is deployed.", - "enum" : [ "AWS", "AZURE" ], - "readOnly" : true + "mainIndex" : { + "$ref" : "#/components/schemas/SearchMainIndexStatusDetail" }, - "region" : { + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on the host." + }, + "stagedIndex" : { + "$ref" : "#/components/schemas/SearchStagedIndexStatusDetail" + }, + "status" : { "type" : "string", - "description" : "Region where the private endpoint is deployed.", - "readOnly" : true + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] } }, - "title" : "Serverless Instance Private Endpoint Connection Strings Endpoint" + "title" : "Search Host Status Detail" }, - "ServerlessConnectionStringsPrivateEndpointList" : { + "SearchIndex" : { "type" : "object", - "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/" + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, { + "type" : "object", + "properties" : { + "analyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves a variety of changes made to the text in fields:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\n MongoDB Cloud uses the selected process to build the Atlas Search index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ], + "externalDocs" : { + "description" : "Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/analyzers--fts" + } + }, + "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" + }, + "items" : { + "$ref" : "#/components/schemas/ApiAtlasFTSAnalyzersViewManual" + } + }, + "mappings" : { + "$ref" : "#/components/schemas/ApiAtlasFTSMappingsViewManual" + }, + "searchAnalyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Method applied to identify words when searching this index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] + }, + "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" + }, + "items" : { + "$ref" : "#/components/schemas/SearchSynonymMappingDefinition" + } + } + } + } ], + "required" : [ "collectionName", "database", "name" ] + }, + "SearchIndexCreateRequest" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "search" : "#/components/schemas/TextSearchIndexCreateRequest", + "vectorSearch" : "#/components/schemas/VectorSearchIndexCreateRequest" + }, + "propertyName" : "type" }, "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**.", - "items" : { - "$ref" : "#/components/schemas/ServerlessConnectionStringsPrivateEndpointItem" - }, - "readOnly" : true + "collectionName" : { + "type" : "string", + "description" : "Label that identifies the collection to create an Atlas Search index in." }, - "srvConnectionString" : { + "database" : { "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 + "description" : "Label that identifies the database that contains the collection to create an Atlas Search index in." + }, + "name" : { + "type" : "string", + "description" : "Label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique." }, "type" : { "type" : "string", - "description" : "MongoDB process type to which your application connects.", - "enum" : [ "MONGOS" ], - "readOnly" : true + "description" : "Type of the index. The default type is search.", + "enum" : [ "search", "vectorSearch" ] } }, - "title" : "Serverless Instance Private Endpoint Connection String" + "required" : [ "collectionName", "database", "name" ] }, - "ServerlessEventTypeViewAlertable" : { - "type" : "string", - "description" : "Event type that triggers an alert.", - "enum" : [ "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], - "example" : "OUTSIDE_SERVERLESS_METRIC_THRESHOLD", - "title" : "Serverless Event Types" + "SearchIndexDefinition" : { + "type" : "object", + "description" : "The search index definition set by the user.", + "title" : "Search Index Definition" + }, + "SearchIndexDefinitionVersion" : { + "type" : "object", + "description" : "Object which includes the version number of the index definition and the time that the index definition was created.", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "The time at which this index definition was created." + }, + "version" : { + "type" : "integer", + "format" : "int64", + "description" : "The version number associated with this index definition when it was created." + } + }, + "title" : "Search Index Definition Version" }, - "ServerlessInstanceDescription" : { + "SearchIndexResponse" : { "type" : "object", - "description" : "Group of settings that configure a MongoDB serverless instance.", - "properties" : { - "connectionStrings" : { - "$ref" : "#/components/schemas/ServerlessInstanceDescriptionConnectionStrings" + "discriminator" : { + "mapping" : { + "search" : "#/components/schemas/TextSearchIndexResponse", + "vectorSearch" : "#/components/schemas/VectorSearchIndexResponse" }, - "createDate" : { + "propertyName" : "type" + }, + "properties" : { + "collectionName" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", - "readOnly" : true + "description" : "Label that identifies the collection that contains one or more Atlas Search indexes." }, - "groupId" : { + "database" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the project.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "description" : "Label that identifies the database that contains the collection with one or more Atlas Search indexes." }, - "id" : { + "indexID" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the serverless instance.", + "description" : "Unique 24-hexadecimal digit string that identifies this Atlas Search index.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "pattern" : "^([a-f0-9]{24})$" }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true + "latestDefinition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" }, - "mongoDBVersion" : { - "type" : "string", - "description" : "Version of MongoDB that the serverless instance runs.", - "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", - "readOnly" : true + "latestDefinitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" }, "name" : { "type" : "string", - "description" : "Human-readable label that identifies the serverless instance.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - }, - "providerSettings" : { - "$ref" : "#/components/schemas/ServerlessProviderSettings" + "description" : "Label that identifies this index. Within each namespace, the names of all indexes must be unique." }, - "serverlessBackupOptions" : { - "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on all hosts." }, - "stateName" : { + "status" : { "type" : "string", - "description" : "Human-readable label that indicates the current operating condition of the serverless instance.", - "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], - "readOnly" : true + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] }, - "tags" : { + "statusDetail" : { "type" : "array", - "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", + "description" : "List of documents detailing index status on each host.", "items" : { - "$ref" : "#/components/schemas/ResourceTag" + "$ref" : "#/components/schemas/SearchHostStatusDetail" } }, - "terminationProtectionEnabled" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." + "type" : { + "type" : "string", + "description" : "Type of the index. The default type is search.", + "enum" : [ "search", "vectorSearch" ] } }, - "required" : [ "providerSettings" ], - "title" : "Serverless Instance Description" + "title" : "Search Index Response" }, - "ServerlessInstanceDescriptionConnectionStrings" : { + "SearchIndexUpdateRequest" : { "type" : "object", - "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", - "externalDocs" : { - "description" : "Connection string URI format.", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, "properties" : { - "privateEndpoint" : { - "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.", - "items" : { - "$ref" : "#/components/schemas/ServerlessConnectionStringsPrivateEndpointList" - }, - "readOnly" : true - }, - "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.", - "externalDocs" : { - "description" : "Connection String URI Format", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, - "readOnly" : true + "definition" : { + "type" : "object", + "description" : "The index definition to update the search index to.", + "oneOf" : [ { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + }, { + "$ref" : "#/components/schemas/VectorSearchIndexDefinition" + } ] } }, - "readOnly" : true, - "title" : "Serverless Instance Connection Strings" + "required" : [ "definition" ], + "title" : "Search Index Update Request" }, - "ServerlessInstanceDescriptionCreate" : { + "SearchMainIndexStatusDetail" : { "type" : "object", - "description" : "Settings that you can specify when you create a serverless instance.", + "description" : "Contains status information about the active index.", "properties" : { - "name" : { - "type" : "string", - "description" : "Human-readable label that identifies the serverless instance.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "writeOnly" : true - }, - "providerSettings" : { - "$ref" : "#/components/schemas/ServerlessProviderSettings" + "definition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" }, - "serverlessBackupOptions" : { - "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" }, - "stateName" : { + "message" : { "type" : "string", - "description" : "Human-readable label that indicates the current operating condition of the serverless instance.", - "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], - "readOnly" : true - }, - "tags" : { - "type" : "array", - "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", - "items" : { - "$ref" : "#/components/schemas/ResourceTag" - } + "description" : "Optional message describing an error." }, - "terminationProtectionEnabled" : { + "queryable" : { "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." + "description" : "Flag that indicates whether the index generation is queryable on the host." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] } }, - "required" : [ "name", "providerSettings" ], - "title" : "Serverless Instance Description Create" + "title" : "Search Main Index Status Detail" }, - "ServerlessInstanceDescriptionUpdate" : { + "SearchMappings" : { "type" : "object", - "description" : "Settings that you can update when you request a serverless cluster update.", + "description" : "Index specifications for the collection's fields.", "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.", - "items" : { - "$ref" : "#/components/schemas/ResourceTag" + "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/field-mapping-definition-fts#static-and-dynamic-mappings" } }, - "terminationProtectionEnabled" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." + "fields" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "One or more field specifications for the Atlas Search index. Required if **mappings.dynamic** is omitted or set to **false**.", + "externalDocs" : { + "description" : "Atlas Search Index", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "x-additionalPropertiesName" : "Field Name" + }, + "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" + }, + "x-additionalPropertiesName" : "Field Name" } }, - "title" : "Serverless Instance Description Update" + "title" : "Mappings" }, - "ServerlessMetricAlertConfigViewForNdsGroup" : { + "SearchStagedIndexStatusDetail" : { "type" : "object", - "description" : "Serverless metric alert configuration allows to select which serverless database metrics trigger alerts and how users are notified.", + "description" : "Contains status information about an index building in the background.", "properties" : { - "created" : { + "definition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" + }, + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "message" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "description" : "Optional message describing an error." }, - "enabled" : { + "queryable" : { "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + "description" : "Flag that indicates whether the index generation is queryable on the host." }, - "eventTypeName" : { - "$ref" : "#/components/schemas/ServerlessEventTypeViewAlertable" + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Search Staged Index Status Detail" + }, + "SearchSynonymMappingDefinition" : { + "type" : "object", + "description" : "Synonyms used for this full text index.", + "properties" : { + "analyzer" : { + "type" : "string", + "description" : "Specific pre-defined method chosen to apply to the synonyms to be searched.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] }, - "groupId" : { + "name" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "description" : "Label that identifies the synonym definition. Each **synonym.name** must be unique within the same index definition." }, - "id" : { + "source" : { + "$ref" : "#/components/schemas/SynonymSource" + } + }, + "required" : [ "analyzer", "name", "source" ], + "title" : "Synonym Mapping Definition" + }, + "ServerlessAWSTenantEndpoint" : { + "type" : "object", + "description" : "View for a serverless AWS tenant endpoint.", + "properties" : { + "_id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - }, - "matchers" : { - "type" : "array", - "description" : "Matching conditions for target resources.", - "items" : { - "$ref" : "#/components/schemas/AlertMatcher" - } - }, - "metricThreshold" : { - "$ref" : "#/components/schemas/ServerlessMetricThreshold" - }, - "notifications" : { - "type" : "array", - "description" : "List that contains the targets that MongoDB Cloud sends notifications.", - "items" : { - "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" - } - }, - "updated" : { + "cloudProviderEndpointId" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Unique string that identifies the private endpoint's network interface.", + "pattern" : "^vpce-[0-9a-f]{17}$", "readOnly" : true - } - }, - "required" : [ "eventTypeName", "notifications" ], - "title" : "Serverless Alert Configuration" - }, - "ServerlessMetricThreshold" : { - "type" : "object", - "description" : "Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.", - "discriminator" : { - "mapping" : { - "SERVERLESS_AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", - "SERVERLESS_AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", - "SERVERLESS_AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", - "SERVERLESS_CONNECTIONS" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricThresholdView", - "SERVERLESS_NETWORK_BYTES_IN" : "#/components/schemas/DataMetricThresholdView", - "SERVERLESS_NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricThresholdView", - "SERVERLESS_NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_OPCOUNTER_CMD" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_OPCOUNTER_QUERY" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_TOTAL_READ_UNITS" : "#/components/schemas/RPUMetricThresholdView", - "SERVERLESS_TOTAL_WRITE_UNITS" : "#/components/schemas/RPUMetricThresholdView" }, - "propertyName" : "metricName" - }, - "properties" : { - "metricName" : { + "comment" : { "type" : "string", - "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "readOnly" : true }, - "mode" : { + "endpointServiceName" : { "type" : "string", - "description" : "MongoDB Cloud computes the current metric value as an average.", - "enum" : [ "AVERAGE" ] - }, - "operator" : { - "$ref" : "#/components/schemas/Operator" - }, - "threshold" : { - "type" : "number", - "format" : "double", - "description" : "Value of metric that, when exceeded, triggers an alert." + "description" : "Unique string that identifies the Amazon Web Services (AWS) PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}", + "readOnly" : true }, - "units" : { - "type" : "string", - "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", - "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] - } - }, - "required" : [ "metricName" ], - "title" : "Serverless Metric Threshold" - }, - "ServerlessMetricUnits" : { - "type" : "string", - "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", - "enum" : [ "RPU", "THOUSAND_RPU", "MILLION_RPU", "WPU", "THOUSAND_WPU", "MILLION_WPU" ], - "example" : "RPU", - "title" : "Serverless Metric Units" - }, - "ServerlessProviderSettings" : { - "type" : "object", - "description" : "Group of cloud provider settings that configure the provisioned MongoDB serverless instance.", - "properties" : { - "backingProviderName" : { + "errorMessage" : { "type" : "string", - "description" : "Cloud service provider on which MongoDB Cloud provisioned the serverless instance.", - "enum" : [ "AWS", "AZURE", "GCP" ] + "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", + "readOnly" : true }, "providerName" : { "type" : "string", - "default" : "SERVERLESS", "description" : "Human-readable label that identifies the cloud service provider.", - "enum" : [ "SERVERLESS" ] + "enum" : [ "AWS" ], + "readOnly" : true }, - "regionName" : { + "status" : { "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/)." + "description" : "Human-readable label that indicates the current operating status of the private endpoint.", + "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true } }, - "required" : [ "backingProviderName", "regionName" ], - "title" : "Cloud Service Provider Settings for a Serverless Instance" + "title" : "AWS" }, - "ServerlessTenantCreateRequest" : { + "ServerlessAWSTenantEndpointUpdate" : { "type" : "object", - "properties" : { - "comment" : { - "type" : "string", - "description" : "Human-readable comment associated with the private endpoint.", - "maxLength" : 80, - "writeOnly" : true + "allOf" : [ { + "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" + }, { + "type" : "object", + "properties" : { + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface.", + "pattern" : "^vpce-[0-9a-f]{17}$", + "writeOnly" : true + } } - } + } ], + "description" : "Updates to a serverless AWS tenant endpoint.", + "required" : [ "providerName" ], + "title" : "AWS" }, - "ServerlessTenantEndpoint" : { + "ServerlessAzureTenantEndpoint" : { "type" : "object", - "oneOf" : [ { - "$ref" : "#/components/schemas/ServerlessAWSTenantEndpoint" - }, { - "$ref" : "#/components/schemas/ServerlessAzureTenantEndpoint" - } ], + "description" : "View for a serverless Azure tenant endpoint.", "properties" : { "_id" : { "type" : "string", @@ -48196,7 +49366,8 @@ }, "cloudProviderEndpointId" : { "type" : "string", - "description" : "Unique string that identifies the private endpoint's network interface.", + "description" : "Unique string that identifies the Azure private endpoint's network interface that someone added to this private endpoint service.", + "pattern" : "^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\\.Network/privateEndpoints/[-\\w._()]+$", "readOnly" : true }, "comment" : { @@ -48207,8 +49378,8 @@ }, "endpointServiceName" : { "type" : "string", - "description" : "Unique string that identifies the PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", - "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}|pls_[0-9a-f]{24}$", + "description" : "Unique string that identifies the Azure private endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^pls_[0-9a-f]{24}$", "readOnly" : true }, "errorMessage" : { @@ -48216,112 +49387,113 @@ "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", "readOnly" : true }, - "status" : { + "privateEndpointIpAddress" : { "type" : "string", - "description" : "Human-readable label that indicates the current operating status of the private endpoint.", - "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", "readOnly" : true - } - } - }, - "ServerlessTenantEndpointUpdate" : { - "type" : "object", - "description" : "Update view for a serverless tenant endpoint.", - "discriminator" : { - "mapping" : { - "AWS" : "#/components/schemas/ServerlessAWSTenantEndpointUpdate", - "AZURE" : "#/components/schemas/ServerlessAzureTenantEndpointUpdate" }, - "propertyName" : "providerName" - }, - "properties" : { - "comment" : { + "privateLinkServiceResourceId" : { "type" : "string", - "description" : "Human-readable comment associated with the private endpoint.", - "maxLength" : 80, - "writeOnly" : true + "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 provider of the tenant endpoint.", - "enum" : [ "AWS", "AZURE" ], - "writeOnly" : true + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "AZURE" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating status of the private endpoint.", + "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true } }, - "required" : [ "providerName" ] - }, - "ServiceAccountEventTypeViewForNdsGroup" : { - "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" ], - "title" : "Service Account Event Types" - }, - "ServiceAccountEventTypeViewForOrg" : { - "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" ], - "title" : "Service Account Event Types" + "title" : "Azure" }, - "ServiceAccountGroup" : { + "ServerlessAzureTenantEndpointUpdate" : { "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "allOf" : [ { + "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" + }, { + "type" : "object", + "properties" : { + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure private endpoint's network interface for this private endpoint service.", + "pattern" : "^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\\.Network/privateEndpoints/[-\\w._()]+$", + "writeOnly" : true + }, + "privateEndpointIpAddress" : { + "type" : "string", + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "writeOnly" : true + } } - } + } ], + "description" : "Updates to a serverless Azure tenant endpoint.", + "required" : [ "providerName" ], + "title" : "AZURE" }, - "ServiceAccountGroupEvents" : { + "ServerlessBackupRestoreJob" : { "type" : "object", - "description" : "Service Account event identifies different activities around user api keys.", "properties" : { - "apiKeyId" : { + "cancelled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone canceled this restore job.", + "readOnly" : true + }, + "deliveryType" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "description" : "Human-readable label that categorizes the restore job to create.", + "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\"`.", + "items" : { + "type" : "string", + "description" : "One Uniform Resource Locator that points to the compressed snapshot files for manual download." + }, "readOnly" : true }, - "created" : { + "desiredTimestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "expired" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job expired.", + "readOnly" : true + }, + "expiresAt" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Date and time when the restore job expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "eventTypeName" : { - "$ref" : "#/components/schemas/ServiceAccountEventTypeViewForNdsGroup" + "failed" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job failed.", + "readOnly" : true }, - "groupId" : { + "finishedAt" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "format" : "date-time", + "description" : "Date and time when the restore job completed. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "description" : "Unique 24-hexadecimal character string that identifies the restore job.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "isGlobalAdmin" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", - "readOnly" : true - }, "links" : { "type" : "array", "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", @@ -48334,98 +49506,87 @@ }, "readOnly" : true }, - "orgId" : { + "oplogInc" : { + "type" : "integer", + "format" : "int32", + "description" : "Oplog operation number from which you want to restore this snapshot. This number represents the second part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", + "example" : 1, + "minimum" : 1 + }, + "oplogTs" : { + "type" : "integer", + "format" : "int32", + "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`.", + "minimum" : 1199145600 + }, + "pointInTimeUTCSeconds" : { + "type" : "integer", + "format" : "int32", + "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`.", + "minimum" : 1199145600 + }, + "snapshotId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "publicKey" : { - "type" : "string", - "format" : "email", - "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "example" : "test.user@mongodb.com", - "readOnly" : true - }, - "raw" : { - "$ref" : "#/components/schemas/raw" + "pattern" : "^([a-f0-9]{24})$" }, - "remoteAddress" : { + "targetClusterName" : { "type" : "string", - "description" : "IPv4 or IPv6 address from which the user triggered this event.", - "example" : "216.172.40.186", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", - "readOnly" : true + "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\"`.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, - "userId" : { + "targetGroupId" : { "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.", + "description" : "Unique 24-hexadecimal digit string that identifies the target project for the specified **targetClusterName**.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "pattern" : "^([a-f0-9]{24})$" }, - "username" : { + "timestamp" : { "type" : "string", - "format" : "email", - "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", - "example" : "test.user@mongodb.com", + "format" : "date-time", + "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.", "readOnly" : true } }, - "required" : [ "created", "eventTypeName", "id" ], - "title" : "ServiceAccount Events" + "required" : [ "deliveryType", "targetClusterName", "targetGroupId" ] }, - "ServiceAccountOrgEvents" : { + "ServerlessBackupSnapshot" : { "type" : "object", - "description" : "Service Account event identifies different activities around user api keys.", "properties" : { - "apiKeyId" : { + "createdAt" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "created" : { + "expiresAt" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "eventTypeName" : { - "$ref" : "#/components/schemas/ServiceAccountEventTypeViewForOrg" - }, - "groupId" : { + "frequencyType" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "description" : "Human-readable label that identifies how often this snapshot triggers.", + "enum" : [ "hourly", "daily", "weekly", "monthly" ], "readOnly" : true }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "isGlobalAdmin" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", - "readOnly" : true - }, "links" : { "type" : "array", "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", @@ -48438,332 +49599,278 @@ }, "readOnly" : true }, - "orgId" : { + "mongodVersion" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "description" : "Version of the MongoDB host that this snapshot backs up.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", "readOnly" : true }, - "publicKey" : { + "serverlessInstanceName" : { "type" : "string", - "format" : "email", - "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "example" : "test.user@mongodb.com", + "description" : "Human-readable label given to the serverless instance from which MongoDB Cloud took this snapshot.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, - "raw" : { - "$ref" : "#/components/schemas/raw" - }, - "remoteAddress" : { + "snapshotType" : { "type" : "string", - "description" : "IPv4 or IPv6 address from which the user triggered this event.", - "example" : "216.172.40.186", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "description" : "Human-readable label that identifies when this snapshot triggers.", + "enum" : [ "onDemand", "scheduled" ], "readOnly" : true }, - "userId" : { + "status" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", + "enum" : [ "queued", "inProgress", "completed", "failed" ], "readOnly" : true }, - "username" : { - "type" : "string", - "format" : "email", - "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", - "example" : "test.user@mongodb.com", + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of bytes taken to store the backup snapshot.", "readOnly" : true } - }, - "required" : [ "created", "eventTypeName", "id" ], - "title" : "ServiceAccount Events" + } }, - "ServiceAccountSecret" : { + "ServerlessConnectionStringsPrivateEndpointItem" : { "type" : "object", + "description" : "Details of a private endpoint deployed for this serverless instance.", "properties" : { - "createdAt" : { + "endpointId" : { "type" : "string", - "format" : "date-time", - "description" : "Timestamp representing creation time.", + "description" : "Unique string that the cloud provider uses to identify the private endpoint.", "readOnly" : true }, - "expiresAt" : { + "providerName" : { "type" : "string", - "format" : "date-time", - "description" : "Timestamp representing secret expiration time.", + "description" : "Cloud provider where the private endpoint is deployed.", + "enum" : [ "AWS", "AZURE" ], "readOnly" : true }, - "id" : { + "region" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the secret.", - "example" : "32b6e34b3d91647abb20e7b8", - "pattern" : "^([a-f0-9]{24})$", + "description" : "Region where the private endpoint is deployed.", "readOnly" : true - }, - "lastUsedAt" : { - "type" : "string", - "format" : "date-time", - "description" : "Timestamp representing last secret usage.", + } + }, + "title" : "Serverless Instance Private Endpoint Connection Strings Endpoint" + }, + "ServerlessConnectionStringsPrivateEndpointList" : { + "type" : "object", + "description" : "Private endpoint connection string that you can use to connect to this serverless instance through a private endpoint.", + "externalDocs" : { + "description" : "Private Endpoint for Serverless Instance", + "url" : "https://docs.atlas.mongodb.com/security-serverless-private-endpoint/" + }, + "properties" : { + "endpoints" : { + "type" : "array", + "description" : "List that contains the private endpoints through which you connect to MongoDB Cloud when you use **connectionStrings.privateEndpoint[n].srvConnectionString**.", + "items" : { + "$ref" : "#/components/schemas/ServerlessConnectionStringsPrivateEndpointItem" + }, "readOnly" : true }, - "maskedSecretValue" : { + "srvConnectionString" : { "type" : "string", - "description" : "Service Account secret with masked values of the first 20 characters.", - "example" : "mdb_ic_sk_...12ce", + "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 }, - "secret" : { + "type" : { "type" : "string", - "description" : "Secret for the service account. It will be returned only the first time after service account creation.", - "pattern" : "^mdb_sa_sk_[0-9a-zA-Z]{40}$", + "description" : "MongoDB process type to which your application connects.", + "enum" : [ "MONGOS" ], "readOnly" : true } }, - "required" : [ "createdAt", "expiresAt", "id" ] + "title" : "Serverless Instance Private Endpoint Connection String" }, - "ServiceAccountSecretRequest" : { - "type" : "object", - "properties" : { - "secretExpiresAfterHours" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of hours representing validity duration for secret." - } - }, - "required" : [ "secretExpiresAfterHours" ] + "ServerlessEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], + "example" : "OUTSIDE_SERVERLESS_METRIC_THRESHOLD", + "title" : "Serverless Event Types" }, - "ShardEntry" : { + "ServerlessInstanceDescription" : { "type" : "object", - "description" : "Sharding configuration for a collection to be sharded on the destination cluster.", + "description" : "Group of settings that configure a MongoDB serverless instance.", "properties" : { - "collection" : { + "connectionStrings" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescriptionConnectionStrings" + }, + "createDate" : { "type" : "string", - "description" : "Human-readable label that identifies the collection to be sharded on the destination cluster.", - "writeOnly" : true + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true }, - "database" : { + "groupId" : { "type" : "string", - "description" : "Human-readable label that identifies the database that contains the collection to be sharded on the destination cluster.", - "writeOnly" : true + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "shardCollection" : { - "$ref" : "#/components/schemas/ShardKeys" - } - }, - "required" : [ "collection", "database", "shardCollection" ] - }, - "ShardKeys" : { - "type" : "object", - "description" : "Document that configures the shard key on the destination cluster.", - "properties" : { - "key" : { - "type" : "array", - "description" : "List of fields to use for the shard key.", - "items" : { - "type" : "object", - "additionalProperties" : { - "type" : "object" - } - }, - "uniqueItems" : true, - "writeOnly" : true - } - }, - "writeOnly" : true - }, - "ShardingRequest" : { - "type" : "object", - "description" : "Document that configures sharding on the destination cluster when migrating from a replica set source to a sharded cluster destination on MongoDB 6.0 or higher. If you don't wish to shard any collections on the destination cluster, leave this empty.", - "properties" : { - "createSupportingIndexes" : { - "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 + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the serverless instance.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "shardingEntries" : { + "links" : { "type" : "array", - "description" : "List of shard configurations to shard destination collections. Atlas shards only those collections that you include in the sharding entries array.", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, "items" : { - "$ref" : "#/components/schemas/ShardEntry" + "$ref" : "#/components/schemas/Link" }, - "uniqueItems" : true, - "writeOnly" : true - } - }, - "required" : [ "createSupportingIndexes" ], - "writeOnly" : true - }, - "Slack" : { - "type" : "object", - "description" : "Details to integrate one Slack account with one MongoDB Cloud project.", - "properties" : { - "apiToken" : { + "readOnly" : true + }, + "mongoDBVersion" : { "type" : "string", - "description" : "Key that allows MongoDB Cloud to access your Slack account.\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.\n\n**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" + "description" : "Version of MongoDB that the serverless instance runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true }, - "channelName" : { + "name" : { "type" : "string", - "description" : "Name of the Slack channel to which MongoDB Cloud sends alert notifications.", - "example" : "alerts", - "maxLength" : 80, + "description" : "Human-readable label that identifies the serverless instance.", + "maxLength" : 64, "minLength" : 1, - "nullable" : true + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, - "id" : { - "type" : "string", - "description" : "Integration id.", - "nullable" : true + "providerSettings" : { + "$ref" : "#/components/schemas/ServerlessProviderSettings" }, - "teamName" : { - "type" : "string", - "description" : "Human-readable label that identifies your Slack team. Set this parameter when you configure a legacy Slack integration.", - "example" : "MongoDB" + "serverlessBackupOptions" : { + "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" }, - "type" : { + "stateName" : { "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" : "Human-readable label that indicates the current operating condition of the serverless instance.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." } }, - "required" : [ "apiToken", "channelName" ], - "title" : "SLACK" + "required" : [ "providerSettings" ], + "title" : "Serverless Instance Description" }, - "SlackNotification" : { + "ServerlessInstanceDescriptionConnectionStrings" : { "type" : "object", - "description" : "Slack notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, "properties" : { - "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", - "format" : "int32", - "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." - }, - "integrationId" : { - "type" : "string", - "description" : "The id of the associated integration, the credentials of which to use for requests.", - "example" : "32b6e34b3d91647abb20e7b8" - }, - "intervalMin" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", - "minimum" : 5 - }, - "notifierId" : { - "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" + "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.", + "items" : { + "$ref" : "#/components/schemas/ServerlessConnectionStringsPrivateEndpointList" + }, + "readOnly" : true }, - "typeName" : { + "standardSrv" : { "type" : "string", - "description" : "Human-readable label that displays the alert notification type.", - "enum" : [ "SLACK" ] + "description" : "Public connection string that you can use to connect to this serverless instance. This connection string uses the `mongodb+srv://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true } }, - "required" : [ "typeName" ], - "title" : "Slack Notification" + "readOnly" : true, + "title" : "Serverless Instance Connection Strings" }, - "Source" : { + "ServerlessInstanceDescriptionCreate" : { "type" : "object", - "description" : "Document that describes the source of the migration.", + "description" : "Settings that you can specify when you create a serverless instance.", "properties" : { - "caCertificatePath" : { + "name" : { "type" : "string", - "description" : "Path to the CA certificate that signed SSL certificates use to authenticate to the source cluster." + "description" : "Human-readable label that identifies the serverless instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "writeOnly" : true }, - "clusterName" : { - "type" : "string", - "description" : "Label that identifies the source cluster name." + "providerSettings" : { + "$ref" : "#/components/schemas/ServerlessProviderSettings" }, - "groupId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the source project.", - "example" : "9b43a5b329223c3a1591a678", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" + "serverlessBackupOptions" : { + "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" }, - "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." + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the serverless instance.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true }, - "password" : { - "type" : "string", - "description" : "Password that authenticates the username to the source cluster.", - "writeOnly" : true + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } }, - "ssl" : { + "terminationProtectionEnabled" : { "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 - } - }, - "required" : [ "clusterName", "groupId", "managedAuthentication", "ssl" ] - }, - "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/" + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." } }, - "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/" - } + "required" : [ "name", "providerSettings" ], + "title" : "Serverless Instance Description Create" }, - "StreamConfig" : { + "ServerlessInstanceDescriptionUpdate" : { "type" : "object", - "description" : "Configuration options for an Atlas Stream Processing Instance.", - "nullable" : true, + "description" : "Settings that you can update when you request a serverless cluster update.", "properties" : { - "links" : { + "serverlessBackupOptions" : { + "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" + }, + "tags" : { "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true + "$ref" : "#/components/schemas/ResourceTag" + } }, - "tier" : { - "type" : "string", - "description" : "Selected tier for the Stream Instance. Configures Memory / VCPU allowances.", - "enum" : [ "SP30", "SP10" ], - "title" : "Stream Instance Tier" + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." } - } + }, + "title" : "Serverless Instance Description Update" }, - "StreamProcessorAlertConfigViewForNdsGroup" : { + "ServerlessMetricAlertConfigViewForNdsGroup" : { "type" : "object", - "description" : "Host metric alert configuration allows to select which Atlas streams processors trigger alerts and how users are notified.", + "description" : "Serverless metric alert configuration allows to select which serverless database metrics trigger alerts and how users are notified.", "properties" : { "created" : { "type" : "string", @@ -48777,7 +49884,7 @@ "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." }, "eventTypeName" : { - "$ref" : "#/components/schemas/StreamProcessorEventTypeViewAlertable" + "$ref" : "#/components/schemas/ServerlessEventTypeViewAlertable" }, "groupId" : { "type" : "string", @@ -48811,11 +49918,14 @@ }, "matchers" : { "type" : "array", - "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration.", + "description" : "Matching conditions for target resources.", "items" : { - "$ref" : "#/components/schemas/StreamsMatcher" + "$ref" : "#/components/schemas/AlertMatcher" } }, + "metricThreshold" : { + "$ref" : "#/components/schemas/ServerlessMetricThreshold" + }, "notifications" : { "type" : "array", "description" : "List that contains the targets that MongoDB Cloud sends notifications.", @@ -48831,157 +49941,215 @@ } }, "required" : [ "eventTypeName", "notifications" ], - "title" : "Stream Processor Alert Configuration" + "title" : "Serverless Alert Configuration" }, - "StreamProcessorAlertViewForNdsGroup" : { + "ServerlessMetricThreshold" : { "type" : "object", - "description" : "Stream Processor alert notifies about activities on Stream Processor in AtlasStreams.", + "description" : "Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.", + "discriminator" : { + "mapping" : { + "SERVERLESS_AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_CONNECTIONS" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_BYTES_IN" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_CMD" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_QUERY" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_TOTAL_READ_UNITS" : "#/components/schemas/RPUMetricThresholdView", + "SERVERLESS_TOTAL_WRITE_UNITS" : "#/components/schemas/RPUMetricThresholdView" + }, + "propertyName" : "metricName" + }, "properties" : { - "acknowledgedUntil" : { + "metricName" : { "type" : "string", - "format" : "date-time", - "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.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." }, - "acknowledgementComment" : { + "mode" : { "type" : "string", - "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", - "example" : "Expiration on 3/19. Silencing for 7days.", - "maxLength" : 200 + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] }, - "acknowledgingUsername" : { + "operator" : { "type" : "string", - "format" : "email", - "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", - "readOnly" : true + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, - "alertConfigId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." }, - "created" : { + "units" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true - }, - "eventTypeName" : { - "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroupAlertable" - }, - "groupId" : { + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] + } + }, + "required" : [ "metricName" ], + "title" : "Serverless Metric Threshold" + }, + "ServerlessMetricUnits" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "RPU", "THOUSAND_RPU", "MILLION_RPU", "WPU", "THOUSAND_WPU", "MILLION_WPU" ], + "example" : "RPU", + "title" : "Serverless Metric Units" + }, + "ServerlessProviderSettings" : { + "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB serverless instance.", + "properties" : { + "backingProviderName" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "description" : "Cloud service provider on which MongoDB Cloud provisioned the serverless instance.", + "enum" : [ "AWS", "AZURE", "GCP" ] }, - "id" : { + "providerName" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies this alert.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "default" : "SERVERLESS", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "SERVERLESS" ] }, - "instanceName" : { + "regionName" : { "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.", - "example" : "foobar", - "readOnly" : true - }, - "lastNotified" : { + "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/)." + } + }, + "required" : [ "backingProviderName", "regionName" ], + "title" : "Cloud Service Provider Settings for a Serverless Instance" + }, + "ServerlessTenantCreateRequest" : { + "type" : "object", + "properties" : { + "comment" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", - "readOnly" : true - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - }, - "orgId" : { + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "writeOnly" : true + } + } + }, + "ServerlessTenantEndpoint" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/ServerlessAWSTenantEndpoint" + }, { + "$ref" : "#/components/schemas/ServerlessAzureTenantEndpoint" + } ], + "properties" : { + "_id" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "processorErrorMsg" : { + "cloudProviderEndpointId" : { "type" : "string", - "description" : "The error message associated with the Stream Processor to which this alert applies.", - "example" : "MongoServerError: Failed to start stream processor: (Location77175) Could not connect to the Kafka topic with kafka error code: -195, message: Local: Broker transport failure.: (Location77175)", + "description" : "Unique string that identifies the private endpoint's network interface.", "readOnly" : true }, - "processorName" : { + "comment" : { "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.", - "example" : "foobar", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, "readOnly" : true }, - "processorState" : { + "endpointServiceName" : { "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.", - "example" : "STARTED", + "description" : "Unique string that identifies the PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}|pls_[0-9a-f]{24}$", "readOnly" : true }, - "resolved" : { + "errorMessage" : { "type" : "string", - "format" : "date-time", - "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\"`.", + "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", "readOnly" : true }, "status" : { "type" : "string", - "description" : "State of this alert at the time you requested its details.", - "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], - "example" : "OPEN", + "description" : "Human-readable label that indicates the current operating status of the private endpoint.", + "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], "readOnly" : true + } + } + }, + "ServerlessTenantEndpointUpdate" : { + "type" : "object", + "description" : "Update view for a serverless tenant endpoint.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/ServerlessAWSTenantEndpointUpdate", + "AZURE" : "#/components/schemas/ServerlessAzureTenantEndpointUpdate" }, - "updated" : { + "propertyName" : "providerName" + }, + "properties" : { + "comment" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "writeOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider of the tenant endpoint.", + "enum" : [ "AWS", "AZURE" ], + "writeOnly" : true } }, - "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], - "title" : "Stream Processor Alerts" + "required" : [ "providerName" ] }, - "StreamProcessorEventTypeViewAlertable" : { + "ServiceAccountEventTypeViewForNdsGroup" : { "type" : "string", - "description" : "Event type that triggers an alert.", - "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], - "example" : "STREAM_PROCESSOR_STATE_IS_FAILED", - "title" : "Stream Processor Event Types" + "description" : "Unique identifier of event type.", + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" }, - "StreamProcessorEventTypeViewForNdsGroup" : { + "ServiceAccountEventTypeViewForOrg" : { "type" : "string", "description" : "Unique identifier of event type.", - "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], - "example" : "STREAM_PROCESSOR_STATE_IS_FAILED", - "title" : "Stream Processor Event Types" + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" }, - "StreamProcessorEventViewForNdsGroup" : { + "ServiceAccountGroup" : { "type" : "object", - "description" : "Stream Processor event identifies different activities about a stream processor in Atlas Streams.", "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies your project. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "ServiceAccountGroupEvents" : { + "type" : "object", + "description" : "Service Account event identifies different activities around user api keys.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, "created" : { "type" : "string", "format" : "date-time", @@ -48989,7 +50157,7 @@ "readOnly" : true }, "eventTypeName" : { - "$ref" : "#/components/schemas/StreamProcessorEventTypeViewForNdsGroup" + "$ref" : "#/components/schemas/ServiceAccountEventTypeViewForNdsGroup" }, "groupId" : { "type" : "string", @@ -49009,10 +50177,10 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "instanceName" : { - "type" : "string", - "description" : "Name of the stream processing instance associated with the event.", - "example" : "foobar", + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", "readOnly" : true }, "links" : { @@ -49036,159 +50204,96 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "processorErrorMsg" : { - "type" : "string", - "description" : "Error message linked to the stream processor associated with the event.", - "example" : "invalid auth", - "readOnly" : true - }, - "processorName" : { - "type" : "string", - "description" : "Name of the stream processor associated with the event.", - "example" : "foobar", - "readOnly" : true - }, - "processorState" : { + "publicKey" : { "type" : "string", - "description" : "State of the stream processor associated with the event.", - "example" : "FAILED", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true }, "raw" : { "$ref" : "#/components/schemas/raw" - } - }, - "required" : [ "created", "eventTypeName", "id" ], - "title" : "Stream Processor Events" - }, - "StreamsClusterConnection" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/StreamsConnection" - }, { - "type" : "object", - "properties" : { - "clusterName" : { - "type" : "string", - "description" : "Name of the cluster configured for this connection." - }, - "dbRoleToExecute" : { - "$ref" : "#/components/schemas/DBRoleToExecute" - } - } - } ] - }, - "StreamsConnection" : { - "type" : "object", - "description" : "Settings that define a connection to an external data store.", - "discriminator" : { - "mapping" : { - "Cluster" : "#/components/schemas/StreamsClusterConnection", - "Kafka" : "#/components/schemas/StreamsKafkaConnection", - "Sample" : "#/components/schemas/StreamsSampleConnection" }, - "propertyName" : "type" - }, - "oneOf" : [ { - "$ref" : "#/components/schemas/StreamsSampleConnection" - }, { - "$ref" : "#/components/schemas/StreamsClusterConnection" - }, { - "$ref" : "#/components/schemas/StreamsKafkaConnection" - } ], - "properties" : { - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", "readOnly" : true }, - "name" : { + "userId" : { "type" : "string", - "description" : "Human-readable label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source." + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "type" : { + "username" : { "type" : "string", - "description" : "Type of the connection. Can be either Cluster or Kafka.", - "enum" : [ "Kafka", "Cluster", "Sample" ] + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true } }, - "readOnly" : true + "required" : [ "created", "eventTypeName", "id" ], + "title" : "ServiceAccount Events" }, - "StreamsDLQ" : { + "ServiceAccountIPAccessListEntry" : { "type" : "object", - "description" : "Dead letter queue for the stream processor.", "properties" : { - "coll" : { + "cidrBlock" : { "type" : "string", - "description" : "Name of the collection that will be used for the DLQ." + "description" : "Range of network addresses in the access list for the Service Account. This parameter requires the range to be expressed in Classless Inter-Domain Routing (CIDR) notation of Internet Protocol version 4 or version 6 addresses. You can set a value for this parameter or **ipAddress**, but not for both in the same request.", + "example" : "203.0.113.0/24", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" }, - "connectionName" : { + "createdAt" : { "type" : "string", - "description" : "Connection name that will be used to write DLQ messages to. Has to be an Atlas connection." + "format" : "date-time", + "description" : "Date MongoDB Cloud added the entry was added to the Access List.", + "readOnly" : true }, - "db" : { + "ipAddress" : { "type" : "string", - "description" : "Name of the database that will be used for the DLQ." + "description" : "Network address in the access list for the Service Account. This parameter requires the address to be expressed as one Internet Protocol version 4 or version 6 address. You can set a value for this parameter or **cidrBlock**, but not for both in the same request.", + "example" : "203.0.113.10", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - } - } - }, - "StreamsDataProcessRegion" : { - "type" : "object", - "description" : "Information about the cloud provider region in which MongoDB Cloud processes the stream.", - "properties" : { - "cloudProvider" : { + "lastUsedAddress" : { "type" : "string", - "description" : "Label that identifies the cloud service provider where MongoDB Cloud performs stream processing. Currently, this parameter supports AWS only.", - "enum" : [ "AWS", "GCP", "AZURE", "TENANT", "SERVERLESS" ] + "description" : "Network address that issued the most recent request to the API. This parameter requires the address to be expressed as one Internet Protocol version 4 or version 6 address. The resource returns this parameter after this IP address makes at least one request.", + "readOnly" : true }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, + "lastUsedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date when MongoDB Cloud received the most recent request that originated from this Internet Protocol version 4 or version 6 address. The resource returns this parameter when at least one request originates from this IP address. MongoDB Cloud updates this parameter each time a client accesses the permitted resource, with a delay of up to 5 minutes.", "readOnly" : true }, - "region" : { - "$ref" : "#/components/schemas/BaseStreamsRegion" + "requestCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of requests that has originated from this network address.", + "readOnly" : true } - }, - "required" : [ "cloudProvider", "region" ] - }, - "StreamsEventTypeViewForNdsGroup" : { - "type" : "string", - "description" : "Unique identifier of event type.", - "enum" : [ "MAX_PROCESSOR_COUNT_REACHED" ], - "example" : "MAX_PROCESSOR_COUNT_REACHED", - "title" : "Streams Event Types" + } }, - "StreamsEventViewForNdsGroup" : { + "ServiceAccountOrgEvents" : { "type" : "object", - "description" : "Streams event identifies different activities about Atlas Streams.", + "description" : "Service Account event identifies different activities around user api keys.", "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, "created" : { "type" : "string", "format" : "date-time", @@ -49196,7 +50301,7 @@ "readOnly" : true }, "eventTypeName" : { - "$ref" : "#/components/schemas/StreamsEventTypeViewForNdsGroup" + "$ref" : "#/components/schemas/ServiceAccountEventTypeViewForOrg" }, "groupId" : { "type" : "string", @@ -49216,10 +50321,10 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "instanceName" : { - "type" : "string", - "description" : "Name of the stream processing instance associated with the event.", - "example" : "foobar", + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", "readOnly" : true }, "links" : { @@ -49243,387 +50348,217 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, "raw" : { "$ref" : "#/components/schemas/raw" - } - }, - "required" : [ "created", "eventTypeName", "id" ], - "title" : "Streams Events" - }, - "StreamsKafkaAuthentication" : { - "type" : "object", - "description" : "User credentials required to connect to a Kafka Cluster. Includes the authentication type, as well as the parameters for that authentication mode.", - "properties" : { - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true }, - "mechanism" : { + "remoteAddress" : { "type" : "string", - "description" : "Style of authentication. Can be one of PLAIN, SCRAM-256, or SCRAM-512." + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true }, - "password" : { + "userId" : { "type" : "string", - "format" : "password", - "description" : "Password of the account to connect to the Kafka cluster.", - "writeOnly" : true + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, "username" : { "type" : "string", - "description" : "Username of the account to connect to the Kafka cluster." - } - } - }, - "StreamsKafkaConnection" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/StreamsConnection" - }, { - "type" : "object", - "properties" : { - "authentication" : { - "$ref" : "#/components/schemas/StreamsKafkaAuthentication" - }, - "bootstrapServers" : { - "type" : "string", - "description" : "Comma separated list of server addresses." - }, - "config" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "description" : "A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.", - "example" : "{\"group.protocol.type\":\"consumer\",\"debug\":\"queue, msg, protocol\"}" - }, - "description" : "A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.", - "example" : { - "debug" : "queue, msg, protocol", - "group.protocol.type" : "consumer" - } - }, - "networking" : { - "$ref" : "#/components/schemas/StreamsKafkaNetworking" - }, - "proxyInfo" : { - "$ref" : "#/components/schemas/ProxyInfo" - }, - "security" : { - "$ref" : "#/components/schemas/StreamsKafkaSecurity" - } - } - } ] - }, - "StreamsKafkaNetworking" : { - "type" : "object", - "description" : "Networking Access Type can either be 'PUBLIC' (default) or VPC. VPC type is in public preview, please file a support ticket to enable VPC Network Access", - "properties" : { - "access" : { - "$ref" : "#/components/schemas/StreamsKafkaNetworkingAccess" - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true } - } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "ServiceAccount Events" }, - "StreamsKafkaNetworkingAccess" : { + "ServiceAccountSecret" : { "type" : "object", - "description" : "Information about the networking access.", "properties" : { - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "The date that the secret was created on.", "readOnly" : true }, - "name" : { + "expiresAt" : { "type" : "string", - "description" : "Id of the vpc peer when the type is VPC." + "format" : "date-time", + "description" : "The date for the expiration of the secret.", + "readOnly" : true }, - "type" : { + "id" : { "type" : "string", - "description" : "Selected networking type. Either PUBLIC or VPC. Defaults to PUBLIC", - "enum" : [ "PUBLIC", "VPC" ], - "title" : "Networking Access Type" - } - } - }, - "StreamsKafkaSecurity" : { - "type" : "object", - "description" : "Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use.", - "properties" : { - "brokerPublicCertificate" : { + "description" : "Unique 24-hexadecimal digit string that identifies the secret.", + "example" : "32b6e34b3d91647abb20e7b8", + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastUsedAt" : { "type" : "string", - "description" : "A trusted, public x509 certificate for connecting to Kafka over SSL." + "format" : "date-time", + "description" : "The last time the secret was used.", + "readOnly" : true }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, + "maskedSecretValue" : { + "type" : "string", + "description" : "The masked Service Account secret.", + "example" : "mdb_ic_sk_...12ce", "readOnly" : true }, - "protocol" : { + "secret" : { "type" : "string", - "description" : "Describes the transport type. Can be either PLAINTEXT or SSL." + "description" : "The secret for the Service Account. It will be returned only the first time after creation.", + "pattern" : "^mdb_sa_sk_[0-9a-zA-Z_-]{40}$", + "readOnly" : true } - } + }, + "required" : [ "createdAt", "expiresAt", "id" ] }, - "StreamsMatcher" : { + "ServiceAccountSecretRequest" : { "type" : "object", - "description" : "Rules to apply when comparing a stream processing instance or stream processor against this alert configuration.", "properties" : { - "fieldName" : { - "$ref" : "#/components/schemas/StreamsMatcherField" - }, - "operator" : { + "secretExpiresAfterHours" : { + "type" : "integer", + "format" : "int32", + "description" : "The expiration time of the new Service Account secret. The expiration is provided in hours." + } + }, + "required" : [ "secretExpiresAfterHours" ] + }, + "ShardEntry" : { + "type" : "object", + "description" : "Sharding configuration for a collection to be sharded on the destination cluster.", + "properties" : { + "collection" : { "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" ] + "description" : "Human-readable label that identifies the collection to be sharded on the destination cluster.", + "writeOnly" : true }, - "value" : { + "database" : { "type" : "string", - "description" : "Value to match or exceed using the specified **matchers.operator**.", - "example" : "event-replica-set" + "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" } }, - "required" : [ "fieldName", "operator", "value" ], - "title" : "Matchers" - }, - "StreamsMatcherField" : { - "type" : "string", - "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", - "enum" : [ "INSTANCE_NAME", "PROCESSOR_NAME" ], - "example" : "INSTANCE_NAME", - "title" : "Streams Matcher Fields" + "required" : [ "collection", "database", "shardCollection" ] }, - "StreamsOptions" : { + "ShardKeys" : { "type" : "object", - "description" : "Optional configuration for the stream processor.", + "description" : "Document that configures the shard key on the destination cluster.", "properties" : { - "dlq" : { - "$ref" : "#/components/schemas/StreamsDLQ" - }, - "links" : { + "key" : { "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, + "description" : "List of fields to use for the shard key.", "items" : { - "$ref" : "#/components/schemas/Link" + "type" : "object", + "additionalProperties" : { + "type" : "object" + } }, - "readOnly" : true + "uniqueItems" : true, + "writeOnly" : true } - } + }, + "writeOnly" : true }, - "StreamsProcessor" : { + "ShardingRequest" : { "type" : "object", - "description" : "An atlas stream processor.", + "description" : "Document that configures sharding on the destination cluster when migrating from a replica set source to a sharded cluster destination on MongoDB 6.0 or higher. If you don't wish to shard any collections on the destination cluster, leave this empty.", "properties" : { - "_id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the stream processor.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "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 }, - "links" : { + "shardingEntries" : { "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, + "description" : "List of shard configurations to shard destination collections. Atlas shards only those collections that you include in the sharding entries array.", "items" : { - "$ref" : "#/components/schemas/Link" + "$ref" : "#/components/schemas/ShardEntry" }, - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "Human-readable name of the stream processor." - }, - "options" : { - "$ref" : "#/components/schemas/StreamsOptions" - }, - "pipeline" : { - "type" : "array", - "description" : "Stream aggregation pipeline you want to apply to your streaming data.", - "items" : { - "$ref" : "#/components/schemas/Document" - } + "uniqueItems" : true, + "writeOnly" : true } - } + }, + "required" : [ "createSupportingIndexes" ], + "writeOnly" : true }, - "StreamsProcessorWithStats" : { + "Slack" : { "type" : "object", - "description" : "An atlas stream processor with optional stats.", + "description" : "Details to integrate one Slack account with one MongoDB Cloud project.", "properties" : { - "_id" : { + "apiToken" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the stream processor.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true + "description" : "Key that allows MongoDB Cloud to access your Slack account.\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.\n\n**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" }, - "name" : { + "channelName" : { "type" : "string", - "description" : "Human-readable name of the stream processor.", - "readOnly" : true + "description" : "Name of the Slack channel to which MongoDB Cloud sends alert notifications.", + "example" : "alerts", + "maxLength" : 80, + "minLength" : 1, + "nullable" : true }, - "pipeline" : { - "type" : "array", - "description" : "Stream aggregation pipeline you want to apply to your streaming data.", - "items" : { - "$ref" : "#/components/schemas/Document" - }, - "readOnly" : true + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true }, - "state" : { + "teamName" : { "type" : "string", - "description" : "The state of the stream processor.", - "readOnly" : true + "description" : "Human-readable label that identifies your Slack team. Set this parameter when you configure a legacy Slack integration.", + "example" : "MongoDB" }, - "stats" : { - "type" : "object", - "additionalProperties" : { - "type" : "object", - "description" : "The stats associated with the stream processor.", - "readOnly" : true - }, - "description" : "The stats associated with the stream processor.", - "readOnly" : 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" : [ "SLACK" ] } }, - "required" : [ "_id", "name", "pipeline", "state" ] - }, - "StreamsSampleConnection" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/StreamsConnection" - } ] + "required" : [ "apiToken", "channelName" ], + "title" : "SLACK" }, - "StreamsTenant" : { + "SlackNotification" : { "type" : "object", + "description" : "Slack notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", "properties" : { - "_id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the project.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "connections" : { - "type" : "array", - "description" : "List of connections configured in the stream instance.", - "items" : { - "$ref" : "#/components/schemas/StreamsConnection" - }, - "readOnly" : true - }, - "dataProcessRegion" : { - "$ref" : "#/components/schemas/StreamsDataProcessRegion" - }, - "groupId" : { + "apiToken" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the project.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "hostnames" : { - "type" : "array", - "description" : "List that contains the hostnames assigned to the stream instance.", - "items" : { - "type" : "string", - "description" : "Unique hostname assigned to the stream instance.", - "readOnly" : true - }, - "readOnly" : true - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true + "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" }, - "name" : { + "channelName" : { "type" : "string", - "description" : "Human-readable label that identifies the stream instance." + "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" }, - "streamConfig" : { - "$ref" : "#/components/schemas/StreamConfig" - } - } - }, - "SummaryNotification" : { - "type" : "object", - "description" : "Summary notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", - "properties" : { "delayMin" : { "type" : "integer", "format" : "int32", "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." }, - "emailAddress" : { + "integrationId" : { "type" : "string", - "format" : "email", - "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:\n\n- specific MongoDB Cloud users (`\"notifications.[n].typeName\" : \"USER\"`)\n- MongoDB Cloud users with specific project roles (`\"notifications.[n].typeName\" : \"GROUP\"`)\n- MongoDB Cloud users with specific organization roles (`\"notifications.[n].typeName\" : \"ORG\"`)\n- MongoDB Cloud teams (`\"notifications.[n].typeName\" : \"TEAM\"`)\n\nTo send emails to one MongoDB Cloud user or grouping of users, set the **notifications.[n].emailEnabled** parameter." + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" }, "intervalMin" : { "type" : "integer", @@ -49639,68 +50574,74 @@ "typeName" : { "type" : "string", "description" : "Human-readable label that displays the alert notification type.", - "enum" : [ "SUMMARY" ] + "enum" : [ "SLACK" ] } }, "required" : [ "typeName" ], - "title" : "Summary Notification" + "title" : "Slack Notification" }, - "SynonymMappingStatusDetail" : { + "Source" : { "type" : "object", - "description" : "Contains the status of the index's synonym mappings on each search host. This field (and its subfields) only appear if the index has synonyms defined.", + "description" : "Document that describes the source of the migration.", "properties" : { - "message" : { + "caCertificatePath" : { "type" : "string", - "description" : "Optional message describing an error." + "description" : "Path to the CA certificate that signed SSL certificates use to authenticate to the source cluster." }, - "queryable" : { + "clusterName" : { + "type" : "string", + "description" : "Label that identifies the source cluster name." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the source project.", + "example" : "9b43a5b329223c3a1591a678", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "managedAuthentication" : { "type" : "boolean", - "description" : "Flag that indicates whether the synonym mapping is queryable on a host." + "description" : "Flag that indicates whether MongoDB Automation manages authentication to the source cluster. If true, do not provide values for username and password." }, - "status" : { + "password" : { "type" : "string", - "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", - "enum" : [ "FAILED", "BUILDING", "READY" ] + "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 } }, - "title" : "Synonym Mapping Status Detail" + "required" : [ "clusterName", "groupId", "managedAuthentication", "ssl" ] }, - "SynonymMappingStatusDetailMap" : { + "StorageEngine" : { "type" : "object", "additionalProperties" : { - "$ref" : "#/components/schemas/SynonymMappingStatusDetail" - }, - "x-additionalPropertiesName" : "Synonym Mapping Name" - }, - "SynonymSource" : { - "type" : "object", - "description" : "Data set that stores words and their applicable synonyms.", - "properties" : { - "collection" : { - "type" : "string", - "description" : "Label that identifies the MongoDB collection that stores words and their applicable synonyms." + "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/" } }, - "required" : [ "collection" ] + "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/" + } }, - "SystemStatus" : { + "StreamConfig" : { "type" : "object", + "description" : "Configuration options for an Atlas Stream Processing Instance.", + "nullable" : true, "properties" : { - "apiKey" : { - "$ref" : "#/components/schemas/ApiKey" - }, - "appName" : { - "type" : "string", - "description" : "Human-readable label that identifies the service from which you requested this response.", - "enum" : [ "MongoDB Atlas" ], - "readOnly" : true - }, - "build" : { - "type" : "string", - "description" : "Unique 40-hexadecimal digit hash that identifies the latest git commit merged for this application.", - "example" : "83be55e140f493c88e7f578aae96548dd881587b", - "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.", @@ -49713,43 +50654,44 @@ }, "readOnly" : true }, - "throttling" : { - "type" : "boolean", - "description" : "Flag that indicates whether someone enabled throttling on this service.", - "readOnly" : true - } - }, - "required" : [ "apiKey", "appName", "build", "throttling" ] - }, - "TargetOrg" : { - "type" : "object", - "properties" : { - "linkToken" : { + "tier" : { "type" : "string", - "description" : "Link token that contains all the information required to complete the link." - } - }, - "required" : [ "linkToken" ] - }, - "TargetOrgRequest" : { - "type" : "object", - "properties" : { - "accessListIps" : { - "type" : "array", - "description" : "IP address access list entries associated with the API key.", - "items" : { - "type" : "string", - "description" : "One IP address access list entry associated with the API key." - } + "description" : "Selected tier for the Stream Instance. Configures Memory / VCPU allowances.", + "enum" : [ "SP30", "SP10" ], + "title" : "Stream Instance Tier" } } }, - "Team" : { + "StreamProcessorAlertConfigViewForNdsGroup" : { "type" : "object", + "description" : "Host metric alert configuration allows to select which Atlas streams processors trigger alerts and how users are notified.", "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/StreamProcessorEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies this team.", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -49768,30 +50710,54 @@ }, "readOnly" : true }, - "name" : { - "type" : "string", - "description" : "Human-readable label that identifies the team." + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration.", + "items" : { + "$ref" : "#/components/schemas/StreamsMatcher" + } }, - "usernames" : { + "notifications" : { "type" : "array", - "description" : "List that contains the MongoDB Cloud users in this team.", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", "items" : { - "type" : "string", - "format" : "email", - "description" : "List that contains email addresses that identify MongoDB Cloud users to in this team." - }, - "uniqueItems" : true + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true } }, - "required" : [ "name" ] + "required" : [ "eventTypeName", "notifications" ], + "title" : "Stream Processor Alert Configuration" }, - "TeamEvent" : { + "StreamProcessorAlertViewForNdsGroup" : { "type" : "object", - "description" : "Team event identifies different activities around organization teams.", + "description" : "Stream Processor alert notifies about activities on Stream Processor in AtlasStreams.", "properties" : { - "apiKeyId" : { + "acknowledgedUntil" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "format" : "date-time", + "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.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -49801,15 +50767,15 @@ "created" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, "eventTypeName" : { - "$ref" : "#/components/schemas/TeamEventTypeView" + "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroupAlertable" }, "groupId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -49818,17 +50784,23 @@ }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "isGlobalAdmin" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "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.", + "example" : "foobar", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", "readOnly" : true }, "links" : { @@ -49845,86 +50817,72 @@ }, "orgId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "publicKey" : { + "processorErrorMsg" : { "type" : "string", - "format" : "email", - "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "example" : "test.user@mongodb.com", + "description" : "The error message associated with the Stream Processor to which this alert applies.", + "example" : "MongoServerError: Failed to start stream processor: (Location77175) Could not connect to the Kafka topic with kafka error code: -195, message: Local: Broker transport failure.: (Location77175)", "readOnly" : true }, - "raw" : { - "$ref" : "#/components/schemas/raw" + "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.", + "example" : "foobar", + "readOnly" : true }, - "remoteAddress" : { + "processorState" : { "type" : "string", - "description" : "IPv4 or IPv6 address from which the user triggered this event.", - "example" : "216.172.40.186", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "description" : "The state of the Stream Processor to which this alert applies. The resource returns this parameter for alerts of events impacting Stream Processors.", + "example" : "STARTED", "readOnly" : true }, - "teamId" : { + "resolved" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization team associated with this event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "format" : "date-time", + "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\"`.", "readOnly" : true }, - "userId" : { + "status" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", "readOnly" : true }, - "username" : { + "updated" : { "type" : "string", - "format" : "email", - "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", - "example" : "test.user@mongodb.com", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true } }, - "required" : [ "created", "eventTypeName", "id" ], - "title" : "Team Events" + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Stream Processor Alerts" }, - "TeamEventTypeView" : { + "StreamProcessorEventTypeViewAlertable" : { "type" : "string", - "description" : "Unique identifier of event type.", - "enum" : [ "TEAM_CREATED", "TEAM_DELETED", "TEAM_UPDATED", "TEAM_NAME_CHANGED", "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], - "example" : "TEAM_ADDED_TO_GROUP", - "title" : "Team Event Types" + "description" : "Event type that triggers an alert.", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "example" : "STREAM_PROCESSOR_STATE_IS_FAILED", + "title" : "Stream Processor Event Types" }, - "TeamEventTypeViewForNdsGroup" : { + "StreamProcessorEventTypeViewForNdsGroup" : { "type" : "string", "description" : "Unique identifier of event type.", - "enum" : [ "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], - "example" : "TEAM_ADDED_TO_GROUP", - "title" : "Team Event Types" + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "example" : "STREAM_PROCESSOR_STATE_IS_FAILED", + "title" : "Stream Processor Event Types" }, - "TeamEventViewForNdsGroup" : { + "StreamProcessorEventViewForNdsGroup" : { "type" : "object", - "description" : "Team event identifies different activities around organization teams.", + "description" : "Stream Processor event identifies different activities about a stream processor in Atlas Streams.", "properties" : { - "apiKeyId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, "created" : { "type" : "string", "format" : "date-time", @@ -49932,7 +50890,7 @@ "readOnly" : true }, "eventTypeName" : { - "$ref" : "#/components/schemas/TeamEventTypeViewForNdsGroup" + "$ref" : "#/components/schemas/StreamProcessorEventTypeViewForNdsGroup" }, "groupId" : { "type" : "string", @@ -49952,10 +50910,10 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "isGlobalAdmin" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "instanceName" : { + "type" : "string", + "description" : "Name of the stream processing instance associated with the event.", + "example" : "foobar", "readOnly" : true }, "links" : { @@ -49979,113 +50937,297 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "publicKey" : { + "processorErrorMsg" : { "type" : "string", - "format" : "email", - "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "example" : "test.user@mongodb.com", + "description" : "Error message linked to the stream processor associated with the event.", + "example" : "invalid auth", + "readOnly" : true + }, + "processorName" : { + "type" : "string", + "description" : "Name of the stream processor associated with the event.", + "example" : "foobar", + "readOnly" : true + }, + "processorState" : { + "type" : "string", + "description" : "State of the stream processor associated with the event.", + "example" : "FAILED", "readOnly" : true }, "raw" : { "$ref" : "#/components/schemas/raw" + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Stream Processor Events" + }, + "StreamsClusterConnection" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/StreamsConnection" + }, { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Name of the cluster configured for this connection." + }, + "dbRoleToExecute" : { + "$ref" : "#/components/schemas/DBRoleToExecute" + } + } + } ] + }, + "StreamsConnection" : { + "type" : "object", + "description" : "Settings that define a connection to an external data store.", + "discriminator" : { + "mapping" : { + "Cluster" : "#/components/schemas/StreamsClusterConnection", + "Kafka" : "#/components/schemas/StreamsKafkaConnection", + "Sample" : "#/components/schemas/StreamsSampleConnection" }, - "remoteAddress" : { + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/StreamsSampleConnection" + }, { + "$ref" : "#/components/schemas/StreamsClusterConnection" + }, { + "$ref" : "#/components/schemas/StreamsKafkaConnection" + } ], + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { "type" : "string", - "description" : "IPv4 or IPv6 address from which the user triggered this event.", - "example" : "216.172.40.186", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "description" : "Human-readable label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source." + }, + "type" : { + "type" : "string", + "description" : "Type of the connection. Can be either Cluster or Kafka.", + "enum" : [ "Kafka", "Cluster", "Sample" ] + } + }, + "readOnly" : true + }, + "StreamsDLQ" : { + "type" : "object", + "description" : "Dead letter queue for the stream processor.", + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/reference/glossary/#std-term-dead-letter-queue" + }, + "properties" : { + "coll" : { + "type" : "string", + "description" : "Name of the collection to use for the DLQ." + }, + "connectionName" : { + "type" : "string", + "description" : "Name of the connection to write DLQ messages to. Must be an Atlas connection." + }, + "db" : { + "type" : "string", + "description" : "Name of the database to use for the DLQ." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, "readOnly" : true + } + } + }, + "StreamsDataProcessRegion" : { + "type" : "object", + "description" : "Information about the cloud provider region in which MongoDB Cloud processes the stream.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Label that identifies the cloud service provider where MongoDB Cloud performs stream processing. Currently, this parameter supports AWS only.", + "enum" : [ "AWS", "GCP", "AZURE", "TENANT", "SERVERLESS" ] }, - "teamId" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "region" : { + "$ref" : "#/components/schemas/BaseStreamsRegion" + } + }, + "required" : [ "cloudProvider", "region" ] + }, + "StreamsEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "MAX_PROCESSOR_COUNT_REACHED" ], + "example" : "MAX_PROCESSOR_COUNT_REACHED", + "title" : "Streams Event Types" + }, + "StreamsEventViewForNdsGroup" : { + "type" : "object", + "description" : "Streams event identifies different activities about Atlas Streams.", + "properties" : { + "created" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization team associated with this event.", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/StreamsEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "userId" : { + "id" : { "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.", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "username" : { + "instanceName" : { "type" : "string", - "format" : "email", - "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", - "example" : "test.user@mongodb.com", + "description" : "Name of the stream processing instance associated with the event.", + "example" : "foobar", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" } }, "required" : [ "created", "eventTypeName", "id" ], - "title" : "Team Events" + "title" : "Streams Events" }, - "TeamNotification" : { + "StreamsKafkaAuthentication" : { "type" : "object", - "description" : "Team notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "description" : "User credentials required to connect to a Kafka Cluster. Includes the authentication type, as well as the parameters for that authentication mode.", "properties" : { - "delayMin" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." - }, - "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:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" - }, - "intervalMin" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", - "minimum" : 5 - }, - "notifierId" : { - "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:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true }, - "teamId" : { + "mechanism" : { "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", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" + "description" : "Style of authentication. Can be one of PLAIN, SCRAM-256, or SCRAM-512." }, - "teamName" : { + "password" : { "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" + "format" : "password", + "description" : "Password of the account to connect to the Kafka cluster.", + "writeOnly" : true }, - "typeName" : { + "username" : { "type" : "string", - "description" : "Human-readable label that displays the alert notification type.", - "enum" : [ "TEAM" ] + "description" : "Username of the account to connect to the Kafka cluster." } - }, - "required" : [ "typeName" ], - "title" : "Team Notification" + } }, - "TeamResponse" : { + "StreamsKafkaConnection" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/StreamsConnection" + }, { + "type" : "object", + "properties" : { + "authentication" : { + "$ref" : "#/components/schemas/StreamsKafkaAuthentication" + }, + "bootstrapServers" : { + "type" : "string", + "description" : "Comma separated list of server addresses." + }, + "config" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.", + "example" : "{\"group.protocol.type\":\"consumer\",\"debug\":\"queue, msg, protocol\"}" + }, + "description" : "A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.", + "example" : { + "debug" : "queue, msg, protocol", + "group.protocol.type" : "consumer" + } + }, + "networking" : { + "$ref" : "#/components/schemas/StreamsKafkaNetworking" + }, + "security" : { + "$ref" : "#/components/schemas/StreamsKafkaSecurity" + } + } + } ] + }, + "StreamsKafkaNetworking" : { "type" : "object", + "description" : "Networking Access Type can either be 'PUBLIC' (default) or VPC. VPC type is in public preview, please file a support ticket to enable VPC Network Access", "properties" : { - "id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies this team.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "access" : { + "$ref" : "#/components/schemas/StreamsKafkaNetworkingAccess" }, "links" : { "type" : "array", @@ -50098,16 +51240,21 @@ "$ref" : "#/components/schemas/Link" }, "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "Human-readable label that identifies the team." } } }, - "TeamRole" : { + "StreamsKafkaNetworkingAccess" : { "type" : "object", + "description" : "Information about the networking access.", "properties" : { + "connectionId" : { + "type" : "string", + "description" : "Reserved. Will be used by PRIVATE_LINK connection type.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, "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.", @@ -50120,28 +51267,26 @@ }, "readOnly" : true }, - "roleNames" : { - "type" : "array", - "description" : "One or more organization- or project-level roles to assign to the MongoDB Cloud user.", - "items" : { - "type" : "string", - "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] - }, - "uniqueItems" : true + "name" : { + "type" : "string", + "description" : "Reserved. Will be used by PRIVATE_LINK connection type." }, - "teamId" : { + "type" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the team.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" + "description" : "Selected networking type. Either PUBLIC, VPC or PRIVATE_LINK. Defaults to PUBLIC. For VPC, ensure that VPC peering exists and connectivity has been established between Atlas VPC and the VPC where Kafka cluster is hosted for the connection to function properly. PRIVATE_LINK support is coming soon.", + "enum" : [ "PUBLIC", "VPC", "PRIVATE_LINK" ], + "title" : "Networking Access Type" } } }, - "TeamUpdate" : { + "StreamsKafkaSecurity" : { "type" : "object", + "description" : "Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use.", "properties" : { + "brokerPublicCertificate" : { + "type" : "string", + "description" : "A trusted, public x509 certificate for connecting to Kafka over SSL." + }, "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.", @@ -50154,108 +51299,83 @@ }, "readOnly" : true }, - "name" : { - "type" : "string", - "description" : "Human-readable label that identifies the team.", - "writeOnly" : true - } - }, - "required" : [ "name" ] - }, - "TenantHardwareSpec" : { - "type" : "object", - "properties" : { - "instanceSize" : { + "protocol" : { "type" : "string", - "description" : "Hardware specification for the instances in this M0/M2/M5 tier cluster.", - "enum" : [ "M0", "M2", "M5" ], - "title" : "Tenant Instance Sizes" + "description" : "Describes the transport type. Can be either PLAINTEXT or SSL." } } }, - "TenantHardwareSpec20240805" : { + "StreamsMatcher" : { "type" : "object", + "description" : "Rules to apply when comparing a stream processing instance or stream processor against this alert configuration.", "properties" : { - "diskSizeGB" : { - "type" : "number", - "format" : "double", - "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", - "maximum" : 4096, - "minimum" : 10 + "fieldName" : { + "$ref" : "#/components/schemas/StreamsMatcherField" }, - "instanceSize" : { + "operator" : { "type" : "string", - "description" : "Hardware specification for the instances in this M0/M2/M5 tier cluster.", - "enum" : [ "M0", "M2", "M5" ], - "title" : "Tenant Instance Sizes" + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" } - } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" }, - "TenantRegionConfig" : { - "type" : "object", - "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`.", - "enum" : [ "AWS", "GCP", "AZURE" ] - } - } - } ], - "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", - "title" : "Tenant Regional Replication Specifications" + "StreamsMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "INSTANCE_NAME", "PROCESSOR_NAME" ], + "example" : "INSTANCE_NAME", + "title" : "Streams Matcher Fields" }, - "TenantRegionConfig20240805" : { + "StreamsOptions" : { "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/CloudRegionConfig20240805" - }, { - "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`.", - "enum" : [ "AWS", "GCP", "AZURE" ] - } + "description" : "Optional configuration for the stream processor.", + "properties" : { + "dlq" : { + "$ref" : "#/components/schemas/StreamsDLQ" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true } - } ], - "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", - "title" : "Tenant Regional Replication Specifications" + } }, - "TenantRestore" : { + "StreamsPrivateLinkConnection" : { "type" : "object", + "description" : "Container for metadata needed to create a Private Link connection.", "properties" : { - "clusterName" : { + "_id" : { "type" : "string", - "description" : "Human-readable label that identifies the source cluster.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "readOnly" : true + "description" : "The ID of the Private Link connection." }, - "deliveryType" : { + "dnsDomain" : { "type" : "string", - "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", - "enum" : [ "RESTORE", "DOWNLOAD" ], - "readOnly" : true + "description" : "Domain name of Confluent cluster." }, - "expirationDate" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "dnsSubDomain" : { + "type" : "array", + "description" : "Sub-Domain name of Confluent cluster. These are typically your availability zones.", + "items" : { + "type" : "string" + } }, - "id" : { + "interfaceEndpointId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "description" : "Interface endpoint ID that is created from the service endpoint ID provided." }, "links" : { "type" : "array", @@ -50269,354 +51389,451 @@ }, "readOnly" : true }, - "projectId" : { + "provider" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "description" : "Provider where the Kafka cluster is deployed." }, - "restoreFinishedDate" : { + "region" : { "type" : "string", - "format" : "date-time", - "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.", - "readOnly" : true + "description" : "Domain name of Confluent cluster." }, - "restoreScheduledDate" : { + "serviceEndpointId" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "description" : "AWS Service Endpoint ID." }, - "snapshotFinishedDate" : { + "state" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "description" : "State the connection is in." }, - "snapshotId" : { + "vendor" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "description" : "Vendor who manages the Kafka cluster." + } + } + }, + "StreamsProcessor" : { + "type" : "object", + "description" : "An atlas stream processor.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the stream processor.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" - }, - "snapshotUrl" : { - "type" : "string", - "description" : "Internet address from which you can download the compressed snapshot files. The resource returns this parameter when `\"deliveryType\" : \"DOWNLOAD\"`.", + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "status" : { - "type" : "string", - "description" : "Phase of the restore workflow for this job at the time this resource made this request.", - "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, "readOnly" : true }, - "targetDeploymentItemName" : { + "name" : { "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.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + "description" : "Human-readable name of the stream processor." }, - "targetProjectId" : { - "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", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" + "options" : { + "$ref" : "#/components/schemas/StreamsOptions" + }, + "pipeline" : { + "type" : "array", + "description" : "Stream aggregation pipeline you want to apply to your streaming data.", + "externalDocs" : { + "description" : "Supported Aggregation Pipeline Stages", + "url" : "https://www.mongodb.com/docs/atlas/atlas-stream-processing/stream-aggregation/#std-label-stream-aggregation" + }, + "items" : { + "$ref" : "#/components/schemas/Document" + } } - }, - "required" : [ "snapshotId", "targetDeploymentItemName" ] + } }, - "TextSearchHostStatusDetail" : { + "StreamsProcessorWithStats" : { "type" : "object", + "description" : "An atlas stream processor with optional stats.", "properties" : { - "hostname" : { + "_id" : { "type" : "string", - "description" : "Hostname that corresponds to the status detail." + "description" : "Unique 24-hexadecimal character string that identifies the stream processor.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "mainIndex" : { - "$ref" : "#/components/schemas/TextSearchIndexStatusDetail" + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true }, - "queryable" : { - "type" : "boolean", - "description" : "Flag that indicates whether the index is queryable on the host." + "name" : { + "type" : "string", + "description" : "Human-readable name of the stream processor.", + "readOnly" : true }, - "stagedIndex" : { - "$ref" : "#/components/schemas/TextSearchIndexStatusDetail" + "options" : { + "$ref" : "#/components/schemas/StreamsOptions" }, - "status" : { + "pipeline" : { + "type" : "array", + "description" : "Stream aggregation pipeline you want to apply to your streaming data.", + "items" : { + "$ref" : "#/components/schemas/Document" + }, + "readOnly" : true + }, + "state" : { "type" : "string", - "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", - "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + "description" : "The state of the stream processor. Commonly occurring states are 'CREATED', 'STARTED', 'STOPPED' and 'FAILED'.", + "readOnly" : true + }, + "stats" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "The stats associated with the stream processor.", + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor" + }, + "readOnly" : true + }, + "description" : "The stats associated with the stream processor.", + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor" + }, + "readOnly" : true } }, - "title" : "Text Search Host Status Detail" + "required" : [ "_id", "name", "pipeline", "state" ] }, - "TextSearchIndexCreateRequest" : { + "StreamsSampleConnection" : { "type" : "object", "allOf" : [ { - "$ref" : "#/components/schemas/SearchIndexCreateRequest" - }, { - "type" : "object", - "properties" : { - "definition" : { - "$ref" : "#/components/schemas/TextSearchIndexDefinition" - } + "$ref" : "#/components/schemas/StreamsConnection" + } ] + }, + "StreamsSampleConnections" : { + "type" : "object", + "description" : "Sample connections to add to SPI.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "solar" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to add a 'sample_stream_solar' connection." } - } ], - "description" : "Text Search Index Create Request", - "required" : [ "collectionName", "database", "definition", "name" ] + } }, - "TextSearchIndexDefinition" : { + "StreamsTenant" : { "type" : "object", - "description" : "The text search index definition set by the user.", "properties" : { - "analyzer" : { + "_id" : { "type" : "string", - "default" : "lucene.standard", - "description" : "Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves making the following changes to the text in fields:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\n MongoDB Cloud uses the process you select to build the Atlas Search index.", - "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ], - "externalDocs" : { - "description" : "Atlas Search Analyzers", - "url" : "https://dochub.mongodb.org/core/analyzers--fts" - } + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "analyzers" : { + "connections" : { "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" - }, + "description" : "List of connections configured in the stream instance.", "items" : { - "$ref" : "#/components/schemas/AtlasSearchAnalyzer" - } + "$ref" : "#/components/schemas/StreamsConnection" + }, + "readOnly" : true }, - "mappings" : { - "$ref" : "#/components/schemas/SearchMappings" + "dataProcessRegion" : { + "$ref" : "#/components/schemas/StreamsDataProcessRegion" }, - "searchAnalyzer" : { + "groupId" : { "type" : "string", - "default" : "lucene.standard", - "description" : "Method applied to identify words when searching this index.", - "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "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 Stored Source Fields.", - "example" : { - "include | exclude" : [ "field1", "field2" ] + "hostnames" : { + "type" : "array", + "description" : "List that contains the hostnames assigned to the stream instance.", + "items" : { + "type" : "string", + "description" : "Unique hostname assigned to the stream instance.", + "readOnly" : true }, - "externalDocs" : { - "description" : "Stored Source Fields", - "url" : "https://dochub.mongodb.org/core/atlas-search-stored-source" - } + "readOnly" : true }, - "synonyms" : { + "links" : { "type" : "array", - "description" : "Rule sets that map words to their synonyms in this index.", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", "externalDocs" : { - "description" : "Synonym Mapping", - "url" : "https://dochub.mongodb.org/core/fts-synonym-mappings" + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" }, "items" : { - "$ref" : "#/components/schemas/SearchSynonymMappingDefinition" - } - } - }, - "required" : [ "mappings" ], - "title" : "Text Search Index Definition" - }, - "TextSearchIndexResponse" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/SearchIndexResponse" - }, { - "type" : "object", - "properties" : { - "latestDefinition" : { - "$ref" : "#/components/schemas/TextSearchIndexDefinition" - }, - "statusDetail" : { - "type" : "array", - "description" : "List of documents detailing index status on each host.", - "items" : { - "$ref" : "#/components/schemas/TextSearchHostStatusDetail" - } - }, - "synonymMappingStatus" : { - "type" : "string", - "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", - "enum" : [ "FAILED", "BUILDING", "READY" ] - }, - "synonymMappingStatusDetail" : { - "type" : "array", - "description" : "A list of documents describing the status of the index's synonym mappings on each search host. Only appears if the index has synonyms defined.", - "items" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/SynonymMappingStatusDetail" - } - } - } + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the stream instance." + }, + "sampleConnections" : { + "$ref" : "#/components/schemas/StreamsSampleConnections" + }, + "streamConfig" : { + "$ref" : "#/components/schemas/StreamConfig" } - } ], - "title" : "Text Search Index Response" + } }, - "TextSearchIndexStatusDetail" : { + "SummaryNotification" : { "type" : "object", - "description" : "Contains status information about a text search index.", + "description" : "Summary notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", "properties" : { - "definition" : { - "$ref" : "#/components/schemas/TextSearchIndexDefinition" + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." }, - "definitionVersion" : { - "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + "emailAddress" : { + "type" : "string", + "format" : "email", + "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:\n\n- specific MongoDB Cloud users (`\"notifications.[n].typeName\" : \"USER\"`)\n- MongoDB Cloud users with specific project roles (`\"notifications.[n].typeName\" : \"GROUP\"`)\n- MongoDB Cloud users with specific organization roles (`\"notifications.[n].typeName\" : \"ORG\"`)\n- MongoDB Cloud teams (`\"notifications.[n].typeName\" : \"TEAM\"`)\n\nTo send emails to one MongoDB Cloud user or grouping of users, set the **notifications.[n].emailEnabled** parameter." + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "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" ] + } + }, + "required" : [ "typeName" ], + "title" : "Summary Notification" + }, + "SynonymMappingStatusDetail" : { + "type" : "object", + "description" : "Contains the status of the index's synonym mappings on each search host. This field (and its subfields) only appear if the index has synonyms defined.", + "properties" : { "message" : { "type" : "string", "description" : "Optional message describing an error." }, "queryable" : { "type" : "boolean", - "description" : "Flag that indicates whether the index generation is queryable on the host." + "description" : "Flag that indicates whether the synonym mapping is queryable on a host." }, "status" : { - "type" : "string", - "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", - "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] - }, - "synonymMappingStatus" : { "type" : "string", "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", "enum" : [ "FAILED", "BUILDING", "READY" ] - }, - "synonymMappingStatusDetail" : { - "type" : "array", - "description" : "List of synonym statuses by mapping.", - "items" : { - "$ref" : "#/components/schemas/SynonymMappingStatusDetailMap" - } } }, - "title" : "Text Search Index Status Detail" + "title" : "Synonym Mapping Status Detail" }, - "ThirdPartyIntegration" : { + "SynonymMappingStatusDetailMap" : { "type" : "object", - "description" : "Collection of settings that describe third-party integrations.", - "discriminator" : { - "mapping" : { - "DATADOG" : "#/components/schemas/Datadog", - "MICROSOFT_TEAMS" : "#/components/schemas/MicrosoftTeams", - "NEW_RELIC" : "#/components/schemas/NewRelic", - "OPS_GENIE" : "#/components/schemas/OpsGenie", - "PAGER_DUTY" : "#/components/schemas/PagerDuty", - "PROMETHEUS" : "#/components/schemas/Prometheus", - "SLACK" : "#/components/schemas/Slack", - "VICTOR_OPS" : "#/components/schemas/VictorOps", - "WEBHOOK" : "#/components/schemas/Webhook" - }, - "propertyName" : "type" + "additionalProperties" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetail" }, + "x-additionalPropertiesName" : "Synonym Mapping Name" + }, + "SynonymSource" : { + "type" : "object", + "description" : "Data set that stores words and their applicable synonyms.", "properties" : { - "id" : { - "type" : "string", - "description" : "Integration id.", - "nullable" : true - }, - "type" : { + "collection" : { "type" : "string", - "description" : "Integration type", - "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], - "title" : "Integration Type" + "description" : "Label that identifies the MongoDB collection that stores words and their applicable synonyms." } }, - "title" : "Third-Party Integration" + "required" : [ "collection" ] }, - "TimeMetricAlertView" : { + "SystemStatus" : { "type" : "object", "properties" : { - "acknowledgedUntil" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + "apiKey" : { + "$ref" : "#/components/schemas/ApiKey" }, - "acknowledgementComment" : { + "appName" : { "type" : "string", - "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", - "example" : "Expiration on 3/19. Silencing for 7days.", - "maxLength" : 200 + "description" : "Human-readable label that identifies the service from which you requested this response.", + "enum" : [ "MongoDB Atlas" ], + "readOnly" : true }, - "acknowledgingUsername" : { + "build" : { "type" : "string", - "format" : "email", - "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "description" : "Unique 40-hexadecimal digit hash that identifies the latest git commit merged for this application.", + "example" : "83be55e140f493c88e7f578aae96548dd881587b", "readOnly" : true }, - "alertConfigId" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "throttling" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled throttling on this service.", + "readOnly" : true + } + }, + "required" : [ "apiKey", "appName", "build", "throttling" ] + }, + "TargetOrg" : { + "type" : "object", + "properties" : { + "linkToken" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "description" : "Link token that contains all the information required to complete the link." + } + }, + "required" : [ "linkToken" ] + }, + "TargetOrgRequest" : { + "type" : "object", + "properties" : { + "accessListIps" : { + "type" : "array", + "description" : "IP address access list entries associated with the API key.", + "items" : { + "type" : "string", + "description" : "One IP address access list entry associated with the API key." + } + } + } + }, + "Team" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this team.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "clusterName" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { "type" : "string", - "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", - "example" : "cluster1", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "description" : "Human-readable label that identifies the team." + }, + "usernames" : { + "type" : "array", + "description" : "List that contains the MongoDB Cloud users in this team.", + "items" : { + "type" : "string", + "format" : "email", + "description" : "List that contains email addresses that identify MongoDB Cloud users to in this team." + }, + "uniqueItems" : true + } + }, + "required" : [ "name" ] + }, + "TeamEvent" : { + "type" : "object", + "description" : "Team event identifies different activities around organization teams.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, "created" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "currentValue" : { - "$ref" : "#/components/schemas/TimeMetricValueView" - }, "eventTypeName" : { - "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + "$ref" : "#/components/schemas/TeamEventTypeView" }, "groupId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "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.", - "example" : "cloud-test.mongodb.com:27017", - "readOnly" : true - }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "lastNotified" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", "readOnly" : true }, "links" : { @@ -50631,51 +51848,78 @@ }, "readOnly" : true }, - "metricName" : { - "type" : "string", - "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", - "example" : "ASSERT_USER", - "readOnly" : true - }, "orgId" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "replicaSetName" : { + "publicKey" : { "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.", - "example" : "event-replica-set", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true }, - "resolved" : { + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { "type" : "string", - "format" : "date-time", - "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\"`.", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", "readOnly" : true }, - "status" : { + "teamId" : { "type" : "string", - "description" : "State of this alert at the time you requested its details.", - "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], - "example" : "OPEN", + "description" : "Unique 24-hexadecimal digit string that identifies the organization team associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "updated" : { + "userId" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true } }, - "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Team Events" }, - "TimeMetricEventView" : { + "TeamEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TEAM_CREATED", "TEAM_DELETED", "TEAM_UPDATED", "TEAM_NAME_CHANGED", "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "example" : "TEAM_ADDED_TO_GROUP", + "title" : "Team Event Types" + }, + "TeamEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "example" : "TEAM_ADDED_TO_GROUP", + "title" : "Team Event Types" + }, + "TeamEventViewForNdsGroup" : { "type" : "object", + "description" : "Team event identifies different activities around organization teams.", "properties" : { "apiKeyId" : { "type" : "string", @@ -50692,11 +51936,8 @@ "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "currentValue" : { - "$ref" : "#/components/schemas/TimeMetricValueView" - }, "eventTypeName" : { - "$ref" : "#/components/schemas/HostMetricEventTypeView" + "$ref" : "#/components/schemas/TeamEventTypeViewForNdsGroup" }, "groupId" : { "type" : "string", @@ -50734,11 +51975,6 @@ }, "readOnly" : true }, - "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" : { "type" : "string", "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", @@ -50748,13 +51984,6 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "port" : { - "type" : "integer", - "format" : "int32", - "description" : "IANA port on which the MongoDB process listens for requests.", - "example" : 27017, - "readOnly" : true - }, "publicKey" : { "type" : "string", "format" : "email", @@ -50772,16 +52001,13 @@ "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", "readOnly" : true }, - "replicaSetName" : { - "type" : "string", - "description" : "Human-readable label of the replica set associated with the event.", - "example" : "event-replica-set", - "readOnly" : true - }, - "shardName" : { + "teamId" : { "type" : "string", - "description" : "Human-readable label of the shard associated with the event.", - "example" : "event-sh-01", + "description" : "Unique 24-hexadecimal digit string that identifies the organization team associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, "userId" : { @@ -50801,250 +52027,220 @@ "readOnly" : true } }, - "required" : [ "created", "eventTypeName", "id" ] + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Team Events" }, - "TimeMetricThresholdView" : { + "TeamNotification" : { "type" : "object", + "description" : "Team notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", "properties" : { - "metricName" : { - "type" : "string", - "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." }, - "mode" : { + "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:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { "type" : "string", - "description" : "MongoDB Cloud computes the current metric value as an average.", - "enum" : [ "AVERAGE" ] + "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" }, - "operator" : { - "$ref" : "#/components/schemas/Operator" + "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:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" }, - "threshold" : { - "type" : "number", - "format" : "double", - "description" : "Value of metric that, when exceeded, triggers an alert." + "teamId" : { + "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", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" }, - "units" : { - "$ref" : "#/components/schemas/TimeMetricUnits" - } - }, - "required" : [ "metricName" ] - }, - "TimeMetricUnits" : { - "type" : "string", - "default" : "HOURS", - "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", - "enum" : [ "NANOSECONDS", "MILLISECONDS", "MILLION_MINUTES", "SECONDS", "MINUTES", "HOURS", "DAYS" ], - "title" : "Time Metric Units" - }, - "TimeMetricValueView" : { - "type" : "object", - "description" : "Measurement of the **metricName** recorded at the time of the event.", - "properties" : { - "number" : { - "type" : "number", - "format" : "double", - "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", - "readOnly" : true + "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" }, - "units" : { - "$ref" : "#/components/schemas/TimeMetricUnits" - } - }, - "readOnly" : true, - "title" : "Time Metric Value" - }, - "TokenFilterEnglishPossessive" : { - "type" : "object", - "description" : "Filter that removes possessives (trailing 's) from words.", - "properties" : { - "type" : { + "typeName" : { "type" : "string", - "description" : "Human-readable label that identifies this token filter type.", - "enum" : [ "englishPossessive" ] + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "TEAM" ] } }, - "required" : [ "type" ], - "title" : "englishPossessive" + "required" : [ "typeName" ], + "title" : "Team Notification" }, - "TokenFilterFlattenGraph" : { + "TeamResponse" : { "type" : "object", - "description" : "Filter that transforms a token filter graph, such as the token filter graph that the wordDelimiterGraph token filter produces, into a flat form suitable for indexing.", "properties" : { - "type" : { + "id" : { "type" : "string", - "description" : "Human-readable label that identifies this token filter type.", - "enum" : [ "flattenGraph" ] + "description" : "Unique 24-hexadecimal digit string that identifies this team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the team." } - }, - "required" : [ "type" ], - "title" : "flattenGraph" + } }, - "TokenFilterPorterStemming" : { + "TeamRole" : { "type" : "object", - "description" : "Filter that uses the porter stemming algorithm to remove the common morphological and inflectional suffixes from words in English. It expects lowercase text and doesn't work as expected for uppercase text.", "properties" : { - "type" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "roleNames" : { + "type" : "array", + "description" : "One or more organization- or project-level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "teamId" : { "type" : "string", - "description" : "Human-readable label that identifies this token filter type.", - "enum" : [ "porterStemming" ] + "description" : "Unique 24-hexadecimal character string that identifies the team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" } - }, - "required" : [ "type" ], - "title" : "porterStemming" + } }, - "TokenFilterSpanishPluralStemming" : { + "TeamUpdate" : { "type" : "object", - "description" : "Filter that stems Spanish plural words. It expects lowercase text.", "properties" : { - "type" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { "type" : "string", - "description" : "Human-readable label that identifies this token filter type.", - "enum" : [ "spanishPluralStemming" ] + "description" : "Human-readable label that identifies the team.", + "writeOnly" : true } }, - "required" : [ "type" ], - "title" : "spanishPluralStemming" + "required" : [ "name" ] }, - "TokenFilterStempel" : { + "TenantHardwareSpec" : { "type" : "object", - "description" : "Filter that uses Lucene's default Polish stemmer table to stem words in the Polish language. It expects lowercase text.", - "externalDocs" : { - "description" : "Default Polish stemmer table", - "url" : "https://lucene.apache.org/core/9_2_0/analysis/stempel/org/apache/lucene/analysis/pl/PolishAnalyzer.html#DEFAULT_STEMMER_FILE" - }, "properties" : { - "type" : { + "instanceSize" : { "type" : "string", - "description" : "Human-readable label that identifies this token filter type.", - "enum" : [ "stempel" ] + "description" : "Hardware specification for the instances in this M0/M2/M5 tier cluster.", + "enum" : [ "M0", "M2", "M5" ], + "title" : "Tenant Instance Sizes" } - }, - "required" : [ "type" ], - "title" : "stempel" + } }, - "TokenFilterWordDelimiterGraph" : { + "TenantHardwareSpec20240805" : { "type" : "object", - "description" : "Filter that splits tokens into sub-tokens based on configured rules.", "properties" : { - "delimiterOptions" : { - "type" : "object", - "description" : "Object that contains the rules that determine how to split words into sub-words.", - "properties" : { - "concatenateAll" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether to concatenate runs." - }, - "concatenateNumbers" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether to concatenate runs of sub-numbers." - }, - "concatenateWords" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether to concatenate runs of sub-words." - }, - "generateNumberParts" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether to split tokens based on sub-numbers. For example, if `true`, this option splits `100-2` into `100` and `2`." - }, - "generateWordParts" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether to split tokens based on sub-words." - }, - "ignoreKeywords" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether to skip tokens with the `keyword` attribute set to `true`" - }, - "preserveOriginal" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether to generate tokens of the original words." - }, - "splitOnCaseChange" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether to split tokens based on letter-case transitions." - }, - "splitOnNumerics" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether to split tokens based on letter-number transitions." - }, - "stemEnglishPossessive" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether to remove trailing possessives from each sub-word." - } - } - }, - "protectedWords" : { - "type" : "object", - "description" : "Object that contains options for protected words.", - "properties" : { - "ignoreCase" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether to ignore letter case sensitivity for protected words." - }, - "words" : { - "type" : "array", - "description" : "List that contains the tokens to protect from delimination.", - "items" : { - "type" : "string" - } - } - }, - "required" : [ "words" ] + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 }, - "type" : { + "instanceSize" : { "type" : "string", - "description" : "Human-readable label that identifies this token filter type.", - "enum" : [ "wordDelimiterGraph" ] + "description" : "Hardware specification for the instances in this M0/M2/M5 tier cluster.", + "enum" : [ "M0", "M2", "M5" ], + "title" : "Tenant Instance Sizes" } - }, - "required" : [ "type" ], - "title" : "wordDelimiterGraph" + } }, - "TokenFilterkStemming" : { + "TenantRegionConfig" : { "type" : "object", - "description" : "Filter that combines algorithmic stemming with a built-in dictionary for the English language to stem words.", - "properties" : { - "type" : { - "type" : "string", - "description" : "Human-readable label that identifies this token filter type.", - "enum" : [ "kStemming" ] + "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`.", + "enum" : [ "AWS", "GCP", "AZURE" ] + } } - }, - "required" : [ "type" ], - "title" : "kStemming" + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Tenant Regional Replication Specifications" }, - "TriggerIngestionPipelineRequest" : { + "TenantRegionConfig20240805" : { "type" : "object", - "properties" : { - "datasetRetentionPolicy" : { - "$ref" : "#/components/schemas/DatasetRetentionPolicy" - }, - "snapshotId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "writeOnly" : true + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20240805" + }, { + "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`.", + "enum" : [ "AWS", "GCP", "AZURE" ] + } } - }, - "required" : [ "snapshotId" ] + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Tenant Regional Replication Specifications" }, - "USSBackupRestoreJob20250101" : { + "TenantRestore" : { "type" : "object", - "description" : "Details for one restore job of a USS instance.", "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the source cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "readOnly" : true + }, "deliveryType" : { "type" : "string", "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", @@ -51066,14 +52262,6 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "instanceName" : { - "type" : "string", - "description" : "Human-readable label that identifies the source instance.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "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.", @@ -51119,8 +52307,7 @@ "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "pattern" : "^([a-f0-9]{24})$" }, "snapshotUrl" : { "type" : "string", @@ -51135,176 +52322,311 @@ }, "targetDeploymentItemName" : { "type" : "string", - "description" : "Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another USS instance or Dedicated cluster tier.", + "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.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", - "readOnly" : true + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" }, "targetProjectId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the cluster to which you want to restore the snapshot.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "pattern" : "^([a-f0-9]{24})$" } }, - "title" : "USS Backup Restore Job" + "required" : [ "snapshotId", "targetDeploymentItemName" ] + }, + "TenantWithSampleConnections" : { + "type" : "object" }, - "USSBackupRestoreJobCreate20250101" : { + "TextSearchHostStatusDetail" : { "type" : "object", - "description" : "Details to create one restore job of a USS instance.", "properties" : { - "_snapshotId" : { + "hostname" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "writeOnly" : true + "description" : "Hostname that corresponds to the status detail." }, - "_targetDeploymentItemName" : { - "type" : "string", - "description" : "Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another USS instance or Dedicated cluster tier.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", - "writeOnly" : true + "mainIndex" : { + "$ref" : "#/components/schemas/TextSearchIndexStatusDetail" }, - "_targetProjectId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "writeOnly" : true + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on the host." }, - "deliveryType" : { - "type" : "string", - "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", - "enum" : [ "RESTORE", "DOWNLOAD" ], - "readOnly" : true + "stagedIndex" : { + "$ref" : "#/components/schemas/TextSearchIndexStatusDetail" }, - "expirationDate" : { + "status" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true - }, - "id" : { + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Text Search Host Status Detail" + }, + "TextSearchIndexCreateRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexCreateRequest" + }, { + "type" : "object", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + } + } + } ], + "description" : "Text Search Index Create Request", + "required" : [ "collectionName", "database", "definition", "name" ] + }, + "TextSearchIndexDefinition" : { + "type" : "object", + "description" : "The text search index definition set by the user.", + "properties" : { + "analyzer" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "default" : "lucene.standard", + "description" : "Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves making the following changes to the text in fields:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\n MongoDB Cloud uses the process you select to build the Atlas Search index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ], + "externalDocs" : { + "description" : "Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/analyzers--fts" + } }, - "instanceName" : { + "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" + }, + "items" : { + "$ref" : "#/components/schemas/AtlasSearchAnalyzer" + } + }, + "mappings" : { + "$ref" : "#/components/schemas/SearchMappings" + }, + "searchAnalyzer" : { "type" : "string", - "description" : "Human-readable label that identifies the source instance.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "readOnly" : true + "default" : "lucene.standard", + "description" : "Method applied to identify words when searching this index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] }, - "links" : { + "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 Stored Source Fields.", + "example" : { + "include | exclude" : [ "field1", "field2" ] + }, + "externalDocs" : { + "description" : "Stored Source Fields", + "url" : "https://dochub.mongodb.org/core/atlas-search-stored-source" + } + }, + "synonyms" : { "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.", + "description" : "Rule sets that map words to their synonyms in this index.", "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + "description" : "Synonym Mapping", + "url" : "https://dochub.mongodb.org/core/fts-synonym-mappings" }, "items" : { - "$ref" : "#/components/schemas/Link" + "$ref" : "#/components/schemas/SearchSynonymMappingDefinition" + } + } + }, + "required" : [ "mappings" ], + "title" : "Text Search Index Definition" + }, + "TextSearchIndexResponse" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexResponse" + }, { + "type" : "object", + "properties" : { + "latestDefinition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" }, - "readOnly" : true + "statusDetail" : { + "type" : "array", + "description" : "List of documents detailing index status on each host.", + "items" : { + "$ref" : "#/components/schemas/TextSearchHostStatusDetail" + } + }, + "synonymMappingStatus" : { + "type" : "string", + "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", + "enum" : [ "FAILED", "BUILDING", "READY" ] + }, + "synonymMappingStatusDetail" : { + "type" : "array", + "description" : "A list of documents describing the status of the index's synonym mappings on each search host. Only appears if the index has synonyms defined.", + "items" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetail" + } + } + } + } + } ], + "title" : "Text Search Index Response" + }, + "TextSearchIndexStatusDetail" : { + "type" : "object", + "description" : "Contains status information about a text search index.", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" }, - "projectId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" }, - "restoreFinishedDate" : { + "message" : { "type" : "string", - "format" : "date-time", - "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.", - "readOnly" : true + "description" : "Optional message describing an error." }, - "restoreScheduledDate" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index generation is queryable on the host." }, - "snapshotFinishedDate" : { + "status" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] }, - "snapshotUrl" : { + "synonymMappingStatus" : { "type" : "string", - "description" : "Internet address from which you can download the compressed snapshot files. The resource returns this parameter when `\"deliveryType\" : \"DOWNLOAD\"`.", - "readOnly" : true + "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", + "enum" : [ "FAILED", "BUILDING", "READY" ] }, - "status" : { - "type" : "string", - "description" : "Phase of the restore workflow for this job at the time this resource made this request.", - "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], - "readOnly" : true + "synonymMappingStatusDetail" : { + "type" : "array", + "description" : "List of synonym statuses by mapping.", + "items" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetailMap" + } } }, - "required" : [ "_snapshotId", "_targetDeploymentItemName" ], - "title" : "Create USS Backup Restore Job" + "title" : "Text Search Index Status Detail" }, - "USSBackupSettings20250101" : { + "ThirdPartyIntegration" : { "type" : "object", - "description" : "USS backup configuration", + "description" : "Collection of settings that describe third-party integrations.", + "discriminator" : { + "mapping" : { + "DATADOG" : "#/components/schemas/Datadog", + "MICROSOFT_TEAMS" : "#/components/schemas/MicrosoftTeams", + "NEW_RELIC" : "#/components/schemas/NewRelic", + "OPS_GENIE" : "#/components/schemas/OpsGenie", + "PAGER_DUTY" : "#/components/schemas/PagerDuty", + "PROMETHEUS" : "#/components/schemas/Prometheus", + "SLACK" : "#/components/schemas/Slack", + "VICTOR_OPS" : "#/components/schemas/VictorOps", + "WEBHOOK" : "#/components/schemas/Webhook" + }, + "propertyName" : "type" + }, "properties" : { - "enabled" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether backups are performed for this USS instance. Backup uses [TODO](TODO) for USS instances.", - "readOnly" : true + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "type" : { + "type" : "string", + "description" : "Integration type", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" } }, - "readOnly" : true, - "title" : "USS backup configuration" + "title" : "Third-Party Integration" }, - "USSBackupSnapshot20250101" : { + "TimeMetricAlertView" : { "type" : "object", - "description" : "Details for one snapshot of a USS instance.", "properties" : { - "expiration" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "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.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "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.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "readOnly" : true + }, + "created" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "finishTime" : { + "currentValue" : { + "$ref" : "#/components/schemas/TimeMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "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.", + "example" : "cloud-test.mongodb.com:27017", "readOnly" : true }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, "links" : { "type" : "array", "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", @@ -51317,116 +52639,76 @@ }, "readOnly" : true }, - "mongoDBVersion" : { + "metricName" : { "type" : "string", - "description" : "MongoDB host version that the snapshot runs.", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", "readOnly" : true }, - "scheduledTime" : { + "orgId" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud will take the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "startTime" : { + "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.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when MongoDB Cloud began taking the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "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\"`.", "readOnly" : true }, "status" : { "type" : "string", - "description" : "Phase of the workflow for this snapshot at the time this resource made this request.", - "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true } }, - "title" : "USS Backup Snapshot" + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] }, - "USSBackupSnapshotDownloadCreate20250101" : { + "TimeMetricEventView" : { "type" : "object", - "description" : "Details for one backup snapshot download of a USS instance.", "properties" : { - "_snapshotId" : { + "apiKeyId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to download.", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", - "writeOnly" : true - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - } - }, - "required" : [ "_snapshotId" ], - "title" : "USS Backup Snapshot Download Create" - }, - "USSConnectionStrings20250101" : { - "type" : "object", - "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", - "externalDocs" : { - "description" : "Connection string URI format.", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, - "properties" : { - "standard" : { - "type" : "string", - "description" : "Public connection string that you can use to connect to this cluster. This connection string uses the mongodb:// protocol.", - "externalDocs" : { - "description" : "Connection String URI Format", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, - "readOnly" : true - }, - "standardSrv" : { - "type" : "string", - "description" : "Public connection string that you can use to connect to this USS instance. This connection string uses the `mongodb+srv://` protocol.", - "externalDocs" : { - "description" : "Connection String URI Format", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, "readOnly" : true - } - }, - "readOnly" : true, - "title" : "USS Instance Connection Strings" - }, - "USSInstanceDescription20250101" : { - "type" : "object", - "description" : "Group of settings that configure a MongoDB USS instance.", - "properties" : { - "backupSettings" : { - "$ref" : "#/components/schemas/USSBackupSettings20250101" }, - "clusterType" : { + "created" : { "type" : "string", - "description" : "USS instance topology.", - "enum" : [ "REPLICASET", "LOADBALANCED" ], + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "connectionStrings" : { - "$ref" : "#/components/schemas/USSConnectionStrings20250101" + "currentValue" : { + "$ref" : "#/components/schemas/TimeMetricValueView" }, - "createDate" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created this instance. This parameter expresses its value in ISO 8601 format in UTC.", - "readOnly" : true + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" }, "groupId" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the project.", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -51435,13 +52717,19 @@ }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the instance.", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, "links" : { "type" : "array", "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", @@ -51454,167 +52742,314 @@ }, "readOnly" : true }, - "mongoDBVersion" : { + "metricName" : { "type" : "string", - "description" : "Version of MongoDB that the instance runs.", - "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", "readOnly" : true }, - "name" : { + "orgId" : { "type" : "string", - "description" : "Human-readable label that identifies the instance.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "providerSettings" : { - "$ref" : "#/components/schemas/USSProviderSettings20250101" + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true }, - "stateName" : { + "publicKey" : { "type" : "string", - "description" : "Human-readable label that indicates the current operating condition of this instance.", - "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true }, - "tags" : { - "type" : "array", - "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.", - "externalDocs" : { - "description" : "Resource Tags", - "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" - }, - "items" : { - "$ref" : "#/components/schemas/ResourceTag" - } + "raw" : { + "$ref" : "#/components/schemas/raw" }, - "terminationProtectionEnabled" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true }, - "versionReleaseSystem" : { + "replicaSetName" : { "type" : "string", - "default" : "LTS", - "description" : "Method by which the cluster maintains the MongoDB versions.", - "enum" : [ "LTS" ], + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true } }, - "required" : [ "providerSettings" ], - "title" : "USS Instance Description" + "required" : [ "created", "eventTypeName", "id" ] }, - "USSInstanceDescriptionCreate20250101" : { + "TimeMetricThresholdView" : { "type" : "object", - "description" : "Settings that you can specify when you create a USS instance.", "properties" : { - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." }, - "name" : { + "mode" : { "type" : "string", - "description" : "Human-readable label that identifies the instance.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "writeOnly" : true + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] }, - "providerSettings" : { - "$ref" : "#/components/schemas/USSProviderSettingsCreate20250101" + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, - "tags" : { - "type" : "array", - "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.", - "externalDocs" : { - "description" : "Resource Tags", - "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" - }, - "items" : { - "$ref" : "#/components/schemas/ResourceTag" - } + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." }, - "terminationProtectionEnabled" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" } }, - "required" : [ "name", "providerSettings" ], - "title" : "USS Instance Description Create" + "required" : [ "metricName" ] + }, + "TimeMetricUnits" : { + "type" : "string", + "default" : "HOURS", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "NANOSECONDS", "MILLISECONDS", "MILLION_MINUTES", "SECONDS", "MINUTES", "HOURS", "DAYS" ], + "title" : "Time Metric Units" }, - "USSProviderSettings20250101" : { + "TimeMetricValueView" : { "type" : "object", - "description" : "Group of cloud provider settings that configure the provisioned MongoDB USS instance.", + "description" : "Measurement of the **metricName** recorded at the time of the event.", "properties" : { - "backingProviderName" : { - "type" : "string", - "description" : "Cloud service provider on which MongoDB Cloud provisioned the USS instance.", - "enum" : [ "AWS", "AZURE", "GCP" ], - "readOnly" : true - }, - "diskSizeGB" : { + "number" : { "type" : "number", "format" : "double", - "description" : "Storage capacity available to the USS instance expressed in gigabytes.", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", "readOnly" : true }, - "providerName" : { + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "readOnly" : true, + "title" : "Time Metric Value" + }, + "TokenFilterEnglishPossessive" : { + "type" : "object", + "description" : "Filter that removes possessives (trailing 's) from words.", + "properties" : { + "type" : { "type" : "string", - "default" : "USS", - "description" : "Human-readable label that identifies the cloud service provider.", - "enum" : [ "USS" ], - "readOnly" : true - }, - "regionName" : { + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "englishPossessive" ] + } + }, + "required" : [ "type" ], + "title" : "englishPossessive" + }, + "TokenFilterFlattenGraph" : { + "type" : "object", + "description" : "Filter that transforms a token filter graph, such as the token filter graph that the wordDelimiterGraph token filter produces, into a flat form suitable for indexing.", + "properties" : { + "type" : { "type" : "string", - "description" : "Human-readable label that identifies the geographic location of your MongoDB USS 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/).", - "readOnly" : true + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "flattenGraph" ] } }, - "readOnly" : true, - "title" : "Cloud Service Provider Settings for a USS Instance" + "required" : [ "type" ], + "title" : "flattenGraph" }, - "USSProviderSettingsCreate20250101" : { + "TokenFilterPorterStemming" : { "type" : "object", - "description" : "Group of cloud provider settings that configure the provisioned MongoDB USS instance.", + "description" : "Filter that uses the porter stemming algorithm to remove the common morphological and inflectional suffixes from words in English. It expects lowercase text and doesn't work as expected for uppercase text.", "properties" : { - "backingProviderName" : { + "type" : { "type" : "string", - "description" : "Cloud service provider on which MongoDB Cloud provisioned the serverless instance.", - "enum" : [ "AWS", "AZURE", "GCP" ], - "writeOnly" : true + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "porterStemming" ] + } + }, + "required" : [ "type" ], + "title" : "porterStemming" + }, + "TokenFilterSpanishPluralStemming" : { + "type" : "object", + "description" : "Filter that stems Spanish plural words. It expects lowercase text.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "spanishPluralStemming" ] + } + }, + "required" : [ "type" ], + "title" : "spanishPluralStemming" + }, + "TokenFilterStempel" : { + "type" : "object", + "description" : "Filter that uses Lucene's default Polish stemmer table to stem words in the Polish language. It expects lowercase text.", + "externalDocs" : { + "description" : "Default Polish stemmer table", + "url" : "https://lucene.apache.org/core/9_2_0/analysis/stempel/org/apache/lucene/analysis/pl/PolishAnalyzer.html#DEFAULT_STEMMER_FILE" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "stempel" ] + } + }, + "required" : [ "type" ], + "title" : "stempel" + }, + "TokenFilterWordDelimiterGraph" : { + "type" : "object", + "description" : "Filter that splits tokens into sub-tokens based on configured rules.", + "properties" : { + "delimiterOptions" : { + "type" : "object", + "description" : "Object that contains the rules that determine how to split words into sub-words.", + "properties" : { + "concatenateAll" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to concatenate runs." + }, + "concatenateNumbers" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to concatenate runs of sub-numbers." + }, + "concatenateWords" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to concatenate runs of sub-words." + }, + "generateNumberParts" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on sub-numbers. For example, if `true`, this option splits `100-2` into `100` and `2`." + }, + "generateWordParts" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on sub-words." + }, + "ignoreKeywords" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to skip tokens with the `keyword` attribute set to `true`" + }, + "preserveOriginal" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to generate tokens of the original words." + }, + "splitOnCaseChange" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on letter-case transitions." + }, + "splitOnNumerics" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on letter-number transitions." + }, + "stemEnglishPossessive" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to remove trailing possessives from each sub-word." + } + } }, - "diskSizeGB" : { - "type" : "number", - "format" : "double", - "description" : "Storage capacity available to the USS instance expressed in gigabytes.", - "readOnly" : true + "protectedWords" : { + "type" : "object", + "description" : "Object that contains options for protected words.", + "properties" : { + "ignoreCase" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to ignore letter case sensitivity for protected words." + }, + "words" : { + "type" : "array", + "description" : "List that contains the tokens to protect from delimination.", + "items" : { + "type" : "string" + } + } + }, + "required" : [ "words" ] }, - "providerName" : { + "type" : { "type" : "string", - "default" : "USS", - "description" : "Human-readable label that identifies the cloud service provider.", - "enum" : [ "USS" ], - "readOnly" : true + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "wordDelimiterGraph" ] + } + }, + "required" : [ "type" ], + "title" : "wordDelimiterGraph" + }, + "TokenFilterkStemming" : { + "type" : "object", + "description" : "Filter that combines algorithmic stemming with a built-in dictionary for the English language to stem words.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "kStemming" ] + } + }, + "required" : [ "type" ], + "title" : "kStemming" + }, + "TriggerIngestionPipelineRequest" : { + "type" : "object", + "properties" : { + "datasetRetentionPolicy" : { + "$ref" : "#/components/schemas/DatasetRetentionPolicy" }, - "regionName" : { + "snapshotId" : { "type" : "string", - "description" : "Human-readable label that identifies the geographic location of your MongoDB USS 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/).", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "writeOnly" : true } }, - "required" : [ "backingProviderName", "regionName" ], - "title" : "Cloud Service Provider Settings for a USS Instance", - "writeOnly" : true + "required" : [ "snapshotId" ] }, "UpdateAtlasOrganizationApiKey" : { "type" : "object", @@ -52252,7 +53687,7 @@ "description" : "Human-readable label that identifies the cluster or MongoDB Atlas Data Lake that this database user can access.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, "type" : { "type" : "string", @@ -52308,6 +53743,32 @@ "required" : [ "match" ], "title" : "User to Distinguished Name Mapping" }, + "VPCPeeringActionChallenge" : { + "type" : "object", + "description" : "Container for elements used to challenge the user before taking certain actions on VPC Peering connections.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "requesterAccountId" : { + "type" : "string", + "description" : "The AWS requester account ID." + }, + "requesterVpcId" : { + "type" : "string", + "description" : "The AWS requester VPC ID." + } + } + }, "VectorSearchHostStatusDetail" : { "type" : "object", "properties" : { diff --git a/tools/cli/test/data/split/dev/openapi-v2-2024-05-30.yaml b/tools/cli/test/data/split/dev/openapi-v2-2024-05-30.yaml index e7d6021cd4..b6cbef9fc7 100644 --- a/tools/cli/test/data/split/dev/openapi-v2-2024-05-30.yaml +++ b/tools/cli/test/data/split/dev/openapi-v2-2024-05-30.yaml @@ -13,13 +13,15 @@ info: ``` To learn more, see [Get Started with the Atlas Administration API](https://www.mongodb.com/docs/atlas/configure-api-access/). For support, see [MongoDB Support](https://www.mongodb.com/support/get-started). + + You can also explore the various endpoints available through the Atlas Administration API in MongoDB's [Postman workspace](https://www.postman.com/mongodb-devrel/workspace/mongodb-atlas-administration-apis/). license: name: CC BY-NC-SA 3.0 US url: https://creativecommons.org/licenses/by-nc-sa/3.0/us/ termsOfService: https://www.mongodb.com/mongodb-management-service-terms-and-conditions title: MongoDB Atlas Administration API version: "2.0" - x-xgen-sha: 09d9d18db2111c955a8e01702a27ca2763417782 + x-xgen-sha: e6ba3136dbd0be2a81dd4ed21b9e6c470edd4420 servers: - url: https://cloud.mongodb.com tags: @@ -82,8 +84,12 @@ tags: \ resource requires your project ID. Changes to federated database instance configurations\ \ can affect costs." name: Data Federation -- description: "Returns, adds, edits, and removes Atlas Data Lake Pipelines and associated\ +- description: "Returns, edits, and removes Atlas Data Lake Pipelines and associated\ \ runs." + externalDocs: + description: Data Lake Pipelines are deprecated. Please see Data Lake Deprecation + Guide. + url: https://dochub.mongodb.org/core/data-lake-deprecation name: Data Lake Pipelines - description: "Returns, adds, edits, and removes database users." name: Database Users @@ -158,6 +164,8 @@ tags: - description: "You can continually push logs from mongod, mongos, and audit logs\ \ to an AWS S3 bucket. Atlas exports logs every 5 minutes." name: Push-Based Log Export +- description: Configure and manage Atlas Resource Policies within your organization. + name: Resource Policies - description: Creates one index to a database deployment in a rolling manner. You can't create a rolling index on an `M0` free cluster or `M2/M5` shared cluster. name: Rolling Index @@ -173,6 +181,13 @@ tags: description: Set Up a Private Endpoint for a Serverless Instance Tutorial url: https://dochub.mongodb.org/core/serverless-private-endpoint name: Serverless Private Endpoints +- description: Endpoints for managing Service Accounts and secrets. Service Accounts + are used for programmatic access to the Atlas Admin API through the OAuth 2.0 + Client Credentials flow. This feature is available as a Preview feature. + externalDocs: + description: Get Started with the Atlas Administration API + url: https://www.mongodb.com/docs/atlas/configure-api-access/ + name: Service Accounts - description: Returns and adds restore jobs for shared-tier database deployments. name: Shared-Tier Restore Jobs - description: Returns and requests to download shared-tier database deployment snapshots. @@ -2347,9 +2362,9 @@ paths: - AWS Clusters DNS /api/atlas/v2/groups/{groupId}/backup/exportBuckets: get: - description: "Returns all AWS S3 buckets and Azure Blob Storage Containers associated\ - \ with the specified Project. To use this resource, the requesting API Key\ - \ must have the Project Read Only role. Deprecated versions: v2-{2023-01-01}" + description: "Returns all Export Buckets associated with the specified Project.\ + \ To use this resource, the requesting API Key must have the Project Read\ + \ Only role. Deprecated versions: v2-{2023-01-01}" operationId: listExportBuckets parameters: - $ref: "#/components/parameters/envelope" @@ -2372,15 +2387,15 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Return All AWS S3 Buckets and Azure Blob Storage Containers Used for - Cloud Backup Snapshot Exports + summary: Return All Snapshot Export Buckets tags: - Cloud Backups post: - description: "Grants MongoDB Cloud access to the specified AWS S3 Bucket or\ - \ Azure Blob Storage Container. This enables this Export Bucket to receive\ - \ Atlas Cloud Backup Snapshots. To use this resource, the requesting API Key\ - \ must have the Project Owner role. Deprecated versions: v2-{2023-01-01}" + description: "Creates a Snapshot Export Bucket for an AWS S3 Bucket or Azure\ + \ Blob Storage Container. Once created, an snapshots can be exported to the\ + \ Export Bucket and its referenced AWS S3 Bucket or Azure Blob Storage Container.\ + \ To use this resource, the requesting API Key must have the Project Owner\ + \ role. Deprecated versions: v2-{2023-01-01}" operationId: createExportBucket parameters: - $ref: "#/components/parameters/envelope" @@ -2407,8 +2422,8 @@ paths: schema: $ref: "#/components/schemas/DiskBackupSnapshotExportBucket" x-xgen-version: 2024-05-30 - description: Grants MongoDB Cloud access to the specified AWS S3 Bucket or - Azure Blob Storage Container. + description: Specifies the role and AWS S3 Bucket or Azure Blob Storage Container + that the Export Bucket should reference. required: true responses: "200": @@ -2451,24 +2466,21 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Grant Access to AWS S3 Bucket or Azure Blob Storage Container for Cloud - Backup Snapshot Exports + summary: Create One Snapshot Export Bucket tags: - Cloud Backups /api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}: delete: - description: "Revoke MongoDB Cloud access to the specified AWS S3 Bucket or\ - \ Azure Blob Storage Container. This prevents this Export Bucket from receiving\ - \ Atlas Cloud Backup Snapshots. 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 API Key must have the Project Owner\ - \ role." + 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 API Key must have the Project\ + \ Owner role." operationId: deleteExportBucket parameters: - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/groupId" - - description: Unique string that identifies the AWS S3 Bucket or Azure Blob - Storage Container to which you export your Snapshots. + - description: Unique 24-hexadecimal character string that identifies the Export + Bucket. in: path name: exportBucketId required: true @@ -2496,14 +2508,13 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Revoke Access to AWS S3 Bucket or Azure Blob Storage Container for - Cloud Backup Snapshot Exports + summary: Delete One Snapshot Export Bucket tags: - Cloud Backups get: - description: "Returns one AWS S3 Bucket or Azure Blob Storage Container associated\ - \ with the specified Project. To use this resource, the requesting API Key\ - \ must have the Project Read Only role. Deprecated versions: v2-{2023-01-01}" + description: "Returns one Export Bucket associated with the specified Project.\ + \ To use this resource, the requesting API Key must have the Project Read\ + \ Only role. Deprecated versions: v2-{2023-01-01}" operationId: getExportBucket parameters: - $ref: "#/components/parameters/envelope" @@ -2558,8 +2569,7 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Return One AWS S3 Bucket or Azure Blob Storage Container Used for Cloud - Backup Snapshot Exports + summary: Return One Snapshot Export Bucket tags: - Cloud Backups /api/atlas/v2/groups/{groupId}/backupCompliancePolicy: @@ -2680,7 +2690,7 @@ paths: content: application/vnd.atlas.2023-01-01+json: schema: - $ref: "#/components/schemas/CloudProviderAccessRole" + $ref: "#/components/schemas/CloudProviderAccessRoleRequest" description: Creates one role for the specified cloud provider. required: true responses: @@ -2719,6 +2729,8 @@ paths: type: string enum: - AWS + - AZURE + - GCP - description: Unique 24-hexadecimal digit string that identifies the role. in: path name: roleId @@ -2785,7 +2797,8 @@ paths: description: "Grants access to the specified project for the specified access\ \ role. To use this resource, the requesting API Key must have the Project\ \ Owner role. This API endpoint is one step in a procedure to create unified\ - \ access for MongoDB Cloud services." + \ 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/ @@ -2807,7 +2820,7 @@ paths: content: application/vnd.atlas.2023-01-01+json: schema: - $ref: "#/components/schemas/CloudProviderAccessRole" + $ref: "#/components/schemas/CloudProviderAccessRoleRequestUpdate" description: Grants access to the specified project for the specified access role. required: true @@ -3066,7 +3079,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster. in: query @@ -3114,7 +3127,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -3162,7 +3175,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-02-01+json: @@ -3196,7 +3209,7 @@ paths: x-sunset: 2026-03-01 /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports: get: - description: "Returns all Cloud Backup snapshot export jobs associated with\ + description: "Returns all Cloud Backup Snapshot Export Jobs associated with\ \ the specified Atlas cluster. To use this resource, the requesting API Key\ \ must have the Project Atlas Admin role." operationId: listBackupExportJobs @@ -3215,7 +3228,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -3230,11 +3243,11 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Return All Cloud Backup Snapshot Export Jobs + summary: Return All Snapshot Export Jobs tags: - Cloud Backups post: - description: "Exports one backup snapshot for dedicated Atlas cluster using\ + description: "Exports one backup Snapshot for dedicated Atlas cluster using\ \ Cloud Backups to an Export Bucket. To use this resource, the requesting\ \ API Key must have the Project Atlas Admin role." operationId: createBackupExportJob @@ -3249,7 +3262,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -3277,12 +3290,12 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Create One Cloud Backup Snapshot Export Job + summary: Create One Snapshot Export Job tags: - Cloud Backups /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}: get: - description: "Returns one Cloud Backup snapshot export job associated with the\ + description: "Returns one Cloud Backup Snapshot Export Job associated with the\ \ specified Atlas cluster. To use this resource, the requesting API Key must\ \ have the Project Atlas Admin role." operationId: getBackupExportJob @@ -3297,13 +3310,18 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - - description: Unique string that identifies the export job to return. + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + - description: Unique 24-hexadecimal character string that identifies the Export + Job. in: path name: exportId required: true schema: type: string + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" responses: "200": content: @@ -3318,7 +3336,7 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Return One Cloud Backup Snapshot Export Job + summary: Return One Snapshot Export Job tags: - Cloud Backups /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs: @@ -3343,7 +3361,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -3379,7 +3397,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -3428,7 +3446,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the restore job to remove. in: path @@ -3476,7 +3494,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the restore job to return. in: path @@ -3523,7 +3541,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -3543,7 +3561,7 @@ paths: summary: Remove All Cloud Backup Schedules tags: - Cloud Backups - x-sunset: 2025-08-05 + x-sunset: 2026-05-30 get: deprecated: true description: "Returns the cloud backup schedule for the specified cluster within\ @@ -3563,7 +3581,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -3581,7 +3599,7 @@ paths: summary: Return One Cloud Backup Schedule tags: - Cloud Backups - x-sunset: 2025-08-05 + x-sunset: 2026-05-30 patch: deprecated: true description: "Updates the cloud backup schedule for one cluster within the specified\ @@ -3601,7 +3619,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -3631,7 +3649,7 @@ paths: summary: Update Cloud Backup Schedule for One Cluster tags: - Cloud Backups - x-sunset: 2025-08-05 + x-sunset: 2026-05-30 /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots: get: description: "Returns all snapshots of one cluster from the specified project.\ @@ -3653,7 +3671,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -3691,7 +3709,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -3736,7 +3754,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -3781,7 +3799,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -3829,7 +3847,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -3866,7 +3884,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -3912,7 +3930,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -3958,7 +3976,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -4013,7 +4031,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/groupId" - $ref: "#/components/parameters/pretty" @@ -4067,7 +4085,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/groupId" - $ref: "#/components/parameters/pretty" @@ -4116,7 +4134,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/groupId" - $ref: "#/components/parameters/pretty" @@ -4153,7 +4171,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/groupId" - $ref: "#/components/parameters/pretty" @@ -4204,7 +4222,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -4242,7 +4260,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -4295,7 +4313,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -4342,7 +4360,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -4381,7 +4399,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -4419,7 +4437,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-11-15+json: @@ -4473,7 +4491,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-11-15+json: @@ -4527,7 +4545,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-11-15+json: @@ -4582,7 +4600,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -4636,7 +4654,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Name of the collection that contains one or more Atlas Search indexes. in: path @@ -4694,7 +4712,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: "Unique 24-hexadecimal digit string that identifies the Atlas\ \ Search index. Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/)\ \ endpoint to find the IDs of all Atlas Search indexes." @@ -4749,7 +4767,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - 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/)\ @@ -4803,7 +4821,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - 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/)\ @@ -4868,7 +4886,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -4912,7 +4930,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -4954,7 +4972,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-02-01+json: @@ -5006,7 +5024,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - $ref: "#/components/parameters/groupId" - description: Human-readable label that identifies the database that contains the collection. @@ -5063,7 +5081,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-02-01+json: @@ -5118,7 +5136,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -5233,7 +5251,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5272,7 +5290,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -5350,7 +5368,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Flag that indicates whether to download logs for queries against your online archive only or both your online archive and cluster. in: query @@ -5417,7 +5435,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "204": content: @@ -5468,7 +5486,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5521,7 +5539,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -5572,7 +5590,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5613,7 +5631,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5654,7 +5672,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -5707,7 +5725,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5753,7 +5771,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -5806,7 +5824,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5859,7 +5877,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5909,7 +5927,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -5957,7 +5975,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the restore job. in: path @@ -6003,7 +6021,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "204": content: @@ -6042,7 +6060,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -6079,7 +6097,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2024-05-30+json: @@ -6123,7 +6141,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2024-05-30+json: @@ -6175,7 +6193,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -6226,7 +6244,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2024-05-30+json: @@ -6278,7 +6296,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Name of the collection that contains one or more Atlas Search indexes. in: path @@ -6342,7 +6360,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Name of the collection that contains one or more Atlas Search indexes. in: path @@ -6405,7 +6423,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Name of the collection that contains one or more Atlas Search indexes. in: path @@ -6468,7 +6486,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Name of the collection that contains one or more Atlas Search indexes. in: path @@ -6539,7 +6557,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: "Unique 24-hexadecimal digit string that identifies the Atlas\ \ Search index. Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/)\ \ endpoint to find the IDs of all Atlas Search indexes." @@ -6592,7 +6610,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - 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/)\ @@ -6652,7 +6670,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - 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/)\ @@ -6714,7 +6732,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -6752,7 +6770,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -6806,7 +6824,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: "Human-readable label that specifies whether to return only completed,\ \ incomplete, or all snapshots. By default, MongoDB Cloud only returns completed\ \ snapshots." @@ -6861,7 +6879,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -6915,7 +6933,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -6968,7 +6986,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -7023,7 +7041,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -7057,7 +7075,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Human-readable label that identifies the cluster topology to retrieve metrics for. in: path @@ -7106,7 +7124,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Human-readable label that identifies the cluster topology to retrieve metrics for. in: path @@ -7199,7 +7217,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2024-05-30+json: @@ -7247,7 +7265,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "204": content: @@ -7317,18 +7335,22 @@ paths: externalDocs: description: Set up Database Auditing url: https://docs.atlas.mongodb.com/database-auditing/ - - description: Date and time when the period specifies the inclusive ending - point for the range of log messages to retrieve. This parameter expresses - its value in the number of seconds that have elapsed since the UNIX epoch. + - description: "Specifies the date and time for the ending point of the range\ + \ of log messages to retrieve, in the number of seconds that have elapsed\ + \ since the UNIX epoch. This value will default to 24 hours after the start\ + \ date. If the start date is also unspecified, the value will default to\ + \ the time of the request." in: query name: endDate schema: type: integer format: int64 minimum: 1199145600 - - description: Date and time when the period specifies the inclusive starting - point for the range of log messages to retrieve. This parameter expresses - its value in the number of seconds that have elapsed since the UNIX epoch. + - description: "Specifies the date and time for the starting point of the range\ + \ of log messages to retrieve, in the number of seconds that have elapsed\ + \ since the UNIX epoch. This value will default to 24 hours prior to the\ + \ end date. If the end date is also unspecified, the value will default\ + \ to 24 hours prior to the time of the request." in: query name: startDate schema: @@ -8794,7 +8816,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: "Date and time when to stop retrieving database history. If you\ \ specify **end**, you must also specify **start**. This parameter uses\ \ UNIX epoch time in milliseconds." @@ -9013,6 +9035,9 @@ paths: - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/pretty" - $ref: "#/components/parameters/groupId" + - $ref: "#/components/parameters/includeCount" + - $ref: "#/components/parameters/itemsPerPage" + - $ref: "#/components/parameters/pageNum" - description: Human-readable label that identifies the cloud provider for the private endpoints to return. in: path @@ -9110,14 +9135,6 @@ paths: maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" - requestBody: - content: - application/vnd.atlas.2023-01-01+json: - schema: - $ref: "#/components/schemas/EncryptionAtRestPrivateEndpointRequest" - description: Cloud provider of the private endpoints to delete and the list - of cloud provider regions in which to delete the private endpoints. - required: true responses: "204": content: @@ -9172,6 +9189,8 @@ paths: description: OK "403": $ref: "#/components/responses/forbidden" + "404": + $ref: "#/components/responses/notFound" "500": $ref: "#/components/responses/internalServerError" security: @@ -9203,7 +9222,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" style: form - description: |- Category of incident recorded at this moment in time. @@ -9830,7 +9849,7 @@ paths: summary: Return All Project Invitations tags: - Projects - x-sunset: 2024-10-04 + x-sunset: 2024-11-04 patch: deprecated: true description: "Updates the details of one pending invitation to the specified\ @@ -9871,7 +9890,7 @@ paths: summary: Update One Project Invitation tags: - Projects - x-sunset: 2024-10-04 + x-sunset: 2024-11-04 post: deprecated: true description: "Invites one MongoDB Cloud user to join the specified project.\ @@ -9907,7 +9926,7 @@ paths: summary: Invite One MongoDB Cloud User to Join One Project tags: - Projects - x-sunset: 2024-10-04 + x-sunset: 2024-11-04 /api/atlas/v2/groups/{groupId}/invites/{invitationId}: delete: deprecated: true @@ -9945,7 +9964,7 @@ paths: summary: Cancel One Project Invitation tags: - Projects - x-sunset: 2024-10-04 + x-sunset: 2024-11-04 get: deprecated: true description: "Returns the details of one pending invitation to the specified\ @@ -9984,7 +10003,7 @@ paths: summary: Return One Project Invitation tags: - Projects - x-sunset: 2024-10-04 + x-sunset: 2024-11-04 patch: deprecated: true description: "Updates the details of one pending invitation to the specified\ @@ -10034,7 +10053,7 @@ paths: summary: Update One Project Invitation by Invitation ID tags: - Projects - x-sunset: 2024-10-04 + x-sunset: 2024-11-04 /api/atlas/v2/groups/{groupId}/ipAddresses: get: description: "Returns all IP addresses for this project. To use this resource,\ @@ -10110,7 +10129,7 @@ paths: | Limit Name | Description | Default | API Override Limit | | --- | --- | --- | --- | - | atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 | + | atlas.project.deployment.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 | @@ -10122,6 +10141,7 @@ paths: | 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 | in: path name: limitName required: true @@ -10141,6 +10161,7 @@ paths: - 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" @@ -10175,7 +10196,7 @@ paths: | Limit Name | Description | Default | API Override Limit | | --- | --- | --- | --- | - | atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 | + | atlas.project.deployment.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 | @@ -10187,6 +10208,7 @@ paths: | 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 | in: path name: limitName required: true @@ -10206,6 +10228,7 @@ paths: - 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" @@ -10244,7 +10267,7 @@ paths: | Limit Name | Description | Default | API Override Limit | | --- | --- | --- | --- | - | atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 | + | atlas.project.deployment.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 | @@ -10256,6 +10279,7 @@ paths: | 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 | in: path name: limitName required: true @@ -10275,6 +10299,7 @@ paths: - 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" @@ -11047,6 +11072,7 @@ paths: - Network Peering /api/atlas/v2/groups/{groupId}/pipelines: get: + deprecated: true description: "Returns a list of Data Lake Pipelines. To use this resource, the\ \ requesting API Key must have the Project Read Only role." operationId: listPipelines @@ -11074,8 +11100,14 @@ paths: summary: Return All Data Lake Pipelines from One Project tags: - Data Lake Pipelines + x-sunset: 2025-09-09 post: + deprecated: true description: Creates one Data Lake Pipeline. + externalDocs: + description: Data Lake Pipelines are deprecated. Please see Data Lake Deprecation + Guide. + url: https://dochub.mongodb.org/core/data-lake-deprecation operationId: createPipeline parameters: - $ref: "#/components/parameters/envelope" @@ -11108,8 +11140,10 @@ paths: summary: Create One Data Lake Pipeline tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}: delete: + deprecated: true description: Removes one Data Lake Pipeline. operationId: deletePipeline parameters: @@ -11143,7 +11177,9 @@ paths: summary: Remove One Data Lake Pipeline tags: - Data Lake Pipelines + x-sunset: 2025-09-09 get: + deprecated: true description: "Returns the details of one Data Lake Pipeline within the specified\ \ project. To use this resource, the requesting API Key must have the Project\ \ Read Only role." @@ -11180,7 +11216,9 @@ paths: summary: Return One Data Lake Pipeline tags: - Data Lake Pipelines + x-sunset: 2025-09-09 patch: + deprecated: true description: Updates one Data Lake Pipeline. operationId: updatePipeline parameters: @@ -11225,8 +11263,10 @@ paths: summary: Update One Data Lake Pipeline tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules: get: + deprecated: true description: "Returns a list of backup schedule policy items that you can use\ \ as a Data Lake Pipeline source. To use this resource, the requesting API\ \ Key must have the Project Read Only role." @@ -11265,8 +11305,10 @@ paths: summary: Return Available Ingestion Schedules for One Data Lake Pipeline tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots: get: + deprecated: true description: "Returns a list of backup snapshots that you can use to trigger\ \ an on demand pipeline run. To use this resource, the requesting API Key\ \ must have the Project Read Only role." @@ -11316,8 +11358,10 @@ paths: summary: Return Available Backup Snapshots for One Data Lake Pipeline tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause: post: + deprecated: true description: "Pauses ingestion for a Data Lake Pipeline within the specified\ \ project. To use this resource, the requesting API Key must have the Project\ \ Read Only role." @@ -11354,8 +11398,10 @@ paths: summary: Pause One Data Lake Pipeline tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume: post: + deprecated: true description: "Resumes ingestion for a Data Lake Pipeline within the specified\ \ project. To use this resource, the requesting API Key must have the Project\ \ Read Only role." @@ -11392,8 +11438,10 @@ paths: summary: Resume One Data Lake Pipeline tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs: get: + deprecated: true description: "Returns a list of past Data Lake Pipeline runs. To use this resource,\ \ the requesting API Key must have the Project Read Only role." operationId: listPipelineRuns @@ -11440,8 +11488,10 @@ paths: summary: Return All Data Lake Pipeline Runs from One Project tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}: delete: + deprecated: true description: Deletes dataset that Atlas generated during the specified pipeline run. operationId: deletePipelineRunDataset @@ -11488,7 +11538,9 @@ paths: summary: Delete Pipeline Run Dataset tags: - Data Lake Pipelines + x-sunset: 2025-09-09 get: + deprecated: true description: "Returns the details of one Data Lake Pipeline run within the specified\ \ project. To use this resource, the requesting API Key must have the Project\ \ Read Only role." @@ -11536,8 +11588,10 @@ paths: summary: Return One Data Lake Pipeline Run tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger: post: + deprecated: true description: Triggers a Data Lake Pipeline ingestion of a specified snapshot. operationId: triggerSnapshotIngestion parameters: @@ -11579,6 +11633,7 @@ paths: summary: Trigger on demand snapshot ingestion tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService: post: description: "Creates one private endpoint service for the specified cloud service\ @@ -11710,7 +11765,7 @@ paths: schema: type: string maxLength: 64 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -11752,7 +11807,7 @@ paths: schema: type: string maxLength: 64 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -11796,7 +11851,7 @@ paths: schema: type: string maxLength: 64 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be removed. in: path @@ -11842,7 +11897,7 @@ paths: schema: type: string maxLength: 64 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the tenant endpoint. in: path @@ -11887,7 +11942,7 @@ paths: schema: type: string maxLength: 64 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be updated. in: path @@ -12909,6 +12964,8 @@ paths: - 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 maxItems: 10 minItems: 1 uniqueItems: true @@ -12993,6 +13050,8 @@ paths: - CACHE_BYTES_WRITTEN_FROM - CACHE_DIRTY_BYTES - CACHE_USED_BYTES + - CACHE_FILL_RATIO + - DIRTY_FILL_RATIO - COMPUTED_MEMORY - CONNECTIONS - CURSORS_TOTAL_OPEN @@ -13074,6 +13133,7 @@ paths: - 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 @@ -13616,7 +13676,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "201": content: @@ -13761,7 +13821,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -13799,7 +13859,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -13849,7 +13909,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the restore job to return. in: path @@ -13900,7 +13960,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -13937,7 +13997,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -13982,7 +14042,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/pretty" responses: @@ -14015,7 +14075,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Value that we want to set for the Serverless Auto Indexing toggle. in: query name: enable @@ -14059,15 +14119,15 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: - "204": + "202": content: application/vnd.atlas.2023-01-01+json: schema: - $ref: "#/components/schemas/NoBody" + $ref: "#/components/schemas/RequestAccepted" x-xgen-version: 2023-01-01 - description: This endpoint does not return a response body. + description: Accepted "400": $ref: "#/components/responses/badRequest" "404": @@ -14098,7 +14158,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -14136,7 +14196,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -14163,222 +14223,6 @@ paths: summary: Update One Serverless Instance in One Project tags: - Serverless Instances - /api/atlas/v2/groups/{groupId}/serviceAccounts: - get: - description: Returns list of Service Accounts for a project with service account - details. - operationId: listProjectServiceAccounts - parameters: - - $ref: "#/components/parameters/groupId" - - $ref: "#/components/parameters/itemsPerPage" - - $ref: "#/components/parameters/pageNum" - - $ref: "#/components/parameters/pretty" - - $ref: "#/components/parameters/envelope" - responses: - "200": - content: - application/vnd.atlas.2023-10-01+json: - schema: - $ref: "#/components/schemas/PaginatedGroupServiceAccounts" - x-xgen-version: 2023-10-01 - description: OK - "401": - $ref: "#/components/responses/unauthorized" - "403": - $ref: "#/components/responses/forbidden" - "500": - $ref: "#/components/responses/internalServerError" - security: - - DigestAuth: [] - summary: Return All project Service Accounts - tags: - - Groups - post: - description: Creates and assigns the specified Service Account to the specified - Project. - operationId: createProjectServiceAccount - parameters: - - $ref: "#/components/parameters/groupId" - - $ref: "#/components/parameters/envelope" - - $ref: "#/components/parameters/pretty" - requestBody: - content: - application/vnd.atlas.2023-10-01+json: - schema: - $ref: "#/components/schemas/GroupServiceAccountRequest" - x-xgen-version: 2023-10-01 - description: Details to create service account and add to the specified project. - required: true - responses: - "201": - content: - application/vnd.atlas.2023-10-01+json: - schema: - $ref: "#/components/schemas/GroupServiceAccount" - x-xgen-version: 2023-10-01 - description: Created - "400": - $ref: "#/components/responses/badRequest" - "401": - $ref: "#/components/responses/unauthorized" - "500": - $ref: "#/components/responses/internalServerError" - security: - - DigestAuth: [] - summary: Create and Assign one Service Account to one project - tags: - - Groups - /api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}: - delete: - description: Removes one Service Account from the specified project. - operationId: deleteProjectServiceAccount - parameters: - - description: Id of the service account. - in: path - name: serviceAccountId - required: true - schema: - type: string - - $ref: "#/components/parameters/groupId" - - $ref: "#/components/parameters/envelope" - - $ref: "#/components/parameters/pretty" - responses: - "204": - content: - application/vnd.atlas.2023-10-01+json: - schema: - $ref: "#/components/schemas/NoBody" - x-xgen-version: 2023-10-01 - description: This endpoint does not return a response body. - x-xgen-version: 2023-10-01 - "401": - $ref: "#/components/responses/unauthorized" - "404": - $ref: "#/components/responses/notFound" - "500": - $ref: "#/components/responses/internalServerError" - security: - - DigestAuth: [] - summary: Unassign One Service Account from One Project. - tags: - - Groups - get: - description: Get project Service Account Details. - operationId: getProjectServiceAccount - parameters: - - $ref: "#/components/parameters/groupId" - - description: Id of the service account. - in: path - name: serviceAccountId - required: true - schema: - type: string - - $ref: "#/components/parameters/envelope" - - $ref: "#/components/parameters/pretty" - responses: - "200": - content: - application/vnd.atlas.2023-10-01+json: - schema: - $ref: "#/components/schemas/GroupServiceAccount" - x-xgen-version: 2023-10-01 - description: OK - "401": - $ref: "#/components/responses/unauthorized" - "404": - $ref: "#/components/responses/notFound" - "500": - $ref: "#/components/responses/internalServerError" - security: - - DigestAuth: [] - summary: Service Account Fetching - tags: - - Groups - patch: - description: Update Service Account in Project. - operationId: updateProjectServiceAccount - parameters: - - description: Id of the service account. - in: path - name: serviceAccountId - required: true - schema: - type: string - - $ref: "#/components/parameters/groupId" - - $ref: "#/components/parameters/envelope" - - $ref: "#/components/parameters/pretty" - requestBody: - content: - application/vnd.atlas.2023-10-01+json: - schema: - $ref: "#/components/schemas/GroupServiceAccountUpdateRequest" - description: Details to update service account in the specified Project. - required: true - responses: - "200": - content: - application/vnd.atlas.2023-10-01+json: - schema: - $ref: "#/components/schemas/GroupServiceAccount" - x-xgen-version: 2023-10-01 - description: OK - "400": - $ref: "#/components/responses/badRequest" - "401": - $ref: "#/components/responses/unauthorized" - "404": - $ref: "#/components/responses/notFound" - "500": - $ref: "#/components/responses/internalServerError" - security: - - DigestAuth: [] - summary: Service Account Update in Project - tags: - - Groups - post: - description: Assigns the specified organization Service Account to the specified - project. - operationId: addProjectServiceAccount - parameters: - - description: Id of the service account. - in: path - name: serviceAccountId - required: true - schema: - type: string - - $ref: "#/components/parameters/groupId" - - $ref: "#/components/parameters/envelope" - - $ref: "#/components/parameters/pretty" - requestBody: - content: - application/vnd.atlas.2023-10-01+json: - schema: - type: array - items: - $ref: "#/components/schemas/GroupServiceAccountRoleAssignment" - x-xgen-version: 2023-10-01 - description: Service Account Roles to be assigned to the specified project. - required: true - responses: - "204": - content: - application/vnd.atlas.2023-10-01+json: - schema: - $ref: "#/components/schemas/NoBody" - x-xgen-version: 2023-10-01 - description: This endpoint does not return a response body. - x-xgen-version: 2023-10-01 - "401": - $ref: "#/components/responses/unauthorized" - "404": - $ref: "#/components/responses/notFound" - "500": - $ref: "#/components/responses/internalServerError" - security: - - DigestAuth: [] - summary: Assign One Service Account to One Project - tags: - - Groups /api/atlas/v2/groups/{groupId}/settings: get: description: "Returns details about the specified project's settings. To use\ @@ -14515,19 +14359,305 @@ paths: x-xgen-changelog: "2023-09-11": "The MongoDB Atlas Streams Processing API is now exposed as\ \ part of private preview, but is subject to change until GA." - /api/atlas/v2/groups/{groupId}/streams/{tenantName}: + /api/atlas/v2/groups/{groupId}/streams/privateLinkConnections: + get: + description: "Returns all Private Link connections for the specified project.To\ + \ use this resource, the requesting API Key must have the Project Data Access\ + \ roles, Project Owner role or Project Stream Processing Owner role." + operationId: listPrivateLinkConnections + parameters: + - $ref: "#/components/parameters/groupId" + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/itemsPerPage" + - $ref: "#/components/parameters/pageNum" + - $ref: "#/components/parameters/pretty" + responses: + "200": + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/PaginatedApiStreamsPrivateLinkView" + x-xgen-version: 2023-02-01 + description: OK + "401": + $ref: "#/components/responses/unauthorized" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Return All Private Link + tags: + - Streams + x-xgen-changelog: + "2024-10-02": "The MongoDB Atlas Streams Processing Private Link API is now\ + \ exposed as part of private preview, but is subject to change until GA." + post: + description: "Creates one Private Link in the specified project. To use this\ + \ resource, the requesting API Key must have the Project Owner or Project\ + \ Stream Processing Owner role." + operationId: createPrivateLinkConnection + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/pretty" + - $ref: "#/components/parameters/groupId" + requestBody: + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/StreamsPrivateLinkConnection" + description: Details to create one Private Link connection for a project. + project. + required: true + responses: + "200": + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/StreamsPrivateLinkConnection" + x-xgen-version: 2023-02-01 + description: OK + "400": + $ref: "#/components/responses/badRequest" + "401": + $ref: "#/components/responses/unauthorized" + "409": + $ref: "#/components/responses/unauthorized" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Create One Private Link connection + tags: + - Streams + x-xgen-changelog: + "2024-10-02": "The MongoDB Atlas Streams Processing Private Link API is now\ + \ exposed as part of private preview, but is subject to change until GA." + /api/atlas/v2/groups/{groupId}/streams/privateLinkConnections/{connectionId}: delete: - description: "Delete one stream instance in the specified project. To use this\ - \ resource, the requesting API Key must have the Project Data Access Admin\ - \ role, Project Owner role or Project Stream Processing Owner role." - operationId: deleteStreamInstance + description: "Deletes one Private Link in the specified project. To use this\ + \ resource, the requesting API Key must have the Project Owner or Project\ + \ Stream Processing Owner role." + operationId: deletePrivateLinkConnection parameters: - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/pretty" - $ref: "#/components/parameters/groupId" - - description: Human-readable label that identifies the stream instance to delete. + - description: Unique ID that identifies the Private Link connection. in: path - name: tenantName + name: connectionId + required: true + schema: + type: string + responses: + "202": + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/NoBody" + x-xgen-version: 2023-02-01 + description: Accepted + "401": + $ref: "#/components/responses/unauthorized" + "403": + $ref: "#/components/responses/forbidden" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Delete One Private Link connection + tags: + - Streams + x-xgen-changelog: + "2024-10-02": "The MongoDB Atlas Streams Processing Private Link API is now\ + \ exposed as part of private preview, but is subject to change until GA." + get: + description: "Returns the details of one Private Link connection within the\ + \ project. To use this resource, the requesting API Key must have the Project\ + \ Read Only role." + operationId: getPrivateLinkConnection + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/groupId" + - description: Unique ID that identifies the Private Link connection. + in: path + name: connectionId + required: true + schema: + type: string + responses: + "200": + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/StreamsPrivateLinkConnection" + x-xgen-version: 2023-02-01 + description: OK + "401": + $ref: "#/components/responses/unauthorized" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Return One PrivateLink Connection + tags: + - Streams + x-xgen-changelog: + "2024-10-02": "The MongoDB Atlas Streams Processing Private Link API is now\ + \ exposed as part of private preview, but is subject to change until GA." + /api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections: + get: + description: Returns a list of incoming VPC Peering Connections. + operationId: getVPCPeeringConnections + parameters: + - $ref: "#/components/parameters/groupId" + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/itemsPerPage" + - $ref: "#/components/parameters/pageNum" + - $ref: "#/components/parameters/pretty" + responses: + "200": + content: + application/vnd.atlas.2023-02-01+json: + x-xgen-version: 2023-02-01 + description: OK + "401": + $ref: "#/components/responses/unauthorized" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Return All VPC Peering Connections. + tags: + - Streams + /api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}: + delete: + description: Deletes an incoming VPC Peering connection. + operationId: deleteVPCPeeringConnection + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/groupId" + - description: The VPC Peering Connection id. + in: path + name: id + required: true + schema: + type: string + responses: + "202": + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/NoBody" + x-xgen-version: 2023-02-01 + description: Accepted + "401": + $ref: "#/components/responses/unauthorized" + "403": + $ref: "#/components/responses/forbidden" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Deletes an incoming VPC Peering connection. + tags: + - Streams + /api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:accept: + post: + description: Requests the acceptance of an incoming VPC Peering connection. + operationId: acceptVPCPeeringConnection + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/groupId" + - description: The VPC Peering Connection id. + in: path + name: id + required: true + schema: + type: string + requestBody: + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/VPCPeeringActionChallenge" + description: "Challenge values for VPC Peering requester account ID, and requester\ + \ VPC ID." + required: true + responses: + "202": + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/NoBody" + x-xgen-version: 2023-02-01 + description: Accepted + "401": + $ref: "#/components/responses/unauthorized" + "403": + $ref: "#/components/responses/forbidden" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Requests the acceptance of an incoming VPC Peering connection. + tags: + - Streams + /api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:reject: + post: + description: Requests the rejection of an incoming VPC Peering connection. + operationId: rejectVPCPeeringConnection + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/groupId" + - description: The VPC Peering Connection id. + in: path + name: id + required: true + schema: + type: string + responses: + "202": + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/NoBody" + x-xgen-version: 2023-02-01 + description: Accepted + "401": + $ref: "#/components/responses/unauthorized" + "403": + $ref: "#/components/responses/forbidden" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Requests the rejection of an incoming VPC Peering connection. + tags: + - Streams + /api/atlas/v2/groups/{groupId}/streams/{tenantName}: + delete: + description: "Delete one stream instance in the specified project. To use this\ + \ resource, the requesting API Key must have the Project Data Access Admin\ + \ role, Project Owner role or Project Stream Processing Owner role." + operationId: deleteStreamInstance + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/pretty" + - $ref: "#/components/parameters/groupId" + - description: Human-readable label that identifies the stream instance to delete. + in: path + name: tenantName required: true schema: type: string @@ -17189,284 +17319,6 @@ paths: summary: Create One Link-Token tags: - Cloud Migration Service - /api/atlas/v2/orgs/{orgId}/serviceAccounts: - get: - description: Returns list of Service Accounts with service account details. - operationId: listServiceAccounts - parameters: - - $ref: "#/components/parameters/orgId" - - $ref: "#/components/parameters/itemsPerPage" - - $ref: "#/components/parameters/pageNum" - - $ref: "#/components/parameters/pretty" - - $ref: "#/components/parameters/envelope" - responses: - "200": - content: - application/vnd.atlas.2023-10-01+json: - schema: - $ref: "#/components/schemas/PaginatedOrgServiceAccounts" - x-xgen-version: 2023-10-01 - description: OK - "401": - $ref: "#/components/responses/unauthorized" - "403": - $ref: "#/components/responses/forbidden" - "500": - $ref: "#/components/responses/internalServerError" - security: - - DigestAuth: [] - summary: Return All Service Accounts - tags: - - Organizations - post: - description: Create Service Account containing client id and client secrets. - operationId: createServiceAccount - parameters: - - $ref: "#/components/parameters/orgId" - - $ref: "#/components/parameters/envelope" - - $ref: "#/components/parameters/pretty" - requestBody: - content: - application/vnd.atlas.2023-10-01+json: - schema: - $ref: "#/components/schemas/OrgServiceAccountRequest" - description: Details to create service account in the specified organization. - required: true - responses: - "201": - content: - application/vnd.atlas.2023-10-01+json: - schema: - $ref: "#/components/schemas/OrgServiceAccount" - x-xgen-version: 2023-10-01 - description: Created - "400": - $ref: "#/components/responses/badRequest" - "401": - $ref: "#/components/responses/unauthorized" - "500": - $ref: "#/components/responses/internalServerError" - security: - - DigestAuth: [] - summary: Service Account Creation - tags: - - Organizations - /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}: - delete: - description: Delete Service Account. - operationId: deleteServiceAccount - parameters: - - description: Id of the service account. - in: path - name: serviceAccountId - required: true - schema: - type: string - - $ref: "#/components/parameters/orgId" - - $ref: "#/components/parameters/envelope" - - $ref: "#/components/parameters/pretty" - responses: - "204": - content: - application/vnd.atlas.2023-10-01+json: - x-xgen-version: 2023-10-01 - description: This endpoint does not return a response body. - "401": - $ref: "#/components/responses/unauthorized" - "404": - $ref: "#/components/responses/notFound" - "500": - $ref: "#/components/responses/internalServerError" - security: - - DigestAuth: [] - summary: Service Account Deletion. - tags: - - Organizations - get: - description: Get Service Account Details. - operationId: getServiceAccount - parameters: - - $ref: "#/components/parameters/orgId" - - description: Id of the service account. - in: path - name: serviceAccountId - required: true - schema: - type: string - - $ref: "#/components/parameters/envelope" - - $ref: "#/components/parameters/pretty" - responses: - "200": - content: - application/vnd.atlas.2023-10-01+json: - schema: - $ref: "#/components/schemas/OrgServiceAccount" - x-xgen-version: 2023-10-01 - description: OK - "401": - $ref: "#/components/responses/unauthorized" - "404": - $ref: "#/components/responses/notFound" - "500": - $ref: "#/components/responses/internalServerError" - security: - - DigestAuth: [] - summary: Service Account Fetching - tags: - - Organizations - patch: - description: Update Service Account. - operationId: updateServiceAccount - parameters: - - description: Id of the service account. - in: path - name: serviceAccountId - required: true - schema: - type: string - - $ref: "#/components/parameters/orgId" - - $ref: "#/components/parameters/envelope" - - $ref: "#/components/parameters/pretty" - requestBody: - content: - application/vnd.atlas.2023-10-01+json: - schema: - $ref: "#/components/schemas/OrgServiceAccountUpdateRequest" - description: Details to update service account in the specified organization. - required: true - responses: - "200": - content: - application/vnd.atlas.2023-10-01+json: - schema: - $ref: "#/components/schemas/OrgServiceAccount" - x-xgen-version: 2023-10-01 - description: OK - "400": - $ref: "#/components/responses/badRequest" - "401": - $ref: "#/components/responses/unauthorized" - "404": - $ref: "#/components/responses/notFound" - "500": - $ref: "#/components/responses/internalServerError" - security: - - DigestAuth: [] - summary: Service Account Update - tags: - - Organizations - /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/groups: - get: - description: Returns list of Service Account projects. - operationId: listServiceAccountProjects - parameters: - - $ref: "#/components/parameters/orgId" - - description: Id of the service account. - in: path - name: serviceAccountId - required: true - schema: - type: string - - $ref: "#/components/parameters/itemsPerPage" - - $ref: "#/components/parameters/pageNum" - - $ref: "#/components/parameters/pretty" - - $ref: "#/components/parameters/envelope" - responses: - "200": - content: - application/vnd.atlas.2023-10-01+json: - schema: - $ref: "#/components/schemas/PaginatedServiceAccountGroup" - x-xgen-version: 2023-10-01 - description: OK - "401": - $ref: "#/components/responses/unauthorized" - "403": - $ref: "#/components/responses/forbidden" - "500": - $ref: "#/components/responses/internalServerError" - security: - - DigestAuth: [] - summary: Return All Service Account projects - tags: - - Organizations - /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets: - post: - description: Create Service Account secret. - operationId: createServiceAccountSecret - parameters: - - $ref: "#/components/parameters/orgId" - - description: Id of the service account. - in: path - name: serviceAccountId - required: true - schema: - type: string - - $ref: "#/components/parameters/envelope" - - $ref: "#/components/parameters/pretty" - requestBody: - content: - application/vnd.atlas.2023-10-01+json: - schema: - $ref: "#/components/schemas/ServiceAccountSecretRequest" - description: Details to create secret in the specified service account. - required: true - responses: - "201": - content: - application/vnd.atlas.2023-10-01+json: - schema: - $ref: "#/components/schemas/ServiceAccountSecret" - x-xgen-version: 2023-10-01 - description: Created - "400": - $ref: "#/components/responses/badRequest" - "401": - $ref: "#/components/responses/unauthorized" - "500": - $ref: "#/components/responses/internalServerError" - security: - - DigestAuth: [] - summary: Service Account Secret Creation - tags: - - Organizations - /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets/{secretId}: - delete: - description: Delete Service Account Secret. - operationId: deleteServiceAccountSecret - parameters: - - description: Id of the service account. - in: path - name: serviceAccountId - required: true - schema: - type: string - - description: Id of the secret. - in: path - name: secretId - required: true - schema: - type: string - - $ref: "#/components/parameters/orgId" - - $ref: "#/components/parameters/envelope" - - $ref: "#/components/parameters/pretty" - responses: - "204": - content: - application/vnd.atlas.2023-10-01+json: - x-xgen-version: 2023-10-01 - description: This endpoint does not return a response body. - "401": - $ref: "#/components/responses/unauthorized" - "404": - $ref: "#/components/responses/notFound" - "500": - $ref: "#/components/responses/internalServerError" - security: - - DigestAuth: [] - summary: Service Account Secret Deletion. - tags: - - Organizations /api/atlas/v2/orgs/{orgId}/settings: get: description: "Returns details about the specified organization's settings. To\ @@ -17521,6 +17373,8 @@ paths: $ref: "#/components/schemas/OrganizationSettings" x-xgen-version: 2023-01-01 description: OK + "400": + $ref: "#/components/responses/badRequest" "401": $ref: "#/components/responses/unauthorized" "403": @@ -17995,6 +17849,7 @@ paths: - Organizations /api/atlas/v2/orgs/{orgId}/users/{userId}: delete: + deprecated: true description: "Removes one MongoDB Cloud user from the specified organization.\ \ To use this resource, the requesting API Key must have the Organization\ \ User Admin role." @@ -18002,6 +17857,7 @@ paths: parameters: - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/orgId" + - $ref: "#/components/parameters/pretty" - description: Unique 24-hexadecimal digit string that identifies the user to be deleted. in: path @@ -18032,9 +17888,10 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Remove One MongoDB Cloud User from One Organization + summary: Remove One MongoDB Cloud User From One Organization tags: - Organizations + x-sunset: 2026-01-01 /api/atlas/v2/orgs/{orgId}/users/{userId}/roles: put: description: "Updates the roles of the specified user in the specified organization.\ @@ -18861,7 +18718,7 @@ components: description: |- Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. - Change this parameter only if you: + 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). @@ -18937,7 +18794,7 @@ components: You can set different IOPS values on different shards when provisioned IOPS are supported. - Change this parameter only if you: + 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). @@ -19368,6 +19225,31 @@ components: - REPLICASET - SHARDED - GEOSHARDED + configServerManagementMode: + type: string + default: ATLAS_MANAGED + description: |- + Config Server Management Mode for creating or updating a sharded cluster. + + When configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings. + + When configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server. + enum: + - ATLAS_MANAGED + - FIXED_TO_DEDICATED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + configServerType: + type: string + description: Describes a sharded cluster's config server type. + enum: + - DEDICATED + - EMBEDDED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + readOnly: true connectionStrings: $ref: "#/components/schemas/ClusterConnectionStrings" createDate: @@ -19415,6 +19297,15 @@ components: externalDocs: description: Encryption at Rest using Customer Key Management url: https://www.mongodb.com/docs/atlas/security-kms-encryption/ + featureCompatibilityVersion: + type: string + description: Feature compatibility version of the cluster. + readOnly: true + featureCompatibilityVersionExpirationDate: + type: string + format: date-time + description: Feature compatibility version expiration date. + readOnly: true globalClusterSelfManagedSharding: type: boolean description: |- @@ -19465,6 +19356,8 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true + mongoDBEmployeeAccessGrant: + $ref: "#/components/schemas/EmployeeAccessGrantView" mongoDBMajorVersion: type: string description: |- @@ -19486,7 +19379,7 @@ components: description: Human-readable label that identifies the advanced cluster. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" paused: type: boolean description: Flag that indicates whether the cluster is paused. @@ -19497,6 +19390,24 @@ components: externalDocs: description: Continuous Cloud Backups url: https://docs.atlas.mongodb.com/backup/cloud-backup/overview/ + replicaSetScalingStrategy: + type: string + default: WORKLOAD_TYPE + description: |- + Set this field to configure the replica set scaling mode for your cluster. + + By default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes. + + When configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads. + + When configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads. + enum: + - SEQUENTIAL + - WORKLOAD_TYPE + - NODE_TYPE + externalDocs: + description: Modify the Replica Set Scaling Mode + url: https://dochub.mongodb.org/core/scale-nodes replicationSpecs: type: array description: "List of settings that configure your cluster regions. For\ @@ -20375,6 +20286,246 @@ components: description: Atlas Search Index url: https://dochub.mongodb.org/core/index-definitions-fts title: mappings + ApiAtlasInvalidPolicyErrorDetailView: + type: object + properties: + detail: + type: string + description: A string that provides a detailed description of a validation + error. + readOnly: true + ApiAtlasInvalidPolicyView: + type: object + properties: + body: + type: string + description: A string that defines the permissions for the policy. The syntax + used is the Cedar Policy language. + example: |2 + forbid ( + principal, + action == cloud::Action::"cluster.createEdit", + resource + ) when { + context.cluster.regions.contains(cloud::region::"aws:us-east-1") + }; + readOnly: true + errors: + type: array + description: List of validation errors. + items: + $ref: "#/components/schemas/ApiAtlasInvalidPolicyErrorDetailView" + readOnly: true + ApiAtlasInvalidResourcePolicyCreateErrorView: + type: object + properties: + errorType: + type: string + description: Human-readable label that displays the type of an error. + enum: + - POLICY_PARSING_ERROR + - POLICY_HAS_FAILED_VALIDATIONS + - POLICY_HAS_INVALID_PRINCIPAL + - POLICY_HAS_BODY_EXCEEDING_MAX_SIZE + - POLICY_HAS_UNEXPECTED_ENTITIES + invalidPolicies: + type: array + description: List of invalid policies containing details of their validation + errors. + items: + $ref: "#/components/schemas/ApiAtlasInvalidPolicyView" + readOnly: true + ApiAtlasNonCompliantResourceView: + type: object + properties: + orgId: + type: string + description: Unique 24-hexadecimal character string that identifies the + organization the resource belongs to. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + resourceId: + type: string + description: Unique 24-hexadecimal character string that identifies the + non-compliant resource. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + resourcePoliciesCausingNonCompliance: + type: array + description: List of resource policies causing the resource to be considered + non-compliant. + items: + $ref: "#/components/schemas/ApiAtlasResourcePolicyMetadataView" + readOnly: true + resourceType: + type: string + description: Human-readable label that displays the type of a resource. + enum: + - PROJECT + - CLUSTER + readOnly: true + ApiAtlasPolicyCreateView: + type: object + properties: + body: + type: string + description: A string that defines the permissions for the policy. The syntax + used is the Cedar Policy language. + example: |2 + forbid ( + principal, + action == cloud::Action::"cluster.createEdit", + resource + ) when { + context.cluster.regions.contains(cloud::region::"aws:us-east-1") + }; + required: + - body + ApiAtlasPolicyMetadataView: + type: object + properties: + policyId: + type: string + description: Unique 24-hexadecimal character string that identifies the + policy. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + ApiAtlasPolicyView: + type: object + properties: + body: + type: string + description: A string that defines the permissions for the policy. The syntax + used is the Cedar Policy language. + example: |2 + forbid ( + principal, + action == cloud::Action::"cluster.createEdit", + resource + ) when { + context.cluster.regions.contains(cloud::region::"aws:us-east-1") + }; + readOnly: true + id: + type: string + description: Unique 24-hexadecimal character string that identifies the + policy. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + ApiAtlasResourcePolicyCreateView: + type: object + properties: + name: + type: string + description: Human-readable label that describes the atlas resource policy. + policies: + type: array + description: List of policies that make up the atlas resource policy. + items: + $ref: "#/components/schemas/ApiAtlasPolicyCreateView" + required: + - name + - policies + ApiAtlasResourcePolicyEditView: + type: object + properties: + name: + type: string + description: Human-readable label that describes the atlas resource policy. + policies: + type: array + description: List of policies that make up the atlas resource policy. + items: + $ref: "#/components/schemas/ApiAtlasPolicyCreateView" + ApiAtlasResourcePolicyMetadataView: + type: object + properties: + policiesCausingNonCompliance: + type: array + description: List of policies that are in conflict with the current state + of the resource. + items: + $ref: "#/components/schemas/ApiAtlasPolicyMetadataView" + readOnly: true + resourcePolicyId: + type: string + description: Unique 24-hexadecimal character string that identifies the + atlas resource policy. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + resourcePolicyName: + type: string + description: Human-readable label that describes the atlas resource policy. + readOnly: true + ApiAtlasResourcePolicyView: + type: object + properties: + createdByUser: + $ref: "#/components/schemas/ApiAtlasUserMetadataView" + createdDate: + type: string + format: date-time + description: Date and time in UTC when the atlas resource policy was created. + example: 2022-01-01T00:00:00Z + readOnly: true + id: + type: string + description: Unique 24-hexadecimal character string that identifies the + atlas resource policy. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + lastUpdatedByUser: + $ref: "#/components/schemas/ApiAtlasUserMetadataView" + lastUpdatedDate: + type: string + format: date-time + description: Date and time in UTC when the atlas resource policy was last + updated. + example: 2022-01-01T00:00:00Z + readOnly: true + name: + type: string + description: Human-readable label that describes the atlas resource policy. + readOnly: true + orgId: + type: string + description: Unique 24-hexadecimal character string that identifies the + organization the atlas resource policy belongs to. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + policies: + type: array + description: List of policies that make up the atlas resource policy. + items: + $ref: "#/components/schemas/ApiAtlasPolicyView" + readOnly: true + version: + type: string + description: A string that identifies the version of the atlas resource + policy. + example: v1 + readOnly: true ApiAtlasSnapshotScheduleView: type: object properties: @@ -20511,6 +20662,23 @@ components: - snapshotIntervalHours - snapshotRetentionDays - weeklySnapshotRetentionWeeks + ApiAtlasUserMetadataView: + type: object + description: The user that last updated the atlas resource policy. + properties: + id: + type: string + description: Unique 24-hexadecimal character string that identifies a user. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + name: + type: string + description: Human-readable label that describes a user. + readOnly: true + readOnly: true ApiBSONTimestampView: type: object description: BSON timestamp that indicates when the checkpoint token entry in @@ -20567,6 +20735,8 @@ components: ApiError: type: object properties: + badRequestDetail: + $ref: "#/components/schemas/BadRequestDetail" detail: type: string description: Describes the specific conditions or reasons that cause each @@ -20577,17 +20747,25 @@ components: description: HTTP status code returned with this error. externalDocs: url: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status + readOnly: true 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. items: type: object + readOnly: true + readOnly: true reason: type: string description: Application error message returned with this error. + readOnly: true + required: + - error + - errorCode ApiHostView_Atlas: type: object properties: @@ -20876,6 +21054,23 @@ components: \ and **period** in the same request. This parameter expresses its value\ \ in the ISO 8601 timestamp format in UTC." readOnly: true + ApiPrivateDownloadDeliveryUrl: + type: object + description: One Uniform Resource Locator (URL) that points to the compressed + snapshot files for manual download and the corresponding private endpoint. + properties: + deliveryUrl: + type: string + description: One Uniform Resource Locator that points to the compressed + snapshot files for manual download. + endpointId: + type: string + description: Unique 22-character alphanumeric string that identifies the + private endpoint. + example: vpce-3bf78b0ddee411ba1 + maxLength: 22 + minLength: 22 + pattern: "^vpce-[0-9a-f]{17}$" ApiPublicUsageDetailsQueryRequest: type: object description: "Request body for an Invoice Usage Details query with filtering,\ @@ -20987,7 +21182,23 @@ components: type: string description: Atlas Streams AWS Regions. enum: + - SYDNEY_AUS + - MUMBAI_IND + - FRANKFURT_DEU + - DUBLIN_IRL + - LONDON_GBR - VIRGINIA_USA + - OREGON_USA + - SAOPAULO_BRA + - MONTREAL_CAN + - TOKYO_JPN + - SINGAPORE_SGP + ApiStreamsAzureRegionView: + type: string + description: Atlas Streams Azure Regions. + enum: + - VIRGINIA_USA + - AMSTERDAM_NLD ApiUserEventTypeViewForNdsGroup: type: string description: Unique identifier of event type. @@ -21234,6 +21445,12 @@ components: - eventTypeName - id title: API User Events + ApiVersion: + type: object + properties: + version: + type: string + description: Object representing a version of the Atlas Admin API. AppServiceAlertConfigViewForNdsGroup: type: object description: App Services metric alert configuration allows to select which @@ -21715,7 +21932,12 @@ components: enum: - AVERAGE operator: - $ref: "#/components/schemas/Operator" + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - LESS_THAN + - GREATER_THAN threshold: type: number format: double @@ -21793,6 +22015,12 @@ components: enum: - VIRGINIA_USA - AMSTERDAM_NLD + AtlasDataFederationGCPRegion: + type: string + description: Atlas Data Federation GCP Regions. + enum: + - IOWA_USA + - BELGIUM_EU AtlasOrganization: type: object description: Details that describe the organization. @@ -21828,6 +22056,128 @@ components: pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" required: - name + AtlasResourcePolicyAuditForOrg: + type: object + description: Atlas resource policy audits indicate org level changes to resource + policies + properties: + apiKeyId: + type: string + description: "Unique 24-hexadecimal digit string that identifies the [API\ + \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\ + \ triggered the event. If this resource returns this parameter, it doesn't\ + \ return the **userId** parameter." + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + created: + type: string + format: date-time + description: Date and time when this event occurred. This parameter expresses + its value in the ISO 8601 timestamp format in UTC. + readOnly: true + eventTypeName: + type: string + description: Unique identifier of event type. + enum: + - RESOURCE_POLICY_CREATED + - RESOURCE_POLICY_MODIFIED + - RESOURCE_POLICY_DELETED + example: RESOURCE_POLICY_CREATED + title: Atlas Resource Policy Audit Types + groupId: + type: string + description: Unique 24-hexadecimal digit string that identifies the project + in which the event occurred. The **eventId** identifies the specific event. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + id: + type: string + description: Unique 24-hexadecimal digit string that identifies the event. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + isGlobalAdmin: + type: boolean + default: false + description: Flag that indicates whether a MongoDB employee triggered the + specified event. + readOnly: true + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + orgId: + type: string + description: Unique 24-hexadecimal digit string that identifies the organization + to which these events apply. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + publicKey: + type: string + format: email + description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\ + \ that triggered the event. If this resource returns this parameter, it\ + \ doesn't return the **username** parameter." + readOnly: true + raw: + $ref: "#/components/schemas/raw" + remoteAddress: + type: string + description: IPv4 or IPv6 address from which the user triggered this event. + example: 216.172.40.186 + pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + readOnly: true + resourcePolicyId: + type: string + description: Unique 24-hexadecimal character string that identifies the + resource policy. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + userId: + type: string + description: "Unique 24-hexadecimal digit string that identifies the console\ + \ user who triggered the event. If this resource returns this parameter,\ + \ it doesn't return the **apiKeyId** parameter." + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + username: + type: string + format: email + description: "Email address for the user who triggered this event. If this\ + \ resource returns this parameter, it doesn't return the **publicApiKey**\ + \ parameter." + example: test.user@mongodb.com + readOnly: true + required: + - created + - eventTypeName + - id + title: Atlas Resource Policy Audits AtlasSearchAnalyzer: type: object properties: @@ -22549,6 +22899,21 @@ components: AzureHardwareSpec: type: object properties: + diskIOPS: + type: integer + format: int32 + description: |- + Target throughput desired for storage attached to your Azure-provisioned cluster. Change this parameter if you: + + - set `"replicationSpecs[n].regionConfigs[m].providerName" : "Azure"`. + - set `"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize" : "M40"` or greater not including `Mxx_NVME` tiers. + + The maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**. + This parameter defaults to the cluster tier's standard IOPS value. + Changing this value impacts cluster cost. + externalDocs: + description: Programmatic API Keys + url: https://www.mongodb.com/docs/atlas/customize-storage/#extend-iops-on-azure instanceSize: type: string description: Hardware specification for the instance sizes in this region. @@ -22586,6 +22951,21 @@ components: AzureHardwareSpec20240805: type: object properties: + diskIOPS: + type: integer + format: int32 + description: |- + Target throughput desired for storage attached to your Azure-provisioned cluster. Change this parameter if you: + + - set `"replicationSpecs[n].regionConfigs[m].providerName" : "Azure"`. + - set `"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize" : "M40"` or greater not including `Mxx_NVME` tiers. + + The maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**. + This parameter defaults to the cluster tier's standard IOPS value. + Changing this value impacts cluster cost. + externalDocs: + description: Programmatic API Keys + url: https://www.mongodb.com/docs/atlas/customize-storage/#extend-iops-on-azure diskSizeGB: type: number format: double @@ -22801,6 +23181,8 @@ components: - PENDING_ACCEPTANCE - ACTIVE - FAILED + - PENDING_RECREATION + - DELETING readOnly: true title: Azure Key Vault EAR Private Endpoint AzureNetworkPeeringConnectionSettings: @@ -23235,7 +23617,7 @@ components: the collection for which you want to create an online archive. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true collName: type: string @@ -23347,7 +23729,7 @@ components: the collection for which you want to create an online archive. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true collName: type: string @@ -23486,7 +23868,7 @@ components: the snapshots you want to retrieve. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -23699,7 +24081,7 @@ components: To return a response with the **clusterId** parameter, either use the **delivery.targetClusterName** parameter or enable backup on the target cluster. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" targetGroupId: type: string description: "Unique 24-hexadecimal digit string that identifies the project\ @@ -23971,12 +24353,23 @@ components: - FAILED - COMPLETED readOnly: true + BadRequestDetail: + type: object + description: Bad request detail. + properties: + fields: + type: array + description: Describes all violations in a client request. + items: + $ref: "#/components/schemas/FieldViolation" + readOnly: true BaseAtlasDataLakeRegion: type: object description: Name of the region to which the data lake routes client connections. oneOf: - $ref: "#/components/schemas/ApiAtlasDataLakeAWSRegionView" - $ref: "#/components/schemas/AtlasDataFederationAzureRegion" + - $ref: "#/components/schemas/AtlasDataFederationGCPRegion" BaseCloudProviderInstanceSize: type: object description: "Minimum instance size to which your cluster can automatically\ @@ -24104,6 +24497,7 @@ components: description: Name of the cloud provider region hosting Atlas Stream Processing. oneOf: - $ref: "#/components/schemas/ApiStreamsAWSRegionView" + - $ref: "#/components/schemas/ApiStreamsAzureRegionView" BasicBSONList: type: array description: "List that contains the search criteria that the query uses. To\ @@ -25191,7 +25585,7 @@ components: description: Human-readable label that identifies the cluster. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true nodeCount: type: integer @@ -25252,6 +25646,10 @@ components: 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. + description: + type: string + description: Description of this database user. + maxLength: 100 groupId: type: string description: Unique 24-hexadecimal digit string that identifies the project. @@ -25519,6 +25917,127 @@ components: (AWS) Identity and Access Management (IAM) role. required: - providerName + CloudProviderAccessAWSIAMRoleRequest: + type: object + description: Details that describe the features linked to the Amazon Web Services + (AWS) Identity and Access Management (IAM) role. + properties: + atlasAWSAccountArn: + 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. + example: arn:aws:iam::772401394250:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + readOnly: true + atlasAssumedRoleExternalId: + type: string + format: uuid + description: Unique external ID that MongoDB Cloud uses when it assumes + the IAM role in your Amazon Web Services (AWS) account. + readOnly: true + authorizedDate: + type: string + format: date-time + 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. + readOnly: true + createdDate: + type: string + format: date-time + 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. + readOnly: true + featureUsages: + type: array + description: List that contains application features associated with this + Amazon Web Services (AWS) Identity and Access Management (IAM) role. + items: + $ref: "#/components/schemas/CloudProviderAccessFeatureUsage" + readOnly: true + providerName: + type: string + description: Human-readable label that identifies the cloud provider of + the role. + enum: + - AWS + - AZURE + - GCP + roleId: + type: string + description: Unique 24-hexadecimal digit string that identifies the role. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + required: + - providerName + CloudProviderAccessAWSIAMRoleRequestUpdate: + type: object + allOf: + - $ref: "#/components/schemas/CloudProviderAccessRoleRequestUpdate" + - type: object + properties: + atlasAWSAccountArn: + 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. + example: arn:aws:iam::772401394250:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + readOnly: true + atlasAssumedRoleExternalId: + type: string + format: uuid + description: Unique external ID that MongoDB Cloud uses when it assumes + the IAM role in your Amazon Web Services (AWS) account. + readOnly: true + authorizedDate: + type: string + format: date-time + 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. + readOnly: true + createdDate: + type: string + format: date-time + 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. + readOnly: true + featureUsages: + type: array + description: List that contains application features associated with this + Amazon Web Services (AWS) Identity and Access Management (IAM) role. + items: + $ref: "#/components/schemas/CloudProviderAccessFeatureUsage" + readOnly: true + iamAssumedRoleArn: + 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 + maxLength: 2048 + minLength: 20 + roleId: + type: string + description: Unique 24-hexadecimal digit string that identifies the role. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + description: Details that describe the features linked to the Amazon Web Services + (AWS) Identity and Access Management (IAM) role. + required: + - providerName CloudProviderAccessAzureServicePrincipal: type: object allOf: @@ -25580,6 +26099,133 @@ components: Principal. required: - providerName + CloudProviderAccessAzureServicePrincipalRequest: + type: object + description: Details that describe the features linked to the Azure Service + Principal. + properties: + _id: + type: string + description: Unique 24-hexadecimal digit string that identifies the role. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + atlasAzureAppId: + type: string + description: Azure Active Directory Application ID of Atlas. + maxLength: 36 + minLength: 32 + pattern: "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\\ + b-[0-9a-fA-F]{12}$" + createdDate: + type: string + format: date-time + description: Date and time when this Azure Service Principal was created. + This parameter expresses its value in the ISO 8601 timestamp format in + UTC. + readOnly: true + featureUsages: + type: array + description: List that contains application features associated with this + Azure Service Principal. + items: + $ref: "#/components/schemas/CloudProviderAccessFeatureUsage" + readOnly: true + lastUpdatedDate: + type: string + format: date-time + 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. + 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. + maxLength: 36 + minLength: 32 + pattern: "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\\ + b-[0-9a-fA-F]{12}$" + tenantId: + type: string + description: UUID String that identifies the Azure Active Directory Tenant + ID. + maxLength: 36 + minLength: 32 + pattern: "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\\ + b-[0-9a-fA-F]{12}$" + required: + - providerName + CloudProviderAccessAzureServicePrincipalRequestUpdate: + type: object + allOf: + - $ref: "#/components/schemas/CloudProviderAccessRoleRequestUpdate" + - type: object + properties: + _id: + type: string + description: Unique 24-hexadecimal digit string that identifies the role. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + atlasAzureAppId: + type: string + description: Azure Active Directory Application ID of Atlas. + maxLength: 36 + minLength: 32 + pattern: "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\\ + b-[0-9a-fA-F]{12}$" + createdDate: + type: string + format: date-time + description: Date and time when this Azure Service Principal was created. + This parameter expresses its value in the ISO 8601 timestamp format + in UTC. + readOnly: true + featureUsages: + type: array + description: List that contains application features associated with this + Azure Service Principal. + items: + $ref: "#/components/schemas/CloudProviderAccessFeatureUsage" + readOnly: true + lastUpdatedDate: + type: string + format: date-time + 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. + readOnly: true + servicePrincipalId: + type: string + description: UUID string that identifies the Azure Service Principal. + maxLength: 36 + minLength: 32 + pattern: "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\\ + b-[0-9a-fA-F]{12}$" + tenantId: + type: string + description: UUID String that identifies the Azure Active Directory Tenant + ID. + maxLength: 36 + minLength: 32 + pattern: "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\\ + b-[0-9a-fA-F]{12}$" + description: Details that describe the features linked to the Azure Service + Principal. + required: + - providerName CloudProviderAccessDataLakeFeatureUsage: type: object allOf: @@ -25692,6 +26338,85 @@ components: minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true + CloudProviderAccessGCPServiceAccount: + type: object + allOf: + - $ref: "#/components/schemas/CloudProviderAccessRole" + - type: object + properties: + createdDate: + type: string + format: date-time + description: Date and time when this Google Service Account was created. + This parameter expresses its value in the ISO 8601 timestamp format + in UTC. + readOnly: true + featureUsages: + type: array + description: List that contains application features associated with this + Google Service Account. + items: + $ref: "#/components/schemas/CloudProviderAccessFeatureUsage" + readOnly: true + gcpServiceAccountForAtlas: + type: string + description: Email address for the Google Service Account created by Atlas. + maxLength: 82 + minLength: 57 + pattern: "^mongodb-atlas-[0-9a-z]{16}@p-[0-9a-z]{24}.iam.gserviceaccount.com$" + roleId: + type: string + description: Unique 24-hexadecimal digit string that identifies the role. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + description: Details that describe the features linked to the GCP Service Account. + required: + - providerName + CloudProviderAccessGCPServiceAccountRequest: + type: object + description: Details that describe the features linked to the GCP Service Account. + properties: + createdDate: + type: string + format: date-time + description: Date and time when this GCP Service Account was created. This + parameter expresses its value in the ISO 8601 timestamp format in UTC. + readOnly: true + featureUsages: + type: array + description: List that contains application features associated with this + GCP Service Account. + items: + $ref: "#/components/schemas/CloudProviderAccessFeatureUsage" + readOnly: true + 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: + type: string + description: Unique 24-hexadecimal digit string that identifies the role. + readOnly: true + required: + - providerName + CloudProviderAccessGCPServiceAccountRequestUpdate: + type: object + allOf: + - $ref: "#/components/schemas/CloudProviderAccessRoleRequestUpdate" + description: Details that describe the features linked to the GCP Service Account. + required: + - providerName CloudProviderAccessPushBasedLogExportFeatureUsage: type: object allOf: @@ -25710,10 +26435,52 @@ components: mapping: AWS: "#/components/schemas/CloudProviderAccessAWSIAMRole" AZURE: "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + GCP: "#/components/schemas/CloudProviderAccessGCPServiceAccount" + propertyName: providerName + properties: + providerName: + type: string + description: Human-readable label that identifies the cloud provider of + the role. + enum: + - AWS + - AZURE + - GCP + required: + - providerName + CloudProviderAccessRoleRequest: + type: object + description: Cloud provider access role. + discriminator: + mapping: + AWS: "#/components/schemas/CloudProviderAccessAWSIAMRoleRequest" + AZURE: "#/components/schemas/CloudProviderAccessAzureServicePrincipalRequest" + GCP: "#/components/schemas/CloudProviderAccessGCPServiceAccountRequest" propertyName: providerName oneOf: - - $ref: "#/components/schemas/CloudProviderAccessAWSIAMRole" - - $ref: "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + - $ref: "#/components/schemas/CloudProviderAccessAWSIAMRoleRequest" + - $ref: "#/components/schemas/CloudProviderAccessAzureServicePrincipalRequest" + - $ref: "#/components/schemas/CloudProviderAccessGCPServiceAccountRequest" + properties: + providerName: + type: string + description: Human-readable label that identifies the cloud provider of + the role. + enum: + - AWS + - AZURE + - GCP + required: + - providerName + CloudProviderAccessRoleRequestUpdate: + type: object + description: Cloud provider access role. + discriminator: + mapping: + AWS: "#/components/schemas/CloudProviderAccessAWSIAMRoleRequestUpdate" + AZURE: "#/components/schemas/CloudProviderAccessAzureServicePrincipalRequestUpdate" + GCP: "#/components/schemas/CloudProviderAccessGCPServiceAccountRequestUpdate" + propertyName: providerName properties: providerName: type: string @@ -25722,6 +26489,7 @@ components: enum: - AWS - AZURE + - GCP required: - providerName CloudProviderAccessRoles: @@ -25733,6 +26501,12 @@ components: registered and authorized with MongoDB Cloud. items: $ref: "#/components/schemas/CloudProviderAccessAWSIAMRole" + azureServicePrincipals: + type: array + description: List that contains the Azure Service Principals registered + with MongoDB Cloud. + items: + $ref: "#/components/schemas/CloudProviderAccessAzureServicePrincipal" CloudProviderAzureAutoScaling: type: object description: Range of instance sizes to which your cluster can scale. @@ -26401,7 +27175,7 @@ components: example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -26505,6 +27279,7 @@ components: $ref: "#/components/schemas/ClusterComputeAutoScaling" diskGBEnabled: type: boolean + default: false description: Flag that indicates whether someone enabled disk auto-scaling for this cluster. title: Automatic Cluster Scaling Settings @@ -26531,12 +27306,14 @@ components: properties: enabled: type: boolean + default: false description: "Flag that indicates whether cluster tier auto-scaling is enabled.\ \ Set to `true` to enable cluster tier auto-scaling. If enabled, you must\ \ specify a value for **providerSettings.autoScaling.compute.maxInstanceSize**\ \ also. Set to `false` to disable cluster tier auto-scaling." scaleDownEnabled: type: boolean + default: false description: "Flag that indicates whether the cluster tier can scale down.\ \ This is required if **autoScaling.compute.enabled** is `true`. If you\ \ enable this option, specify a value for **providerSettings.autoScaling.compute.minInstanceSize**." @@ -26574,20 +27351,28 @@ components: 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. + description: "Private endpoint-aware connection strings that use AWS-hosted\ + \ clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies\ + \ an Amazon Web Services (AWS) interface endpoint. Each value identifies\ + \ the related `mongodb://` connection string that you use to connect\ + \ to Atlas through the interface endpoint that the key names. If the\ + \ cluster uses an optimized connection string, `awsPrivateLinkSrv` contains\ + \ the optimized connection string. If the cluster has the non-optimized\ + \ (legacy) connection string, `awsPrivateLinkSrv` contains the non-optimized\ + \ connection string even if an optimized connection string is also present." externalDocs: description: Network Peering Connection url: https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/ readOnly: true - 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. + description: "Private endpoint-aware connection strings that use AWS-hosted\ + \ clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies\ + \ an Amazon Web Services (AWS) interface endpoint. Each value identifies\ + \ the related `mongodb://` connection string that you use to connect to\ + \ Atlas through the interface endpoint that the key names. If the cluster\ + \ uses an optimized connection string, `awsPrivateLinkSrv` contains the\ + \ optimized connection string. If the cluster has the non-optimized (legacy)\ + \ connection string, `awsPrivateLinkSrv` contains the non-optimized connection\ + \ string even if an optimized connection string is also present." externalDocs: description: Network Peering Connection url: https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/ @@ -26689,6 +27474,31 @@ components: - REPLICASET - SHARDED - GEOSHARDED + configServerManagementMode: + type: string + default: ATLAS_MANAGED + description: |- + Config Server Management Mode for creating or updating a sharded cluster. + + When configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings. + + When configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server. + enum: + - ATLAS_MANAGED + - FIXED_TO_DEDICATED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + configServerType: + type: string + description: Describes a sharded cluster's config server type. + enum: + - DEDICATED + - EMBEDDED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + readOnly: true connectionStrings: $ref: "#/components/schemas/ClusterConnectionStrings" createDate: @@ -26722,6 +27532,15 @@ components: externalDocs: description: Encryption at Rest using Customer Key Management url: https://www.mongodb.com/docs/atlas/security-kms-encryption/ + featureCompatibilityVersion: + type: string + description: Feature compatibility version of the cluster. + readOnly: true + featureCompatibilityVersionExpirationDate: + type: string + format: date-time + description: Feature compatibility version expiration date. + readOnly: true globalClusterSelfManagedSharding: type: boolean description: |- @@ -26772,6 +27591,8 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true + mongoDBEmployeeAccessGrant: + $ref: "#/components/schemas/EmployeeAccessGrantView" mongoDBMajorVersion: type: string description: |- @@ -26793,7 +27614,7 @@ components: description: Human-readable label that identifies the cluster. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" paused: type: boolean description: Flag that indicates whether the cluster is paused. @@ -26804,6 +27625,35 @@ components: externalDocs: description: Continuous Cloud Backups url: https://docs.atlas.mongodb.com/backup/cloud-backup/overview/ + redactClientLogData: + type: boolean + description: Enable or disable log redaction. + externalDocs: + description: |- + This options corresponds to the ``security.redactClientLogData`` cluster parameter. + + This setting configures the ``mongod`` or ``mongos`` to redact any message accompanying a given log event before logging. This prevents the program from writing potentially sensitive data stored on the database to the diagnostic log. Metadata such as error or operation codes, line numbers, and source file names are still visible in the logs. + + Use ``redactClientLogData`` in conjunction with Encryption at Rest and TLS/SSL (Transport Encryption) to assist compliance with regulatory requirements. + url: https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.redactClientLogData + replicaSetScalingStrategy: + type: string + default: WORKLOAD_TYPE + description: |- + Set this field to configure the replica set scaling mode for your cluster. + + By default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes. + + When configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads. + + When configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads. + enum: + - SEQUENTIAL + - WORKLOAD_TYPE + - NODE_TYPE + externalDocs: + description: Modify the Replica Set Scaling Mode + url: https://dochub.mongodb.org/core/scale-nodes replicationSpecs: type: array description: List of settings that configure your cluster regions. This @@ -26929,6 +27779,24 @@ components: ClusterDescriptionProcessArgs: type: object properties: + changeStreamOptionsPreAndPostImagesExpireAfterSeconds: + type: integer + format: int32 + default: -1 + description: The minimum pre- and post-image retention time in seconds. + externalDocs: + description: "This option corresponds to the ``changeStreamOptions.preAndPostImages.expireAfterSeconds``\ + \ cluster parameter. This setting controls the retention policy of change\ + \ stream pre- and post-images. Pre- and post-images are the versions\ + \ of a document before and after document modification, respectively.\ + \ ``expireAfterSeconds`` controls how long MongoDB retains pre- and\ + \ post-images. When set to -1 (off), MongoDB uses the default retention\ + \ policy: pre- and post-images are retained until the corresponding\ + \ change stream events are removed from the oplog. To set the minimum\ + \ pre- and post-image retention time, specify an integer value greater\ + \ than zero. Setting this too low could increase the risk of interrupting\ + \ Realm sync or triggers processing. The default value is -1 (off)." + url: https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/changeStreamOptions/#mongodb-parameter-param.changeStreamOptions.preAndPostImages.expireAfterSeconds chunkMigrationConcurrency: type: integer format: int32 @@ -26939,6 +27807,14 @@ components: description: This option corresponds to the `chunkMigrationConcurrency` `mongod` configuration file option. url: https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.chunkMigrationConcurrency + defaultMaxTimeMS: + type: integer + format: int32 + description: Default time limit in milliseconds for individual read operations + to complete. + externalDocs: + description: This option corresponds to the defaultMaxTimeMS cluster parameter. + url: https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/defaultMaxTimeMS/ defaultReadConcern: type: string default: available @@ -26975,8 +27851,10 @@ components: url: https://docs.mongodb.com/upcoming/reference/parameters/#mongodb-parameter-param.failIndexKeyTooLong javascriptEnabled: type: boolean - description: Flag that indicates whether the cluster allows execution of - operations that perform server-side executions of JavaScript. + 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. @@ -27069,6 +27947,24 @@ components: ClusterDescriptionProcessArgs20240805: type: object properties: + changeStreamOptionsPreAndPostImagesExpireAfterSeconds: + type: integer + format: int32 + default: -1 + description: The minimum pre- and post-image retention time in seconds. + externalDocs: + description: "This option corresponds to the ``changeStreamOptions.preAndPostImages.expireAfterSeconds``\ + \ cluster parameter. This setting controls the retention policy of change\ + \ stream pre- and post-images. Pre- and post-images are the versions\ + \ of a document before and after document modification, respectively.\ + \ ``expireAfterSeconds`` controls how long MongoDB retains pre- and\ + \ post-images. When set to -1 (off), MongoDB uses the default retention\ + \ policy: pre- and post-images are retained until the corresponding\ + \ change stream events are removed from the oplog. To set the minimum\ + \ pre- and post-image retention time, specify an integer value greater\ + \ than zero. Setting this too low could increase the risk of interrupting\ + \ Realm sync or triggers processing. The default value is -1 (off)." + url: https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/changeStreamOptions/#mongodb-parameter-param.changeStreamOptions.preAndPostImages.expireAfterSeconds chunkMigrationConcurrency: type: integer format: int32 @@ -27079,6 +27975,14 @@ components: description: This option corresponds to the `chunkMigrationConcurrency` `mongod` configuration file option. url: https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.chunkMigrationConcurrency + defaultMaxTimeMS: + type: integer + format: int32 + description: Default time limit in milliseconds for individual read operations + to complete. + externalDocs: + description: This option corresponds to the defaultMaxTimeMS cluster parameter. + url: https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/defaultMaxTimeMS/ defaultWriteConcern: type: string description: Default level of acknowledgment requested from MongoDB for @@ -27089,8 +27993,10 @@ components: url: https://docs.mongodb.com/manual/reference/write-concern/ javascriptEnabled: type: boolean - description: Flag that indicates whether the cluster allows execution of - operations that perform server-side executions of JavaScript. + 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. @@ -27375,7 +28281,7 @@ components: outage simulation. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true groupId: type: string @@ -28190,6 +29096,7 @@ components: mapping: AWS: "#/components/schemas/AWSCreateDataProcessRegionView" AZURE: "#/components/schemas/AzureCreateDataProcessRegionView" + GCP: "#/components/schemas/GCPCreateDataProcessRegionView" propertyName: cloudProvider properties: cloudProvider: @@ -28672,11 +29579,11 @@ components: roleId: type: string description: Unique identifier of the role that Data Federation can use - to access the data stores.Required if specifying cloudProviderConfig. + to access the data stores. Required if specifying cloudProviderConfig. servicePrincipalId: type: string description: The ID of the Service Principal for which there is an access - policyfor Atlas to access Azure resources. + policy for Atlas to access Azure resources. readOnly: true tenantId: type: string @@ -28685,6 +29592,22 @@ components: readOnly: true required: - roleId + DataFederationGCPCloudProviderConfig: + type: object + description: Configuration for running Data Federation in GCP. + 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: + type: string + description: Unique identifier of the role that Data Federation can use + to access the data stores. Required if specifying cloudProviderConfig. + required: + - roleId DataFederationLimit: type: object description: Details of user managed limits. @@ -28692,6 +29615,7 @@ components: mapping: atlas.project.deployment.clusters: "#/components/schemas/DefaultLimit" atlas.project.deployment.nodesPerPrivateLinkRegion: "#/components/schemas/DefaultLimit" + atlas.project.deployment.salesSoldM0s: "#/components/schemas/DefaultLimit" atlas.project.deployment.serverlessMTMs: "#/components/schemas/DefaultLimit" atlas.project.security.databaseAccess.customRoles: "#/components/schemas/DefaultLimit" atlas.project.security.databaseAccess.users: "#/components/schemas/DefaultLimit" @@ -29062,7 +29986,9 @@ components: $ref: "#/components/schemas/DataLakeAWSCloudProviderConfig" azure: $ref: "#/components/schemas/DataFederationAzureCloudProviderConfig" - title: Data Lake Cloud Provider + gcp: + $ref: "#/components/schemas/DataFederationGCPCloudProviderConfig" + title: Data Federation Cloud Provider DataLakeDLSAWSStore: type: object allOf: @@ -29187,6 +30113,7 @@ components: enum: - AWS - AZURE + - GCP region: $ref: "#/components/schemas/BaseAtlasDataLakeRegion" required: @@ -29663,7 +30590,7 @@ components: example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -29922,7 +30849,12 @@ components: enum: - AVERAGE operator: - $ref: "#/components/schemas/Operator" + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - LESS_THAN + - GREATER_THAN threshold: type: number format: double @@ -29970,6 +30902,7 @@ components: mapping: AWS: "#/components/schemas/AWSDataProcessRegionView" AZURE: "#/components/schemas/AzureDataProcessRegionView" + GCP: "#/components/schemas/GCPDataProcessRegionView" propertyName: cloudProvider properties: cloudProvider: @@ -29979,6 +30912,7 @@ components: enum: - AWS - AZURE + - GCP readOnly: true readOnly: true DataProtectionSettings: @@ -30270,6 +31204,8 @@ components: - SQL_SET_SCHEMA - VIEW_ALL_HISTORY - OUT_TO_S3 + - OUT_TO_AZURE + - OUT_TO_GCS - STORAGE_GET_CONFIG - STORAGE_SET_CONFIG - FLUSH_ROUTER_CONFIG @@ -30629,6 +31565,7 @@ components: - FTS_INDEX_BUILD_COMPLETE - FTS_INDEX_BUILD_FAILED - FTS_INDEXES_RESTORE_FAILED + - FTS_INDEXES_SYNONYM_MAPPING_INVALID title: FTS Index Audit Types - type: string enum: @@ -30829,6 +31766,7 @@ components: - FTS_INDEX_BUILD_COMPLETE - FTS_INDEX_BUILD_FAILED - FTS_INDEXES_RESTORE_FAILED + - FTS_INDEXES_SYNONYM_MAPPING_INVALID title: FTS Index Audit Types - type: string enum: @@ -31284,11 +32222,14 @@ components: - CLUSTER_VERSION_UNFIXED - CLUSTER_FCV_FIXED - CLUSTER_FCV_UNFIXED + - CLUSTER_FCV_EXPIRATION_DATE_UPDATED - AGENT_VERSION_FIXED - AGENT_VERSION_UNFIXED - FIXED_VERSION_UPDATED - FIXED_AGENT_VERSION_UPDATED - CLUSTER_FCV_DOWNGRADED + - CLUSTER_BINARY_VERSION_DOWNGRADED + - CLUSTER_BINARY_VERSION_UPGRADED title: Version Audit Types groupId: type: string @@ -31676,7 +32617,6 @@ components: pattern: "^([a-f0-9]{24})$" hostnameSchemaType: type: string - default: PUBLIC description: The network type to use between the migration host and the destination cluster. enum: @@ -31877,30 +32817,19 @@ components: createdAt: type: string format: date-time - description: Date and time when someone created this export job. MongoDB - Cloud represents this timestamp in ISO 8601 format in UTC. + description: Date and time when a user or Atlas created the Export Job. + MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. readOnly: true customData: type: array description: Collection of key-value pairs that represent custom data for - the metadata file that MongoDB Cloud uploads to the bucket when the export - job finishes. + the metadata file that MongoDB Cloud uploads when the Export Job finishes. items: $ref: "#/components/schemas/BackupLabel" - 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\"`." - items: - type: string - description: One Uniform Resource Locator that point to the compressed - snapshot files for manual download. - readOnly: true exportBucketId: type: string description: Unique 24-hexadecimal character string that identifies the - Export Bucket to export to. + Export Bucket. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 @@ -31911,7 +32840,7 @@ components: finishedAt: type: string format: date-time - description: Date and time when this export job completed. MongoDB Cloud + description: Date and time when this Export Job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. readOnly: true id: @@ -31936,8 +32865,8 @@ components: readOnly: true prefix: type: string - description: Full path on the cloud provider bucket to the folder where - the snapshot is exported. + description: Prefix used for all blob storage objects uploaded as part of + the Export Job. pattern: "/exported_snapshots/\\{ORG-NAME\\}/\\{PROJECT-NAME\\}/\\{CLUSTER-NAME\\\ }/\\{SNAPSHOT-INITIATION-DATE\\}/\\{TIMESTAMP\\}" readOnly: true @@ -31951,7 +32880,7 @@ components: pattern: "^([a-f0-9]{24})$" state: type: string - description: State of the export job. + description: State of the Export Job. enum: - Cancelled - Failed @@ -31974,7 +32903,7 @@ components: exportBucketId: type: string description: Unique 24-hexadecimal character string that identifies the - Export Bucket to export to. + Export Bucket. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 @@ -32181,10 +33110,19 @@ components: properties: downloadUrl: type: string - description: "One Uniform Resource Locator that point to the compressed\ + 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." + items: + $ref: "#/components/schemas/ApiPrivateDownloadDeliveryUrl" + readOnly: true replicaSetName: type: string description: Human-readable label that identifies the replica set on the @@ -32636,7 +33574,7 @@ components: \ this parameter when `\"deliveryType\" : \"download\"`." items: type: string - description: One Uniform Resource Locator that point to the compressed + description: One Uniform Resource Locator that points to the compressed snapshot files for manual download. readOnly: true desiredTimestamp: @@ -32708,6 +33646,15 @@ components: \ when `\"deliveryType\" : \"pointInTime\"` and **pointInTimeUTCSeconds**\ \ exceeds `0`." minimum: 1199145600 + 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." + items: + $ref: "#/components/schemas/ApiPrivateDownloadDeliveryUrl" + readOnly: true snapshotId: type: string description: Unique 24-hexadecimal character string that identifies the @@ -32724,7 +33671,7 @@ components: and `pointInTime` restore types. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" targetGroupId: type: string description: Unique 24-hexadecimal digit string that identifies the target @@ -32765,7 +33712,7 @@ components: you want to return. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true copySettings: type: array @@ -32859,7 +33806,7 @@ components: you want to return. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true copySettings: type: array @@ -32945,8 +33892,12 @@ components: additionalProperties: type: object description: The stats associated with the stream processor. + externalDocs: + url: https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor readOnly: true description: The stats associated with the stream processor. + externalDocs: + url: https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor readOnly: true EARPrivateEndpoint: type: object @@ -33041,6 +33992,8 @@ components: - PENDING_ACCEPTANCE - ACTIVE - FAILED + - PENDING_RECREATION + - DELETING readOnly: true title: Encryption At Rest Private Endpoint EmailNotification: @@ -33087,6 +34040,36 @@ components: required: - typeName title: Email Notification + EmployeeAccessGrantView: + type: object + description: MongoDB employee granted access level and expiration for a cluster. + properties: + expirationTime: + type: string + format: date-time + description: Expiration date for the employee access grant. + 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." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + readOnly: true + required: + - expirationTime + - grantType EncryptionAtRest: type: object properties: @@ -33096,24 +34079,6 @@ components: $ref: "#/components/schemas/AzureKeyVault" googleCloudKms: $ref: "#/components/schemas/GoogleCloudKMS" - EncryptionAtRestPrivateEndpointRequest: - type: object - description: Create or delete private endpoints from the specified regions list. - properties: - cloudProvider: - type: string - description: Cloud service provider name. - enum: - - AZURE - regions: - type: array - description: List of regions. - items: - type: string - uniqueItems: true - required: - - cloudProvider - title: Encryption At Rest Private Endpoints setup. EncryptionKeyAlertConfigViewForNdsGroup: type: object description: Encryption key alert configuration allows to select thresholds which @@ -33460,6 +34425,7 @@ components: - FTS_INDEX_CLEANED_UP - FTS_INDEXES_RESTORED - FTS_INDEXES_RESTORE_FAILED + - FTS_INDEXES_SYNONYM_MAPPING_INVALID title: FTS Index Audit Types - type: string enum: @@ -33513,6 +34479,8 @@ components: - HOST_HAS_INDEX_SUGGESTIONS - HOST_MONGOT_RECOVERED_OOM - HOST_MONGOT_CRASHING_OOM + - HOST_MONGOT_RESUME_REPLICATION + - HOST_MONGOT_STOP_REPLICATION - HOST_ENOUGH_DISK_SPACE - HOST_NOT_ENOUGH_DISK_SPACE title: Host Event Types @@ -33550,6 +34518,7 @@ components: - 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 @@ -33627,6 +34596,8 @@ components: - 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 @@ -33656,6 +34627,9 @@ components: - 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 @@ -33714,9 +34688,13 @@ components: - 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 title: NDS Audit Types - type: string enum: @@ -33913,11 +34891,14 @@ components: - CLUSTER_VERSION_UNFIXED - CLUSTER_FCV_FIXED - CLUSTER_FCV_UNFIXED + - CLUSTER_FCV_EXPIRATION_DATE_UPDATED - AGENT_VERSION_FIXED - AGENT_VERSION_UNFIXED - FIXED_VERSION_UPDATED - FIXED_AGENT_VERSION_UPDATED - CLUSTER_FCV_DOWNGRADED + - CLUSTER_BINARY_VERSION_DOWNGRADED + - CLUSTER_BINARY_VERSION_UPGRADED title: Version Audit Types - type: string enum: @@ -34193,6 +35174,12 @@ components: enum: - GROUP_TAGS_MODIFIED title: Resource Event Types + - type: string + enum: + - RESOURCE_POLICY_CREATED + - RESOURCE_POLICY_MODIFIED + - RESOURCE_POLICY_DELETED + title: Atlas Resource Policy Audit Types EventViewForNdsGroup: type: object oneOf: @@ -34234,6 +35221,7 @@ components: - $ref: "#/components/schemas/TeamEvent" - $ref: "#/components/schemas/UserEventViewForOrg" - $ref: "#/components/schemas/ResourceEventViewForOrg" + - $ref: "#/components/schemas/AtlasResourcePolicyAuditForOrg" ExampleResourceResponse20230101: type: object properties: @@ -34283,8 +35271,7 @@ components: - description ExportStatus: type: object - description: State of the export job for the collections on the replica set - only. + description: State of the Export Job. properties: exportedCollections: type: integer @@ -34330,6 +35317,7 @@ components: - FTS_INDEX_CLEANED_UP - FTS_INDEXES_RESTORED - FTS_INDEXES_RESTORE_FAILED + - FTS_INDEXES_SYNONYM_MAPPING_INVALID example: FTS_INDEX_CREATED title: FTS Index Audit Types FTSIndexAuditView: @@ -35257,37 +36245,52 @@ components: enum: - EXCLUDE title: Field Transformation - ForNdsGroup: + FieldViolation: type: object - description: ReplicaSet Event identifies different activities about replica - set of mongod instances. properties: - created: + description: type: string - format: date-time - description: Date and time when this event occurred. This parameter expresses - its value in the ISO 8601 timestamp format in UTC. + 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. + required: + - description + - field + FlexBackupRestoreJob20250101: + type: object + description: Details for one restore job of a flex cluster. + properties: + deliveryType: + type: string + description: Means by which this resource returns the snapshot to the requesting + MongoDB Cloud user. + enum: + - RESTORE + - DOWNLOAD readOnly: true - eventTypeName: - $ref: "#/components/schemas/ReplicaSetEventTypeViewForNdsGroup" - groupId: + expirationDate: type: string - description: Unique 24-hexadecimal digit string that identifies the project - in which the event occurred. The **eventId** identifies the specific event. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" + format: date-time + description: Date and time when the download link no longer works. This + parameter expresses its value in the ISO 8601 timestamp format in UTC. readOnly: true id: type: string - description: Unique 24-hexadecimal digit string that identifies the event. + description: Unique 24-hexadecimal digit string that identifies the restore + job. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true + instanceName: + type: string + description: Human-readable label that identifies the source instance. + maxLength: 64 + minLength: 1 + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + readOnly: true links: type: array description: "List of one or more Uniform Resource Locators (URLs) that\ @@ -35299,656 +36302,296 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true - orgId: + projectId: type: string - description: Unique 24-hexadecimal digit string that identifies the organization - to which these events apply. + description: Unique 24-hexadecimal digit string that identifies the project + from which the restore job originated. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true - port: - type: integer - format: int32 - description: IANA port on which the MongoDB process listens for requests. - example: 27017 - readOnly: true - raw: - $ref: "#/components/schemas/raw" - replicaSetName: + restoreFinishedDate: type: string - description: Human-readable label of the replica set associated with the - event. - example: event-replica-set + format: date-time + 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. readOnly: true - shardName: + restoreScheduledDate: type: string - description: Human-readable label of the shard associated with the event. - example: event-sh-01 + format: date-time + description: Date and time when MongoDB Cloud will restore this snapshot. + This parameter expresses its value in the ISO 8601 timestamp format in + UTC. readOnly: true - required: - - created - - eventTypeName - - id - title: ReplicaSet Events - GCPCloudProviderContainer: - type: object - allOf: - - $ref: "#/components/schemas/CloudProviderContainer" - - type: object - properties: - atlasCidrBlock: - type: string - description: |- - IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project. - - These CIDR blocks must fall within the ranges reserved per RFC 1918. GCP further limits the block to a lower bound of the `/18` range. - - To modify the CIDR block, the target project cannot have: - - - Any M10 or greater clusters - - Any other VPC peering connections - - You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project. - - **Example:** A project in an Google Cloud (GCP) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets. - pattern: "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" - gcpProjectId: - 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. - maxLength: 26 - minLength: 26 - pattern: "^p-[0-9a-z]{24}$" - readOnly: true - networkName: - 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. - maxLength: 36 - minLength: 36 - pattern: "^nt-[0-9a-f]{24}-[0-9a-z]{8}$" - 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." - 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." - 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 - description: Collection of settings that configures the network container for - a virtual private connection on Amazon Web Services. - required: - - atlasCidrBlock - title: GCP - GCPComputeAutoScaling: - type: object - description: Collection of settings that configures how a cluster might scale - its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling - is unavailable for clusters using Low CPU or NVME storage classes. - properties: - maxInstanceSize: - type: string - description: Maximum instance size to which your cluster can automatically - scale. - enum: - - M10 - - M20 - - M30 - - M40 - - M50 - - M60 - - M80 - - M140 - - M200 - - M250 - - M300 - - M400 - - R40 - - R50 - - R60 - - R80 - - R200 - - R300 - - R400 - - R600 - title: GCP Instance Sizes - minInstanceSize: + snapshotFinishedDate: 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 - title: GCP Instance Sizes - title: GCP - GCPConsumerForwardingRule: - type: object - properties: - endpointName: + format: date-time + description: Date and time when MongoDB Cloud completed writing this snapshot. + This parameter expresses its value in the ISO 8601 timestamp format in + UTC. + readOnly: true + snapshotId: type: string - description: Human-readable label that identifies the Google Cloud consumer - forwarding rule that you created. - externalDocs: - description: Google Cloud Forwarding Rule Concepts - url: https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts + description: Unique 24-hexadecimal digit string that identifies the snapshot + to restore. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" readOnly: true - ipAddress: + snapshotUrl: type: string - description: One Private Internet Protocol version 4 (IPv4) address to which - this Google Cloud consumer forwarding rule resolves. - pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + 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: State of the MongoDB Cloud endpoint group when MongoDB Cloud - received this request. + description: Phase of the restore workflow for this job at the time this + resource made this request. enum: - - INITIATING - - AVAILABLE + - PENDING + - QUEUED + - RUNNING - FAILED - - DELETING + - COMPLETED readOnly: true - GCPEndpointService: + targetDeploymentItemName: + type: string + description: Human-readable label that identifies the instance or cluster + on the target project to which you want to restore the snapshot. You can + restore the snapshot to another USS instance or Dedicated cluster tier. + maxLength: 64 + minLength: 1 + pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + readOnly: true + targetProjectId: + type: string + description: Unique 24-hexadecimal digit string that identifies the project + that contains the instance or cluster to which you want to restore the + snapshot. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + title: Flex Backup Restore Job + FlexBackupRestoreJobCreate20250101: type: object - description: Group of Private Endpoint Service settings. + description: Details to create one restore job of a flex cluster. properties: - cloudProvider: + _snapshotId: type: string - description: Cloud service provider that serves the requested endpoint service. + description: Unique 24-hexadecimal digit string that identifies the snapshot + to restore. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + writeOnly: true + _targetDeploymentItemName: + type: string + description: Human-readable label that identifies the instance or cluster + on the target project to which you want to restore the snapshot. You can + restore the snapshot to another flex cluster or dedicated cluster tier. + maxLength: 64 + minLength: 1 + pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + writeOnly: true + _targetProjectId: + type: string + description: Unique 24-hexadecimal digit string that identifies the project + that contains the instance or cluster to which you want to restore the + snapshot. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + writeOnly: true + deliveryType: + type: string + description: Means by which this resource returns the snapshot to the requesting + MongoDB Cloud user. enum: - - AWS - - AZURE - - GCP + - RESTORE + - DOWNLOAD readOnly: true - 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 - items: - type: string - description: One Google Cloud network endpoint group that corresponds - to the Private Service Connect endpoint service. - errorMessage: + expirationDate: type: string - description: Error message returned when requesting private connection resource. - The resource returns `null` if the request succeeded. + format: date-time + description: Date and time when the download link no longer works. This + parameter expresses its value in the ISO 8601 timestamp format in UTC. readOnly: true id: type: string - description: Unique 24-hexadecimal digit string that identifies the Private - Endpoint Service. + description: Unique 24-hexadecimal digit string that identifies the restore + job. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true - regionName: + instanceName: type: string - description: Cloud provider region that manages this Private Endpoint Service. + description: Human-readable label that identifies the source instance. + maxLength: 64 + minLength: 1 + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true - serviceAttachmentNames: + links: 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. + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." externalDocs: - description: Google Cloud Private Service Connect Service Attachments - url: https://cloud.google.com/vpc/docs/private-service-connect#service-attachments + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 items: - 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. - 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\\-]+" - status: + $ref: "#/components/schemas/Link" + readOnly: true + projectId: type: string - description: State of the Private Endpoint Service connection when MongoDB - Cloud received this request. - enum: - - INITIATING - - AVAILABLE - - WAITING_FOR_USER - - FAILED - - DELETING - readOnly: true - required: - - cloudProvider - title: GCP - GCPHardwareSpec: - type: object - properties: - instanceSize: - type: string - description: Hardware specification for the instance sizes in this region. - Each instance size has a default storage and memory capacity. The instance - size you select applies to all the data-bearing hosts 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 - title: GCP Instance Sizes - nodeCount: - type: integer - format: int32 - description: Number of nodes of the given type for MongoDB Cloud to deploy - to the region. - GCPHardwareSpec20240805: - type: object - properties: - diskSizeGB: - type: number - format: double - description: "Storage capacity of instance data volumes expressed in gigabytes.\ - \ Increase this number to add capacity.\n\n This value must be equal for\ - \ all shards and node types.\n\n This value is not configurable on M0/M2/M5\ - \ clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\ - \n If you specify a disk size below the minimum (10 GB), this parameter\ - \ defaults to the minimum disk size value. \n\n Storage charge calculations\ - \ depend on whether you choose the default value or a custom value.\n\n\ - \ The maximum value for disk storage cannot exceed 50 times the maximum\ - \ RAM for the selected cluster. If you require more storage space, consider\ - \ upgrading your cluster to a higher tier." - maximum: 4096 - minimum: 10 - instanceSize: - type: string - description: Hardware specification for the instance sizes in this region - in this shard. Each instance size has a default storage and memory capacity. - Electable nodes and read-only nodes (known as "base nodes") within a single - shard must use the same instance size. Analytics nodes can scale independently - from base nodes within a shard. Both base nodes and analytics nodes can - scale independently from their equivalents in other shards. - enum: - - M10 - - M20 - - M30 - - M40 - - M50 - - M60 - - M80 - - M140 - - M200 - - M250 - - M300 - - M400 - - R40 - - R50 - - R60 - - R80 - - R200 - - R300 - - R400 - - R600 - title: GCP Instance Sizes - nodeCount: - type: integer - format: int32 - description: Number of nodes of the given type for MongoDB Cloud to deploy - to the region. - GCPNetworkPeeringConnectionSettings: - type: object - description: Group of Network Peering connection settings. - properties: - containerId: - type: string - description: Unique 24-hexadecimal digit string that identifies the MongoDB - Cloud network container that contains the specified network peering connection. + description: Unique 24-hexadecimal digit string that identifies the project + from which the restore job originated. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" - 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: + restoreFinishedDate: 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. - maxLength: 30 - minLength: 6 - pattern: "^[a-z][0-9a-z-]{4,28}[0-9a-z]{1}" - id: + format: date-time + 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. + readOnly: true + restoreScheduledDate: type: string - description: Unique 24-hexadecimal digit string that identifies the network - peering connection. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" + format: date-time + description: Date and time when MongoDB Cloud will restore this snapshot. + This parameter expresses its value in the ISO 8601 timestamp format in + UTC. readOnly: true - networkName: + snapshotFinishedDate: type: string - description: Human-readable label that identifies the network to peer with - the MongoDB Cloud VPC. - maxLength: 63 - minLength: 1 - pattern: "[a-z]([-a-z0-9]{0,62}[a-z0-9]{0,1})?" - providerName: + format: date-time + description: Date and time when MongoDB Cloud completed writing this snapshot. + This parameter expresses its value in the ISO 8601 timestamp format in + UTC. + readOnly: true + snapshotUrl: type: string - description: Cloud service provider that serves the requested network peering - connection. - enum: - - AWS - - AZURE - - GCP + 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: State of the network peering connection at the time you made - the request. + description: Phase of the restore workflow for this job at the time this + resource made this request. enum: - - ADDING_PEER - - WAITING_FOR_USER - - AVAILABLE + - PENDING + - QUEUED + - RUNNING - FAILED - - DELETING + - COMPLETED readOnly: true required: - - containerId - - gcpProjectId - - networkName - title: GCP - GCPRegionConfig: - type: object - allOf: - - $ref: "#/components/schemas/CloudRegionConfig" - - type: object - properties: - analyticsAutoScaling: - $ref: "#/components/schemas/AdvancedAutoScalingSettings" - analyticsSpecs: - $ref: "#/components/schemas/DedicatedHardwareSpec" - autoScaling: - $ref: "#/components/schemas/AdvancedAutoScalingSettings" - readOnlySpecs: - $ref: "#/components/schemas/DedicatedHardwareSpec" - description: Details that explain how MongoDB Cloud replicates data in one region - on the specified MongoDB database. - title: GCP Regional Replication Specifications - GCPRegionConfig20240805: - type: object - allOf: - - $ref: "#/components/schemas/CloudRegionConfig20240805" - - type: object - properties: - analyticsAutoScaling: - $ref: "#/components/schemas/AdvancedAutoScalingSettings" - analyticsSpecs: - $ref: "#/components/schemas/DedicatedHardwareSpec20240805" - autoScaling: - $ref: "#/components/schemas/AdvancedAutoScalingSettings" - readOnlySpecs: - $ref: "#/components/schemas/DedicatedHardwareSpec20240805" - description: Details that explain how MongoDB Cloud replicates data in one region - on the specified MongoDB database. - title: GCP Regional Replication Specifications - GeoSharding: + - _snapshotId + - _targetDeploymentItemName + title: Create Flex Backup Restore Job + FlexBackupSettings20250101: type: object + description: Flex backup configuration properties: - customZoneMapping: - type: object - additionalProperties: - 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 - 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. - items: - $ref: "#/components/schemas/ManagedNamespaces" - readOnly: true - selfManagedSharding: + enabled: 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. + default: true + description: "Flag that indicates whether backups are performed for this\ + \ flex cluster. Backup uses [TODO](TODO) for flex clusters." readOnly: true - GeoSharding20240805: + readOnly: true + title: Flex Backup Configuration + FlexBackupSnapshot20250101: type: object + description: Details for one snapshot of a flex cluster. properties: - customZoneMapping: - type: object - additionalProperties: - type: string - description: |- - List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone. - - The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property. - - This parameter returns an empty object if no custom zones exist. - readOnly: true - description: |- - List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone. - - The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property. - - This parameter returns an empty object if no custom zones exist. - readOnly: true - managedNamespaces: - type: array - description: List that contains a namespace for a Global Cluster. MongoDB - Cloud manages this cluster. - items: - $ref: "#/components/schemas/ManagedNamespaces" - readOnly: true - 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. + expiration: + type: string + format: date-time + description: Date and time when the download link no longer works. This + parameter expresses its value in the ISO 8601 timestamp format in UTC. readOnly: true - GoogleCloudKMS: - type: object - description: Details that define the configuration of Encryption at Rest using - Google Cloud Key Management Service (KMS). - externalDocs: - description: Google Cloud Key Management Service - url: https://www.mongodb.com/docs/atlas/security-gcp-kms/ - properties: - enabled: - 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: + finishTime: 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 - serviceAccountKey: + format: date-time + description: Date and time when MongoDB Cloud completed writing this snapshot. + This parameter expresses its value in the ISO 8601 timestamp format in + UTC. + readOnly: true + id: type: string - description: 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. + description: Unique 24-hexadecimal digit string that identifies the snapshot. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." externalDocs: - description: Google Cloud Authentication - url: https://cloud.google.com/docs/authentication/getting-started - writeOnly: true - valid: - type: boolean - description: Flag that indicates whether the Google Cloud Key Management - Service (KMS) encryption key can encrypt and decrypt data. + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" readOnly: true - GreaterThanDaysThresholdView: - type: object - description: Threshold value that triggers an alert. - properties: - operator: - type: string - description: Comparison operator to apply when checking the current metric - value. - enum: - - GREATER_THAN - threshold: - type: integer - format: int32 - description: "Value of metric that, when exceeded, triggers an alert." - units: + mongoDBVersion: type: string - description: "Element used to express the quantity. This can be an element\ - \ of time, storage capacity, and the like." - enum: - - DAYS - GreaterThanRawThreshold: - type: object - description: A Limit that triggers an alert when greater than a number. - properties: - operator: + description: MongoDB host version that the snapshot runs. + readOnly: true + scheduledTime: type: string - description: Comparison operator to apply when checking the current metric - value. - enum: - - GREATER_THAN - threshold: - type: integer - format: int32 - description: "Value of metric that, when exceeded, triggers an alert." - units: - $ref: "#/components/schemas/RawMetricUnits" - title: Greater Than Raw Threshold - GreaterThanRawThresholdAlertConfigViewForNdsGroup: - type: object - properties: - created: + format: date-time + description: Date and time when MongoDB Cloud will take the snapshot. This + parameter expresses its value in the ISO 8601 timestamp format in UTC. + readOnly: true + startTime: type: string format: date-time - description: Date and time when MongoDB Cloud created the alert configuration. - This parameter expresses its value in the ISO 8601 timestamp format - in UTC. + description: Date and time when MongoDB Cloud began taking the snapshot. + This parameter expresses its value in the ISO 8601 timestamp format in + UTC. readOnly: true - enabled: - type: boolean - default: false - description: Flag that indicates whether someone enabled this alert configuration - for the specified project. - eventTypeName: - $ref: "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" - groupId: + status: type: string - description: Unique 24-hexadecimal digit string that identifies the project - that owns this alert configuration. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" + description: Phase of the workflow for this snapshot at the time this resource + made this request. + enum: + - PENDING + - QUEUED + - RUNNING + - FAILED + - COMPLETED readOnly: true - id: + title: Flex Backup Snapshot + FlexBackupSnapshotDownloadCreate20250101: + type: object + description: Details for one backup snapshot download of a flex cluster. + properties: + _snapshotId: type: string - description: Unique 24-hexadecimal digit string that identifies this alert - configuration. + description: Unique 24-hexadecimal digit string that identifies the snapshot + to download. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" - readOnly: true + writeOnly: true links: type: array description: "List of one or more Uniform Resource Locators (URLs) that\ @@ -35960,67 +36603,42 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true - matchers: - type: array - description: "List of rules that determine whether MongoDB Cloud checks\ - \ an object for the alert configuration. You can filter using the matchers\ - \ array if the **eventTypeName** specifies an event for a host, replica\ - \ set, or sharded cluster." - items: - $ref: "#/components/schemas/ReplicaSetMatcher" - notifications: - type: array - description: List that contains the targets that MongoDB Cloud sends notifications. - items: - $ref: "#/components/schemas/AlertsNotificationRootForGroup" - threshold: - $ref: "#/components/schemas/GreaterThanRawThreshold" - updated: - type: string - format: date-time - description: Date and time when someone last updated this alert configuration. - This parameter expresses its value in the ISO 8601 timestamp format - in UTC. - readOnly: true required: - - eventTypeName - - notifications - GreaterThanTimeThreshold: + - _snapshotId + title: Flex Backup Snapshot Download Create + FlexClusterDescription20250101: type: object - description: A Limit that triggers an alert when greater than a time period. + description: Group of settings that configure a MongoDB Flex cluster. properties: - operator: + backupSettings: + $ref: "#/components/schemas/FlexBackupSettings20250101" + clusterType: type: string - description: Comparison operator to apply when checking the current metric - value. + description: Flex cluster topology. enum: - - GREATER_THAN - threshold: - type: integer - format: int32 - description: "Value of metric that, when exceeded, triggers an alert." - units: - $ref: "#/components/schemas/TimeMetricUnits" - title: Greater Than Time Threshold - Group: - type: object - properties: - clusterCount: - type: integer - format: int64 - description: Quantity of MongoDB Cloud clusters deployed in this project. + - REPLICASET + - LOADBALANCED readOnly: true - created: + connectionStrings: + $ref: "#/components/schemas/FlexConnectionStrings20250101" + createDate: type: string format: date-time - description: Date and time when MongoDB Cloud created this project. This - parameter expresses its value in the ISO 8601 timestamp format in UTC. + description: Date and time when MongoDB Cloud created this instance. This + parameter expresses its value in ISO 8601 format in UTC. + readOnly: true + groupId: + type: string + description: Unique 24-hexadecimal character string that identifies the + project. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" readOnly: true id: type: string - description: Unique 24-hexadecimal digit string that identifies the MongoDB - Cloud project. + description: Unique 24-hexadecimal digit string that identifies the instance. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 @@ -36037,18 +36655,1021 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true + mongoDBVersion: + type: string + description: Version of MongoDB that the instance runs. + pattern: "([\\d]+\\.[\\d]+\\.[\\d]+)" + readOnly: true name: type: string - description: Human-readable label that identifies the project included in - the MongoDB Cloud organization. + description: Human-readable label that identifies the instance. maxLength: 64 minLength: 1 - pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" - orgId: + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + readOnly: true + providerSettings: + $ref: "#/components/schemas/FlexProviderSettings20250101" + stateName: type: string - description: Unique 24-hexadecimal digit string that identifies the MongoDB - Cloud organization to which the project belongs. - example: 32b6e34b3d91647abb20e7b8 + description: Human-readable label that indicates the current operating condition + of this instance. + enum: + - IDLE + - CREATING + - UPDATING + - DELETING + - REPAIRING + readOnly: true + tags: + type: array + description: List that contains key-value pairs between 1 to 255 characters + in length for tagging and categorizing the instance. + externalDocs: + description: Resource Tags + url: https://dochub.mongodb.org/core/add-cluster-tag-atlas + items: + $ref: "#/components/schemas/ResourceTag" + terminationProtectionEnabled: + type: boolean + default: false + description: "Flag that indicates whether termination protection is enabled\ + \ on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster.\ + \ If set to `false`, MongoDB Cloud will delete the cluster." + versionReleaseSystem: + type: string + default: LTS + description: Method by which the cluster maintains the MongoDB versions. + enum: + - LTS + readOnly: true + required: + - providerSettings + title: Flex Cluster Description + FlexClusterDescriptionCreate20250101: + type: object + description: Settings that you can specify when you create a flex cluster. + properties: + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + name: + type: string + description: Human-readable label that identifies the instance. + maxLength: 64 + minLength: 1 + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + writeOnly: true + providerSettings: + $ref: "#/components/schemas/FlexProviderSettingsCreate20250101" + tags: + type: array + description: List that contains key-value pairs between 1 to 255 characters + in length for tagging and categorizing the instance. + externalDocs: + description: Resource Tags + url: https://dochub.mongodb.org/core/add-cluster-tag-atlas + items: + $ref: "#/components/schemas/ResourceTag" + terminationProtectionEnabled: + type: boolean + default: false + description: "Flag that indicates whether termination protection is enabled\ + \ on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster.\ + \ If set to `false`, MongoDB Cloud will delete the cluster." + required: + - name + - providerSettings + title: Flex Cluster Description Create + FlexConnectionStrings20250101: + type: object + description: Collection of Uniform Resource Locators that point to the MongoDB + database. + externalDocs: + description: Connection string URI format. + url: https://docs.mongodb.com/manual/reference/connection-string/ + properties: + standard: + type: string + description: Public connection string that you can use to connect to this + cluster. This connection string uses the mongodb:// protocol. + externalDocs: + description: Connection String URI Format + url: https://docs.mongodb.com/manual/reference/connection-string/ + readOnly: true + standardSrv: + type: string + description: Public connection string that you can use to connect to this + flex cluster. This connection string uses the `mongodb+srv://` protocol. + externalDocs: + description: Connection String URI Format + url: https://docs.mongodb.com/manual/reference/connection-string/ + readOnly: true + readOnly: true + title: Flex Cluster Connection Strings + FlexProviderSettings20250101: + type: object + description: Group of cloud provider settings that configure the provisioned + MongoDB flex cluster. + properties: + backingProviderName: + type: string + description: Cloud service provider on which MongoDB Cloud provisioned the + flex cluster. + enum: + - AWS + - AZURE + - GCP + readOnly: true + diskSizeGB: + type: number + format: double + description: Storage capacity available to the flex cluster expressed in + gigabytes. + readOnly: true + providerName: + type: string + default: FLEX + description: Human-readable label that identifies the cloud service provider. + enum: + - FLEX + readOnly: true + regionName: + type: string + description: "Human-readable label that identifies the geographic location\ + \ of your MongoDB flex cluster. The region you choose can affect network\ + \ latency for clients accessing your databases. For a complete list of\ + \ region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws),\ + \ [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/)." + readOnly: true + readOnly: true + title: Cloud Service Provider Settings for a Flex Cluster + FlexProviderSettingsCreate20250101: + type: object + description: Group of cloud provider settings that configure the provisioned + MongoDB flex cluster. + properties: + backingProviderName: + type: string + description: Cloud service provider on which MongoDB Cloud provisioned the + flex cluster. + enum: + - AWS + - AZURE + - GCP + writeOnly: true + diskSizeGB: + type: number + format: double + description: Storage capacity available to the flex cluster expressed in + gigabytes. + readOnly: true + providerName: + type: string + default: FLEX + description: Human-readable label that identifies the cloud service provider. + enum: + - FLEX + readOnly: true + regionName: + type: string + description: "Human-readable label that identifies the geographic location\ + \ of your MongoDB flex cluster. The region you choose can affect network\ + \ latency for clients accessing your databases. For a complete list of\ + \ region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws),\ + \ [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/)." + writeOnly: true + required: + - backingProviderName + - regionName + title: Cloud Service Provider Settings for a Flex Cluster + writeOnly: true + ForNdsGroup: + type: object + description: ReplicaSet Event identifies different activities about replica + set of mongod instances. + properties: + created: + type: string + format: date-time + description: Date and time when this event occurred. This parameter expresses + its value in the ISO 8601 timestamp format in UTC. + readOnly: true + eventTypeName: + $ref: "#/components/schemas/ReplicaSetEventTypeViewForNdsGroup" + groupId: + type: string + description: Unique 24-hexadecimal digit string that identifies the project + in which the event occurred. The **eventId** identifies the specific event. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + id: + type: string + description: Unique 24-hexadecimal digit string that identifies the event. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + orgId: + type: string + description: Unique 24-hexadecimal digit string that identifies the organization + to which these events apply. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + port: + type: integer + format: int32 + description: IANA port on which the MongoDB process listens for requests. + example: 27017 + readOnly: true + raw: + $ref: "#/components/schemas/raw" + replicaSetName: + type: string + description: Human-readable label of the replica set associated with the + event. + example: event-replica-set + readOnly: true + shardName: + type: string + description: Human-readable label of the shard associated with the event. + example: event-sh-01 + readOnly: true + required: + - created + - eventTypeName + - id + title: ReplicaSet Events + GCPCloudProviderContainer: + type: object + allOf: + - $ref: "#/components/schemas/CloudProviderContainer" + - type: object + properties: + atlasCidrBlock: + type: string + description: |- + IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project. + + These CIDR blocks must fall within the ranges reserved per RFC 1918. GCP further limits the block to a lower bound of the `/18` range. + + To modify the CIDR block, the target project cannot have: + + - Any M10 or greater clusters + - Any other VPC peering connections + + You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project. + + **Example:** A project in an Google Cloud (GCP) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets. + pattern: "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + gcpProjectId: + 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. + maxLength: 26 + minLength: 26 + pattern: "^p-[0-9a-z]{24}$" + readOnly: true + networkName: + 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. + maxLength: 36 + minLength: 36 + pattern: "^nt-[0-9a-f]{24}-[0-9a-z]{8}$" + 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." + 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." + 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 + description: Collection of settings that configures the network container for + a virtual private connection on Amazon Web Services. + required: + - atlasCidrBlock + title: GCP + GCPComputeAutoScaling: + type: object + description: Collection of settings that configures how a cluster might scale + its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling + is unavailable for clusters using Low CPU or NVME storage classes. + properties: + maxInstanceSize: + type: string + description: Maximum instance size to which your cluster can automatically + scale. + enum: + - M10 + - M20 + - M30 + - M40 + - M50 + - M60 + - M80 + - M140 + - M200 + - M250 + - M300 + - M400 + - R40 + - R50 + - R60 + - R80 + - R200 + - R300 + - R400 + - R600 + title: GCP Instance Sizes + minInstanceSize: + 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 + title: GCP Instance Sizes + title: GCP + GCPConsumerForwardingRule: + type: object + properties: + endpointName: + type: string + description: Human-readable label that identifies the Google Cloud consumer + forwarding rule that you created. + externalDocs: + description: Google Cloud Forwarding Rule Concepts + url: https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts + readOnly: true + ipAddress: + type: string + description: One Private Internet Protocol version 4 (IPv4) address to which + this Google Cloud consumer forwarding rule resolves. + pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + readOnly: true + status: + type: string + description: State of the MongoDB Cloud endpoint group when MongoDB Cloud + received this request. + enum: + - INITIATING + - AVAILABLE + - FAILED + - DELETING + readOnly: true + 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 + 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. + enum: + - CENTRAL_US + - WESTERN_EUROPE + readOnly: true + GCPEndpointService: + type: object + description: Group of Private Endpoint Service settings. + properties: + cloudProvider: + type: string + description: Cloud service provider that serves the requested endpoint service. + enum: + - AWS + - AZURE + - GCP + readOnly: true + 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 + 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: + type: string + description: Unique 24-hexadecimal digit string that identifies the Private + Endpoint Service. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + 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 + items: + 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. + 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\\-]+" + status: + type: string + description: State of the Private Endpoint Service connection when MongoDB + Cloud received this request. + enum: + - INITIATING + - AVAILABLE + - WAITING_FOR_USER + - FAILED + - DELETING + readOnly: true + required: + - cloudProvider + title: GCP + GCPHardwareSpec: + type: object + properties: + instanceSize: + type: string + description: Hardware specification for the instance sizes in this region. + Each instance size has a default storage and memory capacity. The instance + size you select applies to all the data-bearing hosts 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 + title: GCP Instance Sizes + nodeCount: + type: integer + format: int32 + description: Number of nodes of the given type for MongoDB Cloud to deploy + to the region. + GCPHardwareSpec20240805: + type: object + properties: + diskSizeGB: + type: number + format: double + description: "Storage capacity of instance data volumes expressed in gigabytes.\ + \ Increase this number to add capacity.\n\n This value must be equal for\ + \ all shards and node types.\n\n This value is not configurable on M0/M2/M5\ + \ clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\ + \n If you specify a disk size below the minimum (10 GB), this parameter\ + \ defaults to the minimum disk size value. \n\n Storage charge calculations\ + \ depend on whether you choose the default value or a custom value.\n\n\ + \ The maximum value for disk storage cannot exceed 50 times the maximum\ + \ RAM for the selected cluster. If you require more storage space, consider\ + \ upgrading your cluster to a higher tier." + maximum: 4096 + minimum: 10 + instanceSize: + type: string + description: Hardware specification for the instance sizes in this region + in this shard. Each instance size has a default storage and memory capacity. + Electable nodes and read-only nodes (known as "base nodes") within a single + shard must use the same instance size. Analytics nodes can scale independently + from base nodes within a shard. Both base nodes and analytics nodes can + scale independently from their equivalents in other shards. + enum: + - M10 + - M20 + - M30 + - M40 + - M50 + - M60 + - M80 + - M140 + - M200 + - M250 + - M300 + - M400 + - R40 + - R50 + - R60 + - R80 + - R200 + - R300 + - R400 + - R600 + title: GCP Instance Sizes + nodeCount: + type: integer + format: int32 + description: Number of nodes of the given type for MongoDB Cloud to deploy + to the region. + GCPNetworkPeeringConnectionSettings: + type: object + description: Group of Network Peering connection settings. + properties: + containerId: + type: string + description: Unique 24-hexadecimal digit string that identifies the MongoDB + Cloud network container that contains the specified network peering connection. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + 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: + 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. + maxLength: 30 + minLength: 6 + pattern: "^[a-z][0-9a-z-]{4,28}[0-9a-z]{1}" + id: + type: string + description: Unique 24-hexadecimal digit string that identifies the network + peering connection. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + networkName: + type: string + description: Human-readable label that identifies the network to peer with + the MongoDB Cloud VPC. + maxLength: 63 + minLength: 1 + pattern: "[a-z]([-a-z0-9]{0,62}[a-z0-9]{0,1})?" + 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. + enum: + - ADDING_PEER + - WAITING_FOR_USER + - AVAILABLE + - FAILED + - DELETING + readOnly: true + required: + - containerId + - gcpProjectId + - networkName + title: GCP + GCPRegionConfig: + type: object + allOf: + - $ref: "#/components/schemas/CloudRegionConfig" + - type: object + properties: + analyticsAutoScaling: + $ref: "#/components/schemas/AdvancedAutoScalingSettings" + analyticsSpecs: + $ref: "#/components/schemas/DedicatedHardwareSpec" + autoScaling: + $ref: "#/components/schemas/AdvancedAutoScalingSettings" + readOnlySpecs: + $ref: "#/components/schemas/DedicatedHardwareSpec" + description: Details that explain how MongoDB Cloud replicates data in one region + on the specified MongoDB database. + title: GCP Regional Replication Specifications + GCPRegionConfig20240805: + type: object + allOf: + - $ref: "#/components/schemas/CloudRegionConfig20240805" + - type: object + properties: + analyticsAutoScaling: + $ref: "#/components/schemas/AdvancedAutoScalingSettings" + analyticsSpecs: + $ref: "#/components/schemas/DedicatedHardwareSpec20240805" + autoScaling: + $ref: "#/components/schemas/AdvancedAutoScalingSettings" + readOnlySpecs: + $ref: "#/components/schemas/DedicatedHardwareSpec20240805" + description: Details that explain how MongoDB Cloud replicates data in one region + on the specified MongoDB database. + title: GCP Regional Replication Specifications + GeoSharding: + type: object + properties: + customZoneMapping: + type: object + additionalProperties: + 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 + 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. + items: + $ref: "#/components/schemas/ManagedNamespaces" + readOnly: true + 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 + GeoSharding20240805: + type: object + properties: + customZoneMapping: + type: object + additionalProperties: + type: string + description: |- + List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone. + + The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property. + + This parameter returns an empty object if no custom zones exist. + readOnly: true + description: |- + List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone. + + The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property. + + This parameter returns an empty object if no custom zones exist. + readOnly: true + managedNamespaces: + type: array + description: List that contains a namespace for a Global Cluster. MongoDB + Cloud manages this cluster. + items: + $ref: "#/components/schemas/ManagedNamespaces" + readOnly: true + 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 + GoogleCloudKMS: + type: object + description: Details that define the configuration of Encryption at Rest using + Google Cloud Key Management Service (KMS). + externalDocs: + description: Google Cloud Key Management Service + url: https://www.mongodb.com/docs/atlas/security-gcp-kms/ + properties: + enabled: + 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 + 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. + externalDocs: + description: Google Cloud Authentication + url: https://cloud.google.com/docs/authentication/getting-started + writeOnly: true + valid: + type: boolean + description: Flag that indicates whether the Google Cloud Key Management + Service (KMS) encryption key can encrypt and decrypt data. + readOnly: true + GreaterThanDaysThresholdView: + type: object + description: Threshold value that triggers an alert. + properties: + operator: + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - GREATER_THAN + threshold: + type: integer + format: int32 + description: "Value of metric that, when exceeded, triggers an alert." + units: + type: string + description: "Element used to express the quantity. This can be an element\ + \ of time, storage capacity, and the like." + enum: + - DAYS + GreaterThanRawThreshold: + type: object + description: A Limit that triggers an alert when greater than a number. + properties: + operator: + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - GREATER_THAN + threshold: + type: integer + format: int32 + description: "Value of metric that, when exceeded, triggers an alert." + units: + $ref: "#/components/schemas/RawMetricUnits" + title: Greater Than Raw Threshold + GreaterThanRawThresholdAlertConfigViewForNdsGroup: + type: object + properties: + created: + type: string + format: date-time + description: Date and time when MongoDB Cloud created the alert configuration. + This parameter expresses its value in the ISO 8601 timestamp format + in UTC. + readOnly: true + enabled: + type: boolean + default: false + description: Flag that indicates whether someone enabled this alert configuration + for the specified project. + eventTypeName: + $ref: "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" + groupId: + type: string + description: Unique 24-hexadecimal digit string that identifies the project + that owns this alert configuration. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + id: + type: string + description: Unique 24-hexadecimal digit string that identifies this alert + configuration. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + matchers: + type: array + description: "List of rules that determine whether MongoDB Cloud checks\ + \ an object for the alert configuration. You can filter using the matchers\ + \ array if the **eventTypeName** specifies an event for a host, replica\ + \ set, or sharded cluster." + items: + $ref: "#/components/schemas/ReplicaSetMatcher" + notifications: + type: array + description: List that contains the targets that MongoDB Cloud sends notifications. + items: + $ref: "#/components/schemas/AlertsNotificationRootForGroup" + threshold: + $ref: "#/components/schemas/GreaterThanRawThreshold" + updated: + type: string + format: date-time + description: Date and time when someone last updated this alert configuration. + This parameter expresses its value in the ISO 8601 timestamp format + in UTC. + readOnly: true + required: + - eventTypeName + - notifications + GreaterThanTimeThreshold: + type: object + description: A Limit that triggers an alert when greater than a time period. + properties: + operator: + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - GREATER_THAN + threshold: + type: integer + format: int32 + description: "Value of metric that, when exceeded, triggers an alert." + units: + $ref: "#/components/schemas/TimeMetricUnits" + title: Greater Than Time Threshold + Group: + type: object + properties: + clusterCount: + type: integer + format: int64 + description: Quantity of MongoDB Cloud clusters deployed in this project. + readOnly: true + created: + type: string + format: date-time + description: Date and time when MongoDB Cloud created this project. This + parameter expresses its value in the ISO 8601 timestamp format in UTC. + readOnly: true + id: + type: string + description: Unique 24-hexadecimal digit string that identifies the MongoDB + Cloud project. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + name: + type: string + description: Human-readable label that identifies the project included in + the MongoDB Cloud organization. + maxLength: 64 + minLength: 1 + pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + orgId: + type: string + description: Unique 24-hexadecimal digit string that identifies the MongoDB + Cloud organization to which the project belongs. + example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" @@ -36297,25 +37918,26 @@ components: maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" - readOnly: true destinationOrgPrivateApiKey: type: string - description: "Unique string that identifies the private part of the [API\ - \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) used\ - \ to verify access to the destination organization. This parameter is\ - \ required only when you authenticate with Programmatic API Keys." + description: Unique string that identifies the private part of the API Key + used to verify access to the destination organization. This parameter + is required only when you authenticate with Programmatic API Keys. example: 55c3bbb6-b4bb-0be1-e66d20841f3e - readOnly: true + externalDocs: + description: Grant Programmatic Access to Atlas + url: https://dochub.mongodb.org/core/atlas-create-prog-api-key destinationOrgPublicApiKey: type: string - description: "Unique string that identifies the public part of the [API\ - \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) used\ - \ to verify access to the destination organization. This parameter is\ - \ required only when you authenticate with Programmatic API Keys." + description: Unique string that identifies the public part of the API Key + used to verify access to the destination organization. This parameter + is required only when you authenticate with Programmatic API Keys. example: zmmrboas + externalDocs: + description: Grant Programmatic Access to Atlas + url: https://dochub.mongodb.org/core/atlas-create-prog-api-key maxLength: 8 minLength: 8 - readOnly: true GroupNotification: type: object description: Group notification configuration for MongoDB Cloud to send information @@ -36405,7 +38027,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/EventViewForNdsGroup" @@ -36453,6 +38075,33 @@ components: - GROUP_READ_ONLY - GROUP_SEARCH_INDEX_EDITOR - GROUP_STREAM_PROCESSING_OWNER + GroupRoleAssignment: + type: object + properties: + groupId: + type: string + description: Unique 24-hexadecimal digit string that identifies the project + to which these roles belong. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + groupRoles: + type: array + description: One or more project level roles assigned to the MongoDB Cloud + user. + items: + type: string + enum: + - GROUP_OWNER + - GROUP_CLUSTER_MANAGER + - GROUP_STREAM_PROCESSING_OWNER + - GROUP_DATA_ACCESS_ADMIN + - GROUP_DATA_ACCESS_READ_WRITE + - GROUP_DATA_ACCESS_READ_ONLY + - GROUP_READ_ONLY + - GROUP_SEARCH_INDEX_EDITOR + uniqueItems: true GroupService: type: object description: List of IP addresses in a project categorized by services. @@ -36468,26 +38117,26 @@ components: GroupServiceAccount: type: object properties: + clientId: + type: string + description: The Client ID of the Service Account. + pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" createdAt: type: string format: date-time - description: Service account creation time. + description: The date that the Service Account was created on. description: type: string - description: Description of the service account. - id: - type: string - description: ID for the service account. - pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" + description: Human readable description for the Service Account. name: type: string - description: Name for service account. + description: Human-readable name for the Service Account. roles: type: array - description: Roles assigned to the Service Account group. + description: A list of Project roles associated with the Service Account. items: type: string - description: Project roles associated with the service account. + description: Project roles available for Service Accounts. enum: - GROUP_OWNER - GROUP_READ_ONLY @@ -36500,7 +38149,7 @@ components: uniqueItems: true secrets: type: array - description: List of secrets. + description: A list of secrets associated with the specified Service Account. items: $ref: "#/components/schemas/ServiceAccountSecret" uniqueItems: true @@ -36509,23 +38158,23 @@ components: properties: description: type: string - description: Human readable description for the service account. + description: Human readable description for the Service Account. maxLength: 250 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" name: type: string - description: Human-readable name for the service account. The name is modifiable + description: Human-readable name for the Service Account. The name is modifiable and does not have to be unique. maxLength: 64 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" roles: type: array - description: Project roles associated with the service account. + description: A list of project-level roles for the Service Account. items: type: string - description: Project roles associated with the service account. + description: Project roles available for Service Accounts. enum: - GROUP_OWNER - GROUP_READ_ONLY @@ -36538,20 +38187,23 @@ components: secretExpiresAfterHours: type: integer format: int32 - description: Secret expiration time. + description: The expiration time of the new Service Account secret. The + expiration is provided in hours. required: - description - name + - roles - secretExpiresAfterHours GroupServiceAccountRoleAssignment: type: object properties: roles: type: array - description: Group access roles. + description: The Project permissions for the Service Account in the specified + Project. items: type: string - description: Project roles associated with the service account. + description: Project roles available for Service Accounts. enum: - GROUP_OWNER - GROUP_READ_ONLY @@ -36562,28 +38214,30 @@ components: - GROUP_SEARCH_INDEX_EDITOR - GROUP_STREAM_PROCESSING_OWNER uniqueItems: true + required: + - roles GroupServiceAccountUpdateRequest: type: object properties: description: type: string - description: Human readable description for the service account. + description: Human readable description for the Service Account. maxLength: 250 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" name: type: string - description: Human-readable name for the service account. The name is modifiable + description: Human-readable name for the Service Account. The name is modifiable and does not have to be unique. maxLength: 64 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" roles: type: array - description: Project roles associated with the service account. + description: A list of Project roles associated with the Service Account. items: type: string - description: Project roles associated with the service account. + description: Project roles available for Service Accounts. enum: - GROUP_OWNER - GROUP_READ_ONLY @@ -36847,7 +38501,7 @@ components: example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -36966,6 +38620,8 @@ components: - HOST_HAS_INDEX_SUGGESTIONS - HOST_MONGOT_RECOVERED_OOM - HOST_MONGOT_CRASHING_OOM + - HOST_MONGOT_RESUME_REPLICATION + - HOST_MONGOT_STOP_REPLICATION - HOST_ENOUGH_DISK_SPACE - HOST_NOT_ENOUGH_DISK_SPACE example: HOST_DOWN @@ -36977,6 +38633,7 @@ components: - HOST_DOWN - HOST_HAS_INDEX_SUGGESTIONS - HOST_MONGOT_CRASHING_OOM + - HOST_MONGOT_STOP_REPLICATION - HOST_NOT_ENOUGH_DISK_SPACE example: HOST_DOWN title: Host Event Types @@ -37273,6 +38930,7 @@ components: OPCOUNTER_REPL_INSERT: "#/components/schemas/RawMetricAlertView" OPCOUNTER_REPL_UPDATE: "#/components/schemas/RawMetricAlertView" OPCOUNTER_UPDATE: "#/components/schemas/RawMetricAlertView" + OPERATIONS_QUERIES_KILLED: "#/components/schemas/RawMetricAlertView" OPERATIONS_SCAN_AND_ORDER: "#/components/schemas/RawMetricAlertView" OPERATION_THROTTLING_REJECTED_OPERATIONS: "#/components/schemas/RawMetricAlertView" OPLOG_MASTER_LAG_TIME_DIFF: "#/components/schemas/TimeMetricAlertView" @@ -37347,7 +39005,7 @@ components: example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -37676,6 +39334,7 @@ components: OPCOUNTER_REPL_INSERT: "#/components/schemas/RawMetricEventView" OPCOUNTER_REPL_UPDATE: "#/components/schemas/RawMetricEventView" OPCOUNTER_UPDATE: "#/components/schemas/RawMetricEventView" + OPERATIONS_QUERIES_KILLED: "#/components/schemas/RawMetricEventView" OPERATIONS_SCAN_AND_ORDER: "#/components/schemas/RawMetricEventView" OPERATION_THROTTLING_REJECTED_OPERATIONS: "#/components/schemas/RawMetricEventView" OPLOG_MASTER_LAG_TIME_DIFF: "#/components/schemas/TimeMetricEventView" @@ -37981,6 +39640,7 @@ components: OPCOUNTER_REPL_INSERT: "#/components/schemas/RawMetricThresholdView" OPCOUNTER_REPL_UPDATE: "#/components/schemas/RawMetricThresholdView" OPCOUNTER_UPDATE: "#/components/schemas/RawMetricThresholdView" + OPERATIONS_QUERIES_KILLED: "#/components/schemas/RawMetricThresholdView" OPERATIONS_SCAN_AND_ORDER: "#/components/schemas/RawMetricThresholdView" OPERATION_THROTTLING_REJECTED_OPERATIONS: "#/components/schemas/RawMetricThresholdView" OPLOG_MASTER_LAG_TIME_DIFF: "#/components/schemas/TimeMetricThresholdView" @@ -38025,7 +39685,12 @@ components: enum: - AVERAGE operator: - $ref: "#/components/schemas/Operator" + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - LESS_THAN + - GREATER_THAN threshold: type: number format: double @@ -38502,7 +40167,7 @@ components: the charge. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -38938,6 +40603,21 @@ components: - ATLAS_AWS_STREAM_PROCESSING_DATA_TRANSFER - ATLAS_AZURE_STREAM_PROCESSING_DATA_TRANSFER - ATLAS_AWS_STREAM_PROCESSING_VPC_PEERING + - 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 readOnly: true startDate: type: string @@ -39263,6 +40943,371 @@ components: - REPLICASET - SHARDED - GEOSHARDED + configServerManagementMode: + type: string + default: ATLAS_MANAGED + description: |- + Config Server Management Mode for creating or updating a sharded cluster. + + When configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings. + + When configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server. + enum: + - ATLAS_MANAGED + - FIXED_TO_DEDICATED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + configServerType: + type: string + description: Describes a sharded cluster's config server type. + enum: + - DEDICATED + - EMBEDDED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + readOnly: true + connectionStrings: + $ref: "#/components/schemas/ClusterConnectionStrings" + createDate: + type: string + format: date-time + description: Date and time when MongoDB Cloud created this serverless instance. + MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. + readOnly: true + diskSizeGB: + type: number + format: double + 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." + maximum: 4096 + minimum: 10 + diskWarmingMode: + type: string + default: FULLY_WARMED + description: Disk warming mode selection. + enum: + - FULLY_WARMED + - VISIBLE_EARLIER + externalDocs: + description: Reduce Secondary Disk Warming Impact + url: https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact + encryptionAtRestProvider: + type: string + description: Cloud service provider that manages your customer keys to provide + an additional layer of Encryption at Rest for the cluster. + enum: + - NONE + - AWS + - AZURE + - GCP + externalDocs: + description: Encryption at Rest using Customer Key Management + url: https://www.mongodb.com/docs/atlas/security-kms-encryption/ + featureCompatibilityVersion: + type: string + description: Feature compatibility version of the cluster. + readOnly: true + featureCompatibilityVersionExpirationDate: + type: string + format: date-time + description: Feature compatibility version expiration date. + 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: + type: string + description: Unique 24-hexadecimal character string that identifies the + project. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + id: + type: string + description: Unique 24-hexadecimal digit string that identifies the cluster. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + labels: + type: array + deprecated: true + description: |- + Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels. + + Cluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead. + items: + $ref: "#/components/schemas/ComponentLabel" + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + 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- + mongoDBVersion: + type: string + description: Version of MongoDB that the cluster runs. + pattern: "([\\d]+\\.[\\d]+\\.[\\d]+)" + 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." + externalDocs: + description: Connection string URI format. + url: https://docs.mongodb.com/manual/reference/connection-string/ + readOnly: true + mongoURIUpdated: + type: string + format: date-time + description: Date and time when someone last updated the connection string. + MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. + readOnly: true + 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." + externalDocs: + description: Connection string URI format. + url: https://docs.mongodb.com/manual/reference/connection-string/ + readOnly: true + name: + type: string + description: Human-readable label that identifies the cluster. + maxLength: 64 + minLength: 1 + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + numShards: + type: integer + format: int32 + default: 1 + description: Number of shards up to 50 to deploy for a sharded cluster. + The resource returns `1` to indicate a replica set and values of `2` and + higher to indicate a sharded cluster. The returned value equals the number + of shards in the cluster. + externalDocs: + description: Sharding + url: https://docs.mongodb.com/manual/sharding/ + maximum: 50 + minimum: 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 + default: WORKLOAD_TYPE + description: |- + Set this field to configure the replica set scaling mode for your cluster. + + By default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes. + + When configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads. + + When configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads. + enum: + - SEQUENTIAL + - WORKLOAD_TYPE + - NODE_TYPE + externalDocs: + description: Modify the Replica Set Scaling Mode + url: https://dochub.mongodb.org/core/scale-nodes + replicationFactor: + type: integer + format: int32 + default: 3 + deprecated: true + description: "Number of members that belong to the replica set. Each member\ + \ retains a copy of your databases, providing high availability and data\ + \ redundancy. Use **replicationSpecs** instead." + enum: + - 3 + - 5 + - 7 + replicationSpec: + type: object + additionalProperties: + $ref: "#/components/schemas/RegionSpec" + description: Physical location where MongoDB Cloud provisions cluster nodes. + title: Region Configuration + 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. + items: + $ref: "#/components/schemas/LegacyReplicationSpec" + rootCertType: + type: string + default: ISRGROOTX1 + description: Root Certificate Authority that MongoDB Atlas clusters uses. + MongoDB Cloud supports Internet Security Research Group. + 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. + externalDocs: + description: Connection string URI format. + url: https://docs.mongodb.com/manual/reference/connection-string/ + readOnly: true + stateName: + type: string + description: Human-readable label that indicates the current operating condition + of the cluster. + enum: + - IDLE + - CREATING + - UPDATING + - DELETING + - REPAIRING + readOnly: true + tags: + type: array + description: List that contains key-value pairs between 1 to 255 characters + in length for tagging and categorizing the cluster. + externalDocs: + description: Resource Tags + url: https://dochub.mongodb.org/core/add-cluster-tag-atlas + items: + $ref: "#/components/schemas/ResourceTag" + terminationProtectionEnabled: + type: boolean + default: false + description: "Flag that indicates whether termination protection is enabled\ + \ on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster.\ + \ If set to `false`, MongoDB Cloud will delete the cluster." + versionReleaseSystem: + type: string + default: LTS + description: "Method by which the cluster maintains the MongoDB versions.\ + \ If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**." + enum: + - LTS + - CONTINUOUS + title: Cluster Description + LegacyAtlasTenantClusterUpgradeRequest: + type: object + description: Request containing target state of tenant cluster to be upgraded + properties: + acceptDataRisksAndForceReplicaSetReconfig: + type: string + format: date-time + description: "If reconfiguration is necessary to regain a primary due to\ + \ a regional outage, submit this field alongside your topology reconfiguration\ + \ to request a new regional outage resistant topology. Forced reconfigurations\ + \ during an outage of the majority of electable nodes carry a risk of\ + \ data loss if replicated writes (even majority committed writes) have\ + \ not been replicated to the new primary node. MongoDB Atlas docs contain\ + \ more information. To proceed with an operation which carries that risk,\ + \ set **acceptDataRisksAndForceReplicaSetReconfig** to the current date." + externalDocs: + description: Reconfiguring a Replica Set during a regional outage + url: https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set + 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 + default: ATLAS_MANAGED + description: |- + Config Server Management Mode for creating or updating a sharded cluster. + + When configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings. + + When configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server. + enum: + - ATLAS_MANAGED + - FIXED_TO_DEDICATED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + configServerType: + type: string + description: Describes a sharded cluster's config server type. + enum: + - DEDICATED + - EMBEDDED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + readOnly: true connectionStrings: $ref: "#/components/schemas/ClusterConnectionStrings" createDate: @@ -39307,6 +41352,15 @@ components: externalDocs: description: Encryption at Rest using Customer Key Management url: https://www.mongodb.com/docs/atlas/security-kms-encryption/ + featureCompatibilityVersion: + type: string + description: Feature compatibility version of the cluster. + readOnly: true + featureCompatibilityVersionExpirationDate: + type: string + format: date-time + description: Feature compatibility version expiration date. + readOnly: true globalClusterSelfManagedSharding: type: boolean description: |- @@ -39357,6 +41411,8 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true + mongoDBEmployeeAccessGrant: + $ref: "#/components/schemas/EmployeeAccessGrantView" mongoDBMajorVersion: type: string description: |- @@ -39403,7 +41459,7 @@ components: description: Human-readable label that identifies the cluster. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" numShards: type: integer format: int32 @@ -39435,292 +41491,24 @@ components: \ use MongoDB Cloud backups." providerSettings: $ref: "#/components/schemas/ClusterProviderSettings" - replicationFactor: - type: integer - format: int32 - default: 3 - deprecated: true - description: "Number of members that belong to the replica set. Each member\ - \ retains a copy of your databases, providing high availability and data\ - \ redundancy. Use **replicationSpecs** instead." - enum: - - 3 - - 5 - - 7 - replicationSpec: - type: object - additionalProperties: - $ref: "#/components/schemas/RegionSpec" - description: Physical location where MongoDB Cloud provisions cluster nodes. - title: Region Configuration - 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. - items: - $ref: "#/components/schemas/LegacyReplicationSpec" - rootCertType: - type: string - default: ISRGROOTX1 - description: Root Certificate Authority that MongoDB Atlas clusters uses. - MongoDB Cloud supports Internet Security Research Group. - 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. - externalDocs: - description: Connection string URI format. - url: https://docs.mongodb.com/manual/reference/connection-string/ - readOnly: true - stateName: - type: string - description: Human-readable label that indicates the current operating condition - of the cluster. - enum: - - IDLE - - CREATING - - UPDATING - - DELETING - - REPAIRING - readOnly: true - tags: - type: array - description: List that contains key-value pairs between 1 to 255 characters - in length for tagging and categorizing the cluster. - externalDocs: - description: Resource Tags - url: https://dochub.mongodb.org/core/add-cluster-tag-atlas - items: - $ref: "#/components/schemas/ResourceTag" - terminationProtectionEnabled: - type: boolean - default: false - description: "Flag that indicates whether termination protection is enabled\ - \ on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster.\ - \ If set to `false`, MongoDB Cloud will delete the cluster." - versionReleaseSystem: - type: string - default: LTS - description: "Method by which the cluster maintains the MongoDB versions.\ - \ If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**." - enum: - - LTS - - CONTINUOUS - title: Cluster Description - LegacyAtlasTenantClusterUpgradeRequest: - type: object - description: Request containing target state of tenant cluster to be upgraded - properties: - acceptDataRisksAndForceReplicaSetReconfig: - type: string - format: date-time - description: "If reconfiguration is necessary to regain a primary due to\ - \ a regional outage, submit this field alongside your topology reconfiguration\ - \ to request a new regional outage resistant topology. Forced reconfigurations\ - \ during an outage of the majority of electable nodes carry a risk of\ - \ data loss if replicated writes (even majority committed writes) have\ - \ not been replicated to the new primary node. MongoDB Atlas docs contain\ - \ more information. To proceed with an operation which carries that risk,\ - \ set **acceptDataRisksAndForceReplicaSetReconfig** to the current date." - externalDocs: - description: Reconfiguring a Replica Set during a regional outage - url: https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set - 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 - connectionStrings: - $ref: "#/components/schemas/ClusterConnectionStrings" - createDate: - type: string - format: date-time - description: Date and time when MongoDB Cloud created this serverless instance. - MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. - readOnly: true - diskSizeGB: - type: number - format: double - 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." - maximum: 4096 - minimum: 10 - diskWarmingMode: - type: string - default: FULLY_WARMED - description: Disk warming mode selection. - enum: - - FULLY_WARMED - - VISIBLE_EARLIER - externalDocs: - description: Reduce Secondary Disk Warming Impact - url: https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact - encryptionAtRestProvider: - type: string - description: Cloud service provider that manages your customer keys to provide - an additional layer of Encryption at Rest for the cluster. - enum: - - NONE - - AWS - - AZURE - - GCP - externalDocs: - description: Encryption at Rest using Customer Key Management - url: https://www.mongodb.com/docs/atlas/security-kms-encryption/ - 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: - type: string - description: Unique 24-hexadecimal character string that identifies the - project. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - id: + replicaSetScalingStrategy: type: string - description: Unique 24-hexadecimal digit string that identifies the cluster. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - labels: - type: array - deprecated: true + default: WORKLOAD_TYPE 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. + Set this field to configure the replica set scaling mode for your cluster. - Cluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead. - items: - $ref: "#/components/schemas/ComponentLabel" - links: - type: array - description: "List of one or more Uniform Resource Locators (URLs) that\ - \ point to API sub-resources, related API resources, or both. RFC 5988\ - \ outlines these relationships." - externalDocs: - description: Web Linking Specification (RFC 5988) - url: https://datatracker.ietf.org/doc/html/rfc5988 - items: - $ref: "#/components/schemas/Link" - readOnly: true - mongoDBMajorVersion: - type: string - description: |- - MongoDB major version of the cluster. + By default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes. - 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). + When configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads. - 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- - mongoDBVersion: - type: string - description: Version of MongoDB that the cluster runs. - pattern: "([\\d]+\\.[\\d]+\\.[\\d]+)" - 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." - externalDocs: - description: Connection string URI format. - url: https://docs.mongodb.com/manual/reference/connection-string/ - readOnly: true - mongoURIUpdated: - type: string - format: date-time - description: Date and time when someone last updated the connection string. - MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. - readOnly: true - 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." - externalDocs: - description: Connection string URI format. - url: https://docs.mongodb.com/manual/reference/connection-string/ - readOnly: true - name: - type: string - description: Human-readable label that identifies the cluster. - maxLength: 64 - minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - numShards: - type: integer - format: int32 - default: 1 - description: Number of shards up to 50 to deploy for a sharded cluster. - The resource returns `1` to indicate a replica set and values of `2` and - higher to indicate a sharded cluster. The returned value equals the number - of shards in the cluster. - externalDocs: - description: Sharding - url: https://docs.mongodb.com/manual/sharding/ - maximum: 50 - minimum: 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. + When configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads. + enum: + - SEQUENTIAL + - WORKLOAD_TYPE + - NODE_TYPE externalDocs: - description: 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" + description: Modify the Replica Set Scaling Mode + url: https://dochub.mongodb.org/core/scale-nodes replicationFactor: type: integer format: int32 @@ -40283,6 +42071,10 @@ components: - INSTANCE_NAME - PROCESSOR_NAME title: Streams Matcher Fields + - type: string + enum: + - RULE_ID + title: Log Ingestion Matcher Fields MatcherHostType: type: string description: Value to match or exceed using the specified **matchers.operator**. @@ -40997,6 +42789,7 @@ components: - 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 @@ -41074,6 +42867,8 @@ components: - 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 @@ -41103,6 +42898,9 @@ components: - 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 @@ -41161,9 +42959,13 @@ components: - 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 example: CLUSTER_CREATED title: NDS Audit Types NDSAuditTypeViewForOrg: @@ -42139,7 +43941,7 @@ components: example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -42398,7 +44200,12 @@ components: enum: - AVERAGE operator: - $ref: "#/components/schemas/Operator" + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - LESS_THAN + - GREATER_THAN threshold: type: number format: double @@ -42588,6 +44395,57 @@ components: required: - typeName title: OpsGenie Notification + OrgActiveUserResponse: + type: object + allOf: + - $ref: "#/components/schemas/OrgUserResponse" + - type: object + properties: + country: + type: string + description: Two alphabet characters that identifies MongoDB Cloud user's + geographic location. This parameter uses the ISO 3166-1a2 code format. + example: US + pattern: "^([A-Z]{2})$" + readOnly: true + createdAt: + type: string + format: date-time + description: Date and time when MongoDB Cloud created the current account. + This value is in the ISO 8601 timestamp format in UTC. + readOnly: true + firstName: + type: string + description: First or given name that belongs to the MongoDB Cloud user. + example: John + readOnly: true + lastAuth: + type: string + format: date-time + description: Date and time when the current account last authenticated. + This value is in the ISO 8601 timestamp format in UTC. + readOnly: true + lastName: + type: string + description: "Last name, family name, or surname that belongs to the MongoDB\ + \ Cloud user." + example: Doe + readOnly: true + mobileNumber: + type: string + description: Mobile phone number that belongs to the MongoDB Cloud user. + pattern: "(?:(?:\\\\+?1\\\\s*(?:[.-]\\\\s*)?)?(?:(\\\\s*([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9])\\\ + \\s*)|([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9]))\\\\s*(?:[.-]\\\\\ + s*)?)([2-9]1[02-9]|[2-9][02-9]1|[2-9][02-9]{2})\\\\s*(?:[.-]\\\\s*)?([0-9]{4})$" + readOnly: true + required: + - createdAt + - firstName + - id + - lastName + - orgMembershipStatus + - roles + - username OrgEventTypeViewForOrg: type: string description: Unique identifier of event type. @@ -42938,7 +44796,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/EventViewForOrg" @@ -42950,29 +44808,61 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true + OrgPendingUserResponse: + type: object + allOf: + - $ref: "#/components/schemas/OrgUserResponse" + - type: object + properties: + invitationCreatedAt: + type: string + format: date-time + description: Date and time when MongoDB Cloud sent the invitation. MongoDB + Cloud represents this timestamp in ISO 8601 format in UTC. + readOnly: true + invitationExpiresAt: + type: string + format: date-time + description: Date and time when the invitation from MongoDB Cloud expires. + MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. + readOnly: true + inviterUsername: + type: string + format: email + description: Username of the MongoDB Cloud user who sent the invitation + to join the organization. + readOnly: true + required: + - id + - invitationCreatedAt + - invitationExpiresAt + - inviterUsername + - orgMembershipStatus + - roles + - username OrgServiceAccount: type: object properties: + clientId: + type: string + description: The Client ID of the Service Account. + pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" createdAt: type: string format: date-time - description: Service account creation time. + description: The date that the Service Account was created on. description: type: string - description: Description of the service account. - id: - type: string - description: ID for the service account. - pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" + description: Human readable description for the Service Account. name: type: string - description: Name for service account. + description: Human-readable name for the Service Account. roles: type: array - description: Organization roles assigned to the Service Account. + description: A list of Organization roles associated with the Service Account. items: type: string - description: Organization roles associated with the service account. + description: Organization roles available for Service Accounts. enum: - ORG_MEMBER - ORG_READ_ONLY @@ -42983,7 +44873,7 @@ components: uniqueItems: true secrets: type: array - description: List of secrets. + description: A list of secrets associated with the specified Service Account. items: $ref: "#/components/schemas/ServiceAccountSecret" uniqueItems: true @@ -42992,23 +44882,23 @@ components: properties: description: type: string - description: Human readable description for the service account. + description: Human readable description for the Service Account. maxLength: 250 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" name: type: string - description: Human-readable name for the service account. The name is modifiable + description: Human-readable name for the Service Account. The name is modifiable and does not have to be unique. maxLength: 64 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" roles: type: array - description: Organization roles associated with the service account. + description: A list of organization-level roles for the Service Account. items: type: string - description: Organization roles associated with the service account. + description: Organization roles available for Service Accounts. enum: - ORG_MEMBER - ORG_READ_ONLY @@ -43019,33 +44909,35 @@ components: secretExpiresAfterHours: type: integer format: int32 - description: Secret expiration time. + description: The expiration time of the new Service Account secret. The + expiration is provided in hours. required: - description - name + - roles - secretExpiresAfterHours OrgServiceAccountUpdateRequest: type: object properties: description: type: string - description: Human readable description for the service account. + description: Human readable description for the Service Account. maxLength: 250 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" name: type: string - description: Human-readable name for the service account. The name is modifiable + description: Human-readable name for the Service Account. The name is modifiable and does not have to be unique. maxLength: 64 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" roles: type: array - description: Organization roles associated with the Service account. + description: A list of organization-level roles for the Service Account. items: type: string - description: Organization roles associated with the service account. + description: Organization roles available for Service Accounts. enum: - ORG_MEMBER - ORG_READ_ONLY @@ -43053,6 +44945,158 @@ components: - ORG_BILLING_READ_ONLY - ORG_GROUP_CREATOR - ORG_OWNER + OrgUserRequest: + type: object + properties: + roles: + $ref: "#/components/schemas/OrgUserRolesRequest" + teamIds: + type: array + description: List of unique 24-hexadecimal digit strings that identifies + the teams to which this MongoDB Cloud user belongs. + items: + type: string + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + uniqueItems: true + writeOnly: true + username: + type: string + format: email + description: Email address that represents the username of the MongoDB Cloud + user. + writeOnly: true + required: + - roles + - username + OrgUserResponse: + type: object + discriminator: + mapping: + ACTIVE: "#/components/schemas/OrgActiveUserResponse" + PENDING: "#/components/schemas/OrgPendingUserResponse" + propertyName: orgMembershipStatus + oneOf: + - $ref: "#/components/schemas/OrgPendingUserResponse" + - $ref: "#/components/schemas/OrgActiveUserResponse" + properties: + id: + type: string + description: Unique 24-hexadecimal digit string that identifies the MongoDB + Cloud user. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + orgMembershipStatus: + type: string + description: String enum that indicates whether the MongoDB Cloud user has + a pending invitation to join the organization or they are already active + in the organization. + enum: + - PENDING + - ACTIVE + readOnly: true + roles: + $ref: "#/components/schemas/OrgUserRolesResponse" + teamIds: + type: array + description: List of unique 24-hexadecimal digit strings that identifies + the teams to which this MongoDB Cloud user belongs. + items: + type: string + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + uniqueItems: true + username: + type: string + format: email + description: Email address that represents the username of the MongoDB Cloud + user. + readOnly: true + required: + - id + - orgMembershipStatus + - roles + - username + OrgUserRolesRequest: + type: object + description: Organization and project level roles to assign the MongoDB Cloud + user within one organization. + properties: + groupRoleAssignments: + type: array + description: List of project level role assignments to assign the MongoDB + Cloud user. + items: + $ref: "#/components/schemas/GroupRoleAssignment" + orgRoles: + type: array + description: One or more organization level roles to assign the MongoDB + Cloud user. + items: + type: string + enum: + - ORG_OWNER + - ORG_GROUP_CREATOR + - ORG_BILLING_ADMIN + - ORG_BILLING_READ_ONLY + - ORG_READ_ONLY + - ORG_MEMBER + minItems: 1 + uniqueItems: true + required: + - orgRoles + writeOnly: true + OrgUserRolesResponse: + type: object + description: Organization and project level roles assigned to one MongoDB Cloud + user within one organization. + properties: + groupRoleAssignments: + type: array + description: List of project level role assignments assigned to the MongoDB + Cloud user. + items: + $ref: "#/components/schemas/GroupRoleAssignment" + orgRoles: + type: array + description: One or more organization level roles assigned to the MongoDB + Cloud user. + items: + type: string + enum: + - ORG_OWNER + - ORG_GROUP_CREATOR + - ORG_BILLING_ADMIN + - ORG_BILLING_READ_ONLY + - ORG_READ_ONLY + - ORG_MEMBER + uniqueItems: true + readOnly: true + OrgUserUpdateRequest: + type: object + properties: + roles: + $ref: "#/components/schemas/OrgUserRolesRequest" + teamIds: + type: array + description: List of unique 24-hexadecimal digit strings that identifies + the teams to assign the MongoDB Cloud user. + items: + type: string + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + uniqueItems: true + writeOnly: true OrganizationInvitation: type: object properties: @@ -43264,10 +45308,11 @@ components: restrictEmployeeAccess: type: boolean description: "Flag that indicates whether to block MongoDB Support from\ - \ accessing Atlas infrastructure 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/." + \ 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/." OutboundControlPlaneCloudProviderIPAddresses: type: object description: "List of outbound IP addresses from the Atlas control plane, categorized\ @@ -43440,7 +45485,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/AdvancedClusterDescription" @@ -43468,7 +45513,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/GroupAlertsConfig" @@ -43496,7 +45541,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/AlertViewForNdsGroup" @@ -43524,7 +45569,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ApiKeyUserDetails" @@ -43552,7 +45597,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/CloudAppUser" @@ -43580,7 +45625,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ApiAtlasCheckpointView" @@ -43610,7 +45655,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/CloudDatabaseUser" @@ -43638,7 +45683,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/DiskBackupExportJob" @@ -43666,7 +45711,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/EARPrivateEndpoint" @@ -43678,7 +45723,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedApiAtlasProviderRegionsView: + PaginatedApiAtlasFlexBackupRestoreJob20250101View: type: object properties: links: @@ -43694,10 +45739,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/CloudProviderRegions" + $ref: "#/components/schemas/FlexBackupRestoreJob20250101" readOnly: true totalCount: type: integer @@ -43706,7 +45751,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedApiAtlasServerlessBackupRestoreJobView: + PaginatedApiAtlasFlexBackupSnapshot20240710View: type: object properties: links: @@ -43722,10 +45767,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/ServerlessBackupRestoreJob" + $ref: "#/components/schemas/FlexBackupSnapshot20250101" readOnly: true totalCount: type: integer @@ -43734,7 +45779,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedApiAtlasServerlessBackupSnapshotView: + PaginatedApiAtlasProviderRegionsView: type: object properties: links: @@ -43750,10 +45795,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/ServerlessBackupSnapshot" + $ref: "#/components/schemas/CloudProviderRegions" readOnly: true totalCount: type: integer @@ -43762,7 +45807,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedApiAtlasUSSBackupRestoreJob20250101View: + PaginatedApiAtlasServerlessBackupRestoreJobView: type: object properties: links: @@ -43778,10 +45823,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/USSBackupRestoreJob20250101" + $ref: "#/components/schemas/ServerlessBackupRestoreJob" readOnly: true totalCount: type: integer @@ -43790,7 +45835,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedApiAtlasUSSBackupSnapshot20240710View: + PaginatedApiAtlasServerlessBackupSnapshotView: type: object properties: links: @@ -43806,10 +45851,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/USSBackupSnapshot20250101" + $ref: "#/components/schemas/ServerlessBackupSnapshot" readOnly: true totalCount: type: integer @@ -43834,7 +45879,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/BillingInvoiceMetadata" @@ -43862,7 +45907,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/BillingInvoice" @@ -43890,7 +45935,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/StreamsConnection" @@ -43902,6 +45947,34 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true + PaginatedApiStreamsPrivateLinkView: + type: object + properties: + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + results: + type: array + description: List of returned documents that MongoDB Cloud provides when + completing this request. + items: + $ref: "#/components/schemas/StreamsPrivateLinkConnection" + readOnly: true + totalCount: + type: integer + format: int32 + description: Total number of documents available. MongoDB Cloud omits this + value if `includeCount` is set to `false`. + minimum: 0 + readOnly: true PaginatedApiStreamsStreamProcessorWithStatsView: type: object properties: @@ -43918,7 +45991,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/StreamsProcessorWithStats" @@ -43946,7 +46019,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/StreamsTenant" @@ -43974,7 +46047,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/UserAccessListResponse" @@ -43986,6 +46059,34 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true + PaginatedApiVersions: + type: object + properties: + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + results: + type: array + description: List of returned documents that MongoDB Cloud provides when + completing this request. + items: + $ref: "#/components/schemas/ApiVersion" + readOnly: true + totalCount: + type: integer + format: int32 + description: Total number of documents available. MongoDB Cloud omits this + value if `includeCount` is set to `false`. + minimum: 0 + readOnly: true PaginatedAppUserView: type: object properties: @@ -44002,7 +46103,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/CloudAppUser" @@ -44030,7 +46131,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/Group" @@ -44058,7 +46159,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/MdbAvailableVersion" @@ -44086,7 +46187,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/DiskBackupSnapshotAWSExportBucket" @@ -44114,7 +46215,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/DiskBackupSnapshotExportBucket" @@ -44142,7 +46243,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/DiskBackupSnapshot" @@ -44170,7 +46271,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/DiskBackupReplicaSet" @@ -44198,7 +46299,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/DiskBackupSnapshotRestoreJob" @@ -44226,7 +46327,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/DiskBackupShardedClusterSnapshot" @@ -44255,7 +46356,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/CloudProviderContainer" @@ -44284,7 +46385,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ClusterDescription20240805" @@ -44312,7 +46413,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ConnectedOrgConfig" @@ -44341,7 +46442,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/BaseNetworkPeeringConnectionSettings" @@ -44369,7 +46470,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/MesurementsDatabase" @@ -44397,7 +46498,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/MeasurementDiskPartition" @@ -44425,7 +46526,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/EventTypeDetails" @@ -44453,7 +46554,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/FederationIdentityProvider" @@ -44465,9 +46566,37 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true + PaginatedFlexClusters20250101: + type: object + properties: + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + results: + type: array + description: List of returned documents that MongoDB Cloud provides when + completing this request. + items: + type: object + readOnly: true + totalCount: + type: integer + format: int32 + description: Total number of documents available. MongoDB Cloud omits this + value if `includeCount` is set to `false`. + minimum: 0 + readOnly: true PaginatedGroupServiceAccounts: type: object - description: List of Service Accounts + description: A list of Project Service Accounts. properties: links: type: array @@ -44482,7 +46611,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/GroupServiceAccount" @@ -44510,7 +46639,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ApiHostView_Atlas" @@ -44538,7 +46667,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ThirdPartyIntegration" @@ -44566,7 +46695,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/LegacyAtlasCluster" @@ -44594,7 +46723,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/NetworkPermissionEntry" @@ -44622,7 +46751,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/BackupOnlineArchive" @@ -44650,7 +46779,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/OrgGroup" @@ -44664,7 +46793,7 @@ components: readOnly: true PaginatedOrgServiceAccounts: type: object - description: List of Service Accounts + description: A list of Organization Service Accounts. properties: links: type: array @@ -44679,7 +46808,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/OrgServiceAccount" @@ -44707,7 +46836,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/AtlasOrganization" @@ -44735,7 +46864,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/IngestionPipelineRun" @@ -44763,7 +46892,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/PrivateNetworkEndpointIdEntry" @@ -44791,7 +46920,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/PublicApiUsageDetailsLineItemView" @@ -44819,7 +46948,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/BackupRestoreJob" @@ -44849,7 +46978,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/AuthFederationRoleMapping" @@ -44877,7 +47006,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ServerlessInstanceDescription" @@ -44891,7 +47020,7 @@ components: readOnly: true PaginatedServiceAccountGroup: type: object - description: List of Service Account projects. + description: A list of projects associated with the Service Account. properties: links: type: array @@ -44906,7 +47035,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ServiceAccountGroup" @@ -44918,7 +47047,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedSnapshotView: + PaginatedServiceAccountIPAccessEntryView: type: object properties: links: @@ -44934,10 +47063,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/BackupSnapshot" + $ref: "#/components/schemas/ServiceAccountIPAccessListEntry" readOnly: true totalCount: type: integer @@ -44946,7 +47075,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedTeamRoleView: + PaginatedSnapshotView: type: object properties: links: @@ -44962,10 +47091,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/TeamRole" + $ref: "#/components/schemas/BackupSnapshot" readOnly: true totalCount: type: integer @@ -44974,7 +47103,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedTeamView: + PaginatedTeamRoleView: type: object properties: links: @@ -44990,10 +47119,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/TeamResponse" + $ref: "#/components/schemas/TeamRole" readOnly: true totalCount: type: integer @@ -45002,7 +47131,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedTenantRestoreView: + PaginatedTeamView: type: object properties: links: @@ -45018,10 +47147,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/TenantRestore" + $ref: "#/components/schemas/TeamResponse" readOnly: true totalCount: type: integer @@ -45030,7 +47159,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedTenantSnapshotView: + PaginatedTenantRestoreView: type: object properties: links: @@ -45046,10 +47175,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/BackupTenantSnapshot" + $ref: "#/components/schemas/TenantRestore" readOnly: true totalCount: type: integer @@ -45058,7 +47187,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedUSSInstance20250101: + PaginatedTenantSnapshotView: type: object properties: links: @@ -45074,10 +47203,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - type: object + $ref: "#/components/schemas/BackupTenantSnapshot" readOnly: true totalCount: type: integer @@ -45102,7 +47231,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/UserCert" @@ -45590,6 +47719,13 @@ components: PrivateNetworkEndpointIdEntry: type: object properties: + azureConnectionName: + type: string + description: Connection name that identifies the Azure private endpoint + connection. + 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. @@ -45597,6 +47733,10 @@ components: type: string description: Human-readable label to identify customer's VPC endpoint DNS name. + customerEndpointIPAddress: + type: string + description: IP address used to connect to the Azure private endpoint. + pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" endpointId: type: string description: Unique 22-character alphanumeric string that identifies the @@ -45609,6 +47749,10 @@ components: maxLength: 22 minLength: 22 pattern: "^vpce-[0-9a-f]{17}$" + errorMessage: + type: string + description: Error message describing a failure approving the private endpoint + request. provider: type: string default: AWS @@ -45620,6 +47764,14 @@ components: type: string description: Human-readable label to identify the region of customer's VPC endpoint. + status: + type: string + description: Status of the private endpoint connection request. + enum: + - PENDING + - OK + - FAILED + - DELETING type: type: string default: DATA_LAKE @@ -45689,16 +47841,6 @@ components: - serviceDiscovery - username title: PROMETHEUS - ProxyInfo: - type: object - description: VPC Proxy Information. - properties: - authKey: - type: string - description: Authentication key for the proxy. - dnsName: - type: string - description: DNS name to use to reach the proxy/s. PublicApiUsageDetailsLineItemView: type: object properties: @@ -45790,7 +47932,12 @@ components: enum: - AVERAGE operator: - $ref: "#/components/schemas/Operator" + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - LESS_THAN + - GREATER_THAN threshold: type: number format: double @@ -45841,7 +47988,7 @@ components: example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -46100,7 +48247,12 @@ components: enum: - AVERAGE operator: - $ref: "#/components/schemas/Operator" + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - LESS_THAN + - GREATER_THAN threshold: type: number format: double @@ -46290,7 +48442,7 @@ components: example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -47091,7 +49243,7 @@ components: you loaded the sample dataset. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true completeDate: type: string @@ -47905,7 +50057,7 @@ components: \ this parameter when `\"deliveryType\" : \"download\"`." items: type: string - description: One Uniform Resource Locator that point to the compressed + description: One Uniform Resource Locator that points to the compressed snapshot files for manual download. readOnly: true desiredTimestamp: @@ -47992,7 +50144,7 @@ components: parameter when `"deliveryType":` `"automated"`. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" targetGroupId: type: string description: Unique 24-hexadecimal digit string that identifies the target @@ -48067,7 +50219,7 @@ components: which MongoDB Cloud took this snapshot. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true snapshotType: type: string @@ -48199,7 +50351,7 @@ components: description: Human-readable label that identifies the serverless instance. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" providerSettings: $ref: "#/components/schemas/ServerlessProviderSettings" serverlessBackupOptions: @@ -48268,7 +50420,7 @@ components: description: Human-readable label that identifies the serverless instance. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" writeOnly: true providerSettings: $ref: "#/components/schemas/ServerlessProviderSettings" @@ -48432,7 +50584,12 @@ components: enum: - AVERAGE operator: - $ref: "#/components/schemas/Operator" + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - LESS_THAN + - GREATER_THAN threshold: type: number format: double @@ -48642,7 +50799,11 @@ components: properties: groupId: type: string - description: Unique 24-hexadecimal digit string that identifies the project. + description: "Unique 24-hexadecimal digit string that identifies your project.\ + \ **NOTE**: Groups and projects are synonymous terms. Your group id is\ + \ the same as your project id. For existing groups, your group/project\ + \ id remains the same. The resource and corresponding endpoints use the\ + \ term groups." example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 @@ -48755,6 +50916,54 @@ components: - eventTypeName - id title: ServiceAccount Events + ServiceAccountIPAccessListEntry: + type: object + properties: + cidrBlock: + type: string + description: "Range of network addresses in the access list for the Service\ + \ Account. This parameter requires the range to be expressed in Classless\ + \ Inter-Domain Routing (CIDR) notation of Internet Protocol version 4\ + \ or version 6 addresses. You can set a value for this parameter or **ipAddress**,\ + \ but not for both in the same request." + example: 203.0.113.0/24 + pattern: "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + createdAt: + type: string + format: date-time + description: Date MongoDB Cloud added the entry was added to the Access + List. + readOnly: true + ipAddress: + type: string + description: "Network address in the access list for the Service Account.\ + \ This parameter requires the address to be expressed as one Internet\ + \ Protocol version 4 or version 6 address. You can set a value for this\ + \ parameter or **cidrBlock**, but not for both in the same request." + example: 203.0.113.10 + pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + 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 makes at least one request. + readOnly: true + lastUsedAt: + type: string + format: date-time + description: "Date when MongoDB Cloud received the most recent request that\ + \ originated from this Internet Protocol version 4 or version 6 address.\ + \ The resource returns this parameter when at least one request originates\ + \ from this IP address. MongoDB Cloud updates this parameter each time\ + \ a client accesses the permitted resource, with a delay of up to 5 minutes." + readOnly: true + requestCount: + type: integer + format: int32 + description: The number of requests that has originated from this network + address. + readOnly: true ServiceAccountOrgEvents: type: object description: Service Account event identifies different activities around user @@ -48868,35 +51077,34 @@ components: createdAt: type: string format: date-time - description: Timestamp representing creation time. + description: The date that the secret was created on. readOnly: true expiresAt: type: string format: date-time - description: Timestamp representing secret expiration time. + description: The date for the expiration of the secret. readOnly: true id: type: string - description: Unique 24-hexadecimal character string that identifies the - secret. + description: Unique 24-hexadecimal digit string that identifies the secret. example: 32b6e34b3d91647abb20e7b8 pattern: "^([a-f0-9]{24})$" readOnly: true lastUsedAt: type: string format: date-time - description: Timestamp representing last secret usage. + description: The last time the secret was used. readOnly: true maskedSecretValue: type: string - description: Service Account secret with masked values of the first 20 characters. + description: The masked Service Account secret. example: mdb_ic_sk_...12ce readOnly: true secret: type: string - description: Secret for the service account. It will be returned only the - first time after service account creation. - pattern: "^mdb_sa_sk_[0-9a-zA-Z]{40}$" + description: The secret for the Service Account. It will be returned only + the first time after creation. + pattern: "^mdb_sa_sk_[0-9a-zA-Z_-]{40}$" readOnly: true required: - createdAt @@ -48908,7 +51116,8 @@ components: secretExpiresAfterHours: type: integer format: int32 - description: Number of hours representing validity duration for secret. + description: The expiration time of the new Service Account secret. The + expiration is provided in hours. required: - secretExpiresAfterHours ShardEntry: @@ -49531,17 +51740,19 @@ components: StreamsDLQ: type: object description: Dead letter queue for the stream processor. + externalDocs: + url: https://www.mongodb.com/docs/atlas/reference/glossary/#std-term-dead-letter-queue properties: coll: type: string - description: Name of the collection that will be used for the DLQ. + description: Name of the collection to use for the DLQ. connectionName: type: string - description: Connection name that will be used to write DLQ messages to. - Has to be an Atlas connection. + description: Name of the connection to write DLQ messages to. Must be an + Atlas connection. db: type: string - description: Name of the database that will be used for the DLQ. + description: Name of the database to use for the DLQ. links: type: array description: "List of one or more Uniform Resource Locators (URLs) that\ @@ -49710,8 +51921,6 @@ components: group.protocol.type: consumer networking: $ref: "#/components/schemas/StreamsKafkaNetworking" - proxyInfo: - $ref: "#/components/schemas/ProxyInfo" security: $ref: "#/components/schemas/StreamsKafkaSecurity" StreamsKafkaNetworking: @@ -49737,6 +51946,13 @@ components: type: object description: Information about the networking access. properties: + connectionId: + type: string + description: Reserved. Will be used by PRIVATE_LINK connection type. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" links: type: array description: "List of one or more Uniform Resource Locators (URLs) that\ @@ -49750,14 +51966,18 @@ components: readOnly: true name: type: string - description: Id of the vpc peer when the type is VPC. + description: Reserved. Will be used by PRIVATE_LINK connection type. type: type: string - description: Selected networking type. Either PUBLIC or VPC. Defaults to - PUBLIC + description: "Selected networking type. Either PUBLIC, VPC or PRIVATE_LINK.\ + \ Defaults to PUBLIC. For VPC, ensure that VPC peering exists and connectivity\ + \ has been established between Atlas VPC and the VPC where Kafka cluster\ + \ is hosted for the connection to function properly. PRIVATE_LINK support\ + \ is coming soon." enum: - PUBLIC - VPC + - PRIVATE_LINK title: Networking Access Type StreamsKafkaSecurity: type: object @@ -49836,6 +52056,52 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true + StreamsPrivateLinkConnection: + type: object + description: Container for metadata needed to create a Private Link connection. + properties: + _id: + type: string + description: The ID of the Private Link connection. + dnsDomain: + type: string + description: Domain name of Confluent cluster. + dnsSubDomain: + type: array + description: Sub-Domain name of Confluent cluster. These are typically your + availability zones. + items: + type: string + interfaceEndpointId: + type: string + description: Interface endpoint ID that is created from the service endpoint + ID provided. + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + provider: + type: string + description: Provider where the Kafka cluster is deployed. + region: + type: string + description: Domain name of Confluent cluster. + serviceEndpointId: + type: string + description: AWS Service Endpoint ID. + state: + type: string + description: State the connection is in. + vendor: + type: string + description: Vendor who manages the Kafka cluster. StreamsProcessor: type: object description: An atlas stream processor. @@ -49869,6 +52135,9 @@ components: type: array description: Stream aggregation pipeline you want to apply to your streaming data. + externalDocs: + description: Supported Aggregation Pipeline Stages + url: https://www.mongodb.com/docs/atlas/atlas-stream-processing/stream-aggregation/#std-label-stream-aggregation items: $ref: "#/components/schemas/Document" StreamsProcessorWithStats: @@ -49899,6 +52168,8 @@ components: type: string description: Human-readable name of the stream processor. readOnly: true + options: + $ref: "#/components/schemas/StreamsOptions" pipeline: type: array description: Stream aggregation pipeline you want to apply to your streaming @@ -49908,15 +52179,20 @@ components: readOnly: true state: type: string - description: The state of the stream processor. + description: "The state of the stream processor. Commonly occurring states\ + \ are 'CREATED', 'STARTED', 'STOPPED' and 'FAILED'." readOnly: true stats: type: object additionalProperties: type: object description: The stats associated with the stream processor. + externalDocs: + url: https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor readOnly: true description: The stats associated with the stream processor. + externalDocs: + url: https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor readOnly: true required: - _id @@ -49927,6 +52203,26 @@ components: type: object allOf: - $ref: "#/components/schemas/StreamsConnection" + StreamsSampleConnections: + type: object + description: Sample connections to add to SPI. + properties: + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + solar: + type: boolean + default: false + description: Flag that indicates whether to add a 'sample_stream_solar' + connection. StreamsTenant: type: object properties: @@ -49978,6 +52274,8 @@ components: name: type: string description: Human-readable label that identifies the stream instance. + sampleConnections: + $ref: "#/components/schemas/StreamsSampleConnections" streamConfig: $ref: "#/components/schemas/StreamConfig" SummaryNotification: @@ -50638,7 +52936,7 @@ components: description: Human-readable label that identifies the source cluster. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true deliveryType: type: string @@ -50748,6 +53046,8 @@ components: required: - snapshotId - targetDeploymentItemName + TenantWithSampleConnections: + type: object TextSearchHostStatusDetail: type: object properties: @@ -50964,808 +53264,199 @@ components: type: array description: List of documents detailing index status on each host. items: - $ref: "#/components/schemas/TextSearchHostStatusDetail" - synonymMappingStatus: - type: string - description: Status that describes this index's synonym mappings. This - status appears only if the index has synonyms defined. - enum: - - FAILED - - BUILDING - - READY - synonymMappingStatusDetail: - type: array - description: A list of documents describing the status of the index's - synonym mappings on each search host. Only appears if the index has - synonyms defined. - items: - type: object - additionalProperties: - $ref: "#/components/schemas/SynonymMappingStatusDetail" - title: Text Search Index Response - TextSearchIndexStatusDetail: - type: object - description: Contains status information about a text search index. - properties: - definition: - $ref: "#/components/schemas/TextSearchIndexDefinition" - definitionVersion: - $ref: "#/components/schemas/SearchIndexDefinitionVersion" - message: - type: string - description: Optional message describing an error. - queryable: - type: boolean - description: Flag that indicates whether the index generation is queryable - on the host. - status: - type: string - description: | - Condition of the search index when you made this request. - - | Status | Index Condition | - |---|---| - | DELETING | The index is being deleted. | - | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. | - | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. | - | PENDING | Atlas has not yet started building the index. | - | BUILDING | Atlas is building or re-building the index after an edit. | - | READY | The index is ready and can support queries. | - enum: - - DELETING - - FAILED - - STALE - - PENDING - - BUILDING - - READY - - DOES_NOT_EXIST - synonymMappingStatus: - type: string - description: Status that describes this index's synonym mappings. This status - appears only if the index has synonyms defined. - enum: - - FAILED - - BUILDING - - READY - synonymMappingStatusDetail: - type: array - description: List of synonym statuses by mapping. - items: - $ref: "#/components/schemas/SynonymMappingStatusDetailMap" - title: Text Search Index Status Detail - ThirdPartyIntegration: - type: object - description: Collection of settings that describe third-party integrations. - discriminator: - mapping: - DATADOG: "#/components/schemas/Datadog" - MICROSOFT_TEAMS: "#/components/schemas/MicrosoftTeams" - NEW_RELIC: "#/components/schemas/NewRelic" - OPS_GENIE: "#/components/schemas/OpsGenie" - PAGER_DUTY: "#/components/schemas/PagerDuty" - PROMETHEUS: "#/components/schemas/Prometheus" - SLACK: "#/components/schemas/Slack" - VICTOR_OPS: "#/components/schemas/VictorOps" - WEBHOOK: "#/components/schemas/Webhook" - propertyName: type - properties: - id: - type: string - description: Integration id. - nullable: true - type: - type: string - description: Integration type - enum: - - PAGER_DUTY - - SLACK - - DATADOG - - NEW_RELIC - - OPS_GENIE - - VICTOR_OPS - - WEBHOOK - - HIP_CHAT - - PROMETHEUS - - MICROSOFT_TEAMS - title: Integration Type - title: Third-Party Integration - TimeMetricAlertView: - type: object - properties: - acknowledgedUntil: - type: string - format: date-time - description: |- - Date and time until which this alert has been acknowledged. This parameter expresses its value in the 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. - acknowledgementComment: - type: string - description: Comment that a MongoDB Cloud user submitted when acknowledging - the alert. - example: Expiration on 3/19. Silencing for 7days. - maxLength: 200 - acknowledgingUsername: - type: string - format: email - description: MongoDB Cloud username of the person who acknowledged the alert. - The response returns this parameter if a MongoDB Cloud user previously - acknowledged this alert. - readOnly: true - alertConfigId: - type: string - description: Unique 24-hexadecimal digit string that identifies the alert - configuration that sets this alert. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - clusterName: - 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." - example: cluster1 - maxLength: 64 - minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - readOnly: true - created: - type: string - format: date-time - description: Date and time when MongoDB Cloud created this alert. This parameter - expresses its value in the ISO 8601 timestamp format - in UTC. - readOnly: true - currentValue: - $ref: "#/components/schemas/TimeMetricValueView" - eventTypeName: - $ref: "#/components/schemas/HostMetricEventTypeViewAlertable" - groupId: - type: string - description: Unique 24-hexadecimal digit string that identifies the project - that owns this alert. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - 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. - example: cloud-test.mongodb.com:27017 - readOnly: true - id: - type: string - description: Unique 24-hexadecimal digit string that identifies this alert. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - lastNotified: - type: string - format: date-time - description: Date and time that any notifications were last sent for this - alert. This parameter expresses its value in the ISO 8601 timestamp format - in UTC. The resource returns this parameter if MongoDB Cloud has sent - notifications for this alert. - readOnly: true - links: - type: array - description: "List of one or more Uniform Resource Locators (URLs) that\ - \ point to API sub-resources, related API resources, or both. RFC 5988\ - \ outlines these relationships." - externalDocs: - description: Web Linking Specification (RFC 5988) - url: https://datatracker.ietf.org/doc/html/rfc5988 - items: - $ref: "#/components/schemas/Link" - readOnly: true - 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. - example: ASSERT_USER - readOnly: true - orgId: - type: string - description: Unique 24-hexadecimal character string that identifies the - organization that owns the project to which this alert applies. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - 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." - example: event-replica-set - readOnly: true - resolved: - type: string - format: date-time - description: "Date and time that this alert changed to `\"status\" : \"\ - CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp\ - \ format in UTC. The resource returns this parameter once `\"status\"\ - \ : \"CLOSED\"`." - readOnly: true - status: - type: string - description: State of this alert at the time you requested its details. - enum: - - CANCELLED - - CLOSED - - OPEN - - TRACKING - example: OPEN - readOnly: true - updated: - type: string - format: date-time - description: Date and time when someone last updated this alert. This parameter - expresses its value in the ISO 8601 timestamp format - in UTC. - readOnly: true - required: - - alertConfigId - - created - - eventTypeName - - id - - status - - updated - TimeMetricEventView: - type: object - properties: - apiKeyId: - type: string - description: "Unique 24-hexadecimal digit string that identifies the [API\ - \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\ - \ triggered the event. If this resource returns this parameter, it doesn't\ - \ return the **userId** parameter." - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - created: - type: string - format: date-time - description: Date and time when this event occurred. This parameter expresses - its value in the ISO 8601 timestamp format in UTC. - readOnly: true - currentValue: - $ref: "#/components/schemas/TimeMetricValueView" - eventTypeName: - $ref: "#/components/schemas/HostMetricEventTypeView" - groupId: - type: string - description: Unique 24-hexadecimal digit string that identifies the project - in which the event occurred. The **eventId** identifies the specific event. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - id: - type: string - description: Unique 24-hexadecimal digit string that identifies the event. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - isGlobalAdmin: - type: boolean - default: false - description: Flag that indicates whether a MongoDB employee triggered the - specified event. - readOnly: true - links: - type: array - description: "List of one or more Uniform Resource Locators (URLs) that\ - \ point to API sub-resources, related API resources, or both. RFC 5988\ - \ outlines these relationships." - externalDocs: - description: Web Linking Specification (RFC 5988) - url: https://datatracker.ietf.org/doc/html/rfc5988 - items: - $ref: "#/components/schemas/Link" - readOnly: true - 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: - type: string - description: Unique 24-hexadecimal digit string that identifies the organization - to which these events apply. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - port: - type: integer - format: int32 - description: IANA port on which the MongoDB process listens for requests. - example: 27017 - readOnly: true - publicKey: - type: string - format: email - description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\ - \ that triggered the event. If this resource returns this parameter, it\ - \ doesn't return the **username** parameter." - example: test.user@mongodb.com - readOnly: true - raw: - $ref: "#/components/schemas/raw" - remoteAddress: - type: string - description: IPv4 or IPv6 address from which the user triggered this event. - example: 216.172.40.186 - pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" - readOnly: true - replicaSetName: - type: string - description: Human-readable label of the replica set associated with the - event. - example: event-replica-set - readOnly: true - shardName: - type: string - description: Human-readable label of the shard associated with the event. - example: event-sh-01 - readOnly: true - userId: - type: string - description: "Unique 24-hexadecimal digit string that identifies the console\ - \ user who triggered the event. If this resource returns this parameter,\ - \ it doesn't return the **apiKeyId** parameter." - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - username: - type: string - format: email - description: "Email address for the user who triggered this event. If this\ - \ resource returns this parameter, it doesn't return the **publicApiKey**\ - \ parameter." - example: test.user@mongodb.com - readOnly: true - required: - - created - - eventTypeName - - id - TimeMetricThresholdView: - 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: - $ref: "#/components/schemas/Operator" - threshold: - type: number - format: double - description: "Value of metric that, when exceeded, triggers an alert." - units: - $ref: "#/components/schemas/TimeMetricUnits" - required: - - metricName - TimeMetricUnits: - type: string - default: HOURS - description: "Element used to express the quantity. This can be an element of\ - \ time, storage capacity, and the like." - enum: - - NANOSECONDS - - MILLISECONDS - - MILLION_MINUTES - - SECONDS - - MINUTES - - HOURS - - DAYS - title: Time Metric Units - TimeMetricValueView: - type: object - description: Measurement of the **metricName** recorded at the time of the event. - properties: - number: - type: number - format: double - description: Amount of the **metricName** recorded at the time of the event. - This value triggered the alert. - readOnly: true - units: - $ref: "#/components/schemas/TimeMetricUnits" - readOnly: true - title: Time Metric Value - TokenFilterEnglishPossessive: - type: object - description: Filter that removes possessives (trailing 's) from words. - properties: - type: - type: string - description: Human-readable label that identifies this token filter type. - enum: - - englishPossessive - required: - - type - title: englishPossessive - TokenFilterFlattenGraph: - type: object - description: "Filter that transforms a token filter graph, such as the token\ - \ filter graph that the wordDelimiterGraph token filter produces, into a flat\ - \ form suitable for indexing." - properties: - type: - type: string - description: Human-readable label that identifies this token filter type. - enum: - - flattenGraph - required: - - type - title: flattenGraph - TokenFilterPorterStemming: + $ref: "#/components/schemas/TextSearchHostStatusDetail" + synonymMappingStatus: + type: string + description: Status that describes this index's synonym mappings. This + status appears only if the index has synonyms defined. + enum: + - FAILED + - BUILDING + - READY + synonymMappingStatusDetail: + type: array + description: A list of documents describing the status of the index's + synonym mappings on each search host. Only appears if the index has + synonyms defined. + items: + type: object + additionalProperties: + $ref: "#/components/schemas/SynonymMappingStatusDetail" + title: Text Search Index Response + TextSearchIndexStatusDetail: type: object - 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. + description: Contains status information about a text search index. properties: - type: + definition: + $ref: "#/components/schemas/TextSearchIndexDefinition" + definitionVersion: + $ref: "#/components/schemas/SearchIndexDefinitionVersion" + message: type: string - description: Human-readable label that identifies this token filter type. - enum: - - porterStemming - required: - - type - title: porterStemming - TokenFilterSpanishPluralStemming: - type: object - description: Filter that stems Spanish plural words. It expects lowercase text. - properties: - type: + description: Optional message describing an error. + queryable: + type: boolean + description: Flag that indicates whether the index generation is queryable + on the host. + status: type: string - description: Human-readable label that identifies this token filter type. + description: | + Condition of the search index when you made this request. + + | Status | Index Condition | + |---|---| + | DELETING | The index is being deleted. | + | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. | + | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. | + | PENDING | Atlas has not yet started building the index. | + | BUILDING | Atlas is building or re-building the index after an edit. | + | READY | The index is ready and can support queries. | enum: - - spanishPluralStemming - required: - - type - title: spanishPluralStemming - TokenFilterStempel: - type: object - description: Filter that uses Lucene's default Polish stemmer table to stem - words in the Polish language. It expects lowercase text. - externalDocs: - description: Default Polish stemmer table - url: https://lucene.apache.org/core/9_2_0/analysis/stempel/org/apache/lucene/analysis/pl/PolishAnalyzer.html#DEFAULT_STEMMER_FILE - properties: - type: + - DELETING + - FAILED + - STALE + - PENDING + - BUILDING + - READY + - DOES_NOT_EXIST + synonymMappingStatus: type: string - description: Human-readable label that identifies this token filter type. + description: Status that describes this index's synonym mappings. This status + appears only if the index has synonyms defined. enum: - - stempel - required: - - type - title: stempel - TokenFilterWordDelimiterGraph: + - FAILED + - BUILDING + - READY + synonymMappingStatusDetail: + type: array + description: List of synonym statuses by mapping. + items: + $ref: "#/components/schemas/SynonymMappingStatusDetailMap" + title: Text Search Index Status Detail + ThirdPartyIntegration: type: object - description: Filter that splits tokens into sub-tokens based on configured rules. + description: Collection of settings that describe third-party integrations. + discriminator: + mapping: + DATADOG: "#/components/schemas/Datadog" + MICROSOFT_TEAMS: "#/components/schemas/MicrosoftTeams" + NEW_RELIC: "#/components/schemas/NewRelic" + OPS_GENIE: "#/components/schemas/OpsGenie" + PAGER_DUTY: "#/components/schemas/PagerDuty" + PROMETHEUS: "#/components/schemas/Prometheus" + SLACK: "#/components/schemas/Slack" + VICTOR_OPS: "#/components/schemas/VictorOps" + WEBHOOK: "#/components/schemas/Webhook" + propertyName: type properties: - delimiterOptions: - type: object - description: Object that contains the rules that determine how to split - words into sub-words. - properties: - concatenateAll: - type: boolean - default: false - description: Flag that indicates whether to concatenate runs. - concatenateNumbers: - type: boolean - default: false - description: Flag that indicates whether to concatenate runs of sub-numbers. - concatenateWords: - type: boolean - default: false - description: Flag that indicates whether to concatenate runs of sub-words. - generateNumberParts: - type: boolean - default: true - description: "Flag that indicates whether to split tokens based on sub-numbers.\ - \ For example, if `true`, this option splits `100-2` into `100` and\ - \ `2`." - generateWordParts: - type: boolean - default: true - description: Flag that indicates whether to split tokens based on sub-words. - ignoreKeywords: - type: boolean - default: false - description: Flag that indicates whether to skip tokens with the `keyword` - attribute set to `true` - preserveOriginal: - type: boolean - default: true - description: Flag that indicates whether to generate tokens of the original - words. - splitOnCaseChange: - type: boolean - default: true - description: Flag that indicates whether to split tokens based on letter-case - transitions. - splitOnNumerics: - type: boolean - default: true - description: Flag that indicates whether to split tokens based on letter-number - transitions. - stemEnglishPossessive: - type: boolean - default: true - description: Flag that indicates whether to remove trailing possessives - from each sub-word. - protectedWords: - type: object - description: Object that contains options for protected words. - properties: - ignoreCase: - type: boolean - default: true - description: Flag that indicates whether to ignore letter case sensitivity - for protected words. - words: - type: array - description: List that contains the tokens to protect from delimination. - items: - type: string - required: - - words - type: + id: type: string - description: Human-readable label that identifies this token filter type. - enum: - - wordDelimiterGraph - required: - - type - title: wordDelimiterGraph - TokenFilterkStemming: - type: object - description: Filter that combines algorithmic stemming with a built-in dictionary - for the English language to stem words. - properties: + description: Integration id. + nullable: true type: type: string - description: Human-readable label that identifies this token filter type. + description: Integration type enum: - - kStemming - required: - - type - title: kStemming - TriggerIngestionPipelineRequest: - type: object - properties: - datasetRetentionPolicy: - $ref: "#/components/schemas/DatasetRetentionPolicy" - snapshotId: - type: string - description: Unique 24-hexadecimal character string that identifies the - snapshot. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - writeOnly: true - required: - - snapshotId - USSBackupRestoreJob20250101: + - PAGER_DUTY + - SLACK + - DATADOG + - NEW_RELIC + - OPS_GENIE + - VICTOR_OPS + - WEBHOOK + - HIP_CHAT + - PROMETHEUS + - MICROSOFT_TEAMS + title: Integration Type + title: Third-Party Integration + TimeMetricAlertView: type: object - description: Details for one restore job of a USS instance. properties: - deliveryType: - type: string - description: Means by which this resource returns the snapshot to the requesting - MongoDB Cloud user. - enum: - - RESTORE - - DOWNLOAD - readOnly: true - expirationDate: - type: string - format: date-time - description: Date and time when the download link no longer works. This - parameter expresses its value in the ISO 8601 timestamp format in UTC. - readOnly: true - id: - type: string - description: Unique 24-hexadecimal digit string that identifies the restore - job. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - instanceName: - type: string - description: Human-readable label that identifies the source instance. - maxLength: 64 - minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - readOnly: true - links: - type: array - description: "List of one or more Uniform Resource Locators (URLs) that\ - \ point to API sub-resources, related API resources, or both. RFC 5988\ - \ outlines these relationships." - externalDocs: - description: Web Linking Specification (RFC 5988) - url: https://datatracker.ietf.org/doc/html/rfc5988 - items: - $ref: "#/components/schemas/Link" - readOnly: true - projectId: - type: string - description: Unique 24-hexadecimal digit string that identifies the project - from which the restore job originated. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - restoreFinishedDate: + acknowledgedUntil: type: string format: date-time - 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. - readOnly: true - restoreScheduledDate: + 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. + acknowledgementComment: type: string - format: date-time - description: Date and time when MongoDB Cloud will restore this snapshot. - This parameter expresses its value in the ISO 8601 timestamp format in - UTC. - readOnly: true - snapshotFinishedDate: + description: Comment that a MongoDB Cloud user submitted when acknowledging + the alert. + example: Expiration on 3/19. Silencing for 7days. + maxLength: 200 + acknowledgingUsername: type: string - format: date-time - description: Date and time when MongoDB Cloud completed writing this snapshot. - This parameter expresses its value in the ISO 8601 timestamp format in - UTC. + format: email + description: MongoDB Cloud username of the person who acknowledged the alert. + The response returns this parameter if a MongoDB Cloud user previously + acknowledged this alert. readOnly: true - snapshotId: + alertConfigId: type: string - description: Unique 24-hexadecimal digit string that identifies the snapshot - to restore. + description: Unique 24-hexadecimal digit string that identifies the alert + configuration that sets this alert. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true - 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. - enum: - - PENDING - - QUEUED - - RUNNING - - FAILED - - COMPLETED - readOnly: true - targetDeploymentItemName: + clusterName: type: string - description: Human-readable label that identifies the instance or cluster - on the target project to which you want to restore the snapshot. You can - restore the snapshot to another USS instance or Dedicated cluster tier. + description: "Human-readable label that identifies the cluster to which\ + \ this alert applies. This resource returns this parameter for alerts\ + \ of events impacting backups, replica sets, or sharded clusters." + example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true - targetProjectId: + created: type: string - description: Unique 24-hexadecimal digit string that identifies the project - that contains the instance or cluster to which you want to restore the - snapshot. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" + format: date-time + description: Date and time when MongoDB Cloud created this alert. This parameter + expresses its value in the ISO 8601 timestamp format + in UTC. readOnly: true - title: USS Backup Restore Job - USSBackupRestoreJobCreate20250101: - type: object - description: Details to create one restore job of a USS instance. - properties: - _snapshotId: - type: string - description: Unique 24-hexadecimal digit string that identifies the snapshot - to restore. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - writeOnly: true - _targetDeploymentItemName: - type: string - description: Human-readable label that identifies the instance or cluster - on the target project to which you want to restore the snapshot. You can - restore the snapshot to another USS instance or Dedicated cluster tier. - maxLength: 64 - minLength: 1 - pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" - writeOnly: true - _targetProjectId: + currentValue: + $ref: "#/components/schemas/TimeMetricValueView" + eventTypeName: + $ref: "#/components/schemas/HostMetricEventTypeViewAlertable" + groupId: type: string description: Unique 24-hexadecimal digit string that identifies the project - that contains the instance or cluster to which you want to restore the - snapshot. + that owns this alert. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" - writeOnly: true - deliveryType: - type: string - description: Means by which this resource returns the snapshot to the requesting - MongoDB Cloud user. - enum: - - RESTORE - - DOWNLOAD readOnly: true - expirationDate: + hostnameAndPort: type: string - format: date-time - description: Date and time when the download link no longer works. This - parameter expresses its value in the ISO 8601 timestamp format in UTC. + description: Hostname and port of the host to which this alert applies. + The resource returns this parameter for alerts of events impacting hosts + or replica sets. + example: cloud-test.mongodb.com:27017 readOnly: true id: type: string - description: Unique 24-hexadecimal digit string that identifies the restore - job. + description: Unique 24-hexadecimal digit string that identifies this alert. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true - instanceName: + lastNotified: type: string - description: Human-readable label that identifies the source instance. - maxLength: 64 - minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + format: date-time + 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. readOnly: true links: type: array @@ -51778,94 +53469,114 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true - projectId: + metricName: type: string - description: Unique 24-hexadecimal digit string that identifies the project - from which the restore job originated. + 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. + example: ASSERT_USER + readOnly: true + orgId: + type: string + description: Unique 24-hexadecimal character string that identifies the + organization that owns the project to which this alert applies. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true - restoreFinishedDate: - type: string - format: date-time - 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. - readOnly: true - restoreScheduledDate: + replicaSetName: type: string - format: date-time - description: Date and time when MongoDB Cloud will restore this snapshot. - This parameter expresses its value in the ISO 8601 timestamp format in - UTC. + description: "Name of the replica set to which this alert applies. The response\ + \ returns this parameter for alerts of events impacting backups, hosts,\ + \ or replica sets." + example: event-replica-set readOnly: true - snapshotFinishedDate: + resolved: type: string format: date-time - description: Date and time when MongoDB Cloud completed writing this snapshot. - This parameter expresses its value in the ISO 8601 timestamp format in - UTC. - readOnly: true - snapshotUrl: - type: string - description: "Internet address from which you can download the compressed\ - \ snapshot files. The resource returns this parameter when `\"deliveryType\"\ - \ : \"DOWNLOAD\"`." + 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\"`." readOnly: true status: type: string - description: Phase of the restore workflow for this job at the time this - resource made this request. + description: State of this alert at the time you requested its details. enum: - - PENDING - - QUEUED - - RUNNING - - FAILED - - COMPLETED + - CANCELLED + - CLOSED + - OPEN + - TRACKING + example: OPEN + readOnly: true + updated: + type: string + format: date-time + description: Date and time when someone last updated this alert. This parameter + expresses its value in the ISO 8601 timestamp format + in UTC. readOnly: true required: - - _snapshotId - - _targetDeploymentItemName - title: Create USS Backup Restore Job - USSBackupSettings20250101: + - alertConfigId + - created + - eventTypeName + - id + - status + - updated + TimeMetricEventView: type: object - description: USS backup configuration properties: - enabled: - type: boolean - default: true - description: "Flag that indicates whether backups are performed for this\ - \ USS instance. Backup uses [TODO](TODO) for USS instances." + apiKeyId: + type: string + description: "Unique 24-hexadecimal digit string that identifies the [API\ + \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\ + \ triggered the event. If this resource returns this parameter, it doesn't\ + \ return the **userId** parameter." + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" readOnly: true - readOnly: true - title: USS backup configuration - USSBackupSnapshot20250101: - type: object - description: Details for one snapshot of a USS instance. - properties: - expiration: + created: type: string format: date-time - description: Date and time when the download link no longer works. This - parameter expresses its value in the ISO 8601 timestamp format in UTC. + description: Date and time when this event occurred. This parameter expresses + its value in the ISO 8601 timestamp format in UTC. readOnly: true - finishTime: + currentValue: + $ref: "#/components/schemas/TimeMetricValueView" + eventTypeName: + $ref: "#/components/schemas/HostMetricEventTypeView" + groupId: type: string - format: date-time - description: Date and time when MongoDB Cloud completed writing this snapshot. - This parameter expresses its value in the ISO 8601 timestamp format in - UTC. + description: Unique 24-hexadecimal digit string that identifies the project + in which the event occurred. The **eventId** identifies the specific event. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" readOnly: true id: type: string - description: Unique 24-hexadecimal digit string that identifies the snapshot. + description: Unique 24-hexadecimal digit string that identifies the event. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true + isGlobalAdmin: + type: boolean + default: false + description: Flag that indicates whether a MongoDB employee triggered the + specified event. + readOnly: true links: type: array description: "List of one or more Uniform Resource Locators (URLs) that\ @@ -51877,307 +53588,307 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true - mongoDBVersion: - type: string - description: MongoDB host version that the snapshot runs. - readOnly: true - scheduledTime: - type: string - format: date-time - description: Date and time when MongoDB Cloud will take the snapshot. This - parameter expresses its value in the ISO 8601 timestamp format in UTC. - readOnly: true - startTime: - type: string - format: date-time - description: Date and time when MongoDB Cloud began taking the snapshot. - This parameter expresses its value in the ISO 8601 timestamp format in - UTC. - readOnly: true - status: + metricName: type: string - description: Phase of the workflow for this snapshot at the time this resource - made this request. - enum: - - PENDING - - QUEUED - - RUNNING - - FAILED - - COMPLETED + description: Human-readable label of the metric associated with the **alertId**. + This field may change type of **currentValue** field. readOnly: true - title: USS Backup Snapshot - USSBackupSnapshotDownloadCreate20250101: - type: object - description: Details for one backup snapshot download of a USS instance. - properties: - _snapshotId: + orgId: type: string - description: Unique 24-hexadecimal digit string that identifies the snapshot - to download. + description: Unique 24-hexadecimal digit string that identifies the organization + to which these events apply. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" - writeOnly: true - links: - type: array - description: "List of one or more Uniform Resource Locators (URLs) that\ - \ point to API sub-resources, related API resources, or both. RFC 5988\ - \ outlines these relationships." - externalDocs: - description: Web Linking Specification (RFC 5988) - url: https://datatracker.ietf.org/doc/html/rfc5988 - items: - $ref: "#/components/schemas/Link" readOnly: true - required: - - _snapshotId - title: USS Backup Snapshot Download Create - USSConnectionStrings20250101: - type: object - description: Collection of Uniform Resource Locators that point to the MongoDB - database. - externalDocs: - description: Connection string URI format. - url: https://docs.mongodb.com/manual/reference/connection-string/ - properties: - standard: - type: string - description: Public connection string that you can use to connect to this - cluster. This connection string uses the mongodb:// protocol. - externalDocs: - description: Connection String URI Format - url: https://docs.mongodb.com/manual/reference/connection-string/ + port: + type: integer + format: int32 + description: IANA port on which the MongoDB process listens for requests. + example: 27017 readOnly: true - standardSrv: + publicKey: type: string - description: Public connection string that you can use to connect to this - USS instance. This connection string uses the `mongodb+srv://` protocol. - externalDocs: - description: Connection String URI Format - url: https://docs.mongodb.com/manual/reference/connection-string/ + format: email + description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\ + \ that triggered the event. If this resource returns this parameter, it\ + \ doesn't return the **username** parameter." + example: test.user@mongodb.com readOnly: true - readOnly: true - title: USS Instance Connection Strings - USSInstanceDescription20250101: - type: object - description: Group of settings that configure a MongoDB USS instance. - properties: - backupSettings: - $ref: "#/components/schemas/USSBackupSettings20250101" - clusterType: + raw: + $ref: "#/components/schemas/raw" + remoteAddress: type: string - description: USS instance topology. - enum: - - REPLICASET - - LOADBALANCED + description: IPv4 or IPv6 address from which the user triggered this event. + example: 216.172.40.186 + pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" readOnly: true - connectionStrings: - $ref: "#/components/schemas/USSConnectionStrings20250101" - createDate: + replicaSetName: type: string - format: date-time - description: Date and time when MongoDB Cloud created this instance. This - parameter expresses its value in ISO 8601 format in UTC. + description: Human-readable label of the replica set associated with the + event. + example: event-replica-set readOnly: true - groupId: + shardName: type: string - description: Unique 24-hexadecimal character string that identifies the - project. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" + description: Human-readable label of the shard associated with the event. + example: event-sh-01 readOnly: true - id: + userId: type: string - description: Unique 24-hexadecimal digit string that identifies the instance. + description: "Unique 24-hexadecimal digit string that identifies the console\ + \ user who triggered the event. If this resource returns this parameter,\ + \ it doesn't return the **apiKeyId** parameter." example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true - links: - type: array - description: "List of one or more Uniform Resource Locators (URLs) that\ - \ point to API sub-resources, related API resources, or both. RFC 5988\ - \ outlines these relationships." - externalDocs: - description: Web Linking Specification (RFC 5988) - url: https://datatracker.ietf.org/doc/html/rfc5988 - items: - $ref: "#/components/schemas/Link" - readOnly: true - mongoDBVersion: + username: type: string - description: Version of MongoDB that the instance runs. - pattern: "([\\d]+\\.[\\d]+\\.[\\d]+)" + format: email + description: "Email address for the user who triggered this event. If this\ + \ resource returns this parameter, it doesn't return the **publicApiKey**\ + \ parameter." + example: test.user@mongodb.com readOnly: true - name: + required: + - created + - eventTypeName + - id + TimeMetricThresholdView: + type: object + properties: + metricName: type: string - description: Human-readable label that identifies the instance. - maxLength: 64 - minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - readOnly: true - providerSettings: - $ref: "#/components/schemas/USSProviderSettings20250101" - stateName: + description: Human-readable label that identifies the metric against which + MongoDB Cloud checks the configured **metricThreshold.threshold**. + mode: type: string - description: Human-readable label that indicates the current operating condition - of this instance. + description: MongoDB Cloud computes the current metric value as an average. enum: - - IDLE - - CREATING - - UPDATING - - DELETING - - REPAIRING - readOnly: true - tags: - type: array - description: List that contains key-value pairs between 1 to 255 characters - in length for tagging and categorizing the instance. - externalDocs: - description: Resource Tags - url: https://dochub.mongodb.org/core/add-cluster-tag-atlas - items: - $ref: "#/components/schemas/ResourceTag" - terminationProtectionEnabled: - type: boolean - default: false - description: "Flag that indicates whether termination protection is enabled\ - \ on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster.\ - \ If set to `false`, MongoDB Cloud will delete the cluster." - versionReleaseSystem: + - AVERAGE + operator: type: string - default: LTS - description: Method by which the cluster maintains the MongoDB versions. + description: Comparison operator to apply when checking the current metric + value. enum: - - LTS - readOnly: true + - LESS_THAN + - GREATER_THAN + threshold: + type: number + format: double + description: "Value of metric that, when exceeded, triggers an alert." + units: + $ref: "#/components/schemas/TimeMetricUnits" required: - - providerSettings - title: USS Instance Description - USSInstanceDescriptionCreate20250101: + - metricName + TimeMetricUnits: + type: string + default: HOURS + description: "Element used to express the quantity. This can be an element of\ + \ time, storage capacity, and the like." + enum: + - NANOSECONDS + - MILLISECONDS + - MILLION_MINUTES + - SECONDS + - MINUTES + - HOURS + - DAYS + title: Time Metric Units + TimeMetricValueView: type: object - description: Settings that you can specify when you create a USS instance. + description: Measurement of the **metricName** recorded at the time of the event. properties: - links: - type: array - description: "List of one or more Uniform Resource Locators (URLs) that\ - \ point to API sub-resources, related API resources, or both. RFC 5988\ - \ outlines these relationships." - externalDocs: - description: Web Linking Specification (RFC 5988) - url: https://datatracker.ietf.org/doc/html/rfc5988 - items: - $ref: "#/components/schemas/Link" + number: + type: number + format: double + description: Amount of the **metricName** recorded at the time of the event. + This value triggered the alert. readOnly: true - name: + units: + $ref: "#/components/schemas/TimeMetricUnits" + readOnly: true + title: Time Metric Value + TokenFilterEnglishPossessive: + type: object + description: Filter that removes possessives (trailing 's) from words. + properties: + type: type: string - description: Human-readable label that identifies the instance. - maxLength: 64 - minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - writeOnly: true - providerSettings: - $ref: "#/components/schemas/USSProviderSettingsCreate20250101" - tags: - type: array - description: List that contains key-value pairs between 1 to 255 characters - in length for tagging and categorizing the instance. - externalDocs: - description: Resource Tags - url: https://dochub.mongodb.org/core/add-cluster-tag-atlas - items: - $ref: "#/components/schemas/ResourceTag" - terminationProtectionEnabled: - type: boolean - default: false - description: "Flag that indicates whether termination protection is enabled\ - \ on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster.\ - \ If set to `false`, MongoDB Cloud will delete the cluster." + description: Human-readable label that identifies this token filter type. + enum: + - englishPossessive required: - - name - - providerSettings - title: USS Instance Description Create - USSProviderSettings20250101: + - type + title: englishPossessive + TokenFilterFlattenGraph: type: object - description: Group of cloud provider settings that configure the provisioned - MongoDB USS instance. + description: "Filter that transforms a token filter graph, such as the token\ + \ filter graph that the wordDelimiterGraph token filter produces, into a flat\ + \ form suitable for indexing." properties: - backingProviderName: + type: type: string - description: Cloud service provider on which MongoDB Cloud provisioned the - USS instance. + description: Human-readable label that identifies this token filter type. enum: - - AWS - - AZURE - - GCP - readOnly: true - diskSizeGB: - type: number - format: double - description: Storage capacity available to the USS instance expressed in - gigabytes. - readOnly: true - providerName: + - flattenGraph + required: + - type + title: flattenGraph + TokenFilterPorterStemming: + type: object + description: Filter that uses the porter stemming algorithm to remove the common + morphological and inflectional suffixes from words in English. It expects + lowercase text and doesn't work as expected for uppercase text. + properties: + type: type: string - default: USS - description: Human-readable label that identifies the cloud service provider. + description: Human-readable label that identifies this token filter type. enum: - - USS - readOnly: true - regionName: + - porterStemming + required: + - type + title: porterStemming + TokenFilterSpanishPluralStemming: + type: object + description: Filter that stems Spanish plural words. It expects lowercase text. + properties: + type: type: string - description: "Human-readable label that identifies the geographic location\ - \ of your MongoDB USS 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/)." - readOnly: true - readOnly: true - title: Cloud Service Provider Settings for a USS Instance - USSProviderSettingsCreate20250101: + description: Human-readable label that identifies this token filter type. + enum: + - spanishPluralStemming + required: + - type + title: spanishPluralStemming + TokenFilterStempel: type: object - description: Group of cloud provider settings that configure the provisioned - MongoDB USS instance. + description: Filter that uses Lucene's default Polish stemmer table to stem + words in the Polish language. It expects lowercase text. + externalDocs: + description: Default Polish stemmer table + url: https://lucene.apache.org/core/9_2_0/analysis/stempel/org/apache/lucene/analysis/pl/PolishAnalyzer.html#DEFAULT_STEMMER_FILE properties: - backingProviderName: + type: type: string - description: Cloud service provider on which MongoDB Cloud provisioned the - serverless instance. + description: Human-readable label that identifies this token filter type. enum: - - AWS - - AZURE - - GCP - writeOnly: true - diskSizeGB: - type: number - format: double - description: Storage capacity available to the USS instance expressed in - gigabytes. - readOnly: true - providerName: + - stempel + required: + - type + title: stempel + TokenFilterWordDelimiterGraph: + type: object + description: Filter that splits tokens into sub-tokens based on configured rules. + properties: + delimiterOptions: + type: object + description: Object that contains the rules that determine how to split + words into sub-words. + properties: + concatenateAll: + type: boolean + default: false + description: Flag that indicates whether to concatenate runs. + concatenateNumbers: + type: boolean + default: false + description: Flag that indicates whether to concatenate runs of sub-numbers. + concatenateWords: + type: boolean + default: false + description: Flag that indicates whether to concatenate runs of sub-words. + generateNumberParts: + type: boolean + default: true + description: "Flag that indicates whether to split tokens based on sub-numbers.\ + \ For example, if `true`, this option splits `100-2` into `100` and\ + \ `2`." + generateWordParts: + type: boolean + default: true + description: Flag that indicates whether to split tokens based on sub-words. + ignoreKeywords: + type: boolean + default: false + description: Flag that indicates whether to skip tokens with the `keyword` + attribute set to `true` + preserveOriginal: + type: boolean + default: true + description: Flag that indicates whether to generate tokens of the original + words. + splitOnCaseChange: + type: boolean + default: true + description: Flag that indicates whether to split tokens based on letter-case + transitions. + splitOnNumerics: + type: boolean + default: true + description: Flag that indicates whether to split tokens based on letter-number + transitions. + stemEnglishPossessive: + type: boolean + default: true + description: Flag that indicates whether to remove trailing possessives + from each sub-word. + protectedWords: + type: object + description: Object that contains options for protected words. + properties: + ignoreCase: + type: boolean + default: true + description: Flag that indicates whether to ignore letter case sensitivity + for protected words. + words: + type: array + description: List that contains the tokens to protect from delimination. + items: + type: string + required: + - words + type: type: string - default: USS - description: Human-readable label that identifies the cloud service provider. + description: Human-readable label that identifies this token filter type. enum: - - USS - readOnly: true - regionName: + - wordDelimiterGraph + required: + - type + title: wordDelimiterGraph + TokenFilterkStemming: + type: object + description: Filter that combines algorithmic stemming with a built-in dictionary + for the English language to stem words. + properties: + type: type: string - description: "Human-readable label that identifies the geographic location\ - \ of your MongoDB USS 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/)." + description: Human-readable label that identifies this token filter type. + enum: + - kStemming + required: + - type + title: kStemming + TriggerIngestionPipelineRequest: + type: object + properties: + datasetRetentionPolicy: + $ref: "#/components/schemas/DatasetRetentionPolicy" + snapshotId: + type: string + description: Unique 24-hexadecimal character string that identifies the + snapshot. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" writeOnly: true required: - - backingProviderName - - regionName - title: Cloud Service Provider Settings for a USS Instance - writeOnly: true + - snapshotId UpdateAtlasOrganizationApiKey: type: object properties: @@ -52892,7 +54603,7 @@ components: Atlas Data Lake that this database user can access. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" type: type: string description: Category of resource that this database user can access. @@ -52951,6 +54662,28 @@ components: required: - match title: User to Distinguished Name Mapping + VPCPeeringActionChallenge: + type: object + description: Container for elements used to challenge the user before taking + certain actions on VPC Peering connections. + properties: + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + requesterAccountId: + type: string + description: The AWS requester account ID. + requesterVpcId: + type: string + description: The AWS requester VPC ID. VectorSearchHostStatusDetail: type: object properties: diff --git a/tools/cli/test/data/split/dev/openapi-v2-2024-08-05.json b/tools/cli/test/data/split/dev/openapi-v2-2024-08-05.json index fe893f311f..89f0ade6c3 100644 --- a/tools/cli/test/data/split/dev/openapi-v2-2024-08-05.json +++ b/tools/cli/test/data/split/dev/openapi-v2-2024-08-05.json @@ -1,7 +1,7 @@ { "openapi" : "3.0.1", "info" : { - "description" : "The MongoDB Atlas Administration API allows developers to manage all components in MongoDB Atlas.\n\nThe Atlas Administration API uses HTTP Digest Authentication to authenticate requests. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request. For example, to [return database access history](#tag/Access-Tracking/operation/listAccessLogsByClusterName) with [cURL](https://en.wikipedia.org/wiki/CURL), run the following command in the terminal:\n\n```\ncurl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true\"\n```\n\nTo learn more, see [Get Started with the Atlas Administration API](https://www.mongodb.com/docs/atlas/configure-api-access/). For support, see [MongoDB Support](https://www.mongodb.com/support/get-started).", + "description" : "The MongoDB Atlas Administration API allows developers to manage all components in MongoDB Atlas.\n\nThe Atlas Administration API uses HTTP Digest Authentication to authenticate requests. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request. For example, to [return database access history](#tag/Access-Tracking/operation/listAccessLogsByClusterName) with [cURL](https://en.wikipedia.org/wiki/CURL), run the following command in the terminal:\n\n```\ncurl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2024-08-05+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true\"\n```\n\nTo learn more, see [Get Started with the Atlas Administration API](https://www.mongodb.com/docs/atlas/configure-api-access/). For support, see [MongoDB Support](https://www.mongodb.com/support/get-started).\n\nYou can also explore the various endpoints available through the Atlas Administration API in MongoDB's [Postman workspace](https://www.postman.com/mongodb-devrel/workspace/mongodb-atlas-administration-apis/).", "license" : { "name" : "CC BY-NC-SA 3.0 US", "url" : "https://creativecommons.org/licenses/by-nc-sa/3.0/us/" @@ -9,7 +9,7 @@ "termsOfService" : "https://www.mongodb.com/mongodb-management-service-terms-and-conditions", "title" : "MongoDB Atlas Administration API", "version" : "2.0", - "x-xgen-sha" : "09d9d18db2111c955a8e01702a27ca2763417782" + "x-xgen-sha" : "e6ba3136dbd0be2a81dd4ed21b9e6c470edd4420" }, "servers" : [ { "url" : "https://cloud.mongodb.com" @@ -57,7 +57,11 @@ "description" : "Returns, adds, edits, and removes Federated Database Instances. This resource requires your project ID. Changes to federated database instance configurations can affect costs.", "name" : "Data Federation" }, { - "description" : "Returns, adds, edits, and removes Atlas Data Lake Pipelines and associated runs.", + "description" : "Returns, edits, and removes Atlas Data Lake Pipelines and associated runs.", + "externalDocs" : { + "description" : "Data Lake Pipelines are deprecated. Please see Data Lake Deprecation Guide.", + "url" : "https://dochub.mongodb.org/core/data-lake-deprecation" + }, "name" : "Data Lake Pipelines" }, { "description" : "Returns, adds, edits, and removes database users.", @@ -119,6 +123,9 @@ }, { "description" : "You can continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket. Atlas exports logs every 5 minutes.", "name" : "Push-Based Log Export" + }, { + "description" : "Configure and manage Atlas Resource Policies within your organization.", + "name" : "Resource Policies" }, { "description" : "Creates one index to a database deployment in a rolling manner. You can't create a rolling index on an `M0` free cluster or `M2/M5` shared cluster.", "name" : "Rolling Index" @@ -135,6 +142,13 @@ "url" : "https://dochub.mongodb.org/core/serverless-private-endpoint" }, "name" : "Serverless Private Endpoints" + }, { + "description" : "Endpoints for managing Service Accounts and secrets. Service Accounts are used for programmatic access to the Atlas Admin API through the OAuth 2.0 Client Credentials flow. This feature is available as a Preview feature.", + "externalDocs" : { + "description" : "Get Started with the Atlas Administration API", + "url" : "https://www.mongodb.com/docs/atlas/configure-api-access/" + }, + "name" : "Service Accounts" }, { "description" : "Returns and adds restore jobs for shared-tier database deployments.", "name" : "Shared-Tier Restore Jobs" @@ -2866,7 +2880,7 @@ }, "/api/atlas/v2/groups/{groupId}/backup/exportBuckets" : { "get" : { - "description" : "Returns all AWS S3 buckets and Azure Blob Storage Containers associated with the specified Project. To use this resource, the requesting API Key must have the Project Read Only role. Deprecated versions: v2-{2023-01-01}", + "description" : "Returns all Export Buckets associated with the specified Project. To use this resource, the requesting API Key must have the Project Read Only role. Deprecated versions: v2-{2023-01-01}", "operationId" : "listExportBuckets", "parameters" : [ { "$ref" : "#/components/parameters/envelope" @@ -2903,11 +2917,11 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Return All AWS S3 Buckets and Azure Blob Storage Containers Used for Cloud Backup Snapshot Exports", + "summary" : "Return All Snapshot Export Buckets", "tags" : [ "Cloud Backups" ] }, "post" : { - "description" : "Grants MongoDB Cloud access to the specified AWS S3 Bucket or Azure Blob Storage Container. This enables this Export Bucket to receive Atlas Cloud Backup Snapshots. To use this resource, the requesting API Key must have the Project Owner role. Deprecated versions: v2-{2023-01-01}", + "description" : "Creates a Snapshot Export Bucket for an AWS S3 Bucket or Azure Blob Storage Container. Once created, an snapshots can be exported to the Export Bucket and its referenced AWS S3 Bucket or Azure Blob Storage Container. To use this resource, the requesting API Key must have the Project Owner role. Deprecated versions: v2-{2023-01-01}", "operationId" : "createExportBucket", "parameters" : [ { "$ref" : "#/components/parameters/envelope" @@ -2945,7 +2959,7 @@ "x-xgen-version" : "2024-05-30" } }, - "description" : "Grants MongoDB Cloud access to the specified AWS S3 Bucket or Azure Blob Storage Container.", + "description" : "Specifies the role and AWS S3 Bucket or Azure Blob Storage Container that the Export Bucket should reference.", "required" : true }, "responses" : { @@ -3006,20 +3020,20 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Grant Access to AWS S3 Bucket or Azure Blob Storage Container for Cloud Backup Snapshot Exports", + "summary" : "Create One Snapshot Export Bucket", "tags" : [ "Cloud Backups" ] } }, "/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}" : { "delete" : { - "description" : "Revoke MongoDB Cloud access to the specified AWS S3 Bucket or Azure Blob Storage Container. This prevents this Export Bucket from receiving Atlas Cloud Backup Snapshots. 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 API Key must have the Project Owner role.", + "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 API Key must have the Project Owner role.", "operationId" : "deleteExportBucket", "parameters" : [ { "$ref" : "#/components/parameters/envelope" }, { "$ref" : "#/components/parameters/groupId" }, { - "description" : "Unique string that identifies the AWS S3 Bucket or Azure Blob Storage Container to which you export your Snapshots.", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", "in" : "path", "name" : "exportBucketId", "required" : true, @@ -3059,11 +3073,11 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Revoke Access to AWS S3 Bucket or Azure Blob Storage Container for Cloud Backup Snapshot Exports", + "summary" : "Delete One Snapshot Export Bucket", "tags" : [ "Cloud Backups" ] }, "get" : { - "description" : "Returns one AWS S3 Bucket or Azure Blob Storage Container associated with the specified Project. To use this resource, the requesting API Key must have the Project Read Only role. Deprecated versions: v2-{2023-01-01}", + "description" : "Returns one Export Bucket associated with the specified Project. To use this resource, the requesting API Key must have the Project Read Only role. Deprecated versions: v2-{2023-01-01}", "operationId" : "getExportBucket", "parameters" : [ { "$ref" : "#/components/parameters/envelope" @@ -3137,7 +3151,7 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Return One AWS S3 Bucket or Azure Blob Storage Container Used for Cloud Backup Snapshot Exports", + "summary" : "Return One Snapshot Export Bucket", "tags" : [ "Cloud Backups" ] } }, @@ -3296,7 +3310,7 @@ "content" : { "application/vnd.atlas.2023-01-01+json" : { "schema" : { - "$ref" : "#/components/schemas/CloudProviderAccessRole" + "$ref" : "#/components/schemas/CloudProviderAccessRoleRequest" } } }, @@ -3346,7 +3360,7 @@ "required" : true, "schema" : { "type" : "string", - "enum" : [ "AWS" ] + "enum" : [ "AWS", "AZURE", "GCP" ] } }, { "description" : "Unique 24-hexadecimal digit string that identifies the role.", @@ -3434,7 +3448,7 @@ "tags" : [ "Cloud Provider Access" ] }, "patch" : { - "description" : "Grants access to the specified project for the specified access role. To use this resource, the requesting API Key must have the Project Owner role. This API endpoint is one step in a procedure to create unified access for MongoDB Cloud services.", + "description" : "Grants access to the specified project for the specified access role. To use this resource, the requesting API Key must have the Project Owner role. This API endpoint is one step in a procedure to create unified access for MongoDB Cloud services. 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/" @@ -3462,7 +3476,7 @@ "content" : { "application/vnd.atlas.2023-01-01+json" : { "schema" : { - "$ref" : "#/components/schemas/CloudProviderAccessRole" + "$ref" : "#/components/schemas/CloudProviderAccessRoleRequestUpdate" } } }, @@ -3567,7 +3581,99 @@ "examples" : { "Cluster" : { "description" : "Cluster", - "value" : "{\n \"clusterType\": \"SHARDED\",\n \"links\": [],\n \"name\": \"myCluster\",\n \"replicationSpecs\": [\n {\n \"regionConfigs\": [\n {\n \"analyticsAutoScaling\": {\n \"autoIndexing\": {\n \"enabled\": false\n },\n \"compute\": {\n \"enabled\": true,\n \"maxInstanceSize\": \"M40\",\n \"minInstanceSize\": \"M30\",\n \"scaleDownEnabled\": true\n },\n \"diskGB\": {\n \"enabled\": true\n }\n },\n \"analyticsSpecs\": {\n \"instanceSize\": \"M30\",\n \"nodeCount\": 0,\n \"diskSizeGB\": 10.0\n },\n \"autoScaling\": {\n \"autoIndexing\": {\n \"enabled\": false\n },\n \"compute\": {\n \"enabled\": true,\n \"maxInstanceSize\": \"M40\",\n \"minInstanceSize\": \"M30\",\n \"scaleDownEnabled\": true\n },\n \"diskGB\": {\n \"enabled\": true\n }\n },\n \"electableSpecs\": {\n \"instanceSize\": \"M30\",\n \"nodeCount\": 3,\n \"diskSizeGB\": 10.0\n },\n \"hiddenSecondarySpecs\": {\n \"instanceSize\": \"M30\",\n \"nodeCount\": 0,\n \"diskSizeGB\": 10.0\n },\n \"priority\": 7,\n \"providerName\": \"AWS\",\n \"readOnlySpecs\": {\n \"instanceSize\": \"M30\",\n \"nodeCount\": 0,\n \"diskSizeGB\": 10.0\n },\n \"regionName\": \"US_EAST_1\"\n }\n ],\n \"zoneName\": \"Zone 1\"\n },\n {\n \"regionConfigs\": [\n {\n \"analyticsAutoScaling\": {\n \"autoIndexing\": {\n \"enabled\": false\n },\n \"compute\": {\n \"enabled\": true,\n \"maxInstanceSize\": \"M20\",\n \"minInstanceSize\": \"M10\",\n \"scaleDownEnabled\": true\n },\n \"diskGB\": {\n \"enabled\": true\n }\n },\n \"analyticsSpecs\": {\n \"instanceSize\": \"M10\",\n \"nodeCount\": 0,\n \"diskSizeGB\": 10.0\n },\n \"autoScaling\": {\n \"autoIndexing\": {\n \"enabled\": false\n },\n \"compute\": {\n \"enabled\": true,\n \"maxInstanceSize\": \"M20\",\n \"minInstanceSize\": \"M10\",\n \"scaleDownEnabled\": true\n },\n \"diskGB\": {\n \"enabled\": true\n }\n },\n \"electableSpecs\": {\n \"instanceSize\": \"M10\",\n \"nodeCount\": 3,\n \"diskSizeGB\": 10.0\n },\n \"hiddenSecondarySpecs\": {\n \"instanceSize\": \"M10\",\n \"nodeCount\": 0,\n \"diskSizeGB\": 10.0\n },\n \"priority\": 7,\n \"providerName\": \"AWS\",\n \"readOnlySpecs\": {\n \"instanceSize\": \"M10\",\n \"nodeCount\": 0,\n \"diskSizeGB\": 10.0\n },\n \"regionName\": \"US_EAST_1\"\n }\n ],\n \"zoneName\": \"Zone 1\"\n },\n ]\n}\n" + "value" : { + "clusterType" : "SHARDED", + "name" : "myCluster", + "replicationSpecs" : [ { + "regionConfigs" : [ { + "analyticsAutoScaling" : { + "autoIndexing" : { + "enabled" : false + }, + "compute" : { + "enabled" : false + }, + "diskGB" : { + "enabled" : true + } + }, + "analyticsSpecs" : { + "diskSizeGB" : 10.0, + "instanceSize" : "M30", + "nodeCount" : 0 + }, + "autoScaling" : { + "autoIndexing" : { + "enabled" : false + }, + "compute" : { + "enabled" : false + }, + "diskGB" : { + "enabled" : true + } + }, + "electableSpecs" : { + "diskSizeGB" : 10.0, + "instanceSize" : "M30", + "nodeCount" : 3 + }, + "priority" : 7, + "providerName" : "AWS", + "readOnlySpecs" : { + "diskSizeGB" : 10.0, + "instanceSize" : "M30", + "nodeCount" : 0 + }, + "regionName" : "US_EAST_1" + } ], + "zoneName" : "Zone 1" + }, { + "regionConfigs" : [ { + "analyticsAutoScaling" : { + "autoIndexing" : { + "enabled" : false + }, + "compute" : { + "enabled" : false + }, + "diskGB" : { + "enabled" : true + } + }, + "analyticsSpecs" : { + "diskSizeGB" : 10.0, + "instanceSize" : "M10", + "nodeCount" : 0 + }, + "autoScaling" : { + "autoIndexing" : { + "enabled" : false + }, + "compute" : { + "enabled" : false + }, + "diskGB" : { + "enabled" : true + } + }, + "electableSpecs" : { + "diskSizeGB" : 10.0, + "instanceSize" : "M10", + "nodeCount" : 3 + }, + "priority" : 7, + "providerName" : "AWS", + "readOnlySpecs" : { + "diskSizeGB" : 10.0, + "instanceSize" : "M10", + "nodeCount" : 0 + }, + "regionName" : "US_EAST_1" + } ], + "zoneName" : "Zone 1" + } ] + } } }, "schema" : { @@ -3816,7 +3922,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster.", @@ -3875,7 +3981,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -3927,7 +4033,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -3979,7 +4085,7 @@ }, "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports" : { "get" : { - "description" : "Returns all Cloud Backup snapshot export jobs associated with the specified Atlas cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role.", + "description" : "Returns all Cloud Backup Snapshot Export Jobs associated with the specified Atlas cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role.", "operationId" : "listBackupExportJobs", "parameters" : [ { "$ref" : "#/components/parameters/envelope" @@ -4002,7 +4108,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -4027,11 +4133,11 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Return All Cloud Backup Snapshot Export Jobs", + "summary" : "Return All Snapshot Export Jobs", "tags" : [ "Cloud Backups" ] }, "post" : { - "description" : "Exports one backup snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. To use this resource, the requesting API Key must have the Project Atlas Admin role.", + "description" : "Exports one backup Snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. To use this resource, the requesting API Key must have the Project Atlas Admin role.", "operationId" : "createBackupExportJob", "parameters" : [ { "$ref" : "#/components/parameters/envelope" @@ -4046,7 +4152,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -4091,13 +4197,13 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Create One Cloud Backup Snapshot Export Job", + "summary" : "Create One Snapshot Export Job", "tags" : [ "Cloud Backups" ] } }, "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}" : { "get" : { - "description" : "Returns one Cloud Backup snapshot export job associated with the specified Atlas cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role.", + "description" : "Returns one Cloud Backup Snapshot Export Job associated with the specified Atlas cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role.", "operationId" : "getBackupExportJob", "parameters" : [ { "$ref" : "#/components/parameters/envelope" @@ -4112,15 +4218,19 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { - "description" : "Unique string that identifies the export job to return.", + "description" : "Unique 24-hexadecimal character string that identifies the Export Job.", "in" : "path", "name" : "exportId", "required" : true, "schema" : { - "type" : "string" + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" } } ], "responses" : { @@ -4145,7 +4255,7 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Return One Cloud Backup Snapshot Export Job", + "summary" : "Return One Snapshot Export Job", "tags" : [ "Cloud Backups" ] } }, @@ -4174,7 +4284,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -4220,7 +4330,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -4288,7 +4398,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the restore job to remove.", @@ -4348,7 +4458,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the restore job to return.", @@ -4405,7 +4515,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -4454,7 +4564,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -4500,7 +4610,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -4568,7 +4678,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -4617,7 +4727,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -4679,7 +4789,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -4736,7 +4846,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -4798,7 +4908,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -4849,7 +4959,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -4909,7 +5019,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -4969,7 +5079,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -5036,7 +5146,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "$ref" : "#/components/parameters/envelope" @@ -5107,7 +5217,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "$ref" : "#/components/parameters/envelope" @@ -5175,7 +5285,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "$ref" : "#/components/parameters/envelope" @@ -5226,7 +5336,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "$ref" : "#/components/parameters/envelope" @@ -5294,7 +5404,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -5345,7 +5455,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -5414,7 +5524,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -5474,7 +5584,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -5526,7 +5636,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -5576,7 +5686,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -5648,7 +5758,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -5722,7 +5832,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -5792,7 +5902,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -5863,7 +5973,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Name of the collection that contains one or more Atlas Search indexes.", @@ -5936,7 +6046,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the Atlas Search index. Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes.", @@ -6002,7 +6112,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "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.", @@ -6065,7 +6175,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "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.", @@ -6146,7 +6256,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -6198,7 +6308,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -6248,7 +6358,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -6313,7 +6423,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "$ref" : "#/components/parameters/groupId" @@ -6382,7 +6492,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -6452,7 +6562,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -6606,7 +6716,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -6656,7 +6766,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -6749,7 +6859,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Flag that indicates whether to download logs for queries against your online archive only or both your online archive and cluster.", @@ -6828,7 +6938,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -6892,7 +7002,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -6959,7 +7069,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -7031,7 +7141,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -7087,7 +7197,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -7143,7 +7253,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -7209,7 +7319,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -7262,7 +7372,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -7328,7 +7438,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -7390,7 +7500,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -7440,7 +7550,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -7503,7 +7613,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", @@ -7565,7 +7675,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -7617,7 +7727,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -7666,7 +7776,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -7729,7 +7839,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -7798,7 +7908,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -7864,7 +7974,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -7933,7 +8043,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Name of the collection that contains one or more Atlas Search indexes.", @@ -8017,7 +8127,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Name of the collection that contains one or more Atlas Search indexes.", @@ -8094,7 +8204,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Name of the collection that contains one or more Atlas Search indexes.", @@ -8171,7 +8281,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Name of the collection that contains one or more Atlas Search indexes.", @@ -8264,7 +8374,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the Atlas Search index. Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes.", @@ -8328,7 +8438,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "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.", @@ -8402,7 +8512,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "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.", @@ -8479,7 +8589,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -8526,7 +8636,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -8592,7 +8702,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Human-readable label that specifies whether to return only completed, incomplete, or all snapshots. By default, MongoDB Cloud only returns completed snapshots.", @@ -8650,7 +8760,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -8711,7 +8821,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -8769,7 +8879,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -8839,7 +8949,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -8883,7 +8993,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Human-readable label that identifies the cluster topology to retrieve metrics for.", @@ -8944,7 +9054,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Human-readable label that identifies the cluster topology to retrieve metrics for.", @@ -9015,10 +9125,10 @@ "tags" : [ "Collection Level Metrics" ] } }, - "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:pinFeatureCompatibilityVersion" : { + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:grantMongoDBEmployeeAccess" : { "post" : { - "description" : "Pins the FCV to the current MongoDB version.", - "operationId" : "pinFeatureCompatibilityVersion", + "description" : "Grants MongoDB employee cluster access for the given duration and at the specified level for one cluster.", + "operationId" : "grantMongoDBEmployeeAccess", "parameters" : [ { "$ref" : "#/components/parameters/envelope" }, { @@ -9034,28 +9144,29 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { "content" : { - "application/vnd.atlas.2024-05-30+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { - "$ref" : "#/components/schemas/PinFCVView" + "$ref" : "#/components/schemas/EmployeeAccessGrantView" }, - "x-xgen-version" : "2024-05-30" + "x-xgen-version" : "2024-08-05" } }, - "description" : "Optional request params for tuning FCV pinning configuration." + "description" : "Grant access level and expiration.", + "required" : true }, "responses" : { "204" : { "content" : { - "application/vnd.atlas.2024-05-30+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { "$ref" : "#/components/schemas/NoBody" }, - "x-xgen-version" : "2024-05-30" + "x-xgen-version" : "2024-08-05" } }, "description" : "This endpoint does not return a response body." @@ -9079,20 +9190,20 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Pin FCV for One Cluster from One Project", + "summary" : "Grant MongoDB employee cluster access for one cluster.", "tags" : [ "Clusters" ] } }, - "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:unpinFeatureCompatibilityVersion" : { + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:pinFeatureCompatibilityVersion" : { "post" : { - "description" : "Unpins the current fixed Feature Compatibility Version. This feature is not available for clusters on rapid release.", - "operationId" : "unpinFeatureCompatibilityVersion", + "description" : "Pins the FCV to the current MongoDB version.", + "operationId" : "pinFeatureCompatibilityVersion", "parameters" : [ { "$ref" : "#/components/parameters/envelope" - }, { - "$ref" : "#/components/parameters/groupId" }, { "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" }, { "description" : "Human-readable label that identifies this cluster.", "in" : "path", @@ -9102,9 +9213,20 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/PinFCVView" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "Optional request params for tuning FCV pinning configuration." + }, "responses" : { "204" : { "content" : { @@ -9123,11 +9245,8 @@ "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" @@ -9139,72 +9258,43 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Unpins FCV for One Cluster from One Project", + "summary" : "Pin FCV for One Cluster from One Project", "tags" : [ "Clusters" ] } }, - "/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz" : { - "get" : { - "description" : "Returns a compressed (.gz) log file that contains a range of log messages for the specified host for the specified project. MongoDB updates process and audit logs from the cluster backend infrastructure every five minutes and contain log data from the previous five minutes. If you poll the API for log files, we recommend polling every five minutes. For example, if the logs are updated at 4:00 UTC and then you poll the API, the API returns log data from the interval between 3:55 UTC and 4:00 UTC. This feature isn't available for `M0` free clusters, `M2`, `M5`, or serverless clusters. To use this resource, the requesting API Key must have the Project Data Access Read Only or higher role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: \"Accept: application/vnd.atlas.YYYY-MM-DD+gzip\". Deprecated versions: v2-{2023-01-01}", - "operationId" : "getHostLogs", + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:revokeMongoDBEmployeeAccess" : { + "post" : { + "description" : "Revokes a previously granted MongoDB employee cluster access.", + "operationId" : "revokeMongoDBEmployeeAccess", "parameters" : [ { "$ref" : "#/components/parameters/envelope" }, { - "$ref" : "#/components/parameters/groupId" + "$ref" : "#/components/parameters/pretty" }, { - "description" : "Human-readable label that identifies the host that stores the log files that you want to download.", - "in" : "path", - "name" : "hostName", - "required" : true, - "schema" : { - "type" : "string", - "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$" - } + "$ref" : "#/components/parameters/groupId" }, { - "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.", + "description" : "Human-readable label that identifies this cluster.", "in" : "path", - "name" : "logName", + "name" : "clusterName", "required" : true, "schema" : { "type" : "string", - "enum" : [ "mongodb", "mongos", "mongodb-audit-log", "mongos-audit-log" ], - "externalDocs" : { - "description" : "Set up Database Auditing", - "url" : "https://docs.atlas.mongodb.com/database-auditing/" - } - } - }, { - "description" : "Date and time when the period specifies the inclusive ending point for the range of log messages to retrieve. This parameter expresses its value in the number of seconds that have elapsed since the UNIX epoch.", - "in" : "query", - "name" : "endDate", - "schema" : { - "type" : "integer", - "format" : "int64", - "minimum" : 1199145600 - } - }, { - "description" : "Date and time when the period specifies the inclusive starting point for the range of log messages to retrieve. This parameter expresses its value in the number of seconds that have elapsed since the UNIX epoch.", - "in" : "query", - "name" : "startDate", - "schema" : { - "type" : "integer", - "format" : "int64", - "minimum" : 1199145600 + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { - "200" : { + "204" : { "content" : { - "application/vnd.atlas.2023-02-01+gzip" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { - "type" : "string", - "format" : "binary", - "description" : "Compressed (.gz) log file that contains a range of log messages for the specified host for the specified project" + "$ref" : "#/components/schemas/NoBody" }, - "x-xgen-version" : "2023-02-01" + "x-xgen-version" : "2024-08-05" } }, - "description" : "OK" + "description" : "This endpoint does not return a response body." }, "400" : { "$ref" : "#/components/responses/badRequest" @@ -9212,9 +9302,6 @@ "401" : { "$ref" : "#/components/responses/unauthorized" }, - "403" : { - "$ref" : "#/components/responses/forbidden" - }, "404" : { "$ref" : "#/components/responses/notFound" }, @@ -9228,39 +9315,58 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Download Logs for One Cluster Host in One Project", - "tags" : [ "Monitoring and Logs" ] + "summary" : "Revoke granted MongoDB employee cluster access for one cluster.", + "tags" : [ "Clusters" ] } }, - "/api/atlas/v2/groups/{groupId}/collStats/metrics" : { - "get" : { - "description" : "Returns all available Coll Stats Latency metric names and their respective units for the specified project at the time of request.", - "operationId" : "getCollStatsLatencyNamespaceMetrics", + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:unpinFeatureCompatibilityVersion" : { + "post" : { + "description" : "Unpins the current fixed Feature Compatibility Version. This feature is not available for clusters on rapid release.", + "operationId" : "unpinFeatureCompatibilityVersion", "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { "$ref" : "#/components/parameters/groupId" }, { - "$ref" : "#/components/parameters/envelope" + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + } } ], "responses" : { - "200" : { + "204" : { "content" : { - "application/vnd.atlas.2023-11-15+json" : { + "application/vnd.atlas.2024-05-30+json" : { "schema" : { "$ref" : "#/components/schemas/NoBody" }, - "x-xgen-version" : "2023-11-15" + "x-xgen-version" : "2024-05-30" } }, - "description" : "Succeeded" + "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" @@ -9269,94 +9375,224 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Return all metric names", - "tags" : [ "Collection Level Metrics" ] + "summary" : "Unpins FCV for One Cluster from One Project", + "tags" : [ "Clusters" ] } }, - "/api/atlas/v2/groups/{groupId}/containers" : { + "/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz" : { "get" : { - "description" : "Returns details about all network peering containers in the specified project for the specified cloud provider. If you do not specify the cloud provider, MongoDB Cloud returns details about all network peering containers in the project for Amazon Web Services (AWS). To use this resource, the requesting API Key must have the Project Read Only role.", - "operationId" : "listPeeringContainerByCloudProvider", + "description" : "Returns a compressed (.gz) log file that contains a range of log messages for the specified host for the specified project. MongoDB updates process and audit logs from the cluster backend infrastructure every five minutes and contain log data from the previous five minutes. If you poll the API for log files, we recommend polling every five minutes. For example, if the logs are updated at 4:00 UTC and then you poll the API, the API returns log data from the interval between 3:55 UTC and 4:00 UTC. This feature isn't available for `M0` free clusters, `M2`, `M5`, or serverless clusters. To use this resource, the requesting API Key must have the Project Data Access Read Only or higher role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: \"Accept: application/vnd.atlas.YYYY-MM-DD+gzip\". Deprecated versions: v2-{2023-01-01}", + "operationId" : "getHostLogs", "parameters" : [ { "$ref" : "#/components/parameters/envelope" }, { "$ref" : "#/components/parameters/groupId" }, { - "$ref" : "#/components/parameters/includeCount" - }, { - "$ref" : "#/components/parameters/itemsPerPage" - }, { - "$ref" : "#/components/parameters/pageNum" - }, { - "$ref" : "#/components/parameters/pretty" - }, { - "description" : "Cloud service provider that serves the desired network peering containers.", - "in" : "query", - "name" : "providerName", + "description" : "Human-readable label that identifies the host that stores the log files that you want to download.", + "in" : "path", + "name" : "hostName", "required" : true, "schema" : { "type" : "string", - "default" : "AWS", - "enum" : [ "AWS", "AZURE", "GCP" ] + "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]+)?$" } - } ], - "responses" : { - "200" : { - "content" : { - "application/vnd.atlas.2023-01-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/PaginatedCloudProviderContainerView" - }, - "x-xgen-version" : "2023-01-01" - } - }, - "description" : "OK" - }, - "401" : { - "$ref" : "#/components/responses/unauthorized" - }, - "404" : { - "$ref" : "#/components/responses/notFound" - }, - "500" : { - "$ref" : "#/components/responses/internalServerError" + }, { + "description" : "Human-readable label that identifies the log file that you want to return. To return audit logs, enable *Database Auditing* for the specified project.", + "in" : "path", + "name" : "logName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "mongodb", "mongos", "mongodb-audit-log", "mongos-audit-log" ], + "externalDocs" : { + "description" : "Set up Database Auditing", + "url" : "https://docs.atlas.mongodb.com/database-auditing/" + } } - }, - "security" : [ { - "DigestAuth" : [ ] - } ], - "summary" : "Return All Network Peering Containers in One Project for One Cloud Provider", - "tags" : [ "Network Peering" ] - }, - "post" : { - "description" : "Creates one new network peering container in the specified project. MongoDB Cloud can deploy Network Peering connections in a network peering container. GCP can have one container per project. AWS and Azure can have one container per cloud provider region. To use this resource, the requesting API Key must have the Project Owner role.", - "operationId" : "createPeeringContainer", - "parameters" : [ { - "$ref" : "#/components/parameters/envelope" }, { - "$ref" : "#/components/parameters/groupId" + "description" : "Specifies the date and time for the ending point of the range of log messages to retrieve, in the number of seconds that have elapsed since the UNIX epoch. This value will default to 24 hours after the start date. If the start date is also unspecified, the value will default to the time of the request.", + "in" : "query", + "name" : "endDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600 + } }, { - "$ref" : "#/components/parameters/pretty" + "description" : "Specifies the date and time for the starting point of the range of log messages to retrieve, in the number of seconds that have elapsed since the UNIX epoch. This value will default to 24 hours prior to the end date. If the end date is also unspecified, the value will default to 24 hours prior to the time of the request.", + "in" : "query", + "name" : "startDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600 + } } ], - "requestBody" : { - "content" : { - "application/vnd.atlas.2023-01-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/CloudProviderContainer" - } - } - }, - "description" : "Creates one new network peering container in the specified project.", - "required" : true - }, "responses" : { "200" : { "content" : { - "application/vnd.atlas.2023-01-01+json" : { + "application/vnd.atlas.2023-02-01+gzip" : { "schema" : { - "$ref" : "#/components/schemas/CloudProviderContainer" + "type" : "string", + "format" : "binary", + "description" : "Compressed (.gz) log file that contains a range of log messages for the specified host for the specified project" }, - "x-xgen-version" : "2023-01-01" + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Download Logs for One Cluster Host in One Project", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/api/atlas/v2/groups/{groupId}/collStats/metrics" : { + "get" : { + "description" : "Returns all available Coll Stats Latency metric names and their respective units for the specified project at the time of request.", + "operationId" : "getCollStatsLatencyNamespaceMetrics", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "Succeeded" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return all metric names", + "tags" : [ "Collection Level Metrics" ] + } + }, + "/api/atlas/v2/groups/{groupId}/containers" : { + "get" : { + "description" : "Returns details about all network peering containers in the specified project for the specified cloud provider. If you do not specify the cloud provider, MongoDB Cloud returns details about all network peering containers in the project for Amazon Web Services (AWS). To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "listPeeringContainerByCloudProvider", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that serves the desired network peering containers.", + "in" : "query", + "name" : "providerName", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudProviderContainerView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Network Peering Containers in One Project for One Cloud Provider", + "tags" : [ "Network Peering" ] + }, + "post" : { + "description" : "Creates one new network peering container in the specified project. MongoDB Cloud can deploy Network Peering connections in a network peering container. GCP can have one container per project. AWS and Azure can have one container per cloud provider region. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "createPeeringContainer", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + } + } + }, + "description" : "Creates one new network peering container in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, + "x-xgen-version" : "2023-01-01" } }, "description" : "OK" @@ -10991,7 +11227,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Date and time when to stop retrieving database history. If you specify **end**, you must also specify **start**. This parameter uses UNIX epoch time in milliseconds.", @@ -11254,6 +11490,12 @@ "$ref" : "#/components/parameters/pretty" }, { "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" }, { "description" : "Human-readable label that identifies the cloud provider for the private endpoints to return.", "in" : "path", @@ -11376,17 +11618,6 @@ "pattern" : "^([a-f0-9]{24})$" } } ], - "requestBody" : { - "content" : { - "application/vnd.atlas.2023-01-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/EncryptionAtRestPrivateEndpointRequest" - } - } - }, - "description" : "Cloud provider of the private endpoints to delete and the list of cloud provider regions in which to delete the private endpoints.", - "required" : true - }, "responses" : { "204" : { "content" : { @@ -11457,6 +11688,9 @@ "403" : { "$ref" : "#/components/responses/forbidden" }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, "500" : { "$ref" : "#/components/responses/internalServerError" } @@ -11494,7 +11728,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, "style" : "form" @@ -12212,7 +12446,7 @@ } ], "summary" : "Return All Project Invitations", "tags" : [ "Projects" ], - "x-sunset" : "2024-10-04" + "x-sunset" : "2024-11-04" }, "patch" : { "deprecated" : true, @@ -12266,7 +12500,7 @@ } ], "summary" : "Update One Project Invitation", "tags" : [ "Projects" ], - "x-sunset" : "2024-10-04" + "x-sunset" : "2024-11-04" }, "post" : { "deprecated" : true, @@ -12314,7 +12548,7 @@ } ], "summary" : "Invite One MongoDB Cloud User to Join One Project", "tags" : [ "Projects" ], - "x-sunset" : "2024-10-04" + "x-sunset" : "2024-11-04" } }, "/api/atlas/v2/groups/{groupId}/invites/{invitationId}" : { @@ -12362,7 +12596,7 @@ } ], "summary" : "Cancel One Project Invitation", "tags" : [ "Projects" ], - "x-sunset" : "2024-10-04" + "x-sunset" : "2024-11-04" }, "get" : { "deprecated" : true, @@ -12413,7 +12647,7 @@ } ], "summary" : "Return One Project Invitation", "tags" : [ "Projects" ], - "x-sunset" : "2024-10-04" + "x-sunset" : "2024-11-04" }, "patch" : { "deprecated" : true, @@ -12476,7 +12710,7 @@ } ], "summary" : "Update One Project Invitation by Invitation ID", "tags" : [ "Projects" ], - "x-sunset" : "2024-10-04" + "x-sunset" : "2024-11-04" } }, "/api/atlas/v2/groups/{groupId}/ipAddresses" : { @@ -12573,13 +12807,13 @@ "description" : "Removes the specified project limit. Depending on the limit, Atlas either resets the limit to its default value or removes the limit entirely. To use this resource, the requesting API Key must have the Project Owner role.", "operationId" : "deleteProjectLimit", "parameters" : [ { - "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", + "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| 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 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n| atlas.project.deployment.salesSoldM0s | Limit on the number of M0 clusters in this project if the org is sales-sold | 100 | 100 |\n", "in" : "path", "name" : "limitName", "required" : true, "schema" : { "type" : "string", - "enum" : [ "atlas.project.security.databaseAccess.users", "atlas.project.deployment.clusters", "atlas.project.deployment.serverlessMTMs", "atlas.project.security.databaseAccess.customRoles", "atlas.project.security.networkAccess.entries", "atlas.project.security.networkAccess.crossRegionEntries", "atlas.project.deployment.nodesPerPrivateLinkRegion", "dataFederation.bytesProcessed.query", "dataFederation.bytesProcessed.daily", "dataFederation.bytesProcessed.weekly", "dataFederation.bytesProcessed.monthly", "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", "atlas.project.deployment.privateServiceConnectionsSubnetMask" ] + "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" @@ -12623,13 +12857,13 @@ "description" : "Returns the specified limit for the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "getProjectLimit", "parameters" : [ { - "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", + "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| 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 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n| atlas.project.deployment.salesSoldM0s | Limit on the number of M0 clusters in this project if the org is sales-sold | 100 | 100 |\n", "in" : "path", "name" : "limitName", "required" : true, "schema" : { "type" : "string", - "enum" : [ "atlas.project.security.databaseAccess.users", "atlas.project.deployment.clusters", "atlas.project.deployment.serverlessMTMs", "atlas.project.security.databaseAccess.customRoles", "atlas.project.security.networkAccess.entries", "atlas.project.security.networkAccess.crossRegionEntries", "atlas.project.deployment.nodesPerPrivateLinkRegion", "dataFederation.bytesProcessed.query", "dataFederation.bytesProcessed.daily", "dataFederation.bytesProcessed.weekly", "dataFederation.bytesProcessed.monthly", "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", "atlas.project.deployment.privateServiceConnectionsSubnetMask" ] + "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" @@ -12676,13 +12910,13 @@ "description" : "Sets the specified project limit. To use this resource, the requesting API Key must have the Project Owner role.\n\n**NOTE**: Increasing the following configuration limits might lead to slower response times in the MongoDB Cloud UI or increased user management overhead leading to authentication or authorization re-architecture. If possible, we recommend that you create additional projects to gain access to more of these resources for a more sustainable growth pattern.", "operationId" : "setProjectLimit", "parameters" : [ { - "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", + "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| 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 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n| atlas.project.deployment.salesSoldM0s | Limit on the number of M0 clusters in this project if the org is sales-sold | 100 | 100 |\n", "in" : "path", "name" : "limitName", "required" : true, "schema" : { "type" : "string", - "enum" : [ "atlas.project.security.databaseAccess.users", "atlas.project.deployment.clusters", "atlas.project.deployment.serverlessMTMs", "atlas.project.security.databaseAccess.customRoles", "atlas.project.security.networkAccess.entries", "atlas.project.security.networkAccess.crossRegionEntries", "atlas.project.deployment.nodesPerPrivateLinkRegion", "dataFederation.bytesProcessed.query", "dataFederation.bytesProcessed.daily", "dataFederation.bytesProcessed.weekly", "dataFederation.bytesProcessed.monthly", "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", "atlas.project.deployment.privateServiceConnectionsSubnetMask" ] + "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" @@ -13665,6 +13899,7 @@ }, "/api/atlas/v2/groups/{groupId}/pipelines" : { "get" : { + "deprecated" : true, "description" : "Returns a list of Data Lake Pipelines. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "listPipelines", "parameters" : [ { @@ -13701,10 +13936,16 @@ "DigestAuth" : [ ] } ], "summary" : "Return All Data Lake Pipelines from One Project", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" }, "post" : { + "deprecated" : true, "description" : "Creates one Data Lake Pipeline.", + "externalDocs" : { + "description" : "Data Lake Pipelines are deprecated. Please see Data Lake Deprecation Guide.", + "url" : "https://dochub.mongodb.org/core/data-lake-deprecation" + }, "operationId" : "createPipeline", "parameters" : [ { "$ref" : "#/components/parameters/envelope" @@ -13751,11 +13992,13 @@ "DigestAuth" : [ ] } ], "summary" : "Create One Data Lake Pipeline", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}" : { "delete" : { + "deprecated" : true, "description" : "Removes one Data Lake Pipeline.", "operationId" : "deletePipeline", "parameters" : [ { @@ -13800,9 +14043,11 @@ "DigestAuth" : [ ] } ], "summary" : "Remove One Data Lake Pipeline", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" }, "get" : { + "deprecated" : true, "description" : "Returns the details of one Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "getPipeline", "parameters" : [ { @@ -13849,9 +14094,11 @@ "DigestAuth" : [ ] } ], "summary" : "Return One Data Lake Pipeline", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" }, "patch" : { + "deprecated" : true, "description" : "Updates one Data Lake Pipeline.", "operationId" : "updatePipeline", "parameters" : [ { @@ -13913,11 +14160,13 @@ "DigestAuth" : [ ] } ], "summary" : "Update One Data Lake Pipeline", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules" : { "get" : { + "deprecated" : true, "description" : "Returns a list of backup schedule policy items that you can use as a Data Lake Pipeline source. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "listPipelineSchedules", "parameters" : [ { @@ -13967,11 +14216,13 @@ "DigestAuth" : [ ] } ], "summary" : "Return Available Ingestion Schedules for One Data Lake Pipeline", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots" : { "get" : { + "deprecated" : true, "description" : "Returns a list of backup snapshots that you can use to trigger an on demand pipeline run. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "listPipelineSnapshots", "parameters" : [ { @@ -14033,11 +14284,13 @@ "DigestAuth" : [ ] } ], "summary" : "Return Available Backup Snapshots for One Data Lake Pipeline", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause" : { "post" : { + "deprecated" : true, "description" : "Pauses ingestion for a Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "pausePipeline", "parameters" : [ { @@ -14084,11 +14337,13 @@ "DigestAuth" : [ ] } ], "summary" : "Pause One Data Lake Pipeline", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume" : { "post" : { + "deprecated" : true, "description" : "Resumes ingestion for a Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "resumePipeline", "parameters" : [ { @@ -14135,11 +14390,13 @@ "DigestAuth" : [ ] } ], "summary" : "Resume One Data Lake Pipeline", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs" : { "get" : { + "deprecated" : true, "description" : "Returns a list of past Data Lake Pipeline runs. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "listPipelineRuns", "parameters" : [ { @@ -14201,11 +14458,13 @@ "DigestAuth" : [ ] } ], "summary" : "Return All Data Lake Pipeline Runs from One Project", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}" : { "delete" : { + "deprecated" : true, "description" : "Deletes dataset that Atlas generated during the specified pipeline run.", "operationId" : "deletePipelineRunDataset", "parameters" : [ { @@ -14264,9 +14523,11 @@ "DigestAuth" : [ ] } ], "summary" : "Delete Pipeline Run Dataset", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" }, "get" : { + "deprecated" : true, "description" : "Returns the details of one Data Lake Pipeline run within the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "getPipelineRun", "parameters" : [ { @@ -14325,11 +14586,13 @@ "DigestAuth" : [ ] } ], "summary" : "Return One Data Lake Pipeline Run", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger" : { "post" : { + "deprecated" : true, "description" : "Triggers a Data Lake Pipeline ingestion of a specified snapshot.", "operationId" : "triggerSnapshotIngestion", "parameters" : [ { @@ -14387,7 +14650,8 @@ "DigestAuth" : [ ] } ], "summary" : "Trigger on demand snapshot ingestion", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService" : { @@ -14547,7 +14811,7 @@ "schema" : { "type" : "string", "maxLength" : 64, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -14600,7 +14864,7 @@ "schema" : { "type" : "string", "maxLength" : 64, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -14659,7 +14923,7 @@ "schema" : { "type" : "string", "maxLength" : 64, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be removed.", @@ -14716,7 +14980,7 @@ "schema" : { "type" : "string", "maxLength" : 64, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the tenant endpoint.", @@ -14773,7 +15037,7 @@ "schema" : { "type" : "string", "maxLength" : 64, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be updated.", @@ -15949,7 +16213,7 @@ "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" ] + "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" ] }, "maxItems" : 10, "minItems" : 1, @@ -16028,7 +16292,7 @@ "items" : { "type" : "string", "description" : "One measurement requested for this MongoDB process.", - "enum" : [ "ASSERT_MSG", "ASSERT_REGULAR", "ASSERT_USER", "ASSERT_WARNING", "BACKGROUND_FLUSH_AVG", "CACHE_BYTES_READ_INTO", "CACHE_BYTES_WRITTEN_FROM", "CACHE_DIRTY_BYTES", "CACHE_USED_BYTES", "COMPUTED_MEMORY", "CONNECTIONS", "CURSORS_TOTAL_OPEN", "CURSORS_TOTAL_TIMED_OUT", "DB_DATA_SIZE_TOTAL", "DB_STORAGE_TOTAL", "DOCUMENT_METRICS_DELETED", "DOCUMENT_METRICS_INSERTED", "DOCUMENT_METRICS_RETURNED", "DOCUMENT_METRICS_UPDATED", "EXTRA_INFO_PAGE_FAULTS", "FTS_DISK_UTILIZATION", "FTS_MEMORY_MAPPED", "FTS_MEMORY_RESIDENT", "FTS_MEMORY_VIRTUAL", "FTS_PROCESS_CPU_KERNEL", "FTS_PROCESS_CPU_USER", "FTS_PROCESS_NORMALIZED_CPU_KERNEL", "FTS_PROCESS_NORMALIZED_CPU_USER", "GLOBAL_ACCESSES_NOT_IN_MEMORY", "GLOBAL_LOCK_CURRENT_QUEUE_READERS", "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL", "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS", "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN", "INDEX_COUNTERS_BTREE_ACCESSES", "INDEX_COUNTERS_BTREE_HITS", "INDEX_COUNTERS_BTREE_MISS_RATIO", "INDEX_COUNTERS_BTREE_MISSES", "JOURNALING_COMMITS_IN_WRITE_LOCK", "JOURNALING_MB", "JOURNALING_WRITE_DATA_FILES_MB", "MAX_PROCESS_CPU_CHILDREN_KERNEL", "MAX_PROCESS_CPU_CHILDREN_USER", "MAX_PROCESS_CPU_KERNEL", "MAX_PROCESS_CPU_USER", "MAX_PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL", "MAX_PROCESS_NORMALIZED_CPU_CHILDREN_USER", "MAX_PROCESS_NORMALIZED_CPU_KERNEL", "MAX_PROCESS_NORMALIZED_CPU_USER", "MAX_SWAP_USAGE_FREE", "MAX_SWAP_USAGE_USED ", "MAX_SYSTEM_CPU_GUEST", "MAX_SYSTEM_CPU_IOWAIT", "MAX_SYSTEM_CPU_IRQ", "MAX_SYSTEM_CPU_KERNEL", "MAX_SYSTEM_CPU_SOFTIRQ", "MAX_SYSTEM_CPU_STEAL", "MAX_SYSTEM_CPU_USER", "MAX_SYSTEM_MEMORY_AVAILABLE", "MAX_SYSTEM_MEMORY_FREE", "MAX_SYSTEM_MEMORY_USED", "MAX_SYSTEM_NETWORK_IN", "MAX_SYSTEM_NETWORK_OUT", "MAX_SYSTEM_NORMALIZED_CPU_GUEST", "MAX_SYSTEM_NORMALIZED_CPU_IOWAIT", "MAX_SYSTEM_NORMALIZED_CPU_IRQ", "MAX_SYSTEM_NORMALIZED_CPU_KERNEL", "MAX_SYSTEM_NORMALIZED_CPU_NICE", "MAX_SYSTEM_NORMALIZED_CPU_SOFTIRQ", "MAX_SYSTEM_NORMALIZED_CPU_STEAL", "MAX_SYSTEM_NORMALIZED_CPU_USER", "MEMORY_MAPPED", "MEMORY_RESIDENT", "MEMORY_VIRTUAL", "NETWORK_BYTES_IN", "NETWORK_BYTES_OUT", "NETWORK_NUM_REQUESTS", "OP_EXECUTION_TIME_COMMANDS", "OP_EXECUTION_TIME_READS", "OP_EXECUTION_TIME_WRITES", "OPCOUNTER_CMD", "OPCOUNTER_DELETE", "OPCOUNTER_GETMORE", "OPCOUNTER_INSERT", "OPCOUNTER_QUERY", "OPCOUNTER_REPL_CMD", "OPCOUNTER_REPL_DELETE", "OPCOUNTER_REPL_INSERT", "OPCOUNTER_REPL_UPDATE", "OPCOUNTER_UPDATE", "OPERATIONS_SCAN_AND_ORDER", "OPLOG_MASTER_LAG_TIME_DIFF", "OPLOG_MASTER_TIME", "OPLOG_RATE_GB_PER_HOUR", "OPLOG_SLAVE_LAG_MASTER_TIME", "OPLOG_REPLICATION_LAG", "PROCESS_CPU_CHILDREN_KERNEL", "PROCESS_CPU_CHILDREN_USER", "PROCESS_CPU_KERNEL", "PROCESS_CPU_USER", "PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL", "PROCESS_NORMALIZED_CPU_CHILDREN_USER", "PROCESS_NORMALIZED_CPU_KERNEL", "PROCESS_NORMALIZED_CPU_USER", "QUERY_EXECUTOR_SCANNED", "QUERY_EXECUTOR_SCANNED_OBJECTS", "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED", "QUERY_TARGETING_SCANNED_PER_RETURNED", "RESTARTS_IN_LAST_HOUR", "SWAP_USAGE_FREE", "SWAP_USAGE_USED", "SYSTEM_CPU_GUEST", "SYSTEM_CPU_IOWAIT", "SYSTEM_CPU_IRQ", "SYSTEM_CPU_KERNEL", "SYSTEM_CPU_NICE", "SYSTEM_CPU_SOFTIRQ", "SYSTEM_CPU_STEAL", "SYSTEM_CPU_USER", "SYSTEM_MEMORY_AVAILABLE", "SYSTEM_MEMORY_FREE", "SYSTEM_MEMORY_USED", "SYSTEM_NETWORK_IN", "SYSTEM_NETWORK_OUT", "SYSTEM_NORMALIZED_CPU_GUEST", "SYSTEM_NORMALIZED_CPU_IOWAIT", "SYSTEM_NORMALIZED_CPU_IRQ", "SYSTEM_NORMALIZED_CPU_KERNEL", "SYSTEM_NORMALIZED_CPU_NICE", "SYSTEM_NORMALIZED_CPU_SOFTIRQ", "SYSTEM_NORMALIZED_CPU_STEAL", "SYSTEM_NORMALIZED_CPU_USER", "TICKETS_AVAILABLE_READS", "TICKETS_AVAILABLE_WRITE", "OPERATION_THROTTLING_REJECTED_OPERATIONS" ] + "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_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" ] }, "maxItems" : 10, "minItems" : 1, @@ -16598,7 +16862,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -16799,7 +17063,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -16848,7 +17112,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -16916,7 +17180,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the restore job to return.", @@ -16984,7 +17248,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -17033,7 +17297,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -17092,7 +17356,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "$ref" : "#/components/parameters/envelope" @@ -17138,7 +17402,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Value that we want to set for the Serverless Auto Indexing toggle.", @@ -17196,20 +17460,20 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { - "204" : { + "202" : { "content" : { "application/vnd.atlas.2023-01-01+json" : { "schema" : { - "$ref" : "#/components/schemas/NoBody" + "$ref" : "#/components/schemas/RequestAccepted" }, "x-xgen-version" : "2023-01-01" } }, - "description" : "This endpoint does not return a response body." + "description" : "Accepted" }, "400" : { "$ref" : "#/components/responses/badRequest" @@ -17248,7 +17512,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -17300,7 +17564,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -17345,7 +17609,7 @@ }, "/api/atlas/v2/groups/{groupId}/serviceAccounts" : { "get" : { - "description" : "Returns list of Service Accounts for a project with service account details.", + "description" : "Returns all Service Accounts for the specified Project. Available as a preview feature.", "operationId" : "listProjectServiceAccounts", "parameters" : [ { "$ref" : "#/components/parameters/groupId" @@ -17361,11 +17625,11 @@ "responses" : { "200" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { "$ref" : "#/components/schemas/PaginatedGroupServiceAccounts" }, - "x-xgen-version" : "2023-10-01" + "x-xgen-version" : "2024-08-05" } }, "description" : "OK" @@ -17383,11 +17647,11 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Return All project Service Accounts", - "tags" : [ "Groups" ] + "summary" : "List All Project Service Accounts", + "tags" : [ "Service Accounts" ] }, "post" : { - "description" : "Creates and assigns the specified Service Account to the specified Project.", + "description" : "Creates one Service Account for the specified Project. The Service Account will automatically be added as an Organization Member to the Organization that the specified Project is a part of. Available as a preview feature.", "operationId" : "createProjectServiceAccount", "parameters" : [ { "$ref" : "#/components/parameters/groupId" @@ -17398,24 +17662,24 @@ } ], "requestBody" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { "$ref" : "#/components/schemas/GroupServiceAccountRequest" }, - "x-xgen-version" : "2023-10-01" + "x-xgen-version" : "2024-08-05" } }, - "description" : "Details to create service account and add to the specified project.", + "description" : "Details of the new Service Account.", "required" : true }, "responses" : { "201" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { "$ref" : "#/components/schemas/GroupServiceAccount" }, - "x-xgen-version" : "2023-10-01" + "x-xgen-version" : "2024-08-05" } }, "description" : "Created" @@ -17433,21 +17697,23 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Create and Assign one Service Account to one project", - "tags" : [ "Groups" ] + "summary" : "Create and Assign one Service Account to one Project", + "tags" : [ "Service Accounts" ] } }, - "/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}" : { + "/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}" : { "delete" : { - "description" : "Removes one Service Account from the specified project.", + "description" : "Removes the specified Service Account from the specified project. The Service Account will still be a part of the Organization it was created in, and the credentials will remain active until expired or manually revoked. Available as a preview feature.", "operationId" : "deleteProjectServiceAccount", "parameters" : [ { - "description" : "Id of the service account.", + "description" : "The Client ID of the Service Account.", "in" : "path", - "name" : "serviceAccountId", + "name" : "clientId", "required" : true, "schema" : { - "type" : "string" + "type" : "string", + "example" : "mdb_sa_id_667066535bc75b03c37b3038", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" } }, { "$ref" : "#/components/parameters/groupId" @@ -17459,15 +17725,15 @@ "responses" : { "204" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { "$ref" : "#/components/schemas/NoBody" }, - "x-xgen-version" : "2023-10-01" + "x-xgen-version" : "2024-08-05" } }, "description" : "This endpoint does not return a response body.", - "x-xgen-version" : "2023-10-01" + "x-xgen-version" : "2024-08-05" }, "401" : { "$ref" : "#/components/responses/unauthorized" @@ -17482,21 +17748,23 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Unassign One Service Account from One Project.", - "tags" : [ "Groups" ] + "summary" : "Unassign One Service Account from One Project", + "tags" : [ "Service Accounts" ] }, "get" : { - "description" : "Get project Service Account Details.", + "description" : "Returns one Service Account in the specified Project. Available as a preview feature.", "operationId" : "getProjectServiceAccount", "parameters" : [ { "$ref" : "#/components/parameters/groupId" }, { - "description" : "Id of the service account.", + "description" : "The Client ID of the Service Account.", "in" : "path", - "name" : "serviceAccountId", + "name" : "clientId", "required" : true, "schema" : { - "type" : "string" + "type" : "string", + "example" : "mdb_sa_id_667066535bc75b03c37b3038", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" } }, { "$ref" : "#/components/parameters/envelope" @@ -17506,11 +17774,11 @@ "responses" : { "200" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { "$ref" : "#/components/schemas/GroupServiceAccount" }, - "x-xgen-version" : "2023-10-01" + "x-xgen-version" : "2024-08-05" } }, "description" : "OK" @@ -17528,19 +17796,21 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Service Account Fetching", - "tags" : [ "Groups" ] + "summary" : "Get one Project Service Account", + "tags" : [ "Service Accounts" ] }, "patch" : { - "description" : "Update Service Account in Project.", + "description" : "Updates one Service Account in the specified Project. Available as a preview feature.", "operationId" : "updateProjectServiceAccount", "parameters" : [ { - "description" : "Id of the service account.", + "description" : "The Client ID of the Service Account.", "in" : "path", - "name" : "serviceAccountId", + "name" : "clientId", "required" : true, "schema" : { - "type" : "string" + "type" : "string", + "example" : "mdb_sa_id_667066535bc75b03c37b3038", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" } }, { "$ref" : "#/components/parameters/groupId" @@ -17551,23 +17821,23 @@ } ], "requestBody" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { "$ref" : "#/components/schemas/GroupServiceAccountUpdateRequest" } } }, - "description" : "Details to update service account in the specified Project.", + "description" : "The new details for the Service Account.", "required" : true }, "responses" : { "200" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { "$ref" : "#/components/schemas/GroupServiceAccount" }, - "x-xgen-version" : "2023-10-01" + "x-xgen-version" : "2024-08-05" } }, "description" : "OK" @@ -17588,19 +17858,208 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Service Account Update in Project", - "tags" : [ "Groups" ] + "summary" : "Update one Project Service Account", + "tags" : [ "Service Accounts" ] + } + }, + "/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList" : { + "get" : { + "description" : "Returns all access list entries that you configured for the specified Service Account for the project. Available as a preview feature.", + "operationId" : "listProjectServiceAccountAccessList", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "The Client ID of the Service Account.", + "in" : "path", + "name" : "clientId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mdb_sa_id_667066535bc75b03c37b3038", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedServiceAccountIPAccessEntryView" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Access List entries for one Project Service Account", + "tags" : [ "Service Accounts" ] }, "post" : { - "description" : "Assigns the specified organization Service Account to the specified project.", + "description" : "Add Access List Entries for the specified Service Account for the project. Resources require all API requests to originate from IP addresses on the API access list. Available as a preview feature.", + "operationId" : "createProjectServiceAccountAccessList", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "The Client ID of the Service Account.", + "in" : "path", + "name" : "clientId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mdb_sa_id_667066535bc75b03c37b3038", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ServiceAccountIPAccessListEntry" + } + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "A list of access list entries to add to the access list of the specified Service Account for the project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedServiceAccountIPAccessEntryView" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add Access List entries for one Project Service Account", + "tags" : [ "Service Accounts" ] + } + }, + "/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList/{ipAddress}" : { + "delete" : { + "description" : "Removes the specified access list entry from the specified Service Account for the project. You can't remove the requesting IP address from the access list. Available as a preview feature.", + "operationId" : "deleteProjectServiceAccountAccessListEntry", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "The Client ID of the Service Account.", + "in" : "path", + "name" : "clientId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mdb_sa_id_667066535bc75b03c37b3038", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + } + }, { + "description" : "One IP address or multiple IP addresses represented as one CIDR block. When specifying a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /.", + "in" : "path", + "name" : "ipAddress", + "required" : true, + "schema" : { + "type" : "string", + "example" : "192.0.2.0%2F24", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})?$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Access List entry from one Project Service Account", + "tags" : [ "Service Accounts" ] + } + }, + "/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}:invite" : { + "post" : { + "description" : "Assigns the specified Service Account to the specified Project. Available as a preview feature.", "operationId" : "addProjectServiceAccount", "parameters" : [ { - "description" : "Id of the service account.", + "description" : "The Client ID of the Service Account.", "in" : "path", - "name" : "serviceAccountId", + "name" : "clientId", "required" : true, "schema" : { - "type" : "string" + "type" : "string", + "example" : "mdb_sa_id_667066535bc75b03c37b3038", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" } }, { "$ref" : "#/components/parameters/groupId" @@ -17611,31 +18070,30 @@ } ], "requestBody" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/GroupServiceAccountRoleAssignment" } }, - "x-xgen-version" : "2023-10-01" + "x-xgen-version" : "2024-08-05" } }, - "description" : "Service Account Roles to be assigned to the specified project.", + "description" : "The Project permissions for the Service Account in the specified Project.", "required" : true }, "responses" : { - "204" : { + "200" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { - "$ref" : "#/components/schemas/NoBody" + "$ref" : "#/components/schemas/GroupServiceAccount" }, - "x-xgen-version" : "2023-10-01" + "x-xgen-version" : "2024-08-05" } }, - "description" : "This endpoint does not return a response body.", - "x-xgen-version" : "2023-10-01" + "description" : "OK" }, "401" : { "$ref" : "#/components/responses/unauthorized" @@ -17651,7 +18109,7 @@ "DigestAuth" : [ ] } ], "summary" : "Assign One Service Account to One Project", - "tags" : [ "Groups" ] + "tags" : [ "Service Accounts" ] } }, "/api/atlas/v2/groups/{groupId}/settings" : { @@ -17845,6 +18303,405 @@ } } }, + "/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections" : { + "get" : { + "description" : "Returns all Private Link connections for the specified project.To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role.", + "operationId" : "listPrivateLinkConnections", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiStreamsPrivateLinkView" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Private Link", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2024-10-02" : "The MongoDB Atlas Streams Processing Private Link API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "post" : { + "description" : "Creates one Private Link in the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Stream Processing Owner role.", + "operationId" : "createPrivateLinkConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsPrivateLinkConnection" + } + } + }, + "description" : "Details to create one Private Link connection for a project. project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsPrivateLinkConnection" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "409" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Private Link connection", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2024-10-02" : "The MongoDB Atlas Streams Processing Private Link API is now exposed as part of private preview, but is subject to change until GA." + } + } + }, + "/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections/{connectionId}" : { + "delete" : { + "description" : "Deletes one Private Link in the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Stream Processing Owner role.", + "operationId" : "deletePrivateLinkConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique ID that identifies the Private Link connection.", + "in" : "path", + "name" : "connectionId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Accepted" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete One Private Link connection", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2024-10-02" : "The MongoDB Atlas Streams Processing Private Link API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "get" : { + "description" : "Returns the details of one Private Link connection within the project. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "getPrivateLinkConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique ID that identifies the Private Link connection.", + "in" : "path", + "name" : "connectionId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsPrivateLinkConnection" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One PrivateLink Connection", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2024-10-02" : "The MongoDB Atlas Streams Processing Private Link API is now exposed as part of private preview, but is subject to change until GA." + } + } + }, + "/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections" : { + "get" : { + "description" : "Returns a list of incoming VPC Peering Connections.", + "operationId" : "getVPCPeeringConnections", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All VPC Peering Connections.", + "tags" : [ "Streams" ] + } + }, + "/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}" : { + "delete" : { + "description" : "Deletes an incoming VPC Peering connection.", + "operationId" : "deleteVPCPeeringConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "The VPC Peering Connection id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Accepted" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Deletes an incoming VPC Peering connection.", + "tags" : [ "Streams" ] + } + }, + "/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:accept" : { + "post" : { + "description" : "Requests the acceptance of an incoming VPC Peering connection.", + "operationId" : "acceptVPCPeeringConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "The VPC Peering Connection id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/VPCPeeringActionChallenge" + } + } + }, + "description" : "Challenge values for VPC Peering requester account ID, and requester VPC ID.", + "required" : true + }, + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Accepted" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Requests the acceptance of an incoming VPC Peering connection.", + "tags" : [ "Streams" ] + } + }, + "/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:reject" : { + "post" : { + "description" : "Requests the rejection of an incoming VPC Peering connection.", + "operationId" : "rejectVPCPeeringConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "The VPC Peering Connection id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Accepted" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Requests the rejection of an incoming VPC Peering connection.", + "tags" : [ "Streams" ] + } + }, "/api/atlas/v2/groups/{groupId}/streams/{tenantName}" : { "delete" : { "description" : "Delete one stream instance in the specified project. To use this resource, the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role.", @@ -18758,6 +19615,57 @@ "tags" : [ "Streams" ] } }, + "/api/atlas/v2/groups/{groupId}/streams:withSampleConnections" : { + "post" : { + "description" : "Creates one stream instance in the specified project with sample connections. To use this resource the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role.", + "operationId" : "createStreamInstanceWithSampleConnections", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantWithSampleConnections" + } + } + }, + "description" : "Details to create one streams instance in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsTenant" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Stream Instance With Sample Connections", + "tags" : [ "Streams" ] + } + }, "/api/atlas/v2/groups/{groupId}/teams" : { "get" : { "description" : "Returns all teams to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. All members of the team share the same project access. To use this resource, the requesting API Key must have the Project Read Only role.", @@ -21178,6 +22086,70 @@ "tags" : [ "Invoices" ] } }, + "/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/lineItems:search" : { + "get" : { + "description" : "Query the lineItems of the specified invoice and return the result JSON. A unique 24-hexadecimal digit string identifies the invoice.", + "operationId" : "queryLineItemsFromSingleInvoice", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the invoice submitted to the specified organization. Charges typically post the next day.", + "in" : "path", + "name" : "invoiceId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiPublicUsageDetailsQueryRequest" + } + } + }, + "description" : "Filter parameters for the lineItems query. Send a request with an empty JSON body to retrieve all line items for a given invoiceID without applying any filters.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedPublicApiUsageDetailsLineItemView" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Query lineItems of the specified invoiceId", + "tags" : [ "Invoices" ] + } + }, "/api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects" : { "get" : { "description" : "Return all projects that you can migrate to the specified organization.", @@ -21308,38 +22280,94 @@ "tags" : [ "Cloud Migration Service" ] } }, - "/api/atlas/v2/orgs/{orgId}/serviceAccounts" : { + "/api/atlas/v2/orgs/{orgId}/nonCompliantResources" : { "get" : { - "description" : "Returns list of Service Accounts with service account details.", - "operationId" : "listServiceAccounts", + "description" : "Return all non-compliant resources for an org.", + "externalDocs" : { + "description" : "Atlas Resource Policies", + "url" : "https://docs.atlas.mongodb.com" + }, + "operationId" : "getResourcesNonCompliant", "parameters" : [ { - "$ref" : "#/components/parameters/orgId" + "$ref" : "#/components/parameters/envelope" }, { - "$ref" : "#/components/parameters/itemsPerPage" + "$ref" : "#/components/parameters/pretty" }, { - "$ref" : "#/components/parameters/pageNum" + "$ref" : "#/components/parameters/orgId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasNonCompliantResourceView" + } + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return all non-compliant resources", + "tags" : [ "Resource Policies" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/resourcePolicies" : { + "get" : { + "description" : "Return all Atlas Resource Policies for the org.", + "externalDocs" : { + "description" : "Atlas Resource Policies", + "url" : "https://docs.atlas.mongodb.com" + }, + "operationId" : "getAtlasResourcePolicies", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" }, { "$ref" : "#/components/parameters/pretty" }, { - "$ref" : "#/components/parameters/envelope" + "$ref" : "#/components/parameters/orgId" } ], "responses" : { "200" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { - "$ref" : "#/components/schemas/PaginatedOrgServiceAccounts" + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasResourcePolicyView" + } }, - "x-xgen-version" : "2023-10-01" + "x-xgen-version" : "2024-08-05" } }, "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" @@ -21348,48 +22376,64 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Return All Service Accounts", - "tags" : [ "Organizations" ] + "summary" : "Return all Atlas Resource Policies", + "tags" : [ "Resource Policies" ] }, "post" : { - "description" : "Create Service Account containing client id and client secrets.", - "operationId" : "createServiceAccount", + "description" : "Create one Atlas Resource Policy for an org.", + "externalDocs" : { + "description" : "Atlas Resource Policies", + "url" : "https://docs.atlas.mongodb.com" + }, + "operationId" : "createAtlasResourcePolicy", "parameters" : [ { - "$ref" : "#/components/parameters/orgId" - }, { "$ref" : "#/components/parameters/envelope" }, { "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/orgId" } ], "requestBody" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { - "$ref" : "#/components/schemas/OrgServiceAccountRequest" - } + "$ref" : "#/components/schemas/ApiAtlasResourcePolicyCreateView" + }, + "x-xgen-version" : "2024-08-05" } }, - "description" : "Details to create service account in the specified organization.", + "description" : "Atlas Resource Policy to create.", "required" : true }, "responses" : { "201" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { - "$ref" : "#/components/schemas/OrgServiceAccount" + "$ref" : "#/components/schemas/ApiAtlasResourcePolicyView" }, - "x-xgen-version" : "2023-10-01" + "x-xgen-version" : "2024-08-05" } }, "description" : "Created" }, "400" : { - "$ref" : "#/components/responses/badRequest" + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasInvalidResourcePolicyCreateErrorView" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "Bad request." }, "401" : { "$ref" : "#/components/responses/unauthorized" }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, "500" : { "$ref" : "#/components/responses/internalServerError" } @@ -21397,38 +22441,54 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Service Account Creation", - "tags" : [ "Organizations" ] + "summary" : "Create one Atlas Resource Policy", + "tags" : [ "Resource Policies" ] } }, - "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}" : { + "/api/atlas/v2/orgs/{orgId}/resourcePolicies/{resourcePolicyId}" : { "delete" : { - "description" : "Delete Service Account.", - "operationId" : "deleteServiceAccount", + "description" : "Delete one Atlas Resource Policy for an org.", + "externalDocs" : { + "description" : "Atlas Resource Policies", + "url" : "https://docs.atlas.mongodb.com" + }, + "operationId" : "deleteAtlasResourcePolicy", "parameters" : [ { - "description" : "Id of the service account.", + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies an atlas resource policy.", "in" : "path", - "name" : "serviceAccountId", + "name" : "resourcePolicyId", "required" : true, "schema" : { - "type" : "string" + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the atlas resource policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true } - }, { - "$ref" : "#/components/parameters/orgId" - }, { - "$ref" : "#/components/parameters/envelope" - }, { - "$ref" : "#/components/parameters/pretty" } ], "responses" : { - "204" : { + "200" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "x-xgen-version" : "2023-10-01" + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2024-08-05" } }, "description" : "This endpoint does not return a response body." }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, "401" : { "$ref" : "#/components/responses/unauthorized" }, @@ -21442,39 +22502,52 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Service Account Deletion.", - "tags" : [ "Organizations" ] + "summary" : "Delete one Atlas Resource Policy", + "tags" : [ "Resource Policies" ] }, "get" : { - "description" : "Get Service Account Details.", - "operationId" : "getServiceAccount", + "description" : "Return one Atlas Resource Policy for an org.", + "externalDocs" : { + "description" : "Atlas Resource Policies", + "url" : "https://docs.atlas.mongodb.com" + }, + "operationId" : "getAtlasResourcePolicy", "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { "$ref" : "#/components/parameters/orgId" }, { - "description" : "Id of the service account.", + "description" : "Unique 24-hexadecimal digit string that identifies an atlas resource policy.", "in" : "path", - "name" : "serviceAccountId", + "name" : "resourcePolicyId", "required" : true, "schema" : { - "type" : "string" + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the atlas resource policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true } - }, { - "$ref" : "#/components/parameters/envelope" - }, { - "$ref" : "#/components/parameters/pretty" } ], "responses" : { "200" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { - "$ref" : "#/components/schemas/OrgServiceAccount" + "$ref" : "#/components/schemas/ApiAtlasResourcePolicyView" }, - "x-xgen-version" : "2023-10-01" + "x-xgen-version" : "2024-08-05" } }, "description" : "OK" }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, "401" : { "$ref" : "#/components/responses/unauthorized" }, @@ -21488,52 +22561,138 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Service Account Fetching", - "tags" : [ "Organizations" ] + "summary" : "Return one Atlas Resource Policy", + "tags" : [ "Resource Policies" ] }, "patch" : { - "description" : "Update Service Account.", - "operationId" : "updateServiceAccount", + "description" : "Update one Atlas Resource Policy for an org.", + "externalDocs" : { + "description" : "Atlas Resource Policies", + "url" : "https://docs.atlas.mongodb.com" + }, + "operationId" : "updateAtlasResourcePolicy", "parameters" : [ { - "description" : "Id of the service account.", + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies an atlas resource policy.", "in" : "path", - "name" : "serviceAccountId", + "name" : "resourcePolicyId", "required" : true, "schema" : { - "type" : "string" + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the atlas resource policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true } - }, { - "$ref" : "#/components/parameters/orgId" - }, { + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasResourcePolicyEditView" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "Atlas Resource Policy to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasResourcePolicyView" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "Ok" + }, + "400" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasInvalidResourcePolicyCreateErrorView" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "Bad request." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update one Atlas Resource Policy", + "tags" : [ "Resource Policies" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/resourcePolicies:validate" : { + "post" : { + "description" : "Validate one Atlas Resource Policy for an org.", + "externalDocs" : { + "description" : "Atlas Resource Policies", + "url" : "https://docs.atlas.mongodb.com" + }, + "operationId" : "validateAtlasResourcePolicy", + "parameters" : [ { "$ref" : "#/components/parameters/envelope" }, { "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/orgId" } ], "requestBody" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { - "$ref" : "#/components/schemas/OrgServiceAccountUpdateRequest" - } + "$ref" : "#/components/schemas/ApiAtlasResourcePolicyCreateView" + }, + "x-xgen-version" : "2024-08-05" } }, - "description" : "Details to update service account in the specified organization.", + "description" : "Atlas Resource Policy to create.", "required" : true }, "responses" : { "200" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { - "$ref" : "#/components/schemas/OrgServiceAccount" + "$ref" : "#/components/schemas/ApiAtlasResourcePolicyView" }, - "x-xgen-version" : "2023-10-01" + "x-xgen-version" : "2024-08-05" } }, - "description" : "OK" + "description" : "Ok" }, "400" : { - "$ref" : "#/components/responses/badRequest" + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasInvalidResourcePolicyCreateErrorView" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "Bad request." }, "401" : { "$ref" : "#/components/responses/unauthorized" @@ -21548,24 +22707,16 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Service Account Update", - "tags" : [ "Organizations" ] + "summary" : "Validate one Atlas Resource Policy", + "tags" : [ "Resource Policies" ] } }, - "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/groups" : { + "/api/atlas/v2/orgs/{orgId}/serviceAccounts" : { "get" : { - "description" : "Returns list of Service Account projects.", - "operationId" : "listServiceAccountProjects", + "description" : "Returns all Service Accounts for the specified Organization. Available as a preview feature.", + "operationId" : "listServiceAccounts", "parameters" : [ { "$ref" : "#/components/parameters/orgId" - }, { - "description" : "Id of the service account.", - "in" : "path", - "name" : "serviceAccountId", - "required" : true, - "schema" : { - "type" : "string" - } }, { "$ref" : "#/components/parameters/itemsPerPage" }, { @@ -21578,11 +22729,11 @@ "responses" : { "200" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { - "$ref" : "#/components/schemas/PaginatedServiceAccountGroup" + "$ref" : "#/components/schemas/PaginatedOrgServiceAccounts" }, - "x-xgen-version" : "2023-10-01" + "x-xgen-version" : "2024-08-05" } }, "description" : "OK" @@ -21600,24 +22751,14 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Return All Service Account projects", - "tags" : [ "Organizations" ] - } - }, - "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets" : { + "summary" : "List All Organization Service Accounts", + "tags" : [ "Service Accounts" ] + }, "post" : { - "description" : "Create Service Account secret.", - "operationId" : "createServiceAccountSecret", + "description" : "Creates one Service Account for the specified Organization. Available as a preview feature.", + "operationId" : "createServiceAccount", "parameters" : [ { "$ref" : "#/components/parameters/orgId" - }, { - "description" : "Id of the service account.", - "in" : "path", - "name" : "serviceAccountId", - "required" : true, - "schema" : { - "type" : "string" - } }, { "$ref" : "#/components/parameters/envelope" }, { @@ -21625,23 +22766,23 @@ } ], "requestBody" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceAccountSecretRequest" + "$ref" : "#/components/schemas/OrgServiceAccountRequest" } } }, - "description" : "Details to create secret in the specified service account.", + "description" : "Details of the new Service Account.", "required" : true }, "responses" : { "201" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { - "$ref" : "#/components/schemas/ServiceAccountSecret" + "$ref" : "#/components/schemas/OrgServiceAccount" }, - "x-xgen-version" : "2023-10-01" + "x-xgen-version" : "2024-08-05" } }, "description" : "Created" @@ -21659,29 +22800,23 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Service Account Secret Creation", - "tags" : [ "Organizations" ] + "summary" : "Create one Organization Service Account", + "tags" : [ "Service Accounts" ] } }, - "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets/{secretId}" : { + "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}" : { "delete" : { - "description" : "Delete Service Account Secret.", - "operationId" : "deleteServiceAccountSecret", + "description" : "Deletes the specified Service Account. Available as a preview feature.", + "operationId" : "deleteServiceAccount", "parameters" : [ { - "description" : "Id of the service account.", + "description" : "The Client ID of the Service Account.", "in" : "path", - "name" : "serviceAccountId", + "name" : "clientId", "required" : true, "schema" : { - "type" : "string" - } - }, { - "description" : "Id of the secret.", - "in" : "path", - "name" : "secretId", - "required" : true, - "schema" : { - "type" : "string" + "type" : "string", + "example" : "mdb_sa_id_667066535bc75b03c37b3038", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" } }, { "$ref" : "#/components/parameters/orgId" @@ -21693,8 +22828,8 @@ "responses" : { "204" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "x-xgen-version" : "2023-10-01" + "application/vnd.atlas.2024-08-05+json" : { + "x-xgen-version" : "2024-08-05" } }, "description" : "This endpoint does not return a response body." @@ -21712,29 +22847,37 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Service Account Secret Deletion.", - "tags" : [ "Organizations" ] - } - }, - "/api/atlas/v2/orgs/{orgId}/settings" : { + "summary" : "Delete one Organization Service Account", + "tags" : [ "Service Accounts" ] + }, "get" : { - "description" : "Returns details about the specified organization's settings. To use this resource, the requesting API Key must have the Organization Owner role.", - "operationId" : "getOrganizationSettings", + "description" : "Returns the specified Service Account. Available as a preview feature.", + "operationId" : "getServiceAccount", "parameters" : [ { - "$ref" : "#/components/parameters/envelope" - }, { "$ref" : "#/components/parameters/orgId" + }, { + "description" : "The Client ID of the Service Account.", + "in" : "path", + "name" : "clientId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mdb_sa_id_667066535bc75b03c37b3038", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + } + }, { + "$ref" : "#/components/parameters/envelope" }, { "$ref" : "#/components/parameters/pretty" } ], "responses" : { "200" : { "content" : { - "application/vnd.atlas.2023-01-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { - "$ref" : "#/components/schemas/OrganizationSettings" + "$ref" : "#/components/schemas/OrgServiceAccount" }, - "x-xgen-version" : "2023-01-01" + "x-xgen-version" : "2024-08-05" } }, "description" : "OK" @@ -21742,9 +22885,6 @@ "401" : { "$ref" : "#/components/responses/unauthorized" }, - "403" : { - "$ref" : "#/components/responses/forbidden" - }, "404" : { "$ref" : "#/components/responses/notFound" }, @@ -21755,48 +22895,58 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Return Settings for One Organization", - "tags" : [ "Organizations" ] + "summary" : "Get one Organization Service Account", + "tags" : [ "Service Accounts" ] }, "patch" : { - "description" : "Updates the organization's settings. To use this resource, the requesting API Key must have the Organization Owner role.", - "operationId" : "updateOrganizationSettings", + "description" : "Updates the specified Service Account in the specified Organization. Available as a preview feature.", + "operationId" : "updateServiceAccount", "parameters" : [ { - "$ref" : "#/components/parameters/envelope" + "description" : "The Client ID of the Service Account.", + "in" : "path", + "name" : "clientId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mdb_sa_id_667066535bc75b03c37b3038", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + } }, { "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" }, { "$ref" : "#/components/parameters/pretty" } ], "requestBody" : { "content" : { - "application/vnd.atlas.2023-01-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { - "$ref" : "#/components/schemas/OrganizationSettings" + "$ref" : "#/components/schemas/OrgServiceAccountUpdateRequest" } } }, - "description" : "Details to update on the specified organization's settings.", + "description" : "The new details for the Service Account.", "required" : true }, "responses" : { "200" : { "content" : { - "application/vnd.atlas.2023-01-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { - "$ref" : "#/components/schemas/OrganizationSettings" + "$ref" : "#/components/schemas/OrgServiceAccount" }, - "x-xgen-version" : "2023-01-01" + "x-xgen-version" : "2024-08-05" } }, "description" : "OK" }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, "401" : { "$ref" : "#/components/responses/unauthorized" }, - "403" : { - "$ref" : "#/components/responses/forbidden" - }, "404" : { "$ref" : "#/components/responses/notFound" }, @@ -21807,51 +22957,52 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Update Settings for One Organization", - "tags" : [ "Organizations" ] + "summary" : "Update one Organization Service Account", + "tags" : [ "Service Accounts" ] } }, - "/api/atlas/v2/orgs/{orgId}/teams" : { + "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/groups" : { "get" : { - "description" : "Returns all teams that belong to the specified organization. Teams enable you to grant project access roles to MongoDB Cloud users. MongoDB Cloud only returns teams for which you have access. To use this resource, the requesting API Key must have the Organization Member role.", - "externalDocs" : { - "description" : "Manage Organization Teams", - "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" - }, - "operationId" : "listOrganizationTeams", + "description" : "Returns a list of all projects the specified Service Account is a part of. Available as a preview feature.", + "operationId" : "listServiceAccountProjects", "parameters" : [ { - "$ref" : "#/components/parameters/envelope" + "$ref" : "#/components/parameters/orgId" }, { - "$ref" : "#/components/parameters/itemsPerPage" + "description" : "The Client ID of the Service Account.", + "in" : "path", + "name" : "clientId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mdb_sa_id_667066535bc75b03c37b3038", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + } }, { - "$ref" : "#/components/parameters/includeCount" + "$ref" : "#/components/parameters/itemsPerPage" }, { "$ref" : "#/components/parameters/pageNum" - }, { - "$ref" : "#/components/parameters/orgId" }, { "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/envelope" } ], "responses" : { "200" : { "content" : { - "application/vnd.atlas.2023-01-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { - "$ref" : "#/components/schemas/PaginatedTeamView" + "$ref" : "#/components/schemas/PaginatedServiceAccountGroup" }, - "x-xgen-version" : "2023-01-01" + "x-xgen-version" : "2024-08-05" } }, "description" : "OK" }, - "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" @@ -21860,14 +23011,281 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Return All Teams in One Organization", - "tags" : [ "Teams" ] - }, + "summary" : "Return All Service Account Project assignments", + "tags" : [ "Service Accounts" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/secrets" : { "post" : { - "description" : "Creates one team in the specified organization. Teams enable you to grant project access roles to MongoDB Cloud users. MongoDB Cloud limits the number of teams to a maximum of 250 teams per organization. To use this resource, the requesting API Key must have the Organization Owner role.", - "externalDocs" : { - "description" : "Manage Organization Teams", - "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + "description" : "Create a secret for the specified Service Account. Available as a preview feature.", + "operationId" : "createServiceAccountSecret", + "parameters" : [ { + "$ref" : "#/components/parameters/orgId" + }, { + "description" : "The Client ID of the Service Account.", + "in" : "path", + "name" : "clientId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mdb_sa_id_667066535bc75b03c37b3038", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + } + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceAccountSecretRequest" + } + } + }, + "description" : "Details for the new secret.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceAccountSecret" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create one Organization Service Account Secret", + "tags" : [ "Service Accounts" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/secrets/{secretId}" : { + "delete" : { + "description" : "Deletes the specified Service Account secret. Available as a preview feature.", + "operationId" : "deleteServiceAccountSecret", + "parameters" : [ { + "description" : "The Client ID of the Service Account.", + "in" : "path", + "name" : "clientId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mdb_sa_id_667066535bc75b03c37b3038", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + } + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the secret.", + "in" : "path", + "name" : "secretId", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "This endpoint does not return a response body." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete a Organization Service Account Secret", + "tags" : [ "Service Accounts" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/settings" : { + "get" : { + "description" : "Returns details about the specified organization's settings. To use this resource, the requesting API Key must have the Organization Owner role.", + "operationId" : "getOrganizationSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Settings for One Organization", + "tags" : [ "Organizations" ] + }, + "patch" : { + "description" : "Updates the organization's settings. To use this resource, the requesting API Key must have the Organization Owner role.", + "operationId" : "updateOrganizationSettings", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationSettings" + } + } + }, + "description" : "Details to update on the specified organization's settings.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrganizationSettings" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update Settings for One Organization", + "tags" : [ "Organizations" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/teams" : { + "get" : { + "description" : "Returns all teams that belong to the specified organization. Teams enable you to grant project access roles to MongoDB Cloud users. MongoDB Cloud only returns teams for which you have access. To use this resource, the requesting API Key must have the Organization Member role.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" + }, + "operationId" : "listOrganizationTeams", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedTeamView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Teams in One Organization", + "tags" : [ "Teams" ] + }, + "post" : { + "description" : "Creates one team in the specified organization. Teams enable you to grant project access roles to MongoDB Cloud users. MongoDB Cloud limits the number of teams to a maximum of 250 teams per organization. To use this resource, the requesting API Key must have the Organization Owner role.", + "externalDocs" : { + "description" : "Manage Organization Teams", + "url" : "https://docs.atlas.mongodb.com/access/manage-teams-in-orgs/#std-label-manage-teams" }, "operationId" : "createTeam", "parameters" : [ { @@ -22417,12 +23835,15 @@ }, "/api/atlas/v2/orgs/{orgId}/users/{userId}" : { "delete" : { + "deprecated" : true, "description" : "Removes one MongoDB Cloud user from the specified organization. To use this resource, the requesting API Key must have the Organization User Admin role.", "operationId" : "removeOrganizationUser", "parameters" : [ { "$ref" : "#/components/parameters/envelope" }, { "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" }, { "description" : "Unique 24-hexadecimal digit string that identifies the user to be deleted.", "in" : "path", @@ -22466,8 +23887,9 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Remove One MongoDB Cloud User from One Organization", - "tags" : [ "Organizations" ] + "summary" : "Remove One MongoDB Cloud User From One Organization", + "tags" : [ "Organizations" ], + "x-sunset" : "2026-01-01" } }, "/api/atlas/v2/orgs/{orgId}/users/{userId}/roles" : { @@ -22562,6 +23984,53 @@ "tags" : [ "Root" ] } }, + "/api/atlas/v2/unauth/openapi/versions" : { + "get" : { + "description" : "API that provides a list of available versionsfor a given environment.", + "operationId" : "getApiVersions", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "The environment to get the versions from. If not provided, it returnsthe versions for the given MongoDB URL. (E.g. prod for cloud.mongodb.com)", + "in" : "query", + "name" : "env", + "schema" : { + "type" : "string", + "enum" : [ "dev", "qa", "prod", "stage" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiVersions" + }, + "x-xgen-version" : "2024-08-05" + }, + "application/vnd.atlas.2024-08-05+yaml" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiVersions" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "OK" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "summary" : "Provides a list of versions for a given environment.", + "tags" : [ "OpenAPI" ] + } + }, "/api/atlas/v2/users" : { "post" : { "description" : "Creates one MongoDB Cloud user account. A MongoDB Cloud user account grants access to only the MongoDB Cloud application. To grant database access, create a database user. MongoDB Cloud sends an email to the users you specify, inviting them to join the project. Invited users don't have access to the project until they accept the invitation. Invitations expire after 30 days.\n\n 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.\n\n To use this resource, the requesting API Key can have any role.", @@ -23215,7 +24684,7 @@ "diskIOPS" : { "type" : "integer", "format" : "int32", - "description" : "Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.\n\n Change this parameter only if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" to \"AWS\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" to \"M30\"` or greater (not including `Mxx_NVME` tiers).\n\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType\" to \"PROVISIONED\"`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1." + "description" : "Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.\n\n Change this parameter if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" to \"AWS\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" to \"M30\"` or greater (not including `Mxx_NVME` tiers).\n\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType\" to \"PROVISIONED\"`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1." }, "ebsVolumeType" : { "type" : "string", @@ -23244,7 +24713,7 @@ "diskIOPS" : { "type" : "integer", "format" : "int32", - "description" : "Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.\n\n You can set different IOPS values on different shards when provisioned IOPS are supported.\n\n Change this parameter only if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" to \"AWS\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" to \"M30\"` or greater (not including `Mxx_NVME` tiers).\n\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType\" to \"PROVISIONED\"`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1." + "description" : "Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.\n\n You can set different IOPS values on different shards when provisioned IOPS are supported.\n\n Change this parameter if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" to \"AWS\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" to \"M30\"` or greater (not including `Mxx_NVME` tiers).\n\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType\" to \"PROVISIONED\"`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1." }, "diskSizeGB" : { "type" : "number", @@ -23575,6 +25044,26 @@ "description" : "Configuration of nodes that comprise the cluster.", "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] }, + "configServerManagementMode" : { + "type" : "string", + "default" : "ATLAS_MANAGED", + "description" : "Config Server Management Mode for creating or updating a sharded cluster.\n\nWhen configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings.\n\nWhen configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server.", + "enum" : [ "ATLAS_MANAGED", "FIXED_TO_DEDICATED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + } + }, + "configServerType" : { + "type" : "string", + "description" : "Describes a sharded cluster's config server type.", + "enum" : [ "DEDICATED", "EMBEDDED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + }, + "readOnly" : true + }, "connectionStrings" : { "$ref" : "#/components/schemas/ClusterConnectionStrings" }, @@ -23610,6 +25099,17 @@ "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" } }, + "featureCompatibilityVersion" : { + "type" : "string", + "description" : "Feature compatibility version of the cluster.", + "readOnly" : true + }, + "featureCompatibilityVersionExpirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Feature compatibility version expiration date.", + "readOnly" : true + }, "globalClusterSelfManagedSharding" : { "type" : "boolean", "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen 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.\n\nWhen 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.\n\nThis setting cannot be changed once the cluster is deployed.", @@ -23656,6 +25156,9 @@ }, "readOnly" : true }, + "mongoDBEmployeeAccessGrant" : { + "$ref" : "#/components/schemas/EmployeeAccessGrantView" + }, "mongoDBMajorVersion" : { "type" : "string", "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", @@ -23675,7 +25178,7 @@ "description" : "Human-readable label that identifies the advanced cluster.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, "paused" : { "type" : "boolean", @@ -23689,6 +25192,16 @@ "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" } }, + "replicaSetScalingStrategy" : { + "type" : "string", + "default" : "WORKLOAD_TYPE", + "description" : "Set this field to configure the replica set scaling mode for your cluster.\n\nBy default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes.\n\nWhen configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads.\n\nWhen configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads.", + "enum" : [ "SEQUENTIAL", "WORKLOAD_TYPE", "NODE_TYPE" ], + "externalDocs" : { + "description" : "Modify the Replica Set Scaling Mode", + "url" : "https://dochub.mongodb.org/core/scale-nodes" + } + }, "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.", @@ -24559,6 +26072,257 @@ }, "title" : "mappings" }, + "ApiAtlasInvalidPolicyErrorDetailView" : { + "type" : "object", + "properties" : { + "detail" : { + "type" : "string", + "description" : "A string that provides a detailed description of a validation error.", + "readOnly" : true + } + } + }, + "ApiAtlasInvalidPolicyView" : { + "type" : "object", + "properties" : { + "body" : { + "type" : "string", + "description" : "A string that defines the permissions for the policy. The syntax used is the Cedar Policy language.", + "example" : " forbid (\n principal,\n action == cloud::Action::\"cluster.createEdit\",\n resource\n ) when {\n context.cluster.regions.contains(cloud::region::\"aws:us-east-1\")\n };\n", + "readOnly" : true + }, + "errors" : { + "type" : "array", + "description" : "List of validation errors.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasInvalidPolicyErrorDetailView" + }, + "readOnly" : true + } + } + }, + "ApiAtlasInvalidResourcePolicyCreateErrorView" : { + "type" : "object", + "properties" : { + "errorType" : { + "type" : "string", + "description" : "Human-readable label that displays the type of an error.", + "enum" : [ "POLICY_PARSING_ERROR", "POLICY_HAS_FAILED_VALIDATIONS", "POLICY_HAS_INVALID_PRINCIPAL", "POLICY_HAS_BODY_EXCEEDING_MAX_SIZE", "POLICY_HAS_UNEXPECTED_ENTITIES" ] + }, + "invalidPolicies" : { + "type" : "array", + "description" : "List of invalid policies containing details of their validation errors.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasInvalidPolicyView" + }, + "readOnly" : true + } + } + }, + "ApiAtlasNonCompliantResourceView" : { + "type" : "object", + "properties" : { + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization the resource belongs to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resourceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the non-compliant resource.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resourcePoliciesCausingNonCompliance" : { + "type" : "array", + "description" : "List of resource policies causing the resource to be considered non-compliant.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasResourcePolicyMetadataView" + }, + "readOnly" : true + }, + "resourceType" : { + "type" : "string", + "description" : "Human-readable label that displays the type of a resource.", + "enum" : [ "PROJECT", "CLUSTER" ], + "readOnly" : true + } + } + }, + "ApiAtlasPolicyCreateView" : { + "type" : "object", + "properties" : { + "body" : { + "type" : "string", + "description" : "A string that defines the permissions for the policy. The syntax used is the Cedar Policy language.", + "example" : " forbid (\n principal,\n action == cloud::Action::\"cluster.createEdit\",\n resource\n ) when {\n context.cluster.regions.contains(cloud::region::\"aws:us-east-1\")\n };\n" + } + }, + "required" : [ "body" ] + }, + "ApiAtlasPolicyMetadataView" : { + "type" : "object", + "properties" : { + "policyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "ApiAtlasPolicyView" : { + "type" : "object", + "properties" : { + "body" : { + "type" : "string", + "description" : "A string that defines the permissions for the policy. The syntax used is the Cedar Policy language.", + "example" : " forbid (\n principal,\n action == cloud::Action::\"cluster.createEdit\",\n resource\n ) when {\n context.cluster.regions.contains(cloud::region::\"aws:us-east-1\")\n };\n", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "ApiAtlasResourcePolicyCreateView" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that describes the atlas resource policy." + }, + "policies" : { + "type" : "array", + "description" : "List of policies that make up the atlas resource policy.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasPolicyCreateView" + } + } + }, + "required" : [ "name", "policies" ] + }, + "ApiAtlasResourcePolicyEditView" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that describes the atlas resource policy." + }, + "policies" : { + "type" : "array", + "description" : "List of policies that make up the atlas resource policy.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasPolicyCreateView" + } + } + } + }, + "ApiAtlasResourcePolicyMetadataView" : { + "type" : "object", + "properties" : { + "policiesCausingNonCompliance" : { + "type" : "array", + "description" : "List of policies that are in conflict with the current state of the resource.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasPolicyMetadataView" + }, + "readOnly" : true + }, + "resourcePolicyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the atlas resource policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resourcePolicyName" : { + "type" : "string", + "description" : "Human-readable label that describes the atlas resource policy.", + "readOnly" : true + } + } + }, + "ApiAtlasResourcePolicyView" : { + "type" : "object", + "properties" : { + "createdByUser" : { + "$ref" : "#/components/schemas/ApiAtlasUserMetadataView" + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time in UTC when the atlas resource policy was created.", + "example" : "2022-01-01T00:00:00Z", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the atlas resource policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastUpdatedByUser" : { + "$ref" : "#/components/schemas/ApiAtlasUserMetadataView" + }, + "lastUpdatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time in UTC when the atlas resource policy was last updated.", + "example" : "2022-01-01T00:00:00Z", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that describes the atlas resource policy.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization the atlas resource policy belongs to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "policies" : { + "type" : "array", + "description" : "List of policies that make up the atlas resource policy.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasPolicyView" + }, + "readOnly" : true + }, + "version" : { + "type" : "string", + "description" : "A string that identifies the version of the atlas resource policy.", + "example" : "v1", + "readOnly" : true + } + } + }, "ApiAtlasSnapshotScheduleView" : { "type" : "object", "properties" : { @@ -24635,6 +26399,27 @@ }, "required" : [ "clusterCheckpointIntervalMin", "clusterId", "dailySnapshotRetentionDays", "groupId", "monthlySnapshotRetentionMonths", "pointInTimeWindowHours", "snapshotIntervalHours", "snapshotRetentionDays", "weeklySnapshotRetentionWeeks" ] }, + "ApiAtlasUserMetadataView" : { + "type" : "object", + "description" : "The user that last updated the atlas resource policy.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies a user.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that describes a user.", + "readOnly" : true + } + }, + "readOnly" : true + }, "ApiBSONTimestampView" : { "type" : "object", "description" : "BSON timestamp that indicates when the checkpoint token entry in the oplog occurred.", @@ -24691,6 +26476,9 @@ "ApiError" : { "type" : "object", "properties" : { + "badRequestDetail" : { + "$ref" : "#/components/schemas/BadRequestDetail" + }, "detail" : { "type" : "string", "description" : "Describes the specific conditions or reasons that cause each type of error." @@ -24701,24 +26489,30 @@ "description" : "HTTP status code returned with this error.", "externalDocs" : { "url" : "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status" - } + }, + "readOnly" : true }, "errorCode" : { "type" : "string", - "description" : "Application error code returned with this error." + "description" : "Application error code returned with this error.", + "readOnly" : true }, "parameters" : { "type" : "array", "description" : "Parameters used to give more information about the error.", "items" : { - "type" : "object" - } + "type" : "object", + "readOnly" : true + }, + "readOnly" : true }, "reason" : { "type" : "string", - "description" : "Application error message returned with this error." + "description" : "Application error message returned with this error.", + "readOnly" : true } - } + }, + "required" : [ "error", "errorCode" ] }, "ApiHostView_Atlas" : { "type" : "object", @@ -24974,6 +26768,24 @@ } } }, + "ApiPrivateDownloadDeliveryUrl" : { + "type" : "object", + "description" : "One Uniform Resource Locator (URL) that points to the compressed snapshot files for manual download and the corresponding private endpoint.", + "properties" : { + "deliveryUrl" : { + "type" : "string", + "description" : "One Uniform Resource Locator that points to the compressed snapshot files for manual download." + }, + "endpointId" : { + "type" : "string", + "description" : "Unique 22-character alphanumeric string that identifies the private endpoint.", + "example" : "vpce-3bf78b0ddee411ba1", + "maxLength" : 22, + "minLength" : 22, + "pattern" : "^vpce-[0-9a-f]{17}$" + } + } + }, "ApiPublicUsageDetailsQueryRequest" : { "type" : "object", "description" : "Request body for an Invoice Usage Details query with filtering, pagination, and sort.", @@ -25067,7 +26879,12 @@ "ApiStreamsAWSRegionView" : { "type" : "string", "description" : "Atlas Streams AWS Regions.", - "enum" : [ "VIRGINIA_USA" ] + "enum" : [ "SYDNEY_AUS", "MUMBAI_IND", "FRANKFURT_DEU", "DUBLIN_IRL", "LONDON_GBR", "VIRGINIA_USA", "OREGON_USA", "SAOPAULO_BRA", "MONTREAL_CAN", "TOKYO_JPN", "SINGAPORE_SGP" ] + }, + "ApiStreamsAzureRegionView" : { + "type" : "string", + "description" : "Atlas Streams Azure Regions.", + "enum" : [ "VIRGINIA_USA", "AMSTERDAM_NLD" ] }, "ApiUserEventTypeViewForNdsGroup" : { "type" : "string", @@ -25291,6 +27108,15 @@ "required" : [ "created", "eventTypeName", "id" ], "title" : "API User Events" }, + "ApiVersion" : { + "type" : "object", + "properties" : { + "version" : { + "type" : "string", + "description" : "Object representing a version of the Atlas Admin API." + } + } + }, "AppServiceAlertConfigViewForNdsGroup" : { "type" : "object", "description" : "App Services metric alert configuration allows to select which app service conditions and events trigger alerts and how users are notified.", @@ -25713,7 +27539,9 @@ "enum" : [ "AVERAGE" ] }, "operator" : { - "$ref" : "#/components/schemas/Operator" + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, "threshold" : { "type" : "number", @@ -25753,6 +27581,11 @@ "description" : "Atlas Data Federation Azure Regions.", "enum" : [ "VIRGINIA_USA", "AMSTERDAM_NLD" ] }, + "AtlasDataFederationGCPRegion" : { + "type" : "string", + "description" : "Atlas Data Federation GCP Regions.", + "enum" : [ "IOWA_USA", "BELGIUM_EU" ] + }, "AtlasOrganization" : { "type" : "object", "description" : "Details that describe the organization.", @@ -25793,6 +27626,122 @@ }, "required" : [ "name" ] }, + "AtlasResourcePolicyAuditForOrg" : { + "type" : "object", + "description" : "Atlas resource policy audits indicate org level changes to resource policies", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "RESOURCE_POLICY_CREATED", "RESOURCE_POLICY_MODIFIED", "RESOURCE_POLICY_DELETED" ], + "example" : "RESOURCE_POLICY_CREATED", + "title" : "Atlas Resource Policy Audit Types" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "resourcePolicyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the resource policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Atlas Resource Policy Audits" + }, "AtlasSearchAnalyzer" : { "type" : "object", "properties" : { @@ -26308,6 +28257,15 @@ "AzureHardwareSpec" : { "type" : "object", "properties" : { + "diskIOPS" : { + "type" : "integer", + "format" : "int32", + "description" : "Target throughput desired for storage attached to your Azure-provisioned cluster. Change this parameter if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" : \"Azure\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : \"M40\"` or greater not including `Mxx_NVME` tiers.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://www.mongodb.com/docs/atlas/customize-storage/#extend-iops-on-azure" + } + }, "instanceSize" : { "type" : "string", "description" : "Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts of the node type.", @@ -26324,6 +28282,15 @@ "AzureHardwareSpec20240805" : { "type" : "object", "properties" : { + "diskIOPS" : { + "type" : "integer", + "format" : "int32", + "description" : "Target throughput desired for storage attached to your Azure-provisioned cluster. Change this parameter if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" : \"Azure\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : \"M40\"` or greater not including `Mxx_NVME` tiers.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://www.mongodb.com/docs/atlas/customize-storage/#extend-iops-on-azure" + } + }, "diskSizeGB" : { "type" : "number", "format" : "double", @@ -26451,7 +28418,7 @@ "status" : { "type" : "string", "description" : "State of the Encryption At Rest private endpoint.", - "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "ACTIVE", "FAILED" ], + "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "ACTIVE", "FAILED", "PENDING_RECREATION", "DELETING" ], "readOnly" : true } }, @@ -26784,7 +28751,7 @@ "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to create an online archive.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "collName" : { @@ -26868,7 +28835,7 @@ "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to create an online archive.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "collName" : { @@ -26971,7 +28938,7 @@ "description" : "Human-readable label that identifies the cluster containing the snapshots you want to retrieve.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -27128,7 +29095,7 @@ "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\"`.\n\nIf the target cluster doesn't have backup enabled, two resources return parameters with empty values:\n\n- **Get All Snapshots** endpoint returns an empty results array without **clusterId** elements\n- **Get a Snapshot** endpoint doesn't return a **clusterId** parameter.\n\nTo return a response with the **clusterId** parameter, either use the **delivery.targetClusterName** parameter or enable backup on the target cluster.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, "targetGroupId" : { "type" : "string", @@ -27389,6 +29356,20 @@ } } }, + "BadRequestDetail" : { + "type" : "object", + "description" : "Bad request detail.", + "properties" : { + "fields" : { + "type" : "array", + "description" : "Describes all violations in a client request.", + "items" : { + "$ref" : "#/components/schemas/FieldViolation" + } + } + }, + "readOnly" : true + }, "BaseAtlasDataLakeRegion" : { "type" : "object", "description" : "Name of the region to which the data lake routes client connections.", @@ -27396,6 +29377,8 @@ "$ref" : "#/components/schemas/ApiAtlasDataLakeAWSRegionView" }, { "$ref" : "#/components/schemas/AtlasDataFederationAzureRegion" + }, { + "$ref" : "#/components/schemas/AtlasDataFederationGCPRegion" } ] }, "BaseCloudProviderInstanceSize" : { @@ -27463,6 +29446,8 @@ "description" : "Name of the cloud provider region hosting Atlas Stream Processing.", "oneOf" : [ { "$ref" : "#/components/schemas/ApiStreamsAWSRegionView" + }, { + "$ref" : "#/components/schemas/ApiStreamsAzureRegionView" } ] }, "BasicBSONList" : { @@ -28352,7 +30337,7 @@ "description" : "Human-readable label that identifies the cluster.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "nodeCount" : { @@ -28404,6 +30389,11 @@ "format" : "date-time", "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." }, + "description" : { + "type" : "string", + "description" : "Description of this database user.", + "maxLength" : 100 + }, "groupId" : { "type" : "string", "description" : "Unique 24-hexadecimal digit string that identifies the project.", @@ -28582,6 +30572,123 @@ "description" : "Details that describe the features linked to the Amazon Web Services (AWS) Identity and Access Management (IAM) role.", "required" : [ "providerName" ] }, + "CloudProviderAccessAWSIAMRoleRequest" : { + "type" : "object", + "description" : "Details that describe the features linked to the Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "properties" : { + "atlasAWSAccountArn" : { + "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.", + "example" : "arn:aws:iam::772401394250:role/my-test-aws-role", + "maxLength" : 2048, + "minLength" : 20, + "readOnly" : true + }, + "atlasAssumedRoleExternalId" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique external ID that MongoDB Cloud uses when it assumes the IAM role in your Amazon Web Services (AWS) account.", + "readOnly" : true + }, + "authorizedDate" : { + "type" : "string", + "format" : "date-time", + "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.", + "readOnly" : true + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "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.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider of the role.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "roleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + }, + "required" : [ "providerName" ] + }, + "CloudProviderAccessAWSIAMRoleRequestUpdate" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessRoleRequestUpdate" + }, { + "type" : "object", + "properties" : { + "atlasAWSAccountArn" : { + "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.", + "example" : "arn:aws:iam::772401394250:role/my-test-aws-role", + "maxLength" : 2048, + "minLength" : 20, + "readOnly" : true + }, + "atlasAssumedRoleExternalId" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique external ID that MongoDB Cloud uses when it assumes the IAM role in your Amazon Web Services (AWS) account.", + "readOnly" : true + }, + "authorizedDate" : { + "type" : "string", + "format" : "date-time", + "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.", + "readOnly" : true + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "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.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "iamAssumedRoleArn" : { + "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", + "maxLength" : 2048, + "minLength" : 20 + }, + "roleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + } ], + "description" : "Details that describe the features linked to the Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "required" : [ "providerName" ] + }, "CloudProviderAccessAzureServicePrincipal" : { "type" : "object", "allOf" : [ { @@ -28644,6 +30751,130 @@ "description" : "Details that describe the features linked to the Azure Service Principal.", "required" : [ "providerName" ] }, + "CloudProviderAccessAzureServicePrincipalRequest" : { + "type" : "object", + "description" : "Details that describe the features linked to the Azure Service Principal.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "atlasAzureAppId" : { + "type" : "string", + "description" : "Azure Active Directory Application ID of Atlas.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this Azure Service Principal was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Azure Service Principal.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "lastUpdatedDate" : { + "type" : "string", + "format" : "date-time", + "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.", + "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.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "tenantId" : { + "type" : "string", + "description" : "UUID String that identifies the Azure Active Directory Tenant ID.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + } + }, + "required" : [ "providerName" ] + }, + "CloudProviderAccessAzureServicePrincipalRequestUpdate" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessRoleRequestUpdate" + }, { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "atlasAzureAppId" : { + "type" : "string", + "description" : "Azure Active Directory Application ID of Atlas.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this Azure Service Principal was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Azure Service Principal.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "lastUpdatedDate" : { + "type" : "string", + "format" : "date-time", + "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.", + "readOnly" : true + }, + "servicePrincipalId" : { + "type" : "string", + "description" : "UUID string that identifies the Azure Service Principal.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "tenantId" : { + "type" : "string", + "description" : "UUID String that identifies the Azure Active Directory Tenant ID.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + } + } + } ], + "description" : "Details that describe the features linked to the Azure Service Principal.", + "required" : [ "providerName" ] + }, "CloudProviderAccessDataLakeFeatureUsage" : { "type" : "object", "allOf" : [ { @@ -28770,6 +31001,92 @@ } } }, + "CloudProviderAccessGCPServiceAccount" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, { + "type" : "object", + "properties" : { + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this Google Service Account was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Google Service Account.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "gcpServiceAccountForAtlas" : { + "type" : "string", + "description" : "Email address for the Google Service Account created by Atlas.", + "maxLength" : 82, + "minLength" : 57, + "pattern" : "^mongodb-atlas-[0-9a-z]{16}@p-[0-9a-z]{24}.iam.gserviceaccount.com$" + }, + "roleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + } ], + "description" : "Details that describe the features linked to the GCP Service Account.", + "required" : [ "providerName" ] + }, + "CloudProviderAccessGCPServiceAccountRequest" : { + "type" : "object", + "description" : "Details that describe the features linked to the GCP Service Account.", + "properties" : { + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this GCP Service Account was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this GCP Service Account.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "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" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "readOnly" : true + } + }, + "required" : [ "providerName" ] + }, + "CloudProviderAccessGCPServiceAccountRequestUpdate" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessRoleRequestUpdate" + } ], + "description" : "Details that describe the features linked to the GCP Service Account.", + "required" : [ "providerName" ] + }, "CloudProviderAccessPushBasedLogExportFeatureUsage" : { "type" : "object", "allOf" : [ { @@ -28790,20 +31107,63 @@ "discriminator" : { "mapping" : { "AWS" : "#/components/schemas/CloudProviderAccessAWSIAMRole", - "AZURE" : "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + "AZURE" : "#/components/schemas/CloudProviderAccessAzureServicePrincipal", + "GCP" : "#/components/schemas/CloudProviderAccessGCPServiceAccount" + }, + "propertyName" : "providerName" + }, + "properties" : { + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider of the role.", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, + "required" : [ "providerName" ] + }, + "CloudProviderAccessRoleRequest" : { + "type" : "object", + "description" : "Cloud provider access role.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/CloudProviderAccessAWSIAMRoleRequest", + "AZURE" : "#/components/schemas/CloudProviderAccessAzureServicePrincipalRequest", + "GCP" : "#/components/schemas/CloudProviderAccessGCPServiceAccountRequest" }, "propertyName" : "providerName" }, "oneOf" : [ { - "$ref" : "#/components/schemas/CloudProviderAccessAWSIAMRole" + "$ref" : "#/components/schemas/CloudProviderAccessAWSIAMRoleRequest" }, { - "$ref" : "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + "$ref" : "#/components/schemas/CloudProviderAccessAzureServicePrincipalRequest" + }, { + "$ref" : "#/components/schemas/CloudProviderAccessGCPServiceAccountRequest" } ], "properties" : { "providerName" : { "type" : "string", "description" : "Human-readable label that identifies the cloud provider of the role.", - "enum" : [ "AWS", "AZURE" ] + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, + "required" : [ "providerName" ] + }, + "CloudProviderAccessRoleRequestUpdate" : { + "type" : "object", + "description" : "Cloud provider access role.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/CloudProviderAccessAWSIAMRoleRequestUpdate", + "AZURE" : "#/components/schemas/CloudProviderAccessAzureServicePrincipalRequestUpdate", + "GCP" : "#/components/schemas/CloudProviderAccessGCPServiceAccountRequestUpdate" + }, + "propertyName" : "providerName" + }, + "properties" : { + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider of the role.", + "enum" : [ "AWS", "AZURE", "GCP" ] } }, "required" : [ "providerName" ] @@ -28817,6 +31177,13 @@ "items" : { "$ref" : "#/components/schemas/CloudProviderAccessAWSIAMRole" } + }, + "azureServicePrincipals" : { + "type" : "array", + "description" : "List that contains the Azure Service Principals registered with MongoDB Cloud.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + } } } }, @@ -29199,7 +31566,7 @@ "example" : "cluster1", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -29292,6 +31659,7 @@ }, "diskGBEnabled" : { "type" : "boolean", + "default" : false, "description" : "Flag that indicates whether someone enabled disk auto-scaling for this cluster." } }, @@ -29321,10 +31689,12 @@ "properties" : { "enabled" : { "type" : "boolean", + "default" : false, "description" : "Flag that indicates whether cluster tier auto-scaling is enabled. Set to `true` to enable cluster tier auto-scaling. If enabled, you must specify a value for **providerSettings.autoScaling.compute.maxInstanceSize** also. Set to `false` to disable cluster tier auto-scaling." }, "scaleDownEnabled" : { "type" : "boolean", + "default" : false, "description" : "Flag that indicates whether the cluster tier can scale down. This is required if **autoScaling.compute.enabled** is `true`. If you enable this option, specify a value for **providerSettings.autoScaling.compute.minInstanceSize**." } } @@ -29359,14 +31729,14 @@ "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.", + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to Atlas through the interface endpoint that the key names. If the cluster uses an optimized connection string, `awsPrivateLinkSrv` contains the optimized connection string. If the cluster has the non-optimized (legacy) connection string, `awsPrivateLinkSrv` contains the non-optimized connection string even if an optimized connection string is also present.", "externalDocs" : { "description" : "Network Peering Connection", "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" }, "readOnly" : true }, - "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.", + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to Atlas through the interface endpoint that the key names. If the cluster uses an optimized connection string, `awsPrivateLinkSrv` contains the optimized connection string. If the cluster has the non-optimized (legacy) connection string, `awsPrivateLinkSrv` contains the non-optimized connection string even if an optimized connection string is also present.", "externalDocs" : { "description" : "Network Peering Connection", "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" @@ -29446,6 +31816,26 @@ "description" : "Configuration of nodes that comprise the cluster.", "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] }, + "configServerManagementMode" : { + "type" : "string", + "default" : "ATLAS_MANAGED", + "description" : "Config Server Management Mode for creating or updating a sharded cluster.\n\nWhen configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings.\n\nWhen configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server.", + "enum" : [ "ATLAS_MANAGED", "FIXED_TO_DEDICATED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + } + }, + "configServerType" : { + "type" : "string", + "description" : "Describes a sharded cluster's config server type.", + "enum" : [ "DEDICATED", "EMBEDDED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + }, + "readOnly" : true + }, "connectionStrings" : { "$ref" : "#/components/schemas/ClusterConnectionStrings" }, @@ -29474,6 +31864,17 @@ "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" } }, + "featureCompatibilityVersion" : { + "type" : "string", + "description" : "Feature compatibility version of the cluster.", + "readOnly" : true + }, + "featureCompatibilityVersionExpirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Feature compatibility version expiration date.", + "readOnly" : true + }, "globalClusterSelfManagedSharding" : { "type" : "boolean", "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen 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.\n\nWhen 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.\n\nThis setting cannot be changed once the cluster is deployed.", @@ -29520,6 +31921,9 @@ }, "readOnly" : true }, + "mongoDBEmployeeAccessGrant" : { + "$ref" : "#/components/schemas/EmployeeAccessGrantView" + }, "mongoDBMajorVersion" : { "type" : "string", "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", @@ -29539,7 +31943,7 @@ "description" : "Human-readable label that identifies the cluster.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, "paused" : { "type" : "boolean", @@ -29553,6 +31957,24 @@ "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" } }, + "redactClientLogData" : { + "type" : "boolean", + "description" : "Enable or disable log redaction.", + "externalDocs" : { + "description" : "This options corresponds to the ``security.redactClientLogData`` cluster parameter.\n\nThis setting configures the ``mongod`` or ``mongos`` to redact any message accompanying a given log event before logging. This prevents the program from writing potentially sensitive data stored on the database to the diagnostic log. Metadata such as error or operation codes, line numbers, and source file names are still visible in the logs.\n\nUse ``redactClientLogData`` in conjunction with Encryption at Rest and TLS/SSL (Transport Encryption) to assist compliance with regulatory requirements.", + "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.redactClientLogData" + } + }, + "replicaSetScalingStrategy" : { + "type" : "string", + "default" : "WORKLOAD_TYPE", + "description" : "Set this field to configure the replica set scaling mode for your cluster.\n\nBy default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes.\n\nWhen configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads.\n\nWhen configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads.", + "enum" : [ "SEQUENTIAL", "WORKLOAD_TYPE", "NODE_TYPE" ], + "externalDocs" : { + "description" : "Modify the Replica Set Scaling Mode", + "url" : "https://dochub.mongodb.org/core/scale-nodes" + } + }, "replicationSpecs" : { "type" : "array", "description" : "List of settings that configure your cluster regions. This array has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations.", @@ -29662,6 +32084,16 @@ "ClusterDescriptionProcessArgs" : { "type" : "object", "properties" : { + "changeStreamOptionsPreAndPostImagesExpireAfterSeconds" : { + "type" : "integer", + "format" : "int32", + "default" : -1, + "description" : "The minimum pre- and post-image retention time in seconds.", + "externalDocs" : { + "description" : "This option corresponds to the ``changeStreamOptions.preAndPostImages.expireAfterSeconds`` cluster parameter. This setting controls the retention policy of change stream pre- and post-images. Pre- and post-images are the versions of a document before and after document modification, respectively. ``expireAfterSeconds`` controls how long MongoDB retains pre- and post-images. When set to -1 (off), MongoDB uses the default retention policy: pre- and post-images are retained until the corresponding change stream events are removed from the oplog. To set the minimum pre- and post-image retention time, specify an integer value greater than zero. Setting this too low could increase the risk of interrupting Realm sync or triggers processing. The default value is -1 (off).", + "url" : "https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/changeStreamOptions/#mongodb-parameter-param.changeStreamOptions.preAndPostImages.expireAfterSeconds" + } + }, "chunkMigrationConcurrency" : { "type" : "integer", "format" : "int32", @@ -29671,6 +32103,15 @@ "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.chunkMigrationConcurrency" } }, + "defaultMaxTimeMS" : { + "type" : "integer", + "format" : "int32", + "description" : "Default time limit in milliseconds for individual read operations to complete.", + "externalDocs" : { + "description" : "This option corresponds to the defaultMaxTimeMS cluster parameter.", + "url" : "https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/defaultMaxTimeMS/" + } + }, "defaultReadConcern" : { "type" : "string", "default" : "available", @@ -29701,7 +32142,7 @@ }, "javascriptEnabled" : { "type" : "boolean", - "description" : "Flag that indicates whether the cluster allows execution of operations that perform server-side executions of JavaScript.", + "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" @@ -29789,6 +32230,16 @@ "ClusterDescriptionProcessArgs20240805" : { "type" : "object", "properties" : { + "changeStreamOptionsPreAndPostImagesExpireAfterSeconds" : { + "type" : "integer", + "format" : "int32", + "default" : -1, + "description" : "The minimum pre- and post-image retention time in seconds.", + "externalDocs" : { + "description" : "This option corresponds to the ``changeStreamOptions.preAndPostImages.expireAfterSeconds`` cluster parameter. This setting controls the retention policy of change stream pre- and post-images. Pre- and post-images are the versions of a document before and after document modification, respectively. ``expireAfterSeconds`` controls how long MongoDB retains pre- and post-images. When set to -1 (off), MongoDB uses the default retention policy: pre- and post-images are retained until the corresponding change stream events are removed from the oplog. To set the minimum pre- and post-image retention time, specify an integer value greater than zero. Setting this too low could increase the risk of interrupting Realm sync or triggers processing. The default value is -1 (off).", + "url" : "https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/changeStreamOptions/#mongodb-parameter-param.changeStreamOptions.preAndPostImages.expireAfterSeconds" + } + }, "chunkMigrationConcurrency" : { "type" : "integer", "format" : "int32", @@ -29798,6 +32249,15 @@ "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.chunkMigrationConcurrency" } }, + "defaultMaxTimeMS" : { + "type" : "integer", + "format" : "int32", + "description" : "Default time limit in milliseconds for individual read operations to complete.", + "externalDocs" : { + "description" : "This option corresponds to the defaultMaxTimeMS cluster parameter.", + "url" : "https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/defaultMaxTimeMS/" + } + }, "defaultWriteConcern" : { "type" : "string", "description" : "Default level of acknowledgment requested from MongoDB for write operations when none is specified by the driver.", @@ -29808,7 +32268,7 @@ }, "javascriptEnabled" : { "type" : "boolean", - "description" : "Flag that indicates whether the cluster allows execution of operations that perform server-side executions of JavaScript.", + "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" @@ -30075,7 +32535,7 @@ "description" : "Human-readable label that identifies the cluster that undergoes outage simulation.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "groupId" : { @@ -30669,7 +33129,8 @@ "discriminator" : { "mapping" : { "AWS" : "#/components/schemas/AWSCreateDataProcessRegionView", - "AZURE" : "#/components/schemas/AzureCreateDataProcessRegionView" + "AZURE" : "#/components/schemas/AzureCreateDataProcessRegionView", + "GCP" : "#/components/schemas/GCPCreateDataProcessRegionView" }, "propertyName" : "cloudProvider" }, @@ -31166,11 +33627,11 @@ }, "roleId" : { "type" : "string", - "description" : "Unique identifier of the role that Data Federation can use to access the data stores.Required if specifying cloudProviderConfig." + "description" : "Unique identifier of the role that Data Federation can use to access the data stores. Required if specifying cloudProviderConfig." }, "servicePrincipalId" : { "type" : "string", - "description" : "The ID of the Service Principal for which there is an access policyfor Atlas to access Azure resources.", + "description" : "The ID of the Service Principal for which there is an access policy for Atlas to access Azure resources.", "readOnly" : true }, "tenantId" : { @@ -31181,6 +33642,22 @@ }, "required" : [ "roleId" ] }, + "DataFederationGCPCloudProviderConfig" : { + "type" : "object", + "description" : "Configuration for running Data Federation in GCP.", + "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" : { + "type" : "string", + "description" : "Unique identifier of the role that Data Federation can use to access the data stores. Required if specifying cloudProviderConfig." + } + }, + "required" : [ "roleId" ] + }, "DataFederationLimit" : { "type" : "object", "description" : "Details of user managed limits.", @@ -31188,6 +33665,7 @@ "mapping" : { "atlas.project.deployment.clusters" : "#/components/schemas/DefaultLimit", "atlas.project.deployment.nodesPerPrivateLinkRegion" : "#/components/schemas/DefaultLimit", + "atlas.project.deployment.salesSoldM0s" : "#/components/schemas/DefaultLimit", "atlas.project.deployment.serverlessMTMs" : "#/components/schemas/DefaultLimit", "atlas.project.security.databaseAccess.customRoles" : "#/components/schemas/DefaultLimit", "atlas.project.security.databaseAccess.users" : "#/components/schemas/DefaultLimit", @@ -31528,9 +34006,12 @@ }, "azure" : { "$ref" : "#/components/schemas/DataFederationAzureCloudProviderConfig" + }, + "gcp" : { + "$ref" : "#/components/schemas/DataFederationGCPCloudProviderConfig" } }, - "title" : "Data Lake Cloud Provider" + "title" : "Data Federation Cloud Provider" }, "DataLakeDLSAWSStore" : { "type" : "object", @@ -31571,7 +34052,7 @@ "cloudProvider" : { "type" : "string", "description" : "Name of the cloud service that hosts the Federated Database Instance's infrastructure.", - "enum" : [ "AWS", "AZURE" ] + "enum" : [ "AWS", "AZURE", "GCP" ] }, "region" : { "$ref" : "#/components/schemas/BaseAtlasDataLakeRegion" @@ -31993,7 +34474,7 @@ "example" : "cluster1", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -32235,7 +34716,9 @@ "enum" : [ "AVERAGE" ] }, "operator" : { - "$ref" : "#/components/schemas/Operator" + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, "threshold" : { "type" : "number", @@ -32278,7 +34761,8 @@ "discriminator" : { "mapping" : { "AWS" : "#/components/schemas/AWSDataProcessRegionView", - "AZURE" : "#/components/schemas/AzureDataProcessRegionView" + "AZURE" : "#/components/schemas/AzureDataProcessRegionView", + "GCP" : "#/components/schemas/GCPDataProcessRegionView" }, "propertyName" : "cloudProvider" }, @@ -32286,7 +34770,7 @@ "cloudProvider" : { "type" : "string", "description" : "Human-readable label that identifies the Cloud service provider where you store your archived data.", - "enum" : [ "AWS", "AZURE" ], + "enum" : [ "AWS", "AZURE", "GCP" ], "readOnly" : true } }, @@ -32513,7 +34997,7 @@ "action" : { "type" : "string", "description" : "Human-readable label that identifies the privilege action.", - "enum" : [ "FIND", "INSERT", "REMOVE", "UPDATE", "BYPASS_DOCUMENT_VALIDATION", "USE_UUID", "KILL_OP", "CREATE_COLLECTION", "CREATE_INDEX", "DROP_COLLECTION", "ENABLE_PROFILER", "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", "STORAGE_GET_CONFIG", "STORAGE_SET_CONFIG", "FLUSH_ROUTER_CONFIG", "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" ] + "enum" : [ "FIND", "INSERT", "REMOVE", "UPDATE", "BYPASS_DOCUMENT_VALIDATION", "USE_UUID", "KILL_OP", "CREATE_COLLECTION", "CREATE_INDEX", "DROP_COLLECTION", "ENABLE_PROFILER", "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", "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", @@ -32792,7 +35276,7 @@ "title" : "Cps Backup Event Types" }, { "type" : "string", - "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEXES_RESTORE_FAILED" ], + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEXES_RESTORE_FAILED", "FTS_INDEXES_SYNONYM_MAPPING_INVALID" ], "title" : "FTS Index Audit Types" }, { "type" : "string", @@ -32935,7 +35419,7 @@ "title" : "Encryption Event Types" }, { "type" : "string", - "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEXES_RESTORE_FAILED" ], + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEXES_RESTORE_FAILED", "FTS_INDEXES_SYNONYM_MAPPING_INVALID" ], "title" : "FTS Index Audit Types" }, { "type" : "string", @@ -33200,7 +35684,7 @@ "title" : "Tenant Backup Event Types" }, { "type" : "string", - "enum" : [ "CLUSTER_VERSION_FIXED", "CLUSTER_VERSION_UNFIXED", "CLUSTER_FCV_FIXED", "CLUSTER_FCV_UNFIXED", "AGENT_VERSION_FIXED", "AGENT_VERSION_UNFIXED", "FIXED_VERSION_UPDATED", "FIXED_AGENT_VERSION_UPDATED", "CLUSTER_FCV_DOWNGRADED" ], + "enum" : [ "CLUSTER_VERSION_FIXED", "CLUSTER_VERSION_UNFIXED", "CLUSTER_FCV_FIXED", "CLUSTER_FCV_UNFIXED", "CLUSTER_FCV_EXPIRATION_DATE_UPDATED", "AGENT_VERSION_FIXED", "AGENT_VERSION_UNFIXED", "FIXED_VERSION_UPDATED", "FIXED_AGENT_VERSION_UPDATED", "CLUSTER_FCV_DOWNGRADED", "CLUSTER_BINARY_VERSION_DOWNGRADED", "CLUSTER_BINARY_VERSION_UPGRADED" ], "title" : "Version Audit Types" } ] }, @@ -33524,7 +36008,6 @@ }, "hostnameSchemaType" : { "type" : "string", - "default" : "PUBLIC", "description" : "The network type to use between the migration host and the destination cluster.", "enum" : [ "PUBLIC", "PRIVATE_LINK", "VPC_PEERING" ] }, @@ -33648,28 +36131,19 @@ "createdAt" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when someone created this export job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "description" : "Date and time when a user or Atlas created the Export Job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", "readOnly" : true }, "customData" : { "type" : "array", - "description" : "Collection of key-value pairs that represent custom data for the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes.", + "description" : "Collection of key-value pairs that represent custom data for the metadata file that MongoDB Cloud uploads when the Export Job finishes.", "items" : { "$ref" : "#/components/schemas/BackupLabel" } }, - "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\"`.", - "items" : { - "type" : "string", - "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download." - }, - "readOnly" : true - }, "exportBucketId" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket to export to.", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -33682,7 +36156,7 @@ "finishedAt" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when this export job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "description" : "Date and time when this Export Job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", "readOnly" : true }, "id" : { @@ -33708,7 +36182,7 @@ }, "prefix" : { "type" : "string", - "description" : "Full path on the cloud provider bucket to the folder where the snapshot is exported.", + "description" : "Prefix used for all blob storage objects uploaded as part of the Export Job.", "pattern" : "/exported_snapshots/\\{ORG-NAME\\}/\\{PROJECT-NAME\\}/\\{CLUSTER-NAME\\}/\\{SNAPSHOT-INITIATION-DATE\\}/\\{TIMESTAMP\\}", "readOnly" : true }, @@ -33722,7 +36196,7 @@ }, "state" : { "type" : "string", - "description" : "State of the export job.", + "description" : "State of the Export Job.", "enum" : [ "Cancelled", "Failed", "InProgress", "Queued", "Successful" ], "readOnly" : true } @@ -33741,7 +36215,7 @@ }, "exportBucketId" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket to export to.", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -33942,7 +36416,15 @@ "properties" : { "downloadUrl" : { "type" : "string", - "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", + "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.", + "items" : { + "$ref" : "#/components/schemas/ApiPrivateDownloadDeliveryUrl" + }, "readOnly" : true }, "replicaSetName" : { @@ -34370,7 +36852,7 @@ "description" : "One or more Uniform Resource Locators (URLs) that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", "items" : { "type" : "string", - "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download." + "description" : "One Uniform Resource Locator that points to the compressed snapshot files for manual download." }, "readOnly" : true }, @@ -34439,6 +36921,14 @@ "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`.", "minimum" : 1199145600 }, + "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.", + "items" : { + "$ref" : "#/components/schemas/ApiPrivateDownloadDeliveryUrl" + }, + "readOnly" : true + }, "snapshotId" : { "type" : "string", "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", @@ -34452,7 +36942,7 @@ "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.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, "targetGroupId" : { "type" : "string", @@ -34492,7 +36982,7 @@ "description" : "Human-readable label that identifies the cluster with the Snapshot you want to return.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "copySettings" : { @@ -34593,7 +37083,7 @@ "description" : "Human-readable label that identifies the cluster with the Snapshot you want to return.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "copySettings" : { @@ -34688,9 +37178,15 @@ "additionalProperties" : { "type" : "object", "description" : "The stats associated with the stream processor.", + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor" + }, "readOnly" : true }, "description" : "The stats associated with the stream processor.", + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor" + }, "readOnly" : true }, "EARPrivateEndpoint" : { @@ -34733,7 +37229,7 @@ "status" : { "type" : "string", "description" : "State of the Encryption At Rest private endpoint.", - "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "ACTIVE", "FAILED" ], + "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "ACTIVE", "FAILED", "PENDING_RECREATION", "DELETING" ], "readOnly" : true } }, @@ -34773,6 +37269,36 @@ "required" : [ "typeName" ], "title" : "Email Notification" }, + "EmployeeAccessGrantView" : { + "type" : "object", + "description" : "MongoDB employee granted access level and expiration for a cluster.", + "properties" : { + "expirationTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Expiration date for the employee access grant." + }, + "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.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "required" : [ "expirationTime", "grantType" ] + }, "EncryptionAtRest" : { "type" : "object", "properties" : { @@ -34787,27 +37313,6 @@ } } }, - "EncryptionAtRestPrivateEndpointRequest" : { - "type" : "object", - "description" : "Create or delete private endpoints from the specified regions list.", - "properties" : { - "cloudProvider" : { - "type" : "string", - "description" : "Cloud service provider name.", - "enum" : [ "AZURE" ] - }, - "regions" : { - "type" : "array", - "description" : "List of regions.", - "items" : { - "type" : "string" - }, - "uniqueItems" : true - } - }, - "required" : [ "cloudProvider" ], - "title" : "Encryption At Rest Private Endpoints setup." - }, "EncryptionKeyAlertConfigViewForNdsGroup" : { "type" : "object", "description" : "Encryption key alert configuration allows to select thresholds which trigger alerts and how users are notified.", @@ -35033,7 +37538,7 @@ "title" : "Export Bucket Audit Types" }, { "type" : "string", - "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEX_CREATED", "FTS_INDEX_UPDATED", "FTS_INDEX_DELETED", "FTS_INDEX_CLEANED_UP", "FTS_INDEXES_RESTORED", "FTS_INDEXES_RESTORE_FAILED" ], + "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" : "FTS Index Audit Types" }, { "type" : "string", @@ -35053,7 +37558,7 @@ "title" : "Group Integration 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_ENOUGH_DISK_SPACE", "HOST_NOT_ENOUGH_DISK_SPACE" ], + "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_ENOUGH_DISK_SPACE", "HOST_NOT_ENOUGH_DISK_SPACE" ], "title" : "Host Event Types" }, { "type" : "string", @@ -35065,7 +37570,7 @@ "title" : "Index Build 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_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_SSL_ROTATED", "CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER", "CLUSTER_INSTANCE_SSL_REVOKED", "RELOAD_SSL_ON_PROCESSES", "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", "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", "MOVE_SKIPPED", "PROXY_RESTARTED", "PROXY_PANICKED", "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", "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", "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", "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", "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", "PENDING_INDEXES_DELETED", "PENDING_INDEXES_CANCELED", "PROCESS_RESTART_REQUESTED", "AUTO_HEALING_ACTION", "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", "CLUSTER_FORCE_RECONFIG_REQUESTED", "PROJECT_BYPASSED_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", "ATLAS_SQL_SCHEDULED_UPDATE_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_MODIFIED", "ATLAS_SQL_SCHEDULED_UPDATE_REMOVED" ], + "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_SSL_ROTATED", "CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER", "CLUSTER_INSTANCE_SSL_REVOKED", "RELOAD_SSL_ON_PROCESSES", "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", "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", "MOVE_SKIPPED", "PROXY_RESTARTED", "PROXY_PANICKED", "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", "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", "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", "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", "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", "CLUSTER_FORCE_RECONFIG_REQUESTED", "PROJECT_BYPASSED_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" ], "title" : "NDS Audit Types" }, { "type" : "string", @@ -35165,7 +37670,7 @@ "title" : "User Event Types" }, { "type" : "string", - "enum" : [ "CLUSTER_VERSION_FIXED", "CLUSTER_VERSION_UNFIXED", "CLUSTER_FCV_FIXED", "CLUSTER_FCV_UNFIXED", "AGENT_VERSION_FIXED", "AGENT_VERSION_UNFIXED", "FIXED_VERSION_UPDATED", "FIXED_AGENT_VERSION_UPDATED", "CLUSTER_FCV_DOWNGRADED" ], + "enum" : [ "CLUSTER_VERSION_FIXED", "CLUSTER_VERSION_UNFIXED", "CLUSTER_FCV_FIXED", "CLUSTER_FCV_UNFIXED", "CLUSTER_FCV_EXPIRATION_DATE_UPDATED", "AGENT_VERSION_FIXED", "AGENT_VERSION_UNFIXED", "FIXED_VERSION_UPDATED", "FIXED_AGENT_VERSION_UPDATED", "CLUSTER_FCV_DOWNGRADED", "CLUSTER_BINARY_VERSION_DOWNGRADED", "CLUSTER_BINARY_VERSION_UPGRADED" ], "title" : "Version Audit Types" }, { "type" : "string", @@ -35235,6 +37740,10 @@ "type" : "string", "enum" : [ "GROUP_TAGS_MODIFIED" ], "title" : "Resource Event Types" + }, { + "type" : "string", + "enum" : [ "RESOURCE_POLICY_CREATED", "RESOURCE_POLICY_MODIFIED", "RESOURCE_POLICY_DELETED" ], + "title" : "Atlas Resource Policy Audit Types" } ] }, "EventViewForNdsGroup" : { @@ -35313,6 +37822,8 @@ "$ref" : "#/components/schemas/UserEventViewForOrg" }, { "$ref" : "#/components/schemas/ResourceEventViewForOrg" + }, { + "$ref" : "#/components/schemas/AtlasResourcePolicyAuditForOrg" } ] }, "ExampleResourceResponse20230101" : { @@ -35373,7 +37884,7 @@ }, "ExportStatus" : { "type" : "object", - "description" : "State of the export job for the collections on the replica set only.", + "description" : "State of the Export Job.", "properties" : { "exportedCollections" : { "type" : "integer", @@ -35408,7 +37919,7 @@ "FTSIndexAuditTypeView" : { "type" : "string", "description" : "Unique identifier of event type.", - "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEX_CREATED", "FTS_INDEX_UPDATED", "FTS_INDEX_DELETED", "FTS_INDEX_CLEANED_UP", "FTS_INDEXES_RESTORED", "FTS_INDEXES_RESTORE_FAILED" ], + "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" ], "example" : "FTS_INDEX_CREATED", "title" : "FTS Index Audit Types" }, @@ -36314,37 +38825,53 @@ }, "title" : "Field Transformation" }, - "ForNdsGroup" : { + "FieldViolation" : { "type" : "object", - "description" : "ReplicaSet Event identifies different activities about replica set of mongod instances.", "properties" : { - "created" : { + "description" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "description" : "A description of why the request element is bad." }, - "eventTypeName" : { - "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroup" + "field" : { + "type" : "string", + "description" : "A path that leads to a field in the request body." + } + }, + "required" : [ "description", "field" ] + }, + "FlexBackupRestoreJob20250101" : { + "type" : "object", + "description" : "Details for one restore job of a flex cluster.", + "properties" : { + "deliveryType" : { + "type" : "string", + "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", + "enum" : [ "RESTORE", "DOWNLOAD" ], + "readOnly" : true }, - "groupId" : { + "expirationDate" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, + "instanceName" : { + "type" : "string", + "description" : "Human-readable label that identifies the source instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "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.", @@ -36357,485 +38884,317 @@ }, "readOnly" : true }, - "orgId" : { + "projectId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "port" : { - "type" : "integer", - "format" : "int32", - "description" : "IANA port on which the MongoDB process listens for requests.", - "example" : 27017, + "restoreFinishedDate" : { + "type" : "string", + "format" : "date-time", + "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.", "readOnly" : true }, - "raw" : { - "$ref" : "#/components/schemas/raw" - }, - "replicaSetName" : { + "restoreScheduledDate" : { "type" : "string", - "description" : "Human-readable label of the replica set associated with the event.", - "example" : "event-replica-set", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "shardName" : { + "snapshotFinishedDate" : { "type" : "string", - "description" : "Human-readable label of the shard associated with the event.", - "example" : "event-sh-01", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true - } - }, - "required" : [ "created", "eventTypeName", "id" ], - "title" : "ReplicaSet Events" - }, - "GCPCloudProviderContainer" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/CloudProviderContainer" - }, { - "type" : "object", - "properties" : { - "atlasCidrBlock" : { - "type" : "string", - "description" : "IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.\n\nThese CIDR blocks must fall within the ranges reserved per RFC 1918. GCP further limits the block to a lower bound of the `/18` range.\n\nTo modify the CIDR block, the target project cannot have:\n\n- Any M10 or greater clusters\n- Any other VPC peering connections\n\n 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.\n\n **Example:** A project in an Google Cloud (GCP) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets.", - "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" - }, - "gcpProjectId" : { - "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.", - "maxLength" : 26, - "minLength" : 26, - "pattern" : "^p-[0-9a-z]{24}$", - "readOnly" : true - }, - "networkName" : { - "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.", - "maxLength" : 36, - "minLength" : 36, - "pattern" : "^nt-[0-9a-f]{24}-[0-9a-z]{8}$", - "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.", - "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.", - "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" ] - } - } - } - } ], - "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", - "required" : [ "atlasCidrBlock" ], - "title" : "GCP" - }, - "GCPComputeAutoScaling" : { - "type" : "object", - "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", - "properties" : { - "maxInstanceSize" : { + }, + "snapshotId" : { "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" ], - "title" : "GCP Instance Sizes" + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "minInstanceSize" : { + "snapshotUrl" : { "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" ], - "title" : "GCP Instance Sizes" - } - }, - "title" : "GCP" - }, - "GCPConsumerForwardingRule" : { - "type" : "object", - "properties" : { - "endpointName" : { + "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" : "Human-readable label that identifies the Google Cloud consumer forwarding rule that you created.", - "externalDocs" : { - "description" : "Google Cloud Forwarding Rule Concepts", - "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" - }, + "description" : "Phase of the restore workflow for this job at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], "readOnly" : true }, - "ipAddress" : { + "targetDeploymentItemName" : { "type" : "string", - "description" : "One Private Internet Protocol version 4 (IPv4) address to which this Google Cloud consumer forwarding rule resolves.", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "description" : "Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another USS instance or Dedicated cluster tier.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", "readOnly" : true }, - "status" : { + "targetProjectId" : { "type" : "string", - "description" : "State of the MongoDB Cloud endpoint group when MongoDB Cloud received this request.", - "enum" : [ "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true } - } + }, + "title" : "Flex Backup Restore Job" }, - "GCPEndpointService" : { + "FlexBackupRestoreJobCreate20250101" : { "type" : "object", - "description" : "Group of Private Endpoint Service settings.", + "description" : "Details to create one restore job of a flex cluster.", "properties" : { - "cloudProvider" : { + "_snapshotId" : { "type" : "string", - "description" : "Cloud service provider that serves the requested endpoint service.", - "enum" : [ "AWS", "AZURE", "GCP" ], - "readOnly" : true + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true }, - "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" - }, - "items" : { - "type" : "string", - "description" : "One Google Cloud network endpoint group that corresponds to the Private Service Connect endpoint service." - } + "_targetDeploymentItemName" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another flex cluster or dedicated cluster tier.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", + "writeOnly" : true }, - "errorMessage" : { + "_targetProjectId" : { "type" : "string", - "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "deliveryType" : { + "type" : "string", + "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", + "enum" : [ "RESTORE", "DOWNLOAD" ], + "readOnly" : true + }, + "expirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "regionName" : { + "instanceName" : { "type" : "string", - "description" : "Cloud provider region that manages this Private Endpoint Service.", + "description" : "Human-readable label that identifies the source instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, - "serviceAttachmentNames" : { + "links" : { "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.", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", "externalDocs" : { - "description" : "Google Cloud Private Service Connect Service Attachments", - "url" : "https://cloud.google.com/vpc/docs/private-service-connect#service-attachments" + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" }, "items" : { - "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.", - "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\\-]+" - } + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true }, - "status" : { + "projectId" : { "type" : "string", - "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", - "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true - } - }, - "required" : [ "cloudProvider" ], - "title" : "GCP" - }, - "GCPHardwareSpec" : { - "type" : "object", - "properties" : { - "instanceSize" : { + }, + "restoreFinishedDate" : { "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" ], - "title" : "GCP Instance Sizes" + "format" : "date-time", + "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.", + "readOnly" : true }, - "nodeCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + "restoreScheduledDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "snapshotFinishedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "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.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true } - } + }, + "required" : [ "_snapshotId", "_targetDeploymentItemName" ], + "title" : "Create Flex Backup Restore Job" }, - "GCPHardwareSpec20240805" : { + "FlexBackupSettings20250101" : { "type" : "object", + "description" : "Flex backup configuration", "properties" : { - "diskSizeGB" : { - "type" : "number", - "format" : "double", - "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", - "maximum" : 4096, - "minimum" : 10 - }, - "instanceSize" : { - "type" : "string", - "description" : "Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as \"base nodes\") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.", - "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], - "title" : "GCP Instance Sizes" - }, - "nodeCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + "enabled" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether backups are performed for this flex cluster. Backup uses [TODO](TODO) for flex clusters.", + "readOnly" : true } - } + }, + "readOnly" : true, + "title" : "Flex Backup Configuration" }, - "GCPNetworkPeeringConnectionSettings" : { + "FlexBackupSnapshot20250101" : { "type" : "object", - "description" : "Group of Network Peering connection settings.", + "description" : "Details for one snapshot of a flex cluster.", "properties" : { - "containerId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" - }, - "errorMessage" : { + "expiration" : { "type" : "string", - "description" : "Details of the error returned when requesting a GCP network peering resource. The resource returns `null` if the request succeeded.", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "gcpProjectId" : { + "finishTime" : { "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.", - "maxLength" : 30, - "minLength" : 6, - "pattern" : "^[a-z][0-9a-z-]{4,28}[0-9a-z]{1}" + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "networkName" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBVersion" : { "type" : "string", - "description" : "Human-readable label that identifies the network to peer with the MongoDB Cloud VPC.", - "maxLength" : 63, - "minLength" : 1, - "pattern" : "[a-z]([-a-z0-9]{0,62}[a-z0-9]{0,1})?" + "description" : "MongoDB host version that the snapshot runs.", + "readOnly" : true }, - "providerName" : { + "scheduledTime" : { "type" : "string", - "description" : "Cloud service provider that serves the requested network peering connection.", - "enum" : [ "AWS", "AZURE", "GCP" ] + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will take the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "startTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began taking the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true }, "status" : { "type" : "string", - "description" : "State of the network peering connection at the time you made the request.", - "enum" : [ "ADDING_PEER", "WAITING_FOR_USER", "AVAILABLE", "FAILED", "DELETING" ], + "description" : "Phase of the workflow for this snapshot at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], "readOnly" : true } }, - "required" : [ "containerId", "gcpProjectId", "networkName" ], - "title" : "GCP" + "title" : "Flex Backup Snapshot" }, - "GCPRegionConfig" : { + "FlexBackupSnapshotDownloadCreate20250101" : { "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/CloudRegionConfig" - }, { - "type" : "object", - "properties" : { - "analyticsAutoScaling" : { - "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" - }, - "analyticsSpecs" : { - "$ref" : "#/components/schemas/DedicatedHardwareSpec" + "description" : "Details for one backup snapshot download of a flex cluster.", + "properties" : { + "_snapshotId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to download.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" }, - "autoScaling" : { - "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + "items" : { + "$ref" : "#/components/schemas/Link" }, - "readOnlySpecs" : { - "$ref" : "#/components/schemas/DedicatedHardwareSpec" - } + "readOnly" : true } - } ], - "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", - "title" : "GCP Regional Replication Specifications" - }, - "GCPRegionConfig20240805" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/CloudRegionConfig20240805" - }, { - "type" : "object", - "properties" : { - "analyticsAutoScaling" : { - "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" - }, - "analyticsSpecs" : { - "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" - }, - "autoScaling" : { - "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" - }, - "readOnlySpecs" : { - "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" - } - } - } ], - "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", - "title" : "GCP Regional Replication Specifications" - }, - "GeoSharding" : { - "type" : "object", - "properties" : { - "customZoneMapping" : { - "type" : "object", - "additionalProperties" : { - "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `id` property.\n\nThis parameter returns an empty object if no custom zones exist.", - "readOnly" : true - }, - "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `id` property.\n\nThis 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.", - "items" : { - "$ref" : "#/components/schemas/ManagedNamespaces" - }, - "readOnly" : true - }, - "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 - } - } - }, - "GeoSharding20240805" : { - "type" : "object", - "properties" : { - "customZoneMapping" : { - "type" : "object", - "additionalProperties" : { - "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.\n\nThis parameter returns an empty object if no custom zones exist.", - "readOnly" : true - }, - "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.\n\nThis 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.", - "items" : { - "$ref" : "#/components/schemas/ManagedNamespaces" - }, - "readOnly" : true - }, - "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 - } - } - }, - "GoogleCloudKMS" : { - "type" : "object", - "description" : "Details that define the configuration of Encryption at Rest using Google Cloud Key Management Service (KMS).", - "externalDocs" : { - "description" : "Google Cloud Key Management Service", - "url" : "https://www.mongodb.com/docs/atlas/security-gcp-kms/" }, - "properties" : { - "enabled" : { - "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" - }, - "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.", - "externalDocs" : { - "description" : "Google Cloud Authentication", - "url" : "https://cloud.google.com/docs/authentication/getting-started" - }, - "writeOnly" : true - }, - "valid" : { - "type" : "boolean", - "description" : "Flag that indicates whether the Google Cloud Key Management Service (KMS) encryption key can encrypt and decrypt data.", - "readOnly" : true - } - } + "required" : [ "_snapshotId" ], + "title" : "Flex Backup Snapshot Download Create" }, - "GreaterThanDaysThresholdView" : { + "FlexClusterDescription20250101" : { "type" : "object", - "description" : "Threshold value that triggers an alert.", + "description" : "Group of settings that configure a MongoDB Flex cluster.", "properties" : { - "operator" : { - "type" : "string", - "description" : "Comparison operator to apply when checking the current metric value.", - "enum" : [ "GREATER_THAN" ] - }, - "threshold" : { - "type" : "integer", - "format" : "int32", - "description" : "Value of metric that, when exceeded, triggers an alert." + "backupSettings" : { + "$ref" : "#/components/schemas/FlexBackupSettings20250101" }, - "units" : { - "type" : "string", - "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", - "enum" : [ "DAYS" ] - } - } - }, - "GreaterThanRawThreshold" : { - "type" : "object", - "description" : "A Limit that triggers an alert when greater than a number.", - "properties" : { - "operator" : { + "clusterType" : { "type" : "string", - "description" : "Comparison operator to apply when checking the current metric value.", - "enum" : [ "GREATER_THAN" ] + "description" : "Flex cluster topology.", + "enum" : [ "REPLICASET", "LOADBALANCED" ], + "readOnly" : true }, - "threshold" : { - "type" : "integer", - "format" : "int32", - "description" : "Value of metric that, when exceeded, triggers an alert." + "connectionStrings" : { + "$ref" : "#/components/schemas/FlexConnectionStrings20250101" }, - "units" : { - "$ref" : "#/components/schemas/RawMetricUnits" - } - }, - "title" : "Greater Than Raw Threshold" - }, - "GreaterThanRawThresholdAlertConfigViewForNdsGroup" : { - "type" : "object", - "properties" : { - "created" : { + "createDate" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Date and time when MongoDB Cloud created this instance. This parameter expresses its value in ISO 8601 format in UTC.", "readOnly" : true }, - "enabled" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." - }, - "eventTypeName" : { - "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" - }, "groupId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "description" : "Unique 24-hexadecimal character string that identifies the project.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -36844,7 +39203,7 @@ }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "description" : "Unique 24-hexadecimal digit string that identifies the instance.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -36863,76 +39222,60 @@ }, "readOnly" : true }, - "matchers" : { - "type" : "array", - "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", - "items" : { - "$ref" : "#/components/schemas/ReplicaSetMatcher" - } + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the instance runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true }, - "notifications" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "readOnly" : true + }, + "providerSettings" : { + "$ref" : "#/components/schemas/FlexProviderSettings20250101" + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of this instance.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { "type" : "array", - "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, "items" : { - "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + "$ref" : "#/components/schemas/ResourceTag" } }, - "threshold" : { - "$ref" : "#/components/schemas/GreaterThanRawThreshold" + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." }, - "updated" : { + "versionReleaseSystem" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions.", + "enum" : [ "LTS" ], "readOnly" : true } }, - "required" : [ "eventTypeName", "notifications" ] - }, - "GreaterThanTimeThreshold" : { - "type" : "object", - "description" : "A Limit that triggers an alert when greater than a time period.", - "properties" : { - "operator" : { - "type" : "string", - "description" : "Comparison operator to apply when checking the current metric value.", - "enum" : [ "GREATER_THAN" ] - }, - "threshold" : { - "type" : "integer", - "format" : "int32", - "description" : "Value of metric that, when exceeded, triggers an alert." - }, - "units" : { - "$ref" : "#/components/schemas/TimeMetricUnits" - } - }, - "title" : "Greater Than Time Threshold" + "required" : [ "providerSettings" ], + "title" : "Flex Cluster Description" }, - "Group" : { + "FlexClusterDescriptionCreate20250101" : { "type" : "object", + "description" : "Settings that you can specify when you create a flex cluster.", "properties" : { - "clusterCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Quantity of MongoDB Cloud clusters deployed in this project.", - "readOnly" : true - }, - "created" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created this project. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true - }, - "id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, "links" : { "type" : "array", "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", @@ -36947,145 +39290,161 @@ }, "name" : { "type" : "string", - "description" : "Human-readable label that identifies the project included in the MongoDB Cloud organization.", + "description" : "Human-readable label that identifies the instance.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" - }, - "orgId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud organization to which the project belongs.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "writeOnly" : true }, - "regionUsageRestrictions" : { - "type" : "string", - "default" : "COMMERCIAL_FEDRAMP_REGIONS_ONLY", - "description" : "Applies to Atlas for Government only.\n\nIn Commercial Atlas, this field will be rejected in requests and missing in responses.\n\nThis field sets restrictions on available regions in the project.\n\n| Value | Available Regions |\n|-----------------------------------|------------|\n| `COMMERCIAL_FEDRAMP_REGIONS_ONLY` | Only allows deployments in FedRAMP Moderate regions.|\n| `GOV_REGIONS_ONLY` | Only allows deployments in GovCloud regions.|", - "enum" : [ "COMMERCIAL_FEDRAMP_REGIONS_ONLY", "GOV_REGIONS_ONLY" ], - "externalDocs" : { - "url" : "https://www.mongodb.com/docs/atlas/government/overview/supported-regions/#supported-cloud-providers-and-regions" - } + "providerSettings" : { + "$ref" : "#/components/schemas/FlexProviderSettingsCreate20250101" }, "tags" : { "type" : "array", - "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the project.", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.", "externalDocs" : { "description" : "Resource Tags", - "url" : "https://www.mongodb.com/docs/atlas/tags" + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" }, "items" : { "$ref" : "#/components/schemas/ResourceTag" } }, - "withDefaultAlertsSettings" : { + "terminationProtectionEnabled" : { "type" : "boolean", - "description" : "Flag that indicates whether to create the project with default alert settings.", - "writeOnly" : true + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." } }, - "required" : [ "clusterCount", "created", "name", "orgId" ] + "required" : [ "name", "providerSettings" ], + "title" : "Flex Cluster Description Create" }, - "GroupAlertsConfig" : { + "FlexConnectionStrings20250101" : { "type" : "object", - "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/StreamProcessorAlertConfigViewForNdsGroup" - } ] + "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "properties" : { + "standard" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this cluster. This connection string uses the mongodb:// protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "standardSrv" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this flex cluster. This connection string uses the `mongodb+srv://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Flex Cluster Connection Strings" }, - "GroupIPAddresses" : { + "FlexProviderSettings20250101" : { "type" : "object", - "description" : "List of IP addresses in a project.", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB flex cluster.", "properties" : { - "groupId" : { + "backingProviderName" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the flex cluster.", + "enum" : [ "AWS", "AZURE", "GCP" ], "readOnly" : true }, - "services" : { - "$ref" : "#/components/schemas/GroupService" + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity available to the flex cluster expressed in gigabytes.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "default" : "FLEX", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "FLEX" ], + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB flex cluster. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).", + "readOnly" : true } }, - "title" : "Group IP Address" + "readOnly" : true, + "title" : "Cloud Service Provider Settings for a Flex Cluster" }, - "GroupInvitation" : { + "FlexProviderSettingsCreate20250101" : { "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB flex cluster.", "properties" : { - "createdAt" : { + "backingProviderName" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud sent the invitation. This parameter expresses its value in ISO 8601 format in UTC.", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the flex cluster.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "writeOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity available to the flex cluster expressed in gigabytes.", "readOnly" : true }, - "expiresAt" : { + "providerName" : { + "type" : "string", + "default" : "FLEX", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "FLEX" ], + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB flex cluster. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).", + "writeOnly" : true + } + }, + "required" : [ "backingProviderName", "regionName" ], + "title" : "Cloud Service Provider Settings for a Flex Cluster", + "writeOnly" : true + }, + "ForNdsGroup" : { + "type" : "object", + "description" : "ReplicaSet Event identifies different activities about replica set of mongod instances.", + "properties" : { + "created" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when MongoDB Cloud expires the invitation. This parameter expresses its value in ISO 8601 format in UTC.", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroup" + }, "groupId" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the project.", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "groupName" : { - "type" : "string", - "description" : "Human-readable label that identifies the project to which you invited the MongoDB Cloud user.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", - "readOnly" : true - }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the invitation.", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "inviterUsername" : { - "type" : "string", - "format" : "email", - "description" : "Email address of the MongoDB Cloud user who sent the invitation.", - "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.", @@ -37098,56 +39457,828 @@ }, "readOnly" : true }, - "roles" : { - "type" : "array", - "description" : "One or more organization or project level roles to assign to the MongoDB Cloud user.", - "items" : { - "type" : "string", - "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] - }, - "uniqueItems" : true + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "username" : { + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "replicaSetName" : { "type" : "string", - "format" : "email", - "description" : "Email address of the MongoDB Cloud user invited to join the project.", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", "readOnly" : true - } - } - }, - "GroupInvitationRequest" : { - "type" : "object", - "properties" : { - "roles" : { - "type" : "array", - "description" : "One or more project level roles to assign to the MongoDB Cloud user.", - "items" : { - "type" : "string", - "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] - }, - "uniqueItems" : true }, - "username" : { + "shardName" : { "type" : "string", - "format" : "email", - "description" : "Email address of the MongoDB Cloud user invited to the specified project." + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true } - } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "ReplicaSet Events" }, - "GroupInvitationUpdateRequest" : { + "GCPCloudProviderContainer" : { "type" : "object", - "properties" : { - "roles" : { - "type" : "array", - "description" : "One or more organization or project level roles to assign to the MongoDB Cloud user.", - "items" : { + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, { + "type" : "object", + "properties" : { + "atlasCidrBlock" : { "type" : "string", - "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + "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.\n\nThese CIDR blocks must fall within the ranges reserved per RFC 1918. GCP further limits the block to a lower bound of the `/18` range.\n\nTo modify the CIDR block, the target project cannot have:\n\n- Any M10 or greater clusters\n- Any other VPC peering connections\n\n 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.\n\n **Example:** A project in an Google Cloud (GCP) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets.", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" }, - "uniqueItems" : true - } - } - }, + "gcpProjectId" : { + "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.", + "maxLength" : 26, + "minLength" : 26, + "pattern" : "^p-[0-9a-z]{24}$", + "readOnly" : true + }, + "networkName" : { + "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.", + "maxLength" : 36, + "minLength" : 36, + "pattern" : "^nt-[0-9a-f]{24}-[0-9a-z]{8}$", + "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.", + "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.", + "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" ] + } + } + } + } ], + "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", + "required" : [ "atlasCidrBlock" ], + "title" : "GCP" + }, + "GCPComputeAutoScaling" : { + "type" : "object", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", + "properties" : { + "maxInstanceSize" : { + "type" : "string", + "description" : "Maximum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "minInstanceSize" : { + "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" ], + "title" : "GCP Instance Sizes" + } + }, + "title" : "GCP" + }, + "GCPConsumerForwardingRule" : { + "type" : "object", + "properties" : { + "endpointName" : { + "type" : "string", + "description" : "Human-readable label that identifies the Google Cloud consumer forwarding rule that you created.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "One Private Internet Protocol version 4 (IPv4) address to which this Google Cloud consumer forwarding rule resolves.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the MongoDB Cloud endpoint group when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + } + }, + "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" ] + } + } + } ] + }, + "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.", + "enum" : [ "CENTRAL_US", "WESTERN_EUROPE" ], + "readOnly" : true + } + } + } ] + }, + "GCPEndpointService" : { + "type" : "object", + "description" : "Group of Private Endpoint Service settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "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" + }, + "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" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "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" + }, + "items" : { + "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.", + "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\\-]+" + } + }, + "status" : { + "type" : "string", + "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "GCP" + }, + "GCPHardwareSpec" : { + "type" : "object", + "properties" : { + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts 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" ], + "title" : "GCP Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "GCPHardwareSpec20240805" : { + "type" : "object", + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as \"base nodes\") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "GCPNetworkPeeringConnectionSettings" : { + "type" : "object", + "description" : "Group of Network Peering connection settings.", + "properties" : { + "containerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "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" : { + "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.", + "maxLength" : 30, + "minLength" : 6, + "pattern" : "^[a-z][0-9a-z-]{4,28}[0-9a-z]{1}" + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "networkName" : { + "type" : "string", + "description" : "Human-readable label that identifies the network to peer with the MongoDB Cloud VPC.", + "maxLength" : 63, + "minLength" : 1, + "pattern" : "[a-z]([-a-z0-9]{0,62}[a-z0-9]{0,1})?" + }, + "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.", + "enum" : [ "ADDING_PEER", "WAITING_FOR_USER", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "containerId", "gcpProjectId", "networkName" ], + "title" : "GCP" + }, + "GCPRegionConfig" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "GCP Regional Replication Specifications" + }, + "GCPRegionConfig20240805" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20240805" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "GCP Regional Replication Specifications" + }, + "GeoSharding" : { + "type" : "object", + "properties" : { + "customZoneMapping" : { + "type" : "object", + "additionalProperties" : { + "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `id` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `id` property.\n\nThis 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.", + "items" : { + "$ref" : "#/components/schemas/ManagedNamespaces" + }, + "readOnly" : true + }, + "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 + } + } + }, + "GeoSharding20240805" : { + "type" : "object", + "properties" : { + "customZoneMapping" : { + "type" : "object", + "additionalProperties" : { + "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.\n\nThis 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.", + "items" : { + "$ref" : "#/components/schemas/ManagedNamespaces" + }, + "readOnly" : true + }, + "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 + } + } + }, + "GoogleCloudKMS" : { + "type" : "object", + "description" : "Details that define the configuration of Encryption at Rest using Google Cloud Key Management Service (KMS).", + "externalDocs" : { + "description" : "Google Cloud Key Management Service", + "url" : "https://www.mongodb.com/docs/atlas/security-gcp-kms/" + }, + "properties" : { + "enabled" : { + "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" + }, + "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.", + "externalDocs" : { + "description" : "Google Cloud Authentication", + "url" : "https://cloud.google.com/docs/authentication/getting-started" + }, + "writeOnly" : true + }, + "valid" : { + "type" : "boolean", + "description" : "Flag that indicates whether the Google Cloud Key Management Service (KMS) encryption key can encrypt and decrypt data.", + "readOnly" : true + } + } + }, + "GreaterThanDaysThresholdView" : { + "type" : "object", + "description" : "Threshold value that triggers an alert.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "GREATER_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "DAYS" ] + } + } + }, + "GreaterThanRawThreshold" : { + "type" : "object", + "description" : "A Limit that triggers an alert when greater than a number.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "GREATER_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/RawMetricUnits" + } + }, + "title" : "Greater Than Raw Threshold" + }, + "GreaterThanRawThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ReplicaSetMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/GreaterThanRawThreshold" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ] + }, + "GreaterThanTimeThreshold" : { + "type" : "object", + "description" : "A Limit that triggers an alert when greater than a time period.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "GREATER_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "title" : "Greater Than Time Threshold" + }, + "Group" : { + "type" : "object", + "properties" : { + "clusterCount" : { + "type" : "integer", + "format" : "int64", + "description" : "Quantity of MongoDB Cloud clusters deployed in this project.", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this project. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the project included in the MongoDB Cloud organization.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud organization to which the project belongs.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "regionUsageRestrictions" : { + "type" : "string", + "default" : "COMMERCIAL_FEDRAMP_REGIONS_ONLY", + "description" : "Applies to Atlas for Government only.\n\nIn Commercial Atlas, this field will be rejected in requests and missing in responses.\n\nThis field sets restrictions on available regions in the project.\n\n| Value | Available Regions |\n|-----------------------------------|------------|\n| `COMMERCIAL_FEDRAMP_REGIONS_ONLY` | Only allows deployments in FedRAMP Moderate regions.|\n| `GOV_REGIONS_ONLY` | Only allows deployments in GovCloud regions.|", + "enum" : [ "COMMERCIAL_FEDRAMP_REGIONS_ONLY", "GOV_REGIONS_ONLY" ], + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/government/overview/supported-regions/#supported-cloud-providers-and-regions" + } + }, + "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" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "withDefaultAlertsSettings" : { + "type" : "boolean", + "description" : "Flag that indicates whether to create the project with default alert settings.", + "writeOnly" : true + } + }, + "required" : [ "clusterCount", "created", "name", "orgId" ] + }, + "GroupAlertsConfig" : { + "type" : "object", + "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/StreamProcessorAlertConfigViewForNdsGroup" + } ] + }, + "GroupIPAddresses" : { + "type" : "object", + "description" : "List of IP addresses in a project.", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "services" : { + "$ref" : "#/components/schemas/GroupService" + } + }, + "title" : "Group IP Address" + }, + "GroupInvitation" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud sent the invitation. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud expires the invitation. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "groupName" : { + "type" : "string", + "description" : "Human-readable label that identifies the project to which you invited the MongoDB Cloud user.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the invitation.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "inviterUsername" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user who sent the invitation.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "roles" : { + "type" : "array", + "description" : "One or more organization or project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user invited to join the project.", + "readOnly" : true + } + } + }, + "GroupInvitationRequest" : { + "type" : "object", + "properties" : { + "roles" : { + "type" : "array", + "description" : "One or more project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address of the MongoDB Cloud user invited to the specified project." + } + } + }, + "GroupInvitationUpdateRequest" : { + "type" : "object", + "properties" : { + "roles" : { + "type" : "array", + "description" : "One or more organization or project level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + } + } + }, "GroupMaintenanceWindow" : { "type" : "object", "properties" : { @@ -37191,22 +40322,27 @@ "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "pattern" : "^([a-f0-9]{24})$" }, "destinationOrgPrivateApiKey" : { "type" : "string", - "description" : "Unique string that identifies the private part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.", + "description" : "Unique string that identifies the private part of the API Key used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.", "example" : "55c3bbb6-b4bb-0be1-e66d20841f3e", - "readOnly" : true + "externalDocs" : { + "description" : "Grant Programmatic Access to Atlas", + "url" : "https://dochub.mongodb.org/core/atlas-create-prog-api-key" + } }, "destinationOrgPublicApiKey" : { "type" : "string", - "description" : "Unique string that identifies the public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.", + "description" : "Unique string that identifies the public part of the API Key used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.", "example" : "zmmrboas", + "externalDocs" : { + "description" : "Grant Programmatic Access to Atlas", + "url" : "https://dochub.mongodb.org/core/atlas-create-prog-api-key" + }, "maxLength" : 8, - "minLength" : 8, - "readOnly" : true + "minLength" : 8 } } }, @@ -37273,7 +40409,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/EventViewForNdsGroup" }, @@ -37306,6 +40442,28 @@ } } }, + "GroupRoleAssignment" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to which these roles belong.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "groupRoles" : { + "type" : "array", + "description" : "One or more project level roles assigned to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_OWNER", "GROUP_CLUSTER_MANAGER", "GROUP_STREAM_PROCESSING_OWNER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR" ] + }, + "uniqueItems" : true + } + } + }, "GroupService" : { "type" : "object", "description" : "List of IP addresses in a project categorized by services.", @@ -37325,37 +40483,37 @@ "GroupServiceAccount" : { "type" : "object", "properties" : { + "clientId" : { + "type" : "string", + "description" : "The Client ID of the Service Account.", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + }, "createdAt" : { "type" : "string", "format" : "date-time", - "description" : "Service account creation time." + "description" : "The date that the Service Account was created on." }, "description" : { "type" : "string", - "description" : "Description of the service account." - }, - "id" : { - "type" : "string", - "description" : "ID for the service account.", - "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + "description" : "Human readable description for the Service Account." }, "name" : { "type" : "string", - "description" : "Name for service account." + "description" : "Human-readable name for the Service Account." }, "roles" : { "type" : "array", - "description" : "Roles assigned to the Service Account group.", + "description" : "A list of Project roles associated with the Service Account.", "items" : { "type" : "string", - "description" : "Project roles associated with the service account.", + "description" : "Project roles available for Service Accounts.", "enum" : [ "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" ] }, "uniqueItems" : true }, "secrets" : { "type" : "array", - "description" : "List of secrets.", + "description" : "A list of secrets associated with the specified Service Account.", "items" : { "$ref" : "#/components/schemas/ServiceAccountSecret" }, @@ -37368,73 +40526,74 @@ "properties" : { "description" : { "type" : "string", - "description" : "Human readable description for the service account.", + "description" : "Human readable description for the Service Account.", "maxLength" : 250, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "name" : { "type" : "string", - "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "description" : "Human-readable name for the Service Account. The name is modifiable and does not have to be unique.", "maxLength" : 64, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "roles" : { "type" : "array", - "description" : "Project roles associated with the service account.", + "description" : "A list of project-level roles for the Service Account.", "items" : { "type" : "string", - "description" : "Project roles associated with the service account.", + "description" : "Project roles available for Service Accounts.", "enum" : [ "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" ] } }, "secretExpiresAfterHours" : { "type" : "integer", "format" : "int32", - "description" : "Secret expiration time." + "description" : "The expiration time of the new Service Account secret. The expiration is provided in hours." } }, - "required" : [ "description", "name", "secretExpiresAfterHours" ] + "required" : [ "description", "name", "roles", "secretExpiresAfterHours" ] }, "GroupServiceAccountRoleAssignment" : { "type" : "object", "properties" : { "roles" : { "type" : "array", - "description" : "Group access roles.", + "description" : "The Project permissions for the Service Account in the specified Project.", "items" : { "type" : "string", - "description" : "Project roles associated with the service account.", + "description" : "Project roles available for Service Accounts.", "enum" : [ "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" ] }, "uniqueItems" : true } - } + }, + "required" : [ "roles" ] }, "GroupServiceAccountUpdateRequest" : { "type" : "object", "properties" : { "description" : { "type" : "string", - "description" : "Human readable description for the service account.", + "description" : "Human readable description for the Service Account.", "maxLength" : 250, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "name" : { "type" : "string", - "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "description" : "Human-readable name for the Service Account. The name is modifiable and does not have to be unique.", "maxLength" : 64, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "roles" : { "type" : "array", - "description" : "Project roles associated with the service account.", + "description" : "A list of Project roles associated with the Service Account.", "items" : { "type" : "string", - "description" : "Project roles associated with the service account.", + "description" : "Project roles available for Service Accounts.", "enum" : [ "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" ] } } @@ -37678,7 +40837,7 @@ "example" : "cluster1", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -37773,14 +40932,14 @@ "HostEventTypeViewForNdsGroup" : { "type" : "string", "description" : "Unique identifier of event type.", - "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_ENOUGH_DISK_SPACE", "HOST_NOT_ENOUGH_DISK_SPACE" ], + "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_ENOUGH_DISK_SPACE", "HOST_NOT_ENOUGH_DISK_SPACE" ], "example" : "HOST_DOWN", "title" : "Host Event Types" }, "HostEventTypeViewForNdsGroupAlertable" : { "type" : "string", "description" : "Event type that triggers an alert.", - "enum" : [ "HOST_DOWN", "HOST_HAS_INDEX_SUGGESTIONS", "HOST_MONGOT_CRASHING_OOM", "HOST_NOT_ENOUGH_DISK_SPACE" ], + "enum" : [ "HOST_DOWN", "HOST_HAS_INDEX_SUGGESTIONS", "HOST_MONGOT_CRASHING_OOM", "HOST_MONGOT_STOP_REPLICATION", "HOST_NOT_ENOUGH_DISK_SPACE" ], "example" : "HOST_DOWN", "title" : "Host Event Types" }, @@ -38066,6 +41225,7 @@ "OPCOUNTER_REPL_INSERT" : "#/components/schemas/RawMetricAlertView", "OPCOUNTER_REPL_UPDATE" : "#/components/schemas/RawMetricAlertView", "OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricAlertView", + "OPERATIONS_QUERIES_KILLED" : "#/components/schemas/RawMetricAlertView", "OPERATIONS_SCAN_AND_ORDER" : "#/components/schemas/RawMetricAlertView", "OPERATION_THROTTLING_REJECTED_OPERATIONS" : "#/components/schemas/RawMetricAlertView", "OPLOG_MASTER_LAG_TIME_DIFF" : "#/components/schemas/TimeMetricAlertView", @@ -38135,7 +41295,7 @@ "example" : "cluster1", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -38444,6 +41604,7 @@ "OPCOUNTER_REPL_INSERT" : "#/components/schemas/RawMetricEventView", "OPCOUNTER_REPL_UPDATE" : "#/components/schemas/RawMetricEventView", "OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricEventView", + "OPERATIONS_QUERIES_KILLED" : "#/components/schemas/RawMetricEventView", "OPERATIONS_SCAN_AND_ORDER" : "#/components/schemas/RawMetricEventView", "OPERATION_THROTTLING_REJECTED_OPERATIONS" : "#/components/schemas/RawMetricEventView", "OPLOG_MASTER_LAG_TIME_DIFF" : "#/components/schemas/TimeMetricEventView", @@ -38749,6 +41910,7 @@ "OPCOUNTER_REPL_INSERT" : "#/components/schemas/RawMetricThresholdView", "OPCOUNTER_REPL_UPDATE" : "#/components/schemas/RawMetricThresholdView", "OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "OPERATIONS_QUERIES_KILLED" : "#/components/schemas/RawMetricThresholdView", "OPERATIONS_SCAN_AND_ORDER" : "#/components/schemas/RawMetricThresholdView", "OPERATION_THROTTLING_REJECTED_OPERATIONS" : "#/components/schemas/RawMetricThresholdView", "OPLOG_MASTER_LAG_TIME_DIFF" : "#/components/schemas/TimeMetricThresholdView", @@ -38795,7 +41957,9 @@ "enum" : [ "AVERAGE" ] }, "operator" : { - "$ref" : "#/components/schemas/Operator" + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, "threshold" : { "type" : "number", @@ -39147,7 +42311,7 @@ "description" : "Human-readable label that identifies the cluster that incurred the charge.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -39201,7 +42365,7 @@ "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.", - "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_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", "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_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_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" ], + "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_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", "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_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_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_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" ], "readOnly" : true }, "startDate" : { @@ -39491,6 +42655,323 @@ "description" : "Configuration of nodes that comprise the cluster.", "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] }, + "configServerManagementMode" : { + "type" : "string", + "default" : "ATLAS_MANAGED", + "description" : "Config Server Management Mode for creating or updating a sharded cluster.\n\nWhen configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings.\n\nWhen configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server.", + "enum" : [ "ATLAS_MANAGED", "FIXED_TO_DEDICATED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + } + }, + "configServerType" : { + "type" : "string", + "description" : "Describes a sharded cluster's config server type.", + "enum" : [ "DEDICATED", "EMBEDDED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + }, + "readOnly" : true + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/ClusterConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "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.", + "maximum" : 4096, + "minimum" : 10 + }, + "diskWarmingMode" : { + "type" : "string", + "default" : "FULLY_WARMED", + "description" : "Disk warming mode selection.", + "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], + "externalDocs" : { + "description" : "Reduce Secondary Disk Warming Impact", + "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" + } + }, + "encryptionAtRestProvider" : { + "type" : "string", + "description" : "Cloud service provider that manages your customer keys to provide an additional layer of Encryption at Rest for the cluster.", + "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "featureCompatibilityVersion" : { + "type" : "string", + "description" : "Feature compatibility version of the cluster.", + "readOnly" : true + }, + "featureCompatibilityVersionExpirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Feature compatibility version expiration date.", + "readOnly" : true + }, + "globalClusterSelfManagedSharding" : { + "type" : "boolean", + "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen 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.\n\nWhen 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.\n\nThis 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" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "labels" : { + "type" : "array", + "deprecated" : true, + "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBEmployeeAccessGrant" : { + "$ref" : "#/components/schemas/EmployeeAccessGrantView" + }, + "mongoDBMajorVersion" : { + "type" : "string", + "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", + "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-" + } + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the cluster runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)" + }, + "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.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "mongoURIUpdated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated the connection string. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "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.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + }, + "numShards" : { + "type" : "integer", + "format" : "int32", + "default" : 1, + "description" : "Number of shards up to 50 to deploy for a sharded cluster. The resource returns `1` to indicate a replica set and values of `2` and higher to indicate a sharded cluster. The returned value equals the number of shards in the cluster.", + "externalDocs" : { + "description" : "Sharding", + "url" : "https://docs.mongodb.com/manual/sharding/" + }, + "maximum" : 50, + "minimum" : 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", + "default" : "WORKLOAD_TYPE", + "description" : "Set this field to configure the replica set scaling mode for your cluster.\n\nBy default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes.\n\nWhen configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads.\n\nWhen configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads.", + "enum" : [ "SEQUENTIAL", "WORKLOAD_TYPE", "NODE_TYPE" ], + "externalDocs" : { + "description" : "Modify the Replica Set Scaling Mode", + "url" : "https://dochub.mongodb.org/core/scale-nodes" + } + }, + "replicationFactor" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "deprecated" : true, + "description" : "Number of members that belong to the replica set. Each member retains a copy of your databases, providing high availability and data redundancy. Use **replicationSpecs** instead.", + "enum" : [ 3, 5, 7 ] + }, + "replicationSpec" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RegionSpec" + }, + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "title" : "Region Configuration" + }, + "replicationSpecs" : { + "type" : "array", + "description" : "List of settings that configure your cluster regions.\n\n- For Global Clusters, each object in the array represents one zone where MongoDB Cloud deploys your clusters nodes.\n- For non-Global sharded clusters and replica sets, the single object represents where MongoDB Cloud deploys your clusters nodes.", + "items" : { + "$ref" : "#/components/schemas/LegacyReplicationSpec" + } + }, + "rootCertType" : { + "type" : "string", + "default" : "ISRGROOTX1", + "description" : "Root Certificate Authority that MongoDB Atlas clusters uses. MongoDB Cloud supports Internet Security Research Group.", + "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.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the cluster.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", + "enum" : [ "LTS", "CONTINUOUS" ] + } + }, + "title" : "Cluster Description" + }, + "LegacyAtlasTenantClusterUpgradeRequest" : { + "type" : "object", + "description" : "Request containing target state of tenant cluster to be upgraded", + "properties" : { + "acceptDataRisksAndForceReplicaSetReconfig" : { + "type" : "string", + "format" : "date-time", + "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", + "externalDocs" : { + "description" : "Reconfiguring a Replica Set during a regional outage", + "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + } + }, + "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", + "default" : "ATLAS_MANAGED", + "description" : "Config Server Management Mode for creating or updating a sharded cluster.\n\nWhen configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings.\n\nWhen configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server.", + "enum" : [ "ATLAS_MANAGED", "FIXED_TO_DEDICATED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + } + }, + "configServerType" : { + "type" : "string", + "description" : "Describes a sharded cluster's config server type.", + "enum" : [ "DEDICATED", "EMBEDDED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + }, + "readOnly" : true + }, "connectionStrings" : { "$ref" : "#/components/schemas/ClusterConnectionStrings" }, @@ -39526,6 +43007,17 @@ "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" } }, + "featureCompatibilityVersion" : { + "type" : "string", + "description" : "Feature compatibility version of the cluster.", + "readOnly" : true + }, + "featureCompatibilityVersionExpirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Feature compatibility version expiration date.", + "readOnly" : true + }, "globalClusterSelfManagedSharding" : { "type" : "boolean", "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen 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.\n\nWhen 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.\n\nThis setting cannot be changed once the cluster is deployed.", @@ -39572,6 +43064,9 @@ }, "readOnly" : true }, + "mongoDBEmployeeAccessGrant" : { + "$ref" : "#/components/schemas/EmployeeAccessGrantView" + }, "mongoDBMajorVersion" : { "type" : "string", "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", @@ -39614,7 +43109,7 @@ "description" : "Human-readable label that identifies the cluster.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, "numShards" : { "type" : "integer", @@ -39647,259 +43142,16 @@ "providerSettings" : { "$ref" : "#/components/schemas/ClusterProviderSettings" }, - "replicationFactor" : { - "type" : "integer", - "format" : "int32", - "default" : 3, - "deprecated" : true, - "description" : "Number of members that belong to the replica set. Each member retains a copy of your databases, providing high availability and data redundancy. Use **replicationSpecs** instead.", - "enum" : [ 3, 5, 7 ] - }, - "replicationSpec" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/RegionSpec" - }, - "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", - "title" : "Region Configuration" - }, - "replicationSpecs" : { - "type" : "array", - "description" : "List of settings that configure your cluster regions.\n\n- For Global Clusters, each object in the array represents one zone where MongoDB Cloud deploys your clusters nodes.\n- For non-Global sharded clusters and replica sets, the single object represents where MongoDB Cloud deploys your clusters nodes.", - "items" : { - "$ref" : "#/components/schemas/LegacyReplicationSpec" - } - }, - "rootCertType" : { - "type" : "string", - "default" : "ISRGROOTX1", - "description" : "Root Certificate Authority that MongoDB Atlas clusters uses. MongoDB Cloud supports Internet Security Research Group.", - "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.", - "externalDocs" : { - "description" : "Connection string URI format.", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, - "readOnly" : true - }, - "stateName" : { + "replicaSetScalingStrategy" : { "type" : "string", - "description" : "Human-readable label that indicates the current operating condition of the cluster.", - "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], - "readOnly" : true - }, - "tags" : { - "type" : "array", - "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "default" : "WORKLOAD_TYPE", + "description" : "Set this field to configure the replica set scaling mode for your cluster.\n\nBy default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes.\n\nWhen configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads.\n\nWhen configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads.", + "enum" : [ "SEQUENTIAL", "WORKLOAD_TYPE", "NODE_TYPE" ], "externalDocs" : { - "description" : "Resource Tags", - "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" - }, - "items" : { - "$ref" : "#/components/schemas/ResourceTag" - } - }, - "terminationProtectionEnabled" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." - }, - "versionReleaseSystem" : { - "type" : "string", - "default" : "LTS", - "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", - "enum" : [ "LTS", "CONTINUOUS" ] - } - }, - "title" : "Cluster Description" - }, - "LegacyAtlasTenantClusterUpgradeRequest" : { - "type" : "object", - "description" : "Request containing target state of tenant cluster to be upgraded", - "properties" : { - "acceptDataRisksAndForceReplicaSetReconfig" : { - "type" : "string", - "format" : "date-time", - "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", - "externalDocs" : { - "description" : "Reconfiguring a Replica Set during a regional outage", - "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + "description" : "Modify the Replica Set Scaling Mode", + "url" : "https://dochub.mongodb.org/core/scale-nodes" } }, - "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" ] - }, - "connectionStrings" : { - "$ref" : "#/components/schemas/ClusterConnectionStrings" - }, - "createDate" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", - "readOnly" : true - }, - "diskSizeGB" : { - "type" : "number", - "format" : "double", - "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.", - "maximum" : 4096, - "minimum" : 10 - }, - "diskWarmingMode" : { - "type" : "string", - "default" : "FULLY_WARMED", - "description" : "Disk warming mode selection.", - "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], - "externalDocs" : { - "description" : "Reduce Secondary Disk Warming Impact", - "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" - } - }, - "encryptionAtRestProvider" : { - "type" : "string", - "description" : "Cloud service provider that manages your customer keys to provide an additional layer of Encryption at Rest for the cluster.", - "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], - "externalDocs" : { - "description" : "Encryption at Rest using Customer Key Management", - "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" - } - }, - "globalClusterSelfManagedSharding" : { - "type" : "boolean", - "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen 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.\n\nWhen 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.\n\nThis 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" : { - "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the project.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "labels" : { - "type" : "array", - "deprecated" : true, - "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", - "items" : { - "$ref" : "#/components/schemas/ComponentLabel" - } - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - }, - "mongoDBMajorVersion" : { - "type" : "string", - "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", - "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-" - } - }, - "mongoDBVersion" : { - "type" : "string", - "description" : "Version of MongoDB that the cluster runs.", - "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)" - }, - "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.", - "externalDocs" : { - "description" : "Connection string URI format.", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, - "readOnly" : true - }, - "mongoURIUpdated" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when someone last updated the connection string. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", - "readOnly" : true - }, - "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.", - "externalDocs" : { - "description" : "Connection string URI format.", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "Human-readable label that identifies the cluster.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - }, - "numShards" : { - "type" : "integer", - "format" : "int32", - "default" : 1, - "description" : "Number of shards up to 50 to deploy for a sharded cluster. The resource returns `1` to indicate a replica set and values of `2` and higher to indicate a sharded cluster. The returned value equals the number of shards in the cluster.", - "externalDocs" : { - "description" : "Sharding", - "url" : "https://docs.mongodb.com/manual/sharding/" - }, - "maximum" : 50, - "minimum" : 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" - }, "replicationFactor" : { "type" : "integer", "format" : "int32", @@ -40446,6 +43698,10 @@ "type" : "string", "enum" : [ "INSTANCE_NAME", "PROCESSOR_NAME" ], "title" : "Streams Matcher Fields" + }, { + "type" : "string", + "enum" : [ "RULE_ID" ], + "title" : "Log Ingestion Matcher Fields" } ] }, "MatcherHostType" : { @@ -41096,7 +44352,7 @@ "NDSAuditTypeViewForNdsGroup" : { "type" : "string", "description" : "Unique identifier of event type.", - "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_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_SSL_ROTATED", "CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER", "CLUSTER_INSTANCE_SSL_REVOKED", "RELOAD_SSL_ON_PROCESSES", "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", "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", "MOVE_SKIPPED", "PROXY_RESTARTED", "PROXY_PANICKED", "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", "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", "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", "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", "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", "PENDING_INDEXES_DELETED", "PENDING_INDEXES_CANCELED", "PROCESS_RESTART_REQUESTED", "AUTO_HEALING_ACTION", "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", "CLUSTER_FORCE_RECONFIG_REQUESTED", "PROJECT_BYPASSED_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", "ATLAS_SQL_SCHEDULED_UPDATE_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_MODIFIED", "ATLAS_SQL_SCHEDULED_UPDATE_REMOVED" ], + "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_SSL_ROTATED", "CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER", "CLUSTER_INSTANCE_SSL_REVOKED", "RELOAD_SSL_ON_PROCESSES", "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", "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", "MOVE_SKIPPED", "PROXY_RESTARTED", "PROXY_PANICKED", "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", "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", "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", "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", "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", "CLUSTER_FORCE_RECONFIG_REQUESTED", "PROJECT_BYPASSED_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" ], "example" : "CLUSTER_CREATED", "title" : "NDS Audit Types" }, @@ -41993,7 +45249,7 @@ "example" : "cluster1", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -42235,7 +45491,9 @@ "enum" : [ "AVERAGE" ] }, "operator" : { - "$ref" : "#/components/schemas/Operator" + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, "threshold" : { "type" : "number", @@ -42419,6 +45677,54 @@ "required" : [ "typeName" ], "title" : "OpsGenie Notification" }, + "OrgActiveUserResponse" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OrgUserResponse" + }, { + "type" : "object", + "properties" : { + "country" : { + "type" : "string", + "description" : "Two alphabet characters that identifies MongoDB Cloud user's geographic location. This parameter uses the ISO 3166-1a2 code format.", + "example" : "US", + "pattern" : "^([A-Z]{2})$", + "readOnly" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the current account. This value is in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "firstName" : { + "type" : "string", + "description" : "First or given name that belongs to the MongoDB Cloud user.", + "example" : "John", + "readOnly" : true + }, + "lastAuth" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the current account last authenticated. This value is in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "lastName" : { + "type" : "string", + "description" : "Last name, family name, or surname that belongs to the MongoDB Cloud user.", + "example" : "Doe", + "readOnly" : true + }, + "mobileNumber" : { + "type" : "string", + "description" : "Mobile phone number that belongs to the MongoDB Cloud user.", + "pattern" : "(?:(?:\\\\+?1\\\\s*(?:[.-]\\\\s*)?)?(?:(\\\\s*([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9])\\\\s*)|([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9]))\\\\s*(?:[.-]\\\\s*)?)([2-9]1[02-9]|[2-9][02-9]1|[2-9][02-9]{2})\\\\s*(?:[.-]\\\\s*)?([0-9]{4})$", + "readOnly" : true + } + } + } ], + "required" : [ "createdAt", "firstName", "id", "lastName", "orgMembershipStatus", "roles", "username" ] + }, "OrgEventTypeViewForOrg" : { "type" : "string", "description" : "Unique identifier of event type.", @@ -42700,7 +46006,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/EventViewForOrg" }, @@ -42715,40 +46021,69 @@ } } }, + "OrgPendingUserResponse" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OrgUserResponse" + }, { + "type" : "object", + "properties" : { + "invitationCreatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud sent the invitation. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "invitationExpiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the invitation from MongoDB Cloud expires. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "inviterUsername" : { + "type" : "string", + "format" : "email", + "description" : "Username of the MongoDB Cloud user who sent the invitation to join the organization.", + "readOnly" : true + } + } + } ], + "required" : [ "id", "invitationCreatedAt", "invitationExpiresAt", "inviterUsername", "orgMembershipStatus", "roles", "username" ] + }, "OrgServiceAccount" : { "type" : "object", "properties" : { + "clientId" : { + "type" : "string", + "description" : "The Client ID of the Service Account.", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + }, "createdAt" : { "type" : "string", "format" : "date-time", - "description" : "Service account creation time." + "description" : "The date that the Service Account was created on." }, "description" : { "type" : "string", - "description" : "Description of the service account." - }, - "id" : { - "type" : "string", - "description" : "ID for the service account.", - "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + "description" : "Human readable description for the Service Account." }, "name" : { "type" : "string", - "description" : "Name for service account." + "description" : "Human-readable name for the Service Account." }, "roles" : { "type" : "array", - "description" : "Organization roles assigned to the Service Account.", + "description" : "A list of Organization roles associated with the Service Account.", "items" : { "type" : "string", - "description" : "Organization roles associated with the service account.", + "description" : "Organization roles available for Service Accounts.", "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] }, "uniqueItems" : true }, "secrets" : { "type" : "array", - "description" : "List of secrets.", + "description" : "A list of secrets associated with the specified Service Account.", "items" : { "$ref" : "#/components/schemas/ServiceAccountSecret" }, @@ -42761,63 +46096,215 @@ "properties" : { "description" : { "type" : "string", - "description" : "Human readable description for the service account.", + "description" : "Human readable description for the Service Account.", "maxLength" : 250, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "name" : { "type" : "string", - "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "description" : "Human-readable name for the Service Account. The name is modifiable and does not have to be unique.", "maxLength" : 64, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "roles" : { "type" : "array", - "description" : "Organization roles associated with the service account.", + "description" : "A list of organization-level roles for the Service Account.", "items" : { "type" : "string", - "description" : "Organization roles associated with the service account.", + "description" : "Organization roles available for Service Accounts.", "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] } }, "secretExpiresAfterHours" : { "type" : "integer", "format" : "int32", - "description" : "Secret expiration time." + "description" : "The expiration time of the new Service Account secret. The expiration is provided in hours." } }, - "required" : [ "description", "name", "secretExpiresAfterHours" ] + "required" : [ "description", "name", "roles", "secretExpiresAfterHours" ] }, "OrgServiceAccountUpdateRequest" : { "type" : "object", "properties" : { "description" : { "type" : "string", - "description" : "Human readable description for the service account.", + "description" : "Human readable description for the Service Account.", "maxLength" : 250, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "name" : { "type" : "string", - "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "description" : "Human-readable name for the Service Account. The name is modifiable and does not have to be unique.", "maxLength" : 64, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "roles" : { "type" : "array", - "description" : "Organization roles associated with the Service account.", + "description" : "A list of organization-level roles for the Service Account.", "items" : { "type" : "string", - "description" : "Organization roles associated with the service account.", + "description" : "Organization roles available for Service Accounts.", "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] } } } }, + "OrgUserRequest" : { + "type" : "object", + "properties" : { + "roles" : { + "$ref" : "#/components/schemas/OrgUserRolesRequest" + }, + "teamIds" : { + "type" : "array", + "description" : "List of unique 24-hexadecimal digit strings that identifies the teams to which this MongoDB Cloud user belongs.", + "items" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "uniqueItems" : true, + "writeOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address that represents the username of the MongoDB Cloud user.", + "writeOnly" : true + } + }, + "required" : [ "roles", "username" ] + }, + "OrgUserResponse" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "ACTIVE" : "#/components/schemas/OrgActiveUserResponse", + "PENDING" : "#/components/schemas/OrgPendingUserResponse" + }, + "propertyName" : "orgMembershipStatus" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/OrgPendingUserResponse" + }, { + "$ref" : "#/components/schemas/OrgActiveUserResponse" + } ], + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgMembershipStatus" : { + "type" : "string", + "description" : "String enum that indicates whether the MongoDB Cloud user has a pending invitation to join the organization or they are already active in the organization.", + "enum" : [ "PENDING", "ACTIVE" ], + "readOnly" : true + }, + "roles" : { + "$ref" : "#/components/schemas/OrgUserRolesResponse" + }, + "teamIds" : { + "type" : "array", + "description" : "List of unique 24-hexadecimal digit strings that identifies the teams to which this MongoDB Cloud user belongs.", + "items" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address that represents the username of the MongoDB Cloud user.", + "readOnly" : true + } + }, + "required" : [ "id", "orgMembershipStatus", "roles", "username" ] + }, + "OrgUserRolesRequest" : { + "type" : "object", + "description" : "Organization and project level roles to assign the MongoDB Cloud user within one organization.", + "properties" : { + "groupRoleAssignments" : { + "type" : "array", + "description" : "List of project level role assignments to assign the MongoDB Cloud user.", + "items" : { + "$ref" : "#/components/schemas/GroupRoleAssignment" + } + }, + "orgRoles" : { + "type" : "array", + "description" : "One or more organization level roles to assign the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_READ_ONLY", "ORG_MEMBER" ] + }, + "minItems" : 1, + "uniqueItems" : true + } + }, + "required" : [ "orgRoles" ], + "writeOnly" : true + }, + "OrgUserRolesResponse" : { + "type" : "object", + "description" : "Organization and project level roles assigned to one MongoDB Cloud user within one organization.", + "properties" : { + "groupRoleAssignments" : { + "type" : "array", + "description" : "List of project level role assignments assigned to the MongoDB Cloud user.", + "items" : { + "$ref" : "#/components/schemas/GroupRoleAssignment" + } + }, + "orgRoles" : { + "type" : "array", + "description" : "One or more organization level roles assigned to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_READ_ONLY", "ORG_MEMBER" ] + }, + "uniqueItems" : true + } + }, + "readOnly" : true + }, + "OrgUserUpdateRequest" : { + "type" : "object", + "properties" : { + "roles" : { + "$ref" : "#/components/schemas/OrgUserRolesRequest" + }, + "teamIds" : { + "type" : "array", + "description" : "List of unique 24-hexadecimal digit strings that identifies the teams to assign the MongoDB Cloud user.", + "items" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "uniqueItems" : true, + "writeOnly" : true + } + } + }, "OrganizationInvitation" : { "type" : "object", "properties" : { @@ -43022,7 +46509,7 @@ }, "restrictEmployeeAccess" : { "type" : "boolean", - "description" : "Flag that indicates whether to block MongoDB Support from accessing Atlas infrastructure 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/." + "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/." } } }, @@ -43169,7 +46656,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/AdvancedClusterDescription" }, @@ -43201,7 +46688,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/GroupAlertsConfig" }, @@ -43233,7 +46720,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/AlertViewForNdsGroup" }, @@ -43265,7 +46752,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ApiKeyUserDetails" }, @@ -43297,7 +46784,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/CloudAppUser" }, @@ -43329,7 +46816,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ApiAtlasCheckpointView" }, @@ -43362,7 +46849,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/CloudDatabaseUser" }, @@ -43394,7 +46881,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/DiskBackupExportJob" }, @@ -43426,7 +46913,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/EARPrivateEndpoint" }, @@ -43441,7 +46928,7 @@ } } }, - "PaginatedApiAtlasProviderRegionsView" : { + "PaginatedApiAtlasFlexBackupRestoreJob20250101View" : { "type" : "object", "properties" : { "links" : { @@ -43458,9 +46945,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/CloudProviderRegions" + "$ref" : "#/components/schemas/FlexBackupRestoreJob20250101" }, "readOnly" : true }, @@ -43473,7 +46960,7 @@ } } }, - "PaginatedApiAtlasServerlessBackupRestoreJobView" : { + "PaginatedApiAtlasFlexBackupSnapshot20240710View" : { "type" : "object", "properties" : { "links" : { @@ -43490,9 +46977,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" + "$ref" : "#/components/schemas/FlexBackupSnapshot20250101" }, "readOnly" : true }, @@ -43505,7 +46992,7 @@ } } }, - "PaginatedApiAtlasServerlessBackupSnapshotView" : { + "PaginatedApiAtlasProviderRegionsView" : { "type" : "object", "properties" : { "links" : { @@ -43522,9 +47009,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/ServerlessBackupSnapshot" + "$ref" : "#/components/schemas/CloudProviderRegions" }, "readOnly" : true }, @@ -43537,7 +47024,7 @@ } } }, - "PaginatedApiAtlasUSSBackupRestoreJob20250101View" : { + "PaginatedApiAtlasServerlessBackupRestoreJobView" : { "type" : "object", "properties" : { "links" : { @@ -43554,9 +47041,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/USSBackupRestoreJob20250101" + "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" }, "readOnly" : true }, @@ -43569,7 +47056,7 @@ } } }, - "PaginatedApiAtlasUSSBackupSnapshot20240710View" : { + "PaginatedApiAtlasServerlessBackupSnapshotView" : { "type" : "object", "properties" : { "links" : { @@ -43586,9 +47073,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/USSBackupSnapshot20250101" + "$ref" : "#/components/schemas/ServerlessBackupSnapshot" }, "readOnly" : true }, @@ -43618,7 +47105,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/BillingInvoiceMetadata" }, @@ -43650,7 +47137,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/BillingInvoice" }, @@ -43682,7 +47169,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/StreamsConnection" }, @@ -43697,6 +47184,38 @@ } } }, + "PaginatedApiStreamsPrivateLinkView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", + "items" : { + "$ref" : "#/components/schemas/StreamsPrivateLinkConnection" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, "PaginatedApiStreamsStreamProcessorWithStatsView" : { "type" : "object", "properties" : { @@ -43714,7 +47233,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/StreamsProcessorWithStats" }, @@ -43746,7 +47265,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/StreamsTenant" }, @@ -43778,7 +47297,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/UserAccessListResponse" }, @@ -43793,6 +47312,38 @@ } } }, + "PaginatedApiVersions" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ApiVersion" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, "PaginatedAppUserView" : { "type" : "object", "properties" : { @@ -43810,7 +47361,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/CloudAppUser" }, @@ -43842,7 +47393,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/Group" }, @@ -43874,7 +47425,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/MdbAvailableVersion" }, @@ -43906,7 +47457,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" }, @@ -43938,7 +47489,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/DiskBackupSnapshotExportBucket" }, @@ -43970,7 +47521,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/DiskBackupSnapshot" }, @@ -44002,7 +47553,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/DiskBackupReplicaSet" }, @@ -44034,7 +47585,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/DiskBackupSnapshotRestoreJob" }, @@ -44066,7 +47617,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/DiskBackupShardedClusterSnapshot" }, @@ -44099,7 +47650,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/CloudProviderContainer" }, @@ -44132,7 +47683,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ClusterDescription20240805" }, @@ -44164,7 +47715,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ConnectedOrgConfig" }, @@ -44197,7 +47748,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" }, @@ -44229,7 +47780,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/MesurementsDatabase" }, @@ -44261,7 +47812,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/MeasurementDiskPartition" }, @@ -44293,7 +47844,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/EventTypeDetails" }, @@ -44325,7 +47876,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/FederationIdentityProvider" }, @@ -44340,9 +47891,41 @@ } } }, + "PaginatedFlexClusters20250101" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", + "items" : { + "type" : "object" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, "PaginatedGroupServiceAccounts" : { "type" : "object", - "description" : "List of Service Accounts", + "description" : "A list of Project Service Accounts.", "properties" : { "links" : { "type" : "array", @@ -44358,7 +47941,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/GroupServiceAccount" }, @@ -44390,7 +47973,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ApiHostView_Atlas" }, @@ -44422,7 +48005,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ThirdPartyIntegration" }, @@ -44454,7 +48037,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/LegacyAtlasCluster" }, @@ -44486,7 +48069,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/NetworkPermissionEntry" }, @@ -44518,7 +48101,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/BackupOnlineArchive" }, @@ -44550,7 +48133,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/OrgGroup" }, @@ -44567,7 +48150,7 @@ }, "PaginatedOrgServiceAccounts" : { "type" : "object", - "description" : "List of Service Accounts", + "description" : "A list of Organization Service Accounts.", "properties" : { "links" : { "type" : "array", @@ -44583,7 +48166,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/OrgServiceAccount" }, @@ -44615,7 +48198,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/AtlasOrganization" }, @@ -44647,7 +48230,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/IngestionPipelineRun" }, @@ -44679,7 +48262,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/PrivateNetworkEndpointIdEntry" }, @@ -44711,7 +48294,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/PublicApiUsageDetailsLineItemView" }, @@ -44743,7 +48326,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/BackupRestoreJob" }, @@ -44776,7 +48359,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/AuthFederationRoleMapping" }, @@ -44808,7 +48391,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ServerlessInstanceDescription" }, @@ -44825,7 +48408,7 @@ }, "PaginatedServiceAccountGroup" : { "type" : "object", - "description" : "List of Service Account projects.", + "description" : "A list of projects associated with the Service Account.", "properties" : { "links" : { "type" : "array", @@ -44841,7 +48424,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ServiceAccountGroup" }, @@ -44856,7 +48439,7 @@ } } }, - "PaginatedSnapshotView" : { + "PaginatedServiceAccountIPAccessEntryView" : { "type" : "object", "properties" : { "links" : { @@ -44873,9 +48456,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/BackupSnapshot" + "$ref" : "#/components/schemas/ServiceAccountIPAccessListEntry" }, "readOnly" : true }, @@ -44888,7 +48471,7 @@ } } }, - "PaginatedTeamRoleView" : { + "PaginatedSnapshotView" : { "type" : "object", "properties" : { "links" : { @@ -44905,9 +48488,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/TeamRole" + "$ref" : "#/components/schemas/BackupSnapshot" }, "readOnly" : true }, @@ -44920,7 +48503,7 @@ } } }, - "PaginatedTeamView" : { + "PaginatedTeamRoleView" : { "type" : "object", "properties" : { "links" : { @@ -44937,9 +48520,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/TeamResponse" + "$ref" : "#/components/schemas/TeamRole" }, "readOnly" : true }, @@ -44952,7 +48535,7 @@ } } }, - "PaginatedTenantRestoreView" : { + "PaginatedTeamView" : { "type" : "object", "properties" : { "links" : { @@ -44969,9 +48552,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/TenantRestore" + "$ref" : "#/components/schemas/TeamResponse" }, "readOnly" : true }, @@ -44984,7 +48567,7 @@ } } }, - "PaginatedTenantSnapshotView" : { + "PaginatedTenantRestoreView" : { "type" : "object", "properties" : { "links" : { @@ -45001,9 +48584,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/BackupTenantSnapshot" + "$ref" : "#/components/schemas/TenantRestore" }, "readOnly" : true }, @@ -45016,7 +48599,7 @@ } } }, - "PaginatedUSSInstance20250101" : { + "PaginatedTenantSnapshotView" : { "type" : "object", "properties" : { "links" : { @@ -45033,9 +48616,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "type" : "object" + "$ref" : "#/components/schemas/BackupTenantSnapshot" }, "readOnly" : true }, @@ -45065,7 +48648,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/UserCert" }, @@ -45572,6 +49155,14 @@ "PrivateNetworkEndpointIdEntry" : { "type" : "object", "properties" : { + "azureConnectionName" : { + "type" : "string", + "description" : "Connection name that identifies the Azure private endpoint connection." + }, + "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." @@ -45580,6 +49171,11 @@ "type" : "string", "description" : "Human-readable label to identify customer's VPC endpoint DNS name." }, + "customerEndpointIPAddress" : { + "type" : "string", + "description" : "IP address used to connect to the Azure private endpoint.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + }, "endpointId" : { "type" : "string", "description" : "Unique 22-character alphanumeric string that identifies the private endpoint.", @@ -45592,6 +49188,10 @@ "minLength" : 22, "pattern" : "^vpce-[0-9a-f]{17}$" }, + "errorMessage" : { + "type" : "string", + "description" : "Error message describing a failure approving the private endpoint request." + }, "provider" : { "type" : "string", "default" : "AWS", @@ -45602,6 +49202,11 @@ "type" : "string", "description" : "Human-readable label to identify the region of customer's VPC endpoint." }, + "status" : { + "type" : "string", + "description" : "Status of the private endpoint connection request.", + "enum" : [ "PENDING", "OK", "FAILED", "DELETING" ] + }, "type" : { "type" : "string", "default" : "DATA_LAKE", @@ -45658,20 +49263,6 @@ "required" : [ "enabled", "serviceDiscovery", "username" ], "title" : "PROMETHEUS" }, - "ProxyInfo" : { - "type" : "object", - "description" : "VPC Proxy Information.", - "properties" : { - "authKey" : { - "type" : "string", - "description" : "Authentication key for the proxy." - }, - "dnsName" : { - "type" : "string", - "description" : "DNS name to use to reach the proxy/s." - } - } - }, "PublicApiUsageDetailsLineItemView" : { "type" : "object", "properties" : { @@ -45769,7 +49360,9 @@ "enum" : [ "AVERAGE" ] }, "operator" : { - "$ref" : "#/components/schemas/Operator" + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, "threshold" : { "type" : "number", @@ -45817,7 +49410,7 @@ "example" : "cluster1", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -46059,7 +49652,9 @@ "enum" : [ "AVERAGE" ] }, "operator" : { - "$ref" : "#/components/schemas/Operator" + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, "threshold" : { "type" : "number", @@ -46237,7 +49832,7 @@ "example" : "cluster1", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -46517,472 +50112,69 @@ } }, "zoneName" : { - "type" : "string", - "description" : "Human-readable label that identifies the zone in a Global Cluster. Provide this value only if `\"clusterType\" : \"GEOSHARDED\"`." - } - }, - "title" : "Replication Specifications" - }, - "ReplicationSpec20240805" : { - "type" : "object", - "description" : "Details that explain how MongoDB Cloud replicates data on the specified MongoDB database.", - "properties" : { - "id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a shard in a Cluster. If you include existing shard replication configurations in the request, you must specify this parameter. If you add a new shard to an existing Cluster, you may specify this parameter. The request deletes any existing shards in the Cluster that you exclude from the request.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "regionConfigs" : { - "type" : "array", - "description" : "Hardware specifications for nodes set for a given region. 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**.\n\n**Example:**\n\nIf you set `\"replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize\" : \"M30\"`, set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : `\"M30\"` if you have electable nodes and `\"replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize\" : `\"M30\"` if you have read-only nodes.", - "items" : { - "$ref" : "#/components/schemas/CloudRegionConfig20240805" - } - }, - "zoneId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the zone in a Global Cluster. This value can be used to configure Global Cluster backup policies.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "zoneName" : { - "type" : "string", - "description" : "Human-readable label that describes the zone this shard belongs to in a Global Cluster. Provide this value only if \"clusterType\" : \"GEOSHARDED\" but not \"selfManagedSharding\" : true." - } - }, - "title" : "Replication Specifications" - }, - "RequestAccepted" : { - "type" : "object", - "description" : "Accepted" - }, - "ResourceEventTypeView" : { - "type" : "string", - "description" : "Unique identifier of event type.", - "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], - "example" : "TAGS_MODIFIED", - "title" : "Resource Event Types" - }, - "ResourceEventTypeViewForOrg" : { - "type" : "string", - "description" : "Unique identifier of event type.", - "enum" : [ "GROUP_TAGS_MODIFIED" ], - "example" : "GROUP_TAGS_MODIFIED", - "title" : "Resource Event Types" - }, - "ResourceEventViewForNdsGroup" : { - "type" : "object", - "description" : "Resource event reflects different activities about resources.", - "properties" : { - "apiKeyId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "created" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true - }, - "eventTypeName" : { - "$ref" : "#/components/schemas/ResourceEventTypeView" - }, - "groupId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "isGlobalAdmin" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", - "readOnly" : true - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - }, - "orgId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "publicKey" : { - "type" : "string", - "format" : "email", - "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "example" : "test.user@mongodb.com", - "readOnly" : true - }, - "raw" : { - "$ref" : "#/components/schemas/raw" - }, - "remoteAddress" : { - "type" : "string", - "description" : "IPv4 or IPv6 address from which the user triggered this event.", - "example" : "216.172.40.186", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", - "readOnly" : true - }, - "resourceId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the resource associated with the event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "resourceType" : { - "type" : "string", - "description" : "Unique identifier of resource type.", - "example" : "cluster" - }, - "userId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "username" : { - "type" : "string", - "format" : "email", - "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", - "example" : "test.user@mongodb.com", - "readOnly" : true - } - }, - "required" : [ "created", "eventTypeName", "id", "resourceType" ], - "title" : "Resource Events" - }, - "ResourceEventViewForOrg" : { - "type" : "object", - "description" : "Resource event reflects different activities about resources.", - "properties" : { - "apiKeyId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "created" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true - }, - "eventTypeName" : { - "$ref" : "#/components/schemas/ResourceEventTypeViewForOrg" - }, - "groupId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "isGlobalAdmin" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", - "readOnly" : true - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - }, - "orgId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "publicKey" : { - "type" : "string", - "format" : "email", - "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "example" : "test.user@mongodb.com", - "readOnly" : true - }, - "raw" : { - "$ref" : "#/components/schemas/raw" - }, - "remoteAddress" : { - "type" : "string", - "description" : "IPv4 or IPv6 address from which the user triggered this event.", - "example" : "216.172.40.186", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", - "readOnly" : true - }, - "resourceId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the resource associated with the event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "resourceType" : { - "type" : "string", - "description" : "Unique identifier of resource type.", - "example" : "cluster" - }, - "userId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "username" : { - "type" : "string", - "format" : "email", - "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", - "example" : "test.user@mongodb.com", - "readOnly" : true - } - }, - "required" : [ "created", "eventTypeName", "id", "resourceType" ], - "title" : "Resource Events" - }, - "ResourceTag" : { - "type" : "object", - "description" : "Key-value pair that tags and categorizes a MongoDB Cloud organization, project, or cluster. For example, `environment : production`.", - "properties" : { - "key" : { - "type" : "string", - "description" : "Constant that defines the set of the tag. For example, `environment` in the `environment : production` tag.", - "maxLength" : 255, - "minLength" : 1 - }, - "value" : { - "type" : "string", - "description" : "Variable that belongs to the set of the tag. For example, `production` in the `environment : production` tag.", - "maxLength" : 255, - "minLength" : 1 - } - }, - "required" : [ "key", "value" ], - "title" : "Resource Tag" - }, - "RestoreJobFileHash" : { - "type" : "object", - "description" : "Key and value pair that map one restore file to one hashed checksum. This parameter applies after you download the corresponding **delivery.url**.", - "properties" : { - "fileName" : { - "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.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - }, - "typeName" : { - "type" : "string", - "description" : "Human-readable label that identifies the hashing algorithm used to compute the hash value.", - "enum" : [ "SHA1" ], - "readOnly" : true - } - }, - "readOnly" : true - }, - "RoleAssignment" : { - "type" : "object", - "properties" : { - "groupId" : { - "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", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" - }, - "orgId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization to which this role belongs. Each element within **roleAssignments** can have a value for **orgId** or **groupId**, but not both.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" - }, - "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.\n\nOrganization Roles\n\n* ORG_OWNER\n* ORG_MEMBER\n* ORG_GROUP_CREATOR\n* ORG_BILLING_ADMIN\n* ORG_READ_ONLY\n\nProject Roles\n\n* GROUP_CLUSTER_MANAGER\n* GROUP_DATA_ACCESS_ADMIN\n* GROUP_DATA_ACCESS_READ_ONLY\n* GROUP_DATA_ACCESS_READ_WRITE\n* GROUP_OWNER\n* GROUP_READ_ONLY\n* GROUP_SEARCH_INDEX_EDITOR\n* GROUP_STREAM_PROCESSING_OWNER\n\n", - "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] - } - } - }, - "SMSNotification" : { - "type" : "object", - "description" : "SMS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", - "properties" : { - "delayMin" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." - }, - "intervalMin" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", - "minimum" : 5 - }, - "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" : { - "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" ] + "type" : "string", + "description" : "Human-readable label that identifies the zone in a Global Cluster. Provide this value only if `\"clusterType\" : \"GEOSHARDED\"`." } }, - "required" : [ "typeName" ], - "title" : "SMS Notification" + "title" : "Replication Specifications" }, - "SampleDatasetStatus" : { + "ReplicationSpec20240805" : { "type" : "object", + "description" : "Details that explain how MongoDB Cloud replicates data on the specified MongoDB database.", "properties" : { - "_id" : { + "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies this sample dataset.", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a shard in a Cluster. If you include existing shard replication configurations in the request, you must specify this parameter. If you add a new shard to an existing Cluster, you may specify this parameter. The request deletes any existing shards in the Cluster that you exclude from the request.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "clusterName" : { - "type" : "string", - "description" : "Human-readable label that identifies the cluster into which you loaded the sample dataset.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "readOnly" : true - }, - "completeDate" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when the sample dataset load job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", - "readOnly" : true - }, - "createDate" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when you started the sample dataset load job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", - "readOnly" : true + "regionConfigs" : { + "type" : "array", + "description" : "Hardware specifications for nodes set for a given region. 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**.\n\n**Example:**\n\nIf you set `\"replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize\" : \"M30\"`, set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : `\"M30\"` if you have electable nodes and `\"replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize\" : `\"M30\"` if you have read-only nodes.", + "items" : { + "$ref" : "#/components/schemas/CloudRegionConfig20240805" + } }, - "errorMessage" : { + "zoneId" : { "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.", + "description" : "Unique 24-hexadecimal digit string that identifies the zone in a Global Cluster. This value can be used to configure Global Cluster backup policies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "state" : { + "zoneName" : { "type" : "string", - "description" : "Status of the sample dataset load job.", - "enum" : [ "WORKING", "FAILED", "COMPLETED" ], - "readOnly" : true + "description" : "Human-readable label that describes the zone this shard belongs to in a Global Cluster. Provide this value only if \"clusterType\" : \"GEOSHARDED\" but not \"selfManagedSharding\" : true." } - } + }, + "title" : "Replication Specifications" }, - "SearchDeploymentAuditTypeView" : { + "RequestAccepted" : { + "type" : "object", + "description" : "Accepted" + }, + "ResourceEventTypeView" : { "type" : "string", "description" : "Unique identifier of event type.", - "enum" : [ "SEARCH_DEPLOYMENT_CREATED", "SEARCH_DEPLOYMENT_UPDATED", "SEARCH_DEPLOYMENT_DELETED" ], - "example" : "SEARCH_DEPLOYMENT_CREATED", - "title" : "Search Deployment Audit Types" + "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], + "example" : "TAGS_MODIFIED", + "title" : "Resource Event Types" }, - "SearchDeploymentAuditView" : { + "ResourceEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "GROUP_TAGS_MODIFIED" ], + "example" : "GROUP_TAGS_MODIFIED", + "title" : "Resource Event Types" + }, + "ResourceEventViewForNdsGroup" : { "type" : "object", - "description" : "Indicates activities on decoupled search nodes.", + "description" : "Resource event reflects different activities about resources.", "properties" : { "apiKeyId" : { "type" : "string", @@ -47000,7 +50192,7 @@ "readOnly" : true }, "eventTypeName" : { - "$ref" : "#/components/schemas/SearchDeploymentAuditTypeView" + "$ref" : "#/components/schemas/ResourceEventTypeView" }, "groupId" : { "type" : "string", @@ -47051,6 +50243,7 @@ "type" : "string", "format" : "email", "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true }, "raw" : { @@ -47063,6 +50256,20 @@ "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", "readOnly" : true }, + "resourceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the resource associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resourceType" : { + "type" : "string", + "description" : "Unique identifier of resource type.", + "example" : "cluster" + }, "userId" : { "type" : "string", "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", @@ -47080,541 +50287,159 @@ "readOnly" : true } }, - "required" : [ "created", "eventTypeName", "id" ], - "title" : "Search Deployment Audits" - }, - "SearchHostStatusDetail" : { - "type" : "object", - "properties" : { - "hostname" : { - "type" : "string", - "description" : "Hostname that corresponds to the status detail." - }, - "mainIndex" : { - "$ref" : "#/components/schemas/SearchMainIndexStatusDetail" - }, - "queryable" : { - "type" : "boolean", - "description" : "Flag that indicates whether the index is queryable on the host." - }, - "stagedIndex" : { - "$ref" : "#/components/schemas/SearchStagedIndexStatusDetail" - }, - "status" : { - "type" : "string", - "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", - "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] - } - }, - "title" : "Search Host Status Detail" - }, - "SearchIndex" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/ClusterSearchIndex" - }, { - "type" : "object", - "properties" : { - "analyzer" : { - "type" : "string", - "default" : "lucene.standard", - "description" : "Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves a variety of changes made to the text in fields:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\n MongoDB Cloud uses the selected process to build the Atlas Search index.", - "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ], - "externalDocs" : { - "description" : "Atlas Search Analyzers", - "url" : "https://dochub.mongodb.org/core/analyzers--fts" - } - }, - "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" - }, - "items" : { - "$ref" : "#/components/schemas/ApiAtlasFTSAnalyzersViewManual" - } - }, - "mappings" : { - "$ref" : "#/components/schemas/ApiAtlasFTSMappingsViewManual" - }, - "searchAnalyzer" : { - "type" : "string", - "default" : "lucene.standard", - "description" : "Method applied to identify words when searching this index.", - "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] - }, - "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" - }, - "items" : { - "$ref" : "#/components/schemas/SearchSynonymMappingDefinition" - } - } - } - } ], - "required" : [ "collectionName", "database", "name" ] - }, - "SearchIndexCreateRequest" : { - "type" : "object", - "discriminator" : { - "mapping" : { - "search" : "#/components/schemas/TextSearchIndexCreateRequest", - "vectorSearch" : "#/components/schemas/VectorSearchIndexCreateRequest" - }, - "propertyName" : "type" - }, - "properties" : { - "collectionName" : { - "type" : "string", - "description" : "Label that identifies the collection to create an Atlas Search index in." - }, - "database" : { - "type" : "string", - "description" : "Label that identifies the database that contains the collection to create an Atlas Search index in." - }, - "name" : { - "type" : "string", - "description" : "Label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique." - }, - "type" : { - "type" : "string", - "description" : "Type of the index. The default type is search.", - "enum" : [ "search", "vectorSearch" ] - } - }, - "required" : [ "collectionName", "database", "name" ] - }, - "SearchIndexDefinition" : { - "type" : "object", - "description" : "The search index definition set by the user.", - "title" : "Search Index Definition" - }, - "SearchIndexDefinitionVersion" : { - "type" : "object", - "description" : "Object which includes the version number of the index definition and the time that the index definition was created.", - "properties" : { - "createdAt" : { - "type" : "string", - "format" : "date-time", - "description" : "The time at which this index definition was created." - }, - "version" : { - "type" : "integer", - "format" : "int64", - "description" : "The version number associated with this index definition when it was created." - } - }, - "title" : "Search Index Definition Version" + "required" : [ "created", "eventTypeName", "id", "resourceType" ], + "title" : "Resource Events" }, - "SearchIndexResponse" : { + "ResourceEventViewForOrg" : { "type" : "object", - "discriminator" : { - "mapping" : { - "search" : "#/components/schemas/TextSearchIndexResponse", - "vectorSearch" : "#/components/schemas/VectorSearchIndexResponse" - }, - "propertyName" : "type" - }, + "description" : "Resource event reflects different activities about resources.", "properties" : { - "collectionName" : { - "type" : "string", - "description" : "Label that identifies the collection that contains one or more Atlas Search indexes." - }, - "database" : { - "type" : "string", - "description" : "Label that identifies the database that contains the collection with one or more Atlas Search indexes." - }, - "indexID" : { + "apiKeyId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies this Atlas Search index.", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" - }, - "latestDefinition" : { - "$ref" : "#/components/schemas/SearchIndexDefinition" - }, - "latestDefinitionVersion" : { - "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" - }, - "name" : { - "type" : "string", - "description" : "Label that identifies this index. Within each namespace, the names of all indexes must be unique." - }, - "queryable" : { - "type" : "boolean", - "description" : "Flag that indicates whether the index is queryable on all hosts." - }, - "status" : { - "type" : "string", - "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", - "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] - }, - "statusDetail" : { - "type" : "array", - "description" : "List of documents detailing index status on each host.", - "items" : { - "$ref" : "#/components/schemas/SearchHostStatusDetail" - } - }, - "type" : { - "type" : "string", - "description" : "Type of the index. The default type is search.", - "enum" : [ "search", "vectorSearch" ] - } - }, - "title" : "Search Index Response" - }, - "SearchIndexUpdateRequest" : { - "type" : "object", - "properties" : { - "definition" : { - "type" : "object", - "description" : "The index definition to update the search index to.", - "oneOf" : [ { - "$ref" : "#/components/schemas/TextSearchIndexDefinition" - }, { - "$ref" : "#/components/schemas/VectorSearchIndexDefinition" - } ] - } - }, - "required" : [ "definition" ], - "title" : "Search Index Update Request" - }, - "SearchMainIndexStatusDetail" : { - "type" : "object", - "description" : "Contains status information about the active index.", - "properties" : { - "definition" : { - "$ref" : "#/components/schemas/SearchIndexDefinition" - }, - "definitionVersion" : { - "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" - }, - "message" : { - "type" : "string", - "description" : "Optional message describing an error." - }, - "queryable" : { - "type" : "boolean", - "description" : "Flag that indicates whether the index generation is queryable on the host." - }, - "status" : { - "type" : "string", - "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", - "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] - } - }, - "title" : "Search Main Index Status Detail" - }, - "SearchMappings" : { - "type" : "object", - "description" : "Index specifications for the collection's fields.", - "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/field-mapping-definition-fts#static-and-dynamic-mappings" - } - }, - "fields" : { - "type" : "object", - "additionalProperties" : { - "type" : "object", - "description" : "One or more field specifications for the Atlas Search index. Required if **mappings.dynamic** is omitted or set to **false**.", - "externalDocs" : { - "description" : "Atlas Search Index", - "url" : "https://dochub.mongodb.org/core/index-definitions-fts" - }, - "x-additionalPropertiesName" : "Field Name" - }, - "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" - }, - "x-additionalPropertiesName" : "Field Name" - } - }, - "title" : "Mappings" - }, - "SearchStagedIndexStatusDetail" : { - "type" : "object", - "description" : "Contains status information about an index building in the background.", - "properties" : { - "definition" : { - "$ref" : "#/components/schemas/SearchIndexDefinition" - }, - "definitionVersion" : { - "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" - }, - "message" : { - "type" : "string", - "description" : "Optional message describing an error." - }, - "queryable" : { - "type" : "boolean", - "description" : "Flag that indicates whether the index generation is queryable on the host." + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "status" : { - "type" : "string", - "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", - "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] - } - }, - "title" : "Search Staged Index Status Detail" - }, - "SearchSynonymMappingDefinition" : { - "type" : "object", - "description" : "Synonyms used for this full text index.", - "properties" : { - "analyzer" : { + "created" : { "type" : "string", - "description" : "Specific pre-defined method chosen to apply to the synonyms to be searched.", - "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true }, - "name" : { - "type" : "string", - "description" : "Label that identifies the synonym definition. Each **synonym.name** must be unique within the same index definition." + "eventTypeName" : { + "$ref" : "#/components/schemas/ResourceEventTypeViewForOrg" }, - "source" : { - "$ref" : "#/components/schemas/SynonymSource" - } - }, - "required" : [ "analyzer", "name", "source" ], - "title" : "Synonym Mapping Definition" - }, - "ServerlessAWSTenantEndpoint" : { - "type" : "object", - "description" : "View for a serverless AWS tenant endpoint.", - "properties" : { - "_id" : { + "groupId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "cloudProviderEndpointId" : { - "type" : "string", - "description" : "Unique string that identifies the private endpoint's network interface.", - "pattern" : "^vpce-[0-9a-f]{17}$", - "readOnly" : true - }, - "comment" : { - "type" : "string", - "description" : "Human-readable comment associated with the private endpoint.", - "maxLength" : 80, - "readOnly" : true - }, - "endpointServiceName" : { + "id" : { "type" : "string", - "description" : "Unique string that identifies the Amazon Web Services (AWS) PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", - "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "errorMessage" : { - "type" : "string", - "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", "readOnly" : true }, - "providerName" : { - "type" : "string", - "description" : "Human-readable label that identifies the cloud service provider.", - "enum" : [ "AWS" ], + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, "readOnly" : true }, - "status" : { - "type" : "string", - "description" : "Human-readable label that indicates the current operating status of the private endpoint.", - "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], - "readOnly" : true - } - }, - "title" : "AWS" - }, - "ServerlessAWSTenantEndpointUpdate" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" - }, { - "type" : "object", - "properties" : { - "cloudProviderEndpointId" : { - "type" : "string", - "description" : "Unique string that identifies the private endpoint's network interface.", - "pattern" : "^vpce-[0-9a-f]{17}$", - "writeOnly" : true - } - } - } ], - "description" : "Updates to a serverless AWS tenant endpoint.", - "required" : [ "providerName" ], - "title" : "AWS" - }, - "ServerlessAzureTenantEndpoint" : { - "type" : "object", - "description" : "View for a serverless Azure tenant endpoint.", - "properties" : { - "_id" : { + "orgId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "cloudProviderEndpointId" : { - "type" : "string", - "description" : "Unique string that identifies the Azure private endpoint's network interface that someone added to this private endpoint service.", - "pattern" : "^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\\.Network/privateEndpoints/[-\\w._()]+$", - "readOnly" : true - }, - "comment" : { + "publicKey" : { "type" : "string", - "description" : "Human-readable comment associated with the private endpoint.", - "maxLength" : 80, + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true }, - "endpointServiceName" : { - "type" : "string", - "description" : "Unique string that identifies the Azure private endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", - "pattern" : "^pls_[0-9a-f]{24}$", - "readOnly" : true + "raw" : { + "$ref" : "#/components/schemas/raw" }, - "errorMessage" : { + "remoteAddress" : { "type" : "string", - "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", "readOnly" : true }, - "privateEndpointIpAddress" : { + "resourceId" : { "type" : "string", - "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "description" : "Unique 24-hexadecimal digit string that identifies the resource associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "privateLinkServiceResourceId" : { + "resourceType" : { "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 + "description" : "Unique identifier of resource type.", + "example" : "cluster" }, - "providerName" : { + "userId" : { "type" : "string", - "description" : "Human-readable label that identifies the cloud service provider.", - "enum" : [ "AZURE" ], + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "status" : { + "username" : { "type" : "string", - "description" : "Human-readable label that indicates the current operating status of the private endpoint.", - "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true } }, - "title" : "Azure" - }, - "ServerlessAzureTenantEndpointUpdate" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" - }, { - "type" : "object", - "properties" : { - "cloudProviderEndpointId" : { - "type" : "string", - "description" : "Unique string that identifies the Azure private endpoint's network interface for this private endpoint service.", - "pattern" : "^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\\.Network/privateEndpoints/[-\\w._()]+$", - "writeOnly" : true - }, - "privateEndpointIpAddress" : { - "type" : "string", - "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", - "writeOnly" : true - } - } - } ], - "description" : "Updates to a serverless Azure tenant endpoint.", - "required" : [ "providerName" ], - "title" : "AZURE" + "required" : [ "created", "eventTypeName", "id", "resourceType" ], + "title" : "Resource Events" }, - "ServerlessBackupRestoreJob" : { + "ResourceTag" : { "type" : "object", + "description" : "Key-value pair that tags and categorizes a MongoDB Cloud organization, project, or cluster. For example, `environment : production`.", "properties" : { - "cancelled" : { - "type" : "boolean", - "description" : "Flag that indicates whether someone canceled this restore job.", - "readOnly" : true - }, - "deliveryType" : { + "key" : { "type" : "string", - "description" : "Human-readable label that categorizes the restore job to create.", - "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\"`.", - "items" : { - "type" : "string", - "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download." - }, - "readOnly" : true - }, - "desiredTimestamp" : { - "$ref" : "#/components/schemas/ApiBSONTimestampView" - }, - "expired" : { - "type" : "boolean", - "description" : "Flag that indicates whether the restore job expired.", - "readOnly" : true + "description" : "Constant that defines the set of the tag. For example, `environment` in the `environment : production` tag.", + "maxLength" : 255, + "minLength" : 1 }, - "expiresAt" : { + "value" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when the restore job expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true - }, - "failed" : { - "type" : "boolean", - "description" : "Flag that indicates whether the restore job failed.", - "readOnly" : true - }, - "finishedAt" : { + "description" : "Variable that belongs to the set of the tag. For example, `production` in the `environment : production` tag.", + "maxLength" : 255, + "minLength" : 1 + } + }, + "required" : [ "key", "value" ], + "title" : "Resource Tag" + }, + "RestoreJobFileHash" : { + "type" : "object", + "description" : "Key and value pair that map one restore file to one hashed checksum. This parameter applies after you download the corresponding **delivery.url**.", + "properties" : { + "fileName" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when the restore job completed. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Human-readable label that identifies the hashed file.", "readOnly" : true }, - "id" : { + "hash" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the restore job.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "description" : "Hashed checksum that maps to the restore file.", "readOnly" : true }, "links" : { @@ -47629,87 +50454,173 @@ }, "readOnly" : true }, - "oplogInc" : { - "type" : "integer", - "format" : "int32", - "description" : "Oplog operation number from which you want to restore this snapshot. This number represents the second part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", - "example" : 1, - "minimum" : 1 + "typeName" : { + "type" : "string", + "description" : "Human-readable label that identifies the hashing algorithm used to compute the hash value.", + "enum" : [ "SHA1" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "RoleAssignment" : { + "type" : "object", + "properties" : { + "groupId" : { + "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", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" }, - "oplogTs" : { + "orgId" : { + "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", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "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.\n\nOrganization Roles\n\n* ORG_OWNER\n* ORG_MEMBER\n* ORG_GROUP_CREATOR\n* ORG_BILLING_ADMIN\n* ORG_READ_ONLY\n\nProject Roles\n\n* GROUP_CLUSTER_MANAGER\n* GROUP_DATA_ACCESS_ADMIN\n* GROUP_DATA_ACCESS_READ_ONLY\n* GROUP_DATA_ACCESS_READ_WRITE\n* GROUP_OWNER\n* GROUP_READ_ONLY\n* GROUP_SEARCH_INDEX_EDITOR\n* GROUP_STREAM_PROCESSING_OWNER\n\n", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + } + }, + "SMSNotification" : { + "type" : "object", + "description" : "SMS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { "type" : "integer", "format" : "int32", - "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`.", - "minimum" : 1199145600 + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." }, - "pointInTimeUTCSeconds" : { + "intervalMin" : { "type" : "integer", "format" : "int32", - "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`.", - "minimum" : 1199145600 + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 }, - "snapshotId" : { + "mobileNumber" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "description" : "Mobile phone number to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"SMS\"`.", + "example" : "1233337892" + }, + "notifierId" : { + "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" ] + } + }, + "required" : [ "typeName" ], + "title" : "SMS Notification" + }, + "SampleDatasetStatus" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies this sample dataset.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "targetClusterName" : { + "clusterName" : { "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\"`.", + "description" : "Human-readable label that identifies the cluster into which you loaded the sample dataset.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "readOnly" : true }, - "targetGroupId" : { + "completeDate" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the target project for the specified **targetClusterName**.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" + "format" : "date-time", + "description" : "Date and time when the sample dataset load job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true }, - "timestamp" : { + "createDate" : { "type" : "string", "format" : "date-time", - "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.", + "description" : "Date and time when you started the sample dataset load job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "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.", + "enum" : [ "WORKING", "FAILED", "COMPLETED" ], "readOnly" : true } - }, - "required" : [ "deliveryType", "targetClusterName", "targetGroupId" ] + } }, - "ServerlessBackupSnapshot" : { + "SearchDeploymentAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "SEARCH_DEPLOYMENT_CREATED", "SEARCH_DEPLOYMENT_UPDATED", "SEARCH_DEPLOYMENT_DELETED" ], + "example" : "SEARCH_DEPLOYMENT_CREATED", + "title" : "Search Deployment Audit Types" + }, + "SearchDeploymentAuditView" : { "type" : "object", + "description" : "Indicates activities on decoupled search nodes.", "properties" : { - "createdAt" : { + "apiKeyId" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "expiresAt" : { + "created" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "frequencyType" : { + "eventTypeName" : { + "$ref" : "#/components/schemas/SearchDeploymentAuditTypeView" + }, + "groupId" : { "type" : "string", - "description" : "Human-readable label that identifies how often this snapshot triggers.", - "enum" : [ "hourly", "daily", "weekly", "monthly" ], + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, "links" : { "type" : "array", "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", @@ -47722,450 +50633,445 @@ }, "readOnly" : true }, - "mongodVersion" : { + "orgId" : { "type" : "string", - "description" : "Version of the MongoDB host that this snapshot backs up.", - "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "serverlessInstanceName" : { + "publicKey" : { "type" : "string", - "description" : "Human-readable label given to the serverless instance from which MongoDB Cloud took this snapshot.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", "readOnly" : true }, - "snapshotType" : { + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { "type" : "string", - "description" : "Human-readable label that identifies when this snapshot triggers.", - "enum" : [ "onDemand", "scheduled" ], + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", "readOnly" : true }, - "status" : { + "userId" : { "type" : "string", - "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", - "enum" : [ "queued", "inProgress", "completed", "failed" ], + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "storageSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "Number of bytes taken to store the backup snapshot.", + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true } - } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Search Deployment Audits" }, - "ServerlessConnectionStringsPrivateEndpointItem" : { + "SearchHostStatusDetail" : { "type" : "object", - "description" : "Details of a private endpoint deployed for this serverless instance.", "properties" : { - "endpointId" : { + "hostname" : { "type" : "string", - "description" : "Unique string that the cloud provider uses to identify the private endpoint.", - "readOnly" : true + "description" : "Hostname that corresponds to the status detail." }, - "providerName" : { - "type" : "string", - "description" : "Cloud provider where the private endpoint is deployed.", - "enum" : [ "AWS", "AZURE" ], - "readOnly" : true + "mainIndex" : { + "$ref" : "#/components/schemas/SearchMainIndexStatusDetail" }, - "region" : { + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on the host." + }, + "stagedIndex" : { + "$ref" : "#/components/schemas/SearchStagedIndexStatusDetail" + }, + "status" : { "type" : "string", - "description" : "Region where the private endpoint is deployed.", - "readOnly" : true + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] } }, - "title" : "Serverless Instance Private Endpoint Connection Strings Endpoint" + "title" : "Search Host Status Detail" }, - "ServerlessConnectionStringsPrivateEndpointList" : { + "SearchIndex" : { "type" : "object", - "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/" + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, { + "type" : "object", + "properties" : { + "analyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves a variety of changes made to the text in fields:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\n MongoDB Cloud uses the selected process to build the Atlas Search index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ], + "externalDocs" : { + "description" : "Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/analyzers--fts" + } + }, + "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" + }, + "items" : { + "$ref" : "#/components/schemas/ApiAtlasFTSAnalyzersViewManual" + } + }, + "mappings" : { + "$ref" : "#/components/schemas/ApiAtlasFTSMappingsViewManual" + }, + "searchAnalyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Method applied to identify words when searching this index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] + }, + "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" + }, + "items" : { + "$ref" : "#/components/schemas/SearchSynonymMappingDefinition" + } + } + } + } ], + "required" : [ "collectionName", "database", "name" ] + }, + "SearchIndexCreateRequest" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "search" : "#/components/schemas/TextSearchIndexCreateRequest", + "vectorSearch" : "#/components/schemas/VectorSearchIndexCreateRequest" + }, + "propertyName" : "type" }, "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**.", - "items" : { - "$ref" : "#/components/schemas/ServerlessConnectionStringsPrivateEndpointItem" - }, - "readOnly" : true + "collectionName" : { + "type" : "string", + "description" : "Label that identifies the collection to create an Atlas Search index in." }, - "srvConnectionString" : { + "database" : { "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 + "description" : "Label that identifies the database that contains the collection to create an Atlas Search index in." + }, + "name" : { + "type" : "string", + "description" : "Label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique." }, "type" : { "type" : "string", - "description" : "MongoDB process type to which your application connects.", - "enum" : [ "MONGOS" ], - "readOnly" : true + "description" : "Type of the index. The default type is search.", + "enum" : [ "search", "vectorSearch" ] } }, - "title" : "Serverless Instance Private Endpoint Connection String" + "required" : [ "collectionName", "database", "name" ] }, - "ServerlessEventTypeViewAlertable" : { - "type" : "string", - "description" : "Event type that triggers an alert.", - "enum" : [ "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], - "example" : "OUTSIDE_SERVERLESS_METRIC_THRESHOLD", - "title" : "Serverless Event Types" + "SearchIndexDefinition" : { + "type" : "object", + "description" : "The search index definition set by the user.", + "title" : "Search Index Definition" + }, + "SearchIndexDefinitionVersion" : { + "type" : "object", + "description" : "Object which includes the version number of the index definition and the time that the index definition was created.", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "The time at which this index definition was created." + }, + "version" : { + "type" : "integer", + "format" : "int64", + "description" : "The version number associated with this index definition when it was created." + } + }, + "title" : "Search Index Definition Version" }, - "ServerlessInstanceDescription" : { + "SearchIndexResponse" : { "type" : "object", - "description" : "Group of settings that configure a MongoDB serverless instance.", - "properties" : { - "connectionStrings" : { - "$ref" : "#/components/schemas/ServerlessInstanceDescriptionConnectionStrings" + "discriminator" : { + "mapping" : { + "search" : "#/components/schemas/TextSearchIndexResponse", + "vectorSearch" : "#/components/schemas/VectorSearchIndexResponse" }, - "createDate" : { + "propertyName" : "type" + }, + "properties" : { + "collectionName" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", - "readOnly" : true + "description" : "Label that identifies the collection that contains one or more Atlas Search indexes." }, - "groupId" : { + "database" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the project.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "description" : "Label that identifies the database that contains the collection with one or more Atlas Search indexes." }, - "id" : { + "indexID" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the serverless instance.", + "description" : "Unique 24-hexadecimal digit string that identifies this Atlas Search index.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "pattern" : "^([a-f0-9]{24})$" }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true + "latestDefinition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" }, - "mongoDBVersion" : { - "type" : "string", - "description" : "Version of MongoDB that the serverless instance runs.", - "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", - "readOnly" : true + "latestDefinitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" }, "name" : { "type" : "string", - "description" : "Human-readable label that identifies the serverless instance.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - }, - "providerSettings" : { - "$ref" : "#/components/schemas/ServerlessProviderSettings" + "description" : "Label that identifies this index. Within each namespace, the names of all indexes must be unique." }, - "serverlessBackupOptions" : { - "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on all hosts." }, - "stateName" : { + "status" : { "type" : "string", - "description" : "Human-readable label that indicates the current operating condition of the serverless instance.", - "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], - "readOnly" : true + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] }, - "tags" : { + "statusDetail" : { "type" : "array", - "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", + "description" : "List of documents detailing index status on each host.", "items" : { - "$ref" : "#/components/schemas/ResourceTag" + "$ref" : "#/components/schemas/SearchHostStatusDetail" } }, - "terminationProtectionEnabled" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." + "type" : { + "type" : "string", + "description" : "Type of the index. The default type is search.", + "enum" : [ "search", "vectorSearch" ] } }, - "required" : [ "providerSettings" ], - "title" : "Serverless Instance Description" + "title" : "Search Index Response" }, - "ServerlessInstanceDescriptionConnectionStrings" : { + "SearchIndexUpdateRequest" : { "type" : "object", - "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", - "externalDocs" : { - "description" : "Connection string URI format.", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, "properties" : { - "privateEndpoint" : { - "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.", - "items" : { - "$ref" : "#/components/schemas/ServerlessConnectionStringsPrivateEndpointList" - }, - "readOnly" : true - }, - "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.", - "externalDocs" : { - "description" : "Connection String URI Format", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, - "readOnly" : true + "definition" : { + "type" : "object", + "description" : "The index definition to update the search index to.", + "oneOf" : [ { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + }, { + "$ref" : "#/components/schemas/VectorSearchIndexDefinition" + } ] } }, - "readOnly" : true, - "title" : "Serverless Instance Connection Strings" + "required" : [ "definition" ], + "title" : "Search Index Update Request" }, - "ServerlessInstanceDescriptionCreate" : { + "SearchMainIndexStatusDetail" : { "type" : "object", - "description" : "Settings that you can specify when you create a serverless instance.", + "description" : "Contains status information about the active index.", "properties" : { - "name" : { - "type" : "string", - "description" : "Human-readable label that identifies the serverless instance.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "writeOnly" : true - }, - "providerSettings" : { - "$ref" : "#/components/schemas/ServerlessProviderSettings" + "definition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" }, - "serverlessBackupOptions" : { - "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" }, - "stateName" : { + "message" : { "type" : "string", - "description" : "Human-readable label that indicates the current operating condition of the serverless instance.", - "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], - "readOnly" : true - }, - "tags" : { - "type" : "array", - "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", - "items" : { - "$ref" : "#/components/schemas/ResourceTag" - } + "description" : "Optional message describing an error." }, - "terminationProtectionEnabled" : { + "queryable" : { "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." + "description" : "Flag that indicates whether the index generation is queryable on the host." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] } }, - "required" : [ "name", "providerSettings" ], - "title" : "Serverless Instance Description Create" + "title" : "Search Main Index Status Detail" }, - "ServerlessInstanceDescriptionUpdate" : { + "SearchMappings" : { "type" : "object", - "description" : "Settings that you can update when you request a serverless cluster update.", + "description" : "Index specifications for the collection's fields.", "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.", - "items" : { - "$ref" : "#/components/schemas/ResourceTag" + "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/field-mapping-definition-fts#static-and-dynamic-mappings" } }, - "terminationProtectionEnabled" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." + "fields" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "One or more field specifications for the Atlas Search index. Required if **mappings.dynamic** is omitted or set to **false**.", + "externalDocs" : { + "description" : "Atlas Search Index", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "x-additionalPropertiesName" : "Field Name" + }, + "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" + }, + "x-additionalPropertiesName" : "Field Name" } }, - "title" : "Serverless Instance Description Update" + "title" : "Mappings" }, - "ServerlessMetricAlertConfigViewForNdsGroup" : { + "SearchStagedIndexStatusDetail" : { "type" : "object", - "description" : "Serverless metric alert configuration allows to select which serverless database metrics trigger alerts and how users are notified.", + "description" : "Contains status information about an index building in the background.", "properties" : { - "created" : { + "definition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" + }, + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "message" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "description" : "Optional message describing an error." }, - "enabled" : { + "queryable" : { "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + "description" : "Flag that indicates whether the index generation is queryable on the host." }, - "eventTypeName" : { - "$ref" : "#/components/schemas/ServerlessEventTypeViewAlertable" + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Search Staged Index Status Detail" + }, + "SearchSynonymMappingDefinition" : { + "type" : "object", + "description" : "Synonyms used for this full text index.", + "properties" : { + "analyzer" : { + "type" : "string", + "description" : "Specific pre-defined method chosen to apply to the synonyms to be searched.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] }, - "groupId" : { + "name" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "description" : "Label that identifies the synonym definition. Each **synonym.name** must be unique within the same index definition." }, - "id" : { + "source" : { + "$ref" : "#/components/schemas/SynonymSource" + } + }, + "required" : [ "analyzer", "name", "source" ], + "title" : "Synonym Mapping Definition" + }, + "ServerlessAWSTenantEndpoint" : { + "type" : "object", + "description" : "View for a serverless AWS tenant endpoint.", + "properties" : { + "_id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - }, - "matchers" : { - "type" : "array", - "description" : "Matching conditions for target resources.", - "items" : { - "$ref" : "#/components/schemas/AlertMatcher" - } - }, - "metricThreshold" : { - "$ref" : "#/components/schemas/ServerlessMetricThreshold" - }, - "notifications" : { - "type" : "array", - "description" : "List that contains the targets that MongoDB Cloud sends notifications.", - "items" : { - "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" - } - }, - "updated" : { + "cloudProviderEndpointId" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Unique string that identifies the private endpoint's network interface.", + "pattern" : "^vpce-[0-9a-f]{17}$", "readOnly" : true - } - }, - "required" : [ "eventTypeName", "notifications" ], - "title" : "Serverless Alert Configuration" - }, - "ServerlessMetricThreshold" : { - "type" : "object", - "description" : "Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.", - "discriminator" : { - "mapping" : { - "SERVERLESS_AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", - "SERVERLESS_AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", - "SERVERLESS_AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", - "SERVERLESS_CONNECTIONS" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricThresholdView", - "SERVERLESS_NETWORK_BYTES_IN" : "#/components/schemas/DataMetricThresholdView", - "SERVERLESS_NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricThresholdView", - "SERVERLESS_NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_OPCOUNTER_CMD" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_OPCOUNTER_QUERY" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_TOTAL_READ_UNITS" : "#/components/schemas/RPUMetricThresholdView", - "SERVERLESS_TOTAL_WRITE_UNITS" : "#/components/schemas/RPUMetricThresholdView" }, - "propertyName" : "metricName" - }, - "properties" : { - "metricName" : { + "comment" : { "type" : "string", - "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "readOnly" : true }, - "mode" : { + "endpointServiceName" : { "type" : "string", - "description" : "MongoDB Cloud computes the current metric value as an average.", - "enum" : [ "AVERAGE" ] - }, - "operator" : { - "$ref" : "#/components/schemas/Operator" - }, - "threshold" : { - "type" : "number", - "format" : "double", - "description" : "Value of metric that, when exceeded, triggers an alert." + "description" : "Unique string that identifies the Amazon Web Services (AWS) PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}", + "readOnly" : true }, - "units" : { - "type" : "string", - "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", - "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] - } - }, - "required" : [ "metricName" ], - "title" : "Serverless Metric Threshold" - }, - "ServerlessMetricUnits" : { - "type" : "string", - "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", - "enum" : [ "RPU", "THOUSAND_RPU", "MILLION_RPU", "WPU", "THOUSAND_WPU", "MILLION_WPU" ], - "example" : "RPU", - "title" : "Serverless Metric Units" - }, - "ServerlessProviderSettings" : { - "type" : "object", - "description" : "Group of cloud provider settings that configure the provisioned MongoDB serverless instance.", - "properties" : { - "backingProviderName" : { + "errorMessage" : { "type" : "string", - "description" : "Cloud service provider on which MongoDB Cloud provisioned the serverless instance.", - "enum" : [ "AWS", "AZURE", "GCP" ] + "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", + "readOnly" : true }, "providerName" : { "type" : "string", - "default" : "SERVERLESS", "description" : "Human-readable label that identifies the cloud service provider.", - "enum" : [ "SERVERLESS" ] + "enum" : [ "AWS" ], + "readOnly" : true }, - "regionName" : { + "status" : { "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/)." + "description" : "Human-readable label that indicates the current operating status of the private endpoint.", + "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true } }, - "required" : [ "backingProviderName", "regionName" ], - "title" : "Cloud Service Provider Settings for a Serverless Instance" + "title" : "AWS" }, - "ServerlessTenantCreateRequest" : { + "ServerlessAWSTenantEndpointUpdate" : { "type" : "object", - "properties" : { - "comment" : { - "type" : "string", - "description" : "Human-readable comment associated with the private endpoint.", - "maxLength" : 80, - "writeOnly" : true + "allOf" : [ { + "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" + }, { + "type" : "object", + "properties" : { + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface.", + "pattern" : "^vpce-[0-9a-f]{17}$", + "writeOnly" : true + } } - } + } ], + "description" : "Updates to a serverless AWS tenant endpoint.", + "required" : [ "providerName" ], + "title" : "AWS" }, - "ServerlessTenantEndpoint" : { + "ServerlessAzureTenantEndpoint" : { "type" : "object", - "oneOf" : [ { - "$ref" : "#/components/schemas/ServerlessAWSTenantEndpoint" - }, { - "$ref" : "#/components/schemas/ServerlessAzureTenantEndpoint" - } ], + "description" : "View for a serverless Azure tenant endpoint.", "properties" : { "_id" : { "type" : "string", @@ -48178,7 +51084,8 @@ }, "cloudProviderEndpointId" : { "type" : "string", - "description" : "Unique string that identifies the private endpoint's network interface.", + "description" : "Unique string that identifies the Azure private endpoint's network interface that someone added to this private endpoint service.", + "pattern" : "^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\\.Network/privateEndpoints/[-\\w._()]+$", "readOnly" : true }, "comment" : { @@ -48189,8 +51096,8 @@ }, "endpointServiceName" : { "type" : "string", - "description" : "Unique string that identifies the PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", - "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}|pls_[0-9a-f]{24}$", + "description" : "Unique string that identifies the Azure private endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^pls_[0-9a-f]{24}$", "readOnly" : true }, "errorMessage" : { @@ -48198,112 +51105,113 @@ "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", "readOnly" : true }, - "status" : { + "privateEndpointIpAddress" : { "type" : "string", - "description" : "Human-readable label that indicates the current operating status of the private endpoint.", - "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", "readOnly" : true - } - } - }, - "ServerlessTenantEndpointUpdate" : { - "type" : "object", - "description" : "Update view for a serverless tenant endpoint.", - "discriminator" : { - "mapping" : { - "AWS" : "#/components/schemas/ServerlessAWSTenantEndpointUpdate", - "AZURE" : "#/components/schemas/ServerlessAzureTenantEndpointUpdate" }, - "propertyName" : "providerName" - }, - "properties" : { - "comment" : { + "privateLinkServiceResourceId" : { "type" : "string", - "description" : "Human-readable comment associated with the private endpoint.", - "maxLength" : 80, - "writeOnly" : true + "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 provider of the tenant endpoint.", - "enum" : [ "AWS", "AZURE" ], - "writeOnly" : true + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "AZURE" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating status of the private endpoint.", + "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true } }, - "required" : [ "providerName" ] - }, - "ServiceAccountEventTypeViewForNdsGroup" : { - "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" ], - "title" : "Service Account Event Types" - }, - "ServiceAccountEventTypeViewForOrg" : { - "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" ], - "title" : "Service Account Event Types" + "title" : "Azure" }, - "ServiceAccountGroup" : { + "ServerlessAzureTenantEndpointUpdate" : { "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "allOf" : [ { + "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" + }, { + "type" : "object", + "properties" : { + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure private endpoint's network interface for this private endpoint service.", + "pattern" : "^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\\.Network/privateEndpoints/[-\\w._()]+$", + "writeOnly" : true + }, + "privateEndpointIpAddress" : { + "type" : "string", + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "writeOnly" : true + } } - } + } ], + "description" : "Updates to a serverless Azure tenant endpoint.", + "required" : [ "providerName" ], + "title" : "AZURE" }, - "ServiceAccountGroupEvents" : { + "ServerlessBackupRestoreJob" : { "type" : "object", - "description" : "Service Account event identifies different activities around user api keys.", "properties" : { - "apiKeyId" : { + "cancelled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone canceled this restore job.", + "readOnly" : true + }, + "deliveryType" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "description" : "Human-readable label that categorizes the restore job to create.", + "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\"`.", + "items" : { + "type" : "string", + "description" : "One Uniform Resource Locator that points to the compressed snapshot files for manual download." + }, "readOnly" : true }, - "created" : { + "desiredTimestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "expired" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job expired.", + "readOnly" : true + }, + "expiresAt" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Date and time when the restore job expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "eventTypeName" : { - "$ref" : "#/components/schemas/ServiceAccountEventTypeViewForNdsGroup" + "failed" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job failed.", + "readOnly" : true }, - "groupId" : { + "finishedAt" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "format" : "date-time", + "description" : "Date and time when the restore job completed. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "description" : "Unique 24-hexadecimal character string that identifies the restore job.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "isGlobalAdmin" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", - "readOnly" : true - }, "links" : { "type" : "array", "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", @@ -48316,98 +51224,87 @@ }, "readOnly" : true }, - "orgId" : { + "oplogInc" : { + "type" : "integer", + "format" : "int32", + "description" : "Oplog operation number from which you want to restore this snapshot. This number represents the second part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", + "example" : 1, + "minimum" : 1 + }, + "oplogTs" : { + "type" : "integer", + "format" : "int32", + "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`.", + "minimum" : 1199145600 + }, + "pointInTimeUTCSeconds" : { + "type" : "integer", + "format" : "int32", + "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`.", + "minimum" : 1199145600 + }, + "snapshotId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "publicKey" : { - "type" : "string", - "format" : "email", - "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "example" : "test.user@mongodb.com", - "readOnly" : true - }, - "raw" : { - "$ref" : "#/components/schemas/raw" + "pattern" : "^([a-f0-9]{24})$" }, - "remoteAddress" : { + "targetClusterName" : { "type" : "string", - "description" : "IPv4 or IPv6 address from which the user triggered this event.", - "example" : "216.172.40.186", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", - "readOnly" : true + "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\"`.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, - "userId" : { + "targetGroupId" : { "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.", + "description" : "Unique 24-hexadecimal digit string that identifies the target project for the specified **targetClusterName**.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "pattern" : "^([a-f0-9]{24})$" }, - "username" : { + "timestamp" : { "type" : "string", - "format" : "email", - "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", - "example" : "test.user@mongodb.com", + "format" : "date-time", + "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.", "readOnly" : true } }, - "required" : [ "created", "eventTypeName", "id" ], - "title" : "ServiceAccount Events" + "required" : [ "deliveryType", "targetClusterName", "targetGroupId" ] }, - "ServiceAccountOrgEvents" : { + "ServerlessBackupSnapshot" : { "type" : "object", - "description" : "Service Account event identifies different activities around user api keys.", "properties" : { - "apiKeyId" : { + "createdAt" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "created" : { + "expiresAt" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "eventTypeName" : { - "$ref" : "#/components/schemas/ServiceAccountEventTypeViewForOrg" - }, - "groupId" : { + "frequencyType" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "description" : "Human-readable label that identifies how often this snapshot triggers.", + "enum" : [ "hourly", "daily", "weekly", "monthly" ], "readOnly" : true }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "isGlobalAdmin" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", - "readOnly" : true - }, "links" : { "type" : "array", "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", @@ -48420,332 +51317,278 @@ }, "readOnly" : true }, - "orgId" : { + "mongodVersion" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "description" : "Version of the MongoDB host that this snapshot backs up.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", "readOnly" : true }, - "publicKey" : { + "serverlessInstanceName" : { "type" : "string", - "format" : "email", - "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "example" : "test.user@mongodb.com", + "description" : "Human-readable label given to the serverless instance from which MongoDB Cloud took this snapshot.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, - "raw" : { - "$ref" : "#/components/schemas/raw" - }, - "remoteAddress" : { + "snapshotType" : { "type" : "string", - "description" : "IPv4 or IPv6 address from which the user triggered this event.", - "example" : "216.172.40.186", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "description" : "Human-readable label that identifies when this snapshot triggers.", + "enum" : [ "onDemand", "scheduled" ], "readOnly" : true }, - "userId" : { + "status" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", + "enum" : [ "queued", "inProgress", "completed", "failed" ], "readOnly" : true }, - "username" : { - "type" : "string", - "format" : "email", - "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", - "example" : "test.user@mongodb.com", + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of bytes taken to store the backup snapshot.", "readOnly" : true } - }, - "required" : [ "created", "eventTypeName", "id" ], - "title" : "ServiceAccount Events" + } }, - "ServiceAccountSecret" : { + "ServerlessConnectionStringsPrivateEndpointItem" : { "type" : "object", + "description" : "Details of a private endpoint deployed for this serverless instance.", "properties" : { - "createdAt" : { + "endpointId" : { "type" : "string", - "format" : "date-time", - "description" : "Timestamp representing creation time.", + "description" : "Unique string that the cloud provider uses to identify the private endpoint.", "readOnly" : true }, - "expiresAt" : { + "providerName" : { "type" : "string", - "format" : "date-time", - "description" : "Timestamp representing secret expiration time.", + "description" : "Cloud provider where the private endpoint is deployed.", + "enum" : [ "AWS", "AZURE" ], "readOnly" : true }, - "id" : { + "region" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the secret.", - "example" : "32b6e34b3d91647abb20e7b8", - "pattern" : "^([a-f0-9]{24})$", + "description" : "Region where the private endpoint is deployed.", "readOnly" : true - }, - "lastUsedAt" : { - "type" : "string", - "format" : "date-time", - "description" : "Timestamp representing last secret usage.", + } + }, + "title" : "Serverless Instance Private Endpoint Connection Strings Endpoint" + }, + "ServerlessConnectionStringsPrivateEndpointList" : { + "type" : "object", + "description" : "Private endpoint connection string that you can use to connect to this serverless instance through a private endpoint.", + "externalDocs" : { + "description" : "Private Endpoint for Serverless Instance", + "url" : "https://docs.atlas.mongodb.com/security-serverless-private-endpoint/" + }, + "properties" : { + "endpoints" : { + "type" : "array", + "description" : "List that contains the private endpoints through which you connect to MongoDB Cloud when you use **connectionStrings.privateEndpoint[n].srvConnectionString**.", + "items" : { + "$ref" : "#/components/schemas/ServerlessConnectionStringsPrivateEndpointItem" + }, "readOnly" : true }, - "maskedSecretValue" : { + "srvConnectionString" : { "type" : "string", - "description" : "Service Account secret with masked values of the first 20 characters.", - "example" : "mdb_ic_sk_...12ce", + "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 }, - "secret" : { + "type" : { "type" : "string", - "description" : "Secret for the service account. It will be returned only the first time after service account creation.", - "pattern" : "^mdb_sa_sk_[0-9a-zA-Z]{40}$", + "description" : "MongoDB process type to which your application connects.", + "enum" : [ "MONGOS" ], "readOnly" : true } }, - "required" : [ "createdAt", "expiresAt", "id" ] + "title" : "Serverless Instance Private Endpoint Connection String" }, - "ServiceAccountSecretRequest" : { - "type" : "object", - "properties" : { - "secretExpiresAfterHours" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of hours representing validity duration for secret." - } - }, - "required" : [ "secretExpiresAfterHours" ] + "ServerlessEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], + "example" : "OUTSIDE_SERVERLESS_METRIC_THRESHOLD", + "title" : "Serverless Event Types" }, - "ShardEntry" : { + "ServerlessInstanceDescription" : { "type" : "object", - "description" : "Sharding configuration for a collection to be sharded on the destination cluster.", + "description" : "Group of settings that configure a MongoDB serverless instance.", "properties" : { - "collection" : { + "connectionStrings" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescriptionConnectionStrings" + }, + "createDate" : { "type" : "string", - "description" : "Human-readable label that identifies the collection to be sharded on the destination cluster.", - "writeOnly" : true + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true }, - "database" : { + "groupId" : { "type" : "string", - "description" : "Human-readable label that identifies the database that contains the collection to be sharded on the destination cluster.", - "writeOnly" : true + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "shardCollection" : { - "$ref" : "#/components/schemas/ShardKeys" - } - }, - "required" : [ "collection", "database", "shardCollection" ] - }, - "ShardKeys" : { - "type" : "object", - "description" : "Document that configures the shard key on the destination cluster.", - "properties" : { - "key" : { - "type" : "array", - "description" : "List of fields to use for the shard key.", - "items" : { - "type" : "object", - "additionalProperties" : { - "type" : "object" - } - }, - "uniqueItems" : true, - "writeOnly" : true - } - }, - "writeOnly" : true - }, - "ShardingRequest" : { - "type" : "object", - "description" : "Document that configures sharding on the destination cluster when migrating from a replica set source to a sharded cluster destination on MongoDB 6.0 or higher. If you don't wish to shard any collections on the destination cluster, leave this empty.", - "properties" : { - "createSupportingIndexes" : { - "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 + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the serverless instance.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "shardingEntries" : { + "links" : { "type" : "array", - "description" : "List of shard configurations to shard destination collections. Atlas shards only those collections that you include in the sharding entries array.", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, "items" : { - "$ref" : "#/components/schemas/ShardEntry" + "$ref" : "#/components/schemas/Link" }, - "uniqueItems" : true, - "writeOnly" : true - } - }, - "required" : [ "createSupportingIndexes" ], - "writeOnly" : true - }, - "Slack" : { - "type" : "object", - "description" : "Details to integrate one Slack account with one MongoDB Cloud project.", - "properties" : { - "apiToken" : { + "readOnly" : true + }, + "mongoDBVersion" : { "type" : "string", - "description" : "Key that allows MongoDB Cloud to access your Slack account.\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.\n\n**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" + "description" : "Version of MongoDB that the serverless instance runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true }, - "channelName" : { + "name" : { "type" : "string", - "description" : "Name of the Slack channel to which MongoDB Cloud sends alert notifications.", - "example" : "alerts", - "maxLength" : 80, + "description" : "Human-readable label that identifies the serverless instance.", + "maxLength" : 64, "minLength" : 1, - "nullable" : true + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, - "id" : { - "type" : "string", - "description" : "Integration id.", - "nullable" : true + "providerSettings" : { + "$ref" : "#/components/schemas/ServerlessProviderSettings" }, - "teamName" : { - "type" : "string", - "description" : "Human-readable label that identifies your Slack team. Set this parameter when you configure a legacy Slack integration.", - "example" : "MongoDB" + "serverlessBackupOptions" : { + "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" }, - "type" : { + "stateName" : { "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" : "Human-readable label that indicates the current operating condition of the serverless instance.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." } }, - "required" : [ "apiToken", "channelName" ], - "title" : "SLACK" + "required" : [ "providerSettings" ], + "title" : "Serverless Instance Description" }, - "SlackNotification" : { + "ServerlessInstanceDescriptionConnectionStrings" : { "type" : "object", - "description" : "Slack notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, "properties" : { - "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", - "format" : "int32", - "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." - }, - "integrationId" : { - "type" : "string", - "description" : "The id of the associated integration, the credentials of which to use for requests.", - "example" : "32b6e34b3d91647abb20e7b8" - }, - "intervalMin" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", - "minimum" : 5 - }, - "notifierId" : { - "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" + "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.", + "items" : { + "$ref" : "#/components/schemas/ServerlessConnectionStringsPrivateEndpointList" + }, + "readOnly" : true }, - "typeName" : { + "standardSrv" : { "type" : "string", - "description" : "Human-readable label that displays the alert notification type.", - "enum" : [ "SLACK" ] + "description" : "Public connection string that you can use to connect to this serverless instance. This connection string uses the `mongodb+srv://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true } }, - "required" : [ "typeName" ], - "title" : "Slack Notification" + "readOnly" : true, + "title" : "Serverless Instance Connection Strings" }, - "Source" : { + "ServerlessInstanceDescriptionCreate" : { "type" : "object", - "description" : "Document that describes the source of the migration.", + "description" : "Settings that you can specify when you create a serverless instance.", "properties" : { - "caCertificatePath" : { + "name" : { "type" : "string", - "description" : "Path to the CA certificate that signed SSL certificates use to authenticate to the source cluster." + "description" : "Human-readable label that identifies the serverless instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "writeOnly" : true }, - "clusterName" : { - "type" : "string", - "description" : "Label that identifies the source cluster name." + "providerSettings" : { + "$ref" : "#/components/schemas/ServerlessProviderSettings" }, - "groupId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the source project.", - "example" : "9b43a5b329223c3a1591a678", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" + "serverlessBackupOptions" : { + "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" }, - "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." + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the serverless instance.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true }, - "password" : { - "type" : "string", - "description" : "Password that authenticates the username to the source cluster.", - "writeOnly" : true + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } }, - "ssl" : { + "terminationProtectionEnabled" : { "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 - } - }, - "required" : [ "clusterName", "groupId", "managedAuthentication", "ssl" ] - }, - "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/" + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." } }, - "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/" - } + "required" : [ "name", "providerSettings" ], + "title" : "Serverless Instance Description Create" }, - "StreamConfig" : { + "ServerlessInstanceDescriptionUpdate" : { "type" : "object", - "description" : "Configuration options for an Atlas Stream Processing Instance.", - "nullable" : true, + "description" : "Settings that you can update when you request a serverless cluster update.", "properties" : { - "links" : { + "serverlessBackupOptions" : { + "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" + }, + "tags" : { "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true + "$ref" : "#/components/schemas/ResourceTag" + } }, - "tier" : { - "type" : "string", - "description" : "Selected tier for the Stream Instance. Configures Memory / VCPU allowances.", - "enum" : [ "SP30", "SP10" ], - "title" : "Stream Instance Tier" + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." } - } + }, + "title" : "Serverless Instance Description Update" }, - "StreamProcessorAlertConfigViewForNdsGroup" : { + "ServerlessMetricAlertConfigViewForNdsGroup" : { "type" : "object", - "description" : "Host metric alert configuration allows to select which Atlas streams processors trigger alerts and how users are notified.", + "description" : "Serverless metric alert configuration allows to select which serverless database metrics trigger alerts and how users are notified.", "properties" : { "created" : { "type" : "string", @@ -48759,7 +51602,7 @@ "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." }, "eventTypeName" : { - "$ref" : "#/components/schemas/StreamProcessorEventTypeViewAlertable" + "$ref" : "#/components/schemas/ServerlessEventTypeViewAlertable" }, "groupId" : { "type" : "string", @@ -48793,11 +51636,14 @@ }, "matchers" : { "type" : "array", - "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration.", + "description" : "Matching conditions for target resources.", "items" : { - "$ref" : "#/components/schemas/StreamsMatcher" + "$ref" : "#/components/schemas/AlertMatcher" } }, + "metricThreshold" : { + "$ref" : "#/components/schemas/ServerlessMetricThreshold" + }, "notifications" : { "type" : "array", "description" : "List that contains the targets that MongoDB Cloud sends notifications.", @@ -48813,157 +51659,215 @@ } }, "required" : [ "eventTypeName", "notifications" ], - "title" : "Stream Processor Alert Configuration" + "title" : "Serverless Alert Configuration" }, - "StreamProcessorAlertViewForNdsGroup" : { + "ServerlessMetricThreshold" : { "type" : "object", - "description" : "Stream Processor alert notifies about activities on Stream Processor in AtlasStreams.", + "description" : "Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.", + "discriminator" : { + "mapping" : { + "SERVERLESS_AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_CONNECTIONS" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_BYTES_IN" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_CMD" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_QUERY" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_TOTAL_READ_UNITS" : "#/components/schemas/RPUMetricThresholdView", + "SERVERLESS_TOTAL_WRITE_UNITS" : "#/components/schemas/RPUMetricThresholdView" + }, + "propertyName" : "metricName" + }, "properties" : { - "acknowledgedUntil" : { + "metricName" : { "type" : "string", - "format" : "date-time", - "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.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." }, - "acknowledgementComment" : { + "mode" : { "type" : "string", - "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", - "example" : "Expiration on 3/19. Silencing for 7days.", - "maxLength" : 200 + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] }, - "acknowledgingUsername" : { + "operator" : { "type" : "string", - "format" : "email", - "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", - "readOnly" : true + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, - "alertConfigId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." }, - "created" : { + "units" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true - }, - "eventTypeName" : { - "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroupAlertable" - }, - "groupId" : { + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] + } + }, + "required" : [ "metricName" ], + "title" : "Serverless Metric Threshold" + }, + "ServerlessMetricUnits" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "RPU", "THOUSAND_RPU", "MILLION_RPU", "WPU", "THOUSAND_WPU", "MILLION_WPU" ], + "example" : "RPU", + "title" : "Serverless Metric Units" + }, + "ServerlessProviderSettings" : { + "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB serverless instance.", + "properties" : { + "backingProviderName" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "description" : "Cloud service provider on which MongoDB Cloud provisioned the serverless instance.", + "enum" : [ "AWS", "AZURE", "GCP" ] }, - "id" : { + "providerName" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies this alert.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "default" : "SERVERLESS", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "SERVERLESS" ] }, - "instanceName" : { + "regionName" : { "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.", - "example" : "foobar", - "readOnly" : true - }, - "lastNotified" : { + "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/)." + } + }, + "required" : [ "backingProviderName", "regionName" ], + "title" : "Cloud Service Provider Settings for a Serverless Instance" + }, + "ServerlessTenantCreateRequest" : { + "type" : "object", + "properties" : { + "comment" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", - "readOnly" : true - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - }, - "orgId" : { + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "writeOnly" : true + } + } + }, + "ServerlessTenantEndpoint" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/ServerlessAWSTenantEndpoint" + }, { + "$ref" : "#/components/schemas/ServerlessAzureTenantEndpoint" + } ], + "properties" : { + "_id" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "processorErrorMsg" : { + "cloudProviderEndpointId" : { "type" : "string", - "description" : "The error message associated with the Stream Processor to which this alert applies.", - "example" : "MongoServerError: Failed to start stream processor: (Location77175) Could not connect to the Kafka topic with kafka error code: -195, message: Local: Broker transport failure.: (Location77175)", + "description" : "Unique string that identifies the private endpoint's network interface.", "readOnly" : true }, - "processorName" : { + "comment" : { "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.", - "example" : "foobar", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, "readOnly" : true }, - "processorState" : { + "endpointServiceName" : { "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.", - "example" : "STARTED", + "description" : "Unique string that identifies the PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}|pls_[0-9a-f]{24}$", "readOnly" : true }, - "resolved" : { + "errorMessage" : { "type" : "string", - "format" : "date-time", - "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\"`.", + "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", "readOnly" : true }, "status" : { "type" : "string", - "description" : "State of this alert at the time you requested its details.", - "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], - "example" : "OPEN", + "description" : "Human-readable label that indicates the current operating status of the private endpoint.", + "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], "readOnly" : true + } + } + }, + "ServerlessTenantEndpointUpdate" : { + "type" : "object", + "description" : "Update view for a serverless tenant endpoint.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/ServerlessAWSTenantEndpointUpdate", + "AZURE" : "#/components/schemas/ServerlessAzureTenantEndpointUpdate" }, - "updated" : { + "propertyName" : "providerName" + }, + "properties" : { + "comment" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "writeOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider of the tenant endpoint.", + "enum" : [ "AWS", "AZURE" ], + "writeOnly" : true } }, - "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], - "title" : "Stream Processor Alerts" + "required" : [ "providerName" ] }, - "StreamProcessorEventTypeViewAlertable" : { + "ServiceAccountEventTypeViewForNdsGroup" : { "type" : "string", - "description" : "Event type that triggers an alert.", - "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], - "example" : "STREAM_PROCESSOR_STATE_IS_FAILED", - "title" : "Stream Processor Event Types" + "description" : "Unique identifier of event type.", + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" }, - "StreamProcessorEventTypeViewForNdsGroup" : { + "ServiceAccountEventTypeViewForOrg" : { "type" : "string", "description" : "Unique identifier of event type.", - "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], - "example" : "STREAM_PROCESSOR_STATE_IS_FAILED", - "title" : "Stream Processor Event Types" + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" }, - "StreamProcessorEventViewForNdsGroup" : { + "ServiceAccountGroup" : { "type" : "object", - "description" : "Stream Processor event identifies different activities about a stream processor in Atlas Streams.", "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies your project. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "ServiceAccountGroupEvents" : { + "type" : "object", + "description" : "Service Account event identifies different activities around user api keys.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, "created" : { "type" : "string", "format" : "date-time", @@ -48971,7 +51875,7 @@ "readOnly" : true }, "eventTypeName" : { - "$ref" : "#/components/schemas/StreamProcessorEventTypeViewForNdsGroup" + "$ref" : "#/components/schemas/ServiceAccountEventTypeViewForNdsGroup" }, "groupId" : { "type" : "string", @@ -48991,10 +51895,10 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "instanceName" : { - "type" : "string", - "description" : "Name of the stream processing instance associated with the event.", - "example" : "foobar", + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", "readOnly" : true }, "links" : { @@ -49018,159 +51922,96 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "processorErrorMsg" : { - "type" : "string", - "description" : "Error message linked to the stream processor associated with the event.", - "example" : "invalid auth", - "readOnly" : true - }, - "processorName" : { - "type" : "string", - "description" : "Name of the stream processor associated with the event.", - "example" : "foobar", - "readOnly" : true - }, - "processorState" : { + "publicKey" : { "type" : "string", - "description" : "State of the stream processor associated with the event.", - "example" : "FAILED", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true }, "raw" : { "$ref" : "#/components/schemas/raw" - } - }, - "required" : [ "created", "eventTypeName", "id" ], - "title" : "Stream Processor Events" - }, - "StreamsClusterConnection" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/StreamsConnection" - }, { - "type" : "object", - "properties" : { - "clusterName" : { - "type" : "string", - "description" : "Name of the cluster configured for this connection." - }, - "dbRoleToExecute" : { - "$ref" : "#/components/schemas/DBRoleToExecute" - } - } - } ] - }, - "StreamsConnection" : { - "type" : "object", - "description" : "Settings that define a connection to an external data store.", - "discriminator" : { - "mapping" : { - "Cluster" : "#/components/schemas/StreamsClusterConnection", - "Kafka" : "#/components/schemas/StreamsKafkaConnection", - "Sample" : "#/components/schemas/StreamsSampleConnection" }, - "propertyName" : "type" - }, - "oneOf" : [ { - "$ref" : "#/components/schemas/StreamsSampleConnection" - }, { - "$ref" : "#/components/schemas/StreamsClusterConnection" - }, { - "$ref" : "#/components/schemas/StreamsKafkaConnection" - } ], - "properties" : { - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", "readOnly" : true }, - "name" : { + "userId" : { "type" : "string", - "description" : "Human-readable label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source." + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "type" : { + "username" : { "type" : "string", - "description" : "Type of the connection. Can be either Cluster or Kafka.", - "enum" : [ "Kafka", "Cluster", "Sample" ] + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true } }, - "readOnly" : true + "required" : [ "created", "eventTypeName", "id" ], + "title" : "ServiceAccount Events" }, - "StreamsDLQ" : { + "ServiceAccountIPAccessListEntry" : { "type" : "object", - "description" : "Dead letter queue for the stream processor.", "properties" : { - "coll" : { + "cidrBlock" : { "type" : "string", - "description" : "Name of the collection that will be used for the DLQ." + "description" : "Range of network addresses in the access list for the Service Account. This parameter requires the range to be expressed in Classless Inter-Domain Routing (CIDR) notation of Internet Protocol version 4 or version 6 addresses. You can set a value for this parameter or **ipAddress**, but not for both in the same request.", + "example" : "203.0.113.0/24", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" }, - "connectionName" : { + "createdAt" : { "type" : "string", - "description" : "Connection name that will be used to write DLQ messages to. Has to be an Atlas connection." + "format" : "date-time", + "description" : "Date MongoDB Cloud added the entry was added to the Access List.", + "readOnly" : true }, - "db" : { + "ipAddress" : { "type" : "string", - "description" : "Name of the database that will be used for the DLQ." + "description" : "Network address in the access list for the Service Account. This parameter requires the address to be expressed as one Internet Protocol version 4 or version 6 address. You can set a value for this parameter or **cidrBlock**, but not for both in the same request.", + "example" : "203.0.113.10", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - } - } - }, - "StreamsDataProcessRegion" : { - "type" : "object", - "description" : "Information about the cloud provider region in which MongoDB Cloud processes the stream.", - "properties" : { - "cloudProvider" : { + "lastUsedAddress" : { "type" : "string", - "description" : "Label that identifies the cloud service provider where MongoDB Cloud performs stream processing. Currently, this parameter supports AWS only.", - "enum" : [ "AWS", "GCP", "AZURE", "TENANT", "SERVERLESS" ] + "description" : "Network address that issued the most recent request to the API. This parameter requires the address to be expressed as one Internet Protocol version 4 or version 6 address. The resource returns this parameter after this IP address makes at least one request.", + "readOnly" : true }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, + "lastUsedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date when MongoDB Cloud received the most recent request that originated from this Internet Protocol version 4 or version 6 address. The resource returns this parameter when at least one request originates from this IP address. MongoDB Cloud updates this parameter each time a client accesses the permitted resource, with a delay of up to 5 minutes.", "readOnly" : true }, - "region" : { - "$ref" : "#/components/schemas/BaseStreamsRegion" + "requestCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of requests that has originated from this network address.", + "readOnly" : true } - }, - "required" : [ "cloudProvider", "region" ] - }, - "StreamsEventTypeViewForNdsGroup" : { - "type" : "string", - "description" : "Unique identifier of event type.", - "enum" : [ "MAX_PROCESSOR_COUNT_REACHED" ], - "example" : "MAX_PROCESSOR_COUNT_REACHED", - "title" : "Streams Event Types" + } }, - "StreamsEventViewForNdsGroup" : { + "ServiceAccountOrgEvents" : { "type" : "object", - "description" : "Streams event identifies different activities about Atlas Streams.", + "description" : "Service Account event identifies different activities around user api keys.", "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, "created" : { "type" : "string", "format" : "date-time", @@ -49178,7 +52019,7 @@ "readOnly" : true }, "eventTypeName" : { - "$ref" : "#/components/schemas/StreamsEventTypeViewForNdsGroup" + "$ref" : "#/components/schemas/ServiceAccountEventTypeViewForOrg" }, "groupId" : { "type" : "string", @@ -49198,10 +52039,10 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "instanceName" : { - "type" : "string", - "description" : "Name of the stream processing instance associated with the event.", - "example" : "foobar", + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", "readOnly" : true }, "links" : { @@ -49225,387 +52066,217 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, "raw" : { "$ref" : "#/components/schemas/raw" - } - }, - "required" : [ "created", "eventTypeName", "id" ], - "title" : "Streams Events" - }, - "StreamsKafkaAuthentication" : { - "type" : "object", - "description" : "User credentials required to connect to a Kafka Cluster. Includes the authentication type, as well as the parameters for that authentication mode.", - "properties" : { - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true }, - "mechanism" : { + "remoteAddress" : { "type" : "string", - "description" : "Style of authentication. Can be one of PLAIN, SCRAM-256, or SCRAM-512." + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true }, - "password" : { + "userId" : { "type" : "string", - "format" : "password", - "description" : "Password of the account to connect to the Kafka cluster.", - "writeOnly" : true + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, "username" : { "type" : "string", - "description" : "Username of the account to connect to the Kafka cluster." - } - } - }, - "StreamsKafkaConnection" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/StreamsConnection" - }, { - "type" : "object", - "properties" : { - "authentication" : { - "$ref" : "#/components/schemas/StreamsKafkaAuthentication" - }, - "bootstrapServers" : { - "type" : "string", - "description" : "Comma separated list of server addresses." - }, - "config" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "description" : "A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.", - "example" : "{\"group.protocol.type\":\"consumer\",\"debug\":\"queue, msg, protocol\"}" - }, - "description" : "A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.", - "example" : { - "debug" : "queue, msg, protocol", - "group.protocol.type" : "consumer" - } - }, - "networking" : { - "$ref" : "#/components/schemas/StreamsKafkaNetworking" - }, - "proxyInfo" : { - "$ref" : "#/components/schemas/ProxyInfo" - }, - "security" : { - "$ref" : "#/components/schemas/StreamsKafkaSecurity" - } - } - } ] - }, - "StreamsKafkaNetworking" : { - "type" : "object", - "description" : "Networking Access Type can either be 'PUBLIC' (default) or VPC. VPC type is in public preview, please file a support ticket to enable VPC Network Access", - "properties" : { - "access" : { - "$ref" : "#/components/schemas/StreamsKafkaNetworkingAccess" - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true } - } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "ServiceAccount Events" }, - "StreamsKafkaNetworkingAccess" : { + "ServiceAccountSecret" : { "type" : "object", - "description" : "Information about the networking access.", "properties" : { - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "The date that the secret was created on.", "readOnly" : true }, - "name" : { + "expiresAt" : { "type" : "string", - "description" : "Id of the vpc peer when the type is VPC." + "format" : "date-time", + "description" : "The date for the expiration of the secret.", + "readOnly" : true }, - "type" : { + "id" : { "type" : "string", - "description" : "Selected networking type. Either PUBLIC or VPC. Defaults to PUBLIC", - "enum" : [ "PUBLIC", "VPC" ], - "title" : "Networking Access Type" - } - } - }, - "StreamsKafkaSecurity" : { - "type" : "object", - "description" : "Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use.", - "properties" : { - "brokerPublicCertificate" : { + "description" : "Unique 24-hexadecimal digit string that identifies the secret.", + "example" : "32b6e34b3d91647abb20e7b8", + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastUsedAt" : { "type" : "string", - "description" : "A trusted, public x509 certificate for connecting to Kafka over SSL." + "format" : "date-time", + "description" : "The last time the secret was used.", + "readOnly" : true }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, + "maskedSecretValue" : { + "type" : "string", + "description" : "The masked Service Account secret.", + "example" : "mdb_ic_sk_...12ce", "readOnly" : true }, - "protocol" : { + "secret" : { "type" : "string", - "description" : "Describes the transport type. Can be either PLAINTEXT or SSL." + "description" : "The secret for the Service Account. It will be returned only the first time after creation.", + "pattern" : "^mdb_sa_sk_[0-9a-zA-Z_-]{40}$", + "readOnly" : true } - } + }, + "required" : [ "createdAt", "expiresAt", "id" ] }, - "StreamsMatcher" : { + "ServiceAccountSecretRequest" : { "type" : "object", - "description" : "Rules to apply when comparing a stream processing instance or stream processor against this alert configuration.", "properties" : { - "fieldName" : { - "$ref" : "#/components/schemas/StreamsMatcherField" - }, - "operator" : { + "secretExpiresAfterHours" : { + "type" : "integer", + "format" : "int32", + "description" : "The expiration time of the new Service Account secret. The expiration is provided in hours." + } + }, + "required" : [ "secretExpiresAfterHours" ] + }, + "ShardEntry" : { + "type" : "object", + "description" : "Sharding configuration for a collection to be sharded on the destination cluster.", + "properties" : { + "collection" : { "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" ] + "description" : "Human-readable label that identifies the collection to be sharded on the destination cluster.", + "writeOnly" : true }, - "value" : { + "database" : { "type" : "string", - "description" : "Value to match or exceed using the specified **matchers.operator**.", - "example" : "event-replica-set" + "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" } }, - "required" : [ "fieldName", "operator", "value" ], - "title" : "Matchers" - }, - "StreamsMatcherField" : { - "type" : "string", - "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", - "enum" : [ "INSTANCE_NAME", "PROCESSOR_NAME" ], - "example" : "INSTANCE_NAME", - "title" : "Streams Matcher Fields" + "required" : [ "collection", "database", "shardCollection" ] }, - "StreamsOptions" : { + "ShardKeys" : { "type" : "object", - "description" : "Optional configuration for the stream processor.", + "description" : "Document that configures the shard key on the destination cluster.", "properties" : { - "dlq" : { - "$ref" : "#/components/schemas/StreamsDLQ" - }, - "links" : { + "key" : { "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, + "description" : "List of fields to use for the shard key.", "items" : { - "$ref" : "#/components/schemas/Link" + "type" : "object", + "additionalProperties" : { + "type" : "object" + } }, - "readOnly" : true + "uniqueItems" : true, + "writeOnly" : true } - } + }, + "writeOnly" : true }, - "StreamsProcessor" : { + "ShardingRequest" : { "type" : "object", - "description" : "An atlas stream processor.", + "description" : "Document that configures sharding on the destination cluster when migrating from a replica set source to a sharded cluster destination on MongoDB 6.0 or higher. If you don't wish to shard any collections on the destination cluster, leave this empty.", "properties" : { - "_id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the stream processor.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "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 }, - "links" : { + "shardingEntries" : { "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, + "description" : "List of shard configurations to shard destination collections. Atlas shards only those collections that you include in the sharding entries array.", "items" : { - "$ref" : "#/components/schemas/Link" + "$ref" : "#/components/schemas/ShardEntry" }, - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "Human-readable name of the stream processor." - }, - "options" : { - "$ref" : "#/components/schemas/StreamsOptions" - }, - "pipeline" : { - "type" : "array", - "description" : "Stream aggregation pipeline you want to apply to your streaming data.", - "items" : { - "$ref" : "#/components/schemas/Document" - } + "uniqueItems" : true, + "writeOnly" : true } - } + }, + "required" : [ "createSupportingIndexes" ], + "writeOnly" : true }, - "StreamsProcessorWithStats" : { + "Slack" : { "type" : "object", - "description" : "An atlas stream processor with optional stats.", + "description" : "Details to integrate one Slack account with one MongoDB Cloud project.", "properties" : { - "_id" : { + "apiToken" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the stream processor.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true + "description" : "Key that allows MongoDB Cloud to access your Slack account.\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.\n\n**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" }, - "name" : { + "channelName" : { "type" : "string", - "description" : "Human-readable name of the stream processor.", - "readOnly" : true + "description" : "Name of the Slack channel to which MongoDB Cloud sends alert notifications.", + "example" : "alerts", + "maxLength" : 80, + "minLength" : 1, + "nullable" : true }, - "pipeline" : { - "type" : "array", - "description" : "Stream aggregation pipeline you want to apply to your streaming data.", - "items" : { - "$ref" : "#/components/schemas/Document" - }, - "readOnly" : true + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true }, - "state" : { + "teamName" : { "type" : "string", - "description" : "The state of the stream processor.", - "readOnly" : true + "description" : "Human-readable label that identifies your Slack team. Set this parameter when you configure a legacy Slack integration.", + "example" : "MongoDB" }, - "stats" : { - "type" : "object", - "additionalProperties" : { - "type" : "object", - "description" : "The stats associated with the stream processor.", - "readOnly" : true - }, - "description" : "The stats associated with the stream processor.", - "readOnly" : 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" : [ "SLACK" ] } }, - "required" : [ "_id", "name", "pipeline", "state" ] - }, - "StreamsSampleConnection" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/StreamsConnection" - } ] + "required" : [ "apiToken", "channelName" ], + "title" : "SLACK" }, - "StreamsTenant" : { + "SlackNotification" : { "type" : "object", + "description" : "Slack notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", "properties" : { - "_id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the project.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "connections" : { - "type" : "array", - "description" : "List of connections configured in the stream instance.", - "items" : { - "$ref" : "#/components/schemas/StreamsConnection" - }, - "readOnly" : true - }, - "dataProcessRegion" : { - "$ref" : "#/components/schemas/StreamsDataProcessRegion" - }, - "groupId" : { + "apiToken" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the project.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "hostnames" : { - "type" : "array", - "description" : "List that contains the hostnames assigned to the stream instance.", - "items" : { - "type" : "string", - "description" : "Unique hostname assigned to the stream instance.", - "readOnly" : true - }, - "readOnly" : true - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true + "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" }, - "name" : { + "channelName" : { "type" : "string", - "description" : "Human-readable label that identifies the stream instance." + "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" }, - "streamConfig" : { - "$ref" : "#/components/schemas/StreamConfig" - } - } - }, - "SummaryNotification" : { - "type" : "object", - "description" : "Summary notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", - "properties" : { "delayMin" : { "type" : "integer", "format" : "int32", "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." }, - "emailAddress" : { + "integrationId" : { "type" : "string", - "format" : "email", - "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:\n\n- specific MongoDB Cloud users (`\"notifications.[n].typeName\" : \"USER\"`)\n- MongoDB Cloud users with specific project roles (`\"notifications.[n].typeName\" : \"GROUP\"`)\n- MongoDB Cloud users with specific organization roles (`\"notifications.[n].typeName\" : \"ORG\"`)\n- MongoDB Cloud teams (`\"notifications.[n].typeName\" : \"TEAM\"`)\n\nTo send emails to one MongoDB Cloud user or grouping of users, set the **notifications.[n].emailEnabled** parameter." + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" }, "intervalMin" : { "type" : "integer", @@ -49621,68 +52292,74 @@ "typeName" : { "type" : "string", "description" : "Human-readable label that displays the alert notification type.", - "enum" : [ "SUMMARY" ] + "enum" : [ "SLACK" ] } }, "required" : [ "typeName" ], - "title" : "Summary Notification" + "title" : "Slack Notification" }, - "SynonymMappingStatusDetail" : { + "Source" : { "type" : "object", - "description" : "Contains the status of the index's synonym mappings on each search host. This field (and its subfields) only appear if the index has synonyms defined.", + "description" : "Document that describes the source of the migration.", "properties" : { - "message" : { + "caCertificatePath" : { "type" : "string", - "description" : "Optional message describing an error." + "description" : "Path to the CA certificate that signed SSL certificates use to authenticate to the source cluster." }, - "queryable" : { + "clusterName" : { + "type" : "string", + "description" : "Label that identifies the source cluster name." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the source project.", + "example" : "9b43a5b329223c3a1591a678", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "managedAuthentication" : { "type" : "boolean", - "description" : "Flag that indicates whether the synonym mapping is queryable on a host." + "description" : "Flag that indicates whether MongoDB Automation manages authentication to the source cluster. If true, do not provide values for username and password." }, - "status" : { + "password" : { "type" : "string", - "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", - "enum" : [ "FAILED", "BUILDING", "READY" ] + "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 } }, - "title" : "Synonym Mapping Status Detail" + "required" : [ "clusterName", "groupId", "managedAuthentication", "ssl" ] }, - "SynonymMappingStatusDetailMap" : { + "StorageEngine" : { "type" : "object", "additionalProperties" : { - "$ref" : "#/components/schemas/SynonymMappingStatusDetail" - }, - "x-additionalPropertiesName" : "Synonym Mapping Name" - }, - "SynonymSource" : { - "type" : "object", - "description" : "Data set that stores words and their applicable synonyms.", - "properties" : { - "collection" : { - "type" : "string", - "description" : "Label that identifies the MongoDB collection that stores words and their applicable synonyms." + "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/" } }, - "required" : [ "collection" ] + "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/" + } }, - "SystemStatus" : { + "StreamConfig" : { "type" : "object", + "description" : "Configuration options for an Atlas Stream Processing Instance.", + "nullable" : true, "properties" : { - "apiKey" : { - "$ref" : "#/components/schemas/ApiKey" - }, - "appName" : { - "type" : "string", - "description" : "Human-readable label that identifies the service from which you requested this response.", - "enum" : [ "MongoDB Atlas" ], - "readOnly" : true - }, - "build" : { - "type" : "string", - "description" : "Unique 40-hexadecimal digit hash that identifies the latest git commit merged for this application.", - "example" : "83be55e140f493c88e7f578aae96548dd881587b", - "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.", @@ -49695,43 +52372,44 @@ }, "readOnly" : true }, - "throttling" : { - "type" : "boolean", - "description" : "Flag that indicates whether someone enabled throttling on this service.", - "readOnly" : true - } - }, - "required" : [ "apiKey", "appName", "build", "throttling" ] - }, - "TargetOrg" : { - "type" : "object", - "properties" : { - "linkToken" : { + "tier" : { "type" : "string", - "description" : "Link token that contains all the information required to complete the link." - } - }, - "required" : [ "linkToken" ] - }, - "TargetOrgRequest" : { - "type" : "object", - "properties" : { - "accessListIps" : { - "type" : "array", - "description" : "IP address access list entries associated with the API key.", - "items" : { - "type" : "string", - "description" : "One IP address access list entry associated with the API key." - } + "description" : "Selected tier for the Stream Instance. Configures Memory / VCPU allowances.", + "enum" : [ "SP30", "SP10" ], + "title" : "Stream Instance Tier" } } }, - "Team" : { + "StreamProcessorAlertConfigViewForNdsGroup" : { "type" : "object", + "description" : "Host metric alert configuration allows to select which Atlas streams processors trigger alerts and how users are notified.", "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/StreamProcessorEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies this team.", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -49750,30 +52428,54 @@ }, "readOnly" : true }, - "name" : { - "type" : "string", - "description" : "Human-readable label that identifies the team." + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration.", + "items" : { + "$ref" : "#/components/schemas/StreamsMatcher" + } }, - "usernames" : { + "notifications" : { "type" : "array", - "description" : "List that contains the MongoDB Cloud users in this team.", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", "items" : { - "type" : "string", - "format" : "email", - "description" : "List that contains email addresses that identify MongoDB Cloud users to in this team." - }, - "uniqueItems" : true + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true } }, - "required" : [ "name" ] + "required" : [ "eventTypeName", "notifications" ], + "title" : "Stream Processor Alert Configuration" }, - "TeamEvent" : { + "StreamProcessorAlertViewForNdsGroup" : { "type" : "object", - "description" : "Team event identifies different activities around organization teams.", + "description" : "Stream Processor alert notifies about activities on Stream Processor in AtlasStreams.", "properties" : { - "apiKeyId" : { + "acknowledgedUntil" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "format" : "date-time", + "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.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -49783,15 +52485,15 @@ "created" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, "eventTypeName" : { - "$ref" : "#/components/schemas/TeamEventTypeView" + "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroupAlertable" }, "groupId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -49800,17 +52502,23 @@ }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "isGlobalAdmin" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "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.", + "example" : "foobar", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", "readOnly" : true }, "links" : { @@ -49827,86 +52535,72 @@ }, "orgId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "publicKey" : { + "processorErrorMsg" : { "type" : "string", - "format" : "email", - "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "example" : "test.user@mongodb.com", + "description" : "The error message associated with the Stream Processor to which this alert applies.", + "example" : "MongoServerError: Failed to start stream processor: (Location77175) Could not connect to the Kafka topic with kafka error code: -195, message: Local: Broker transport failure.: (Location77175)", "readOnly" : true }, - "raw" : { - "$ref" : "#/components/schemas/raw" + "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.", + "example" : "foobar", + "readOnly" : true }, - "remoteAddress" : { + "processorState" : { "type" : "string", - "description" : "IPv4 or IPv6 address from which the user triggered this event.", - "example" : "216.172.40.186", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "description" : "The state of the Stream Processor to which this alert applies. The resource returns this parameter for alerts of events impacting Stream Processors.", + "example" : "STARTED", "readOnly" : true }, - "teamId" : { + "resolved" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization team associated with this event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "format" : "date-time", + "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\"`.", "readOnly" : true }, - "userId" : { + "status" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", "readOnly" : true }, - "username" : { + "updated" : { "type" : "string", - "format" : "email", - "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", - "example" : "test.user@mongodb.com", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true } }, - "required" : [ "created", "eventTypeName", "id" ], - "title" : "Team Events" + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Stream Processor Alerts" }, - "TeamEventTypeView" : { + "StreamProcessorEventTypeViewAlertable" : { "type" : "string", - "description" : "Unique identifier of event type.", - "enum" : [ "TEAM_CREATED", "TEAM_DELETED", "TEAM_UPDATED", "TEAM_NAME_CHANGED", "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], - "example" : "TEAM_ADDED_TO_GROUP", - "title" : "Team Event Types" + "description" : "Event type that triggers an alert.", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "example" : "STREAM_PROCESSOR_STATE_IS_FAILED", + "title" : "Stream Processor Event Types" }, - "TeamEventTypeViewForNdsGroup" : { + "StreamProcessorEventTypeViewForNdsGroup" : { "type" : "string", "description" : "Unique identifier of event type.", - "enum" : [ "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], - "example" : "TEAM_ADDED_TO_GROUP", - "title" : "Team Event Types" + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "example" : "STREAM_PROCESSOR_STATE_IS_FAILED", + "title" : "Stream Processor Event Types" }, - "TeamEventViewForNdsGroup" : { + "StreamProcessorEventViewForNdsGroup" : { "type" : "object", - "description" : "Team event identifies different activities around organization teams.", + "description" : "Stream Processor event identifies different activities about a stream processor in Atlas Streams.", "properties" : { - "apiKeyId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, "created" : { "type" : "string", "format" : "date-time", @@ -49914,7 +52608,7 @@ "readOnly" : true }, "eventTypeName" : { - "$ref" : "#/components/schemas/TeamEventTypeViewForNdsGroup" + "$ref" : "#/components/schemas/StreamProcessorEventTypeViewForNdsGroup" }, "groupId" : { "type" : "string", @@ -49934,10 +52628,10 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "isGlobalAdmin" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "instanceName" : { + "type" : "string", + "description" : "Name of the stream processing instance associated with the event.", + "example" : "foobar", "readOnly" : true }, "links" : { @@ -49961,113 +52655,297 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "publicKey" : { + "processorErrorMsg" : { "type" : "string", - "format" : "email", - "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "example" : "test.user@mongodb.com", + "description" : "Error message linked to the stream processor associated with the event.", + "example" : "invalid auth", + "readOnly" : true + }, + "processorName" : { + "type" : "string", + "description" : "Name of the stream processor associated with the event.", + "example" : "foobar", + "readOnly" : true + }, + "processorState" : { + "type" : "string", + "description" : "State of the stream processor associated with the event.", + "example" : "FAILED", "readOnly" : true }, "raw" : { "$ref" : "#/components/schemas/raw" + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Stream Processor Events" + }, + "StreamsClusterConnection" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/StreamsConnection" + }, { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Name of the cluster configured for this connection." + }, + "dbRoleToExecute" : { + "$ref" : "#/components/schemas/DBRoleToExecute" + } + } + } ] + }, + "StreamsConnection" : { + "type" : "object", + "description" : "Settings that define a connection to an external data store.", + "discriminator" : { + "mapping" : { + "Cluster" : "#/components/schemas/StreamsClusterConnection", + "Kafka" : "#/components/schemas/StreamsKafkaConnection", + "Sample" : "#/components/schemas/StreamsSampleConnection" }, - "remoteAddress" : { + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/StreamsSampleConnection" + }, { + "$ref" : "#/components/schemas/StreamsClusterConnection" + }, { + "$ref" : "#/components/schemas/StreamsKafkaConnection" + } ], + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { "type" : "string", - "description" : "IPv4 or IPv6 address from which the user triggered this event.", - "example" : "216.172.40.186", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "description" : "Human-readable label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source." + }, + "type" : { + "type" : "string", + "description" : "Type of the connection. Can be either Cluster or Kafka.", + "enum" : [ "Kafka", "Cluster", "Sample" ] + } + }, + "readOnly" : true + }, + "StreamsDLQ" : { + "type" : "object", + "description" : "Dead letter queue for the stream processor.", + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/reference/glossary/#std-term-dead-letter-queue" + }, + "properties" : { + "coll" : { + "type" : "string", + "description" : "Name of the collection to use for the DLQ." + }, + "connectionName" : { + "type" : "string", + "description" : "Name of the connection to write DLQ messages to. Must be an Atlas connection." + }, + "db" : { + "type" : "string", + "description" : "Name of the database to use for the DLQ." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, "readOnly" : true + } + } + }, + "StreamsDataProcessRegion" : { + "type" : "object", + "description" : "Information about the cloud provider region in which MongoDB Cloud processes the stream.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Label that identifies the cloud service provider where MongoDB Cloud performs stream processing. Currently, this parameter supports AWS only.", + "enum" : [ "AWS", "GCP", "AZURE", "TENANT", "SERVERLESS" ] }, - "teamId" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "region" : { + "$ref" : "#/components/schemas/BaseStreamsRegion" + } + }, + "required" : [ "cloudProvider", "region" ] + }, + "StreamsEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "MAX_PROCESSOR_COUNT_REACHED" ], + "example" : "MAX_PROCESSOR_COUNT_REACHED", + "title" : "Streams Event Types" + }, + "StreamsEventViewForNdsGroup" : { + "type" : "object", + "description" : "Streams event identifies different activities about Atlas Streams.", + "properties" : { + "created" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization team associated with this event.", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/StreamsEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "userId" : { + "id" : { "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.", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "username" : { + "instanceName" : { "type" : "string", - "format" : "email", - "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", - "example" : "test.user@mongodb.com", + "description" : "Name of the stream processing instance associated with the event.", + "example" : "foobar", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" } }, "required" : [ "created", "eventTypeName", "id" ], - "title" : "Team Events" + "title" : "Streams Events" }, - "TeamNotification" : { + "StreamsKafkaAuthentication" : { "type" : "object", - "description" : "Team notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "description" : "User credentials required to connect to a Kafka Cluster. Includes the authentication type, as well as the parameters for that authentication mode.", "properties" : { - "delayMin" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." - }, - "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:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" - }, - "intervalMin" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", - "minimum" : 5 - }, - "notifierId" : { - "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:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true }, - "teamId" : { + "mechanism" : { "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", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" + "description" : "Style of authentication. Can be one of PLAIN, SCRAM-256, or SCRAM-512." }, - "teamName" : { + "password" : { "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" + "format" : "password", + "description" : "Password of the account to connect to the Kafka cluster.", + "writeOnly" : true }, - "typeName" : { + "username" : { "type" : "string", - "description" : "Human-readable label that displays the alert notification type.", - "enum" : [ "TEAM" ] + "description" : "Username of the account to connect to the Kafka cluster." } - }, - "required" : [ "typeName" ], - "title" : "Team Notification" + } }, - "TeamResponse" : { + "StreamsKafkaConnection" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/StreamsConnection" + }, { + "type" : "object", + "properties" : { + "authentication" : { + "$ref" : "#/components/schemas/StreamsKafkaAuthentication" + }, + "bootstrapServers" : { + "type" : "string", + "description" : "Comma separated list of server addresses." + }, + "config" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.", + "example" : "{\"group.protocol.type\":\"consumer\",\"debug\":\"queue, msg, protocol\"}" + }, + "description" : "A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.", + "example" : { + "debug" : "queue, msg, protocol", + "group.protocol.type" : "consumer" + } + }, + "networking" : { + "$ref" : "#/components/schemas/StreamsKafkaNetworking" + }, + "security" : { + "$ref" : "#/components/schemas/StreamsKafkaSecurity" + } + } + } ] + }, + "StreamsKafkaNetworking" : { "type" : "object", + "description" : "Networking Access Type can either be 'PUBLIC' (default) or VPC. VPC type is in public preview, please file a support ticket to enable VPC Network Access", "properties" : { - "id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies this team.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "access" : { + "$ref" : "#/components/schemas/StreamsKafkaNetworkingAccess" }, "links" : { "type" : "array", @@ -50080,16 +52958,21 @@ "$ref" : "#/components/schemas/Link" }, "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "Human-readable label that identifies the team." } } }, - "TeamRole" : { + "StreamsKafkaNetworkingAccess" : { "type" : "object", + "description" : "Information about the networking access.", "properties" : { + "connectionId" : { + "type" : "string", + "description" : "Reserved. Will be used by PRIVATE_LINK connection type.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, "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.", @@ -50102,28 +52985,26 @@ }, "readOnly" : true }, - "roleNames" : { - "type" : "array", - "description" : "One or more organization- or project-level roles to assign to the MongoDB Cloud user.", - "items" : { - "type" : "string", - "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] - }, - "uniqueItems" : true + "name" : { + "type" : "string", + "description" : "Reserved. Will be used by PRIVATE_LINK connection type." }, - "teamId" : { + "type" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the team.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" + "description" : "Selected networking type. Either PUBLIC, VPC or PRIVATE_LINK. Defaults to PUBLIC. For VPC, ensure that VPC peering exists and connectivity has been established between Atlas VPC and the VPC where Kafka cluster is hosted for the connection to function properly. PRIVATE_LINK support is coming soon.", + "enum" : [ "PUBLIC", "VPC", "PRIVATE_LINK" ], + "title" : "Networking Access Type" } } }, - "TeamUpdate" : { + "StreamsKafkaSecurity" : { "type" : "object", + "description" : "Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use.", "properties" : { + "brokerPublicCertificate" : { + "type" : "string", + "description" : "A trusted, public x509 certificate for connecting to Kafka over SSL." + }, "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.", @@ -50136,108 +53017,83 @@ }, "readOnly" : true }, - "name" : { - "type" : "string", - "description" : "Human-readable label that identifies the team.", - "writeOnly" : true - } - }, - "required" : [ "name" ] - }, - "TenantHardwareSpec" : { - "type" : "object", - "properties" : { - "instanceSize" : { + "protocol" : { "type" : "string", - "description" : "Hardware specification for the instances in this M0/M2/M5 tier cluster.", - "enum" : [ "M0", "M2", "M5" ], - "title" : "Tenant Instance Sizes" + "description" : "Describes the transport type. Can be either PLAINTEXT or SSL." } } }, - "TenantHardwareSpec20240805" : { + "StreamsMatcher" : { "type" : "object", + "description" : "Rules to apply when comparing a stream processing instance or stream processor against this alert configuration.", "properties" : { - "diskSizeGB" : { - "type" : "number", - "format" : "double", - "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", - "maximum" : 4096, - "minimum" : 10 + "fieldName" : { + "$ref" : "#/components/schemas/StreamsMatcherField" }, - "instanceSize" : { + "operator" : { "type" : "string", - "description" : "Hardware specification for the instances in this M0/M2/M5 tier cluster.", - "enum" : [ "M0", "M2", "M5" ], - "title" : "Tenant Instance Sizes" + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" } - } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" }, - "TenantRegionConfig" : { - "type" : "object", - "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`.", - "enum" : [ "AWS", "GCP", "AZURE" ] - } - } - } ], - "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", - "title" : "Tenant Regional Replication Specifications" + "StreamsMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "INSTANCE_NAME", "PROCESSOR_NAME" ], + "example" : "INSTANCE_NAME", + "title" : "Streams Matcher Fields" }, - "TenantRegionConfig20240805" : { + "StreamsOptions" : { "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/CloudRegionConfig20240805" - }, { - "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`.", - "enum" : [ "AWS", "GCP", "AZURE" ] - } + "description" : "Optional configuration for the stream processor.", + "properties" : { + "dlq" : { + "$ref" : "#/components/schemas/StreamsDLQ" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true } - } ], - "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", - "title" : "Tenant Regional Replication Specifications" + } }, - "TenantRestore" : { + "StreamsPrivateLinkConnection" : { "type" : "object", + "description" : "Container for metadata needed to create a Private Link connection.", "properties" : { - "clusterName" : { + "_id" : { "type" : "string", - "description" : "Human-readable label that identifies the source cluster.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "readOnly" : true + "description" : "The ID of the Private Link connection." }, - "deliveryType" : { + "dnsDomain" : { "type" : "string", - "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", - "enum" : [ "RESTORE", "DOWNLOAD" ], - "readOnly" : true + "description" : "Domain name of Confluent cluster." }, - "expirationDate" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "dnsSubDomain" : { + "type" : "array", + "description" : "Sub-Domain name of Confluent cluster. These are typically your availability zones.", + "items" : { + "type" : "string" + } }, - "id" : { + "interfaceEndpointId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "description" : "Interface endpoint ID that is created from the service endpoint ID provided." }, "links" : { "type" : "array", @@ -50251,354 +53107,451 @@ }, "readOnly" : true }, - "projectId" : { + "provider" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "description" : "Provider where the Kafka cluster is deployed." }, - "restoreFinishedDate" : { + "region" : { "type" : "string", - "format" : "date-time", - "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.", - "readOnly" : true + "description" : "Domain name of Confluent cluster." }, - "restoreScheduledDate" : { + "serviceEndpointId" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "description" : "AWS Service Endpoint ID." }, - "snapshotFinishedDate" : { + "state" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "description" : "State the connection is in." }, - "snapshotId" : { + "vendor" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "description" : "Vendor who manages the Kafka cluster." + } + } + }, + "StreamsProcessor" : { + "type" : "object", + "description" : "An atlas stream processor.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the stream processor.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" - }, - "snapshotUrl" : { - "type" : "string", - "description" : "Internet address from which you can download the compressed snapshot files. The resource returns this parameter when `\"deliveryType\" : \"DOWNLOAD\"`.", + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "status" : { - "type" : "string", - "description" : "Phase of the restore workflow for this job at the time this resource made this request.", - "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, "readOnly" : true }, - "targetDeploymentItemName" : { + "name" : { "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.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + "description" : "Human-readable name of the stream processor." }, - "targetProjectId" : { - "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", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" + "options" : { + "$ref" : "#/components/schemas/StreamsOptions" + }, + "pipeline" : { + "type" : "array", + "description" : "Stream aggregation pipeline you want to apply to your streaming data.", + "externalDocs" : { + "description" : "Supported Aggregation Pipeline Stages", + "url" : "https://www.mongodb.com/docs/atlas/atlas-stream-processing/stream-aggregation/#std-label-stream-aggregation" + }, + "items" : { + "$ref" : "#/components/schemas/Document" + } } - }, - "required" : [ "snapshotId", "targetDeploymentItemName" ] + } }, - "TextSearchHostStatusDetail" : { + "StreamsProcessorWithStats" : { "type" : "object", + "description" : "An atlas stream processor with optional stats.", "properties" : { - "hostname" : { + "_id" : { "type" : "string", - "description" : "Hostname that corresponds to the status detail." + "description" : "Unique 24-hexadecimal character string that identifies the stream processor.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "mainIndex" : { - "$ref" : "#/components/schemas/TextSearchIndexStatusDetail" + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true }, - "queryable" : { - "type" : "boolean", - "description" : "Flag that indicates whether the index is queryable on the host." + "name" : { + "type" : "string", + "description" : "Human-readable name of the stream processor.", + "readOnly" : true }, - "stagedIndex" : { - "$ref" : "#/components/schemas/TextSearchIndexStatusDetail" + "options" : { + "$ref" : "#/components/schemas/StreamsOptions" }, - "status" : { + "pipeline" : { + "type" : "array", + "description" : "Stream aggregation pipeline you want to apply to your streaming data.", + "items" : { + "$ref" : "#/components/schemas/Document" + }, + "readOnly" : true + }, + "state" : { "type" : "string", - "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", - "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + "description" : "The state of the stream processor. Commonly occurring states are 'CREATED', 'STARTED', 'STOPPED' and 'FAILED'.", + "readOnly" : true + }, + "stats" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "The stats associated with the stream processor.", + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor" + }, + "readOnly" : true + }, + "description" : "The stats associated with the stream processor.", + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor" + }, + "readOnly" : true } }, - "title" : "Text Search Host Status Detail" + "required" : [ "_id", "name", "pipeline", "state" ] }, - "TextSearchIndexCreateRequest" : { + "StreamsSampleConnection" : { "type" : "object", "allOf" : [ { - "$ref" : "#/components/schemas/SearchIndexCreateRequest" - }, { - "type" : "object", - "properties" : { - "definition" : { - "$ref" : "#/components/schemas/TextSearchIndexDefinition" - } + "$ref" : "#/components/schemas/StreamsConnection" + } ] + }, + "StreamsSampleConnections" : { + "type" : "object", + "description" : "Sample connections to add to SPI.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "solar" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to add a 'sample_stream_solar' connection." } - } ], - "description" : "Text Search Index Create Request", - "required" : [ "collectionName", "database", "definition", "name" ] + } }, - "TextSearchIndexDefinition" : { + "StreamsTenant" : { "type" : "object", - "description" : "The text search index definition set by the user.", "properties" : { - "analyzer" : { + "_id" : { "type" : "string", - "default" : "lucene.standard", - "description" : "Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves making the following changes to the text in fields:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\n MongoDB Cloud uses the process you select to build the Atlas Search index.", - "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ], - "externalDocs" : { - "description" : "Atlas Search Analyzers", - "url" : "https://dochub.mongodb.org/core/analyzers--fts" - } + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "analyzers" : { + "connections" : { "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" - }, + "description" : "List of connections configured in the stream instance.", "items" : { - "$ref" : "#/components/schemas/AtlasSearchAnalyzer" - } + "$ref" : "#/components/schemas/StreamsConnection" + }, + "readOnly" : true }, - "mappings" : { - "$ref" : "#/components/schemas/SearchMappings" + "dataProcessRegion" : { + "$ref" : "#/components/schemas/StreamsDataProcessRegion" }, - "searchAnalyzer" : { + "groupId" : { "type" : "string", - "default" : "lucene.standard", - "description" : "Method applied to identify words when searching this index.", - "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "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 Stored Source Fields.", - "example" : { - "include | exclude" : [ "field1", "field2" ] + "hostnames" : { + "type" : "array", + "description" : "List that contains the hostnames assigned to the stream instance.", + "items" : { + "type" : "string", + "description" : "Unique hostname assigned to the stream instance.", + "readOnly" : true }, - "externalDocs" : { - "description" : "Stored Source Fields", - "url" : "https://dochub.mongodb.org/core/atlas-search-stored-source" - } + "readOnly" : true }, - "synonyms" : { + "links" : { "type" : "array", - "description" : "Rule sets that map words to their synonyms in this index.", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", "externalDocs" : { - "description" : "Synonym Mapping", - "url" : "https://dochub.mongodb.org/core/fts-synonym-mappings" + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" }, "items" : { - "$ref" : "#/components/schemas/SearchSynonymMappingDefinition" - } - } - }, - "required" : [ "mappings" ], - "title" : "Text Search Index Definition" - }, - "TextSearchIndexResponse" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/SearchIndexResponse" - }, { - "type" : "object", - "properties" : { - "latestDefinition" : { - "$ref" : "#/components/schemas/TextSearchIndexDefinition" - }, - "statusDetail" : { - "type" : "array", - "description" : "List of documents detailing index status on each host.", - "items" : { - "$ref" : "#/components/schemas/TextSearchHostStatusDetail" - } - }, - "synonymMappingStatus" : { - "type" : "string", - "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", - "enum" : [ "FAILED", "BUILDING", "READY" ] - }, - "synonymMappingStatusDetail" : { - "type" : "array", - "description" : "A list of documents describing the status of the index's synonym mappings on each search host. Only appears if the index has synonyms defined.", - "items" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/SynonymMappingStatusDetail" - } - } - } + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the stream instance." + }, + "sampleConnections" : { + "$ref" : "#/components/schemas/StreamsSampleConnections" + }, + "streamConfig" : { + "$ref" : "#/components/schemas/StreamConfig" } - } ], - "title" : "Text Search Index Response" + } }, - "TextSearchIndexStatusDetail" : { + "SummaryNotification" : { "type" : "object", - "description" : "Contains status information about a text search index.", + "description" : "Summary notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", "properties" : { - "definition" : { - "$ref" : "#/components/schemas/TextSearchIndexDefinition" + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." }, - "definitionVersion" : { - "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + "emailAddress" : { + "type" : "string", + "format" : "email", + "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:\n\n- specific MongoDB Cloud users (`\"notifications.[n].typeName\" : \"USER\"`)\n- MongoDB Cloud users with specific project roles (`\"notifications.[n].typeName\" : \"GROUP\"`)\n- MongoDB Cloud users with specific organization roles (`\"notifications.[n].typeName\" : \"ORG\"`)\n- MongoDB Cloud teams (`\"notifications.[n].typeName\" : \"TEAM\"`)\n\nTo send emails to one MongoDB Cloud user or grouping of users, set the **notifications.[n].emailEnabled** parameter." + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "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" ] + } + }, + "required" : [ "typeName" ], + "title" : "Summary Notification" + }, + "SynonymMappingStatusDetail" : { + "type" : "object", + "description" : "Contains the status of the index's synonym mappings on each search host. This field (and its subfields) only appear if the index has synonyms defined.", + "properties" : { "message" : { "type" : "string", "description" : "Optional message describing an error." }, "queryable" : { "type" : "boolean", - "description" : "Flag that indicates whether the index generation is queryable on the host." + "description" : "Flag that indicates whether the synonym mapping is queryable on a host." }, "status" : { - "type" : "string", - "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", - "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] - }, - "synonymMappingStatus" : { "type" : "string", "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", "enum" : [ "FAILED", "BUILDING", "READY" ] - }, - "synonymMappingStatusDetail" : { - "type" : "array", - "description" : "List of synonym statuses by mapping.", - "items" : { - "$ref" : "#/components/schemas/SynonymMappingStatusDetailMap" - } } }, - "title" : "Text Search Index Status Detail" + "title" : "Synonym Mapping Status Detail" }, - "ThirdPartyIntegration" : { + "SynonymMappingStatusDetailMap" : { "type" : "object", - "description" : "Collection of settings that describe third-party integrations.", - "discriminator" : { - "mapping" : { - "DATADOG" : "#/components/schemas/Datadog", - "MICROSOFT_TEAMS" : "#/components/schemas/MicrosoftTeams", - "NEW_RELIC" : "#/components/schemas/NewRelic", - "OPS_GENIE" : "#/components/schemas/OpsGenie", - "PAGER_DUTY" : "#/components/schemas/PagerDuty", - "PROMETHEUS" : "#/components/schemas/Prometheus", - "SLACK" : "#/components/schemas/Slack", - "VICTOR_OPS" : "#/components/schemas/VictorOps", - "WEBHOOK" : "#/components/schemas/Webhook" - }, - "propertyName" : "type" + "additionalProperties" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetail" }, + "x-additionalPropertiesName" : "Synonym Mapping Name" + }, + "SynonymSource" : { + "type" : "object", + "description" : "Data set that stores words and their applicable synonyms.", "properties" : { - "id" : { - "type" : "string", - "description" : "Integration id.", - "nullable" : true - }, - "type" : { + "collection" : { "type" : "string", - "description" : "Integration type", - "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], - "title" : "Integration Type" + "description" : "Label that identifies the MongoDB collection that stores words and their applicable synonyms." } }, - "title" : "Third-Party Integration" + "required" : [ "collection" ] }, - "TimeMetricAlertView" : { + "SystemStatus" : { "type" : "object", "properties" : { - "acknowledgedUntil" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + "apiKey" : { + "$ref" : "#/components/schemas/ApiKey" }, - "acknowledgementComment" : { + "appName" : { "type" : "string", - "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", - "example" : "Expiration on 3/19. Silencing for 7days.", - "maxLength" : 200 + "description" : "Human-readable label that identifies the service from which you requested this response.", + "enum" : [ "MongoDB Atlas" ], + "readOnly" : true }, - "acknowledgingUsername" : { + "build" : { "type" : "string", - "format" : "email", - "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "description" : "Unique 40-hexadecimal digit hash that identifies the latest git commit merged for this application.", + "example" : "83be55e140f493c88e7f578aae96548dd881587b", "readOnly" : true }, - "alertConfigId" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "throttling" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled throttling on this service.", + "readOnly" : true + } + }, + "required" : [ "apiKey", "appName", "build", "throttling" ] + }, + "TargetOrg" : { + "type" : "object", + "properties" : { + "linkToken" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "description" : "Link token that contains all the information required to complete the link." + } + }, + "required" : [ "linkToken" ] + }, + "TargetOrgRequest" : { + "type" : "object", + "properties" : { + "accessListIps" : { + "type" : "array", + "description" : "IP address access list entries associated with the API key.", + "items" : { + "type" : "string", + "description" : "One IP address access list entry associated with the API key." + } + } + } + }, + "Team" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this team.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "clusterName" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { "type" : "string", - "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", - "example" : "cluster1", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "description" : "Human-readable label that identifies the team." + }, + "usernames" : { + "type" : "array", + "description" : "List that contains the MongoDB Cloud users in this team.", + "items" : { + "type" : "string", + "format" : "email", + "description" : "List that contains email addresses that identify MongoDB Cloud users to in this team." + }, + "uniqueItems" : true + } + }, + "required" : [ "name" ] + }, + "TeamEvent" : { + "type" : "object", + "description" : "Team event identifies different activities around organization teams.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, "created" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "currentValue" : { - "$ref" : "#/components/schemas/TimeMetricValueView" - }, "eventTypeName" : { - "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + "$ref" : "#/components/schemas/TeamEventTypeView" }, "groupId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "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.", - "example" : "cloud-test.mongodb.com:27017", - "readOnly" : true - }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "lastNotified" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", "readOnly" : true }, "links" : { @@ -50613,51 +53566,78 @@ }, "readOnly" : true }, - "metricName" : { - "type" : "string", - "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", - "example" : "ASSERT_USER", - "readOnly" : true - }, "orgId" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "replicaSetName" : { + "publicKey" : { "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.", - "example" : "event-replica-set", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true }, - "resolved" : { + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { "type" : "string", - "format" : "date-time", - "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\"`.", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", "readOnly" : true }, - "status" : { + "teamId" : { "type" : "string", - "description" : "State of this alert at the time you requested its details.", - "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], - "example" : "OPEN", + "description" : "Unique 24-hexadecimal digit string that identifies the organization team associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "updated" : { + "userId" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true } }, - "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Team Events" }, - "TimeMetricEventView" : { + "TeamEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TEAM_CREATED", "TEAM_DELETED", "TEAM_UPDATED", "TEAM_NAME_CHANGED", "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "example" : "TEAM_ADDED_TO_GROUP", + "title" : "Team Event Types" + }, + "TeamEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "example" : "TEAM_ADDED_TO_GROUP", + "title" : "Team Event Types" + }, + "TeamEventViewForNdsGroup" : { "type" : "object", + "description" : "Team event identifies different activities around organization teams.", "properties" : { "apiKeyId" : { "type" : "string", @@ -50674,11 +53654,8 @@ "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "currentValue" : { - "$ref" : "#/components/schemas/TimeMetricValueView" - }, "eventTypeName" : { - "$ref" : "#/components/schemas/HostMetricEventTypeView" + "$ref" : "#/components/schemas/TeamEventTypeViewForNdsGroup" }, "groupId" : { "type" : "string", @@ -50716,11 +53693,6 @@ }, "readOnly" : true }, - "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" : { "type" : "string", "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", @@ -50730,13 +53702,6 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "port" : { - "type" : "integer", - "format" : "int32", - "description" : "IANA port on which the MongoDB process listens for requests.", - "example" : 27017, - "readOnly" : true - }, "publicKey" : { "type" : "string", "format" : "email", @@ -50754,16 +53719,13 @@ "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", "readOnly" : true }, - "replicaSetName" : { - "type" : "string", - "description" : "Human-readable label of the replica set associated with the event.", - "example" : "event-replica-set", - "readOnly" : true - }, - "shardName" : { + "teamId" : { "type" : "string", - "description" : "Human-readable label of the shard associated with the event.", - "example" : "event-sh-01", + "description" : "Unique 24-hexadecimal digit string that identifies the organization team associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, "userId" : { @@ -50783,250 +53745,220 @@ "readOnly" : true } }, - "required" : [ "created", "eventTypeName", "id" ] + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Team Events" }, - "TimeMetricThresholdView" : { + "TeamNotification" : { "type" : "object", + "description" : "Team notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", "properties" : { - "metricName" : { - "type" : "string", - "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." }, - "mode" : { + "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:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { "type" : "string", - "description" : "MongoDB Cloud computes the current metric value as an average.", - "enum" : [ "AVERAGE" ] + "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" }, - "operator" : { - "$ref" : "#/components/schemas/Operator" + "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:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" }, - "threshold" : { - "type" : "number", - "format" : "double", - "description" : "Value of metric that, when exceeded, triggers an alert." + "teamId" : { + "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", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" }, - "units" : { - "$ref" : "#/components/schemas/TimeMetricUnits" - } - }, - "required" : [ "metricName" ] - }, - "TimeMetricUnits" : { - "type" : "string", - "default" : "HOURS", - "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", - "enum" : [ "NANOSECONDS", "MILLISECONDS", "MILLION_MINUTES", "SECONDS", "MINUTES", "HOURS", "DAYS" ], - "title" : "Time Metric Units" - }, - "TimeMetricValueView" : { - "type" : "object", - "description" : "Measurement of the **metricName** recorded at the time of the event.", - "properties" : { - "number" : { - "type" : "number", - "format" : "double", - "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", - "readOnly" : true + "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" }, - "units" : { - "$ref" : "#/components/schemas/TimeMetricUnits" - } - }, - "readOnly" : true, - "title" : "Time Metric Value" - }, - "TokenFilterEnglishPossessive" : { - "type" : "object", - "description" : "Filter that removes possessives (trailing 's) from words.", - "properties" : { - "type" : { + "typeName" : { "type" : "string", - "description" : "Human-readable label that identifies this token filter type.", - "enum" : [ "englishPossessive" ] + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "TEAM" ] } }, - "required" : [ "type" ], - "title" : "englishPossessive" + "required" : [ "typeName" ], + "title" : "Team Notification" }, - "TokenFilterFlattenGraph" : { + "TeamResponse" : { "type" : "object", - "description" : "Filter that transforms a token filter graph, such as the token filter graph that the wordDelimiterGraph token filter produces, into a flat form suitable for indexing.", "properties" : { - "type" : { + "id" : { "type" : "string", - "description" : "Human-readable label that identifies this token filter type.", - "enum" : [ "flattenGraph" ] + "description" : "Unique 24-hexadecimal digit string that identifies this team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the team." } - }, - "required" : [ "type" ], - "title" : "flattenGraph" + } }, - "TokenFilterPorterStemming" : { + "TeamRole" : { "type" : "object", - "description" : "Filter that uses the porter stemming algorithm to remove the common morphological and inflectional suffixes from words in English. It expects lowercase text and doesn't work as expected for uppercase text.", "properties" : { - "type" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "roleNames" : { + "type" : "array", + "description" : "One or more organization- or project-level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "teamId" : { "type" : "string", - "description" : "Human-readable label that identifies this token filter type.", - "enum" : [ "porterStemming" ] + "description" : "Unique 24-hexadecimal character string that identifies the team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" } - }, - "required" : [ "type" ], - "title" : "porterStemming" + } }, - "TokenFilterSpanishPluralStemming" : { + "TeamUpdate" : { "type" : "object", - "description" : "Filter that stems Spanish plural words. It expects lowercase text.", "properties" : { - "type" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { "type" : "string", - "description" : "Human-readable label that identifies this token filter type.", - "enum" : [ "spanishPluralStemming" ] + "description" : "Human-readable label that identifies the team.", + "writeOnly" : true } }, - "required" : [ "type" ], - "title" : "spanishPluralStemming" + "required" : [ "name" ] }, - "TokenFilterStempel" : { + "TenantHardwareSpec" : { "type" : "object", - "description" : "Filter that uses Lucene's default Polish stemmer table to stem words in the Polish language. It expects lowercase text.", - "externalDocs" : { - "description" : "Default Polish stemmer table", - "url" : "https://lucene.apache.org/core/9_2_0/analysis/stempel/org/apache/lucene/analysis/pl/PolishAnalyzer.html#DEFAULT_STEMMER_FILE" - }, "properties" : { - "type" : { + "instanceSize" : { "type" : "string", - "description" : "Human-readable label that identifies this token filter type.", - "enum" : [ "stempel" ] + "description" : "Hardware specification for the instances in this M0/M2/M5 tier cluster.", + "enum" : [ "M0", "M2", "M5" ], + "title" : "Tenant Instance Sizes" } - }, - "required" : [ "type" ], - "title" : "stempel" + } }, - "TokenFilterWordDelimiterGraph" : { + "TenantHardwareSpec20240805" : { "type" : "object", - "description" : "Filter that splits tokens into sub-tokens based on configured rules.", "properties" : { - "delimiterOptions" : { - "type" : "object", - "description" : "Object that contains the rules that determine how to split words into sub-words.", - "properties" : { - "concatenateAll" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether to concatenate runs." - }, - "concatenateNumbers" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether to concatenate runs of sub-numbers." - }, - "concatenateWords" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether to concatenate runs of sub-words." - }, - "generateNumberParts" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether to split tokens based on sub-numbers. For example, if `true`, this option splits `100-2` into `100` and `2`." - }, - "generateWordParts" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether to split tokens based on sub-words." - }, - "ignoreKeywords" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether to skip tokens with the `keyword` attribute set to `true`" - }, - "preserveOriginal" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether to generate tokens of the original words." - }, - "splitOnCaseChange" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether to split tokens based on letter-case transitions." - }, - "splitOnNumerics" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether to split tokens based on letter-number transitions." - }, - "stemEnglishPossessive" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether to remove trailing possessives from each sub-word." - } - } - }, - "protectedWords" : { - "type" : "object", - "description" : "Object that contains options for protected words.", - "properties" : { - "ignoreCase" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether to ignore letter case sensitivity for protected words." - }, - "words" : { - "type" : "array", - "description" : "List that contains the tokens to protect from delimination.", - "items" : { - "type" : "string" - } - } - }, - "required" : [ "words" ] + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 }, - "type" : { + "instanceSize" : { "type" : "string", - "description" : "Human-readable label that identifies this token filter type.", - "enum" : [ "wordDelimiterGraph" ] + "description" : "Hardware specification for the instances in this M0/M2/M5 tier cluster.", + "enum" : [ "M0", "M2", "M5" ], + "title" : "Tenant Instance Sizes" } - }, - "required" : [ "type" ], - "title" : "wordDelimiterGraph" + } }, - "TokenFilterkStemming" : { + "TenantRegionConfig" : { "type" : "object", - "description" : "Filter that combines algorithmic stemming with a built-in dictionary for the English language to stem words.", - "properties" : { - "type" : { - "type" : "string", - "description" : "Human-readable label that identifies this token filter type.", - "enum" : [ "kStemming" ] + "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`.", + "enum" : [ "AWS", "GCP", "AZURE" ] + } } - }, - "required" : [ "type" ], - "title" : "kStemming" + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Tenant Regional Replication Specifications" }, - "TriggerIngestionPipelineRequest" : { + "TenantRegionConfig20240805" : { "type" : "object", - "properties" : { - "datasetRetentionPolicy" : { - "$ref" : "#/components/schemas/DatasetRetentionPolicy" - }, - "snapshotId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "writeOnly" : true + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20240805" + }, { + "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`.", + "enum" : [ "AWS", "GCP", "AZURE" ] + } } - }, - "required" : [ "snapshotId" ] + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Tenant Regional Replication Specifications" }, - "USSBackupRestoreJob20250101" : { + "TenantRestore" : { "type" : "object", - "description" : "Details for one restore job of a USS instance.", "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the source cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "readOnly" : true + }, "deliveryType" : { "type" : "string", "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", @@ -51048,14 +53980,6 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "instanceName" : { - "type" : "string", - "description" : "Human-readable label that identifies the source instance.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "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.", @@ -51101,8 +54025,7 @@ "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "pattern" : "^([a-f0-9]{24})$" }, "snapshotUrl" : { "type" : "string", @@ -51117,176 +54040,311 @@ }, "targetDeploymentItemName" : { "type" : "string", - "description" : "Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another USS instance or Dedicated cluster tier.", + "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.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", - "readOnly" : true + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" }, "targetProjectId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the cluster to which you want to restore the snapshot.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "pattern" : "^([a-f0-9]{24})$" } }, - "title" : "USS Backup Restore Job" + "required" : [ "snapshotId", "targetDeploymentItemName" ] + }, + "TenantWithSampleConnections" : { + "type" : "object" }, - "USSBackupRestoreJobCreate20250101" : { + "TextSearchHostStatusDetail" : { "type" : "object", - "description" : "Details to create one restore job of a USS instance.", "properties" : { - "_snapshotId" : { + "hostname" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "writeOnly" : true + "description" : "Hostname that corresponds to the status detail." }, - "_targetDeploymentItemName" : { - "type" : "string", - "description" : "Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another USS instance or Dedicated cluster tier.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", - "writeOnly" : true + "mainIndex" : { + "$ref" : "#/components/schemas/TextSearchIndexStatusDetail" }, - "_targetProjectId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "writeOnly" : true + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on the host." }, - "deliveryType" : { - "type" : "string", - "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", - "enum" : [ "RESTORE", "DOWNLOAD" ], - "readOnly" : true + "stagedIndex" : { + "$ref" : "#/components/schemas/TextSearchIndexStatusDetail" }, - "expirationDate" : { + "status" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true - }, - "id" : { + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Text Search Host Status Detail" + }, + "TextSearchIndexCreateRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexCreateRequest" + }, { + "type" : "object", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + } + } + } ], + "description" : "Text Search Index Create Request", + "required" : [ "collectionName", "database", "definition", "name" ] + }, + "TextSearchIndexDefinition" : { + "type" : "object", + "description" : "The text search index definition set by the user.", + "properties" : { + "analyzer" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "default" : "lucene.standard", + "description" : "Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves making the following changes to the text in fields:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\n MongoDB Cloud uses the process you select to build the Atlas Search index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ], + "externalDocs" : { + "description" : "Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/analyzers--fts" + } }, - "instanceName" : { + "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" + }, + "items" : { + "$ref" : "#/components/schemas/AtlasSearchAnalyzer" + } + }, + "mappings" : { + "$ref" : "#/components/schemas/SearchMappings" + }, + "searchAnalyzer" : { "type" : "string", - "description" : "Human-readable label that identifies the source instance.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "readOnly" : true + "default" : "lucene.standard", + "description" : "Method applied to identify words when searching this index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] }, - "links" : { + "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 Stored Source Fields.", + "example" : { + "include | exclude" : [ "field1", "field2" ] + }, + "externalDocs" : { + "description" : "Stored Source Fields", + "url" : "https://dochub.mongodb.org/core/atlas-search-stored-source" + } + }, + "synonyms" : { "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.", + "description" : "Rule sets that map words to their synonyms in this index.", "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + "description" : "Synonym Mapping", + "url" : "https://dochub.mongodb.org/core/fts-synonym-mappings" }, "items" : { - "$ref" : "#/components/schemas/Link" + "$ref" : "#/components/schemas/SearchSynonymMappingDefinition" + } + } + }, + "required" : [ "mappings" ], + "title" : "Text Search Index Definition" + }, + "TextSearchIndexResponse" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexResponse" + }, { + "type" : "object", + "properties" : { + "latestDefinition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" }, - "readOnly" : true + "statusDetail" : { + "type" : "array", + "description" : "List of documents detailing index status on each host.", + "items" : { + "$ref" : "#/components/schemas/TextSearchHostStatusDetail" + } + }, + "synonymMappingStatus" : { + "type" : "string", + "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", + "enum" : [ "FAILED", "BUILDING", "READY" ] + }, + "synonymMappingStatusDetail" : { + "type" : "array", + "description" : "A list of documents describing the status of the index's synonym mappings on each search host. Only appears if the index has synonyms defined.", + "items" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetail" + } + } + } + } + } ], + "title" : "Text Search Index Response" + }, + "TextSearchIndexStatusDetail" : { + "type" : "object", + "description" : "Contains status information about a text search index.", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" }, - "projectId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" }, - "restoreFinishedDate" : { + "message" : { "type" : "string", - "format" : "date-time", - "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.", - "readOnly" : true + "description" : "Optional message describing an error." }, - "restoreScheduledDate" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index generation is queryable on the host." }, - "snapshotFinishedDate" : { + "status" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] }, - "snapshotUrl" : { + "synonymMappingStatus" : { "type" : "string", - "description" : "Internet address from which you can download the compressed snapshot files. The resource returns this parameter when `\"deliveryType\" : \"DOWNLOAD\"`.", - "readOnly" : true + "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", + "enum" : [ "FAILED", "BUILDING", "READY" ] }, - "status" : { - "type" : "string", - "description" : "Phase of the restore workflow for this job at the time this resource made this request.", - "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], - "readOnly" : true + "synonymMappingStatusDetail" : { + "type" : "array", + "description" : "List of synonym statuses by mapping.", + "items" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetailMap" + } } }, - "required" : [ "_snapshotId", "_targetDeploymentItemName" ], - "title" : "Create USS Backup Restore Job" + "title" : "Text Search Index Status Detail" }, - "USSBackupSettings20250101" : { + "ThirdPartyIntegration" : { "type" : "object", - "description" : "USS backup configuration", + "description" : "Collection of settings that describe third-party integrations.", + "discriminator" : { + "mapping" : { + "DATADOG" : "#/components/schemas/Datadog", + "MICROSOFT_TEAMS" : "#/components/schemas/MicrosoftTeams", + "NEW_RELIC" : "#/components/schemas/NewRelic", + "OPS_GENIE" : "#/components/schemas/OpsGenie", + "PAGER_DUTY" : "#/components/schemas/PagerDuty", + "PROMETHEUS" : "#/components/schemas/Prometheus", + "SLACK" : "#/components/schemas/Slack", + "VICTOR_OPS" : "#/components/schemas/VictorOps", + "WEBHOOK" : "#/components/schemas/Webhook" + }, + "propertyName" : "type" + }, "properties" : { - "enabled" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether backups are performed for this USS instance. Backup uses [TODO](TODO) for USS instances.", - "readOnly" : true + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "type" : { + "type" : "string", + "description" : "Integration type", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" } }, - "readOnly" : true, - "title" : "USS backup configuration" + "title" : "Third-Party Integration" }, - "USSBackupSnapshot20250101" : { + "TimeMetricAlertView" : { "type" : "object", - "description" : "Details for one snapshot of a USS instance.", "properties" : { - "expiration" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "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.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "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.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "readOnly" : true + }, + "created" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "finishTime" : { + "currentValue" : { + "$ref" : "#/components/schemas/TimeMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "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.", + "example" : "cloud-test.mongodb.com:27017", "readOnly" : true }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, "links" : { "type" : "array", "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", @@ -51299,116 +54357,76 @@ }, "readOnly" : true }, - "mongoDBVersion" : { + "metricName" : { "type" : "string", - "description" : "MongoDB host version that the snapshot runs.", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", "readOnly" : true }, - "scheduledTime" : { + "orgId" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud will take the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "startTime" : { + "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.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when MongoDB Cloud began taking the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "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\"`.", "readOnly" : true }, "status" : { "type" : "string", - "description" : "Phase of the workflow for this snapshot at the time this resource made this request.", - "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true } }, - "title" : "USS Backup Snapshot" + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] }, - "USSBackupSnapshotDownloadCreate20250101" : { + "TimeMetricEventView" : { "type" : "object", - "description" : "Details for one backup snapshot download of a USS instance.", "properties" : { - "_snapshotId" : { + "apiKeyId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to download.", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", - "writeOnly" : true - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - } - }, - "required" : [ "_snapshotId" ], - "title" : "USS Backup Snapshot Download Create" - }, - "USSConnectionStrings20250101" : { - "type" : "object", - "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", - "externalDocs" : { - "description" : "Connection string URI format.", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, - "properties" : { - "standard" : { - "type" : "string", - "description" : "Public connection string that you can use to connect to this cluster. This connection string uses the mongodb:// protocol.", - "externalDocs" : { - "description" : "Connection String URI Format", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, - "readOnly" : true - }, - "standardSrv" : { - "type" : "string", - "description" : "Public connection string that you can use to connect to this USS instance. This connection string uses the `mongodb+srv://` protocol.", - "externalDocs" : { - "description" : "Connection String URI Format", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, "readOnly" : true - } - }, - "readOnly" : true, - "title" : "USS Instance Connection Strings" - }, - "USSInstanceDescription20250101" : { - "type" : "object", - "description" : "Group of settings that configure a MongoDB USS instance.", - "properties" : { - "backupSettings" : { - "$ref" : "#/components/schemas/USSBackupSettings20250101" }, - "clusterType" : { + "created" : { "type" : "string", - "description" : "USS instance topology.", - "enum" : [ "REPLICASET", "LOADBALANCED" ], + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "connectionStrings" : { - "$ref" : "#/components/schemas/USSConnectionStrings20250101" + "currentValue" : { + "$ref" : "#/components/schemas/TimeMetricValueView" }, - "createDate" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created this instance. This parameter expresses its value in ISO 8601 format in UTC.", - "readOnly" : true + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" }, "groupId" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the project.", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -51417,13 +54435,19 @@ }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the instance.", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, "links" : { "type" : "array", "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", @@ -51436,167 +54460,314 @@ }, "readOnly" : true }, - "mongoDBVersion" : { + "metricName" : { "type" : "string", - "description" : "Version of MongoDB that the instance runs.", - "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", "readOnly" : true }, - "name" : { + "orgId" : { "type" : "string", - "description" : "Human-readable label that identifies the instance.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "providerSettings" : { - "$ref" : "#/components/schemas/USSProviderSettings20250101" + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true }, - "stateName" : { + "publicKey" : { "type" : "string", - "description" : "Human-readable label that indicates the current operating condition of this instance.", - "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true }, - "tags" : { - "type" : "array", - "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.", - "externalDocs" : { - "description" : "Resource Tags", - "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" - }, - "items" : { - "$ref" : "#/components/schemas/ResourceTag" - } + "raw" : { + "$ref" : "#/components/schemas/raw" }, - "terminationProtectionEnabled" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true }, - "versionReleaseSystem" : { + "replicaSetName" : { "type" : "string", - "default" : "LTS", - "description" : "Method by which the cluster maintains the MongoDB versions.", - "enum" : [ "LTS" ], + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true } }, - "required" : [ "providerSettings" ], - "title" : "USS Instance Description" + "required" : [ "created", "eventTypeName", "id" ] }, - "USSInstanceDescriptionCreate20250101" : { + "TimeMetricThresholdView" : { "type" : "object", - "description" : "Settings that you can specify when you create a USS instance.", "properties" : { - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." }, - "name" : { + "mode" : { "type" : "string", - "description" : "Human-readable label that identifies the instance.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "writeOnly" : true + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] }, - "providerSettings" : { - "$ref" : "#/components/schemas/USSProviderSettingsCreate20250101" + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, - "tags" : { - "type" : "array", - "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.", - "externalDocs" : { - "description" : "Resource Tags", - "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" - }, - "items" : { - "$ref" : "#/components/schemas/ResourceTag" - } + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." }, - "terminationProtectionEnabled" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" } }, - "required" : [ "name", "providerSettings" ], - "title" : "USS Instance Description Create" + "required" : [ "metricName" ] + }, + "TimeMetricUnits" : { + "type" : "string", + "default" : "HOURS", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "NANOSECONDS", "MILLISECONDS", "MILLION_MINUTES", "SECONDS", "MINUTES", "HOURS", "DAYS" ], + "title" : "Time Metric Units" }, - "USSProviderSettings20250101" : { + "TimeMetricValueView" : { "type" : "object", - "description" : "Group of cloud provider settings that configure the provisioned MongoDB USS instance.", + "description" : "Measurement of the **metricName** recorded at the time of the event.", "properties" : { - "backingProviderName" : { - "type" : "string", - "description" : "Cloud service provider on which MongoDB Cloud provisioned the USS instance.", - "enum" : [ "AWS", "AZURE", "GCP" ], - "readOnly" : true - }, - "diskSizeGB" : { + "number" : { "type" : "number", "format" : "double", - "description" : "Storage capacity available to the USS instance expressed in gigabytes.", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", "readOnly" : true }, - "providerName" : { + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "readOnly" : true, + "title" : "Time Metric Value" + }, + "TokenFilterEnglishPossessive" : { + "type" : "object", + "description" : "Filter that removes possessives (trailing 's) from words.", + "properties" : { + "type" : { "type" : "string", - "default" : "USS", - "description" : "Human-readable label that identifies the cloud service provider.", - "enum" : [ "USS" ], - "readOnly" : true - }, - "regionName" : { + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "englishPossessive" ] + } + }, + "required" : [ "type" ], + "title" : "englishPossessive" + }, + "TokenFilterFlattenGraph" : { + "type" : "object", + "description" : "Filter that transforms a token filter graph, such as the token filter graph that the wordDelimiterGraph token filter produces, into a flat form suitable for indexing.", + "properties" : { + "type" : { "type" : "string", - "description" : "Human-readable label that identifies the geographic location of your MongoDB USS 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/).", - "readOnly" : true + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "flattenGraph" ] } }, - "readOnly" : true, - "title" : "Cloud Service Provider Settings for a USS Instance" + "required" : [ "type" ], + "title" : "flattenGraph" }, - "USSProviderSettingsCreate20250101" : { + "TokenFilterPorterStemming" : { "type" : "object", - "description" : "Group of cloud provider settings that configure the provisioned MongoDB USS instance.", + "description" : "Filter that uses the porter stemming algorithm to remove the common morphological and inflectional suffixes from words in English. It expects lowercase text and doesn't work as expected for uppercase text.", "properties" : { - "backingProviderName" : { + "type" : { "type" : "string", - "description" : "Cloud service provider on which MongoDB Cloud provisioned the serverless instance.", - "enum" : [ "AWS", "AZURE", "GCP" ], - "writeOnly" : true + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "porterStemming" ] + } + }, + "required" : [ "type" ], + "title" : "porterStemming" + }, + "TokenFilterSpanishPluralStemming" : { + "type" : "object", + "description" : "Filter that stems Spanish plural words. It expects lowercase text.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "spanishPluralStemming" ] + } + }, + "required" : [ "type" ], + "title" : "spanishPluralStemming" + }, + "TokenFilterStempel" : { + "type" : "object", + "description" : "Filter that uses Lucene's default Polish stemmer table to stem words in the Polish language. It expects lowercase text.", + "externalDocs" : { + "description" : "Default Polish stemmer table", + "url" : "https://lucene.apache.org/core/9_2_0/analysis/stempel/org/apache/lucene/analysis/pl/PolishAnalyzer.html#DEFAULT_STEMMER_FILE" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "stempel" ] + } + }, + "required" : [ "type" ], + "title" : "stempel" + }, + "TokenFilterWordDelimiterGraph" : { + "type" : "object", + "description" : "Filter that splits tokens into sub-tokens based on configured rules.", + "properties" : { + "delimiterOptions" : { + "type" : "object", + "description" : "Object that contains the rules that determine how to split words into sub-words.", + "properties" : { + "concatenateAll" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to concatenate runs." + }, + "concatenateNumbers" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to concatenate runs of sub-numbers." + }, + "concatenateWords" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to concatenate runs of sub-words." + }, + "generateNumberParts" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on sub-numbers. For example, if `true`, this option splits `100-2` into `100` and `2`." + }, + "generateWordParts" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on sub-words." + }, + "ignoreKeywords" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to skip tokens with the `keyword` attribute set to `true`" + }, + "preserveOriginal" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to generate tokens of the original words." + }, + "splitOnCaseChange" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on letter-case transitions." + }, + "splitOnNumerics" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on letter-number transitions." + }, + "stemEnglishPossessive" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to remove trailing possessives from each sub-word." + } + } }, - "diskSizeGB" : { - "type" : "number", - "format" : "double", - "description" : "Storage capacity available to the USS instance expressed in gigabytes.", - "readOnly" : true + "protectedWords" : { + "type" : "object", + "description" : "Object that contains options for protected words.", + "properties" : { + "ignoreCase" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to ignore letter case sensitivity for protected words." + }, + "words" : { + "type" : "array", + "description" : "List that contains the tokens to protect from delimination.", + "items" : { + "type" : "string" + } + } + }, + "required" : [ "words" ] }, - "providerName" : { + "type" : { "type" : "string", - "default" : "USS", - "description" : "Human-readable label that identifies the cloud service provider.", - "enum" : [ "USS" ], - "readOnly" : true + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "wordDelimiterGraph" ] + } + }, + "required" : [ "type" ], + "title" : "wordDelimiterGraph" + }, + "TokenFilterkStemming" : { + "type" : "object", + "description" : "Filter that combines algorithmic stemming with a built-in dictionary for the English language to stem words.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "kStemming" ] + } + }, + "required" : [ "type" ], + "title" : "kStemming" + }, + "TriggerIngestionPipelineRequest" : { + "type" : "object", + "properties" : { + "datasetRetentionPolicy" : { + "$ref" : "#/components/schemas/DatasetRetentionPolicy" }, - "regionName" : { + "snapshotId" : { "type" : "string", - "description" : "Human-readable label that identifies the geographic location of your MongoDB USS 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/).", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "writeOnly" : true } }, - "required" : [ "backingProviderName", "regionName" ], - "title" : "Cloud Service Provider Settings for a USS Instance", - "writeOnly" : true + "required" : [ "snapshotId" ] }, "UpdateAtlasOrganizationApiKey" : { "type" : "object", @@ -52234,7 +55405,7 @@ "description" : "Human-readable label that identifies the cluster or MongoDB Atlas Data Lake that this database user can access.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, "type" : { "type" : "string", @@ -52290,6 +55461,32 @@ "required" : [ "match" ], "title" : "User to Distinguished Name Mapping" }, + "VPCPeeringActionChallenge" : { + "type" : "object", + "description" : "Container for elements used to challenge the user before taking certain actions on VPC Peering connections.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "requesterAccountId" : { + "type" : "string", + "description" : "The AWS requester account ID." + }, + "requesterVpcId" : { + "type" : "string", + "description" : "The AWS requester VPC ID." + } + } + }, "VectorSearchHostStatusDetail" : { "type" : "object", "properties" : { diff --git a/tools/cli/test/data/split/dev/openapi-v2-2024-08-05.yaml b/tools/cli/test/data/split/dev/openapi-v2-2024-08-05.yaml index 21b174b0a7..9d5fca1a9a 100644 --- a/tools/cli/test/data/split/dev/openapi-v2-2024-08-05.yaml +++ b/tools/cli/test/data/split/dev/openapi-v2-2024-08-05.yaml @@ -13,13 +13,15 @@ info: ``` To learn more, see [Get Started with the Atlas Administration API](https://www.mongodb.com/docs/atlas/configure-api-access/). For support, see [MongoDB Support](https://www.mongodb.com/support/get-started). + + You can also explore the various endpoints available through the Atlas Administration API in MongoDB's [Postman workspace](https://www.postman.com/mongodb-devrel/workspace/mongodb-atlas-administration-apis/). license: name: CC BY-NC-SA 3.0 US url: https://creativecommons.org/licenses/by-nc-sa/3.0/us/ termsOfService: https://www.mongodb.com/mongodb-management-service-terms-and-conditions title: MongoDB Atlas Administration API version: "2.0" - x-xgen-sha: 09d9d18db2111c955a8e01702a27ca2763417782 + x-xgen-sha: e6ba3136dbd0be2a81dd4ed21b9e6c470edd4420 servers: - url: https://cloud.mongodb.com tags: @@ -82,8 +84,12 @@ tags: \ resource requires your project ID. Changes to federated database instance configurations\ \ can affect costs." name: Data Federation -- description: "Returns, adds, edits, and removes Atlas Data Lake Pipelines and associated\ +- description: "Returns, edits, and removes Atlas Data Lake Pipelines and associated\ \ runs." + externalDocs: + description: Data Lake Pipelines are deprecated. Please see Data Lake Deprecation + Guide. + url: https://dochub.mongodb.org/core/data-lake-deprecation name: Data Lake Pipelines - description: "Returns, adds, edits, and removes database users." name: Database Users @@ -158,6 +164,8 @@ tags: - description: "You can continually push logs from mongod, mongos, and audit logs\ \ to an AWS S3 bucket. Atlas exports logs every 5 minutes." name: Push-Based Log Export +- description: Configure and manage Atlas Resource Policies within your organization. + name: Resource Policies - description: Creates one index to a database deployment in a rolling manner. You can't create a rolling index on an `M0` free cluster or `M2/M5` shared cluster. name: Rolling Index @@ -173,6 +181,13 @@ tags: description: Set Up a Private Endpoint for a Serverless Instance Tutorial url: https://dochub.mongodb.org/core/serverless-private-endpoint name: Serverless Private Endpoints +- description: Endpoints for managing Service Accounts and secrets. Service Accounts + are used for programmatic access to the Atlas Admin API through the OAuth 2.0 + Client Credentials flow. This feature is available as a Preview feature. + externalDocs: + description: Get Started with the Atlas Administration API + url: https://www.mongodb.com/docs/atlas/configure-api-access/ + name: Service Accounts - description: Returns and adds restore jobs for shared-tier database deployments. name: Shared-Tier Restore Jobs - description: Returns and requests to download shared-tier database deployment snapshots. @@ -2347,9 +2362,9 @@ paths: - AWS Clusters DNS /api/atlas/v2/groups/{groupId}/backup/exportBuckets: get: - description: "Returns all AWS S3 buckets and Azure Blob Storage Containers associated\ - \ with the specified Project. To use this resource, the requesting API Key\ - \ must have the Project Read Only role. Deprecated versions: v2-{2023-01-01}" + description: "Returns all Export Buckets associated with the specified Project.\ + \ To use this resource, the requesting API Key must have the Project Read\ + \ Only role. Deprecated versions: v2-{2023-01-01}" operationId: listExportBuckets parameters: - $ref: "#/components/parameters/envelope" @@ -2372,15 +2387,15 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Return All AWS S3 Buckets and Azure Blob Storage Containers Used for - Cloud Backup Snapshot Exports + summary: Return All Snapshot Export Buckets tags: - Cloud Backups post: - description: "Grants MongoDB Cloud access to the specified AWS S3 Bucket or\ - \ Azure Blob Storage Container. This enables this Export Bucket to receive\ - \ Atlas Cloud Backup Snapshots. To use this resource, the requesting API Key\ - \ must have the Project Owner role. Deprecated versions: v2-{2023-01-01}" + description: "Creates a Snapshot Export Bucket for an AWS S3 Bucket or Azure\ + \ Blob Storage Container. Once created, an snapshots can be exported to the\ + \ Export Bucket and its referenced AWS S3 Bucket or Azure Blob Storage Container.\ + \ To use this resource, the requesting API Key must have the Project Owner\ + \ role. Deprecated versions: v2-{2023-01-01}" operationId: createExportBucket parameters: - $ref: "#/components/parameters/envelope" @@ -2407,8 +2422,8 @@ paths: schema: $ref: "#/components/schemas/DiskBackupSnapshotExportBucket" x-xgen-version: 2024-05-30 - description: Grants MongoDB Cloud access to the specified AWS S3 Bucket or - Azure Blob Storage Container. + description: Specifies the role and AWS S3 Bucket or Azure Blob Storage Container + that the Export Bucket should reference. required: true responses: "200": @@ -2451,24 +2466,21 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Grant Access to AWS S3 Bucket or Azure Blob Storage Container for Cloud - Backup Snapshot Exports + summary: Create One Snapshot Export Bucket tags: - Cloud Backups /api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}: delete: - description: "Revoke MongoDB Cloud access to the specified AWS S3 Bucket or\ - \ Azure Blob Storage Container. This prevents this Export Bucket from receiving\ - \ Atlas Cloud Backup Snapshots. 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 API Key must have the Project Owner\ - \ role." + 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 API Key must have the Project\ + \ Owner role." operationId: deleteExportBucket parameters: - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/groupId" - - description: Unique string that identifies the AWS S3 Bucket or Azure Blob - Storage Container to which you export your Snapshots. + - description: Unique 24-hexadecimal character string that identifies the Export + Bucket. in: path name: exportBucketId required: true @@ -2496,14 +2508,13 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Revoke Access to AWS S3 Bucket or Azure Blob Storage Container for - Cloud Backup Snapshot Exports + summary: Delete One Snapshot Export Bucket tags: - Cloud Backups get: - description: "Returns one AWS S3 Bucket or Azure Blob Storage Container associated\ - \ with the specified Project. To use this resource, the requesting API Key\ - \ must have the Project Read Only role. Deprecated versions: v2-{2023-01-01}" + description: "Returns one Export Bucket associated with the specified Project.\ + \ To use this resource, the requesting API Key must have the Project Read\ + \ Only role. Deprecated versions: v2-{2023-01-01}" operationId: getExportBucket parameters: - $ref: "#/components/parameters/envelope" @@ -2558,8 +2569,7 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Return One AWS S3 Bucket or Azure Blob Storage Container Used for Cloud - Backup Snapshot Exports + summary: Return One Snapshot Export Bucket tags: - Cloud Backups /api/atlas/v2/groups/{groupId}/backupCompliancePolicy: @@ -2680,7 +2690,7 @@ paths: content: application/vnd.atlas.2023-01-01+json: schema: - $ref: "#/components/schemas/CloudProviderAccessRole" + $ref: "#/components/schemas/CloudProviderAccessRoleRequest" description: Creates one role for the specified cloud provider. required: true responses: @@ -2719,6 +2729,8 @@ paths: type: string enum: - AWS + - AZURE + - GCP - description: Unique 24-hexadecimal digit string that identifies the role. in: path name: roleId @@ -2785,7 +2797,8 @@ paths: description: "Grants access to the specified project for the specified access\ \ role. To use this resource, the requesting API Key must have the Project\ \ Owner role. This API endpoint is one step in a procedure to create unified\ - \ access for MongoDB Cloud services." + \ 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/ @@ -2807,7 +2820,7 @@ paths: content: application/vnd.atlas.2023-01-01+json: schema: - $ref: "#/components/schemas/CloudProviderAccessRole" + $ref: "#/components/schemas/CloudProviderAccessRoleRequestUpdate" description: Grants access to the specified project for the specified access role. required: true @@ -2889,130 +2902,72 @@ paths: examples: Cluster: description: Cluster - value: | - { - "clusterType": "SHARDED", - "links": [], - "name": "myCluster", - "replicationSpecs": [ - { - "regionConfigs": [ - { - "analyticsAutoScaling": { - "autoIndexing": { - "enabled": false - }, - "compute": { - "enabled": true, - "maxInstanceSize": "M40", - "minInstanceSize": "M30", - "scaleDownEnabled": true - }, - "diskGB": { - "enabled": true - } - }, - "analyticsSpecs": { - "instanceSize": "M30", - "nodeCount": 0, - "diskSizeGB": 10.0 - }, - "autoScaling": { - "autoIndexing": { - "enabled": false - }, - "compute": { - "enabled": true, - "maxInstanceSize": "M40", - "minInstanceSize": "M30", - "scaleDownEnabled": true - }, - "diskGB": { - "enabled": true - } - }, - "electableSpecs": { - "instanceSize": "M30", - "nodeCount": 3, - "diskSizeGB": 10.0 - }, - "hiddenSecondarySpecs": { - "instanceSize": "M30", - "nodeCount": 0, - "diskSizeGB": 10.0 - }, - "priority": 7, - "providerName": "AWS", - "readOnlySpecs": { - "instanceSize": "M30", - "nodeCount": 0, - "diskSizeGB": 10.0 - }, - "regionName": "US_EAST_1" - } - ], - "zoneName": "Zone 1" - }, - { - "regionConfigs": [ - { - "analyticsAutoScaling": { - "autoIndexing": { - "enabled": false - }, - "compute": { - "enabled": true, - "maxInstanceSize": "M20", - "minInstanceSize": "M10", - "scaleDownEnabled": true - }, - "diskGB": { - "enabled": true - } - }, - "analyticsSpecs": { - "instanceSize": "M10", - "nodeCount": 0, - "diskSizeGB": 10.0 - }, - "autoScaling": { - "autoIndexing": { - "enabled": false - }, - "compute": { - "enabled": true, - "maxInstanceSize": "M20", - "minInstanceSize": "M10", - "scaleDownEnabled": true - }, - "diskGB": { - "enabled": true - } - }, - "electableSpecs": { - "instanceSize": "M10", - "nodeCount": 3, - "diskSizeGB": 10.0 - }, - "hiddenSecondarySpecs": { - "instanceSize": "M10", - "nodeCount": 0, - "diskSizeGB": 10.0 - }, - "priority": 7, - "providerName": "AWS", - "readOnlySpecs": { - "instanceSize": "M10", - "nodeCount": 0, - "diskSizeGB": 10.0 - }, - "regionName": "US_EAST_1" - } - ], - "zoneName": "Zone 1" - }, - ] - } + value: + clusterType: SHARDED + name: myCluster + replicationSpecs: + - regionConfigs: + - analyticsAutoScaling: + autoIndexing: + enabled: false + compute: + enabled: false + diskGB: + enabled: true + analyticsSpecs: + diskSizeGB: 10.0 + instanceSize: M30 + nodeCount: 0 + autoScaling: + autoIndexing: + enabled: false + compute: + enabled: false + diskGB: + enabled: true + electableSpecs: + diskSizeGB: 10.0 + instanceSize: M30 + nodeCount: 3 + priority: 7 + providerName: AWS + readOnlySpecs: + diskSizeGB: 10.0 + instanceSize: M30 + nodeCount: 0 + regionName: US_EAST_1 + zoneName: Zone 1 + - regionConfigs: + - analyticsAutoScaling: + autoIndexing: + enabled: false + compute: + enabled: false + diskGB: + enabled: true + analyticsSpecs: + diskSizeGB: 10.0 + instanceSize: M10 + nodeCount: 0 + autoScaling: + autoIndexing: + enabled: false + compute: + enabled: false + diskGB: + enabled: true + electableSpecs: + diskSizeGB: 10.0 + instanceSize: M10 + nodeCount: 3 + priority: 7 + providerName: AWS + readOnlySpecs: + diskSizeGB: 10.0 + instanceSize: M10 + nodeCount: 0 + regionName: US_EAST_1 + zoneName: Zone 1 schema: $ref: "#/components/schemas/ClusterDescription20240805" x-xgen-version: 2024-08-05 @@ -3190,7 +3145,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster. in: query @@ -3238,7 +3193,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -3284,7 +3239,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2024-08-05+json: @@ -3318,7 +3273,7 @@ paths: - Clusters /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports: get: - description: "Returns all Cloud Backup snapshot export jobs associated with\ + description: "Returns all Cloud Backup Snapshot Export Jobs associated with\ \ the specified Atlas cluster. To use this resource, the requesting API Key\ \ must have the Project Atlas Admin role." operationId: listBackupExportJobs @@ -3337,7 +3292,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -3352,11 +3307,11 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Return All Cloud Backup Snapshot Export Jobs + summary: Return All Snapshot Export Jobs tags: - Cloud Backups post: - description: "Exports one backup snapshot for dedicated Atlas cluster using\ + description: "Exports one backup Snapshot for dedicated Atlas cluster using\ \ Cloud Backups to an Export Bucket. To use this resource, the requesting\ \ API Key must have the Project Atlas Admin role." operationId: createBackupExportJob @@ -3371,7 +3326,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -3399,12 +3354,12 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Create One Cloud Backup Snapshot Export Job + summary: Create One Snapshot Export Job tags: - Cloud Backups /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}: get: - description: "Returns one Cloud Backup snapshot export job associated with the\ + description: "Returns one Cloud Backup Snapshot Export Job associated with the\ \ specified Atlas cluster. To use this resource, the requesting API Key must\ \ have the Project Atlas Admin role." operationId: getBackupExportJob @@ -3419,13 +3374,18 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - - description: Unique string that identifies the export job to return. + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + - description: Unique 24-hexadecimal character string that identifies the Export + Job. in: path name: exportId required: true schema: type: string + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" responses: "200": content: @@ -3440,7 +3400,7 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Return One Cloud Backup Snapshot Export Job + summary: Return One Snapshot Export Job tags: - Cloud Backups /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs: @@ -3465,7 +3425,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -3501,7 +3461,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -3550,7 +3510,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the restore job to remove. in: path @@ -3598,7 +3558,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the restore job to return. in: path @@ -3644,7 +3604,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -3683,7 +3643,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -3719,7 +3679,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2024-08-05+json: @@ -3770,7 +3730,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -3808,7 +3768,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -3853,7 +3813,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -3898,7 +3858,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -3946,7 +3906,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -3983,7 +3943,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -4029,7 +3989,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -4075,7 +4035,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -4130,7 +4090,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/groupId" - $ref: "#/components/parameters/pretty" @@ -4184,7 +4144,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/groupId" - $ref: "#/components/parameters/pretty" @@ -4233,7 +4193,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/groupId" - $ref: "#/components/parameters/pretty" @@ -4270,7 +4230,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/groupId" - $ref: "#/components/parameters/pretty" @@ -4321,7 +4281,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -4359,7 +4319,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -4412,7 +4372,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -4459,7 +4419,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -4498,7 +4458,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -4536,7 +4496,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-11-15+json: @@ -4590,7 +4550,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-11-15+json: @@ -4644,7 +4604,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-11-15+json: @@ -4699,7 +4659,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -4753,7 +4713,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Name of the collection that contains one or more Atlas Search indexes. in: path @@ -4811,7 +4771,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: "Unique 24-hexadecimal digit string that identifies the Atlas\ \ Search index. Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/)\ \ endpoint to find the IDs of all Atlas Search indexes." @@ -4866,7 +4826,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - 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/)\ @@ -4920,7 +4880,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - 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/)\ @@ -4985,7 +4945,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5027,7 +4987,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5068,7 +5028,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2024-08-05+json: @@ -5119,7 +5079,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - $ref: "#/components/parameters/groupId" - description: Human-readable label that identifies the database that contains the collection. @@ -5174,7 +5134,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2024-08-05+json: @@ -5229,7 +5189,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -5344,7 +5304,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5383,7 +5343,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -5461,7 +5421,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Flag that indicates whether to download logs for queries against your online archive only or both your online archive and cluster. in: query @@ -5528,7 +5488,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "204": content: @@ -5579,7 +5539,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5632,7 +5592,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -5683,7 +5643,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5724,7 +5684,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5765,7 +5725,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -5817,7 +5777,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5861,7 +5821,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2024-08-05+json: @@ -5913,7 +5873,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5966,7 +5926,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -6016,7 +5976,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -6064,7 +6024,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the restore job. in: path @@ -6110,7 +6070,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "204": content: @@ -6149,7 +6109,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -6186,7 +6146,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2024-05-30+json: @@ -6230,7 +6190,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2024-05-30+json: @@ -6282,7 +6242,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -6333,7 +6293,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2024-05-30+json: @@ -6385,7 +6345,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Name of the collection that contains one or more Atlas Search indexes. in: path @@ -6449,7 +6409,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Name of the collection that contains one or more Atlas Search indexes. in: path @@ -6512,7 +6472,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Name of the collection that contains one or more Atlas Search indexes. in: path @@ -6575,7 +6535,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Name of the collection that contains one or more Atlas Search indexes. in: path @@ -6646,7 +6606,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: "Unique 24-hexadecimal digit string that identifies the Atlas\ \ Search index. Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/)\ \ endpoint to find the IDs of all Atlas Search indexes." @@ -6699,7 +6659,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - 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/)\ @@ -6759,7 +6719,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - 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/)\ @@ -6821,7 +6781,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -6859,7 +6819,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -6913,7 +6873,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: "Human-readable label that specifies whether to return only completed,\ \ incomplete, or all snapshots. By default, MongoDB Cloud only returns completed\ \ snapshots." @@ -6968,7 +6928,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -7022,7 +6982,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -7075,7 +7035,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -7130,7 +7090,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -7164,7 +7124,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Human-readable label that identifies the cluster topology to retrieve metrics for. in: path @@ -7213,7 +7173,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Human-readable label that identifies the cluster topology to retrieve metrics for. in: path @@ -7290,6 +7250,55 @@ paths: summary: Return Cluster-Level Query Latency tags: - Collection Level Metrics + /api/atlas/v2/groups/{groupId}/clusters/{clusterName}:grantMongoDBEmployeeAccess: + post: + description: Grants MongoDB employee cluster access for the given duration and + at the specified level for one cluster. + operationId: grantMongoDBEmployeeAccess + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/pretty" + - $ref: "#/components/parameters/groupId" + - description: Human-readable label that identifies this cluster. + in: path + name: clusterName + required: true + schema: + type: string + maxLength: 64 + minLength: 1 + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + requestBody: + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/EmployeeAccessGrantView" + x-xgen-version: 2024-08-05 + description: Grant access level and expiration. + required: true + responses: + "204": + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/NoBody" + x-xgen-version: 2024-08-05 + description: This endpoint does not return a response body. + "400": + $ref: "#/components/responses/badRequest" + "401": + $ref: "#/components/responses/unauthorized" + "404": + $ref: "#/components/responses/notFound" + "409": + $ref: "#/components/responses/conflict" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Grant MongoDB employee cluster access for one cluster. + tags: + - Clusters /api/atlas/v2/groups/{groupId}/clusters/{clusterName}:pinFeatureCompatibilityVersion: post: description: Pins the FCV to the current MongoDB version. @@ -7306,7 +7315,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2024-05-30+json: @@ -7337,6 +7346,46 @@ paths: summary: Pin FCV for One Cluster from One Project tags: - Clusters + /api/atlas/v2/groups/{groupId}/clusters/{clusterName}:revokeMongoDBEmployeeAccess: + post: + description: Revokes a previously granted MongoDB employee cluster access. + operationId: revokeMongoDBEmployeeAccess + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/pretty" + - $ref: "#/components/parameters/groupId" + - description: Human-readable label that identifies this cluster. + in: path + name: clusterName + required: true + schema: + type: string + maxLength: 64 + minLength: 1 + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + responses: + "204": + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/NoBody" + x-xgen-version: 2024-08-05 + description: This endpoint does not return a response body. + "400": + $ref: "#/components/responses/badRequest" + "401": + $ref: "#/components/responses/unauthorized" + "404": + $ref: "#/components/responses/notFound" + "409": + $ref: "#/components/responses/conflict" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Revoke granted MongoDB employee cluster access for one cluster. + tags: + - Clusters /api/atlas/v2/groups/{groupId}/clusters/{clusterName}:unpinFeatureCompatibilityVersion: post: description: Unpins the current fixed Feature Compatibility Version. This feature @@ -7354,7 +7403,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "204": content: @@ -7424,18 +7473,22 @@ paths: externalDocs: description: Set up Database Auditing url: https://docs.atlas.mongodb.com/database-auditing/ - - description: Date and time when the period specifies the inclusive ending - point for the range of log messages to retrieve. This parameter expresses - its value in the number of seconds that have elapsed since the UNIX epoch. + - description: "Specifies the date and time for the ending point of the range\ + \ of log messages to retrieve, in the number of seconds that have elapsed\ + \ since the UNIX epoch. This value will default to 24 hours after the start\ + \ date. If the start date is also unspecified, the value will default to\ + \ the time of the request." in: query name: endDate schema: type: integer format: int64 minimum: 1199145600 - - description: Date and time when the period specifies the inclusive starting - point for the range of log messages to retrieve. This parameter expresses - its value in the number of seconds that have elapsed since the UNIX epoch. + - description: "Specifies the date and time for the starting point of the range\ + \ of log messages to retrieve, in the number of seconds that have elapsed\ + \ since the UNIX epoch. This value will default to 24 hours prior to the\ + \ end date. If the end date is also unspecified, the value will default\ + \ to 24 hours prior to the time of the request." in: query name: startDate schema: @@ -8901,7 +8954,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: "Date and time when to stop retrieving database history. If you\ \ specify **end**, you must also specify **start**. This parameter uses\ \ UNIX epoch time in milliseconds." @@ -9120,6 +9173,9 @@ paths: - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/pretty" - $ref: "#/components/parameters/groupId" + - $ref: "#/components/parameters/includeCount" + - $ref: "#/components/parameters/itemsPerPage" + - $ref: "#/components/parameters/pageNum" - description: Human-readable label that identifies the cloud provider for the private endpoints to return. in: path @@ -9217,14 +9273,6 @@ paths: maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" - requestBody: - content: - application/vnd.atlas.2023-01-01+json: - schema: - $ref: "#/components/schemas/EncryptionAtRestPrivateEndpointRequest" - description: Cloud provider of the private endpoints to delete and the list - of cloud provider regions in which to delete the private endpoints. - required: true responses: "204": content: @@ -9279,6 +9327,8 @@ paths: description: OK "403": $ref: "#/components/responses/forbidden" + "404": + $ref: "#/components/responses/notFound" "500": $ref: "#/components/responses/internalServerError" security: @@ -9310,7 +9360,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" style: form - description: |- Category of incident recorded at this moment in time. @@ -9937,7 +9987,7 @@ paths: summary: Return All Project Invitations tags: - Projects - x-sunset: 2024-10-04 + x-sunset: 2024-11-04 patch: deprecated: true description: "Updates the details of one pending invitation to the specified\ @@ -9978,7 +10028,7 @@ paths: summary: Update One Project Invitation tags: - Projects - x-sunset: 2024-10-04 + x-sunset: 2024-11-04 post: deprecated: true description: "Invites one MongoDB Cloud user to join the specified project.\ @@ -10014,7 +10064,7 @@ paths: summary: Invite One MongoDB Cloud User to Join One Project tags: - Projects - x-sunset: 2024-10-04 + x-sunset: 2024-11-04 /api/atlas/v2/groups/{groupId}/invites/{invitationId}: delete: deprecated: true @@ -10052,7 +10102,7 @@ paths: summary: Cancel One Project Invitation tags: - Projects - x-sunset: 2024-10-04 + x-sunset: 2024-11-04 get: deprecated: true description: "Returns the details of one pending invitation to the specified\ @@ -10091,7 +10141,7 @@ paths: summary: Return One Project Invitation tags: - Projects - x-sunset: 2024-10-04 + x-sunset: 2024-11-04 patch: deprecated: true description: "Updates the details of one pending invitation to the specified\ @@ -10141,7 +10191,7 @@ paths: summary: Update One Project Invitation by Invitation ID tags: - Projects - x-sunset: 2024-10-04 + x-sunset: 2024-11-04 /api/atlas/v2/groups/{groupId}/ipAddresses: get: description: "Returns all IP addresses for this project. To use this resource,\ @@ -10217,7 +10267,7 @@ paths: | Limit Name | Description | Default | API Override Limit | | --- | --- | --- | --- | - | atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 | + | atlas.project.deployment.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 | @@ -10229,6 +10279,7 @@ paths: | 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 | in: path name: limitName required: true @@ -10248,6 +10299,7 @@ paths: - 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" @@ -10282,7 +10334,7 @@ paths: | Limit Name | Description | Default | API Override Limit | | --- | --- | --- | --- | - | atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 | + | atlas.project.deployment.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 | @@ -10294,6 +10346,7 @@ paths: | 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 | in: path name: limitName required: true @@ -10313,6 +10366,7 @@ paths: - 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" @@ -10351,7 +10405,7 @@ paths: | Limit Name | Description | Default | API Override Limit | | --- | --- | --- | --- | - | atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 | + | atlas.project.deployment.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 | @@ -10363,6 +10417,7 @@ paths: | 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 | in: path name: limitName required: true @@ -10382,6 +10437,7 @@ paths: - 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" @@ -11154,6 +11210,7 @@ paths: - Network Peering /api/atlas/v2/groups/{groupId}/pipelines: get: + deprecated: true description: "Returns a list of Data Lake Pipelines. To use this resource, the\ \ requesting API Key must have the Project Read Only role." operationId: listPipelines @@ -11181,8 +11238,14 @@ paths: summary: Return All Data Lake Pipelines from One Project tags: - Data Lake Pipelines + x-sunset: 2025-09-09 post: + deprecated: true description: Creates one Data Lake Pipeline. + externalDocs: + description: Data Lake Pipelines are deprecated. Please see Data Lake Deprecation + Guide. + url: https://dochub.mongodb.org/core/data-lake-deprecation operationId: createPipeline parameters: - $ref: "#/components/parameters/envelope" @@ -11215,8 +11278,10 @@ paths: summary: Create One Data Lake Pipeline tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}: delete: + deprecated: true description: Removes one Data Lake Pipeline. operationId: deletePipeline parameters: @@ -11250,7 +11315,9 @@ paths: summary: Remove One Data Lake Pipeline tags: - Data Lake Pipelines + x-sunset: 2025-09-09 get: + deprecated: true description: "Returns the details of one Data Lake Pipeline within the specified\ \ project. To use this resource, the requesting API Key must have the Project\ \ Read Only role." @@ -11287,7 +11354,9 @@ paths: summary: Return One Data Lake Pipeline tags: - Data Lake Pipelines + x-sunset: 2025-09-09 patch: + deprecated: true description: Updates one Data Lake Pipeline. operationId: updatePipeline parameters: @@ -11332,8 +11401,10 @@ paths: summary: Update One Data Lake Pipeline tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules: get: + deprecated: true description: "Returns a list of backup schedule policy items that you can use\ \ as a Data Lake Pipeline source. To use this resource, the requesting API\ \ Key must have the Project Read Only role." @@ -11372,8 +11443,10 @@ paths: summary: Return Available Ingestion Schedules for One Data Lake Pipeline tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots: get: + deprecated: true description: "Returns a list of backup snapshots that you can use to trigger\ \ an on demand pipeline run. To use this resource, the requesting API Key\ \ must have the Project Read Only role." @@ -11423,8 +11496,10 @@ paths: summary: Return Available Backup Snapshots for One Data Lake Pipeline tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause: post: + deprecated: true description: "Pauses ingestion for a Data Lake Pipeline within the specified\ \ project. To use this resource, the requesting API Key must have the Project\ \ Read Only role." @@ -11461,8 +11536,10 @@ paths: summary: Pause One Data Lake Pipeline tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume: post: + deprecated: true description: "Resumes ingestion for a Data Lake Pipeline within the specified\ \ project. To use this resource, the requesting API Key must have the Project\ \ Read Only role." @@ -11499,8 +11576,10 @@ paths: summary: Resume One Data Lake Pipeline tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs: get: + deprecated: true description: "Returns a list of past Data Lake Pipeline runs. To use this resource,\ \ the requesting API Key must have the Project Read Only role." operationId: listPipelineRuns @@ -11547,8 +11626,10 @@ paths: summary: Return All Data Lake Pipeline Runs from One Project tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}: delete: + deprecated: true description: Deletes dataset that Atlas generated during the specified pipeline run. operationId: deletePipelineRunDataset @@ -11595,7 +11676,9 @@ paths: summary: Delete Pipeline Run Dataset tags: - Data Lake Pipelines + x-sunset: 2025-09-09 get: + deprecated: true description: "Returns the details of one Data Lake Pipeline run within the specified\ \ project. To use this resource, the requesting API Key must have the Project\ \ Read Only role." @@ -11643,8 +11726,10 @@ paths: summary: Return One Data Lake Pipeline Run tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger: post: + deprecated: true description: Triggers a Data Lake Pipeline ingestion of a specified snapshot. operationId: triggerSnapshotIngestion parameters: @@ -11686,6 +11771,7 @@ paths: summary: Trigger on demand snapshot ingestion tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService: post: description: "Creates one private endpoint service for the specified cloud service\ @@ -11817,7 +11903,7 @@ paths: schema: type: string maxLength: 64 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -11859,7 +11945,7 @@ paths: schema: type: string maxLength: 64 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -11903,7 +11989,7 @@ paths: schema: type: string maxLength: 64 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be removed. in: path @@ -11949,7 +12035,7 @@ paths: schema: type: string maxLength: 64 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the tenant endpoint. in: path @@ -11994,7 +12080,7 @@ paths: schema: type: string maxLength: 64 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be updated. in: path @@ -13016,6 +13102,8 @@ paths: - 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 maxItems: 10 minItems: 1 uniqueItems: true @@ -13100,6 +13188,8 @@ paths: - CACHE_BYTES_WRITTEN_FROM - CACHE_DIRTY_BYTES - CACHE_USED_BYTES + - CACHE_FILL_RATIO + - DIRTY_FILL_RATIO - COMPUTED_MEMORY - CONNECTIONS - CURSORS_TOTAL_OPEN @@ -13181,6 +13271,7 @@ paths: - 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 @@ -13723,7 +13814,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "201": content: @@ -13868,7 +13959,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -13906,7 +13997,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -13956,7 +14047,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the restore job to return. in: path @@ -14007,7 +14098,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -14044,7 +14135,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -14089,7 +14180,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/pretty" responses: @@ -14122,7 +14213,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Value that we want to set for the Serverless Auto Indexing toggle. in: query name: enable @@ -14166,15 +14257,15 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: - "204": + "202": content: application/vnd.atlas.2023-01-01+json: schema: - $ref: "#/components/schemas/NoBody" + $ref: "#/components/schemas/RequestAccepted" x-xgen-version: 2023-01-01 - description: This endpoint does not return a response body. + description: Accepted "400": $ref: "#/components/responses/badRequest" "404": @@ -14205,7 +14296,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -14243,7 +14334,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -14272,8 +14363,8 @@ paths: - Serverless Instances /api/atlas/v2/groups/{groupId}/serviceAccounts: get: - description: Returns list of Service Accounts for a project with service account - details. + description: Returns all Service Accounts for the specified Project. Available + as a preview feature. operationId: listProjectServiceAccounts parameters: - $ref: "#/components/parameters/groupId" @@ -14284,10 +14375,10 @@ paths: responses: "200": content: - application/vnd.atlas.2023-10-01+json: + application/vnd.atlas.2024-08-05+json: schema: $ref: "#/components/schemas/PaginatedGroupServiceAccounts" - x-xgen-version: 2023-10-01 + x-xgen-version: 2024-08-05 description: OK "401": $ref: "#/components/responses/unauthorized" @@ -14297,12 +14388,13 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Return All project Service Accounts + summary: List All Project Service Accounts tags: - - Groups + - Service Accounts post: - description: Creates and assigns the specified Service Account to the specified - Project. + description: Creates one Service Account for the specified Project. The Service + Account will automatically be added as an Organization Member to the Organization + that the specified Project is a part of. Available as a preview feature. operationId: createProjectServiceAccount parameters: - $ref: "#/components/parameters/groupId" @@ -14310,19 +14402,19 @@ paths: - $ref: "#/components/parameters/pretty" requestBody: content: - application/vnd.atlas.2023-10-01+json: + application/vnd.atlas.2024-08-05+json: schema: $ref: "#/components/schemas/GroupServiceAccountRequest" - x-xgen-version: 2023-10-01 - description: Details to create service account and add to the specified project. + x-xgen-version: 2024-08-05 + description: Details of the new Service Account. required: true responses: "201": content: - application/vnd.atlas.2023-10-01+json: + application/vnd.atlas.2024-08-05+json: schema: $ref: "#/components/schemas/GroupServiceAccount" - x-xgen-version: 2023-10-01 + x-xgen-version: 2024-08-05 description: Created "400": $ref: "#/components/responses/badRequest" @@ -14332,32 +14424,37 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Create and Assign one Service Account to one project + summary: Create and Assign one Service Account to one Project tags: - - Groups - /api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}: + - Service Accounts + /api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}: delete: - description: Removes one Service Account from the specified project. + description: "Removes the specified Service Account from the specified project.\ + \ The Service Account will still be a part of the Organization it was created\ + \ in, and the credentials will remain active until expired or manually revoked.\ + \ Available as a preview feature." operationId: deleteProjectServiceAccount parameters: - - description: Id of the service account. + - description: The Client ID of the Service Account. in: path - name: serviceAccountId + name: clientId required: true schema: type: string + example: mdb_sa_id_667066535bc75b03c37b3038 + pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" - $ref: "#/components/parameters/groupId" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/pretty" responses: "204": content: - application/vnd.atlas.2023-10-01+json: + application/vnd.atlas.2024-08-05+json: schema: $ref: "#/components/schemas/NoBody" - x-xgen-version: 2023-10-01 + x-xgen-version: 2024-08-05 description: This endpoint does not return a response body. - x-xgen-version: 2023-10-01 + x-xgen-version: 2024-08-05 "401": $ref: "#/components/responses/unauthorized" "404": @@ -14366,29 +14463,32 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Unassign One Service Account from One Project. + summary: Unassign One Service Account from One Project tags: - - Groups + - Service Accounts get: - description: Get project Service Account Details. + description: Returns one Service Account in the specified Project. Available + as a preview feature. operationId: getProjectServiceAccount parameters: - $ref: "#/components/parameters/groupId" - - description: Id of the service account. + - description: The Client ID of the Service Account. in: path - name: serviceAccountId + name: clientId required: true schema: type: string + example: mdb_sa_id_667066535bc75b03c37b3038 + pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/pretty" responses: "200": content: - application/vnd.atlas.2023-10-01+json: + application/vnd.atlas.2024-08-05+json: schema: $ref: "#/components/schemas/GroupServiceAccount" - x-xgen-version: 2023-10-01 + x-xgen-version: 2024-08-05 description: OK "401": $ref: "#/components/responses/unauthorized" @@ -14398,36 +14498,39 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Service Account Fetching + summary: Get one Project Service Account tags: - - Groups + - Service Accounts patch: - description: Update Service Account in Project. + description: Updates one Service Account in the specified Project. Available + as a preview feature. operationId: updateProjectServiceAccount parameters: - - description: Id of the service account. + - description: The Client ID of the Service Account. in: path - name: serviceAccountId + name: clientId required: true schema: type: string + example: mdb_sa_id_667066535bc75b03c37b3038 + pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" - $ref: "#/components/parameters/groupId" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/pretty" requestBody: content: - application/vnd.atlas.2023-10-01+json: + application/vnd.atlas.2024-08-05+json: schema: $ref: "#/components/schemas/GroupServiceAccountUpdateRequest" - description: Details to update service account in the specified Project. + description: The new details for the Service Account. required: true responses: "200": content: - application/vnd.atlas.2023-10-01+json: + application/vnd.atlas.2024-08-05+json: schema: $ref: "#/components/schemas/GroupServiceAccount" - x-xgen-version: 2023-10-01 + x-xgen-version: 2024-08-05 description: OK "400": $ref: "#/components/responses/badRequest" @@ -14439,42 +14542,182 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Service Account Update in Project + summary: Update one Project Service Account + tags: + - Service Accounts + /api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList: + get: + description: Returns all access list entries that you configured for the specified + Service Account for the project. Available as a preview feature. + operationId: listProjectServiceAccountAccessList + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/includeCount" + - $ref: "#/components/parameters/itemsPerPage" + - $ref: "#/components/parameters/groupId" + - $ref: "#/components/parameters/pageNum" + - $ref: "#/components/parameters/pretty" + - description: The Client ID of the Service Account. + in: path + name: clientId + required: true + schema: + type: string + example: mdb_sa_id_667066535bc75b03c37b3038 + pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" + responses: + "200": + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/PaginatedServiceAccountIPAccessEntryView" + x-xgen-version: 2024-08-05 + description: OK + "401": + $ref: "#/components/responses/unauthorized" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Return All Access List entries for one Project Service Account tags: - - Groups + - Service Accounts post: - description: Assigns the specified organization Service Account to the specified - project. + description: Add Access List Entries for the specified Service Account for the + project. Resources require all API requests to originate from IP addresses + on the API access list. Available as a preview feature. + operationId: createProjectServiceAccountAccessList + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/includeCount" + - $ref: "#/components/parameters/itemsPerPage" + - $ref: "#/components/parameters/groupId" + - $ref: "#/components/parameters/pageNum" + - $ref: "#/components/parameters/pretty" + - description: The Client ID of the Service Account. + in: path + name: clientId + required: true + schema: + type: string + example: mdb_sa_id_667066535bc75b03c37b3038 + pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" + requestBody: + content: + application/vnd.atlas.2024-08-05+json: + schema: + type: array + items: + $ref: "#/components/schemas/ServiceAccountIPAccessListEntry" + x-xgen-version: 2024-08-05 + description: A list of access list entries to add to the access list of the + specified Service Account for the project. + required: true + responses: + "200": + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/PaginatedServiceAccountIPAccessEntryView" + x-xgen-version: 2024-08-05 + description: OK + "400": + $ref: "#/components/responses/badRequest" + "401": + $ref: "#/components/responses/unauthorized" + "409": + $ref: "#/components/responses/conflict" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Add Access List entries for one Project Service Account + tags: + - Service Accounts + /api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList/{ipAddress}: + delete: + description: Removes the specified access list entry from the specified Service + Account for the project. You can't remove the requesting IP address from the + access list. Available as a preview feature. + operationId: deleteProjectServiceAccountAccessListEntry + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/groupId" + - $ref: "#/components/parameters/pretty" + - description: The Client ID of the Service Account. + in: path + name: clientId + required: true + schema: + type: string + example: mdb_sa_id_667066535bc75b03c37b3038 + pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" + - description: "One IP address or multiple IP addresses represented as one CIDR\ + \ block. When specifying a CIDR block with a subnet mask, such as 192.0.2.0/24,\ + \ use the URL-encoded value %2F for the forward slash /." + in: path + name: ipAddress + required: true + schema: + type: string + example: 192.0.2.0%2F24 + pattern: "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\\ + :){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})?$" + responses: + "204": + content: + application/vnd.atlas.2024-08-05+json: + x-xgen-version: 2024-08-05 + description: This endpoint does not return a response body. + "400": + $ref: "#/components/responses/badRequest" + "401": + $ref: "#/components/responses/unauthorized" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Remove One Access List entry from one Project Service Account + tags: + - Service Accounts + /api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}:invite: + post: + description: Assigns the specified Service Account to the specified Project. + Available as a preview feature. operationId: addProjectServiceAccount parameters: - - description: Id of the service account. + - description: The Client ID of the Service Account. in: path - name: serviceAccountId + name: clientId required: true schema: type: string + example: mdb_sa_id_667066535bc75b03c37b3038 + pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" - $ref: "#/components/parameters/groupId" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/pretty" requestBody: content: - application/vnd.atlas.2023-10-01+json: + application/vnd.atlas.2024-08-05+json: schema: type: array items: $ref: "#/components/schemas/GroupServiceAccountRoleAssignment" - x-xgen-version: 2023-10-01 - description: Service Account Roles to be assigned to the specified project. + x-xgen-version: 2024-08-05 + description: The Project permissions for the Service Account in the specified + Project. required: true responses: - "204": + "200": content: - application/vnd.atlas.2023-10-01+json: + application/vnd.atlas.2024-08-05+json: schema: - $ref: "#/components/schemas/NoBody" - x-xgen-version: 2023-10-01 - description: This endpoint does not return a response body. - x-xgen-version: 2023-10-01 + $ref: "#/components/schemas/GroupServiceAccount" + x-xgen-version: 2024-08-05 + description: OK "401": $ref: "#/components/responses/unauthorized" "404": @@ -14485,7 +14728,7 @@ paths: - DigestAuth: [] summary: Assign One Service Account to One Project tags: - - Groups + - Service Accounts /api/atlas/v2/groups/{groupId}/settings: get: description: "Returns details about the specified project's settings. To use\ @@ -14622,6 +14865,292 @@ paths: x-xgen-changelog: "2023-09-11": "The MongoDB Atlas Streams Processing API is now exposed as\ \ part of private preview, but is subject to change until GA." + /api/atlas/v2/groups/{groupId}/streams/privateLinkConnections: + get: + description: "Returns all Private Link connections for the specified project.To\ + \ use this resource, the requesting API Key must have the Project Data Access\ + \ roles, Project Owner role or Project Stream Processing Owner role." + operationId: listPrivateLinkConnections + parameters: + - $ref: "#/components/parameters/groupId" + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/itemsPerPage" + - $ref: "#/components/parameters/pageNum" + - $ref: "#/components/parameters/pretty" + responses: + "200": + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/PaginatedApiStreamsPrivateLinkView" + x-xgen-version: 2023-02-01 + description: OK + "401": + $ref: "#/components/responses/unauthorized" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Return All Private Link + tags: + - Streams + x-xgen-changelog: + "2024-10-02": "The MongoDB Atlas Streams Processing Private Link API is now\ + \ exposed as part of private preview, but is subject to change until GA." + post: + description: "Creates one Private Link in the specified project. To use this\ + \ resource, the requesting API Key must have the Project Owner or Project\ + \ Stream Processing Owner role." + operationId: createPrivateLinkConnection + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/pretty" + - $ref: "#/components/parameters/groupId" + requestBody: + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/StreamsPrivateLinkConnection" + description: Details to create one Private Link connection for a project. + project. + required: true + responses: + "200": + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/StreamsPrivateLinkConnection" + x-xgen-version: 2023-02-01 + description: OK + "400": + $ref: "#/components/responses/badRequest" + "401": + $ref: "#/components/responses/unauthorized" + "409": + $ref: "#/components/responses/unauthorized" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Create One Private Link connection + tags: + - Streams + x-xgen-changelog: + "2024-10-02": "The MongoDB Atlas Streams Processing Private Link API is now\ + \ exposed as part of private preview, but is subject to change until GA." + /api/atlas/v2/groups/{groupId}/streams/privateLinkConnections/{connectionId}: + delete: + description: "Deletes one Private Link in the specified project. To use this\ + \ resource, the requesting API Key must have the Project Owner or Project\ + \ Stream Processing Owner role." + operationId: deletePrivateLinkConnection + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/pretty" + - $ref: "#/components/parameters/groupId" + - description: Unique ID that identifies the Private Link connection. + in: path + name: connectionId + required: true + schema: + type: string + responses: + "202": + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/NoBody" + x-xgen-version: 2023-02-01 + description: Accepted + "401": + $ref: "#/components/responses/unauthorized" + "403": + $ref: "#/components/responses/forbidden" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Delete One Private Link connection + tags: + - Streams + x-xgen-changelog: + "2024-10-02": "The MongoDB Atlas Streams Processing Private Link API is now\ + \ exposed as part of private preview, but is subject to change until GA." + get: + description: "Returns the details of one Private Link connection within the\ + \ project. To use this resource, the requesting API Key must have the Project\ + \ Read Only role." + operationId: getPrivateLinkConnection + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/groupId" + - description: Unique ID that identifies the Private Link connection. + in: path + name: connectionId + required: true + schema: + type: string + responses: + "200": + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/StreamsPrivateLinkConnection" + x-xgen-version: 2023-02-01 + description: OK + "401": + $ref: "#/components/responses/unauthorized" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Return One PrivateLink Connection + tags: + - Streams + x-xgen-changelog: + "2024-10-02": "The MongoDB Atlas Streams Processing Private Link API is now\ + \ exposed as part of private preview, but is subject to change until GA." + /api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections: + get: + description: Returns a list of incoming VPC Peering Connections. + operationId: getVPCPeeringConnections + parameters: + - $ref: "#/components/parameters/groupId" + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/itemsPerPage" + - $ref: "#/components/parameters/pageNum" + - $ref: "#/components/parameters/pretty" + responses: + "200": + content: + application/vnd.atlas.2023-02-01+json: + x-xgen-version: 2023-02-01 + description: OK + "401": + $ref: "#/components/responses/unauthorized" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Return All VPC Peering Connections. + tags: + - Streams + /api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}: + delete: + description: Deletes an incoming VPC Peering connection. + operationId: deleteVPCPeeringConnection + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/groupId" + - description: The VPC Peering Connection id. + in: path + name: id + required: true + schema: + type: string + responses: + "202": + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/NoBody" + x-xgen-version: 2023-02-01 + description: Accepted + "401": + $ref: "#/components/responses/unauthorized" + "403": + $ref: "#/components/responses/forbidden" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Deletes an incoming VPC Peering connection. + tags: + - Streams + /api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:accept: + post: + description: Requests the acceptance of an incoming VPC Peering connection. + operationId: acceptVPCPeeringConnection + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/groupId" + - description: The VPC Peering Connection id. + in: path + name: id + required: true + schema: + type: string + requestBody: + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/VPCPeeringActionChallenge" + description: "Challenge values for VPC Peering requester account ID, and requester\ + \ VPC ID." + required: true + responses: + "202": + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/NoBody" + x-xgen-version: 2023-02-01 + description: Accepted + "401": + $ref: "#/components/responses/unauthorized" + "403": + $ref: "#/components/responses/forbidden" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Requests the acceptance of an incoming VPC Peering connection. + tags: + - Streams + /api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:reject: + post: + description: Requests the rejection of an incoming VPC Peering connection. + operationId: rejectVPCPeeringConnection + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/groupId" + - description: The VPC Peering Connection id. + in: path + name: id + required: true + schema: + type: string + responses: + "202": + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/NoBody" + x-xgen-version: 2023-02-01 + description: Accepted + "401": + $ref: "#/components/responses/unauthorized" + "403": + $ref: "#/components/responses/forbidden" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Requests the rejection of an incoming VPC Peering connection. + tags: + - Streams /api/atlas/v2/groups/{groupId}/streams/{tenantName}: delete: description: "Delete one stream instance in the specified project. To use this\ @@ -15307,6 +15836,43 @@ paths: summary: Return All Stream Processors In The Stream Instance. tags: - Streams + /api/atlas/v2/groups/{groupId}/streams:withSampleConnections: + post: + description: "Creates one stream instance in the specified project with sample\ + \ connections. To use this resource the requesting API Key must have the Project\ + \ Data Access Admin role, Project Owner role or Project Stream Processing\ + \ Owner role." + operationId: createStreamInstanceWithSampleConnections + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/pretty" + - $ref: "#/components/parameters/groupId" + requestBody: + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/TenantWithSampleConnections" + description: Details to create one streams instance in the specified project. + required: true + responses: + "200": + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/StreamsTenant" + x-xgen-version: 2024-08-05 + description: OK + "400": + $ref: "#/components/responses/badRequest" + "401": + $ref: "#/components/responses/unauthorized" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Create One Stream Instance With Sample Connections + tags: + - Streams /api/atlas/v2/groups/{groupId}/teams: get: description: "Returns all teams to which the authenticated user has access in\ @@ -17200,6 +17766,55 @@ paths: summary: Return One Organization Invoice as CSV tags: - Invoices + /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/lineItems:search: + get: + description: Query the lineItems of the specified invoice and return the result + JSON. A unique 24-hexadecimal digit string identifies the invoice. + operationId: queryLineItemsFromSingleInvoice + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/itemsPerPage" + - $ref: "#/components/parameters/pageNum" + - $ref: "#/components/parameters/orgId" + - description: Unique 24-hexadecimal digit string that identifies the invoice + submitted to the specified organization. Charges typically post the next + day. + in: path + name: invoiceId + required: true + schema: + type: string + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + requestBody: + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/ApiPublicUsageDetailsQueryRequest" + description: Filter parameters for the lineItems query. Send a request with + an empty JSON body to retrieve all line items for a given invoiceID without + applying any filters. + required: true + responses: + "200": + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/PaginatedPublicApiUsageDetailsLineItemView" + x-xgen-version: 2024-08-05 + description: OK + "400": + $ref: "#/components/responses/badRequest" + "401": + $ref: "#/components/responses/unauthorized" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Query lineItems of the specified invoiceId + tags: + - Invoices /api/atlas/v2/orgs/{orgId}/liveMigrations/availableProjects: get: description: Return all projects that you can migrate to the specified organization. @@ -17296,9 +17911,316 @@ paths: summary: Create One Link-Token tags: - Cloud Migration Service + /api/atlas/v2/orgs/{orgId}/nonCompliantResources: + get: + description: Return all non-compliant resources for an org. + externalDocs: + description: Atlas Resource Policies + url: https://docs.atlas.mongodb.com + operationId: getResourcesNonCompliant + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/pretty" + - $ref: "#/components/parameters/orgId" + responses: + "200": + content: + application/vnd.atlas.2024-08-05+json: + schema: + type: array + items: + $ref: "#/components/schemas/ApiAtlasNonCompliantResourceView" + x-xgen-version: 2024-08-05 + description: OK + "400": + $ref: "#/components/responses/badRequest" + "401": + $ref: "#/components/responses/unauthorized" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Return all non-compliant resources + tags: + - Resource Policies + /api/atlas/v2/orgs/{orgId}/resourcePolicies: + get: + description: Return all Atlas Resource Policies for the org. + externalDocs: + description: Atlas Resource Policies + url: https://docs.atlas.mongodb.com + operationId: getAtlasResourcePolicies + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/pretty" + - $ref: "#/components/parameters/orgId" + responses: + "200": + content: + application/vnd.atlas.2024-08-05+json: + schema: + type: array + items: + $ref: "#/components/schemas/ApiAtlasResourcePolicyView" + x-xgen-version: 2024-08-05 + description: OK + "400": + $ref: "#/components/responses/badRequest" + "401": + $ref: "#/components/responses/unauthorized" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Return all Atlas Resource Policies + tags: + - Resource Policies + post: + description: Create one Atlas Resource Policy for an org. + externalDocs: + description: Atlas Resource Policies + url: https://docs.atlas.mongodb.com + operationId: createAtlasResourcePolicy + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/pretty" + - $ref: "#/components/parameters/orgId" + requestBody: + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/ApiAtlasResourcePolicyCreateView" + x-xgen-version: 2024-08-05 + description: Atlas Resource Policy to create. + required: true + responses: + "201": + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/ApiAtlasResourcePolicyView" + x-xgen-version: 2024-08-05 + description: Created + "400": + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/ApiAtlasInvalidResourcePolicyCreateErrorView" + x-xgen-version: 2024-08-05 + description: Bad request. + "401": + $ref: "#/components/responses/unauthorized" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Create one Atlas Resource Policy + tags: + - Resource Policies + /api/atlas/v2/orgs/{orgId}/resourcePolicies/{resourcePolicyId}: + delete: + description: Delete one Atlas Resource Policy for an org. + externalDocs: + description: Atlas Resource Policies + url: https://docs.atlas.mongodb.com + operationId: deleteAtlasResourcePolicy + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/pretty" + - $ref: "#/components/parameters/orgId" + - description: Unique 24-hexadecimal digit string that identifies an atlas resource + policy. + in: path + name: resourcePolicyId + required: true + schema: + type: string + description: Unique 24-hexadecimal character string that identifies the + atlas resource policy. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + responses: + "200": + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/NoBody" + x-xgen-version: 2024-08-05 + description: This endpoint does not return a response body. + "400": + $ref: "#/components/responses/badRequest" + "401": + $ref: "#/components/responses/unauthorized" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Delete one Atlas Resource Policy + tags: + - Resource Policies + get: + description: Return one Atlas Resource Policy for an org. + externalDocs: + description: Atlas Resource Policies + url: https://docs.atlas.mongodb.com + operationId: getAtlasResourcePolicy + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/pretty" + - $ref: "#/components/parameters/orgId" + - description: Unique 24-hexadecimal digit string that identifies an atlas resource + policy. + in: path + name: resourcePolicyId + required: true + schema: + type: string + description: Unique 24-hexadecimal character string that identifies the + atlas resource policy. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + responses: + "200": + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/ApiAtlasResourcePolicyView" + x-xgen-version: 2024-08-05 + description: OK + "400": + $ref: "#/components/responses/badRequest" + "401": + $ref: "#/components/responses/unauthorized" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Return one Atlas Resource Policy + tags: + - Resource Policies + patch: + description: Update one Atlas Resource Policy for an org. + externalDocs: + description: Atlas Resource Policies + url: https://docs.atlas.mongodb.com + operationId: updateAtlasResourcePolicy + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/pretty" + - $ref: "#/components/parameters/orgId" + - description: Unique 24-hexadecimal digit string that identifies an atlas resource + policy. + in: path + name: resourcePolicyId + required: true + schema: + type: string + description: Unique 24-hexadecimal character string that identifies the + atlas resource policy. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + requestBody: + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/ApiAtlasResourcePolicyEditView" + x-xgen-version: 2024-08-05 + description: Atlas Resource Policy to update. + required: true + responses: + "200": + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/ApiAtlasResourcePolicyView" + x-xgen-version: 2024-08-05 + description: Ok + "400": + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/ApiAtlasInvalidResourcePolicyCreateErrorView" + x-xgen-version: 2024-08-05 + description: Bad request. + "401": + $ref: "#/components/responses/unauthorized" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Update one Atlas Resource Policy + tags: + - Resource Policies + /api/atlas/v2/orgs/{orgId}/resourcePolicies:validate: + post: + description: Validate one Atlas Resource Policy for an org. + externalDocs: + description: Atlas Resource Policies + url: https://docs.atlas.mongodb.com + operationId: validateAtlasResourcePolicy + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/pretty" + - $ref: "#/components/parameters/orgId" + requestBody: + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/ApiAtlasResourcePolicyCreateView" + x-xgen-version: 2024-08-05 + description: Atlas Resource Policy to create. + required: true + responses: + "200": + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/ApiAtlasResourcePolicyView" + x-xgen-version: 2024-08-05 + description: Ok + "400": + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/ApiAtlasInvalidResourcePolicyCreateErrorView" + x-xgen-version: 2024-08-05 + description: Bad request. + "401": + $ref: "#/components/responses/unauthorized" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Validate one Atlas Resource Policy + tags: + - Resource Policies /api/atlas/v2/orgs/{orgId}/serviceAccounts: get: - description: Returns list of Service Accounts with service account details. + description: Returns all Service Accounts for the specified Organization. Available + as a preview feature. operationId: listServiceAccounts parameters: - $ref: "#/components/parameters/orgId" @@ -17309,10 +18231,10 @@ paths: responses: "200": content: - application/vnd.atlas.2023-10-01+json: + application/vnd.atlas.2024-08-05+json: schema: $ref: "#/components/schemas/PaginatedOrgServiceAccounts" - x-xgen-version: 2023-10-01 + x-xgen-version: 2024-08-05 description: OK "401": $ref: "#/components/responses/unauthorized" @@ -17322,11 +18244,12 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Return All Service Accounts + summary: List All Organization Service Accounts tags: - - Organizations + - Service Accounts post: - description: Create Service Account containing client id and client secrets. + description: Creates one Service Account for the specified Organization. Available + as a preview feature. operationId: createServiceAccount parameters: - $ref: "#/components/parameters/orgId" @@ -17334,18 +18257,18 @@ paths: - $ref: "#/components/parameters/pretty" requestBody: content: - application/vnd.atlas.2023-10-01+json: + application/vnd.atlas.2024-08-05+json: schema: $ref: "#/components/schemas/OrgServiceAccountRequest" - description: Details to create service account in the specified organization. + description: Details of the new Service Account. required: true responses: "201": content: - application/vnd.atlas.2023-10-01+json: + application/vnd.atlas.2024-08-05+json: schema: $ref: "#/components/schemas/OrgServiceAccount" - x-xgen-version: 2023-10-01 + x-xgen-version: 2024-08-05 description: Created "400": $ref: "#/components/responses/badRequest" @@ -17355,28 +18278,30 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Service Account Creation + summary: Create one Organization Service Account tags: - - Organizations - /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}: + - Service Accounts + /api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}: delete: - description: Delete Service Account. + description: Deletes the specified Service Account. Available as a preview feature. operationId: deleteServiceAccount parameters: - - description: Id of the service account. + - description: The Client ID of the Service Account. in: path - name: serviceAccountId + name: clientId required: true schema: type: string + example: mdb_sa_id_667066535bc75b03c37b3038 + pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" - $ref: "#/components/parameters/orgId" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/pretty" responses: "204": content: - application/vnd.atlas.2023-10-01+json: - x-xgen-version: 2023-10-01 + application/vnd.atlas.2024-08-05+json: + x-xgen-version: 2024-08-05 description: This endpoint does not return a response body. "401": $ref: "#/components/responses/unauthorized" @@ -17386,29 +18311,31 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Service Account Deletion. + summary: Delete one Organization Service Account tags: - - Organizations + - Service Accounts get: - description: Get Service Account Details. + description: Returns the specified Service Account. Available as a preview feature. operationId: getServiceAccount parameters: - $ref: "#/components/parameters/orgId" - - description: Id of the service account. + - description: The Client ID of the Service Account. in: path - name: serviceAccountId + name: clientId required: true schema: type: string + example: mdb_sa_id_667066535bc75b03c37b3038 + pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/pretty" responses: "200": content: - application/vnd.atlas.2023-10-01+json: + application/vnd.atlas.2024-08-05+json: schema: $ref: "#/components/schemas/OrgServiceAccount" - x-xgen-version: 2023-10-01 + x-xgen-version: 2024-08-05 description: OK "401": $ref: "#/components/responses/unauthorized" @@ -17418,36 +18345,39 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Service Account Fetching + summary: Get one Organization Service Account tags: - - Organizations + - Service Accounts patch: - description: Update Service Account. + description: Updates the specified Service Account in the specified Organization. + Available as a preview feature. operationId: updateServiceAccount parameters: - - description: Id of the service account. + - description: The Client ID of the Service Account. in: path - name: serviceAccountId + name: clientId required: true schema: type: string + example: mdb_sa_id_667066535bc75b03c37b3038 + pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" - $ref: "#/components/parameters/orgId" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/pretty" requestBody: content: - application/vnd.atlas.2023-10-01+json: + application/vnd.atlas.2024-08-05+json: schema: $ref: "#/components/schemas/OrgServiceAccountUpdateRequest" - description: Details to update service account in the specified organization. + description: The new details for the Service Account. required: true responses: "200": content: - application/vnd.atlas.2023-10-01+json: + application/vnd.atlas.2024-08-05+json: schema: $ref: "#/components/schemas/OrgServiceAccount" - x-xgen-version: 2023-10-01 + x-xgen-version: 2024-08-05 description: OK "400": $ref: "#/components/responses/badRequest" @@ -17459,21 +18389,24 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Service Account Update + summary: Update one Organization Service Account tags: - - Organizations - /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/groups: + - Service Accounts + /api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/groups: get: - description: Returns list of Service Account projects. + description: Returns a list of all projects the specified Service Account is + a part of. Available as a preview feature. operationId: listServiceAccountProjects parameters: - $ref: "#/components/parameters/orgId" - - description: Id of the service account. + - description: The Client ID of the Service Account. in: path - name: serviceAccountId + name: clientId required: true schema: type: string + example: mdb_sa_id_667066535bc75b03c37b3038 + pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" - $ref: "#/components/parameters/itemsPerPage" - $ref: "#/components/parameters/pageNum" - $ref: "#/components/parameters/pretty" @@ -17481,10 +18414,10 @@ paths: responses: "200": content: - application/vnd.atlas.2023-10-01+json: + application/vnd.atlas.2024-08-05+json: schema: $ref: "#/components/schemas/PaginatedServiceAccountGroup" - x-xgen-version: 2023-10-01 + x-xgen-version: 2024-08-05 description: OK "401": $ref: "#/components/responses/unauthorized" @@ -17494,37 +18427,40 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Return All Service Account projects + summary: Return All Service Account Project assignments tags: - - Organizations - /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets: + - Service Accounts + /api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/secrets: post: - description: Create Service Account secret. + description: Create a secret for the specified Service Account. Available as + a preview feature. operationId: createServiceAccountSecret parameters: - $ref: "#/components/parameters/orgId" - - description: Id of the service account. + - description: The Client ID of the Service Account. in: path - name: serviceAccountId + name: clientId required: true schema: type: string + example: mdb_sa_id_667066535bc75b03c37b3038 + pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/pretty" requestBody: content: - application/vnd.atlas.2023-10-01+json: + application/vnd.atlas.2024-08-05+json: schema: $ref: "#/components/schemas/ServiceAccountSecretRequest" - description: Details to create secret in the specified service account. + description: Details for the new secret. required: true responses: "201": content: - application/vnd.atlas.2023-10-01+json: + application/vnd.atlas.2024-08-05+json: schema: $ref: "#/components/schemas/ServiceAccountSecret" - x-xgen-version: 2023-10-01 + x-xgen-version: 2024-08-05 description: Created "400": $ref: "#/components/responses/badRequest" @@ -17534,21 +18470,24 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Service Account Secret Creation + summary: Create one Organization Service Account Secret tags: - - Organizations - /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets/{secretId}: + - Service Accounts + /api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/secrets/{secretId}: delete: - description: Delete Service Account Secret. + description: Deletes the specified Service Account secret. Available as a preview + feature. operationId: deleteServiceAccountSecret parameters: - - description: Id of the service account. + - description: The Client ID of the Service Account. in: path - name: serviceAccountId + name: clientId required: true schema: type: string - - description: Id of the secret. + example: mdb_sa_id_667066535bc75b03c37b3038 + pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" + - description: Unique 24-hexadecimal digit string that identifies the secret. in: path name: secretId required: true @@ -17560,8 +18499,8 @@ paths: responses: "204": content: - application/vnd.atlas.2023-10-01+json: - x-xgen-version: 2023-10-01 + application/vnd.atlas.2024-08-05+json: + x-xgen-version: 2024-08-05 description: This endpoint does not return a response body. "401": $ref: "#/components/responses/unauthorized" @@ -17571,9 +18510,9 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Service Account Secret Deletion. + summary: Delete a Organization Service Account Secret tags: - - Organizations + - Service Accounts /api/atlas/v2/orgs/{orgId}/settings: get: description: "Returns details about the specified organization's settings. To\ @@ -17628,6 +18567,8 @@ paths: $ref: "#/components/schemas/OrganizationSettings" x-xgen-version: 2023-01-01 description: OK + "400": + $ref: "#/components/responses/badRequest" "401": $ref: "#/components/responses/unauthorized" "403": @@ -18102,6 +19043,7 @@ paths: - Organizations /api/atlas/v2/orgs/{orgId}/users/{userId}: delete: + deprecated: true description: "Removes one MongoDB Cloud user from the specified organization.\ \ To use this resource, the requesting API Key must have the Organization\ \ User Admin role." @@ -18109,6 +19051,7 @@ paths: parameters: - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/orgId" + - $ref: "#/components/parameters/pretty" - description: Unique 24-hexadecimal digit string that identifies the user to be deleted. in: path @@ -18139,9 +19082,10 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Remove One MongoDB Cloud User from One Organization + summary: Remove One MongoDB Cloud User From One Organization tags: - Organizations + x-sunset: 2026-01-01 /api/atlas/v2/orgs/{orgId}/users/{userId}/roles: put: description: "Updates the roles of the specified user in the specified organization.\ @@ -18213,6 +19157,43 @@ paths: summary: Return All Control Plane IP Addresses tags: - Root + /api/atlas/v2/unauth/openapi/versions: + get: + description: API that provides a list of available versionsfor a given environment. + operationId: getApiVersions + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/itemsPerPage" + - $ref: "#/components/parameters/pageNum" + - $ref: "#/components/parameters/pretty" + - description: "The environment to get the versions from. If not provided, it\ + \ returnsthe versions for the given MongoDB URL. (E.g. prod for cloud.mongodb.com)" + in: query + name: env + schema: + type: string + enum: + - dev + - qa + - prod + - stage + responses: + "200": + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/PaginatedApiVersions" + x-xgen-version: 2024-08-05 + application/vnd.atlas.2024-08-05+yaml: + schema: + $ref: "#/components/schemas/PaginatedApiVersions" + x-xgen-version: 2024-08-05 + description: OK + "500": + $ref: "#/components/responses/internalServerError" + summary: Provides a list of versions for a given environment. + tags: + - OpenAPI /api/atlas/v2/users: post: description: |- @@ -18968,7 +19949,7 @@ components: description: |- Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. - Change this parameter only if you: + 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). @@ -19044,7 +20025,7 @@ components: You can set different IOPS values on different shards when provisioned IOPS are supported. - Change this parameter only if you: + 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). @@ -19475,6 +20456,31 @@ components: - REPLICASET - SHARDED - GEOSHARDED + configServerManagementMode: + type: string + default: ATLAS_MANAGED + description: |- + Config Server Management Mode for creating or updating a sharded cluster. + + When configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings. + + When configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server. + enum: + - ATLAS_MANAGED + - FIXED_TO_DEDICATED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + configServerType: + type: string + description: Describes a sharded cluster's config server type. + enum: + - DEDICATED + - EMBEDDED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + readOnly: true connectionStrings: $ref: "#/components/schemas/ClusterConnectionStrings" createDate: @@ -19522,6 +20528,15 @@ components: externalDocs: description: Encryption at Rest using Customer Key Management url: https://www.mongodb.com/docs/atlas/security-kms-encryption/ + featureCompatibilityVersion: + type: string + description: Feature compatibility version of the cluster. + readOnly: true + featureCompatibilityVersionExpirationDate: + type: string + format: date-time + description: Feature compatibility version expiration date. + readOnly: true globalClusterSelfManagedSharding: type: boolean description: |- @@ -19572,6 +20587,8 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true + mongoDBEmployeeAccessGrant: + $ref: "#/components/schemas/EmployeeAccessGrantView" mongoDBMajorVersion: type: string description: |- @@ -19593,7 +20610,7 @@ components: description: Human-readable label that identifies the advanced cluster. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" paused: type: boolean description: Flag that indicates whether the cluster is paused. @@ -19604,6 +20621,24 @@ components: externalDocs: description: Continuous Cloud Backups url: https://docs.atlas.mongodb.com/backup/cloud-backup/overview/ + replicaSetScalingStrategy: + type: string + default: WORKLOAD_TYPE + description: |- + Set this field to configure the replica set scaling mode for your cluster. + + By default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes. + + When configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads. + + When configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads. + enum: + - SEQUENTIAL + - WORKLOAD_TYPE + - NODE_TYPE + externalDocs: + description: Modify the Replica Set Scaling Mode + url: https://dochub.mongodb.org/core/scale-nodes replicationSpecs: type: array description: "List of settings that configure your cluster regions. For\ @@ -20482,6 +21517,246 @@ components: description: Atlas Search Index url: https://dochub.mongodb.org/core/index-definitions-fts title: mappings + ApiAtlasInvalidPolicyErrorDetailView: + type: object + properties: + detail: + type: string + description: A string that provides a detailed description of a validation + error. + readOnly: true + ApiAtlasInvalidPolicyView: + type: object + properties: + body: + type: string + description: A string that defines the permissions for the policy. The syntax + used is the Cedar Policy language. + example: |2 + forbid ( + principal, + action == cloud::Action::"cluster.createEdit", + resource + ) when { + context.cluster.regions.contains(cloud::region::"aws:us-east-1") + }; + readOnly: true + errors: + type: array + description: List of validation errors. + items: + $ref: "#/components/schemas/ApiAtlasInvalidPolicyErrorDetailView" + readOnly: true + ApiAtlasInvalidResourcePolicyCreateErrorView: + type: object + properties: + errorType: + type: string + description: Human-readable label that displays the type of an error. + enum: + - POLICY_PARSING_ERROR + - POLICY_HAS_FAILED_VALIDATIONS + - POLICY_HAS_INVALID_PRINCIPAL + - POLICY_HAS_BODY_EXCEEDING_MAX_SIZE + - POLICY_HAS_UNEXPECTED_ENTITIES + invalidPolicies: + type: array + description: List of invalid policies containing details of their validation + errors. + items: + $ref: "#/components/schemas/ApiAtlasInvalidPolicyView" + readOnly: true + ApiAtlasNonCompliantResourceView: + type: object + properties: + orgId: + type: string + description: Unique 24-hexadecimal character string that identifies the + organization the resource belongs to. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + resourceId: + type: string + description: Unique 24-hexadecimal character string that identifies the + non-compliant resource. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + resourcePoliciesCausingNonCompliance: + type: array + description: List of resource policies causing the resource to be considered + non-compliant. + items: + $ref: "#/components/schemas/ApiAtlasResourcePolicyMetadataView" + readOnly: true + resourceType: + type: string + description: Human-readable label that displays the type of a resource. + enum: + - PROJECT + - CLUSTER + readOnly: true + ApiAtlasPolicyCreateView: + type: object + properties: + body: + type: string + description: A string that defines the permissions for the policy. The syntax + used is the Cedar Policy language. + example: |2 + forbid ( + principal, + action == cloud::Action::"cluster.createEdit", + resource + ) when { + context.cluster.regions.contains(cloud::region::"aws:us-east-1") + }; + required: + - body + ApiAtlasPolicyMetadataView: + type: object + properties: + policyId: + type: string + description: Unique 24-hexadecimal character string that identifies the + policy. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + ApiAtlasPolicyView: + type: object + properties: + body: + type: string + description: A string that defines the permissions for the policy. The syntax + used is the Cedar Policy language. + example: |2 + forbid ( + principal, + action == cloud::Action::"cluster.createEdit", + resource + ) when { + context.cluster.regions.contains(cloud::region::"aws:us-east-1") + }; + readOnly: true + id: + type: string + description: Unique 24-hexadecimal character string that identifies the + policy. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + ApiAtlasResourcePolicyCreateView: + type: object + properties: + name: + type: string + description: Human-readable label that describes the atlas resource policy. + policies: + type: array + description: List of policies that make up the atlas resource policy. + items: + $ref: "#/components/schemas/ApiAtlasPolicyCreateView" + required: + - name + - policies + ApiAtlasResourcePolicyEditView: + type: object + properties: + name: + type: string + description: Human-readable label that describes the atlas resource policy. + policies: + type: array + description: List of policies that make up the atlas resource policy. + items: + $ref: "#/components/schemas/ApiAtlasPolicyCreateView" + ApiAtlasResourcePolicyMetadataView: + type: object + properties: + policiesCausingNonCompliance: + type: array + description: List of policies that are in conflict with the current state + of the resource. + items: + $ref: "#/components/schemas/ApiAtlasPolicyMetadataView" + readOnly: true + resourcePolicyId: + type: string + description: Unique 24-hexadecimal character string that identifies the + atlas resource policy. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + resourcePolicyName: + type: string + description: Human-readable label that describes the atlas resource policy. + readOnly: true + ApiAtlasResourcePolicyView: + type: object + properties: + createdByUser: + $ref: "#/components/schemas/ApiAtlasUserMetadataView" + createdDate: + type: string + format: date-time + description: Date and time in UTC when the atlas resource policy was created. + example: 2022-01-01T00:00:00Z + readOnly: true + id: + type: string + description: Unique 24-hexadecimal character string that identifies the + atlas resource policy. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + lastUpdatedByUser: + $ref: "#/components/schemas/ApiAtlasUserMetadataView" + lastUpdatedDate: + type: string + format: date-time + description: Date and time in UTC when the atlas resource policy was last + updated. + example: 2022-01-01T00:00:00Z + readOnly: true + name: + type: string + description: Human-readable label that describes the atlas resource policy. + readOnly: true + orgId: + type: string + description: Unique 24-hexadecimal character string that identifies the + organization the atlas resource policy belongs to. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + policies: + type: array + description: List of policies that make up the atlas resource policy. + items: + $ref: "#/components/schemas/ApiAtlasPolicyView" + readOnly: true + version: + type: string + description: A string that identifies the version of the atlas resource + policy. + example: v1 + readOnly: true ApiAtlasSnapshotScheduleView: type: object properties: @@ -20618,6 +21893,23 @@ components: - snapshotIntervalHours - snapshotRetentionDays - weeklySnapshotRetentionWeeks + ApiAtlasUserMetadataView: + type: object + description: The user that last updated the atlas resource policy. + properties: + id: + type: string + description: Unique 24-hexadecimal character string that identifies a user. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + name: + type: string + description: Human-readable label that describes a user. + readOnly: true + readOnly: true ApiBSONTimestampView: type: object description: BSON timestamp that indicates when the checkpoint token entry in @@ -20674,6 +21966,8 @@ components: ApiError: type: object properties: + badRequestDetail: + $ref: "#/components/schemas/BadRequestDetail" detail: type: string description: Describes the specific conditions or reasons that cause each @@ -20684,17 +21978,25 @@ components: description: HTTP status code returned with this error. externalDocs: url: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status + readOnly: true 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. items: type: object + readOnly: true + readOnly: true reason: type: string description: Application error message returned with this error. + readOnly: true + required: + - error + - errorCode ApiHostView_Atlas: type: object properties: @@ -20983,6 +22285,23 @@ components: \ and **period** in the same request. This parameter expresses its value\ \ in the ISO 8601 timestamp format in UTC." readOnly: true + ApiPrivateDownloadDeliveryUrl: + type: object + description: One Uniform Resource Locator (URL) that points to the compressed + snapshot files for manual download and the corresponding private endpoint. + properties: + deliveryUrl: + type: string + description: One Uniform Resource Locator that points to the compressed + snapshot files for manual download. + endpointId: + type: string + description: Unique 22-character alphanumeric string that identifies the + private endpoint. + example: vpce-3bf78b0ddee411ba1 + maxLength: 22 + minLength: 22 + pattern: "^vpce-[0-9a-f]{17}$" ApiPublicUsageDetailsQueryRequest: type: object description: "Request body for an Invoice Usage Details query with filtering,\ @@ -21094,7 +22413,23 @@ components: type: string description: Atlas Streams AWS Regions. enum: + - SYDNEY_AUS + - MUMBAI_IND + - FRANKFURT_DEU + - DUBLIN_IRL + - LONDON_GBR + - VIRGINIA_USA + - OREGON_USA + - SAOPAULO_BRA + - MONTREAL_CAN + - TOKYO_JPN + - SINGAPORE_SGP + ApiStreamsAzureRegionView: + type: string + description: Atlas Streams Azure Regions. + enum: - VIRGINIA_USA + - AMSTERDAM_NLD ApiUserEventTypeViewForNdsGroup: type: string description: Unique identifier of event type. @@ -21341,6 +22676,12 @@ components: - eventTypeName - id title: API User Events + ApiVersion: + type: object + properties: + version: + type: string + description: Object representing a version of the Atlas Admin API. AppServiceAlertConfigViewForNdsGroup: type: object description: App Services metric alert configuration allows to select which @@ -21822,7 +23163,12 @@ components: enum: - AVERAGE operator: - $ref: "#/components/schemas/Operator" + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - LESS_THAN + - GREATER_THAN threshold: type: number format: double @@ -21900,6 +23246,12 @@ components: enum: - VIRGINIA_USA - AMSTERDAM_NLD + AtlasDataFederationGCPRegion: + type: string + description: Atlas Data Federation GCP Regions. + enum: + - IOWA_USA + - BELGIUM_EU AtlasOrganization: type: object description: Details that describe the organization. @@ -21935,6 +23287,128 @@ components: pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" required: - name + AtlasResourcePolicyAuditForOrg: + type: object + description: Atlas resource policy audits indicate org level changes to resource + policies + properties: + apiKeyId: + type: string + description: "Unique 24-hexadecimal digit string that identifies the [API\ + \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\ + \ triggered the event. If this resource returns this parameter, it doesn't\ + \ return the **userId** parameter." + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + created: + type: string + format: date-time + description: Date and time when this event occurred. This parameter expresses + its value in the ISO 8601 timestamp format in UTC. + readOnly: true + eventTypeName: + type: string + description: Unique identifier of event type. + enum: + - RESOURCE_POLICY_CREATED + - RESOURCE_POLICY_MODIFIED + - RESOURCE_POLICY_DELETED + example: RESOURCE_POLICY_CREATED + title: Atlas Resource Policy Audit Types + groupId: + type: string + description: Unique 24-hexadecimal digit string that identifies the project + in which the event occurred. The **eventId** identifies the specific event. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + id: + type: string + description: Unique 24-hexadecimal digit string that identifies the event. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + isGlobalAdmin: + type: boolean + default: false + description: Flag that indicates whether a MongoDB employee triggered the + specified event. + readOnly: true + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + orgId: + type: string + description: Unique 24-hexadecimal digit string that identifies the organization + to which these events apply. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + publicKey: + type: string + format: email + description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\ + \ that triggered the event. If this resource returns this parameter, it\ + \ doesn't return the **username** parameter." + readOnly: true + raw: + $ref: "#/components/schemas/raw" + remoteAddress: + type: string + description: IPv4 or IPv6 address from which the user triggered this event. + example: 216.172.40.186 + pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + readOnly: true + resourcePolicyId: + type: string + description: Unique 24-hexadecimal character string that identifies the + resource policy. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + userId: + type: string + description: "Unique 24-hexadecimal digit string that identifies the console\ + \ user who triggered the event. If this resource returns this parameter,\ + \ it doesn't return the **apiKeyId** parameter." + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + username: + type: string + format: email + description: "Email address for the user who triggered this event. If this\ + \ resource returns this parameter, it doesn't return the **publicApiKey**\ + \ parameter." + example: test.user@mongodb.com + readOnly: true + required: + - created + - eventTypeName + - id + title: Atlas Resource Policy Audits AtlasSearchAnalyzer: type: object properties: @@ -22656,6 +24130,21 @@ components: AzureHardwareSpec: type: object properties: + diskIOPS: + type: integer + format: int32 + description: |- + Target throughput desired for storage attached to your Azure-provisioned cluster. Change this parameter if you: + + - set `"replicationSpecs[n].regionConfigs[m].providerName" : "Azure"`. + - set `"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize" : "M40"` or greater not including `Mxx_NVME` tiers. + + The maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**. + This parameter defaults to the cluster tier's standard IOPS value. + Changing this value impacts cluster cost. + externalDocs: + description: Programmatic API Keys + url: https://www.mongodb.com/docs/atlas/customize-storage/#extend-iops-on-azure instanceSize: type: string description: Hardware specification for the instance sizes in this region. @@ -22693,6 +24182,21 @@ components: AzureHardwareSpec20240805: type: object properties: + diskIOPS: + type: integer + format: int32 + description: |- + Target throughput desired for storage attached to your Azure-provisioned cluster. Change this parameter if you: + + - set `"replicationSpecs[n].regionConfigs[m].providerName" : "Azure"`. + - set `"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize" : "M40"` or greater not including `Mxx_NVME` tiers. + + The maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**. + This parameter defaults to the cluster tier's standard IOPS value. + Changing this value impacts cluster cost. + externalDocs: + description: Programmatic API Keys + url: https://www.mongodb.com/docs/atlas/customize-storage/#extend-iops-on-azure diskSizeGB: type: number format: double @@ -22908,6 +24412,8 @@ components: - PENDING_ACCEPTANCE - ACTIVE - FAILED + - PENDING_RECREATION + - DELETING readOnly: true title: Azure Key Vault EAR Private Endpoint AzureNetworkPeeringConnectionSettings: @@ -23342,7 +24848,7 @@ components: the collection for which you want to create an online archive. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true collName: type: string @@ -23454,7 +24960,7 @@ components: the collection for which you want to create an online archive. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true collName: type: string @@ -23593,7 +25099,7 @@ components: the snapshots you want to retrieve. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -23806,7 +25312,7 @@ components: To return a response with the **clusterId** parameter, either use the **delivery.targetClusterName** parameter or enable backup on the target cluster. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" targetGroupId: type: string description: "Unique 24-hexadecimal digit string that identifies the project\ @@ -24078,12 +25584,23 @@ components: - FAILED - COMPLETED readOnly: true + BadRequestDetail: + type: object + description: Bad request detail. + properties: + fields: + type: array + description: Describes all violations in a client request. + items: + $ref: "#/components/schemas/FieldViolation" + readOnly: true BaseAtlasDataLakeRegion: type: object description: Name of the region to which the data lake routes client connections. oneOf: - $ref: "#/components/schemas/ApiAtlasDataLakeAWSRegionView" - $ref: "#/components/schemas/AtlasDataFederationAzureRegion" + - $ref: "#/components/schemas/AtlasDataFederationGCPRegion" BaseCloudProviderInstanceSize: type: object description: "Minimum instance size to which your cluster can automatically\ @@ -24211,6 +25728,7 @@ components: description: Name of the cloud provider region hosting Atlas Stream Processing. oneOf: - $ref: "#/components/schemas/ApiStreamsAWSRegionView" + - $ref: "#/components/schemas/ApiStreamsAzureRegionView" BasicBSONList: type: array description: "List that contains the search criteria that the query uses. To\ @@ -25298,7 +26816,7 @@ components: description: Human-readable label that identifies the cluster. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true nodeCount: type: integer @@ -25359,6 +26877,10 @@ components: 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. + description: + type: string + description: Description of this database user. + maxLength: 100 groupId: type: string description: Unique 24-hexadecimal digit string that identifies the project. @@ -25626,6 +27148,127 @@ components: (AWS) Identity and Access Management (IAM) role. required: - providerName + CloudProviderAccessAWSIAMRoleRequest: + type: object + description: Details that describe the features linked to the Amazon Web Services + (AWS) Identity and Access Management (IAM) role. + properties: + atlasAWSAccountArn: + 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. + example: arn:aws:iam::772401394250:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + readOnly: true + atlasAssumedRoleExternalId: + type: string + format: uuid + description: Unique external ID that MongoDB Cloud uses when it assumes + the IAM role in your Amazon Web Services (AWS) account. + readOnly: true + authorizedDate: + type: string + format: date-time + 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. + readOnly: true + createdDate: + type: string + format: date-time + 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. + readOnly: true + featureUsages: + type: array + description: List that contains application features associated with this + Amazon Web Services (AWS) Identity and Access Management (IAM) role. + items: + $ref: "#/components/schemas/CloudProviderAccessFeatureUsage" + readOnly: true + providerName: + type: string + description: Human-readable label that identifies the cloud provider of + the role. + enum: + - AWS + - AZURE + - GCP + roleId: + type: string + description: Unique 24-hexadecimal digit string that identifies the role. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + required: + - providerName + CloudProviderAccessAWSIAMRoleRequestUpdate: + type: object + allOf: + - $ref: "#/components/schemas/CloudProviderAccessRoleRequestUpdate" + - type: object + properties: + atlasAWSAccountArn: + 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. + example: arn:aws:iam::772401394250:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + readOnly: true + atlasAssumedRoleExternalId: + type: string + format: uuid + description: Unique external ID that MongoDB Cloud uses when it assumes + the IAM role in your Amazon Web Services (AWS) account. + readOnly: true + authorizedDate: + type: string + format: date-time + 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. + readOnly: true + createdDate: + type: string + format: date-time + 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. + readOnly: true + featureUsages: + type: array + description: List that contains application features associated with this + Amazon Web Services (AWS) Identity and Access Management (IAM) role. + items: + $ref: "#/components/schemas/CloudProviderAccessFeatureUsage" + readOnly: true + iamAssumedRoleArn: + 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 + maxLength: 2048 + minLength: 20 + roleId: + type: string + description: Unique 24-hexadecimal digit string that identifies the role. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + description: Details that describe the features linked to the Amazon Web Services + (AWS) Identity and Access Management (IAM) role. + required: + - providerName CloudProviderAccessAzureServicePrincipal: type: object allOf: @@ -25687,6 +27330,133 @@ components: Principal. required: - providerName + CloudProviderAccessAzureServicePrincipalRequest: + type: object + description: Details that describe the features linked to the Azure Service + Principal. + properties: + _id: + type: string + description: Unique 24-hexadecimal digit string that identifies the role. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + atlasAzureAppId: + type: string + description: Azure Active Directory Application ID of Atlas. + maxLength: 36 + minLength: 32 + pattern: "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\\ + b-[0-9a-fA-F]{12}$" + createdDate: + type: string + format: date-time + description: Date and time when this Azure Service Principal was created. + This parameter expresses its value in the ISO 8601 timestamp format in + UTC. + readOnly: true + featureUsages: + type: array + description: List that contains application features associated with this + Azure Service Principal. + items: + $ref: "#/components/schemas/CloudProviderAccessFeatureUsage" + readOnly: true + lastUpdatedDate: + type: string + format: date-time + 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. + 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. + maxLength: 36 + minLength: 32 + pattern: "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\\ + b-[0-9a-fA-F]{12}$" + tenantId: + type: string + description: UUID String that identifies the Azure Active Directory Tenant + ID. + maxLength: 36 + minLength: 32 + pattern: "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\\ + b-[0-9a-fA-F]{12}$" + required: + - providerName + CloudProviderAccessAzureServicePrincipalRequestUpdate: + type: object + allOf: + - $ref: "#/components/schemas/CloudProviderAccessRoleRequestUpdate" + - type: object + properties: + _id: + type: string + description: Unique 24-hexadecimal digit string that identifies the role. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + atlasAzureAppId: + type: string + description: Azure Active Directory Application ID of Atlas. + maxLength: 36 + minLength: 32 + pattern: "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\\ + b-[0-9a-fA-F]{12}$" + createdDate: + type: string + format: date-time + description: Date and time when this Azure Service Principal was created. + This parameter expresses its value in the ISO 8601 timestamp format + in UTC. + readOnly: true + featureUsages: + type: array + description: List that contains application features associated with this + Azure Service Principal. + items: + $ref: "#/components/schemas/CloudProviderAccessFeatureUsage" + readOnly: true + lastUpdatedDate: + type: string + format: date-time + 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. + readOnly: true + servicePrincipalId: + type: string + description: UUID string that identifies the Azure Service Principal. + maxLength: 36 + minLength: 32 + pattern: "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\\ + b-[0-9a-fA-F]{12}$" + tenantId: + type: string + description: UUID String that identifies the Azure Active Directory Tenant + ID. + maxLength: 36 + minLength: 32 + pattern: "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\\ + b-[0-9a-fA-F]{12}$" + description: Details that describe the features linked to the Azure Service + Principal. + required: + - providerName CloudProviderAccessDataLakeFeatureUsage: type: object allOf: @@ -25799,6 +27569,85 @@ components: minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true + CloudProviderAccessGCPServiceAccount: + type: object + allOf: + - $ref: "#/components/schemas/CloudProviderAccessRole" + - type: object + properties: + createdDate: + type: string + format: date-time + description: Date and time when this Google Service Account was created. + This parameter expresses its value in the ISO 8601 timestamp format + in UTC. + readOnly: true + featureUsages: + type: array + description: List that contains application features associated with this + Google Service Account. + items: + $ref: "#/components/schemas/CloudProviderAccessFeatureUsage" + readOnly: true + gcpServiceAccountForAtlas: + type: string + description: Email address for the Google Service Account created by Atlas. + maxLength: 82 + minLength: 57 + pattern: "^mongodb-atlas-[0-9a-z]{16}@p-[0-9a-z]{24}.iam.gserviceaccount.com$" + roleId: + type: string + description: Unique 24-hexadecimal digit string that identifies the role. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + description: Details that describe the features linked to the GCP Service Account. + required: + - providerName + CloudProviderAccessGCPServiceAccountRequest: + type: object + description: Details that describe the features linked to the GCP Service Account. + properties: + createdDate: + type: string + format: date-time + description: Date and time when this GCP Service Account was created. This + parameter expresses its value in the ISO 8601 timestamp format in UTC. + readOnly: true + featureUsages: + type: array + description: List that contains application features associated with this + GCP Service Account. + items: + $ref: "#/components/schemas/CloudProviderAccessFeatureUsage" + readOnly: true + 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: + type: string + description: Unique 24-hexadecimal digit string that identifies the role. + readOnly: true + required: + - providerName + CloudProviderAccessGCPServiceAccountRequestUpdate: + type: object + allOf: + - $ref: "#/components/schemas/CloudProviderAccessRoleRequestUpdate" + description: Details that describe the features linked to the GCP Service Account. + required: + - providerName CloudProviderAccessPushBasedLogExportFeatureUsage: type: object allOf: @@ -25817,10 +27666,52 @@ components: mapping: AWS: "#/components/schemas/CloudProviderAccessAWSIAMRole" AZURE: "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + GCP: "#/components/schemas/CloudProviderAccessGCPServiceAccount" + propertyName: providerName + properties: + providerName: + type: string + description: Human-readable label that identifies the cloud provider of + the role. + enum: + - AWS + - AZURE + - GCP + required: + - providerName + CloudProviderAccessRoleRequest: + type: object + description: Cloud provider access role. + discriminator: + mapping: + AWS: "#/components/schemas/CloudProviderAccessAWSIAMRoleRequest" + AZURE: "#/components/schemas/CloudProviderAccessAzureServicePrincipalRequest" + GCP: "#/components/schemas/CloudProviderAccessGCPServiceAccountRequest" propertyName: providerName oneOf: - - $ref: "#/components/schemas/CloudProviderAccessAWSIAMRole" - - $ref: "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + - $ref: "#/components/schemas/CloudProviderAccessAWSIAMRoleRequest" + - $ref: "#/components/schemas/CloudProviderAccessAzureServicePrincipalRequest" + - $ref: "#/components/schemas/CloudProviderAccessGCPServiceAccountRequest" + properties: + providerName: + type: string + description: Human-readable label that identifies the cloud provider of + the role. + enum: + - AWS + - AZURE + - GCP + required: + - providerName + CloudProviderAccessRoleRequestUpdate: + type: object + description: Cloud provider access role. + discriminator: + mapping: + AWS: "#/components/schemas/CloudProviderAccessAWSIAMRoleRequestUpdate" + AZURE: "#/components/schemas/CloudProviderAccessAzureServicePrincipalRequestUpdate" + GCP: "#/components/schemas/CloudProviderAccessGCPServiceAccountRequestUpdate" + propertyName: providerName properties: providerName: type: string @@ -25829,6 +27720,7 @@ components: enum: - AWS - AZURE + - GCP required: - providerName CloudProviderAccessRoles: @@ -25840,6 +27732,12 @@ components: registered and authorized with MongoDB Cloud. items: $ref: "#/components/schemas/CloudProviderAccessAWSIAMRole" + azureServicePrincipals: + type: array + description: List that contains the Azure Service Principals registered + with MongoDB Cloud. + items: + $ref: "#/components/schemas/CloudProviderAccessAzureServicePrincipal" CloudProviderAzureAutoScaling: type: object description: Range of instance sizes to which your cluster can scale. @@ -26508,7 +28406,7 @@ components: example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -26612,6 +28510,7 @@ components: $ref: "#/components/schemas/ClusterComputeAutoScaling" diskGBEnabled: type: boolean + default: false description: Flag that indicates whether someone enabled disk auto-scaling for this cluster. title: Automatic Cluster Scaling Settings @@ -26638,12 +28537,14 @@ components: properties: enabled: type: boolean + default: false description: "Flag that indicates whether cluster tier auto-scaling is enabled.\ \ Set to `true` to enable cluster tier auto-scaling. If enabled, you must\ \ specify a value for **providerSettings.autoScaling.compute.maxInstanceSize**\ \ also. Set to `false` to disable cluster tier auto-scaling." scaleDownEnabled: type: boolean + default: false description: "Flag that indicates whether the cluster tier can scale down.\ \ This is required if **autoScaling.compute.enabled** is `true`. If you\ \ enable this option, specify a value for **providerSettings.autoScaling.compute.minInstanceSize**." @@ -26681,20 +28582,28 @@ components: 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. + description: "Private endpoint-aware connection strings that use AWS-hosted\ + \ clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies\ + \ an Amazon Web Services (AWS) interface endpoint. Each value identifies\ + \ the related `mongodb://` connection string that you use to connect\ + \ to Atlas through the interface endpoint that the key names. If the\ + \ cluster uses an optimized connection string, `awsPrivateLinkSrv` contains\ + \ the optimized connection string. If the cluster has the non-optimized\ + \ (legacy) connection string, `awsPrivateLinkSrv` contains the non-optimized\ + \ connection string even if an optimized connection string is also present." externalDocs: description: Network Peering Connection url: https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/ readOnly: true - 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. + description: "Private endpoint-aware connection strings that use AWS-hosted\ + \ clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies\ + \ an Amazon Web Services (AWS) interface endpoint. Each value identifies\ + \ the related `mongodb://` connection string that you use to connect to\ + \ Atlas through the interface endpoint that the key names. If the cluster\ + \ uses an optimized connection string, `awsPrivateLinkSrv` contains the\ + \ optimized connection string. If the cluster has the non-optimized (legacy)\ + \ connection string, `awsPrivateLinkSrv` contains the non-optimized connection\ + \ string even if an optimized connection string is also present." externalDocs: description: Network Peering Connection url: https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/ @@ -26796,6 +28705,31 @@ components: - REPLICASET - SHARDED - GEOSHARDED + configServerManagementMode: + type: string + default: ATLAS_MANAGED + description: |- + Config Server Management Mode for creating or updating a sharded cluster. + + When configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings. + + When configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server. + enum: + - ATLAS_MANAGED + - FIXED_TO_DEDICATED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + configServerType: + type: string + description: Describes a sharded cluster's config server type. + enum: + - DEDICATED + - EMBEDDED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + readOnly: true connectionStrings: $ref: "#/components/schemas/ClusterConnectionStrings" createDate: @@ -26829,6 +28763,15 @@ components: externalDocs: description: Encryption at Rest using Customer Key Management url: https://www.mongodb.com/docs/atlas/security-kms-encryption/ + featureCompatibilityVersion: + type: string + description: Feature compatibility version of the cluster. + readOnly: true + featureCompatibilityVersionExpirationDate: + type: string + format: date-time + description: Feature compatibility version expiration date. + readOnly: true globalClusterSelfManagedSharding: type: boolean description: |- @@ -26879,6 +28822,8 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true + mongoDBEmployeeAccessGrant: + $ref: "#/components/schemas/EmployeeAccessGrantView" mongoDBMajorVersion: type: string description: |- @@ -26900,7 +28845,7 @@ components: description: Human-readable label that identifies the cluster. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" paused: type: boolean description: Flag that indicates whether the cluster is paused. @@ -26911,6 +28856,35 @@ components: externalDocs: description: Continuous Cloud Backups url: https://docs.atlas.mongodb.com/backup/cloud-backup/overview/ + redactClientLogData: + type: boolean + description: Enable or disable log redaction. + externalDocs: + description: |- + This options corresponds to the ``security.redactClientLogData`` cluster parameter. + + This setting configures the ``mongod`` or ``mongos`` to redact any message accompanying a given log event before logging. This prevents the program from writing potentially sensitive data stored on the database to the diagnostic log. Metadata such as error or operation codes, line numbers, and source file names are still visible in the logs. + + Use ``redactClientLogData`` in conjunction with Encryption at Rest and TLS/SSL (Transport Encryption) to assist compliance with regulatory requirements. + url: https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.redactClientLogData + replicaSetScalingStrategy: + type: string + default: WORKLOAD_TYPE + description: |- + Set this field to configure the replica set scaling mode for your cluster. + + By default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes. + + When configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads. + + When configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads. + enum: + - SEQUENTIAL + - WORKLOAD_TYPE + - NODE_TYPE + externalDocs: + description: Modify the Replica Set Scaling Mode + url: https://dochub.mongodb.org/core/scale-nodes replicationSpecs: type: array description: List of settings that configure your cluster regions. This @@ -27036,6 +29010,24 @@ components: ClusterDescriptionProcessArgs: type: object properties: + changeStreamOptionsPreAndPostImagesExpireAfterSeconds: + type: integer + format: int32 + default: -1 + description: The minimum pre- and post-image retention time in seconds. + externalDocs: + description: "This option corresponds to the ``changeStreamOptions.preAndPostImages.expireAfterSeconds``\ + \ cluster parameter. This setting controls the retention policy of change\ + \ stream pre- and post-images. Pre- and post-images are the versions\ + \ of a document before and after document modification, respectively.\ + \ ``expireAfterSeconds`` controls how long MongoDB retains pre- and\ + \ post-images. When set to -1 (off), MongoDB uses the default retention\ + \ policy: pre- and post-images are retained until the corresponding\ + \ change stream events are removed from the oplog. To set the minimum\ + \ pre- and post-image retention time, specify an integer value greater\ + \ than zero. Setting this too low could increase the risk of interrupting\ + \ Realm sync or triggers processing. The default value is -1 (off)." + url: https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/changeStreamOptions/#mongodb-parameter-param.changeStreamOptions.preAndPostImages.expireAfterSeconds chunkMigrationConcurrency: type: integer format: int32 @@ -27046,6 +29038,14 @@ components: description: This option corresponds to the `chunkMigrationConcurrency` `mongod` configuration file option. url: https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.chunkMigrationConcurrency + defaultMaxTimeMS: + type: integer + format: int32 + description: Default time limit in milliseconds for individual read operations + to complete. + externalDocs: + description: This option corresponds to the defaultMaxTimeMS cluster parameter. + url: https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/defaultMaxTimeMS/ defaultReadConcern: type: string default: available @@ -27082,8 +29082,10 @@ components: url: https://docs.mongodb.com/upcoming/reference/parameters/#mongodb-parameter-param.failIndexKeyTooLong javascriptEnabled: type: boolean - description: Flag that indicates whether the cluster allows execution of - operations that perform server-side executions of JavaScript. + 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. @@ -27176,6 +29178,24 @@ components: ClusterDescriptionProcessArgs20240805: type: object properties: + changeStreamOptionsPreAndPostImagesExpireAfterSeconds: + type: integer + format: int32 + default: -1 + description: The minimum pre- and post-image retention time in seconds. + externalDocs: + description: "This option corresponds to the ``changeStreamOptions.preAndPostImages.expireAfterSeconds``\ + \ cluster parameter. This setting controls the retention policy of change\ + \ stream pre- and post-images. Pre- and post-images are the versions\ + \ of a document before and after document modification, respectively.\ + \ ``expireAfterSeconds`` controls how long MongoDB retains pre- and\ + \ post-images. When set to -1 (off), MongoDB uses the default retention\ + \ policy: pre- and post-images are retained until the corresponding\ + \ change stream events are removed from the oplog. To set the minimum\ + \ pre- and post-image retention time, specify an integer value greater\ + \ than zero. Setting this too low could increase the risk of interrupting\ + \ Realm sync or triggers processing. The default value is -1 (off)." + url: https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/changeStreamOptions/#mongodb-parameter-param.changeStreamOptions.preAndPostImages.expireAfterSeconds chunkMigrationConcurrency: type: integer format: int32 @@ -27186,6 +29206,14 @@ components: description: This option corresponds to the `chunkMigrationConcurrency` `mongod` configuration file option. url: https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.chunkMigrationConcurrency + defaultMaxTimeMS: + type: integer + format: int32 + description: Default time limit in milliseconds for individual read operations + to complete. + externalDocs: + description: This option corresponds to the defaultMaxTimeMS cluster parameter. + url: https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/defaultMaxTimeMS/ defaultWriteConcern: type: string description: Default level of acknowledgment requested from MongoDB for @@ -27196,8 +29224,10 @@ components: url: https://docs.mongodb.com/manual/reference/write-concern/ javascriptEnabled: type: boolean - description: Flag that indicates whether the cluster allows execution of - operations that perform server-side executions of JavaScript. + 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. @@ -27482,7 +29512,7 @@ components: outage simulation. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true groupId: type: string @@ -28297,6 +30327,7 @@ components: mapping: AWS: "#/components/schemas/AWSCreateDataProcessRegionView" AZURE: "#/components/schemas/AzureCreateDataProcessRegionView" + GCP: "#/components/schemas/GCPCreateDataProcessRegionView" propertyName: cloudProvider properties: cloudProvider: @@ -28779,11 +30810,11 @@ components: roleId: type: string description: Unique identifier of the role that Data Federation can use - to access the data stores.Required if specifying cloudProviderConfig. + to access the data stores. Required if specifying cloudProviderConfig. servicePrincipalId: type: string description: The ID of the Service Principal for which there is an access - policyfor Atlas to access Azure resources. + policy for Atlas to access Azure resources. readOnly: true tenantId: type: string @@ -28792,6 +30823,22 @@ components: readOnly: true required: - roleId + DataFederationGCPCloudProviderConfig: + type: object + description: Configuration for running Data Federation in GCP. + 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: + type: string + description: Unique identifier of the role that Data Federation can use + to access the data stores. Required if specifying cloudProviderConfig. + required: + - roleId DataFederationLimit: type: object description: Details of user managed limits. @@ -28799,6 +30846,7 @@ components: mapping: atlas.project.deployment.clusters: "#/components/schemas/DefaultLimit" atlas.project.deployment.nodesPerPrivateLinkRegion: "#/components/schemas/DefaultLimit" + atlas.project.deployment.salesSoldM0s: "#/components/schemas/DefaultLimit" atlas.project.deployment.serverlessMTMs: "#/components/schemas/DefaultLimit" atlas.project.security.databaseAccess.customRoles: "#/components/schemas/DefaultLimit" atlas.project.security.databaseAccess.users: "#/components/schemas/DefaultLimit" @@ -29169,7 +31217,9 @@ components: $ref: "#/components/schemas/DataLakeAWSCloudProviderConfig" azure: $ref: "#/components/schemas/DataFederationAzureCloudProviderConfig" - title: Data Lake Cloud Provider + gcp: + $ref: "#/components/schemas/DataFederationGCPCloudProviderConfig" + title: Data Federation Cloud Provider DataLakeDLSAWSStore: type: object allOf: @@ -29294,6 +31344,7 @@ components: enum: - AWS - AZURE + - GCP region: $ref: "#/components/schemas/BaseAtlasDataLakeRegion" required: @@ -29770,7 +31821,7 @@ components: example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -30029,7 +32080,12 @@ components: enum: - AVERAGE operator: - $ref: "#/components/schemas/Operator" + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - LESS_THAN + - GREATER_THAN threshold: type: number format: double @@ -30077,6 +32133,7 @@ components: mapping: AWS: "#/components/schemas/AWSDataProcessRegionView" AZURE: "#/components/schemas/AzureDataProcessRegionView" + GCP: "#/components/schemas/GCPDataProcessRegionView" propertyName: cloudProvider properties: cloudProvider: @@ -30086,6 +32143,7 @@ components: enum: - AWS - AZURE + - GCP readOnly: true readOnly: true DataProtectionSettings: @@ -30377,6 +32435,8 @@ components: - SQL_SET_SCHEMA - VIEW_ALL_HISTORY - OUT_TO_S3 + - OUT_TO_AZURE + - OUT_TO_GCS - STORAGE_GET_CONFIG - STORAGE_SET_CONFIG - FLUSH_ROUTER_CONFIG @@ -30736,6 +32796,7 @@ components: - FTS_INDEX_BUILD_COMPLETE - FTS_INDEX_BUILD_FAILED - FTS_INDEXES_RESTORE_FAILED + - FTS_INDEXES_SYNONYM_MAPPING_INVALID title: FTS Index Audit Types - type: string enum: @@ -30936,6 +32997,7 @@ components: - FTS_INDEX_BUILD_COMPLETE - FTS_INDEX_BUILD_FAILED - FTS_INDEXES_RESTORE_FAILED + - FTS_INDEXES_SYNONYM_MAPPING_INVALID title: FTS Index Audit Types - type: string enum: @@ -31391,11 +33453,14 @@ components: - CLUSTER_VERSION_UNFIXED - CLUSTER_FCV_FIXED - CLUSTER_FCV_UNFIXED + - CLUSTER_FCV_EXPIRATION_DATE_UPDATED - AGENT_VERSION_FIXED - AGENT_VERSION_UNFIXED - FIXED_VERSION_UPDATED - FIXED_AGENT_VERSION_UPDATED - CLUSTER_FCV_DOWNGRADED + - CLUSTER_BINARY_VERSION_DOWNGRADED + - CLUSTER_BINARY_VERSION_UPGRADED title: Version Audit Types groupId: type: string @@ -31783,7 +33848,6 @@ components: pattern: "^([a-f0-9]{24})$" hostnameSchemaType: type: string - default: PUBLIC description: The network type to use between the migration host and the destination cluster. enum: @@ -31984,30 +34048,19 @@ components: createdAt: type: string format: date-time - description: Date and time when someone created this export job. MongoDB - Cloud represents this timestamp in ISO 8601 format in UTC. + description: Date and time when a user or Atlas created the Export Job. + MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. readOnly: true customData: type: array description: Collection of key-value pairs that represent custom data for - the metadata file that MongoDB Cloud uploads to the bucket when the export - job finishes. + the metadata file that MongoDB Cloud uploads when the Export Job finishes. items: $ref: "#/components/schemas/BackupLabel" - 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\"`." - items: - type: string - description: One Uniform Resource Locator that point to the compressed - snapshot files for manual download. - readOnly: true exportBucketId: type: string description: Unique 24-hexadecimal character string that identifies the - Export Bucket to export to. + Export Bucket. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 @@ -32018,7 +34071,7 @@ components: finishedAt: type: string format: date-time - description: Date and time when this export job completed. MongoDB Cloud + description: Date and time when this Export Job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. readOnly: true id: @@ -32043,8 +34096,8 @@ components: readOnly: true prefix: type: string - description: Full path on the cloud provider bucket to the folder where - the snapshot is exported. + description: Prefix used for all blob storage objects uploaded as part of + the Export Job. pattern: "/exported_snapshots/\\{ORG-NAME\\}/\\{PROJECT-NAME\\}/\\{CLUSTER-NAME\\\ }/\\{SNAPSHOT-INITIATION-DATE\\}/\\{TIMESTAMP\\}" readOnly: true @@ -32058,7 +34111,7 @@ components: pattern: "^([a-f0-9]{24})$" state: type: string - description: State of the export job. + description: State of the Export Job. enum: - Cancelled - Failed @@ -32081,7 +34134,7 @@ components: exportBucketId: type: string description: Unique 24-hexadecimal character string that identifies the - Export Bucket to export to. + Export Bucket. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 @@ -32288,10 +34341,19 @@ components: properties: downloadUrl: type: string - description: "One Uniform Resource Locator that point to the compressed\ + 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." + items: + $ref: "#/components/schemas/ApiPrivateDownloadDeliveryUrl" + readOnly: true replicaSetName: type: string description: Human-readable label that identifies the replica set on the @@ -32743,7 +34805,7 @@ components: \ this parameter when `\"deliveryType\" : \"download\"`." items: type: string - description: One Uniform Resource Locator that point to the compressed + description: One Uniform Resource Locator that points to the compressed snapshot files for manual download. readOnly: true desiredTimestamp: @@ -32815,6 +34877,15 @@ components: \ when `\"deliveryType\" : \"pointInTime\"` and **pointInTimeUTCSeconds**\ \ exceeds `0`." minimum: 1199145600 + 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." + items: + $ref: "#/components/schemas/ApiPrivateDownloadDeliveryUrl" + readOnly: true snapshotId: type: string description: Unique 24-hexadecimal character string that identifies the @@ -32831,7 +34902,7 @@ components: and `pointInTime` restore types. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" targetGroupId: type: string description: Unique 24-hexadecimal digit string that identifies the target @@ -32872,7 +34943,7 @@ components: you want to return. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true copySettings: type: array @@ -32966,7 +35037,7 @@ components: you want to return. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true copySettings: type: array @@ -33052,8 +35123,12 @@ components: additionalProperties: type: object description: The stats associated with the stream processor. + externalDocs: + url: https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor readOnly: true description: The stats associated with the stream processor. + externalDocs: + url: https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor readOnly: true EARPrivateEndpoint: type: object @@ -33148,6 +35223,8 @@ components: - PENDING_ACCEPTANCE - ACTIVE - FAILED + - PENDING_RECREATION + - DELETING readOnly: true title: Encryption At Rest Private Endpoint EmailNotification: @@ -33194,6 +35271,36 @@ components: required: - typeName title: Email Notification + EmployeeAccessGrantView: + type: object + description: MongoDB employee granted access level and expiration for a cluster. + properties: + expirationTime: + type: string + format: date-time + description: Expiration date for the employee access grant. + 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." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + readOnly: true + required: + - expirationTime + - grantType EncryptionAtRest: type: object properties: @@ -33203,24 +35310,6 @@ components: $ref: "#/components/schemas/AzureKeyVault" googleCloudKms: $ref: "#/components/schemas/GoogleCloudKMS" - EncryptionAtRestPrivateEndpointRequest: - type: object - description: Create or delete private endpoints from the specified regions list. - properties: - cloudProvider: - type: string - description: Cloud service provider name. - enum: - - AZURE - regions: - type: array - description: List of regions. - items: - type: string - uniqueItems: true - required: - - cloudProvider - title: Encryption At Rest Private Endpoints setup. EncryptionKeyAlertConfigViewForNdsGroup: type: object description: Encryption key alert configuration allows to select thresholds which @@ -33567,6 +35656,7 @@ components: - FTS_INDEX_CLEANED_UP - FTS_INDEXES_RESTORED - FTS_INDEXES_RESTORE_FAILED + - FTS_INDEXES_SYNONYM_MAPPING_INVALID title: FTS Index Audit Types - type: string enum: @@ -33620,6 +35710,8 @@ components: - HOST_HAS_INDEX_SUGGESTIONS - HOST_MONGOT_RECOVERED_OOM - HOST_MONGOT_CRASHING_OOM + - HOST_MONGOT_RESUME_REPLICATION + - HOST_MONGOT_STOP_REPLICATION - HOST_ENOUGH_DISK_SPACE - HOST_NOT_ENOUGH_DISK_SPACE title: Host Event Types @@ -33657,6 +35749,7 @@ components: - 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 @@ -33734,6 +35827,8 @@ components: - 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 @@ -33763,6 +35858,9 @@ components: - 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 @@ -33821,9 +35919,13 @@ components: - 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 title: NDS Audit Types - type: string enum: @@ -34020,11 +36122,14 @@ components: - CLUSTER_VERSION_UNFIXED - CLUSTER_FCV_FIXED - CLUSTER_FCV_UNFIXED + - CLUSTER_FCV_EXPIRATION_DATE_UPDATED - AGENT_VERSION_FIXED - AGENT_VERSION_UNFIXED - FIXED_VERSION_UPDATED - FIXED_AGENT_VERSION_UPDATED - CLUSTER_FCV_DOWNGRADED + - CLUSTER_BINARY_VERSION_DOWNGRADED + - CLUSTER_BINARY_VERSION_UPGRADED title: Version Audit Types - type: string enum: @@ -34300,6 +36405,12 @@ components: enum: - GROUP_TAGS_MODIFIED title: Resource Event Types + - type: string + enum: + - RESOURCE_POLICY_CREATED + - RESOURCE_POLICY_MODIFIED + - RESOURCE_POLICY_DELETED + title: Atlas Resource Policy Audit Types EventViewForNdsGroup: type: object oneOf: @@ -34341,6 +36452,7 @@ components: - $ref: "#/components/schemas/TeamEvent" - $ref: "#/components/schemas/UserEventViewForOrg" - $ref: "#/components/schemas/ResourceEventViewForOrg" + - $ref: "#/components/schemas/AtlasResourcePolicyAuditForOrg" ExampleResourceResponse20230101: type: object properties: @@ -34390,8 +36502,7 @@ components: - description ExportStatus: type: object - description: State of the export job for the collections on the replica set - only. + description: State of the Export Job. properties: exportedCollections: type: integer @@ -34437,6 +36548,7 @@ components: - FTS_INDEX_CLEANED_UP - FTS_INDEXES_RESTORED - FTS_INDEXES_RESTORE_FAILED + - FTS_INDEXES_SYNONYM_MAPPING_INVALID example: FTS_INDEX_CREATED title: FTS Index Audit Types FTSIndexAuditView: @@ -35364,37 +37476,52 @@ components: enum: - EXCLUDE title: Field Transformation - ForNdsGroup: + FieldViolation: type: object - description: ReplicaSet Event identifies different activities about replica - set of mongod instances. properties: - created: + description: type: string - format: date-time - description: Date and time when this event occurred. This parameter expresses - its value in the ISO 8601 timestamp format in UTC. + 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. + required: + - description + - field + FlexBackupRestoreJob20250101: + type: object + description: Details for one restore job of a flex cluster. + properties: + deliveryType: + type: string + description: Means by which this resource returns the snapshot to the requesting + MongoDB Cloud user. + enum: + - RESTORE + - DOWNLOAD readOnly: true - eventTypeName: - $ref: "#/components/schemas/ReplicaSetEventTypeViewForNdsGroup" - groupId: + expirationDate: type: string - description: Unique 24-hexadecimal digit string that identifies the project - in which the event occurred. The **eventId** identifies the specific event. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" + format: date-time + description: Date and time when the download link no longer works. This + parameter expresses its value in the ISO 8601 timestamp format in UTC. readOnly: true id: type: string - description: Unique 24-hexadecimal digit string that identifies the event. + description: Unique 24-hexadecimal digit string that identifies the restore + job. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true + instanceName: + type: string + description: Human-readable label that identifies the source instance. + maxLength: 64 + minLength: 1 + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + readOnly: true links: type: array description: "List of one or more Uniform Resource Locators (URLs) that\ @@ -35406,656 +37533,296 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true - orgId: + projectId: type: string - description: Unique 24-hexadecimal digit string that identifies the organization - to which these events apply. + description: Unique 24-hexadecimal digit string that identifies the project + from which the restore job originated. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true - port: - type: integer - format: int32 - description: IANA port on which the MongoDB process listens for requests. - example: 27017 - readOnly: true - raw: - $ref: "#/components/schemas/raw" - replicaSetName: + restoreFinishedDate: type: string - description: Human-readable label of the replica set associated with the - event. - example: event-replica-set + format: date-time + 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. readOnly: true - shardName: + restoreScheduledDate: type: string - description: Human-readable label of the shard associated with the event. - example: event-sh-01 + format: date-time + description: Date and time when MongoDB Cloud will restore this snapshot. + This parameter expresses its value in the ISO 8601 timestamp format in + UTC. readOnly: true - required: - - created - - eventTypeName - - id - title: ReplicaSet Events - GCPCloudProviderContainer: - type: object - allOf: - - $ref: "#/components/schemas/CloudProviderContainer" - - type: object - properties: - atlasCidrBlock: - type: string - description: |- - IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project. - - These CIDR blocks must fall within the ranges reserved per RFC 1918. GCP further limits the block to a lower bound of the `/18` range. - - To modify the CIDR block, the target project cannot have: - - - Any M10 or greater clusters - - Any other VPC peering connections - - You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project. - - **Example:** A project in an Google Cloud (GCP) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets. - pattern: "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" - gcpProjectId: - 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. - maxLength: 26 - minLength: 26 - pattern: "^p-[0-9a-z]{24}$" - readOnly: true - networkName: - 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. - maxLength: 36 - minLength: 36 - pattern: "^nt-[0-9a-f]{24}-[0-9a-z]{8}$" - 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." - 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." - 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 - description: Collection of settings that configures the network container for - a virtual private connection on Amazon Web Services. - required: - - atlasCidrBlock - title: GCP - GCPComputeAutoScaling: - type: object - description: Collection of settings that configures how a cluster might scale - its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling - is unavailable for clusters using Low CPU or NVME storage classes. - properties: - maxInstanceSize: - type: string - description: Maximum instance size to which your cluster can automatically - scale. - enum: - - M10 - - M20 - - M30 - - M40 - - M50 - - M60 - - M80 - - M140 - - M200 - - M250 - - M300 - - M400 - - R40 - - R50 - - R60 - - R80 - - R200 - - R300 - - R400 - - R600 - title: GCP Instance Sizes - minInstanceSize: + snapshotFinishedDate: 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 - title: GCP Instance Sizes - title: GCP - GCPConsumerForwardingRule: - type: object - properties: - endpointName: + format: date-time + description: Date and time when MongoDB Cloud completed writing this snapshot. + This parameter expresses its value in the ISO 8601 timestamp format in + UTC. + readOnly: true + snapshotId: type: string - description: Human-readable label that identifies the Google Cloud consumer - forwarding rule that you created. - externalDocs: - description: Google Cloud Forwarding Rule Concepts - url: https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts + description: Unique 24-hexadecimal digit string that identifies the snapshot + to restore. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" readOnly: true - ipAddress: + snapshotUrl: type: string - description: One Private Internet Protocol version 4 (IPv4) address to which - this Google Cloud consumer forwarding rule resolves. - pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + 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: State of the MongoDB Cloud endpoint group when MongoDB Cloud - received this request. + description: Phase of the restore workflow for this job at the time this + resource made this request. enum: - - INITIATING - - AVAILABLE + - PENDING + - QUEUED + - RUNNING - FAILED - - DELETING + - COMPLETED readOnly: true - GCPEndpointService: + targetDeploymentItemName: + type: string + description: Human-readable label that identifies the instance or cluster + on the target project to which you want to restore the snapshot. You can + restore the snapshot to another USS instance or Dedicated cluster tier. + maxLength: 64 + minLength: 1 + pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + readOnly: true + targetProjectId: + type: string + description: Unique 24-hexadecimal digit string that identifies the project + that contains the instance or cluster to which you want to restore the + snapshot. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + title: Flex Backup Restore Job + FlexBackupRestoreJobCreate20250101: type: object - description: Group of Private Endpoint Service settings. + description: Details to create one restore job of a flex cluster. properties: - cloudProvider: + _snapshotId: type: string - description: Cloud service provider that serves the requested endpoint service. + description: Unique 24-hexadecimal digit string that identifies the snapshot + to restore. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + writeOnly: true + _targetDeploymentItemName: + type: string + description: Human-readable label that identifies the instance or cluster + on the target project to which you want to restore the snapshot. You can + restore the snapshot to another flex cluster or dedicated cluster tier. + maxLength: 64 + minLength: 1 + pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + writeOnly: true + _targetProjectId: + type: string + description: Unique 24-hexadecimal digit string that identifies the project + that contains the instance or cluster to which you want to restore the + snapshot. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + writeOnly: true + deliveryType: + type: string + description: Means by which this resource returns the snapshot to the requesting + MongoDB Cloud user. enum: - - AWS - - AZURE - - GCP + - RESTORE + - DOWNLOAD readOnly: true - 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 - items: - type: string - description: One Google Cloud network endpoint group that corresponds - to the Private Service Connect endpoint service. - errorMessage: + expirationDate: type: string - description: Error message returned when requesting private connection resource. - The resource returns `null` if the request succeeded. + format: date-time + description: Date and time when the download link no longer works. This + parameter expresses its value in the ISO 8601 timestamp format in UTC. readOnly: true id: type: string - description: Unique 24-hexadecimal digit string that identifies the Private - Endpoint Service. + description: Unique 24-hexadecimal digit string that identifies the restore + job. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true - regionName: + instanceName: type: string - description: Cloud provider region that manages this Private Endpoint Service. + description: Human-readable label that identifies the source instance. + maxLength: 64 + minLength: 1 + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true - serviceAttachmentNames: + links: 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. + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." externalDocs: - description: Google Cloud Private Service Connect Service Attachments - url: https://cloud.google.com/vpc/docs/private-service-connect#service-attachments + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 items: - 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. - 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\\-]+" - status: + $ref: "#/components/schemas/Link" + readOnly: true + projectId: type: string - description: State of the Private Endpoint Service connection when MongoDB - Cloud received this request. - enum: - - INITIATING - - AVAILABLE - - WAITING_FOR_USER - - FAILED - - DELETING - readOnly: true - required: - - cloudProvider - title: GCP - GCPHardwareSpec: - type: object - properties: - instanceSize: - type: string - description: Hardware specification for the instance sizes in this region. - Each instance size has a default storage and memory capacity. The instance - size you select applies to all the data-bearing hosts 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 - title: GCP Instance Sizes - nodeCount: - type: integer - format: int32 - description: Number of nodes of the given type for MongoDB Cloud to deploy - to the region. - GCPHardwareSpec20240805: - type: object - properties: - diskSizeGB: - type: number - format: double - description: "Storage capacity of instance data volumes expressed in gigabytes.\ - \ Increase this number to add capacity.\n\n This value must be equal for\ - \ all shards and node types.\n\n This value is not configurable on M0/M2/M5\ - \ clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\ - \n If you specify a disk size below the minimum (10 GB), this parameter\ - \ defaults to the minimum disk size value. \n\n Storage charge calculations\ - \ depend on whether you choose the default value or a custom value.\n\n\ - \ The maximum value for disk storage cannot exceed 50 times the maximum\ - \ RAM for the selected cluster. If you require more storage space, consider\ - \ upgrading your cluster to a higher tier." - maximum: 4096 - minimum: 10 - instanceSize: - type: string - description: Hardware specification for the instance sizes in this region - in this shard. Each instance size has a default storage and memory capacity. - Electable nodes and read-only nodes (known as "base nodes") within a single - shard must use the same instance size. Analytics nodes can scale independently - from base nodes within a shard. Both base nodes and analytics nodes can - scale independently from their equivalents in other shards. - enum: - - M10 - - M20 - - M30 - - M40 - - M50 - - M60 - - M80 - - M140 - - M200 - - M250 - - M300 - - M400 - - R40 - - R50 - - R60 - - R80 - - R200 - - R300 - - R400 - - R600 - title: GCP Instance Sizes - nodeCount: - type: integer - format: int32 - description: Number of nodes of the given type for MongoDB Cloud to deploy - to the region. - GCPNetworkPeeringConnectionSettings: - type: object - description: Group of Network Peering connection settings. - properties: - containerId: - type: string - description: Unique 24-hexadecimal digit string that identifies the MongoDB - Cloud network container that contains the specified network peering connection. + description: Unique 24-hexadecimal digit string that identifies the project + from which the restore job originated. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" - 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: + restoreFinishedDate: 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. - maxLength: 30 - minLength: 6 - pattern: "^[a-z][0-9a-z-]{4,28}[0-9a-z]{1}" - id: + format: date-time + 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. + readOnly: true + restoreScheduledDate: type: string - description: Unique 24-hexadecimal digit string that identifies the network - peering connection. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" + format: date-time + description: Date and time when MongoDB Cloud will restore this snapshot. + This parameter expresses its value in the ISO 8601 timestamp format in + UTC. readOnly: true - networkName: + snapshotFinishedDate: type: string - description: Human-readable label that identifies the network to peer with - the MongoDB Cloud VPC. - maxLength: 63 - minLength: 1 - pattern: "[a-z]([-a-z0-9]{0,62}[a-z0-9]{0,1})?" - providerName: + format: date-time + description: Date and time when MongoDB Cloud completed writing this snapshot. + This parameter expresses its value in the ISO 8601 timestamp format in + UTC. + readOnly: true + snapshotUrl: type: string - description: Cloud service provider that serves the requested network peering - connection. - enum: - - AWS - - AZURE - - GCP + 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: State of the network peering connection at the time you made - the request. + description: Phase of the restore workflow for this job at the time this + resource made this request. enum: - - ADDING_PEER - - WAITING_FOR_USER - - AVAILABLE + - PENDING + - QUEUED + - RUNNING - FAILED - - DELETING + - COMPLETED readOnly: true required: - - containerId - - gcpProjectId - - networkName - title: GCP - GCPRegionConfig: - type: object - allOf: - - $ref: "#/components/schemas/CloudRegionConfig" - - type: object - properties: - analyticsAutoScaling: - $ref: "#/components/schemas/AdvancedAutoScalingSettings" - analyticsSpecs: - $ref: "#/components/schemas/DedicatedHardwareSpec" - autoScaling: - $ref: "#/components/schemas/AdvancedAutoScalingSettings" - readOnlySpecs: - $ref: "#/components/schemas/DedicatedHardwareSpec" - description: Details that explain how MongoDB Cloud replicates data in one region - on the specified MongoDB database. - title: GCP Regional Replication Specifications - GCPRegionConfig20240805: - type: object - allOf: - - $ref: "#/components/schemas/CloudRegionConfig20240805" - - type: object - properties: - analyticsAutoScaling: - $ref: "#/components/schemas/AdvancedAutoScalingSettings" - analyticsSpecs: - $ref: "#/components/schemas/DedicatedHardwareSpec20240805" - autoScaling: - $ref: "#/components/schemas/AdvancedAutoScalingSettings" - readOnlySpecs: - $ref: "#/components/schemas/DedicatedHardwareSpec20240805" - description: Details that explain how MongoDB Cloud replicates data in one region - on the specified MongoDB database. - title: GCP Regional Replication Specifications - GeoSharding: + - _snapshotId + - _targetDeploymentItemName + title: Create Flex Backup Restore Job + FlexBackupSettings20250101: type: object + description: Flex backup configuration properties: - customZoneMapping: - type: object - additionalProperties: - 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 - 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. - items: - $ref: "#/components/schemas/ManagedNamespaces" - readOnly: true - selfManagedSharding: + enabled: 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. + default: true + description: "Flag that indicates whether backups are performed for this\ + \ flex cluster. Backup uses [TODO](TODO) for flex clusters." readOnly: true - GeoSharding20240805: + readOnly: true + title: Flex Backup Configuration + FlexBackupSnapshot20250101: type: object + description: Details for one snapshot of a flex cluster. properties: - customZoneMapping: - type: object - additionalProperties: - type: string - description: |- - List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone. - - The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property. - - This parameter returns an empty object if no custom zones exist. - readOnly: true - description: |- - List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone. - - The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property. - - This parameter returns an empty object if no custom zones exist. - readOnly: true - managedNamespaces: - type: array - description: List that contains a namespace for a Global Cluster. MongoDB - Cloud manages this cluster. - items: - $ref: "#/components/schemas/ManagedNamespaces" - readOnly: true - 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. + expiration: + type: string + format: date-time + description: Date and time when the download link no longer works. This + parameter expresses its value in the ISO 8601 timestamp format in UTC. readOnly: true - GoogleCloudKMS: - type: object - description: Details that define the configuration of Encryption at Rest using - Google Cloud Key Management Service (KMS). - externalDocs: - description: Google Cloud Key Management Service - url: https://www.mongodb.com/docs/atlas/security-gcp-kms/ - properties: - enabled: - 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: + finishTime: 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 - serviceAccountKey: + format: date-time + description: Date and time when MongoDB Cloud completed writing this snapshot. + This parameter expresses its value in the ISO 8601 timestamp format in + UTC. + readOnly: true + id: type: string - description: 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. + description: Unique 24-hexadecimal digit string that identifies the snapshot. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." externalDocs: - description: Google Cloud Authentication - url: https://cloud.google.com/docs/authentication/getting-started - writeOnly: true - valid: - type: boolean - description: Flag that indicates whether the Google Cloud Key Management - Service (KMS) encryption key can encrypt and decrypt data. + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" readOnly: true - GreaterThanDaysThresholdView: - type: object - description: Threshold value that triggers an alert. - properties: - operator: - type: string - description: Comparison operator to apply when checking the current metric - value. - enum: - - GREATER_THAN - threshold: - type: integer - format: int32 - description: "Value of metric that, when exceeded, triggers an alert." - units: + mongoDBVersion: type: string - description: "Element used to express the quantity. This can be an element\ - \ of time, storage capacity, and the like." - enum: - - DAYS - GreaterThanRawThreshold: - type: object - description: A Limit that triggers an alert when greater than a number. - properties: - operator: + description: MongoDB host version that the snapshot runs. + readOnly: true + scheduledTime: type: string - description: Comparison operator to apply when checking the current metric - value. - enum: - - GREATER_THAN - threshold: - type: integer - format: int32 - description: "Value of metric that, when exceeded, triggers an alert." - units: - $ref: "#/components/schemas/RawMetricUnits" - title: Greater Than Raw Threshold - GreaterThanRawThresholdAlertConfigViewForNdsGroup: - type: object - properties: - created: + format: date-time + description: Date and time when MongoDB Cloud will take the snapshot. This + parameter expresses its value in the ISO 8601 timestamp format in UTC. + readOnly: true + startTime: type: string format: date-time - description: Date and time when MongoDB Cloud created the alert configuration. - This parameter expresses its value in the ISO 8601 timestamp format - in UTC. + description: Date and time when MongoDB Cloud began taking the snapshot. + This parameter expresses its value in the ISO 8601 timestamp format in + UTC. readOnly: true - enabled: - type: boolean - default: false - description: Flag that indicates whether someone enabled this alert configuration - for the specified project. - eventTypeName: - $ref: "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" - groupId: + status: type: string - description: Unique 24-hexadecimal digit string that identifies the project - that owns this alert configuration. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" + description: Phase of the workflow for this snapshot at the time this resource + made this request. + enum: + - PENDING + - QUEUED + - RUNNING + - FAILED + - COMPLETED readOnly: true - id: + title: Flex Backup Snapshot + FlexBackupSnapshotDownloadCreate20250101: + type: object + description: Details for one backup snapshot download of a flex cluster. + properties: + _snapshotId: type: string - description: Unique 24-hexadecimal digit string that identifies this alert - configuration. + description: Unique 24-hexadecimal digit string that identifies the snapshot + to download. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" - readOnly: true + writeOnly: true links: type: array description: "List of one or more Uniform Resource Locators (URLs) that\ @@ -36067,67 +37834,42 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true - matchers: - type: array - description: "List of rules that determine whether MongoDB Cloud checks\ - \ an object for the alert configuration. You can filter using the matchers\ - \ array if the **eventTypeName** specifies an event for a host, replica\ - \ set, or sharded cluster." - items: - $ref: "#/components/schemas/ReplicaSetMatcher" - notifications: - type: array - description: List that contains the targets that MongoDB Cloud sends notifications. - items: - $ref: "#/components/schemas/AlertsNotificationRootForGroup" - threshold: - $ref: "#/components/schemas/GreaterThanRawThreshold" - updated: - type: string - format: date-time - description: Date and time when someone last updated this alert configuration. - This parameter expresses its value in the ISO 8601 timestamp format - in UTC. - readOnly: true required: - - eventTypeName - - notifications - GreaterThanTimeThreshold: + - _snapshotId + title: Flex Backup Snapshot Download Create + FlexClusterDescription20250101: type: object - description: A Limit that triggers an alert when greater than a time period. + description: Group of settings that configure a MongoDB Flex cluster. properties: - operator: + backupSettings: + $ref: "#/components/schemas/FlexBackupSettings20250101" + clusterType: type: string - description: Comparison operator to apply when checking the current metric - value. + description: Flex cluster topology. enum: - - GREATER_THAN - threshold: - type: integer - format: int32 - description: "Value of metric that, when exceeded, triggers an alert." - units: - $ref: "#/components/schemas/TimeMetricUnits" - title: Greater Than Time Threshold - Group: - type: object - properties: - clusterCount: - type: integer - format: int64 - description: Quantity of MongoDB Cloud clusters deployed in this project. + - REPLICASET + - LOADBALANCED readOnly: true - created: + connectionStrings: + $ref: "#/components/schemas/FlexConnectionStrings20250101" + createDate: type: string format: date-time - description: Date and time when MongoDB Cloud created this project. This - parameter expresses its value in the ISO 8601 timestamp format in UTC. + description: Date and time when MongoDB Cloud created this instance. This + parameter expresses its value in ISO 8601 format in UTC. + readOnly: true + groupId: + type: string + description: Unique 24-hexadecimal character string that identifies the + project. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" readOnly: true id: type: string - description: Unique 24-hexadecimal digit string that identifies the MongoDB - Cloud project. + description: Unique 24-hexadecimal digit string that identifies the instance. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 @@ -36144,18 +37886,1021 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true + mongoDBVersion: + type: string + description: Version of MongoDB that the instance runs. + pattern: "([\\d]+\\.[\\d]+\\.[\\d]+)" + readOnly: true name: type: string - description: Human-readable label that identifies the project included in - the MongoDB Cloud organization. + description: Human-readable label that identifies the instance. maxLength: 64 minLength: 1 - pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" - orgId: + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + readOnly: true + providerSettings: + $ref: "#/components/schemas/FlexProviderSettings20250101" + stateName: type: string - description: Unique 24-hexadecimal digit string that identifies the MongoDB - Cloud organization to which the project belongs. - example: 32b6e34b3d91647abb20e7b8 + description: Human-readable label that indicates the current operating condition + of this instance. + enum: + - IDLE + - CREATING + - UPDATING + - DELETING + - REPAIRING + readOnly: true + tags: + type: array + description: List that contains key-value pairs between 1 to 255 characters + in length for tagging and categorizing the instance. + externalDocs: + description: Resource Tags + url: https://dochub.mongodb.org/core/add-cluster-tag-atlas + items: + $ref: "#/components/schemas/ResourceTag" + terminationProtectionEnabled: + type: boolean + default: false + description: "Flag that indicates whether termination protection is enabled\ + \ on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster.\ + \ If set to `false`, MongoDB Cloud will delete the cluster." + versionReleaseSystem: + type: string + default: LTS + description: Method by which the cluster maintains the MongoDB versions. + enum: + - LTS + readOnly: true + required: + - providerSettings + title: Flex Cluster Description + FlexClusterDescriptionCreate20250101: + type: object + description: Settings that you can specify when you create a flex cluster. + properties: + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + name: + type: string + description: Human-readable label that identifies the instance. + maxLength: 64 + minLength: 1 + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + writeOnly: true + providerSettings: + $ref: "#/components/schemas/FlexProviderSettingsCreate20250101" + tags: + type: array + description: List that contains key-value pairs between 1 to 255 characters + in length for tagging and categorizing the instance. + externalDocs: + description: Resource Tags + url: https://dochub.mongodb.org/core/add-cluster-tag-atlas + items: + $ref: "#/components/schemas/ResourceTag" + terminationProtectionEnabled: + type: boolean + default: false + description: "Flag that indicates whether termination protection is enabled\ + \ on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster.\ + \ If set to `false`, MongoDB Cloud will delete the cluster." + required: + - name + - providerSettings + title: Flex Cluster Description Create + FlexConnectionStrings20250101: + type: object + description: Collection of Uniform Resource Locators that point to the MongoDB + database. + externalDocs: + description: Connection string URI format. + url: https://docs.mongodb.com/manual/reference/connection-string/ + properties: + standard: + type: string + description: Public connection string that you can use to connect to this + cluster. This connection string uses the mongodb:// protocol. + externalDocs: + description: Connection String URI Format + url: https://docs.mongodb.com/manual/reference/connection-string/ + readOnly: true + standardSrv: + type: string + description: Public connection string that you can use to connect to this + flex cluster. This connection string uses the `mongodb+srv://` protocol. + externalDocs: + description: Connection String URI Format + url: https://docs.mongodb.com/manual/reference/connection-string/ + readOnly: true + readOnly: true + title: Flex Cluster Connection Strings + FlexProviderSettings20250101: + type: object + description: Group of cloud provider settings that configure the provisioned + MongoDB flex cluster. + properties: + backingProviderName: + type: string + description: Cloud service provider on which MongoDB Cloud provisioned the + flex cluster. + enum: + - AWS + - AZURE + - GCP + readOnly: true + diskSizeGB: + type: number + format: double + description: Storage capacity available to the flex cluster expressed in + gigabytes. + readOnly: true + providerName: + type: string + default: FLEX + description: Human-readable label that identifies the cloud service provider. + enum: + - FLEX + readOnly: true + regionName: + type: string + description: "Human-readable label that identifies the geographic location\ + \ of your MongoDB flex cluster. The region you choose can affect network\ + \ latency for clients accessing your databases. For a complete list of\ + \ region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws),\ + \ [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/)." + readOnly: true + readOnly: true + title: Cloud Service Provider Settings for a Flex Cluster + FlexProviderSettingsCreate20250101: + type: object + description: Group of cloud provider settings that configure the provisioned + MongoDB flex cluster. + properties: + backingProviderName: + type: string + description: Cloud service provider on which MongoDB Cloud provisioned the + flex cluster. + enum: + - AWS + - AZURE + - GCP + writeOnly: true + diskSizeGB: + type: number + format: double + description: Storage capacity available to the flex cluster expressed in + gigabytes. + readOnly: true + providerName: + type: string + default: FLEX + description: Human-readable label that identifies the cloud service provider. + enum: + - FLEX + readOnly: true + regionName: + type: string + description: "Human-readable label that identifies the geographic location\ + \ of your MongoDB flex cluster. The region you choose can affect network\ + \ latency for clients accessing your databases. For a complete list of\ + \ region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws),\ + \ [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/)." + writeOnly: true + required: + - backingProviderName + - regionName + title: Cloud Service Provider Settings for a Flex Cluster + writeOnly: true + ForNdsGroup: + type: object + description: ReplicaSet Event identifies different activities about replica + set of mongod instances. + properties: + created: + type: string + format: date-time + description: Date and time when this event occurred. This parameter expresses + its value in the ISO 8601 timestamp format in UTC. + readOnly: true + eventTypeName: + $ref: "#/components/schemas/ReplicaSetEventTypeViewForNdsGroup" + groupId: + type: string + description: Unique 24-hexadecimal digit string that identifies the project + in which the event occurred. The **eventId** identifies the specific event. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + id: + type: string + description: Unique 24-hexadecimal digit string that identifies the event. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + orgId: + type: string + description: Unique 24-hexadecimal digit string that identifies the organization + to which these events apply. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + port: + type: integer + format: int32 + description: IANA port on which the MongoDB process listens for requests. + example: 27017 + readOnly: true + raw: + $ref: "#/components/schemas/raw" + replicaSetName: + type: string + description: Human-readable label of the replica set associated with the + event. + example: event-replica-set + readOnly: true + shardName: + type: string + description: Human-readable label of the shard associated with the event. + example: event-sh-01 + readOnly: true + required: + - created + - eventTypeName + - id + title: ReplicaSet Events + GCPCloudProviderContainer: + type: object + allOf: + - $ref: "#/components/schemas/CloudProviderContainer" + - type: object + properties: + atlasCidrBlock: + type: string + description: |- + IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project. + + These CIDR blocks must fall within the ranges reserved per RFC 1918. GCP further limits the block to a lower bound of the `/18` range. + + To modify the CIDR block, the target project cannot have: + + - Any M10 or greater clusters + - Any other VPC peering connections + + You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project. + + **Example:** A project in an Google Cloud (GCP) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets. + pattern: "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + gcpProjectId: + 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. + maxLength: 26 + minLength: 26 + pattern: "^p-[0-9a-z]{24}$" + readOnly: true + networkName: + 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. + maxLength: 36 + minLength: 36 + pattern: "^nt-[0-9a-f]{24}-[0-9a-z]{8}$" + 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." + 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." + 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 + description: Collection of settings that configures the network container for + a virtual private connection on Amazon Web Services. + required: + - atlasCidrBlock + title: GCP + GCPComputeAutoScaling: + type: object + description: Collection of settings that configures how a cluster might scale + its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling + is unavailable for clusters using Low CPU or NVME storage classes. + properties: + maxInstanceSize: + type: string + description: Maximum instance size to which your cluster can automatically + scale. + enum: + - M10 + - M20 + - M30 + - M40 + - M50 + - M60 + - M80 + - M140 + - M200 + - M250 + - M300 + - M400 + - R40 + - R50 + - R60 + - R80 + - R200 + - R300 + - R400 + - R600 + title: GCP Instance Sizes + minInstanceSize: + 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 + title: GCP Instance Sizes + title: GCP + GCPConsumerForwardingRule: + type: object + properties: + endpointName: + type: string + description: Human-readable label that identifies the Google Cloud consumer + forwarding rule that you created. + externalDocs: + description: Google Cloud Forwarding Rule Concepts + url: https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts + readOnly: true + ipAddress: + type: string + description: One Private Internet Protocol version 4 (IPv4) address to which + this Google Cloud consumer forwarding rule resolves. + pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + readOnly: true + status: + type: string + description: State of the MongoDB Cloud endpoint group when MongoDB Cloud + received this request. + enum: + - INITIATING + - AVAILABLE + - FAILED + - DELETING + readOnly: true + 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 + 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. + enum: + - CENTRAL_US + - WESTERN_EUROPE + readOnly: true + GCPEndpointService: + type: object + description: Group of Private Endpoint Service settings. + properties: + cloudProvider: + type: string + description: Cloud service provider that serves the requested endpoint service. + enum: + - AWS + - AZURE + - GCP + readOnly: true + 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 + 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: + type: string + description: Unique 24-hexadecimal digit string that identifies the Private + Endpoint Service. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + 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 + items: + 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. + 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\\-]+" + status: + type: string + description: State of the Private Endpoint Service connection when MongoDB + Cloud received this request. + enum: + - INITIATING + - AVAILABLE + - WAITING_FOR_USER + - FAILED + - DELETING + readOnly: true + required: + - cloudProvider + title: GCP + GCPHardwareSpec: + type: object + properties: + instanceSize: + type: string + description: Hardware specification for the instance sizes in this region. + Each instance size has a default storage and memory capacity. The instance + size you select applies to all the data-bearing hosts 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 + title: GCP Instance Sizes + nodeCount: + type: integer + format: int32 + description: Number of nodes of the given type for MongoDB Cloud to deploy + to the region. + GCPHardwareSpec20240805: + type: object + properties: + diskSizeGB: + type: number + format: double + description: "Storage capacity of instance data volumes expressed in gigabytes.\ + \ Increase this number to add capacity.\n\n This value must be equal for\ + \ all shards and node types.\n\n This value is not configurable on M0/M2/M5\ + \ clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\ + \n If you specify a disk size below the minimum (10 GB), this parameter\ + \ defaults to the minimum disk size value. \n\n Storage charge calculations\ + \ depend on whether you choose the default value or a custom value.\n\n\ + \ The maximum value for disk storage cannot exceed 50 times the maximum\ + \ RAM for the selected cluster. If you require more storage space, consider\ + \ upgrading your cluster to a higher tier." + maximum: 4096 + minimum: 10 + instanceSize: + type: string + description: Hardware specification for the instance sizes in this region + in this shard. Each instance size has a default storage and memory capacity. + Electable nodes and read-only nodes (known as "base nodes") within a single + shard must use the same instance size. Analytics nodes can scale independently + from base nodes within a shard. Both base nodes and analytics nodes can + scale independently from their equivalents in other shards. + enum: + - M10 + - M20 + - M30 + - M40 + - M50 + - M60 + - M80 + - M140 + - M200 + - M250 + - M300 + - M400 + - R40 + - R50 + - R60 + - R80 + - R200 + - R300 + - R400 + - R600 + title: GCP Instance Sizes + nodeCount: + type: integer + format: int32 + description: Number of nodes of the given type for MongoDB Cloud to deploy + to the region. + GCPNetworkPeeringConnectionSettings: + type: object + description: Group of Network Peering connection settings. + properties: + containerId: + type: string + description: Unique 24-hexadecimal digit string that identifies the MongoDB + Cloud network container that contains the specified network peering connection. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + 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: + 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. + maxLength: 30 + minLength: 6 + pattern: "^[a-z][0-9a-z-]{4,28}[0-9a-z]{1}" + id: + type: string + description: Unique 24-hexadecimal digit string that identifies the network + peering connection. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + networkName: + type: string + description: Human-readable label that identifies the network to peer with + the MongoDB Cloud VPC. + maxLength: 63 + minLength: 1 + pattern: "[a-z]([-a-z0-9]{0,62}[a-z0-9]{0,1})?" + 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. + enum: + - ADDING_PEER + - WAITING_FOR_USER + - AVAILABLE + - FAILED + - DELETING + readOnly: true + required: + - containerId + - gcpProjectId + - networkName + title: GCP + GCPRegionConfig: + type: object + allOf: + - $ref: "#/components/schemas/CloudRegionConfig" + - type: object + properties: + analyticsAutoScaling: + $ref: "#/components/schemas/AdvancedAutoScalingSettings" + analyticsSpecs: + $ref: "#/components/schemas/DedicatedHardwareSpec" + autoScaling: + $ref: "#/components/schemas/AdvancedAutoScalingSettings" + readOnlySpecs: + $ref: "#/components/schemas/DedicatedHardwareSpec" + description: Details that explain how MongoDB Cloud replicates data in one region + on the specified MongoDB database. + title: GCP Regional Replication Specifications + GCPRegionConfig20240805: + type: object + allOf: + - $ref: "#/components/schemas/CloudRegionConfig20240805" + - type: object + properties: + analyticsAutoScaling: + $ref: "#/components/schemas/AdvancedAutoScalingSettings" + analyticsSpecs: + $ref: "#/components/schemas/DedicatedHardwareSpec20240805" + autoScaling: + $ref: "#/components/schemas/AdvancedAutoScalingSettings" + readOnlySpecs: + $ref: "#/components/schemas/DedicatedHardwareSpec20240805" + description: Details that explain how MongoDB Cloud replicates data in one region + on the specified MongoDB database. + title: GCP Regional Replication Specifications + GeoSharding: + type: object + properties: + customZoneMapping: + type: object + additionalProperties: + 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 + 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. + items: + $ref: "#/components/schemas/ManagedNamespaces" + readOnly: true + 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 + GeoSharding20240805: + type: object + properties: + customZoneMapping: + type: object + additionalProperties: + type: string + description: |- + List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone. + + The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property. + + This parameter returns an empty object if no custom zones exist. + readOnly: true + description: |- + List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone. + + The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property. + + This parameter returns an empty object if no custom zones exist. + readOnly: true + managedNamespaces: + type: array + description: List that contains a namespace for a Global Cluster. MongoDB + Cloud manages this cluster. + items: + $ref: "#/components/schemas/ManagedNamespaces" + readOnly: true + 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 + GoogleCloudKMS: + type: object + description: Details that define the configuration of Encryption at Rest using + Google Cloud Key Management Service (KMS). + externalDocs: + description: Google Cloud Key Management Service + url: https://www.mongodb.com/docs/atlas/security-gcp-kms/ + properties: + enabled: + 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 + 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. + externalDocs: + description: Google Cloud Authentication + url: https://cloud.google.com/docs/authentication/getting-started + writeOnly: true + valid: + type: boolean + description: Flag that indicates whether the Google Cloud Key Management + Service (KMS) encryption key can encrypt and decrypt data. + readOnly: true + GreaterThanDaysThresholdView: + type: object + description: Threshold value that triggers an alert. + properties: + operator: + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - GREATER_THAN + threshold: + type: integer + format: int32 + description: "Value of metric that, when exceeded, triggers an alert." + units: + type: string + description: "Element used to express the quantity. This can be an element\ + \ of time, storage capacity, and the like." + enum: + - DAYS + GreaterThanRawThreshold: + type: object + description: A Limit that triggers an alert when greater than a number. + properties: + operator: + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - GREATER_THAN + threshold: + type: integer + format: int32 + description: "Value of metric that, when exceeded, triggers an alert." + units: + $ref: "#/components/schemas/RawMetricUnits" + title: Greater Than Raw Threshold + GreaterThanRawThresholdAlertConfigViewForNdsGroup: + type: object + properties: + created: + type: string + format: date-time + description: Date and time when MongoDB Cloud created the alert configuration. + This parameter expresses its value in the ISO 8601 timestamp format + in UTC. + readOnly: true + enabled: + type: boolean + default: false + description: Flag that indicates whether someone enabled this alert configuration + for the specified project. + eventTypeName: + $ref: "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" + groupId: + type: string + description: Unique 24-hexadecimal digit string that identifies the project + that owns this alert configuration. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + id: + type: string + description: Unique 24-hexadecimal digit string that identifies this alert + configuration. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + matchers: + type: array + description: "List of rules that determine whether MongoDB Cloud checks\ + \ an object for the alert configuration. You can filter using the matchers\ + \ array if the **eventTypeName** specifies an event for a host, replica\ + \ set, or sharded cluster." + items: + $ref: "#/components/schemas/ReplicaSetMatcher" + notifications: + type: array + description: List that contains the targets that MongoDB Cloud sends notifications. + items: + $ref: "#/components/schemas/AlertsNotificationRootForGroup" + threshold: + $ref: "#/components/schemas/GreaterThanRawThreshold" + updated: + type: string + format: date-time + description: Date and time when someone last updated this alert configuration. + This parameter expresses its value in the ISO 8601 timestamp format + in UTC. + readOnly: true + required: + - eventTypeName + - notifications + GreaterThanTimeThreshold: + type: object + description: A Limit that triggers an alert when greater than a time period. + properties: + operator: + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - GREATER_THAN + threshold: + type: integer + format: int32 + description: "Value of metric that, when exceeded, triggers an alert." + units: + $ref: "#/components/schemas/TimeMetricUnits" + title: Greater Than Time Threshold + Group: + type: object + properties: + clusterCount: + type: integer + format: int64 + description: Quantity of MongoDB Cloud clusters deployed in this project. + readOnly: true + created: + type: string + format: date-time + description: Date and time when MongoDB Cloud created this project. This + parameter expresses its value in the ISO 8601 timestamp format in UTC. + readOnly: true + id: + type: string + description: Unique 24-hexadecimal digit string that identifies the MongoDB + Cloud project. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + name: + type: string + description: Human-readable label that identifies the project included in + the MongoDB Cloud organization. + maxLength: 64 + minLength: 1 + pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + orgId: + type: string + description: Unique 24-hexadecimal digit string that identifies the MongoDB + Cloud organization to which the project belongs. + example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" @@ -36404,25 +39149,26 @@ components: maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" - readOnly: true destinationOrgPrivateApiKey: type: string - description: "Unique string that identifies the private part of the [API\ - \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) used\ - \ to verify access to the destination organization. This parameter is\ - \ required only when you authenticate with Programmatic API Keys." + description: Unique string that identifies the private part of the API Key + used to verify access to the destination organization. This parameter + is required only when you authenticate with Programmatic API Keys. example: 55c3bbb6-b4bb-0be1-e66d20841f3e - readOnly: true + externalDocs: + description: Grant Programmatic Access to Atlas + url: https://dochub.mongodb.org/core/atlas-create-prog-api-key destinationOrgPublicApiKey: type: string - description: "Unique string that identifies the public part of the [API\ - \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) used\ - \ to verify access to the destination organization. This parameter is\ - \ required only when you authenticate with Programmatic API Keys." + description: Unique string that identifies the public part of the API Key + used to verify access to the destination organization. This parameter + is required only when you authenticate with Programmatic API Keys. example: zmmrboas + externalDocs: + description: Grant Programmatic Access to Atlas + url: https://dochub.mongodb.org/core/atlas-create-prog-api-key maxLength: 8 minLength: 8 - readOnly: true GroupNotification: type: object description: Group notification configuration for MongoDB Cloud to send information @@ -36512,7 +39258,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/EventViewForNdsGroup" @@ -36560,6 +39306,33 @@ components: - GROUP_READ_ONLY - GROUP_SEARCH_INDEX_EDITOR - GROUP_STREAM_PROCESSING_OWNER + GroupRoleAssignment: + type: object + properties: + groupId: + type: string + description: Unique 24-hexadecimal digit string that identifies the project + to which these roles belong. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + groupRoles: + type: array + description: One or more project level roles assigned to the MongoDB Cloud + user. + items: + type: string + enum: + - GROUP_OWNER + - GROUP_CLUSTER_MANAGER + - GROUP_STREAM_PROCESSING_OWNER + - GROUP_DATA_ACCESS_ADMIN + - GROUP_DATA_ACCESS_READ_WRITE + - GROUP_DATA_ACCESS_READ_ONLY + - GROUP_READ_ONLY + - GROUP_SEARCH_INDEX_EDITOR + uniqueItems: true GroupService: type: object description: List of IP addresses in a project categorized by services. @@ -36575,26 +39348,26 @@ components: GroupServiceAccount: type: object properties: + clientId: + type: string + description: The Client ID of the Service Account. + pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" createdAt: type: string format: date-time - description: Service account creation time. + description: The date that the Service Account was created on. description: type: string - description: Description of the service account. - id: - type: string - description: ID for the service account. - pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" + description: Human readable description for the Service Account. name: type: string - description: Name for service account. + description: Human-readable name for the Service Account. roles: type: array - description: Roles assigned to the Service Account group. + description: A list of Project roles associated with the Service Account. items: type: string - description: Project roles associated with the service account. + description: Project roles available for Service Accounts. enum: - GROUP_OWNER - GROUP_READ_ONLY @@ -36607,7 +39380,7 @@ components: uniqueItems: true secrets: type: array - description: List of secrets. + description: A list of secrets associated with the specified Service Account. items: $ref: "#/components/schemas/ServiceAccountSecret" uniqueItems: true @@ -36616,23 +39389,23 @@ components: properties: description: type: string - description: Human readable description for the service account. + description: Human readable description for the Service Account. maxLength: 250 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" name: type: string - description: Human-readable name for the service account. The name is modifiable + description: Human-readable name for the Service Account. The name is modifiable and does not have to be unique. maxLength: 64 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" roles: type: array - description: Project roles associated with the service account. + description: A list of project-level roles for the Service Account. items: type: string - description: Project roles associated with the service account. + description: Project roles available for Service Accounts. enum: - GROUP_OWNER - GROUP_READ_ONLY @@ -36645,20 +39418,23 @@ components: secretExpiresAfterHours: type: integer format: int32 - description: Secret expiration time. + description: The expiration time of the new Service Account secret. The + expiration is provided in hours. required: - description - name + - roles - secretExpiresAfterHours GroupServiceAccountRoleAssignment: type: object properties: roles: type: array - description: Group access roles. + description: The Project permissions for the Service Account in the specified + Project. items: type: string - description: Project roles associated with the service account. + description: Project roles available for Service Accounts. enum: - GROUP_OWNER - GROUP_READ_ONLY @@ -36669,28 +39445,30 @@ components: - GROUP_SEARCH_INDEX_EDITOR - GROUP_STREAM_PROCESSING_OWNER uniqueItems: true + required: + - roles GroupServiceAccountUpdateRequest: type: object properties: description: type: string - description: Human readable description for the service account. + description: Human readable description for the Service Account. maxLength: 250 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" name: type: string - description: Human-readable name for the service account. The name is modifiable + description: Human-readable name for the Service Account. The name is modifiable and does not have to be unique. maxLength: 64 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" roles: type: array - description: Project roles associated with the service account. + description: A list of Project roles associated with the Service Account. items: type: string - description: Project roles associated with the service account. + description: Project roles available for Service Accounts. enum: - GROUP_OWNER - GROUP_READ_ONLY @@ -36954,7 +39732,7 @@ components: example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -37073,6 +39851,8 @@ components: - HOST_HAS_INDEX_SUGGESTIONS - HOST_MONGOT_RECOVERED_OOM - HOST_MONGOT_CRASHING_OOM + - HOST_MONGOT_RESUME_REPLICATION + - HOST_MONGOT_STOP_REPLICATION - HOST_ENOUGH_DISK_SPACE - HOST_NOT_ENOUGH_DISK_SPACE example: HOST_DOWN @@ -37084,6 +39864,7 @@ components: - HOST_DOWN - HOST_HAS_INDEX_SUGGESTIONS - HOST_MONGOT_CRASHING_OOM + - HOST_MONGOT_STOP_REPLICATION - HOST_NOT_ENOUGH_DISK_SPACE example: HOST_DOWN title: Host Event Types @@ -37380,6 +40161,7 @@ components: OPCOUNTER_REPL_INSERT: "#/components/schemas/RawMetricAlertView" OPCOUNTER_REPL_UPDATE: "#/components/schemas/RawMetricAlertView" OPCOUNTER_UPDATE: "#/components/schemas/RawMetricAlertView" + OPERATIONS_QUERIES_KILLED: "#/components/schemas/RawMetricAlertView" OPERATIONS_SCAN_AND_ORDER: "#/components/schemas/RawMetricAlertView" OPERATION_THROTTLING_REJECTED_OPERATIONS: "#/components/schemas/RawMetricAlertView" OPLOG_MASTER_LAG_TIME_DIFF: "#/components/schemas/TimeMetricAlertView" @@ -37454,7 +40236,7 @@ components: example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -37783,6 +40565,7 @@ components: OPCOUNTER_REPL_INSERT: "#/components/schemas/RawMetricEventView" OPCOUNTER_REPL_UPDATE: "#/components/schemas/RawMetricEventView" OPCOUNTER_UPDATE: "#/components/schemas/RawMetricEventView" + OPERATIONS_QUERIES_KILLED: "#/components/schemas/RawMetricEventView" OPERATIONS_SCAN_AND_ORDER: "#/components/schemas/RawMetricEventView" OPERATION_THROTTLING_REJECTED_OPERATIONS: "#/components/schemas/RawMetricEventView" OPLOG_MASTER_LAG_TIME_DIFF: "#/components/schemas/TimeMetricEventView" @@ -38088,6 +40871,7 @@ components: OPCOUNTER_REPL_INSERT: "#/components/schemas/RawMetricThresholdView" OPCOUNTER_REPL_UPDATE: "#/components/schemas/RawMetricThresholdView" OPCOUNTER_UPDATE: "#/components/schemas/RawMetricThresholdView" + OPERATIONS_QUERIES_KILLED: "#/components/schemas/RawMetricThresholdView" OPERATIONS_SCAN_AND_ORDER: "#/components/schemas/RawMetricThresholdView" OPERATION_THROTTLING_REJECTED_OPERATIONS: "#/components/schemas/RawMetricThresholdView" OPLOG_MASTER_LAG_TIME_DIFF: "#/components/schemas/TimeMetricThresholdView" @@ -38132,7 +40916,12 @@ components: enum: - AVERAGE operator: - $ref: "#/components/schemas/Operator" + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - LESS_THAN + - GREATER_THAN threshold: type: number format: double @@ -38609,7 +41398,7 @@ components: the charge. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -39045,6 +41834,21 @@ components: - ATLAS_AWS_STREAM_PROCESSING_DATA_TRANSFER - ATLAS_AZURE_STREAM_PROCESSING_DATA_TRANSFER - ATLAS_AWS_STREAM_PROCESSING_VPC_PEERING + - 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 readOnly: true startDate: type: string @@ -39370,6 +42174,371 @@ components: - REPLICASET - SHARDED - GEOSHARDED + configServerManagementMode: + type: string + default: ATLAS_MANAGED + description: |- + Config Server Management Mode for creating or updating a sharded cluster. + + When configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings. + + When configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server. + enum: + - ATLAS_MANAGED + - FIXED_TO_DEDICATED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + configServerType: + type: string + description: Describes a sharded cluster's config server type. + enum: + - DEDICATED + - EMBEDDED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + readOnly: true + connectionStrings: + $ref: "#/components/schemas/ClusterConnectionStrings" + createDate: + type: string + format: date-time + description: Date and time when MongoDB Cloud created this serverless instance. + MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. + readOnly: true + diskSizeGB: + type: number + format: double + 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." + maximum: 4096 + minimum: 10 + diskWarmingMode: + type: string + default: FULLY_WARMED + description: Disk warming mode selection. + enum: + - FULLY_WARMED + - VISIBLE_EARLIER + externalDocs: + description: Reduce Secondary Disk Warming Impact + url: https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact + encryptionAtRestProvider: + type: string + description: Cloud service provider that manages your customer keys to provide + an additional layer of Encryption at Rest for the cluster. + enum: + - NONE + - AWS + - AZURE + - GCP + externalDocs: + description: Encryption at Rest using Customer Key Management + url: https://www.mongodb.com/docs/atlas/security-kms-encryption/ + featureCompatibilityVersion: + type: string + description: Feature compatibility version of the cluster. + readOnly: true + featureCompatibilityVersionExpirationDate: + type: string + format: date-time + description: Feature compatibility version expiration date. + 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: + type: string + description: Unique 24-hexadecimal character string that identifies the + project. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + id: + type: string + description: Unique 24-hexadecimal digit string that identifies the cluster. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + labels: + type: array + deprecated: true + description: |- + Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels. + + Cluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead. + items: + $ref: "#/components/schemas/ComponentLabel" + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + 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- + mongoDBVersion: + type: string + description: Version of MongoDB that the cluster runs. + pattern: "([\\d]+\\.[\\d]+\\.[\\d]+)" + 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." + externalDocs: + description: Connection string URI format. + url: https://docs.mongodb.com/manual/reference/connection-string/ + readOnly: true + mongoURIUpdated: + type: string + format: date-time + description: Date and time when someone last updated the connection string. + MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. + readOnly: true + 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." + externalDocs: + description: Connection string URI format. + url: https://docs.mongodb.com/manual/reference/connection-string/ + readOnly: true + name: + type: string + description: Human-readable label that identifies the cluster. + maxLength: 64 + minLength: 1 + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + numShards: + type: integer + format: int32 + default: 1 + description: Number of shards up to 50 to deploy for a sharded cluster. + The resource returns `1` to indicate a replica set and values of `2` and + higher to indicate a sharded cluster. The returned value equals the number + of shards in the cluster. + externalDocs: + description: Sharding + url: https://docs.mongodb.com/manual/sharding/ + maximum: 50 + minimum: 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 + default: WORKLOAD_TYPE + description: |- + Set this field to configure the replica set scaling mode for your cluster. + + By default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes. + + When configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads. + + When configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads. + enum: + - SEQUENTIAL + - WORKLOAD_TYPE + - NODE_TYPE + externalDocs: + description: Modify the Replica Set Scaling Mode + url: https://dochub.mongodb.org/core/scale-nodes + replicationFactor: + type: integer + format: int32 + default: 3 + deprecated: true + description: "Number of members that belong to the replica set. Each member\ + \ retains a copy of your databases, providing high availability and data\ + \ redundancy. Use **replicationSpecs** instead." + enum: + - 3 + - 5 + - 7 + replicationSpec: + type: object + additionalProperties: + $ref: "#/components/schemas/RegionSpec" + description: Physical location where MongoDB Cloud provisions cluster nodes. + title: Region Configuration + 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. + items: + $ref: "#/components/schemas/LegacyReplicationSpec" + rootCertType: + type: string + default: ISRGROOTX1 + description: Root Certificate Authority that MongoDB Atlas clusters uses. + MongoDB Cloud supports Internet Security Research Group. + 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. + externalDocs: + description: Connection string URI format. + url: https://docs.mongodb.com/manual/reference/connection-string/ + readOnly: true + stateName: + type: string + description: Human-readable label that indicates the current operating condition + of the cluster. + enum: + - IDLE + - CREATING + - UPDATING + - DELETING + - REPAIRING + readOnly: true + tags: + type: array + description: List that contains key-value pairs between 1 to 255 characters + in length for tagging and categorizing the cluster. + externalDocs: + description: Resource Tags + url: https://dochub.mongodb.org/core/add-cluster-tag-atlas + items: + $ref: "#/components/schemas/ResourceTag" + terminationProtectionEnabled: + type: boolean + default: false + description: "Flag that indicates whether termination protection is enabled\ + \ on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster.\ + \ If set to `false`, MongoDB Cloud will delete the cluster." + versionReleaseSystem: + type: string + default: LTS + description: "Method by which the cluster maintains the MongoDB versions.\ + \ If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**." + enum: + - LTS + - CONTINUOUS + title: Cluster Description + LegacyAtlasTenantClusterUpgradeRequest: + type: object + description: Request containing target state of tenant cluster to be upgraded + properties: + acceptDataRisksAndForceReplicaSetReconfig: + type: string + format: date-time + description: "If reconfiguration is necessary to regain a primary due to\ + \ a regional outage, submit this field alongside your topology reconfiguration\ + \ to request a new regional outage resistant topology. Forced reconfigurations\ + \ during an outage of the majority of electable nodes carry a risk of\ + \ data loss if replicated writes (even majority committed writes) have\ + \ not been replicated to the new primary node. MongoDB Atlas docs contain\ + \ more information. To proceed with an operation which carries that risk,\ + \ set **acceptDataRisksAndForceReplicaSetReconfig** to the current date." + externalDocs: + description: Reconfiguring a Replica Set during a regional outage + url: https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set + 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 + default: ATLAS_MANAGED + description: |- + Config Server Management Mode for creating or updating a sharded cluster. + + When configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings. + + When configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server. + enum: + - ATLAS_MANAGED + - FIXED_TO_DEDICATED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + configServerType: + type: string + description: Describes a sharded cluster's config server type. + enum: + - DEDICATED + - EMBEDDED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + readOnly: true connectionStrings: $ref: "#/components/schemas/ClusterConnectionStrings" createDate: @@ -39414,6 +42583,15 @@ components: externalDocs: description: Encryption at Rest using Customer Key Management url: https://www.mongodb.com/docs/atlas/security-kms-encryption/ + featureCompatibilityVersion: + type: string + description: Feature compatibility version of the cluster. + readOnly: true + featureCompatibilityVersionExpirationDate: + type: string + format: date-time + description: Feature compatibility version expiration date. + readOnly: true globalClusterSelfManagedSharding: type: boolean description: |- @@ -39464,6 +42642,8 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true + mongoDBEmployeeAccessGrant: + $ref: "#/components/schemas/EmployeeAccessGrantView" mongoDBMajorVersion: type: string description: |- @@ -39510,7 +42690,7 @@ components: description: Human-readable label that identifies the cluster. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" numShards: type: integer format: int32 @@ -39542,292 +42722,24 @@ components: \ use MongoDB Cloud backups." providerSettings: $ref: "#/components/schemas/ClusterProviderSettings" - replicationFactor: - type: integer - format: int32 - default: 3 - deprecated: true - description: "Number of members that belong to the replica set. Each member\ - \ retains a copy of your databases, providing high availability and data\ - \ redundancy. Use **replicationSpecs** instead." - enum: - - 3 - - 5 - - 7 - replicationSpec: - type: object - additionalProperties: - $ref: "#/components/schemas/RegionSpec" - description: Physical location where MongoDB Cloud provisions cluster nodes. - title: Region Configuration - 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. - items: - $ref: "#/components/schemas/LegacyReplicationSpec" - rootCertType: - type: string - default: ISRGROOTX1 - description: Root Certificate Authority that MongoDB Atlas clusters uses. - MongoDB Cloud supports Internet Security Research Group. - 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. - externalDocs: - description: Connection string URI format. - url: https://docs.mongodb.com/manual/reference/connection-string/ - readOnly: true - stateName: - type: string - description: Human-readable label that indicates the current operating condition - of the cluster. - enum: - - IDLE - - CREATING - - UPDATING - - DELETING - - REPAIRING - readOnly: true - tags: - type: array - description: List that contains key-value pairs between 1 to 255 characters - in length for tagging and categorizing the cluster. - externalDocs: - description: Resource Tags - url: https://dochub.mongodb.org/core/add-cluster-tag-atlas - items: - $ref: "#/components/schemas/ResourceTag" - terminationProtectionEnabled: - type: boolean - default: false - description: "Flag that indicates whether termination protection is enabled\ - \ on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster.\ - \ If set to `false`, MongoDB Cloud will delete the cluster." - versionReleaseSystem: - type: string - default: LTS - description: "Method by which the cluster maintains the MongoDB versions.\ - \ If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**." - enum: - - LTS - - CONTINUOUS - title: Cluster Description - LegacyAtlasTenantClusterUpgradeRequest: - type: object - description: Request containing target state of tenant cluster to be upgraded - properties: - acceptDataRisksAndForceReplicaSetReconfig: - type: string - format: date-time - description: "If reconfiguration is necessary to regain a primary due to\ - \ a regional outage, submit this field alongside your topology reconfiguration\ - \ to request a new regional outage resistant topology. Forced reconfigurations\ - \ during an outage of the majority of electable nodes carry a risk of\ - \ data loss if replicated writes (even majority committed writes) have\ - \ not been replicated to the new primary node. MongoDB Atlas docs contain\ - \ more information. To proceed with an operation which carries that risk,\ - \ set **acceptDataRisksAndForceReplicaSetReconfig** to the current date." - externalDocs: - description: Reconfiguring a Replica Set during a regional outage - url: https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set - 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 - connectionStrings: - $ref: "#/components/schemas/ClusterConnectionStrings" - createDate: - type: string - format: date-time - description: Date and time when MongoDB Cloud created this serverless instance. - MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. - readOnly: true - diskSizeGB: - type: number - format: double - 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." - maximum: 4096 - minimum: 10 - diskWarmingMode: - type: string - default: FULLY_WARMED - description: Disk warming mode selection. - enum: - - FULLY_WARMED - - VISIBLE_EARLIER - externalDocs: - description: Reduce Secondary Disk Warming Impact - url: https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact - encryptionAtRestProvider: - type: string - description: Cloud service provider that manages your customer keys to provide - an additional layer of Encryption at Rest for the cluster. - enum: - - NONE - - AWS - - AZURE - - GCP - externalDocs: - description: Encryption at Rest using Customer Key Management - url: https://www.mongodb.com/docs/atlas/security-kms-encryption/ - 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: - type: string - description: Unique 24-hexadecimal character string that identifies the - project. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - id: + replicaSetScalingStrategy: type: string - description: Unique 24-hexadecimal digit string that identifies the cluster. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - labels: - type: array - deprecated: true + default: WORKLOAD_TYPE 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. + Set this field to configure the replica set scaling mode for your cluster. - Cluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead. - items: - $ref: "#/components/schemas/ComponentLabel" - links: - type: array - description: "List of one or more Uniform Resource Locators (URLs) that\ - \ point to API sub-resources, related API resources, or both. RFC 5988\ - \ outlines these relationships." - externalDocs: - description: Web Linking Specification (RFC 5988) - url: https://datatracker.ietf.org/doc/html/rfc5988 - items: - $ref: "#/components/schemas/Link" - readOnly: true - mongoDBMajorVersion: - type: string - description: |- - MongoDB major version of the cluster. + By default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes. - 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). + When configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads. - 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- - mongoDBVersion: - type: string - description: Version of MongoDB that the cluster runs. - pattern: "([\\d]+\\.[\\d]+\\.[\\d]+)" - 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." - externalDocs: - description: Connection string URI format. - url: https://docs.mongodb.com/manual/reference/connection-string/ - readOnly: true - mongoURIUpdated: - type: string - format: date-time - description: Date and time when someone last updated the connection string. - MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. - readOnly: true - 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." - externalDocs: - description: Connection string URI format. - url: https://docs.mongodb.com/manual/reference/connection-string/ - readOnly: true - name: - type: string - description: Human-readable label that identifies the cluster. - maxLength: 64 - minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - numShards: - type: integer - format: int32 - default: 1 - description: Number of shards up to 50 to deploy for a sharded cluster. - The resource returns `1` to indicate a replica set and values of `2` and - higher to indicate a sharded cluster. The returned value equals the number - of shards in the cluster. - externalDocs: - description: Sharding - url: https://docs.mongodb.com/manual/sharding/ - maximum: 50 - minimum: 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. + When configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads. + enum: + - SEQUENTIAL + - WORKLOAD_TYPE + - NODE_TYPE externalDocs: - description: 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" + description: Modify the Replica Set Scaling Mode + url: https://dochub.mongodb.org/core/scale-nodes replicationFactor: type: integer format: int32 @@ -40390,6 +43302,10 @@ components: - INSTANCE_NAME - PROCESSOR_NAME title: Streams Matcher Fields + - type: string + enum: + - RULE_ID + title: Log Ingestion Matcher Fields MatcherHostType: type: string description: Value to match or exceed using the specified **matchers.operator**. @@ -41104,6 +44020,7 @@ components: - 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 @@ -41181,6 +44098,8 @@ components: - 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 @@ -41210,6 +44129,9 @@ components: - 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 @@ -41268,9 +44190,13 @@ components: - 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 example: CLUSTER_CREATED title: NDS Audit Types NDSAuditTypeViewForOrg: @@ -42246,7 +45172,7 @@ components: example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -42505,7 +45431,12 @@ components: enum: - AVERAGE operator: - $ref: "#/components/schemas/Operator" + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - LESS_THAN + - GREATER_THAN threshold: type: number format: double @@ -42695,6 +45626,57 @@ components: required: - typeName title: OpsGenie Notification + OrgActiveUserResponse: + type: object + allOf: + - $ref: "#/components/schemas/OrgUserResponse" + - type: object + properties: + country: + type: string + description: Two alphabet characters that identifies MongoDB Cloud user's + geographic location. This parameter uses the ISO 3166-1a2 code format. + example: US + pattern: "^([A-Z]{2})$" + readOnly: true + createdAt: + type: string + format: date-time + description: Date and time when MongoDB Cloud created the current account. + This value is in the ISO 8601 timestamp format in UTC. + readOnly: true + firstName: + type: string + description: First or given name that belongs to the MongoDB Cloud user. + example: John + readOnly: true + lastAuth: + type: string + format: date-time + description: Date and time when the current account last authenticated. + This value is in the ISO 8601 timestamp format in UTC. + readOnly: true + lastName: + type: string + description: "Last name, family name, or surname that belongs to the MongoDB\ + \ Cloud user." + example: Doe + readOnly: true + mobileNumber: + type: string + description: Mobile phone number that belongs to the MongoDB Cloud user. + pattern: "(?:(?:\\\\+?1\\\\s*(?:[.-]\\\\s*)?)?(?:(\\\\s*([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9])\\\ + \\s*)|([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9]))\\\\s*(?:[.-]\\\\\ + s*)?)([2-9]1[02-9]|[2-9][02-9]1|[2-9][02-9]{2})\\\\s*(?:[.-]\\\\s*)?([0-9]{4})$" + readOnly: true + required: + - createdAt + - firstName + - id + - lastName + - orgMembershipStatus + - roles + - username OrgEventTypeViewForOrg: type: string description: Unique identifier of event type. @@ -43045,7 +46027,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/EventViewForOrg" @@ -43057,29 +46039,61 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true + OrgPendingUserResponse: + type: object + allOf: + - $ref: "#/components/schemas/OrgUserResponse" + - type: object + properties: + invitationCreatedAt: + type: string + format: date-time + description: Date and time when MongoDB Cloud sent the invitation. MongoDB + Cloud represents this timestamp in ISO 8601 format in UTC. + readOnly: true + invitationExpiresAt: + type: string + format: date-time + description: Date and time when the invitation from MongoDB Cloud expires. + MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. + readOnly: true + inviterUsername: + type: string + format: email + description: Username of the MongoDB Cloud user who sent the invitation + to join the organization. + readOnly: true + required: + - id + - invitationCreatedAt + - invitationExpiresAt + - inviterUsername + - orgMembershipStatus + - roles + - username OrgServiceAccount: type: object properties: + clientId: + type: string + description: The Client ID of the Service Account. + pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" createdAt: type: string format: date-time - description: Service account creation time. + description: The date that the Service Account was created on. description: type: string - description: Description of the service account. - id: - type: string - description: ID for the service account. - pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" + description: Human readable description for the Service Account. name: type: string - description: Name for service account. + description: Human-readable name for the Service Account. roles: type: array - description: Organization roles assigned to the Service Account. + description: A list of Organization roles associated with the Service Account. items: type: string - description: Organization roles associated with the service account. + description: Organization roles available for Service Accounts. enum: - ORG_MEMBER - ORG_READ_ONLY @@ -43090,7 +46104,7 @@ components: uniqueItems: true secrets: type: array - description: List of secrets. + description: A list of secrets associated with the specified Service Account. items: $ref: "#/components/schemas/ServiceAccountSecret" uniqueItems: true @@ -43099,23 +46113,23 @@ components: properties: description: type: string - description: Human readable description for the service account. + description: Human readable description for the Service Account. maxLength: 250 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" name: type: string - description: Human-readable name for the service account. The name is modifiable + description: Human-readable name for the Service Account. The name is modifiable and does not have to be unique. maxLength: 64 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" roles: type: array - description: Organization roles associated with the service account. + description: A list of organization-level roles for the Service Account. items: type: string - description: Organization roles associated with the service account. + description: Organization roles available for Service Accounts. enum: - ORG_MEMBER - ORG_READ_ONLY @@ -43126,33 +46140,35 @@ components: secretExpiresAfterHours: type: integer format: int32 - description: Secret expiration time. + description: The expiration time of the new Service Account secret. The + expiration is provided in hours. required: - description - name + - roles - secretExpiresAfterHours OrgServiceAccountUpdateRequest: type: object properties: description: type: string - description: Human readable description for the service account. + description: Human readable description for the Service Account. maxLength: 250 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" name: type: string - description: Human-readable name for the service account. The name is modifiable + description: Human-readable name for the Service Account. The name is modifiable and does not have to be unique. maxLength: 64 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" roles: type: array - description: Organization roles associated with the Service account. + description: A list of organization-level roles for the Service Account. items: type: string - description: Organization roles associated with the service account. + description: Organization roles available for Service Accounts. enum: - ORG_MEMBER - ORG_READ_ONLY @@ -43160,6 +46176,158 @@ components: - ORG_BILLING_READ_ONLY - ORG_GROUP_CREATOR - ORG_OWNER + OrgUserRequest: + type: object + properties: + roles: + $ref: "#/components/schemas/OrgUserRolesRequest" + teamIds: + type: array + description: List of unique 24-hexadecimal digit strings that identifies + the teams to which this MongoDB Cloud user belongs. + items: + type: string + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + uniqueItems: true + writeOnly: true + username: + type: string + format: email + description: Email address that represents the username of the MongoDB Cloud + user. + writeOnly: true + required: + - roles + - username + OrgUserResponse: + type: object + discriminator: + mapping: + ACTIVE: "#/components/schemas/OrgActiveUserResponse" + PENDING: "#/components/schemas/OrgPendingUserResponse" + propertyName: orgMembershipStatus + oneOf: + - $ref: "#/components/schemas/OrgPendingUserResponse" + - $ref: "#/components/schemas/OrgActiveUserResponse" + properties: + id: + type: string + description: Unique 24-hexadecimal digit string that identifies the MongoDB + Cloud user. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + orgMembershipStatus: + type: string + description: String enum that indicates whether the MongoDB Cloud user has + a pending invitation to join the organization or they are already active + in the organization. + enum: + - PENDING + - ACTIVE + readOnly: true + roles: + $ref: "#/components/schemas/OrgUserRolesResponse" + teamIds: + type: array + description: List of unique 24-hexadecimal digit strings that identifies + the teams to which this MongoDB Cloud user belongs. + items: + type: string + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + uniqueItems: true + username: + type: string + format: email + description: Email address that represents the username of the MongoDB Cloud + user. + readOnly: true + required: + - id + - orgMembershipStatus + - roles + - username + OrgUserRolesRequest: + type: object + description: Organization and project level roles to assign the MongoDB Cloud + user within one organization. + properties: + groupRoleAssignments: + type: array + description: List of project level role assignments to assign the MongoDB + Cloud user. + items: + $ref: "#/components/schemas/GroupRoleAssignment" + orgRoles: + type: array + description: One or more organization level roles to assign the MongoDB + Cloud user. + items: + type: string + enum: + - ORG_OWNER + - ORG_GROUP_CREATOR + - ORG_BILLING_ADMIN + - ORG_BILLING_READ_ONLY + - ORG_READ_ONLY + - ORG_MEMBER + minItems: 1 + uniqueItems: true + required: + - orgRoles + writeOnly: true + OrgUserRolesResponse: + type: object + description: Organization and project level roles assigned to one MongoDB Cloud + user within one organization. + properties: + groupRoleAssignments: + type: array + description: List of project level role assignments assigned to the MongoDB + Cloud user. + items: + $ref: "#/components/schemas/GroupRoleAssignment" + orgRoles: + type: array + description: One or more organization level roles assigned to the MongoDB + Cloud user. + items: + type: string + enum: + - ORG_OWNER + - ORG_GROUP_CREATOR + - ORG_BILLING_ADMIN + - ORG_BILLING_READ_ONLY + - ORG_READ_ONLY + - ORG_MEMBER + uniqueItems: true + readOnly: true + OrgUserUpdateRequest: + type: object + properties: + roles: + $ref: "#/components/schemas/OrgUserRolesRequest" + teamIds: + type: array + description: List of unique 24-hexadecimal digit strings that identifies + the teams to assign the MongoDB Cloud user. + items: + type: string + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + uniqueItems: true + writeOnly: true OrganizationInvitation: type: object properties: @@ -43371,10 +46539,11 @@ components: restrictEmployeeAccess: type: boolean description: "Flag that indicates whether to block MongoDB Support from\ - \ accessing Atlas infrastructure 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/." + \ 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/." OutboundControlPlaneCloudProviderIPAddresses: type: object description: "List of outbound IP addresses from the Atlas control plane, categorized\ @@ -43547,7 +46716,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/AdvancedClusterDescription" @@ -43575,7 +46744,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/GroupAlertsConfig" @@ -43603,7 +46772,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/AlertViewForNdsGroup" @@ -43631,7 +46800,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ApiKeyUserDetails" @@ -43659,7 +46828,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/CloudAppUser" @@ -43687,7 +46856,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ApiAtlasCheckpointView" @@ -43717,7 +46886,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/CloudDatabaseUser" @@ -43745,7 +46914,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/DiskBackupExportJob" @@ -43773,7 +46942,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/EARPrivateEndpoint" @@ -43785,7 +46954,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedApiAtlasProviderRegionsView: + PaginatedApiAtlasFlexBackupRestoreJob20250101View: type: object properties: links: @@ -43801,10 +46970,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/CloudProviderRegions" + $ref: "#/components/schemas/FlexBackupRestoreJob20250101" readOnly: true totalCount: type: integer @@ -43813,7 +46982,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedApiAtlasServerlessBackupRestoreJobView: + PaginatedApiAtlasFlexBackupSnapshot20240710View: type: object properties: links: @@ -43829,10 +46998,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/ServerlessBackupRestoreJob" + $ref: "#/components/schemas/FlexBackupSnapshot20250101" readOnly: true totalCount: type: integer @@ -43841,7 +47010,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedApiAtlasServerlessBackupSnapshotView: + PaginatedApiAtlasProviderRegionsView: type: object properties: links: @@ -43857,10 +47026,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/ServerlessBackupSnapshot" + $ref: "#/components/schemas/CloudProviderRegions" readOnly: true totalCount: type: integer @@ -43869,7 +47038,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedApiAtlasUSSBackupRestoreJob20250101View: + PaginatedApiAtlasServerlessBackupRestoreJobView: type: object properties: links: @@ -43885,10 +47054,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/USSBackupRestoreJob20250101" + $ref: "#/components/schemas/ServerlessBackupRestoreJob" readOnly: true totalCount: type: integer @@ -43897,7 +47066,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedApiAtlasUSSBackupSnapshot20240710View: + PaginatedApiAtlasServerlessBackupSnapshotView: type: object properties: links: @@ -43913,10 +47082,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/USSBackupSnapshot20250101" + $ref: "#/components/schemas/ServerlessBackupSnapshot" readOnly: true totalCount: type: integer @@ -43941,7 +47110,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/BillingInvoiceMetadata" @@ -43969,7 +47138,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/BillingInvoice" @@ -43997,7 +47166,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/StreamsConnection" @@ -44009,6 +47178,34 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true + PaginatedApiStreamsPrivateLinkView: + type: object + properties: + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + results: + type: array + description: List of returned documents that MongoDB Cloud provides when + completing this request. + items: + $ref: "#/components/schemas/StreamsPrivateLinkConnection" + readOnly: true + totalCount: + type: integer + format: int32 + description: Total number of documents available. MongoDB Cloud omits this + value if `includeCount` is set to `false`. + minimum: 0 + readOnly: true PaginatedApiStreamsStreamProcessorWithStatsView: type: object properties: @@ -44025,7 +47222,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/StreamsProcessorWithStats" @@ -44053,7 +47250,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/StreamsTenant" @@ -44081,7 +47278,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/UserAccessListResponse" @@ -44093,6 +47290,34 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true + PaginatedApiVersions: + type: object + properties: + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + results: + type: array + description: List of returned documents that MongoDB Cloud provides when + completing this request. + items: + $ref: "#/components/schemas/ApiVersion" + readOnly: true + totalCount: + type: integer + format: int32 + description: Total number of documents available. MongoDB Cloud omits this + value if `includeCount` is set to `false`. + minimum: 0 + readOnly: true PaginatedAppUserView: type: object properties: @@ -44109,7 +47334,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/CloudAppUser" @@ -44137,7 +47362,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/Group" @@ -44165,7 +47390,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/MdbAvailableVersion" @@ -44193,7 +47418,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/DiskBackupSnapshotAWSExportBucket" @@ -44221,7 +47446,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/DiskBackupSnapshotExportBucket" @@ -44249,7 +47474,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/DiskBackupSnapshot" @@ -44277,7 +47502,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/DiskBackupReplicaSet" @@ -44305,7 +47530,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/DiskBackupSnapshotRestoreJob" @@ -44333,7 +47558,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/DiskBackupShardedClusterSnapshot" @@ -44362,7 +47587,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/CloudProviderContainer" @@ -44391,7 +47616,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ClusterDescription20240805" @@ -44419,7 +47644,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ConnectedOrgConfig" @@ -44448,7 +47673,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/BaseNetworkPeeringConnectionSettings" @@ -44476,7 +47701,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/MesurementsDatabase" @@ -44504,7 +47729,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/MeasurementDiskPartition" @@ -44532,7 +47757,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/EventTypeDetails" @@ -44560,7 +47785,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/FederationIdentityProvider" @@ -44572,9 +47797,37 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true + PaginatedFlexClusters20250101: + type: object + properties: + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + results: + type: array + description: List of returned documents that MongoDB Cloud provides when + completing this request. + items: + type: object + readOnly: true + totalCount: + type: integer + format: int32 + description: Total number of documents available. MongoDB Cloud omits this + value if `includeCount` is set to `false`. + minimum: 0 + readOnly: true PaginatedGroupServiceAccounts: type: object - description: List of Service Accounts + description: A list of Project Service Accounts. properties: links: type: array @@ -44589,7 +47842,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/GroupServiceAccount" @@ -44617,7 +47870,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ApiHostView_Atlas" @@ -44645,7 +47898,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ThirdPartyIntegration" @@ -44673,7 +47926,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/LegacyAtlasCluster" @@ -44701,7 +47954,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/NetworkPermissionEntry" @@ -44729,7 +47982,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/BackupOnlineArchive" @@ -44757,7 +48010,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/OrgGroup" @@ -44771,7 +48024,7 @@ components: readOnly: true PaginatedOrgServiceAccounts: type: object - description: List of Service Accounts + description: A list of Organization Service Accounts. properties: links: type: array @@ -44786,7 +48039,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/OrgServiceAccount" @@ -44814,7 +48067,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/AtlasOrganization" @@ -44842,7 +48095,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/IngestionPipelineRun" @@ -44870,7 +48123,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/PrivateNetworkEndpointIdEntry" @@ -44898,7 +48151,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/PublicApiUsageDetailsLineItemView" @@ -44926,7 +48179,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/BackupRestoreJob" @@ -44956,7 +48209,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/AuthFederationRoleMapping" @@ -44984,7 +48237,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ServerlessInstanceDescription" @@ -44998,7 +48251,7 @@ components: readOnly: true PaginatedServiceAccountGroup: type: object - description: List of Service Account projects. + description: A list of projects associated with the Service Account. properties: links: type: array @@ -45013,7 +48266,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ServiceAccountGroup" @@ -45025,7 +48278,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedSnapshotView: + PaginatedServiceAccountIPAccessEntryView: type: object properties: links: @@ -45041,10 +48294,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/BackupSnapshot" + $ref: "#/components/schemas/ServiceAccountIPAccessListEntry" readOnly: true totalCount: type: integer @@ -45053,7 +48306,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedTeamRoleView: + PaginatedSnapshotView: type: object properties: links: @@ -45069,10 +48322,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/TeamRole" + $ref: "#/components/schemas/BackupSnapshot" readOnly: true totalCount: type: integer @@ -45081,7 +48334,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedTeamView: + PaginatedTeamRoleView: type: object properties: links: @@ -45097,10 +48350,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/TeamResponse" + $ref: "#/components/schemas/TeamRole" readOnly: true totalCount: type: integer @@ -45109,7 +48362,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedTenantRestoreView: + PaginatedTeamView: type: object properties: links: @@ -45125,10 +48378,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/TenantRestore" + $ref: "#/components/schemas/TeamResponse" readOnly: true totalCount: type: integer @@ -45137,7 +48390,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedTenantSnapshotView: + PaginatedTenantRestoreView: type: object properties: links: @@ -45153,10 +48406,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/BackupTenantSnapshot" + $ref: "#/components/schemas/TenantRestore" readOnly: true totalCount: type: integer @@ -45165,7 +48418,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedUSSInstance20250101: + PaginatedTenantSnapshotView: type: object properties: links: @@ -45181,10 +48434,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - type: object + $ref: "#/components/schemas/BackupTenantSnapshot" readOnly: true totalCount: type: integer @@ -45209,7 +48462,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/UserCert" @@ -45697,6 +48950,13 @@ components: PrivateNetworkEndpointIdEntry: type: object properties: + azureConnectionName: + type: string + description: Connection name that identifies the Azure private endpoint + connection. + 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. @@ -45704,6 +48964,10 @@ components: type: string description: Human-readable label to identify customer's VPC endpoint DNS name. + customerEndpointIPAddress: + type: string + description: IP address used to connect to the Azure private endpoint. + pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" endpointId: type: string description: Unique 22-character alphanumeric string that identifies the @@ -45716,6 +48980,10 @@ components: maxLength: 22 minLength: 22 pattern: "^vpce-[0-9a-f]{17}$" + errorMessage: + type: string + description: Error message describing a failure approving the private endpoint + request. provider: type: string default: AWS @@ -45727,6 +48995,14 @@ components: type: string description: Human-readable label to identify the region of customer's VPC endpoint. + status: + type: string + description: Status of the private endpoint connection request. + enum: + - PENDING + - OK + - FAILED + - DELETING type: type: string default: DATA_LAKE @@ -45796,16 +49072,6 @@ components: - serviceDiscovery - username title: PROMETHEUS - ProxyInfo: - type: object - description: VPC Proxy Information. - properties: - authKey: - type: string - description: Authentication key for the proxy. - dnsName: - type: string - description: DNS name to use to reach the proxy/s. PublicApiUsageDetailsLineItemView: type: object properties: @@ -45897,7 +49163,12 @@ components: enum: - AVERAGE operator: - $ref: "#/components/schemas/Operator" + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - LESS_THAN + - GREATER_THAN threshold: type: number format: double @@ -45948,7 +49219,7 @@ components: example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -46207,7 +49478,12 @@ components: enum: - AVERAGE operator: - $ref: "#/components/schemas/Operator" + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - LESS_THAN + - GREATER_THAN threshold: type: number format: double @@ -46397,7 +49673,7 @@ components: example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -47198,7 +50474,7 @@ components: you loaded the sample dataset. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true completeDate: type: string @@ -48012,7 +51288,7 @@ components: \ this parameter when `\"deliveryType\" : \"download\"`." items: type: string - description: One Uniform Resource Locator that point to the compressed + description: One Uniform Resource Locator that points to the compressed snapshot files for manual download. readOnly: true desiredTimestamp: @@ -48099,7 +51375,7 @@ components: parameter when `"deliveryType":` `"automated"`. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" targetGroupId: type: string description: Unique 24-hexadecimal digit string that identifies the target @@ -48174,7 +51450,7 @@ components: which MongoDB Cloud took this snapshot. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true snapshotType: type: string @@ -48306,7 +51582,7 @@ components: description: Human-readable label that identifies the serverless instance. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" providerSettings: $ref: "#/components/schemas/ServerlessProviderSettings" serverlessBackupOptions: @@ -48375,7 +51651,7 @@ components: description: Human-readable label that identifies the serverless instance. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" writeOnly: true providerSettings: $ref: "#/components/schemas/ServerlessProviderSettings" @@ -48539,7 +51815,12 @@ components: enum: - AVERAGE operator: - $ref: "#/components/schemas/Operator" + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - LESS_THAN + - GREATER_THAN threshold: type: number format: double @@ -48749,7 +52030,11 @@ components: properties: groupId: type: string - description: Unique 24-hexadecimal digit string that identifies the project. + description: "Unique 24-hexadecimal digit string that identifies your project.\ + \ **NOTE**: Groups and projects are synonymous terms. Your group id is\ + \ the same as your project id. For existing groups, your group/project\ + \ id remains the same. The resource and corresponding endpoints use the\ + \ term groups." example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 @@ -48862,6 +52147,54 @@ components: - eventTypeName - id title: ServiceAccount Events + ServiceAccountIPAccessListEntry: + type: object + properties: + cidrBlock: + type: string + description: "Range of network addresses in the access list for the Service\ + \ Account. This parameter requires the range to be expressed in Classless\ + \ Inter-Domain Routing (CIDR) notation of Internet Protocol version 4\ + \ or version 6 addresses. You can set a value for this parameter or **ipAddress**,\ + \ but not for both in the same request." + example: 203.0.113.0/24 + pattern: "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + createdAt: + type: string + format: date-time + description: Date MongoDB Cloud added the entry was added to the Access + List. + readOnly: true + ipAddress: + type: string + description: "Network address in the access list for the Service Account.\ + \ This parameter requires the address to be expressed as one Internet\ + \ Protocol version 4 or version 6 address. You can set a value for this\ + \ parameter or **cidrBlock**, but not for both in the same request." + example: 203.0.113.10 + pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + 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 makes at least one request. + readOnly: true + lastUsedAt: + type: string + format: date-time + description: "Date when MongoDB Cloud received the most recent request that\ + \ originated from this Internet Protocol version 4 or version 6 address.\ + \ The resource returns this parameter when at least one request originates\ + \ from this IP address. MongoDB Cloud updates this parameter each time\ + \ a client accesses the permitted resource, with a delay of up to 5 minutes." + readOnly: true + requestCount: + type: integer + format: int32 + description: The number of requests that has originated from this network + address. + readOnly: true ServiceAccountOrgEvents: type: object description: Service Account event identifies different activities around user @@ -48975,35 +52308,34 @@ components: createdAt: type: string format: date-time - description: Timestamp representing creation time. + description: The date that the secret was created on. readOnly: true expiresAt: type: string format: date-time - description: Timestamp representing secret expiration time. + description: The date for the expiration of the secret. readOnly: true id: type: string - description: Unique 24-hexadecimal character string that identifies the - secret. + description: Unique 24-hexadecimal digit string that identifies the secret. example: 32b6e34b3d91647abb20e7b8 pattern: "^([a-f0-9]{24})$" readOnly: true lastUsedAt: type: string format: date-time - description: Timestamp representing last secret usage. + description: The last time the secret was used. readOnly: true maskedSecretValue: type: string - description: Service Account secret with masked values of the first 20 characters. + description: The masked Service Account secret. example: mdb_ic_sk_...12ce readOnly: true secret: type: string - description: Secret for the service account. It will be returned only the - first time after service account creation. - pattern: "^mdb_sa_sk_[0-9a-zA-Z]{40}$" + description: The secret for the Service Account. It will be returned only + the first time after creation. + pattern: "^mdb_sa_sk_[0-9a-zA-Z_-]{40}$" readOnly: true required: - createdAt @@ -49015,7 +52347,8 @@ components: secretExpiresAfterHours: type: integer format: int32 - description: Number of hours representing validity duration for secret. + description: The expiration time of the new Service Account secret. The + expiration is provided in hours. required: - secretExpiresAfterHours ShardEntry: @@ -49638,17 +52971,19 @@ components: StreamsDLQ: type: object description: Dead letter queue for the stream processor. + externalDocs: + url: https://www.mongodb.com/docs/atlas/reference/glossary/#std-term-dead-letter-queue properties: coll: type: string - description: Name of the collection that will be used for the DLQ. + description: Name of the collection to use for the DLQ. connectionName: type: string - description: Connection name that will be used to write DLQ messages to. - Has to be an Atlas connection. + description: Name of the connection to write DLQ messages to. Must be an + Atlas connection. db: type: string - description: Name of the database that will be used for the DLQ. + description: Name of the database to use for the DLQ. links: type: array description: "List of one or more Uniform Resource Locators (URLs) that\ @@ -49817,8 +53152,6 @@ components: group.protocol.type: consumer networking: $ref: "#/components/schemas/StreamsKafkaNetworking" - proxyInfo: - $ref: "#/components/schemas/ProxyInfo" security: $ref: "#/components/schemas/StreamsKafkaSecurity" StreamsKafkaNetworking: @@ -49844,6 +53177,13 @@ components: type: object description: Information about the networking access. properties: + connectionId: + type: string + description: Reserved. Will be used by PRIVATE_LINK connection type. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" links: type: array description: "List of one or more Uniform Resource Locators (URLs) that\ @@ -49857,14 +53197,18 @@ components: readOnly: true name: type: string - description: Id of the vpc peer when the type is VPC. + description: Reserved. Will be used by PRIVATE_LINK connection type. type: type: string - description: Selected networking type. Either PUBLIC or VPC. Defaults to - PUBLIC + description: "Selected networking type. Either PUBLIC, VPC or PRIVATE_LINK.\ + \ Defaults to PUBLIC. For VPC, ensure that VPC peering exists and connectivity\ + \ has been established between Atlas VPC and the VPC where Kafka cluster\ + \ is hosted for the connection to function properly. PRIVATE_LINK support\ + \ is coming soon." enum: - PUBLIC - VPC + - PRIVATE_LINK title: Networking Access Type StreamsKafkaSecurity: type: object @@ -49943,6 +53287,52 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true + StreamsPrivateLinkConnection: + type: object + description: Container for metadata needed to create a Private Link connection. + properties: + _id: + type: string + description: The ID of the Private Link connection. + dnsDomain: + type: string + description: Domain name of Confluent cluster. + dnsSubDomain: + type: array + description: Sub-Domain name of Confluent cluster. These are typically your + availability zones. + items: + type: string + interfaceEndpointId: + type: string + description: Interface endpoint ID that is created from the service endpoint + ID provided. + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + provider: + type: string + description: Provider where the Kafka cluster is deployed. + region: + type: string + description: Domain name of Confluent cluster. + serviceEndpointId: + type: string + description: AWS Service Endpoint ID. + state: + type: string + description: State the connection is in. + vendor: + type: string + description: Vendor who manages the Kafka cluster. StreamsProcessor: type: object description: An atlas stream processor. @@ -49976,6 +53366,9 @@ components: type: array description: Stream aggregation pipeline you want to apply to your streaming data. + externalDocs: + description: Supported Aggregation Pipeline Stages + url: https://www.mongodb.com/docs/atlas/atlas-stream-processing/stream-aggregation/#std-label-stream-aggregation items: $ref: "#/components/schemas/Document" StreamsProcessorWithStats: @@ -50006,6 +53399,8 @@ components: type: string description: Human-readable name of the stream processor. readOnly: true + options: + $ref: "#/components/schemas/StreamsOptions" pipeline: type: array description: Stream aggregation pipeline you want to apply to your streaming @@ -50015,15 +53410,20 @@ components: readOnly: true state: type: string - description: The state of the stream processor. + description: "The state of the stream processor. Commonly occurring states\ + \ are 'CREATED', 'STARTED', 'STOPPED' and 'FAILED'." readOnly: true stats: type: object additionalProperties: type: object description: The stats associated with the stream processor. + externalDocs: + url: https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor readOnly: true description: The stats associated with the stream processor. + externalDocs: + url: https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor readOnly: true required: - _id @@ -50034,6 +53434,26 @@ components: type: object allOf: - $ref: "#/components/schemas/StreamsConnection" + StreamsSampleConnections: + type: object + description: Sample connections to add to SPI. + properties: + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + solar: + type: boolean + default: false + description: Flag that indicates whether to add a 'sample_stream_solar' + connection. StreamsTenant: type: object properties: @@ -50085,6 +53505,8 @@ components: name: type: string description: Human-readable label that identifies the stream instance. + sampleConnections: + $ref: "#/components/schemas/StreamsSampleConnections" streamConfig: $ref: "#/components/schemas/StreamConfig" SummaryNotification: @@ -50745,7 +54167,7 @@ components: description: Human-readable label that identifies the source cluster. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true deliveryType: type: string @@ -50855,6 +54277,8 @@ components: required: - snapshotId - targetDeploymentItemName + TenantWithSampleConnections: + type: object TextSearchHostStatusDetail: type: object properties: @@ -51071,808 +54495,199 @@ components: type: array description: List of documents detailing index status on each host. items: - $ref: "#/components/schemas/TextSearchHostStatusDetail" - synonymMappingStatus: - type: string - description: Status that describes this index's synonym mappings. This - status appears only if the index has synonyms defined. - enum: - - FAILED - - BUILDING - - READY - synonymMappingStatusDetail: - type: array - description: A list of documents describing the status of the index's - synonym mappings on each search host. Only appears if the index has - synonyms defined. - items: - type: object - additionalProperties: - $ref: "#/components/schemas/SynonymMappingStatusDetail" - title: Text Search Index Response - TextSearchIndexStatusDetail: - type: object - description: Contains status information about a text search index. - properties: - definition: - $ref: "#/components/schemas/TextSearchIndexDefinition" - definitionVersion: - $ref: "#/components/schemas/SearchIndexDefinitionVersion" - message: - type: string - description: Optional message describing an error. - queryable: - type: boolean - description: Flag that indicates whether the index generation is queryable - on the host. - status: - type: string - description: | - Condition of the search index when you made this request. - - | Status | Index Condition | - |---|---| - | DELETING | The index is being deleted. | - | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. | - | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. | - | PENDING | Atlas has not yet started building the index. | - | BUILDING | Atlas is building or re-building the index after an edit. | - | READY | The index is ready and can support queries. | - enum: - - DELETING - - FAILED - - STALE - - PENDING - - BUILDING - - READY - - DOES_NOT_EXIST - synonymMappingStatus: - type: string - description: Status that describes this index's synonym mappings. This status - appears only if the index has synonyms defined. - enum: - - FAILED - - BUILDING - - READY - synonymMappingStatusDetail: - type: array - description: List of synonym statuses by mapping. - items: - $ref: "#/components/schemas/SynonymMappingStatusDetailMap" - title: Text Search Index Status Detail - ThirdPartyIntegration: - type: object - description: Collection of settings that describe third-party integrations. - discriminator: - mapping: - DATADOG: "#/components/schemas/Datadog" - MICROSOFT_TEAMS: "#/components/schemas/MicrosoftTeams" - NEW_RELIC: "#/components/schemas/NewRelic" - OPS_GENIE: "#/components/schemas/OpsGenie" - PAGER_DUTY: "#/components/schemas/PagerDuty" - PROMETHEUS: "#/components/schemas/Prometheus" - SLACK: "#/components/schemas/Slack" - VICTOR_OPS: "#/components/schemas/VictorOps" - WEBHOOK: "#/components/schemas/Webhook" - propertyName: type - properties: - id: - type: string - description: Integration id. - nullable: true - type: - type: string - description: Integration type - enum: - - PAGER_DUTY - - SLACK - - DATADOG - - NEW_RELIC - - OPS_GENIE - - VICTOR_OPS - - WEBHOOK - - HIP_CHAT - - PROMETHEUS - - MICROSOFT_TEAMS - title: Integration Type - title: Third-Party Integration - TimeMetricAlertView: - type: object - properties: - acknowledgedUntil: - type: string - format: date-time - description: |- - Date and time until which this alert has been acknowledged. This parameter expresses its value in the 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. - acknowledgementComment: - type: string - description: Comment that a MongoDB Cloud user submitted when acknowledging - the alert. - example: Expiration on 3/19. Silencing for 7days. - maxLength: 200 - acknowledgingUsername: - type: string - format: email - description: MongoDB Cloud username of the person who acknowledged the alert. - The response returns this parameter if a MongoDB Cloud user previously - acknowledged this alert. - readOnly: true - alertConfigId: - type: string - description: Unique 24-hexadecimal digit string that identifies the alert - configuration that sets this alert. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - clusterName: - 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." - example: cluster1 - maxLength: 64 - minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - readOnly: true - created: - type: string - format: date-time - description: Date and time when MongoDB Cloud created this alert. This parameter - expresses its value in the ISO 8601 timestamp format - in UTC. - readOnly: true - currentValue: - $ref: "#/components/schemas/TimeMetricValueView" - eventTypeName: - $ref: "#/components/schemas/HostMetricEventTypeViewAlertable" - groupId: - type: string - description: Unique 24-hexadecimal digit string that identifies the project - that owns this alert. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - 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. - example: cloud-test.mongodb.com:27017 - readOnly: true - id: - type: string - description: Unique 24-hexadecimal digit string that identifies this alert. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - lastNotified: - type: string - format: date-time - description: Date and time that any notifications were last sent for this - alert. This parameter expresses its value in the ISO 8601 timestamp format - in UTC. The resource returns this parameter if MongoDB Cloud has sent - notifications for this alert. - readOnly: true - links: - type: array - description: "List of one or more Uniform Resource Locators (URLs) that\ - \ point to API sub-resources, related API resources, or both. RFC 5988\ - \ outlines these relationships." - externalDocs: - description: Web Linking Specification (RFC 5988) - url: https://datatracker.ietf.org/doc/html/rfc5988 - items: - $ref: "#/components/schemas/Link" - readOnly: true - 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. - example: ASSERT_USER - readOnly: true - orgId: - type: string - description: Unique 24-hexadecimal character string that identifies the - organization that owns the project to which this alert applies. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - 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." - example: event-replica-set - readOnly: true - resolved: - type: string - format: date-time - description: "Date and time that this alert changed to `\"status\" : \"\ - CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp\ - \ format in UTC. The resource returns this parameter once `\"status\"\ - \ : \"CLOSED\"`." - readOnly: true - status: - type: string - description: State of this alert at the time you requested its details. - enum: - - CANCELLED - - CLOSED - - OPEN - - TRACKING - example: OPEN - readOnly: true - updated: - type: string - format: date-time - description: Date and time when someone last updated this alert. This parameter - expresses its value in the ISO 8601 timestamp format - in UTC. - readOnly: true - required: - - alertConfigId - - created - - eventTypeName - - id - - status - - updated - TimeMetricEventView: - type: object - properties: - apiKeyId: - type: string - description: "Unique 24-hexadecimal digit string that identifies the [API\ - \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\ - \ triggered the event. If this resource returns this parameter, it doesn't\ - \ return the **userId** parameter." - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - created: - type: string - format: date-time - description: Date and time when this event occurred. This parameter expresses - its value in the ISO 8601 timestamp format in UTC. - readOnly: true - currentValue: - $ref: "#/components/schemas/TimeMetricValueView" - eventTypeName: - $ref: "#/components/schemas/HostMetricEventTypeView" - groupId: - type: string - description: Unique 24-hexadecimal digit string that identifies the project - in which the event occurred. The **eventId** identifies the specific event. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - id: - type: string - description: Unique 24-hexadecimal digit string that identifies the event. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - isGlobalAdmin: - type: boolean - default: false - description: Flag that indicates whether a MongoDB employee triggered the - specified event. - readOnly: true - links: - type: array - description: "List of one or more Uniform Resource Locators (URLs) that\ - \ point to API sub-resources, related API resources, or both. RFC 5988\ - \ outlines these relationships." - externalDocs: - description: Web Linking Specification (RFC 5988) - url: https://datatracker.ietf.org/doc/html/rfc5988 - items: - $ref: "#/components/schemas/Link" - readOnly: true - 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: - type: string - description: Unique 24-hexadecimal digit string that identifies the organization - to which these events apply. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - port: - type: integer - format: int32 - description: IANA port on which the MongoDB process listens for requests. - example: 27017 - readOnly: true - publicKey: - type: string - format: email - description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\ - \ that triggered the event. If this resource returns this parameter, it\ - \ doesn't return the **username** parameter." - example: test.user@mongodb.com - readOnly: true - raw: - $ref: "#/components/schemas/raw" - remoteAddress: - type: string - description: IPv4 or IPv6 address from which the user triggered this event. - example: 216.172.40.186 - pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" - readOnly: true - replicaSetName: - type: string - description: Human-readable label of the replica set associated with the - event. - example: event-replica-set - readOnly: true - shardName: - type: string - description: Human-readable label of the shard associated with the event. - example: event-sh-01 - readOnly: true - userId: - type: string - description: "Unique 24-hexadecimal digit string that identifies the console\ - \ user who triggered the event. If this resource returns this parameter,\ - \ it doesn't return the **apiKeyId** parameter." - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - username: - type: string - format: email - description: "Email address for the user who triggered this event. If this\ - \ resource returns this parameter, it doesn't return the **publicApiKey**\ - \ parameter." - example: test.user@mongodb.com - readOnly: true - required: - - created - - eventTypeName - - id - TimeMetricThresholdView: - 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: - $ref: "#/components/schemas/Operator" - threshold: - type: number - format: double - description: "Value of metric that, when exceeded, triggers an alert." - units: - $ref: "#/components/schemas/TimeMetricUnits" - required: - - metricName - TimeMetricUnits: - type: string - default: HOURS - description: "Element used to express the quantity. This can be an element of\ - \ time, storage capacity, and the like." - enum: - - NANOSECONDS - - MILLISECONDS - - MILLION_MINUTES - - SECONDS - - MINUTES - - HOURS - - DAYS - title: Time Metric Units - TimeMetricValueView: - type: object - description: Measurement of the **metricName** recorded at the time of the event. - properties: - number: - type: number - format: double - description: Amount of the **metricName** recorded at the time of the event. - This value triggered the alert. - readOnly: true - units: - $ref: "#/components/schemas/TimeMetricUnits" - readOnly: true - title: Time Metric Value - TokenFilterEnglishPossessive: - type: object - description: Filter that removes possessives (trailing 's) from words. - properties: - type: - type: string - description: Human-readable label that identifies this token filter type. - enum: - - englishPossessive - required: - - type - title: englishPossessive - TokenFilterFlattenGraph: - type: object - description: "Filter that transforms a token filter graph, such as the token\ - \ filter graph that the wordDelimiterGraph token filter produces, into a flat\ - \ form suitable for indexing." - properties: - type: - type: string - description: Human-readable label that identifies this token filter type. - enum: - - flattenGraph - required: - - type - title: flattenGraph - TokenFilterPorterStemming: + $ref: "#/components/schemas/TextSearchHostStatusDetail" + synonymMappingStatus: + type: string + description: Status that describes this index's synonym mappings. This + status appears only if the index has synonyms defined. + enum: + - FAILED + - BUILDING + - READY + synonymMappingStatusDetail: + type: array + description: A list of documents describing the status of the index's + synonym mappings on each search host. Only appears if the index has + synonyms defined. + items: + type: object + additionalProperties: + $ref: "#/components/schemas/SynonymMappingStatusDetail" + title: Text Search Index Response + TextSearchIndexStatusDetail: type: object - 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. + description: Contains status information about a text search index. properties: - type: + definition: + $ref: "#/components/schemas/TextSearchIndexDefinition" + definitionVersion: + $ref: "#/components/schemas/SearchIndexDefinitionVersion" + message: type: string - description: Human-readable label that identifies this token filter type. - enum: - - porterStemming - required: - - type - title: porterStemming - TokenFilterSpanishPluralStemming: - type: object - description: Filter that stems Spanish plural words. It expects lowercase text. - properties: - type: + description: Optional message describing an error. + queryable: + type: boolean + description: Flag that indicates whether the index generation is queryable + on the host. + status: type: string - description: Human-readable label that identifies this token filter type. + description: | + Condition of the search index when you made this request. + + | Status | Index Condition | + |---|---| + | DELETING | The index is being deleted. | + | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. | + | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. | + | PENDING | Atlas has not yet started building the index. | + | BUILDING | Atlas is building or re-building the index after an edit. | + | READY | The index is ready and can support queries. | enum: - - spanishPluralStemming - required: - - type - title: spanishPluralStemming - TokenFilterStempel: - type: object - description: Filter that uses Lucene's default Polish stemmer table to stem - words in the Polish language. It expects lowercase text. - externalDocs: - description: Default Polish stemmer table - url: https://lucene.apache.org/core/9_2_0/analysis/stempel/org/apache/lucene/analysis/pl/PolishAnalyzer.html#DEFAULT_STEMMER_FILE - properties: - type: + - DELETING + - FAILED + - STALE + - PENDING + - BUILDING + - READY + - DOES_NOT_EXIST + synonymMappingStatus: type: string - description: Human-readable label that identifies this token filter type. + description: Status that describes this index's synonym mappings. This status + appears only if the index has synonyms defined. enum: - - stempel - required: - - type - title: stempel - TokenFilterWordDelimiterGraph: + - FAILED + - BUILDING + - READY + synonymMappingStatusDetail: + type: array + description: List of synonym statuses by mapping. + items: + $ref: "#/components/schemas/SynonymMappingStatusDetailMap" + title: Text Search Index Status Detail + ThirdPartyIntegration: type: object - description: Filter that splits tokens into sub-tokens based on configured rules. + description: Collection of settings that describe third-party integrations. + discriminator: + mapping: + DATADOG: "#/components/schemas/Datadog" + MICROSOFT_TEAMS: "#/components/schemas/MicrosoftTeams" + NEW_RELIC: "#/components/schemas/NewRelic" + OPS_GENIE: "#/components/schemas/OpsGenie" + PAGER_DUTY: "#/components/schemas/PagerDuty" + PROMETHEUS: "#/components/schemas/Prometheus" + SLACK: "#/components/schemas/Slack" + VICTOR_OPS: "#/components/schemas/VictorOps" + WEBHOOK: "#/components/schemas/Webhook" + propertyName: type properties: - delimiterOptions: - type: object - description: Object that contains the rules that determine how to split - words into sub-words. - properties: - concatenateAll: - type: boolean - default: false - description: Flag that indicates whether to concatenate runs. - concatenateNumbers: - type: boolean - default: false - description: Flag that indicates whether to concatenate runs of sub-numbers. - concatenateWords: - type: boolean - default: false - description: Flag that indicates whether to concatenate runs of sub-words. - generateNumberParts: - type: boolean - default: true - description: "Flag that indicates whether to split tokens based on sub-numbers.\ - \ For example, if `true`, this option splits `100-2` into `100` and\ - \ `2`." - generateWordParts: - type: boolean - default: true - description: Flag that indicates whether to split tokens based on sub-words. - ignoreKeywords: - type: boolean - default: false - description: Flag that indicates whether to skip tokens with the `keyword` - attribute set to `true` - preserveOriginal: - type: boolean - default: true - description: Flag that indicates whether to generate tokens of the original - words. - splitOnCaseChange: - type: boolean - default: true - description: Flag that indicates whether to split tokens based on letter-case - transitions. - splitOnNumerics: - type: boolean - default: true - description: Flag that indicates whether to split tokens based on letter-number - transitions. - stemEnglishPossessive: - type: boolean - default: true - description: Flag that indicates whether to remove trailing possessives - from each sub-word. - protectedWords: - type: object - description: Object that contains options for protected words. - properties: - ignoreCase: - type: boolean - default: true - description: Flag that indicates whether to ignore letter case sensitivity - for protected words. - words: - type: array - description: List that contains the tokens to protect from delimination. - items: - type: string - required: - - words - type: + id: type: string - description: Human-readable label that identifies this token filter type. - enum: - - wordDelimiterGraph - required: - - type - title: wordDelimiterGraph - TokenFilterkStemming: - type: object - description: Filter that combines algorithmic stemming with a built-in dictionary - for the English language to stem words. - properties: + description: Integration id. + nullable: true type: type: string - description: Human-readable label that identifies this token filter type. + description: Integration type enum: - - kStemming - required: - - type - title: kStemming - TriggerIngestionPipelineRequest: - type: object - properties: - datasetRetentionPolicy: - $ref: "#/components/schemas/DatasetRetentionPolicy" - snapshotId: - type: string - description: Unique 24-hexadecimal character string that identifies the - snapshot. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - writeOnly: true - required: - - snapshotId - USSBackupRestoreJob20250101: + - PAGER_DUTY + - SLACK + - DATADOG + - NEW_RELIC + - OPS_GENIE + - VICTOR_OPS + - WEBHOOK + - HIP_CHAT + - PROMETHEUS + - MICROSOFT_TEAMS + title: Integration Type + title: Third-Party Integration + TimeMetricAlertView: type: object - description: Details for one restore job of a USS instance. properties: - deliveryType: - type: string - description: Means by which this resource returns the snapshot to the requesting - MongoDB Cloud user. - enum: - - RESTORE - - DOWNLOAD - readOnly: true - expirationDate: - type: string - format: date-time - description: Date and time when the download link no longer works. This - parameter expresses its value in the ISO 8601 timestamp format in UTC. - readOnly: true - id: - type: string - description: Unique 24-hexadecimal digit string that identifies the restore - job. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - instanceName: - type: string - description: Human-readable label that identifies the source instance. - maxLength: 64 - minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - readOnly: true - links: - type: array - description: "List of one or more Uniform Resource Locators (URLs) that\ - \ point to API sub-resources, related API resources, or both. RFC 5988\ - \ outlines these relationships." - externalDocs: - description: Web Linking Specification (RFC 5988) - url: https://datatracker.ietf.org/doc/html/rfc5988 - items: - $ref: "#/components/schemas/Link" - readOnly: true - projectId: - type: string - description: Unique 24-hexadecimal digit string that identifies the project - from which the restore job originated. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - restoreFinishedDate: + acknowledgedUntil: type: string format: date-time - 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. - readOnly: true - restoreScheduledDate: + 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. + acknowledgementComment: type: string - format: date-time - description: Date and time when MongoDB Cloud will restore this snapshot. - This parameter expresses its value in the ISO 8601 timestamp format in - UTC. - readOnly: true - snapshotFinishedDate: + description: Comment that a MongoDB Cloud user submitted when acknowledging + the alert. + example: Expiration on 3/19. Silencing for 7days. + maxLength: 200 + acknowledgingUsername: type: string - format: date-time - description: Date and time when MongoDB Cloud completed writing this snapshot. - This parameter expresses its value in the ISO 8601 timestamp format in - UTC. + format: email + description: MongoDB Cloud username of the person who acknowledged the alert. + The response returns this parameter if a MongoDB Cloud user previously + acknowledged this alert. readOnly: true - snapshotId: + alertConfigId: type: string - description: Unique 24-hexadecimal digit string that identifies the snapshot - to restore. + description: Unique 24-hexadecimal digit string that identifies the alert + configuration that sets this alert. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true - 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. - enum: - - PENDING - - QUEUED - - RUNNING - - FAILED - - COMPLETED - readOnly: true - targetDeploymentItemName: + clusterName: type: string - description: Human-readable label that identifies the instance or cluster - on the target project to which you want to restore the snapshot. You can - restore the snapshot to another USS instance or Dedicated cluster tier. + description: "Human-readable label that identifies the cluster to which\ + \ this alert applies. This resource returns this parameter for alerts\ + \ of events impacting backups, replica sets, or sharded clusters." + example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true - targetProjectId: + created: type: string - description: Unique 24-hexadecimal digit string that identifies the project - that contains the instance or cluster to which you want to restore the - snapshot. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" + format: date-time + description: Date and time when MongoDB Cloud created this alert. This parameter + expresses its value in the ISO 8601 timestamp format + in UTC. readOnly: true - title: USS Backup Restore Job - USSBackupRestoreJobCreate20250101: - type: object - description: Details to create one restore job of a USS instance. - properties: - _snapshotId: - type: string - description: Unique 24-hexadecimal digit string that identifies the snapshot - to restore. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - writeOnly: true - _targetDeploymentItemName: - type: string - description: Human-readable label that identifies the instance or cluster - on the target project to which you want to restore the snapshot. You can - restore the snapshot to another USS instance or Dedicated cluster tier. - maxLength: 64 - minLength: 1 - pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" - writeOnly: true - _targetProjectId: + currentValue: + $ref: "#/components/schemas/TimeMetricValueView" + eventTypeName: + $ref: "#/components/schemas/HostMetricEventTypeViewAlertable" + groupId: type: string description: Unique 24-hexadecimal digit string that identifies the project - that contains the instance or cluster to which you want to restore the - snapshot. + that owns this alert. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" - writeOnly: true - deliveryType: - type: string - description: Means by which this resource returns the snapshot to the requesting - MongoDB Cloud user. - enum: - - RESTORE - - DOWNLOAD readOnly: true - expirationDate: + hostnameAndPort: type: string - format: date-time - description: Date and time when the download link no longer works. This - parameter expresses its value in the ISO 8601 timestamp format in UTC. + description: Hostname and port of the host to which this alert applies. + The resource returns this parameter for alerts of events impacting hosts + or replica sets. + example: cloud-test.mongodb.com:27017 readOnly: true id: type: string - description: Unique 24-hexadecimal digit string that identifies the restore - job. + description: Unique 24-hexadecimal digit string that identifies this alert. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true - instanceName: + lastNotified: type: string - description: Human-readable label that identifies the source instance. - maxLength: 64 - minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + format: date-time + 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. readOnly: true links: type: array @@ -51885,94 +54700,114 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true - projectId: + metricName: type: string - description: Unique 24-hexadecimal digit string that identifies the project - from which the restore job originated. + 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. + example: ASSERT_USER + readOnly: true + orgId: + type: string + description: Unique 24-hexadecimal character string that identifies the + organization that owns the project to which this alert applies. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true - restoreFinishedDate: - type: string - format: date-time - 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. - readOnly: true - restoreScheduledDate: + replicaSetName: type: string - format: date-time - description: Date and time when MongoDB Cloud will restore this snapshot. - This parameter expresses its value in the ISO 8601 timestamp format in - UTC. + description: "Name of the replica set to which this alert applies. The response\ + \ returns this parameter for alerts of events impacting backups, hosts,\ + \ or replica sets." + example: event-replica-set readOnly: true - snapshotFinishedDate: + resolved: type: string format: date-time - description: Date and time when MongoDB Cloud completed writing this snapshot. - This parameter expresses its value in the ISO 8601 timestamp format in - UTC. - readOnly: true - snapshotUrl: - type: string - description: "Internet address from which you can download the compressed\ - \ snapshot files. The resource returns this parameter when `\"deliveryType\"\ - \ : \"DOWNLOAD\"`." + 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\"`." readOnly: true status: type: string - description: Phase of the restore workflow for this job at the time this - resource made this request. + description: State of this alert at the time you requested its details. enum: - - PENDING - - QUEUED - - RUNNING - - FAILED - - COMPLETED + - CANCELLED + - CLOSED + - OPEN + - TRACKING + example: OPEN + readOnly: true + updated: + type: string + format: date-time + description: Date and time when someone last updated this alert. This parameter + expresses its value in the ISO 8601 timestamp format + in UTC. readOnly: true required: - - _snapshotId - - _targetDeploymentItemName - title: Create USS Backup Restore Job - USSBackupSettings20250101: + - alertConfigId + - created + - eventTypeName + - id + - status + - updated + TimeMetricEventView: type: object - description: USS backup configuration properties: - enabled: - type: boolean - default: true - description: "Flag that indicates whether backups are performed for this\ - \ USS instance. Backup uses [TODO](TODO) for USS instances." + apiKeyId: + type: string + description: "Unique 24-hexadecimal digit string that identifies the [API\ + \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\ + \ triggered the event. If this resource returns this parameter, it doesn't\ + \ return the **userId** parameter." + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" readOnly: true - readOnly: true - title: USS backup configuration - USSBackupSnapshot20250101: - type: object - description: Details for one snapshot of a USS instance. - properties: - expiration: + created: type: string format: date-time - description: Date and time when the download link no longer works. This - parameter expresses its value in the ISO 8601 timestamp format in UTC. + description: Date and time when this event occurred. This parameter expresses + its value in the ISO 8601 timestamp format in UTC. readOnly: true - finishTime: + currentValue: + $ref: "#/components/schemas/TimeMetricValueView" + eventTypeName: + $ref: "#/components/schemas/HostMetricEventTypeView" + groupId: type: string - format: date-time - description: Date and time when MongoDB Cloud completed writing this snapshot. - This parameter expresses its value in the ISO 8601 timestamp format in - UTC. + description: Unique 24-hexadecimal digit string that identifies the project + in which the event occurred. The **eventId** identifies the specific event. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" readOnly: true id: type: string - description: Unique 24-hexadecimal digit string that identifies the snapshot. + description: Unique 24-hexadecimal digit string that identifies the event. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true + isGlobalAdmin: + type: boolean + default: false + description: Flag that indicates whether a MongoDB employee triggered the + specified event. + readOnly: true links: type: array description: "List of one or more Uniform Resource Locators (URLs) that\ @@ -51984,307 +54819,307 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true - mongoDBVersion: - type: string - description: MongoDB host version that the snapshot runs. - readOnly: true - scheduledTime: - type: string - format: date-time - description: Date and time when MongoDB Cloud will take the snapshot. This - parameter expresses its value in the ISO 8601 timestamp format in UTC. - readOnly: true - startTime: - type: string - format: date-time - description: Date and time when MongoDB Cloud began taking the snapshot. - This parameter expresses its value in the ISO 8601 timestamp format in - UTC. - readOnly: true - status: + metricName: type: string - description: Phase of the workflow for this snapshot at the time this resource - made this request. - enum: - - PENDING - - QUEUED - - RUNNING - - FAILED - - COMPLETED + description: Human-readable label of the metric associated with the **alertId**. + This field may change type of **currentValue** field. readOnly: true - title: USS Backup Snapshot - USSBackupSnapshotDownloadCreate20250101: - type: object - description: Details for one backup snapshot download of a USS instance. - properties: - _snapshotId: + orgId: type: string - description: Unique 24-hexadecimal digit string that identifies the snapshot - to download. + description: Unique 24-hexadecimal digit string that identifies the organization + to which these events apply. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" - writeOnly: true - links: - type: array - description: "List of one or more Uniform Resource Locators (URLs) that\ - \ point to API sub-resources, related API resources, or both. RFC 5988\ - \ outlines these relationships." - externalDocs: - description: Web Linking Specification (RFC 5988) - url: https://datatracker.ietf.org/doc/html/rfc5988 - items: - $ref: "#/components/schemas/Link" readOnly: true - required: - - _snapshotId - title: USS Backup Snapshot Download Create - USSConnectionStrings20250101: - type: object - description: Collection of Uniform Resource Locators that point to the MongoDB - database. - externalDocs: - description: Connection string URI format. - url: https://docs.mongodb.com/manual/reference/connection-string/ - properties: - standard: - type: string - description: Public connection string that you can use to connect to this - cluster. This connection string uses the mongodb:// protocol. - externalDocs: - description: Connection String URI Format - url: https://docs.mongodb.com/manual/reference/connection-string/ + port: + type: integer + format: int32 + description: IANA port on which the MongoDB process listens for requests. + example: 27017 readOnly: true - standardSrv: + publicKey: type: string - description: Public connection string that you can use to connect to this - USS instance. This connection string uses the `mongodb+srv://` protocol. - externalDocs: - description: Connection String URI Format - url: https://docs.mongodb.com/manual/reference/connection-string/ + format: email + description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\ + \ that triggered the event. If this resource returns this parameter, it\ + \ doesn't return the **username** parameter." + example: test.user@mongodb.com readOnly: true - readOnly: true - title: USS Instance Connection Strings - USSInstanceDescription20250101: - type: object - description: Group of settings that configure a MongoDB USS instance. - properties: - backupSettings: - $ref: "#/components/schemas/USSBackupSettings20250101" - clusterType: + raw: + $ref: "#/components/schemas/raw" + remoteAddress: type: string - description: USS instance topology. - enum: - - REPLICASET - - LOADBALANCED + description: IPv4 or IPv6 address from which the user triggered this event. + example: 216.172.40.186 + pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" readOnly: true - connectionStrings: - $ref: "#/components/schemas/USSConnectionStrings20250101" - createDate: + replicaSetName: type: string - format: date-time - description: Date and time when MongoDB Cloud created this instance. This - parameter expresses its value in ISO 8601 format in UTC. + description: Human-readable label of the replica set associated with the + event. + example: event-replica-set readOnly: true - groupId: + shardName: type: string - description: Unique 24-hexadecimal character string that identifies the - project. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" + description: Human-readable label of the shard associated with the event. + example: event-sh-01 readOnly: true - id: + userId: type: string - description: Unique 24-hexadecimal digit string that identifies the instance. + description: "Unique 24-hexadecimal digit string that identifies the console\ + \ user who triggered the event. If this resource returns this parameter,\ + \ it doesn't return the **apiKeyId** parameter." example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true - links: - type: array - description: "List of one or more Uniform Resource Locators (URLs) that\ - \ point to API sub-resources, related API resources, or both. RFC 5988\ - \ outlines these relationships." - externalDocs: - description: Web Linking Specification (RFC 5988) - url: https://datatracker.ietf.org/doc/html/rfc5988 - items: - $ref: "#/components/schemas/Link" - readOnly: true - mongoDBVersion: + username: type: string - description: Version of MongoDB that the instance runs. - pattern: "([\\d]+\\.[\\d]+\\.[\\d]+)" + format: email + description: "Email address for the user who triggered this event. If this\ + \ resource returns this parameter, it doesn't return the **publicApiKey**\ + \ parameter." + example: test.user@mongodb.com readOnly: true - name: + required: + - created + - eventTypeName + - id + TimeMetricThresholdView: + type: object + properties: + metricName: type: string - description: Human-readable label that identifies the instance. - maxLength: 64 - minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - readOnly: true - providerSettings: - $ref: "#/components/schemas/USSProviderSettings20250101" - stateName: + description: Human-readable label that identifies the metric against which + MongoDB Cloud checks the configured **metricThreshold.threshold**. + mode: type: string - description: Human-readable label that indicates the current operating condition - of this instance. + description: MongoDB Cloud computes the current metric value as an average. enum: - - IDLE - - CREATING - - UPDATING - - DELETING - - REPAIRING - readOnly: true - tags: - type: array - description: List that contains key-value pairs between 1 to 255 characters - in length for tagging and categorizing the instance. - externalDocs: - description: Resource Tags - url: https://dochub.mongodb.org/core/add-cluster-tag-atlas - items: - $ref: "#/components/schemas/ResourceTag" - terminationProtectionEnabled: - type: boolean - default: false - description: "Flag that indicates whether termination protection is enabled\ - \ on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster.\ - \ If set to `false`, MongoDB Cloud will delete the cluster." - versionReleaseSystem: + - AVERAGE + operator: type: string - default: LTS - description: Method by which the cluster maintains the MongoDB versions. + description: Comparison operator to apply when checking the current metric + value. enum: - - LTS - readOnly: true + - LESS_THAN + - GREATER_THAN + threshold: + type: number + format: double + description: "Value of metric that, when exceeded, triggers an alert." + units: + $ref: "#/components/schemas/TimeMetricUnits" required: - - providerSettings - title: USS Instance Description - USSInstanceDescriptionCreate20250101: + - metricName + TimeMetricUnits: + type: string + default: HOURS + description: "Element used to express the quantity. This can be an element of\ + \ time, storage capacity, and the like." + enum: + - NANOSECONDS + - MILLISECONDS + - MILLION_MINUTES + - SECONDS + - MINUTES + - HOURS + - DAYS + title: Time Metric Units + TimeMetricValueView: type: object - description: Settings that you can specify when you create a USS instance. + description: Measurement of the **metricName** recorded at the time of the event. properties: - links: - type: array - description: "List of one or more Uniform Resource Locators (URLs) that\ - \ point to API sub-resources, related API resources, or both. RFC 5988\ - \ outlines these relationships." - externalDocs: - description: Web Linking Specification (RFC 5988) - url: https://datatracker.ietf.org/doc/html/rfc5988 - items: - $ref: "#/components/schemas/Link" + number: + type: number + format: double + description: Amount of the **metricName** recorded at the time of the event. + This value triggered the alert. readOnly: true - name: + units: + $ref: "#/components/schemas/TimeMetricUnits" + readOnly: true + title: Time Metric Value + TokenFilterEnglishPossessive: + type: object + description: Filter that removes possessives (trailing 's) from words. + properties: + type: type: string - description: Human-readable label that identifies the instance. - maxLength: 64 - minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - writeOnly: true - providerSettings: - $ref: "#/components/schemas/USSProviderSettingsCreate20250101" - tags: - type: array - description: List that contains key-value pairs between 1 to 255 characters - in length for tagging and categorizing the instance. - externalDocs: - description: Resource Tags - url: https://dochub.mongodb.org/core/add-cluster-tag-atlas - items: - $ref: "#/components/schemas/ResourceTag" - terminationProtectionEnabled: - type: boolean - default: false - description: "Flag that indicates whether termination protection is enabled\ - \ on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster.\ - \ If set to `false`, MongoDB Cloud will delete the cluster." + description: Human-readable label that identifies this token filter type. + enum: + - englishPossessive required: - - name - - providerSettings - title: USS Instance Description Create - USSProviderSettings20250101: + - type + title: englishPossessive + TokenFilterFlattenGraph: type: object - description: Group of cloud provider settings that configure the provisioned - MongoDB USS instance. + description: "Filter that transforms a token filter graph, such as the token\ + \ filter graph that the wordDelimiterGraph token filter produces, into a flat\ + \ form suitable for indexing." properties: - backingProviderName: + type: type: string - description: Cloud service provider on which MongoDB Cloud provisioned the - USS instance. + description: Human-readable label that identifies this token filter type. enum: - - AWS - - AZURE - - GCP - readOnly: true - diskSizeGB: - type: number - format: double - description: Storage capacity available to the USS instance expressed in - gigabytes. - readOnly: true - providerName: + - flattenGraph + required: + - type + title: flattenGraph + TokenFilterPorterStemming: + type: object + description: Filter that uses the porter stemming algorithm to remove the common + morphological and inflectional suffixes from words in English. It expects + lowercase text and doesn't work as expected for uppercase text. + properties: + type: type: string - default: USS - description: Human-readable label that identifies the cloud service provider. + description: Human-readable label that identifies this token filter type. enum: - - USS - readOnly: true - regionName: + - porterStemming + required: + - type + title: porterStemming + TokenFilterSpanishPluralStemming: + type: object + description: Filter that stems Spanish plural words. It expects lowercase text. + properties: + type: type: string - description: "Human-readable label that identifies the geographic location\ - \ of your MongoDB USS 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/)." - readOnly: true - readOnly: true - title: Cloud Service Provider Settings for a USS Instance - USSProviderSettingsCreate20250101: + description: Human-readable label that identifies this token filter type. + enum: + - spanishPluralStemming + required: + - type + title: spanishPluralStemming + TokenFilterStempel: type: object - description: Group of cloud provider settings that configure the provisioned - MongoDB USS instance. + description: Filter that uses Lucene's default Polish stemmer table to stem + words in the Polish language. It expects lowercase text. + externalDocs: + description: Default Polish stemmer table + url: https://lucene.apache.org/core/9_2_0/analysis/stempel/org/apache/lucene/analysis/pl/PolishAnalyzer.html#DEFAULT_STEMMER_FILE properties: - backingProviderName: + type: type: string - description: Cloud service provider on which MongoDB Cloud provisioned the - serverless instance. + description: Human-readable label that identifies this token filter type. enum: - - AWS - - AZURE - - GCP - writeOnly: true - diskSizeGB: - type: number - format: double - description: Storage capacity available to the USS instance expressed in - gigabytes. - readOnly: true - providerName: + - stempel + required: + - type + title: stempel + TokenFilterWordDelimiterGraph: + type: object + description: Filter that splits tokens into sub-tokens based on configured rules. + properties: + delimiterOptions: + type: object + description: Object that contains the rules that determine how to split + words into sub-words. + properties: + concatenateAll: + type: boolean + default: false + description: Flag that indicates whether to concatenate runs. + concatenateNumbers: + type: boolean + default: false + description: Flag that indicates whether to concatenate runs of sub-numbers. + concatenateWords: + type: boolean + default: false + description: Flag that indicates whether to concatenate runs of sub-words. + generateNumberParts: + type: boolean + default: true + description: "Flag that indicates whether to split tokens based on sub-numbers.\ + \ For example, if `true`, this option splits `100-2` into `100` and\ + \ `2`." + generateWordParts: + type: boolean + default: true + description: Flag that indicates whether to split tokens based on sub-words. + ignoreKeywords: + type: boolean + default: false + description: Flag that indicates whether to skip tokens with the `keyword` + attribute set to `true` + preserveOriginal: + type: boolean + default: true + description: Flag that indicates whether to generate tokens of the original + words. + splitOnCaseChange: + type: boolean + default: true + description: Flag that indicates whether to split tokens based on letter-case + transitions. + splitOnNumerics: + type: boolean + default: true + description: Flag that indicates whether to split tokens based on letter-number + transitions. + stemEnglishPossessive: + type: boolean + default: true + description: Flag that indicates whether to remove trailing possessives + from each sub-word. + protectedWords: + type: object + description: Object that contains options for protected words. + properties: + ignoreCase: + type: boolean + default: true + description: Flag that indicates whether to ignore letter case sensitivity + for protected words. + words: + type: array + description: List that contains the tokens to protect from delimination. + items: + type: string + required: + - words + type: type: string - default: USS - description: Human-readable label that identifies the cloud service provider. + description: Human-readable label that identifies this token filter type. enum: - - USS - readOnly: true - regionName: + - wordDelimiterGraph + required: + - type + title: wordDelimiterGraph + TokenFilterkStemming: + type: object + description: Filter that combines algorithmic stemming with a built-in dictionary + for the English language to stem words. + properties: + type: type: string - description: "Human-readable label that identifies the geographic location\ - \ of your MongoDB USS 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/)." + description: Human-readable label that identifies this token filter type. + enum: + - kStemming + required: + - type + title: kStemming + TriggerIngestionPipelineRequest: + type: object + properties: + datasetRetentionPolicy: + $ref: "#/components/schemas/DatasetRetentionPolicy" + snapshotId: + type: string + description: Unique 24-hexadecimal character string that identifies the + snapshot. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" writeOnly: true required: - - backingProviderName - - regionName - title: Cloud Service Provider Settings for a USS Instance - writeOnly: true + - snapshotId UpdateAtlasOrganizationApiKey: type: object properties: @@ -52999,7 +55834,7 @@ components: Atlas Data Lake that this database user can access. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" type: type: string description: Category of resource that this database user can access. @@ -53058,6 +55893,28 @@ components: required: - match title: User to Distinguished Name Mapping + VPCPeeringActionChallenge: + type: object + description: Container for elements used to challenge the user before taking + certain actions on VPC Peering connections. + properties: + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + requesterAccountId: + type: string + description: The AWS requester account ID. + requesterVpcId: + type: string + description: The AWS requester VPC ID. VectorSearchHostStatusDetail: type: object properties: diff --git a/tools/cli/test/data/split/dev/openapi-v2-2025-01-01.json b/tools/cli/test/data/split/dev/openapi-v2-2025-01-01.json index b88c12a2d7..581cd16a2a 100644 --- a/tools/cli/test/data/split/dev/openapi-v2-2025-01-01.json +++ b/tools/cli/test/data/split/dev/openapi-v2-2025-01-01.json @@ -1,7 +1,7 @@ { "openapi" : "3.0.1", "info" : { - "description" : "The MongoDB Atlas Administration API allows developers to manage all components in MongoDB Atlas.\n\nThe Atlas Administration API uses HTTP Digest Authentication to authenticate requests. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request. For example, to [return database access history](#tag/Access-Tracking/operation/listAccessLogsByClusterName) with [cURL](https://en.wikipedia.org/wiki/CURL), run the following command in the terminal:\n\n```\ncurl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true\"\n```\n\nTo learn more, see [Get Started with the Atlas Administration API](https://www.mongodb.com/docs/atlas/configure-api-access/). For support, see [MongoDB Support](https://www.mongodb.com/support/get-started).", + "description" : "The MongoDB Atlas Administration API allows developers to manage all components in MongoDB Atlas.\n\nThe Atlas Administration API uses HTTP Digest Authentication to authenticate requests. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request. For example, to [return database access history](#tag/Access-Tracking/operation/listAccessLogsByClusterName) with [cURL](https://en.wikipedia.org/wiki/CURL), run the following command in the terminal:\n\n```\ncurl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true\"\n```\n\nTo learn more, see [Get Started with the Atlas Administration API](https://www.mongodb.com/docs/atlas/configure-api-access/). For support, see [MongoDB Support](https://www.mongodb.com/support/get-started).\n\nYou can also explore the various endpoints available through the Atlas Administration API in MongoDB's [Postman workspace](https://www.postman.com/mongodb-devrel/workspace/mongodb-atlas-administration-apis/).", "license" : { "name" : "CC BY-NC-SA 3.0 US", "url" : "https://creativecommons.org/licenses/by-nc-sa/3.0/us/" @@ -9,7 +9,7 @@ "termsOfService" : "https://www.mongodb.com/mongodb-management-service-terms-and-conditions", "title" : "MongoDB Atlas Administration API", "version" : "2.0", - "x-xgen-sha" : "09d9d18db2111c955a8e01702a27ca2763417782" + "x-xgen-sha" : "e6ba3136dbd0be2a81dd4ed21b9e6c470edd4420" }, "servers" : [ { "url" : "https://cloud.mongodb.com" @@ -57,7 +57,11 @@ "description" : "Returns, adds, edits, and removes Federated Database Instances. This resource requires your project ID. Changes to federated database instance configurations can affect costs.", "name" : "Data Federation" }, { - "description" : "Returns, adds, edits, and removes Atlas Data Lake Pipelines and associated runs.", + "description" : "Returns, edits, and removes Atlas Data Lake Pipelines and associated runs.", + "externalDocs" : { + "description" : "Data Lake Pipelines are deprecated. Please see Data Lake Deprecation Guide.", + "url" : "https://dochub.mongodb.org/core/data-lake-deprecation" + }, "name" : "Data Lake Pipelines" }, { "description" : "Returns, adds, edits, and removes database users.", @@ -119,6 +123,9 @@ }, { "description" : "You can continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket. Atlas exports logs every 5 minutes.", "name" : "Push-Based Log Export" + }, { + "description" : "Configure and manage Atlas Resource Policies within your organization.", + "name" : "Resource Policies" }, { "description" : "Creates one index to a database deployment in a rolling manner. You can't create a rolling index on an `M0` free cluster or `M2/M5` shared cluster.", "name" : "Rolling Index" @@ -135,6 +142,13 @@ "url" : "https://dochub.mongodb.org/core/serverless-private-endpoint" }, "name" : "Serverless Private Endpoints" + }, { + "description" : "Endpoints for managing Service Accounts and secrets. Service Accounts are used for programmatic access to the Atlas Admin API through the OAuth 2.0 Client Credentials flow. This feature is available as a Preview feature.", + "externalDocs" : { + "description" : "Get Started with the Atlas Administration API", + "url" : "https://www.mongodb.com/docs/atlas/configure-api-access/" + }, + "name" : "Service Accounts" }, { "description" : "Returns and adds restore jobs for shared-tier database deployments.", "name" : "Shared-Tier Restore Jobs" @@ -2866,7 +2880,7 @@ }, "/api/atlas/v2/groups/{groupId}/backup/exportBuckets" : { "get" : { - "description" : "Returns all AWS S3 buckets and Azure Blob Storage Containers associated with the specified Project. To use this resource, the requesting API Key must have the Project Read Only role. Deprecated versions: v2-{2023-01-01}", + "description" : "Returns all Export Buckets associated with the specified Project. To use this resource, the requesting API Key must have the Project Read Only role. Deprecated versions: v2-{2023-01-01}", "operationId" : "listExportBuckets", "parameters" : [ { "$ref" : "#/components/parameters/envelope" @@ -2903,11 +2917,11 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Return All AWS S3 Buckets and Azure Blob Storage Containers Used for Cloud Backup Snapshot Exports", + "summary" : "Return All Snapshot Export Buckets", "tags" : [ "Cloud Backups" ] }, "post" : { - "description" : "Grants MongoDB Cloud access to the specified AWS S3 Bucket or Azure Blob Storage Container. This enables this Export Bucket to receive Atlas Cloud Backup Snapshots. To use this resource, the requesting API Key must have the Project Owner role. Deprecated versions: v2-{2023-01-01}", + "description" : "Creates a Snapshot Export Bucket for an AWS S3 Bucket or Azure Blob Storage Container. Once created, an snapshots can be exported to the Export Bucket and its referenced AWS S3 Bucket or Azure Blob Storage Container. To use this resource, the requesting API Key must have the Project Owner role. Deprecated versions: v2-{2023-01-01}", "operationId" : "createExportBucket", "parameters" : [ { "$ref" : "#/components/parameters/envelope" @@ -2945,7 +2959,7 @@ "x-xgen-version" : "2024-05-30" } }, - "description" : "Grants MongoDB Cloud access to the specified AWS S3 Bucket or Azure Blob Storage Container.", + "description" : "Specifies the role and AWS S3 Bucket or Azure Blob Storage Container that the Export Bucket should reference.", "required" : true }, "responses" : { @@ -3006,20 +3020,20 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Grant Access to AWS S3 Bucket or Azure Blob Storage Container for Cloud Backup Snapshot Exports", + "summary" : "Create One Snapshot Export Bucket", "tags" : [ "Cloud Backups" ] } }, "/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}" : { "delete" : { - "description" : "Revoke MongoDB Cloud access to the specified AWS S3 Bucket or Azure Blob Storage Container. This prevents this Export Bucket from receiving Atlas Cloud Backup Snapshots. 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 API Key must have the Project Owner role.", + "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 API Key must have the Project Owner role.", "operationId" : "deleteExportBucket", "parameters" : [ { "$ref" : "#/components/parameters/envelope" }, { "$ref" : "#/components/parameters/groupId" }, { - "description" : "Unique string that identifies the AWS S3 Bucket or Azure Blob Storage Container to which you export your Snapshots.", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", "in" : "path", "name" : "exportBucketId", "required" : true, @@ -3059,11 +3073,11 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Revoke Access to AWS S3 Bucket or Azure Blob Storage Container for Cloud Backup Snapshot Exports", + "summary" : "Delete One Snapshot Export Bucket", "tags" : [ "Cloud Backups" ] }, "get" : { - "description" : "Returns one AWS S3 Bucket or Azure Blob Storage Container associated with the specified Project. To use this resource, the requesting API Key must have the Project Read Only role. Deprecated versions: v2-{2023-01-01}", + "description" : "Returns one Export Bucket associated with the specified Project. To use this resource, the requesting API Key must have the Project Read Only role. Deprecated versions: v2-{2023-01-01}", "operationId" : "getExportBucket", "parameters" : [ { "$ref" : "#/components/parameters/envelope" @@ -3137,7 +3151,7 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Return One AWS S3 Bucket or Azure Blob Storage Container Used for Cloud Backup Snapshot Exports", + "summary" : "Return One Snapshot Export Bucket", "tags" : [ "Cloud Backups" ] } }, @@ -3296,7 +3310,7 @@ "content" : { "application/vnd.atlas.2023-01-01+json" : { "schema" : { - "$ref" : "#/components/schemas/CloudProviderAccessRole" + "$ref" : "#/components/schemas/CloudProviderAccessRoleRequest" } } }, @@ -3346,7 +3360,7 @@ "required" : true, "schema" : { "type" : "string", - "enum" : [ "AWS" ] + "enum" : [ "AWS", "AZURE", "GCP" ] } }, { "description" : "Unique 24-hexadecimal digit string that identifies the role.", @@ -3434,7 +3448,7 @@ "tags" : [ "Cloud Provider Access" ] }, "patch" : { - "description" : "Grants access to the specified project for the specified access role. To use this resource, the requesting API Key must have the Project Owner role. This API endpoint is one step in a procedure to create unified access for MongoDB Cloud services.", + "description" : "Grants access to the specified project for the specified access role. To use this resource, the requesting API Key must have the Project Owner role. This API endpoint is one step in a procedure to create unified access for MongoDB Cloud services. 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/" @@ -3462,7 +3476,7 @@ "content" : { "application/vnd.atlas.2023-01-01+json" : { "schema" : { - "$ref" : "#/components/schemas/CloudProviderAccessRole" + "$ref" : "#/components/schemas/CloudProviderAccessRoleRequestUpdate" } } }, @@ -3567,7 +3581,99 @@ "examples" : { "Cluster" : { "description" : "Cluster", - "value" : "{\n \"clusterType\": \"SHARDED\",\n \"links\": [],\n \"name\": \"myCluster\",\n \"replicationSpecs\": [\n {\n \"regionConfigs\": [\n {\n \"analyticsAutoScaling\": {\n \"autoIndexing\": {\n \"enabled\": false\n },\n \"compute\": {\n \"enabled\": true,\n \"maxInstanceSize\": \"M40\",\n \"minInstanceSize\": \"M30\",\n \"scaleDownEnabled\": true\n },\n \"diskGB\": {\n \"enabled\": true\n }\n },\n \"analyticsSpecs\": {\n \"instanceSize\": \"M30\",\n \"nodeCount\": 0,\n \"diskSizeGB\": 10.0\n },\n \"autoScaling\": {\n \"autoIndexing\": {\n \"enabled\": false\n },\n \"compute\": {\n \"enabled\": true,\n \"maxInstanceSize\": \"M40\",\n \"minInstanceSize\": \"M30\",\n \"scaleDownEnabled\": true\n },\n \"diskGB\": {\n \"enabled\": true\n }\n },\n \"electableSpecs\": {\n \"instanceSize\": \"M30\",\n \"nodeCount\": 3,\n \"diskSizeGB\": 10.0\n },\n \"hiddenSecondarySpecs\": {\n \"instanceSize\": \"M30\",\n \"nodeCount\": 0,\n \"diskSizeGB\": 10.0\n },\n \"priority\": 7,\n \"providerName\": \"AWS\",\n \"readOnlySpecs\": {\n \"instanceSize\": \"M30\",\n \"nodeCount\": 0,\n \"diskSizeGB\": 10.0\n },\n \"regionName\": \"US_EAST_1\"\n }\n ],\n \"zoneName\": \"Zone 1\"\n },\n {\n \"regionConfigs\": [\n {\n \"analyticsAutoScaling\": {\n \"autoIndexing\": {\n \"enabled\": false\n },\n \"compute\": {\n \"enabled\": true,\n \"maxInstanceSize\": \"M20\",\n \"minInstanceSize\": \"M10\",\n \"scaleDownEnabled\": true\n },\n \"diskGB\": {\n \"enabled\": true\n }\n },\n \"analyticsSpecs\": {\n \"instanceSize\": \"M10\",\n \"nodeCount\": 0,\n \"diskSizeGB\": 10.0\n },\n \"autoScaling\": {\n \"autoIndexing\": {\n \"enabled\": false\n },\n \"compute\": {\n \"enabled\": true,\n \"maxInstanceSize\": \"M20\",\n \"minInstanceSize\": \"M10\",\n \"scaleDownEnabled\": true\n },\n \"diskGB\": {\n \"enabled\": true\n }\n },\n \"electableSpecs\": {\n \"instanceSize\": \"M10\",\n \"nodeCount\": 3,\n \"diskSizeGB\": 10.0\n },\n \"hiddenSecondarySpecs\": {\n \"instanceSize\": \"M10\",\n \"nodeCount\": 0,\n \"diskSizeGB\": 10.0\n },\n \"priority\": 7,\n \"providerName\": \"AWS\",\n \"readOnlySpecs\": {\n \"instanceSize\": \"M10\",\n \"nodeCount\": 0,\n \"diskSizeGB\": 10.0\n },\n \"regionName\": \"US_EAST_1\"\n }\n ],\n \"zoneName\": \"Zone 1\"\n },\n ]\n}\n" + "value" : { + "clusterType" : "SHARDED", + "name" : "myCluster", + "replicationSpecs" : [ { + "regionConfigs" : [ { + "analyticsAutoScaling" : { + "autoIndexing" : { + "enabled" : false + }, + "compute" : { + "enabled" : false + }, + "diskGB" : { + "enabled" : true + } + }, + "analyticsSpecs" : { + "diskSizeGB" : 10.0, + "instanceSize" : "M30", + "nodeCount" : 0 + }, + "autoScaling" : { + "autoIndexing" : { + "enabled" : false + }, + "compute" : { + "enabled" : false + }, + "diskGB" : { + "enabled" : true + } + }, + "electableSpecs" : { + "diskSizeGB" : 10.0, + "instanceSize" : "M30", + "nodeCount" : 3 + }, + "priority" : 7, + "providerName" : "AWS", + "readOnlySpecs" : { + "diskSizeGB" : 10.0, + "instanceSize" : "M30", + "nodeCount" : 0 + }, + "regionName" : "US_EAST_1" + } ], + "zoneName" : "Zone 1" + }, { + "regionConfigs" : [ { + "analyticsAutoScaling" : { + "autoIndexing" : { + "enabled" : false + }, + "compute" : { + "enabled" : false + }, + "diskGB" : { + "enabled" : true + } + }, + "analyticsSpecs" : { + "diskSizeGB" : 10.0, + "instanceSize" : "M10", + "nodeCount" : 0 + }, + "autoScaling" : { + "autoIndexing" : { + "enabled" : false + }, + "compute" : { + "enabled" : false + }, + "diskGB" : { + "enabled" : true + } + }, + "electableSpecs" : { + "diskSizeGB" : 10.0, + "instanceSize" : "M10", + "nodeCount" : 3 + }, + "priority" : 7, + "providerName" : "AWS", + "readOnlySpecs" : { + "diskSizeGB" : 10.0, + "instanceSize" : "M10", + "nodeCount" : 0 + }, + "regionName" : "US_EAST_1" + } ], + "zoneName" : "Zone 1" + } ] + } } }, "schema" : { @@ -3816,7 +3922,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster.", @@ -3875,7 +3981,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -3927,7 +4033,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -3979,7 +4085,7 @@ }, "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports" : { "get" : { - "description" : "Returns all Cloud Backup snapshot export jobs associated with the specified Atlas cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role.", + "description" : "Returns all Cloud Backup Snapshot Export Jobs associated with the specified Atlas cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role.", "operationId" : "listBackupExportJobs", "parameters" : [ { "$ref" : "#/components/parameters/envelope" @@ -4002,7 +4108,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -4027,11 +4133,11 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Return All Cloud Backup Snapshot Export Jobs", + "summary" : "Return All Snapshot Export Jobs", "tags" : [ "Cloud Backups" ] }, "post" : { - "description" : "Exports one backup snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. To use this resource, the requesting API Key must have the Project Atlas Admin role.", + "description" : "Exports one backup Snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. To use this resource, the requesting API Key must have the Project Atlas Admin role.", "operationId" : "createBackupExportJob", "parameters" : [ { "$ref" : "#/components/parameters/envelope" @@ -4046,7 +4152,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -4091,13 +4197,13 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Create One Cloud Backup Snapshot Export Job", + "summary" : "Create One Snapshot Export Job", "tags" : [ "Cloud Backups" ] } }, "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}" : { "get" : { - "description" : "Returns one Cloud Backup snapshot export job associated with the specified Atlas cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role.", + "description" : "Returns one Cloud Backup Snapshot Export Job associated with the specified Atlas cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role.", "operationId" : "getBackupExportJob", "parameters" : [ { "$ref" : "#/components/parameters/envelope" @@ -4112,15 +4218,19 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { - "description" : "Unique string that identifies the export job to return.", + "description" : "Unique 24-hexadecimal character string that identifies the Export Job.", "in" : "path", "name" : "exportId", "required" : true, "schema" : { - "type" : "string" + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" } } ], "responses" : { @@ -4145,7 +4255,7 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Return One Cloud Backup Snapshot Export Job", + "summary" : "Return One Snapshot Export Job", "tags" : [ "Cloud Backups" ] } }, @@ -4174,7 +4284,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -4220,7 +4330,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -4288,7 +4398,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the restore job to remove.", @@ -4348,7 +4458,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the restore job to return.", @@ -4405,7 +4515,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -4454,7 +4564,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -4500,7 +4610,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -4568,7 +4678,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -4617,7 +4727,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -4679,7 +4789,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -4736,7 +4846,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -4798,7 +4908,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -4849,7 +4959,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -4909,7 +5019,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -4969,7 +5079,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -5036,7 +5146,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "$ref" : "#/components/parameters/envelope" @@ -5107,7 +5217,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "$ref" : "#/components/parameters/envelope" @@ -5175,7 +5285,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "$ref" : "#/components/parameters/envelope" @@ -5226,7 +5336,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "$ref" : "#/components/parameters/envelope" @@ -5294,7 +5404,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -5345,7 +5455,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -5414,7 +5524,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -5474,7 +5584,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -5526,7 +5636,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -5576,7 +5686,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -5648,7 +5758,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -5722,7 +5832,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -5792,7 +5902,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -5863,7 +5973,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Name of the collection that contains one or more Atlas Search indexes.", @@ -5936,7 +6046,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the Atlas Search index. Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes.", @@ -6002,7 +6112,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "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.", @@ -6065,7 +6175,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "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.", @@ -6146,7 +6256,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -6198,7 +6308,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -6248,7 +6358,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -6313,7 +6423,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "$ref" : "#/components/parameters/groupId" @@ -6382,7 +6492,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -6452,7 +6562,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -6606,7 +6716,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -6656,7 +6766,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -6749,7 +6859,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Flag that indicates whether to download logs for queries against your online archive only or both your online archive and cluster.", @@ -6828,7 +6938,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -6892,7 +7002,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -6959,7 +7069,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -7031,7 +7141,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -7087,7 +7197,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -7143,7 +7253,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -7186,6 +7296,98 @@ "tags" : [ "Cluster Outage Simulation" ] } }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/suggestedIndexes" : { + "get" : { + "description" : "Returns the indexes that the Performance Advisor suggests. The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "listSuggestedIndexes_1", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + } + }, { + "description" : "ProcessIds from which to retrieve suggested indexes. A processId is a combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests. To include multiple processIds, pass the parameter multiple times delimited with an ampersand (`&`) between each processId.", + "in" : "query", + "name" : "processIds", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, + "style" : "form" + }, { + "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.", + "in" : "query", + "name" : "namespaces", + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "style" : "form" + }, { + "description" : "HostType determines the source of index advice from logs. If **hostType**=All, index advice from logs will come from all processes within a cluster and **processIds** will be ignored. If hostType=Null, index advice from logs will come from the subset of processes within this cluster specified using *processIds**.", + "in" : "query", + "name" : "hostType", + "schema" : { + "type" : "string" + } + }, { + "description" : "Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).\n\n- If you don't specify the **until** parameter, the endpoint returns data covering from the **since** value and the current time.\n- If you specify neither the **since** nor the **until** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "since", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600000 + } + }, { + "description" : "Date and time up until which the query retrieves the suggested indexes. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).\n\n- If you specify the **until** parameter, you must specify the **since** parameter.\n- If you specify neither the **since** nor the **until** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "until", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600000 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PerformanceAdvisorResponse" + }, + "x-xgen-version" : "2025-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Suggested Indexes", + "tags" : [ "Performance Advisor" ] + } + }, "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs" : { "get" : { "description" : "Returns the advanced configuration details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. Advanced configuration details include the read/write concern, index and oplog limits, and other database settings. This feature isn't available for `M0` free clusters, `M2` and `M5` shared-tier clusters, or serverless clusters. To use this resource, the requesting API Key must have the Project Read Only role. Deprecated versions: v2-{2023-01-01}", @@ -7209,7 +7411,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -7262,7 +7464,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -7328,7 +7530,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -7390,7 +7592,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -7440,7 +7642,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -7503,7 +7705,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", @@ -7565,7 +7767,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -7617,7 +7819,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -7666,7 +7868,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -7729,7 +7931,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -7798,7 +8000,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -7864,7 +8066,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -7933,7 +8135,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Name of the collection that contains one or more Atlas Search indexes.", @@ -8017,7 +8219,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Name of the collection that contains one or more Atlas Search indexes.", @@ -8094,7 +8296,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Name of the collection that contains one or more Atlas Search indexes.", @@ -8171,7 +8373,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Name of the collection that contains one or more Atlas Search indexes.", @@ -8264,7 +8466,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the Atlas Search index. Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes.", @@ -8328,7 +8530,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "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.", @@ -8402,7 +8604,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "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.", @@ -8479,7 +8681,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -8526,7 +8728,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -8592,7 +8794,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Human-readable label that specifies whether to return only completed, incomplete, or all snapshots. By default, MongoDB Cloud only returns completed snapshots.", @@ -8650,7 +8852,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -8711,7 +8913,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -8769,7 +8971,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -8839,7 +9041,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -8883,7 +9085,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Human-readable label that identifies the cluster topology to retrieve metrics for.", @@ -8944,7 +9146,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Human-readable label that identifies the cluster topology to retrieve metrics for.", @@ -9015,10 +9217,10 @@ "tags" : [ "Collection Level Metrics" ] } }, - "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:pinFeatureCompatibilityVersion" : { + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:grantMongoDBEmployeeAccess" : { "post" : { - "description" : "Pins the FCV to the current MongoDB version.", - "operationId" : "pinFeatureCompatibilityVersion", + "description" : "Grants MongoDB employee cluster access for the given duration and at the specified level for one cluster.", + "operationId" : "grantMongoDBEmployeeAccess", "parameters" : [ { "$ref" : "#/components/parameters/envelope" }, { @@ -9034,28 +9236,29 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { "content" : { - "application/vnd.atlas.2024-05-30+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { - "$ref" : "#/components/schemas/PinFCVView" + "$ref" : "#/components/schemas/EmployeeAccessGrantView" }, - "x-xgen-version" : "2024-05-30" + "x-xgen-version" : "2024-08-05" } }, - "description" : "Optional request params for tuning FCV pinning configuration." + "description" : "Grant access level and expiration.", + "required" : true }, "responses" : { "204" : { "content" : { - "application/vnd.atlas.2024-05-30+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { "$ref" : "#/components/schemas/NoBody" }, - "x-xgen-version" : "2024-05-30" + "x-xgen-version" : "2024-08-05" } }, "description" : "This endpoint does not return a response body." @@ -9079,20 +9282,20 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Pin FCV for One Cluster from One Project", + "summary" : "Grant MongoDB employee cluster access for one cluster.", "tags" : [ "Clusters" ] } }, - "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:unpinFeatureCompatibilityVersion" : { + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:pinFeatureCompatibilityVersion" : { "post" : { - "description" : "Unpins the current fixed Feature Compatibility Version. This feature is not available for clusters on rapid release.", - "operationId" : "unpinFeatureCompatibilityVersion", + "description" : "Pins the FCV to the current MongoDB version.", + "operationId" : "pinFeatureCompatibilityVersion", "parameters" : [ { "$ref" : "#/components/parameters/envelope" - }, { - "$ref" : "#/components/parameters/groupId" }, { "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" }, { "description" : "Human-readable label that identifies this cluster.", "in" : "path", @@ -9102,9 +9305,20 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/PinFCVView" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "Optional request params for tuning FCV pinning configuration." + }, "responses" : { "204" : { "content" : { @@ -9123,11 +9337,8 @@ "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" @@ -9139,72 +9350,43 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Unpins FCV for One Cluster from One Project", + "summary" : "Pin FCV for One Cluster from One Project", "tags" : [ "Clusters" ] } }, - "/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz" : { - "get" : { - "description" : "Returns a compressed (.gz) log file that contains a range of log messages for the specified host for the specified project. MongoDB updates process and audit logs from the cluster backend infrastructure every five minutes and contain log data from the previous five minutes. If you poll the API for log files, we recommend polling every five minutes. For example, if the logs are updated at 4:00 UTC and then you poll the API, the API returns log data from the interval between 3:55 UTC and 4:00 UTC. This feature isn't available for `M0` free clusters, `M2`, `M5`, or serverless clusters. To use this resource, the requesting API Key must have the Project Data Access Read Only or higher role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: \"Accept: application/vnd.atlas.YYYY-MM-DD+gzip\". Deprecated versions: v2-{2023-01-01}", - "operationId" : "getHostLogs", + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:revokeMongoDBEmployeeAccess" : { + "post" : { + "description" : "Revokes a previously granted MongoDB employee cluster access.", + "operationId" : "revokeMongoDBEmployeeAccess", "parameters" : [ { "$ref" : "#/components/parameters/envelope" }, { - "$ref" : "#/components/parameters/groupId" + "$ref" : "#/components/parameters/pretty" }, { - "description" : "Human-readable label that identifies the host that stores the log files that you want to download.", - "in" : "path", - "name" : "hostName", - "required" : true, - "schema" : { - "type" : "string", - "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$" - } + "$ref" : "#/components/parameters/groupId" }, { - "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.", + "description" : "Human-readable label that identifies this cluster.", "in" : "path", - "name" : "logName", + "name" : "clusterName", "required" : true, "schema" : { "type" : "string", - "enum" : [ "mongodb", "mongos", "mongodb-audit-log", "mongos-audit-log" ], - "externalDocs" : { - "description" : "Set up Database Auditing", - "url" : "https://docs.atlas.mongodb.com/database-auditing/" - } - } - }, { - "description" : "Date and time when the period specifies the inclusive ending point for the range of log messages to retrieve. This parameter expresses its value in the number of seconds that have elapsed since the UNIX epoch.", - "in" : "query", - "name" : "endDate", - "schema" : { - "type" : "integer", - "format" : "int64", - "minimum" : 1199145600 - } - }, { - "description" : "Date and time when the period specifies the inclusive starting point for the range of log messages to retrieve. This parameter expresses its value in the number of seconds that have elapsed since the UNIX epoch.", - "in" : "query", - "name" : "startDate", - "schema" : { - "type" : "integer", - "format" : "int64", - "minimum" : 1199145600 + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { - "200" : { + "204" : { "content" : { - "application/vnd.atlas.2023-02-01+gzip" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { - "type" : "string", - "format" : "binary", - "description" : "Compressed (.gz) log file that contains a range of log messages for the specified host for the specified project" + "$ref" : "#/components/schemas/NoBody" }, - "x-xgen-version" : "2023-02-01" + "x-xgen-version" : "2024-08-05" } }, - "description" : "OK" + "description" : "This endpoint does not return a response body." }, "400" : { "$ref" : "#/components/responses/badRequest" @@ -9212,9 +9394,6 @@ "401" : { "$ref" : "#/components/responses/unauthorized" }, - "403" : { - "$ref" : "#/components/responses/forbidden" - }, "404" : { "$ref" : "#/components/responses/notFound" }, @@ -9228,39 +9407,58 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Download Logs for One Cluster Host in One Project", - "tags" : [ "Monitoring and Logs" ] + "summary" : "Revoke granted MongoDB employee cluster access for one cluster.", + "tags" : [ "Clusters" ] } }, - "/api/atlas/v2/groups/{groupId}/collStats/metrics" : { - "get" : { - "description" : "Returns all available Coll Stats Latency metric names and their respective units for the specified project at the time of request.", - "operationId" : "getCollStatsLatencyNamespaceMetrics", + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:unpinFeatureCompatibilityVersion" : { + "post" : { + "description" : "Unpins the current fixed Feature Compatibility Version. This feature is not available for clusters on rapid release.", + "operationId" : "unpinFeatureCompatibilityVersion", "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { "$ref" : "#/components/parameters/groupId" }, { - "$ref" : "#/components/parameters/envelope" + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + } } ], "responses" : { - "200" : { + "204" : { "content" : { - "application/vnd.atlas.2023-11-15+json" : { + "application/vnd.atlas.2024-05-30+json" : { "schema" : { "$ref" : "#/components/schemas/NoBody" }, - "x-xgen-version" : "2023-11-15" + "x-xgen-version" : "2024-05-30" } }, - "description" : "Succeeded" + "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" @@ -9269,94 +9467,224 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Return all metric names", - "tags" : [ "Collection Level Metrics" ] + "summary" : "Unpins FCV for One Cluster from One Project", + "tags" : [ "Clusters" ] } }, - "/api/atlas/v2/groups/{groupId}/containers" : { + "/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz" : { "get" : { - "description" : "Returns details about all network peering containers in the specified project for the specified cloud provider. If you do not specify the cloud provider, MongoDB Cloud returns details about all network peering containers in the project for Amazon Web Services (AWS). To use this resource, the requesting API Key must have the Project Read Only role.", - "operationId" : "listPeeringContainerByCloudProvider", + "description" : "Returns a compressed (.gz) log file that contains a range of log messages for the specified host for the specified project. MongoDB updates process and audit logs from the cluster backend infrastructure every five minutes and contain log data from the previous five minutes. If you poll the API for log files, we recommend polling every five minutes. For example, if the logs are updated at 4:00 UTC and then you poll the API, the API returns log data from the interval between 3:55 UTC and 4:00 UTC. This feature isn't available for `M0` free clusters, `M2`, `M5`, or serverless clusters. To use this resource, the requesting API Key must have the Project Data Access Read Only or higher role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: \"Accept: application/vnd.atlas.YYYY-MM-DD+gzip\". Deprecated versions: v2-{2023-01-01}", + "operationId" : "getHostLogs", "parameters" : [ { "$ref" : "#/components/parameters/envelope" }, { "$ref" : "#/components/parameters/groupId" }, { - "$ref" : "#/components/parameters/includeCount" - }, { - "$ref" : "#/components/parameters/itemsPerPage" - }, { - "$ref" : "#/components/parameters/pageNum" - }, { - "$ref" : "#/components/parameters/pretty" - }, { - "description" : "Cloud service provider that serves the desired network peering containers.", - "in" : "query", - "name" : "providerName", + "description" : "Human-readable label that identifies the host that stores the log files that you want to download.", + "in" : "path", + "name" : "hostName", "required" : true, "schema" : { "type" : "string", - "default" : "AWS", - "enum" : [ "AWS", "AZURE", "GCP" ] + "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]+)?$" } - } ], - "responses" : { - "200" : { - "content" : { - "application/vnd.atlas.2023-01-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/PaginatedCloudProviderContainerView" - }, - "x-xgen-version" : "2023-01-01" - } - }, - "description" : "OK" - }, - "401" : { - "$ref" : "#/components/responses/unauthorized" - }, - "404" : { - "$ref" : "#/components/responses/notFound" - }, - "500" : { - "$ref" : "#/components/responses/internalServerError" + }, { + "description" : "Human-readable label that identifies the log file that you want to return. To return audit logs, enable *Database Auditing* for the specified project.", + "in" : "path", + "name" : "logName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "mongodb", "mongos", "mongodb-audit-log", "mongos-audit-log" ], + "externalDocs" : { + "description" : "Set up Database Auditing", + "url" : "https://docs.atlas.mongodb.com/database-auditing/" + } } - }, - "security" : [ { - "DigestAuth" : [ ] - } ], - "summary" : "Return All Network Peering Containers in One Project for One Cloud Provider", - "tags" : [ "Network Peering" ] - }, - "post" : { - "description" : "Creates one new network peering container in the specified project. MongoDB Cloud can deploy Network Peering connections in a network peering container. GCP can have one container per project. AWS and Azure can have one container per cloud provider region. To use this resource, the requesting API Key must have the Project Owner role.", - "operationId" : "createPeeringContainer", - "parameters" : [ { - "$ref" : "#/components/parameters/envelope" }, { - "$ref" : "#/components/parameters/groupId" + "description" : "Specifies the date and time for the ending point of the range of log messages to retrieve, in the number of seconds that have elapsed since the UNIX epoch. This value will default to 24 hours after the start date. If the start date is also unspecified, the value will default to the time of the request.", + "in" : "query", + "name" : "endDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600 + } }, { - "$ref" : "#/components/parameters/pretty" + "description" : "Specifies the date and time for the starting point of the range of log messages to retrieve, in the number of seconds that have elapsed since the UNIX epoch. This value will default to 24 hours prior to the end date. If the end date is also unspecified, the value will default to 24 hours prior to the time of the request.", + "in" : "query", + "name" : "startDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600 + } } ], - "requestBody" : { - "content" : { - "application/vnd.atlas.2023-01-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/CloudProviderContainer" - } - } - }, - "description" : "Creates one new network peering container in the specified project.", - "required" : true - }, "responses" : { "200" : { "content" : { - "application/vnd.atlas.2023-01-01+json" : { + "application/vnd.atlas.2023-02-01+gzip" : { "schema" : { - "$ref" : "#/components/schemas/CloudProviderContainer" + "type" : "string", + "format" : "binary", + "description" : "Compressed (.gz) log file that contains a range of log messages for the specified host for the specified project" }, - "x-xgen-version" : "2023-01-01" + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Download Logs for One Cluster Host in One Project", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/api/atlas/v2/groups/{groupId}/collStats/metrics" : { + "get" : { + "description" : "Returns all available Coll Stats Latency metric names and their respective units for the specified project at the time of request.", + "operationId" : "getCollStatsLatencyNamespaceMetrics", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "Succeeded" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return all metric names", + "tags" : [ "Collection Level Metrics" ] + } + }, + "/api/atlas/v2/groups/{groupId}/containers" : { + "get" : { + "description" : "Returns details about all network peering containers in the specified project for the specified cloud provider. If you do not specify the cloud provider, MongoDB Cloud returns details about all network peering containers in the project for Amazon Web Services (AWS). To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "listPeeringContainerByCloudProvider", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that serves the desired network peering containers.", + "in" : "query", + "name" : "providerName", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudProviderContainerView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Network Peering Containers in One Project for One Cloud Provider", + "tags" : [ "Network Peering" ] + }, + "post" : { + "description" : "Creates one new network peering container in the specified project. MongoDB Cloud can deploy Network Peering connections in a network peering container. GCP can have one container per project. AWS and Azure can have one container per cloud provider region. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "createPeeringContainer", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + } + } + }, + "description" : "Creates one new network peering container in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, + "x-xgen-version" : "2023-01-01" } }, "description" : "OK" @@ -10991,7 +11319,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Date and time when to stop retrieving database history. If you specify **end**, you must also specify **start**. This parameter uses UNIX epoch time in milliseconds.", @@ -11254,6 +11582,12 @@ "$ref" : "#/components/parameters/pretty" }, { "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" }, { "description" : "Human-readable label that identifies the cloud provider for the private endpoints to return.", "in" : "path", @@ -11376,17 +11710,6 @@ "pattern" : "^([a-f0-9]{24})$" } } ], - "requestBody" : { - "content" : { - "application/vnd.atlas.2023-01-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/EncryptionAtRestPrivateEndpointRequest" - } - } - }, - "description" : "Cloud provider of the private endpoints to delete and the list of cloud provider regions in which to delete the private endpoints.", - "required" : true - }, "responses" : { "204" : { "content" : { @@ -11457,6 +11780,9 @@ "403" : { "$ref" : "#/components/responses/forbidden" }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, "500" : { "$ref" : "#/components/responses/internalServerError" } @@ -11494,7 +11820,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, "style" : "form" @@ -11631,6 +11957,327 @@ "tags" : [ "Events" ] } }, + "/api/atlas/v2/groups/{groupId}/flexClusters" : { + "get" : { + "description" : "Returns details for all flex clusters in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "listFlexClusters", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedFlexClusters20250101" + }, + "x-xgen-version" : "2025-01-01" + } + }, + "description" : "OK" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Flex Clusters from One Project", + "tags" : [ "Flex Clusters" ] + }, + "post" : { + "description" : "Creates one flex cluster in the specified project. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "createFlexcluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/FlexClusterDescriptionCreate20250101" + } + } + }, + "description" : "Create One Flex Cluster in One Project.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/FlexClusterDescription20250101" + }, + "x-xgen-version" : "2025-01-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Flex Cluster in One Project", + "tags" : [ "Flex Clusters" ] + } + }, + "/api/atlas/v2/groups/{groupId}/flexClusters/{name}" : { + "delete" : { + "description" : "Removes one flex cluster from the specified project. The flex cluster must have termination protection disabled in order to be deleted. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "deleteFlexCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the flex cluster.", + "in" : "path", + "name" : "name", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2025-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Flex Cluster from One Project", + "tags" : [ "Flex Clusters" ] + }, + "get" : { + "description" : "Returns details for one flex cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "getFlexCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the flex cluster.", + "in" : "path", + "name" : "name", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/FlexClusterDescription20250101" + }, + "x-xgen-version" : "2025-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Flex Cluster from One Project", + "tags" : [ "Flex Clusters" ] + }, + "patch" : { + "description" : "Updates one flex cluster in the specified project. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "updateFlexCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the flex cluster.", + "in" : "path", + "name" : "name", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/FlexClusterDescription20250101" + } + } + }, + "description" : "Update One Flex Cluster in One Project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/FlexClusterDescription20250101" + }, + "x-xgen-version" : "2025-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Flex Cluster in One Project", + "tags" : [ "Flex Clusters" ] + } + }, + "/api/atlas/v2/groups/{groupId}/flexClusters:tenantUpgrade" : { + "post" : { + "description" : "Upgrades a flex cluster in the specified project. To use this resource, the requesting API key must have the Project Cluster Manager role.", + "operationId" : "upgradeFlexCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/FlexClusterDescription20250101" + } + } + }, + "description" : "Details of the flex cluster upgrade in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/FlexClusterDescription20250101" + }, + "x-xgen-version" : "2025-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Upgrade One Flex Cluster", + "tags" : [ "Flex Clusters" ] + } + }, "/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics" : { "get" : { "description" : "Returns all Atlas Search metric types available for one process in the specified project. You must have the Project Read Only or higher role to view the Atlas Search metric types.", @@ -12212,7 +12859,7 @@ } ], "summary" : "Return All Project Invitations", "tags" : [ "Projects" ], - "x-sunset" : "2024-10-04" + "x-sunset" : "2024-11-04" }, "patch" : { "deprecated" : true, @@ -12266,7 +12913,7 @@ } ], "summary" : "Update One Project Invitation", "tags" : [ "Projects" ], - "x-sunset" : "2024-10-04" + "x-sunset" : "2024-11-04" }, "post" : { "deprecated" : true, @@ -12314,7 +12961,7 @@ } ], "summary" : "Invite One MongoDB Cloud User to Join One Project", "tags" : [ "Projects" ], - "x-sunset" : "2024-10-04" + "x-sunset" : "2024-11-04" } }, "/api/atlas/v2/groups/{groupId}/invites/{invitationId}" : { @@ -12362,7 +13009,7 @@ } ], "summary" : "Cancel One Project Invitation", "tags" : [ "Projects" ], - "x-sunset" : "2024-10-04" + "x-sunset" : "2024-11-04" }, "get" : { "deprecated" : true, @@ -12413,7 +13060,7 @@ } ], "summary" : "Return One Project Invitation", "tags" : [ "Projects" ], - "x-sunset" : "2024-10-04" + "x-sunset" : "2024-11-04" }, "patch" : { "deprecated" : true, @@ -12476,7 +13123,7 @@ } ], "summary" : "Update One Project Invitation by Invitation ID", "tags" : [ "Projects" ], - "x-sunset" : "2024-10-04" + "x-sunset" : "2024-11-04" } }, "/api/atlas/v2/groups/{groupId}/ipAddresses" : { @@ -12573,13 +13220,13 @@ "description" : "Removes the specified project limit. Depending on the limit, Atlas either resets the limit to its default value or removes the limit entirely. To use this resource, the requesting API Key must have the Project Owner role.", "operationId" : "deleteProjectLimit", "parameters" : [ { - "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", + "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| 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 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n| atlas.project.deployment.salesSoldM0s | Limit on the number of M0 clusters in this project if the org is sales-sold | 100 | 100 |\n", "in" : "path", "name" : "limitName", "required" : true, "schema" : { "type" : "string", - "enum" : [ "atlas.project.security.databaseAccess.users", "atlas.project.deployment.clusters", "atlas.project.deployment.serverlessMTMs", "atlas.project.security.databaseAccess.customRoles", "atlas.project.security.networkAccess.entries", "atlas.project.security.networkAccess.crossRegionEntries", "atlas.project.deployment.nodesPerPrivateLinkRegion", "dataFederation.bytesProcessed.query", "dataFederation.bytesProcessed.daily", "dataFederation.bytesProcessed.weekly", "dataFederation.bytesProcessed.monthly", "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", "atlas.project.deployment.privateServiceConnectionsSubnetMask" ] + "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" @@ -12623,13 +13270,13 @@ "description" : "Returns the specified limit for the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "getProjectLimit", "parameters" : [ { - "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", + "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| 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 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n| atlas.project.deployment.salesSoldM0s | Limit on the number of M0 clusters in this project if the org is sales-sold | 100 | 100 |\n", "in" : "path", "name" : "limitName", "required" : true, "schema" : { "type" : "string", - "enum" : [ "atlas.project.security.databaseAccess.users", "atlas.project.deployment.clusters", "atlas.project.deployment.serverlessMTMs", "atlas.project.security.databaseAccess.customRoles", "atlas.project.security.networkAccess.entries", "atlas.project.security.networkAccess.crossRegionEntries", "atlas.project.deployment.nodesPerPrivateLinkRegion", "dataFederation.bytesProcessed.query", "dataFederation.bytesProcessed.daily", "dataFederation.bytesProcessed.weekly", "dataFederation.bytesProcessed.monthly", "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", "atlas.project.deployment.privateServiceConnectionsSubnetMask" ] + "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" @@ -12676,13 +13323,13 @@ "description" : "Sets the specified project limit. To use this resource, the requesting API Key must have the Project Owner role.\n\n**NOTE**: Increasing the following configuration limits might lead to slower response times in the MongoDB Cloud UI or increased user management overhead leading to authentication or authorization re-architecture. If possible, we recommend that you create additional projects to gain access to more of these resources for a more sustainable growth pattern.", "operationId" : "setProjectLimit", "parameters" : [ { - "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", + "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| 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 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n| atlas.project.deployment.salesSoldM0s | Limit on the number of M0 clusters in this project if the org is sales-sold | 100 | 100 |\n", "in" : "path", "name" : "limitName", "required" : true, "schema" : { "type" : "string", - "enum" : [ "atlas.project.security.databaseAccess.users", "atlas.project.deployment.clusters", "atlas.project.deployment.serverlessMTMs", "atlas.project.security.databaseAccess.customRoles", "atlas.project.security.networkAccess.entries", "atlas.project.security.networkAccess.crossRegionEntries", "atlas.project.deployment.nodesPerPrivateLinkRegion", "dataFederation.bytesProcessed.query", "dataFederation.bytesProcessed.daily", "dataFederation.bytesProcessed.weekly", "dataFederation.bytesProcessed.monthly", "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", "atlas.project.deployment.privateServiceConnectionsSubnetMask" ] + "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" @@ -13665,6 +14312,7 @@ }, "/api/atlas/v2/groups/{groupId}/pipelines" : { "get" : { + "deprecated" : true, "description" : "Returns a list of Data Lake Pipelines. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "listPipelines", "parameters" : [ { @@ -13701,10 +14349,16 @@ "DigestAuth" : [ ] } ], "summary" : "Return All Data Lake Pipelines from One Project", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" }, "post" : { + "deprecated" : true, "description" : "Creates one Data Lake Pipeline.", + "externalDocs" : { + "description" : "Data Lake Pipelines are deprecated. Please see Data Lake Deprecation Guide.", + "url" : "https://dochub.mongodb.org/core/data-lake-deprecation" + }, "operationId" : "createPipeline", "parameters" : [ { "$ref" : "#/components/parameters/envelope" @@ -13751,11 +14405,13 @@ "DigestAuth" : [ ] } ], "summary" : "Create One Data Lake Pipeline", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}" : { "delete" : { + "deprecated" : true, "description" : "Removes one Data Lake Pipeline.", "operationId" : "deletePipeline", "parameters" : [ { @@ -13800,9 +14456,11 @@ "DigestAuth" : [ ] } ], "summary" : "Remove One Data Lake Pipeline", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" }, "get" : { + "deprecated" : true, "description" : "Returns the details of one Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "getPipeline", "parameters" : [ { @@ -13849,9 +14507,11 @@ "DigestAuth" : [ ] } ], "summary" : "Return One Data Lake Pipeline", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" }, "patch" : { + "deprecated" : true, "description" : "Updates one Data Lake Pipeline.", "operationId" : "updatePipeline", "parameters" : [ { @@ -13913,11 +14573,13 @@ "DigestAuth" : [ ] } ], "summary" : "Update One Data Lake Pipeline", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules" : { "get" : { + "deprecated" : true, "description" : "Returns a list of backup schedule policy items that you can use as a Data Lake Pipeline source. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "listPipelineSchedules", "parameters" : [ { @@ -13967,11 +14629,13 @@ "DigestAuth" : [ ] } ], "summary" : "Return Available Ingestion Schedules for One Data Lake Pipeline", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots" : { "get" : { + "deprecated" : true, "description" : "Returns a list of backup snapshots that you can use to trigger an on demand pipeline run. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "listPipelineSnapshots", "parameters" : [ { @@ -14033,11 +14697,13 @@ "DigestAuth" : [ ] } ], "summary" : "Return Available Backup Snapshots for One Data Lake Pipeline", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause" : { "post" : { + "deprecated" : true, "description" : "Pauses ingestion for a Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "pausePipeline", "parameters" : [ { @@ -14084,11 +14750,13 @@ "DigestAuth" : [ ] } ], "summary" : "Pause One Data Lake Pipeline", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume" : { "post" : { + "deprecated" : true, "description" : "Resumes ingestion for a Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "resumePipeline", "parameters" : [ { @@ -14135,11 +14803,13 @@ "DigestAuth" : [ ] } ], "summary" : "Resume One Data Lake Pipeline", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs" : { "get" : { + "deprecated" : true, "description" : "Returns a list of past Data Lake Pipeline runs. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "listPipelineRuns", "parameters" : [ { @@ -14201,11 +14871,13 @@ "DigestAuth" : [ ] } ], "summary" : "Return All Data Lake Pipeline Runs from One Project", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}" : { "delete" : { + "deprecated" : true, "description" : "Deletes dataset that Atlas generated during the specified pipeline run.", "operationId" : "deletePipelineRunDataset", "parameters" : [ { @@ -14264,9 +14936,11 @@ "DigestAuth" : [ ] } ], "summary" : "Delete Pipeline Run Dataset", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" }, "get" : { + "deprecated" : true, "description" : "Returns the details of one Data Lake Pipeline run within the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "getPipelineRun", "parameters" : [ { @@ -14325,11 +14999,13 @@ "DigestAuth" : [ ] } ], "summary" : "Return One Data Lake Pipeline Run", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger" : { "post" : { + "deprecated" : true, "description" : "Triggers a Data Lake Pipeline ingestion of a specified snapshot.", "operationId" : "triggerSnapshotIngestion", "parameters" : [ { @@ -14387,7 +15063,8 @@ "DigestAuth" : [ ] } ], "summary" : "Trigger on demand snapshot ingestion", - "tags" : [ "Data Lake Pipelines" ] + "tags" : [ "Data Lake Pipelines" ], + "x-sunset" : "2025-09-09" } }, "/api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService" : { @@ -14547,7 +15224,7 @@ "schema" : { "type" : "string", "maxLength" : 64, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -14600,7 +15277,7 @@ "schema" : { "type" : "string", "maxLength" : 64, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -14659,7 +15336,7 @@ "schema" : { "type" : "string", "maxLength" : 64, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be removed.", @@ -14716,7 +15393,7 @@ "schema" : { "type" : "string", "maxLength" : 64, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the tenant endpoint.", @@ -14773,7 +15450,7 @@ "schema" : { "type" : "string", "maxLength" : 64, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be updated.", @@ -15949,7 +16626,7 @@ "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" ] + "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" ] }, "maxItems" : 10, "minItems" : 1, @@ -16028,7 +16705,7 @@ "items" : { "type" : "string", "description" : "One measurement requested for this MongoDB process.", - "enum" : [ "ASSERT_MSG", "ASSERT_REGULAR", "ASSERT_USER", "ASSERT_WARNING", "BACKGROUND_FLUSH_AVG", "CACHE_BYTES_READ_INTO", "CACHE_BYTES_WRITTEN_FROM", "CACHE_DIRTY_BYTES", "CACHE_USED_BYTES", "COMPUTED_MEMORY", "CONNECTIONS", "CURSORS_TOTAL_OPEN", "CURSORS_TOTAL_TIMED_OUT", "DB_DATA_SIZE_TOTAL", "DB_STORAGE_TOTAL", "DOCUMENT_METRICS_DELETED", "DOCUMENT_METRICS_INSERTED", "DOCUMENT_METRICS_RETURNED", "DOCUMENT_METRICS_UPDATED", "EXTRA_INFO_PAGE_FAULTS", "FTS_DISK_UTILIZATION", "FTS_MEMORY_MAPPED", "FTS_MEMORY_RESIDENT", "FTS_MEMORY_VIRTUAL", "FTS_PROCESS_CPU_KERNEL", "FTS_PROCESS_CPU_USER", "FTS_PROCESS_NORMALIZED_CPU_KERNEL", "FTS_PROCESS_NORMALIZED_CPU_USER", "GLOBAL_ACCESSES_NOT_IN_MEMORY", "GLOBAL_LOCK_CURRENT_QUEUE_READERS", "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL", "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS", "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN", "INDEX_COUNTERS_BTREE_ACCESSES", "INDEX_COUNTERS_BTREE_HITS", "INDEX_COUNTERS_BTREE_MISS_RATIO", "INDEX_COUNTERS_BTREE_MISSES", "JOURNALING_COMMITS_IN_WRITE_LOCK", "JOURNALING_MB", "JOURNALING_WRITE_DATA_FILES_MB", "MAX_PROCESS_CPU_CHILDREN_KERNEL", "MAX_PROCESS_CPU_CHILDREN_USER", "MAX_PROCESS_CPU_KERNEL", "MAX_PROCESS_CPU_USER", "MAX_PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL", "MAX_PROCESS_NORMALIZED_CPU_CHILDREN_USER", "MAX_PROCESS_NORMALIZED_CPU_KERNEL", "MAX_PROCESS_NORMALIZED_CPU_USER", "MAX_SWAP_USAGE_FREE", "MAX_SWAP_USAGE_USED ", "MAX_SYSTEM_CPU_GUEST", "MAX_SYSTEM_CPU_IOWAIT", "MAX_SYSTEM_CPU_IRQ", "MAX_SYSTEM_CPU_KERNEL", "MAX_SYSTEM_CPU_SOFTIRQ", "MAX_SYSTEM_CPU_STEAL", "MAX_SYSTEM_CPU_USER", "MAX_SYSTEM_MEMORY_AVAILABLE", "MAX_SYSTEM_MEMORY_FREE", "MAX_SYSTEM_MEMORY_USED", "MAX_SYSTEM_NETWORK_IN", "MAX_SYSTEM_NETWORK_OUT", "MAX_SYSTEM_NORMALIZED_CPU_GUEST", "MAX_SYSTEM_NORMALIZED_CPU_IOWAIT", "MAX_SYSTEM_NORMALIZED_CPU_IRQ", "MAX_SYSTEM_NORMALIZED_CPU_KERNEL", "MAX_SYSTEM_NORMALIZED_CPU_NICE", "MAX_SYSTEM_NORMALIZED_CPU_SOFTIRQ", "MAX_SYSTEM_NORMALIZED_CPU_STEAL", "MAX_SYSTEM_NORMALIZED_CPU_USER", "MEMORY_MAPPED", "MEMORY_RESIDENT", "MEMORY_VIRTUAL", "NETWORK_BYTES_IN", "NETWORK_BYTES_OUT", "NETWORK_NUM_REQUESTS", "OP_EXECUTION_TIME_COMMANDS", "OP_EXECUTION_TIME_READS", "OP_EXECUTION_TIME_WRITES", "OPCOUNTER_CMD", "OPCOUNTER_DELETE", "OPCOUNTER_GETMORE", "OPCOUNTER_INSERT", "OPCOUNTER_QUERY", "OPCOUNTER_REPL_CMD", "OPCOUNTER_REPL_DELETE", "OPCOUNTER_REPL_INSERT", "OPCOUNTER_REPL_UPDATE", "OPCOUNTER_UPDATE", "OPERATIONS_SCAN_AND_ORDER", "OPLOG_MASTER_LAG_TIME_DIFF", "OPLOG_MASTER_TIME", "OPLOG_RATE_GB_PER_HOUR", "OPLOG_SLAVE_LAG_MASTER_TIME", "OPLOG_REPLICATION_LAG", "PROCESS_CPU_CHILDREN_KERNEL", "PROCESS_CPU_CHILDREN_USER", "PROCESS_CPU_KERNEL", "PROCESS_CPU_USER", "PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL", "PROCESS_NORMALIZED_CPU_CHILDREN_USER", "PROCESS_NORMALIZED_CPU_KERNEL", "PROCESS_NORMALIZED_CPU_USER", "QUERY_EXECUTOR_SCANNED", "QUERY_EXECUTOR_SCANNED_OBJECTS", "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED", "QUERY_TARGETING_SCANNED_PER_RETURNED", "RESTARTS_IN_LAST_HOUR", "SWAP_USAGE_FREE", "SWAP_USAGE_USED", "SYSTEM_CPU_GUEST", "SYSTEM_CPU_IOWAIT", "SYSTEM_CPU_IRQ", "SYSTEM_CPU_KERNEL", "SYSTEM_CPU_NICE", "SYSTEM_CPU_SOFTIRQ", "SYSTEM_CPU_STEAL", "SYSTEM_CPU_USER", "SYSTEM_MEMORY_AVAILABLE", "SYSTEM_MEMORY_FREE", "SYSTEM_MEMORY_USED", "SYSTEM_NETWORK_IN", "SYSTEM_NETWORK_OUT", "SYSTEM_NORMALIZED_CPU_GUEST", "SYSTEM_NORMALIZED_CPU_IOWAIT", "SYSTEM_NORMALIZED_CPU_IRQ", "SYSTEM_NORMALIZED_CPU_KERNEL", "SYSTEM_NORMALIZED_CPU_NICE", "SYSTEM_NORMALIZED_CPU_SOFTIRQ", "SYSTEM_NORMALIZED_CPU_STEAL", "SYSTEM_NORMALIZED_CPU_USER", "TICKETS_AVAILABLE_READS", "TICKETS_AVAILABLE_WRITE", "OPERATION_THROTTLING_REJECTED_OPERATIONS" ] + "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_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" ] }, "maxItems" : 10, "minItems" : 1, @@ -16598,7 +17275,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -16799,7 +17476,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -16848,7 +17525,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -16916,7 +17593,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the restore job to return.", @@ -16984,7 +17661,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -17033,7 +17710,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -17092,7 +17769,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "$ref" : "#/components/parameters/envelope" @@ -17138,7 +17815,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Value that we want to set for the Serverless Auto Indexing toggle.", @@ -17196,20 +17873,20 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { - "204" : { + "202" : { "content" : { "application/vnd.atlas.2023-01-01+json" : { "schema" : { - "$ref" : "#/components/schemas/NoBody" + "$ref" : "#/components/schemas/RequestAccepted" }, "x-xgen-version" : "2023-01-01" } }, - "description" : "This endpoint does not return a response body." + "description" : "Accepted" }, "400" : { "$ref" : "#/components/responses/badRequest" @@ -17248,7 +17925,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -17300,7 +17977,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -17345,7 +18022,7 @@ }, "/api/atlas/v2/groups/{groupId}/serviceAccounts" : { "get" : { - "description" : "Returns list of Service Accounts for a project with service account details.", + "description" : "Returns all Service Accounts for the specified Project. Available as a preview feature.", "operationId" : "listProjectServiceAccounts", "parameters" : [ { "$ref" : "#/components/parameters/groupId" @@ -17361,11 +18038,11 @@ "responses" : { "200" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { "$ref" : "#/components/schemas/PaginatedGroupServiceAccounts" }, - "x-xgen-version" : "2023-10-01" + "x-xgen-version" : "2024-08-05" } }, "description" : "OK" @@ -17383,11 +18060,11 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Return All project Service Accounts", - "tags" : [ "Groups" ] + "summary" : "List All Project Service Accounts", + "tags" : [ "Service Accounts" ] }, "post" : { - "description" : "Creates and assigns the specified Service Account to the specified Project.", + "description" : "Creates one Service Account for the specified Project. The Service Account will automatically be added as an Organization Member to the Organization that the specified Project is a part of. Available as a preview feature.", "operationId" : "createProjectServiceAccount", "parameters" : [ { "$ref" : "#/components/parameters/groupId" @@ -17398,24 +18075,24 @@ } ], "requestBody" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { "$ref" : "#/components/schemas/GroupServiceAccountRequest" }, - "x-xgen-version" : "2023-10-01" + "x-xgen-version" : "2024-08-05" } }, - "description" : "Details to create service account and add to the specified project.", + "description" : "Details of the new Service Account.", "required" : true }, "responses" : { "201" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { "$ref" : "#/components/schemas/GroupServiceAccount" }, - "x-xgen-version" : "2023-10-01" + "x-xgen-version" : "2024-08-05" } }, "description" : "Created" @@ -17433,21 +18110,23 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Create and Assign one Service Account to one project", - "tags" : [ "Groups" ] + "summary" : "Create and Assign one Service Account to one Project", + "tags" : [ "Service Accounts" ] } }, - "/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}" : { + "/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}" : { "delete" : { - "description" : "Removes one Service Account from the specified project.", + "description" : "Removes the specified Service Account from the specified project. The Service Account will still be a part of the Organization it was created in, and the credentials will remain active until expired or manually revoked. Available as a preview feature.", "operationId" : "deleteProjectServiceAccount", "parameters" : [ { - "description" : "Id of the service account.", + "description" : "The Client ID of the Service Account.", "in" : "path", - "name" : "serviceAccountId", + "name" : "clientId", "required" : true, "schema" : { - "type" : "string" + "type" : "string", + "example" : "mdb_sa_id_667066535bc75b03c37b3038", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" } }, { "$ref" : "#/components/parameters/groupId" @@ -17459,15 +18138,15 @@ "responses" : { "204" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { "$ref" : "#/components/schemas/NoBody" }, - "x-xgen-version" : "2023-10-01" + "x-xgen-version" : "2024-08-05" } }, "description" : "This endpoint does not return a response body.", - "x-xgen-version" : "2023-10-01" + "x-xgen-version" : "2024-08-05" }, "401" : { "$ref" : "#/components/responses/unauthorized" @@ -17482,21 +18161,23 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Unassign One Service Account from One Project.", - "tags" : [ "Groups" ] + "summary" : "Unassign One Service Account from One Project", + "tags" : [ "Service Accounts" ] }, "get" : { - "description" : "Get project Service Account Details.", + "description" : "Returns one Service Account in the specified Project. Available as a preview feature.", "operationId" : "getProjectServiceAccount", "parameters" : [ { "$ref" : "#/components/parameters/groupId" }, { - "description" : "Id of the service account.", + "description" : "The Client ID of the Service Account.", "in" : "path", - "name" : "serviceAccountId", + "name" : "clientId", "required" : true, "schema" : { - "type" : "string" + "type" : "string", + "example" : "mdb_sa_id_667066535bc75b03c37b3038", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" } }, { "$ref" : "#/components/parameters/envelope" @@ -17506,11 +18187,11 @@ "responses" : { "200" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { "$ref" : "#/components/schemas/GroupServiceAccount" }, - "x-xgen-version" : "2023-10-01" + "x-xgen-version" : "2024-08-05" } }, "description" : "OK" @@ -17528,19 +18209,21 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Service Account Fetching", - "tags" : [ "Groups" ] + "summary" : "Get one Project Service Account", + "tags" : [ "Service Accounts" ] }, "patch" : { - "description" : "Update Service Account in Project.", + "description" : "Updates one Service Account in the specified Project. Available as a preview feature.", "operationId" : "updateProjectServiceAccount", "parameters" : [ { - "description" : "Id of the service account.", + "description" : "The Client ID of the Service Account.", "in" : "path", - "name" : "serviceAccountId", + "name" : "clientId", "required" : true, "schema" : { - "type" : "string" + "type" : "string", + "example" : "mdb_sa_id_667066535bc75b03c37b3038", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" } }, { "$ref" : "#/components/parameters/groupId" @@ -17551,23 +18234,23 @@ } ], "requestBody" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { "$ref" : "#/components/schemas/GroupServiceAccountUpdateRequest" } } }, - "description" : "Details to update service account in the specified Project.", + "description" : "The new details for the Service Account.", "required" : true }, "responses" : { "200" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { "$ref" : "#/components/schemas/GroupServiceAccount" }, - "x-xgen-version" : "2023-10-01" + "x-xgen-version" : "2024-08-05" } }, "description" : "OK" @@ -17588,19 +18271,208 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Service Account Update in Project", - "tags" : [ "Groups" ] + "summary" : "Update one Project Service Account", + "tags" : [ "Service Accounts" ] + } + }, + "/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList" : { + "get" : { + "description" : "Returns all access list entries that you configured for the specified Service Account for the project. Available as a preview feature.", + "operationId" : "listProjectServiceAccountAccessList", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "The Client ID of the Service Account.", + "in" : "path", + "name" : "clientId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mdb_sa_id_667066535bc75b03c37b3038", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedServiceAccountIPAccessEntryView" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Access List entries for one Project Service Account", + "tags" : [ "Service Accounts" ] }, "post" : { - "description" : "Assigns the specified organization Service Account to the specified project.", + "description" : "Add Access List Entries for the specified Service Account for the project. Resources require all API requests to originate from IP addresses on the API access list. Available as a preview feature.", + "operationId" : "createProjectServiceAccountAccessList", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "The Client ID of the Service Account.", + "in" : "path", + "name" : "clientId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mdb_sa_id_667066535bc75b03c37b3038", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ServiceAccountIPAccessListEntry" + } + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "A list of access list entries to add to the access list of the specified Service Account for the project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedServiceAccountIPAccessEntryView" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add Access List entries for one Project Service Account", + "tags" : [ "Service Accounts" ] + } + }, + "/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList/{ipAddress}" : { + "delete" : { + "description" : "Removes the specified access list entry from the specified Service Account for the project. You can't remove the requesting IP address from the access list. Available as a preview feature.", + "operationId" : "deleteProjectServiceAccountAccessListEntry", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "The Client ID of the Service Account.", + "in" : "path", + "name" : "clientId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mdb_sa_id_667066535bc75b03c37b3038", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + } + }, { + "description" : "One IP address or multiple IP addresses represented as one CIDR block. When specifying a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /.", + "in" : "path", + "name" : "ipAddress", + "required" : true, + "schema" : { + "type" : "string", + "example" : "192.0.2.0%2F24", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})?$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Access List entry from one Project Service Account", + "tags" : [ "Service Accounts" ] + } + }, + "/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}:invite" : { + "post" : { + "description" : "Assigns the specified Service Account to the specified Project. Available as a preview feature.", "operationId" : "addProjectServiceAccount", "parameters" : [ { - "description" : "Id of the service account.", + "description" : "The Client ID of the Service Account.", "in" : "path", - "name" : "serviceAccountId", + "name" : "clientId", "required" : true, "schema" : { - "type" : "string" + "type" : "string", + "example" : "mdb_sa_id_667066535bc75b03c37b3038", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" } }, { "$ref" : "#/components/parameters/groupId" @@ -17611,31 +18483,30 @@ } ], "requestBody" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/GroupServiceAccountRoleAssignment" } }, - "x-xgen-version" : "2023-10-01" + "x-xgen-version" : "2024-08-05" } }, - "description" : "Service Account Roles to be assigned to the specified project.", + "description" : "The Project permissions for the Service Account in the specified Project.", "required" : true }, "responses" : { - "204" : { + "200" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { - "$ref" : "#/components/schemas/NoBody" + "$ref" : "#/components/schemas/GroupServiceAccount" }, - "x-xgen-version" : "2023-10-01" + "x-xgen-version" : "2024-08-05" } }, - "description" : "This endpoint does not return a response body.", - "x-xgen-version" : "2023-10-01" + "description" : "OK" }, "401" : { "$ref" : "#/components/responses/unauthorized" @@ -17651,7 +18522,7 @@ "DigestAuth" : [ ] } ], "summary" : "Assign One Service Account to One Project", - "tags" : [ "Groups" ] + "tags" : [ "Service Accounts" ] } }, "/api/atlas/v2/groups/{groupId}/settings" : { @@ -17845,10 +18716,112 @@ } } }, - "/api/atlas/v2/groups/{groupId}/streams/{tenantName}" : { + "/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections" : { + "get" : { + "description" : "Returns all Private Link connections for the specified project.To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role.", + "operationId" : "listPrivateLinkConnections", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiStreamsPrivateLinkView" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Private Link", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2024-10-02" : "The MongoDB Atlas Streams Processing Private Link API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "post" : { + "description" : "Creates one Private Link in the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Stream Processing Owner role.", + "operationId" : "createPrivateLinkConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsPrivateLinkConnection" + } + } + }, + "description" : "Details to create one Private Link connection for a project. project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsPrivateLinkConnection" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "409" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Private Link connection", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2024-10-02" : "The MongoDB Atlas Streams Processing Private Link API is now exposed as part of private preview, but is subject to change until GA." + } + } + }, + "/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections/{connectionId}" : { "delete" : { - "description" : "Delete one stream instance in the specified project. To use this resource, the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role.", - "operationId" : "deleteStreamInstance", + "description" : "Deletes one Private Link in the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Stream Processing Owner role.", + "operationId" : "deletePrivateLinkConnection", "parameters" : [ { "$ref" : "#/components/parameters/envelope" }, { @@ -17856,9 +18829,306 @@ }, { "$ref" : "#/components/parameters/groupId" }, { - "description" : "Human-readable label that identifies the stream instance to delete.", + "description" : "Unique ID that identifies the Private Link connection.", "in" : "path", - "name" : "tenantName", + "name" : "connectionId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Accepted" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete One Private Link connection", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2024-10-02" : "The MongoDB Atlas Streams Processing Private Link API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "get" : { + "description" : "Returns the details of one Private Link connection within the project. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "getPrivateLinkConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique ID that identifies the Private Link connection.", + "in" : "path", + "name" : "connectionId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsPrivateLinkConnection" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One PrivateLink Connection", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2024-10-02" : "The MongoDB Atlas Streams Processing Private Link API is now exposed as part of private preview, but is subject to change until GA." + } + } + }, + "/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections" : { + "get" : { + "description" : "Returns a list of incoming VPC Peering Connections.", + "operationId" : "getVPCPeeringConnections", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All VPC Peering Connections.", + "tags" : [ "Streams" ] + } + }, + "/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}" : { + "delete" : { + "description" : "Deletes an incoming VPC Peering connection.", + "operationId" : "deleteVPCPeeringConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "The VPC Peering Connection id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Accepted" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Deletes an incoming VPC Peering connection.", + "tags" : [ "Streams" ] + } + }, + "/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:accept" : { + "post" : { + "description" : "Requests the acceptance of an incoming VPC Peering connection.", + "operationId" : "acceptVPCPeeringConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "The VPC Peering Connection id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/VPCPeeringActionChallenge" + } + } + }, + "description" : "Challenge values for VPC Peering requester account ID, and requester VPC ID.", + "required" : true + }, + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Accepted" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Requests the acceptance of an incoming VPC Peering connection.", + "tags" : [ "Streams" ] + } + }, + "/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:reject" : { + "post" : { + "description" : "Requests the rejection of an incoming VPC Peering connection.", + "operationId" : "rejectVPCPeeringConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "The VPC Peering Connection id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Accepted" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Requests the rejection of an incoming VPC Peering connection.", + "tags" : [ "Streams" ] + } + }, + "/api/atlas/v2/groups/{groupId}/streams/{tenantName}" : { + "delete" : { + "description" : "Delete one stream instance in the specified project. To use this resource, the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role.", + "operationId" : "deleteStreamInstance", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance to delete.", + "in" : "path", + "name" : "tenantName", "required" : true, "schema" : { "type" : "string" @@ -18758,6 +20028,57 @@ "tags" : [ "Streams" ] } }, + "/api/atlas/v2/groups/{groupId}/streams:withSampleConnections" : { + "post" : { + "description" : "Creates one stream instance in the specified project with sample connections. To use this resource the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role.", + "operationId" : "createStreamInstanceWithSampleConnections", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantWithSampleConnections" + } + } + }, + "description" : "Details to create one streams instance in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsTenant" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Stream Instance With Sample Connections", + "tags" : [ "Streams" ] + } + }, "/api/atlas/v2/groups/{groupId}/teams" : { "get" : { "description" : "Returns all teams to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. All members of the team share the same project access. To use this resource, the requesting API Key must have the Project Read Only role.", @@ -19430,267 +20751,6 @@ "tags" : [ "Projects" ] } }, - "/api/atlas/v2/groups/{groupId}/uss" : { - "get" : { - "description" : "Returns details for all USS instances in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", - "operationId" : "listUSSInstances", - "parameters" : [ { - "$ref" : "#/components/parameters/envelope" - }, { - "$ref" : "#/components/parameters/groupId" - }, { - "$ref" : "#/components/parameters/includeCount" - }, { - "$ref" : "#/components/parameters/itemsPerPage" - }, { - "$ref" : "#/components/parameters/pageNum" - }, { - "$ref" : "#/components/parameters/pretty" - } ], - "responses" : { - "200" : { - "content" : { - "application/vnd.atlas.2025-01-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/PaginatedUSSInstance20250101" - }, - "x-xgen-version" : "2025-01-01" - } - }, - "description" : "OK" - }, - "409" : { - "$ref" : "#/components/responses/conflict" - }, - "500" : { - "$ref" : "#/components/responses/internalServerError" - } - }, - "security" : [ { - "DigestAuth" : [ ] - } ], - "summary" : "Return All USS Instances from One Project", - "tags" : [ "USS Instances" ] - }, - "post" : { - "description" : "Creates one USS instance in the specified project. To use this resource, the requesting API Key must have the Project Owner role.", - "operationId" : "createUSSInstance", - "parameters" : [ { - "$ref" : "#/components/parameters/envelope" - }, { - "$ref" : "#/components/parameters/groupId" - }, { - "$ref" : "#/components/parameters/pretty" - } ], - "requestBody" : { - "content" : { - "application/vnd.atlas.2025-01-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/USSInstanceDescriptionCreate20250101" - } - } - }, - "description" : "Create One USS Instance in One Project.", - "required" : true - }, - "responses" : { - "201" : { - "content" : { - "application/vnd.atlas.2025-01-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/USSInstanceDescription20250101" - }, - "x-xgen-version" : "2025-01-01" - } - }, - "description" : "Created" - }, - "400" : { - "$ref" : "#/components/responses/badRequest" - }, - "402" : { - "$ref" : "#/components/responses/paymentRequired" - }, - "409" : { - "$ref" : "#/components/responses/conflict" - }, - "500" : { - "$ref" : "#/components/responses/internalServerError" - } - }, - "security" : [ { - "DigestAuth" : [ ] - } ], - "summary" : "Create One USS Instance in One Project", - "tags" : [ "USS Instances" ] - } - }, - "/api/atlas/v2/groups/{groupId}/uss/{name}" : { - "delete" : { - "description" : "Removes one USS instance from the specified project. The USS instance must have termination protection disabled in order to be deleted. To use this resource, the requesting API Key must have the Project Owner role.", - "operationId" : "deleteUSSInstance", - "parameters" : [ { - "$ref" : "#/components/parameters/envelope" - }, { - "$ref" : "#/components/parameters/pretty" - }, { - "$ref" : "#/components/parameters/groupId" - }, { - "description" : "Human-readable label that identifies the USS instance.", - "in" : "path", - "name" : "name", - "required" : true, - "schema" : { - "type" : "string", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - } - } ], - "responses" : { - "204" : { - "content" : { - "application/vnd.atlas.2025-01-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/NoBody" - }, - "x-xgen-version" : "2025-01-01" - } - }, - "description" : "This endpoint does not return a response body." - }, - "400" : { - "$ref" : "#/components/responses/badRequest" - }, - "404" : { - "$ref" : "#/components/responses/notFound" - }, - "409" : { - "$ref" : "#/components/responses/conflict" - }, - "500" : { - "$ref" : "#/components/responses/internalServerError" - } - }, - "security" : [ { - "DigestAuth" : [ ] - } ], - "summary" : "Remove One USS Instance from One Project", - "tags" : [ "USS Instances" ] - }, - "get" : { - "description" : "Returns details for one USS instance in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", - "operationId" : "getUSSInstance", - "parameters" : [ { - "$ref" : "#/components/parameters/groupId" - }, { - "$ref" : "#/components/parameters/envelope" - }, { - "$ref" : "#/components/parameters/pretty" - }, { - "description" : "Human-readable label that identifies the USS instance.", - "in" : "path", - "name" : "name", - "required" : true, - "schema" : { - "type" : "string", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - } - } ], - "responses" : { - "200" : { - "content" : { - "application/vnd.atlas.2025-01-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/USSInstanceDescription20250101" - }, - "x-xgen-version" : "2025-01-01" - } - }, - "description" : "OK" - }, - "400" : { - "$ref" : "#/components/responses/badRequest" - }, - "404" : { - "$ref" : "#/components/responses/notFound" - }, - "409" : { - "$ref" : "#/components/responses/conflict" - }, - "500" : { - "$ref" : "#/components/responses/internalServerError" - } - }, - "security" : [ { - "DigestAuth" : [ ] - } ], - "summary" : "Return One USS Instance from One Project", - "tags" : [ "USS Instances" ] - }, - "patch" : { - "description" : "Updates one USS instance in the specified project. To use this resource, the requesting API Key must have the Project Owner role.", - "operationId" : "updateUSSInstance", - "parameters" : [ { - "$ref" : "#/components/parameters/envelope" - }, { - "$ref" : "#/components/parameters/groupId" - }, { - "$ref" : "#/components/parameters/pretty" - }, { - "description" : "Human-readable label that identifies the USS instance.", - "in" : "path", - "name" : "name", - "required" : true, - "schema" : { - "type" : "string", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - } - } ], - "requestBody" : { - "content" : { - "application/vnd.atlas.2025-01-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/USSInstanceDescription20250101" - } - } - }, - "description" : "Update One USS Instance in One Project.", - "required" : true - }, - "responses" : { - "200" : { - "content" : { - "application/vnd.atlas.2025-01-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/USSInstanceDescription20250101" - }, - "x-xgen-version" : "2025-01-01" - } - }, - "description" : "OK" - }, - "400" : { - "$ref" : "#/components/responses/badRequest" - }, - "402" : { - "$ref" : "#/components/responses/paymentRequired" - }, - "409" : { - "$ref" : "#/components/responses/conflict" - } - }, - "security" : [ { - "DigestAuth" : [ ] - } ], - "summary" : "Update One USS Instance in One Project", - "tags" : [ "USS Instances" ] - } - }, "/api/atlas/v2/groups/{groupId}:migrate" : { "post" : { "description" : "Migrates a project from its current organization to another organization. All project users and their roles will be copied to the same project in the destination organization. You must include an organization API key with the Organization Owner role for the destination organization to verify access to the destination organization when you authenticate with Programmatic API Keys. Otherwise, the requesting user must have the Organization Owner role in both organizations. To use this resource, the requesting API Key must have the Organization Owner role.", @@ -21439,7 +22499,7 @@ "tags" : [ "Invoices" ] } }, - "/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/lineItems/:search" : { + "/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/lineItems:search" : { "get" : { "description" : "Query the lineItems of the specified invoice and return the result JSON. A unique 24-hexadecimal digit string identifies the invoice.", "operationId" : "queryLineItemsFromSingleInvoice", @@ -21465,7 +22525,7 @@ } ], "requestBody" : { "content" : { - "application/vnd.atlas.2025-01-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { "$ref" : "#/components/schemas/ApiPublicUsageDetailsQueryRequest" } @@ -21477,11 +22537,11 @@ "responses" : { "200" : { "content" : { - "application/vnd.atlas.2025-01-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { "$ref" : "#/components/schemas/PaginatedPublicApiUsageDetailsLineItemView" }, - "x-xgen-version" : "2025-01-01" + "x-xgen-version" : "2024-08-05" } }, "description" : "OK" @@ -21633,9 +22693,440 @@ "tags" : [ "Cloud Migration Service" ] } }, + "/api/atlas/v2/orgs/{orgId}/nonCompliantResources" : { + "get" : { + "description" : "Return all non-compliant resources for an org.", + "externalDocs" : { + "description" : "Atlas Resource Policies", + "url" : "https://docs.atlas.mongodb.com" + }, + "operationId" : "getResourcesNonCompliant", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasNonCompliantResourceView" + } + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return all non-compliant resources", + "tags" : [ "Resource Policies" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/resourcePolicies" : { + "get" : { + "description" : "Return all Atlas Resource Policies for the org.", + "externalDocs" : { + "description" : "Atlas Resource Policies", + "url" : "https://docs.atlas.mongodb.com" + }, + "operationId" : "getAtlasResourcePolicies", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasResourcePolicyView" + } + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return all Atlas Resource Policies", + "tags" : [ "Resource Policies" ] + }, + "post" : { + "description" : "Create one Atlas Resource Policy for an org.", + "externalDocs" : { + "description" : "Atlas Resource Policies", + "url" : "https://docs.atlas.mongodb.com" + }, + "operationId" : "createAtlasResourcePolicy", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasResourcePolicyCreateView" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "Atlas Resource Policy to create.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasResourcePolicyView" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "Created" + }, + "400" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasInvalidResourcePolicyCreateErrorView" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "Bad request." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create one Atlas Resource Policy", + "tags" : [ "Resource Policies" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/resourcePolicies/{resourcePolicyId}" : { + "delete" : { + "description" : "Delete one Atlas Resource Policy for an org.", + "externalDocs" : { + "description" : "Atlas Resource Policies", + "url" : "https://docs.atlas.mongodb.com" + }, + "operationId" : "deleteAtlasResourcePolicy", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies an atlas resource policy.", + "in" : "path", + "name" : "resourcePolicyId", + "required" : true, + "schema" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the atlas resource policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete one Atlas Resource Policy", + "tags" : [ "Resource Policies" ] + }, + "get" : { + "description" : "Return one Atlas Resource Policy for an org.", + "externalDocs" : { + "description" : "Atlas Resource Policies", + "url" : "https://docs.atlas.mongodb.com" + }, + "operationId" : "getAtlasResourcePolicy", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies an atlas resource policy.", + "in" : "path", + "name" : "resourcePolicyId", + "required" : true, + "schema" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the atlas resource policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasResourcePolicyView" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return one Atlas Resource Policy", + "tags" : [ "Resource Policies" ] + }, + "patch" : { + "description" : "Update one Atlas Resource Policy for an org.", + "externalDocs" : { + "description" : "Atlas Resource Policies", + "url" : "https://docs.atlas.mongodb.com" + }, + "operationId" : "updateAtlasResourcePolicy", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies an atlas resource policy.", + "in" : "path", + "name" : "resourcePolicyId", + "required" : true, + "schema" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the atlas resource policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasResourcePolicyEditView" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "Atlas Resource Policy to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasResourcePolicyView" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "Ok" + }, + "400" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasInvalidResourcePolicyCreateErrorView" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "Bad request." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update one Atlas Resource Policy", + "tags" : [ "Resource Policies" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/resourcePolicies:validate" : { + "post" : { + "description" : "Validate one Atlas Resource Policy for an org.", + "externalDocs" : { + "description" : "Atlas Resource Policies", + "url" : "https://docs.atlas.mongodb.com" + }, + "operationId" : "validateAtlasResourcePolicy", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasResourcePolicyCreateView" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "Atlas Resource Policy to create.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasResourcePolicyView" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "Ok" + }, + "400" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasInvalidResourcePolicyCreateErrorView" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "Bad request." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Validate one Atlas Resource Policy", + "tags" : [ "Resource Policies" ] + } + }, "/api/atlas/v2/orgs/{orgId}/serviceAccounts" : { "get" : { - "description" : "Returns list of Service Accounts with service account details.", + "description" : "Returns all Service Accounts for the specified Organization. Available as a preview feature.", "operationId" : "listServiceAccounts", "parameters" : [ { "$ref" : "#/components/parameters/orgId" @@ -21651,11 +23142,11 @@ "responses" : { "200" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { "$ref" : "#/components/schemas/PaginatedOrgServiceAccounts" }, - "x-xgen-version" : "2023-10-01" + "x-xgen-version" : "2024-08-05" } }, "description" : "OK" @@ -21673,11 +23164,11 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Return All Service Accounts", - "tags" : [ "Organizations" ] + "summary" : "List All Organization Service Accounts", + "tags" : [ "Service Accounts" ] }, "post" : { - "description" : "Create Service Account containing client id and client secrets.", + "description" : "Creates one Service Account for the specified Organization. Available as a preview feature.", "operationId" : "createServiceAccount", "parameters" : [ { "$ref" : "#/components/parameters/orgId" @@ -21688,23 +23179,23 @@ } ], "requestBody" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { "$ref" : "#/components/schemas/OrgServiceAccountRequest" } } }, - "description" : "Details to create service account in the specified organization.", + "description" : "Details of the new Service Account.", "required" : true }, "responses" : { "201" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { "$ref" : "#/components/schemas/OrgServiceAccount" }, - "x-xgen-version" : "2023-10-01" + "x-xgen-version" : "2024-08-05" } }, "description" : "Created" @@ -21722,21 +23213,23 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Service Account Creation", - "tags" : [ "Organizations" ] + "summary" : "Create one Organization Service Account", + "tags" : [ "Service Accounts" ] } }, - "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}" : { + "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}" : { "delete" : { - "description" : "Delete Service Account.", + "description" : "Deletes the specified Service Account. Available as a preview feature.", "operationId" : "deleteServiceAccount", "parameters" : [ { - "description" : "Id of the service account.", + "description" : "The Client ID of the Service Account.", "in" : "path", - "name" : "serviceAccountId", + "name" : "clientId", "required" : true, "schema" : { - "type" : "string" + "type" : "string", + "example" : "mdb_sa_id_667066535bc75b03c37b3038", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" } }, { "$ref" : "#/components/parameters/orgId" @@ -21748,8 +23241,8 @@ "responses" : { "204" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "x-xgen-version" : "2023-10-01" + "application/vnd.atlas.2024-08-05+json" : { + "x-xgen-version" : "2024-08-05" } }, "description" : "This endpoint does not return a response body." @@ -21767,21 +23260,23 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Service Account Deletion.", - "tags" : [ "Organizations" ] + "summary" : "Delete one Organization Service Account", + "tags" : [ "Service Accounts" ] }, "get" : { - "description" : "Get Service Account Details.", + "description" : "Returns the specified Service Account. Available as a preview feature.", "operationId" : "getServiceAccount", "parameters" : [ { "$ref" : "#/components/parameters/orgId" }, { - "description" : "Id of the service account.", + "description" : "The Client ID of the Service Account.", "in" : "path", - "name" : "serviceAccountId", + "name" : "clientId", "required" : true, "schema" : { - "type" : "string" + "type" : "string", + "example" : "mdb_sa_id_667066535bc75b03c37b3038", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" } }, { "$ref" : "#/components/parameters/envelope" @@ -21791,11 +23286,11 @@ "responses" : { "200" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { "$ref" : "#/components/schemas/OrgServiceAccount" }, - "x-xgen-version" : "2023-10-01" + "x-xgen-version" : "2024-08-05" } }, "description" : "OK" @@ -21813,19 +23308,21 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Service Account Fetching", - "tags" : [ "Organizations" ] + "summary" : "Get one Organization Service Account", + "tags" : [ "Service Accounts" ] }, "patch" : { - "description" : "Update Service Account.", + "description" : "Updates the specified Service Account in the specified Organization. Available as a preview feature.", "operationId" : "updateServiceAccount", "parameters" : [ { - "description" : "Id of the service account.", + "description" : "The Client ID of the Service Account.", "in" : "path", - "name" : "serviceAccountId", + "name" : "clientId", "required" : true, "schema" : { - "type" : "string" + "type" : "string", + "example" : "mdb_sa_id_667066535bc75b03c37b3038", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" } }, { "$ref" : "#/components/parameters/orgId" @@ -21836,23 +23333,23 @@ } ], "requestBody" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { "$ref" : "#/components/schemas/OrgServiceAccountUpdateRequest" } } }, - "description" : "Details to update service account in the specified organization.", + "description" : "The new details for the Service Account.", "required" : true }, "responses" : { "200" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { "$ref" : "#/components/schemas/OrgServiceAccount" }, - "x-xgen-version" : "2023-10-01" + "x-xgen-version" : "2024-08-05" } }, "description" : "OK" @@ -21873,23 +23370,25 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Service Account Update", - "tags" : [ "Organizations" ] + "summary" : "Update one Organization Service Account", + "tags" : [ "Service Accounts" ] } }, - "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/groups" : { + "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/groups" : { "get" : { - "description" : "Returns list of Service Account projects.", + "description" : "Returns a list of all projects the specified Service Account is a part of. Available as a preview feature.", "operationId" : "listServiceAccountProjects", "parameters" : [ { "$ref" : "#/components/parameters/orgId" }, { - "description" : "Id of the service account.", + "description" : "The Client ID of the Service Account.", "in" : "path", - "name" : "serviceAccountId", + "name" : "clientId", "required" : true, "schema" : { - "type" : "string" + "type" : "string", + "example" : "mdb_sa_id_667066535bc75b03c37b3038", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" } }, { "$ref" : "#/components/parameters/itemsPerPage" @@ -21903,11 +23402,11 @@ "responses" : { "200" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { "$ref" : "#/components/schemas/PaginatedServiceAccountGroup" }, - "x-xgen-version" : "2023-10-01" + "x-xgen-version" : "2024-08-05" } }, "description" : "OK" @@ -21925,23 +23424,25 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Return All Service Account projects", - "tags" : [ "Organizations" ] + "summary" : "Return All Service Account Project assignments", + "tags" : [ "Service Accounts" ] } }, - "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets" : { + "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/secrets" : { "post" : { - "description" : "Create Service Account secret.", + "description" : "Create a secret for the specified Service Account. Available as a preview feature.", "operationId" : "createServiceAccountSecret", "parameters" : [ { "$ref" : "#/components/parameters/orgId" }, { - "description" : "Id of the service account.", + "description" : "The Client ID of the Service Account.", "in" : "path", - "name" : "serviceAccountId", + "name" : "clientId", "required" : true, "schema" : { - "type" : "string" + "type" : "string", + "example" : "mdb_sa_id_667066535bc75b03c37b3038", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" } }, { "$ref" : "#/components/parameters/envelope" @@ -21950,23 +23451,23 @@ } ], "requestBody" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { "$ref" : "#/components/schemas/ServiceAccountSecretRequest" } } }, - "description" : "Details to create secret in the specified service account.", + "description" : "Details for the new secret.", "required" : true }, "responses" : { "201" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { "$ref" : "#/components/schemas/ServiceAccountSecret" }, - "x-xgen-version" : "2023-10-01" + "x-xgen-version" : "2024-08-05" } }, "description" : "Created" @@ -21984,24 +23485,26 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Service Account Secret Creation", - "tags" : [ "Organizations" ] + "summary" : "Create one Organization Service Account Secret", + "tags" : [ "Service Accounts" ] } }, - "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets/{secretId}" : { + "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/secrets/{secretId}" : { "delete" : { - "description" : "Delete Service Account Secret.", + "description" : "Deletes the specified Service Account secret. Available as a preview feature.", "operationId" : "deleteServiceAccountSecret", "parameters" : [ { - "description" : "Id of the service account.", + "description" : "The Client ID of the Service Account.", "in" : "path", - "name" : "serviceAccountId", + "name" : "clientId", "required" : true, "schema" : { - "type" : "string" + "type" : "string", + "example" : "mdb_sa_id_667066535bc75b03c37b3038", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" } }, { - "description" : "Id of the secret.", + "description" : "Unique 24-hexadecimal digit string that identifies the secret.", "in" : "path", "name" : "secretId", "required" : true, @@ -22018,8 +23521,8 @@ "responses" : { "204" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "x-xgen-version" : "2023-10-01" + "application/vnd.atlas.2024-08-05+json" : { + "x-xgen-version" : "2024-08-05" } }, "description" : "This endpoint does not return a response body." @@ -22037,8 +23540,8 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Service Account Secret Deletion.", - "tags" : [ "Organizations" ] + "summary" : "Delete a Organization Service Account Secret", + "tags" : [ "Service Accounts" ] } }, "/api/atlas/v2/orgs/{orgId}/settings" : { @@ -22116,6 +23619,9 @@ }, "description" : "OK" }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, "401" : { "$ref" : "#/components/responses/unauthorized" }, @@ -22738,16 +24244,76 @@ } ], "summary" : "Return All MongoDB Cloud Users in One Organization", "tags" : [ "Organizations" ] + }, + "post" : { + "description" : "Invites one new or existing MongoDB Cloud user to join the organization. The invitation to join the organization will be sent to the username provided and must be accepted within 30 days. To use this resource, the requesting API Key must have the Organization Owner role.\n\n**Note**: If the user does not have an existing MongoDB Cloud account, they will be prompted to finish setting up an account upon accepting the invitation. If the user already has an account, they will still receive an invitation to access the organization.", + "operationId" : "createOrganizationUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrgUserRequest" + } + } + }, + "description" : "Represents the MongoDB Cloud user to be created within the organization.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrgUserResponse" + }, + "x-xgen-version" : "2025-01-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One MongoDB Cloud User in One Organization", + "tags" : [ "MongoDB Cloud Users" ] } }, "/api/atlas/v2/orgs/{orgId}/users/{userId}" : { "delete" : { - "description" : "Removes one MongoDB Cloud user from the specified organization. To use this resource, the requesting API Key must have the Organization User Admin role.", + "description" : "Removes one MongoDB Cloud user from the specified organization. To use this resource, the requesting API Key must have the Organization User Admin role. Deprecated versions: v2-{2023-01-01}", "operationId" : "removeOrganizationUser", "parameters" : [ { "$ref" : "#/components/parameters/envelope" }, { "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" }, { "description" : "Unique 24-hexadecimal digit string that identifies the user to be deleted.", "in" : "path", @@ -22763,11 +24329,11 @@ "responses" : { "204" : { "content" : { - "application/vnd.atlas.2023-01-01+json" : { + "application/vnd.atlas.2025-01-01+json" : { "schema" : { "$ref" : "#/components/schemas/NoBody" }, - "x-xgen-version" : "2023-01-01" + "x-xgen-version" : "2025-01-01" } }, "description" : "This endpoint does not return a response body." @@ -22791,8 +24357,129 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Remove One MongoDB Cloud User from One Organization", + "summary" : "Remove One MongoDB Cloud User From One Organization", "tags" : [ "Organizations" ] + }, + "get" : { + "description" : "Returns information about the specified MongoDB Cloud user within the context of the specified organization. To use this resource, the requesting API Key must have the Organization Read Only role.\n\n**Note**: This resource can only be used to fetch information about MongoDB Cloud human users. To return information about an API Key, use the [Return One Organization API Key](#tag/Programmatic-API-Keys/operation/getApiKey) endpoint.\n\n**Note**: This resource does not return information about pending users invited via the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint.", + "operationId" : "getOrganizationUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the pending or active user in the organization. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Organization resource and filter by username.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrgUserResponse" + }, + "x-xgen-version" : "2025-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One MongoDB Cloud User in One Organization", + "tags" : [ "MongoDB Cloud Users" ] + }, + "patch" : { + "description" : "Updates one MongoDB Cloud user in the specified organization. You can update an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting API Key must have the Organization Owner role.\n\n**Note**: Only include the fields you wish to update in the request body. Supplying a field with an empty value will reset that field on the user.\n\n**Note**: This resource cannot be used to update pending users invited via the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint.", + "operationId" : "updateOrganizationUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the pending or active user in the organization. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Organization resource and filter by username.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrgUserUpdateRequest" + } + } + }, + "description" : "Represents the roles and teams to assign the MongoDB Cloud user.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrgUserResponse" + }, + "x-xgen-version" : "2025-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One MongoDB Cloud User in One Organization", + "tags" : [ "MongoDB Cloud Users" ] } }, "/api/atlas/v2/orgs/{orgId}/users/{userId}/roles" : { @@ -22860,6 +24547,138 @@ "tags" : [ "Organizations" ] } }, + "/api/atlas/v2/orgs/{orgId}/users/{userId}:addRole" : { + "post" : { + "description" : "Adds one organization level role to the MongoDB Cloud user. You can add a role to an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting API Key must have the Organization Owner role.\n\n**Note**: This operation is atomic.\n\n**Note**: This resource cannot be used to add a role to users invited using the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint.", + "operationId" : "addOrganizationRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the pending or active user in the organization. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Organization resource and filter by username.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Organization level role to assign to the MongoDB Cloud user.", + "in" : "query", + "name" : "role", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_READ_ONLY", "ORG_MEMBER" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrgUserResponse" + }, + "x-xgen-version" : "2025-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add One Organization Role to One MongoDB Cloud User", + "tags" : [ "MongoDB Cloud Users" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/users/{userId}:removeRole" : { + "post" : { + "description" : "Removes one organization level role from the MongoDB Cloud user. You can remove a role from an active user or a user that has not yet accepted the invitation to join the organization. To replace a user's only role, add the new role before removing the old role. A user must have at least one role at all times. To use this resource, the requesting API Key must have the Organization Owner role.\n\n**Note**: This operation is atomic.\n\n**Note**: This resource cannot be used to remove a role from users invited using the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint.", + "operationId" : "removeOrganizationRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the pending or active user in the organization. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Organization resource and filter by username.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Organization level role to remove from the MongoDB Cloud user.", + "in" : "query", + "name" : "role", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_READ_ONLY", "ORG_MEMBER" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrgUserResponse" + }, + "x-xgen-version" : "2025-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Organization Role from One MongoDB Cloud User", + "tags" : [ "MongoDB Cloud Users" ] + } + }, "/api/atlas/v2/unauth/controlPlaneIPAddresses" : { "get" : { "description" : "Returns all control plane IP addresses. Currently, inbound Atlas control plane IP addresses are not yet available. The inbound IP address list in your API response is empty. To manually retrieve a list of inbound Atlas control plane IP addresses, see [Required Inbound Access](https://www.mongodb.com/docs/atlas/setup-cluster-security/#std-label-atlas-required-inbound-access).", @@ -22887,6 +24706,53 @@ "tags" : [ "Root" ] } }, + "/api/atlas/v2/unauth/openapi/versions" : { + "get" : { + "description" : "API that provides a list of available versionsfor a given environment.", + "operationId" : "getApiVersions", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "The environment to get the versions from. If not provided, it returnsthe versions for the given MongoDB URL. (E.g. prod for cloud.mongodb.com)", + "in" : "query", + "name" : "env", + "schema" : { + "type" : "string", + "enum" : [ "dev", "qa", "prod", "stage" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiVersions" + }, + "x-xgen-version" : "2024-08-05" + }, + "application/vnd.atlas.2024-08-05+yaml" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiVersions" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "OK" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "summary" : "Provides a list of versions for a given environment.", + "tags" : [ "OpenAPI" ] + } + }, "/api/atlas/v2/users" : { "post" : { "description" : "Creates one MongoDB Cloud user account. A MongoDB Cloud user account grants access to only the MongoDB Cloud application. To grant database access, create a database user. MongoDB Cloud sends an email to the users you specify, inviting them to join the project. Invited users don't have access to the project until they accept the invitation. Invitations expire after 30 days.\n\n 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.\n\n To use this resource, the requesting API Key can have any role.", @@ -23540,7 +25406,7 @@ "diskIOPS" : { "type" : "integer", "format" : "int32", - "description" : "Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.\n\n Change this parameter only if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" to \"AWS\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" to \"M30\"` or greater (not including `Mxx_NVME` tiers).\n\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType\" to \"PROVISIONED\"`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1." + "description" : "Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.\n\n Change this parameter if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" to \"AWS\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" to \"M30\"` or greater (not including `Mxx_NVME` tiers).\n\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType\" to \"PROVISIONED\"`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1." }, "ebsVolumeType" : { "type" : "string", @@ -23569,7 +25435,7 @@ "diskIOPS" : { "type" : "integer", "format" : "int32", - "description" : "Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.\n\n You can set different IOPS values on different shards when provisioned IOPS are supported.\n\n Change this parameter only if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" to \"AWS\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" to \"M30\"` or greater (not including `Mxx_NVME` tiers).\n\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType\" to \"PROVISIONED\"`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1." + "description" : "Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.\n\n You can set different IOPS values on different shards when provisioned IOPS are supported.\n\n Change this parameter if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" to \"AWS\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" to \"M30\"` or greater (not including `Mxx_NVME` tiers).\n\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType\" to \"PROVISIONED\"`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1." }, "diskSizeGB" : { "type" : "number", @@ -23900,6 +25766,26 @@ "description" : "Configuration of nodes that comprise the cluster.", "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] }, + "configServerManagementMode" : { + "type" : "string", + "default" : "ATLAS_MANAGED", + "description" : "Config Server Management Mode for creating or updating a sharded cluster.\n\nWhen configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings.\n\nWhen configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server.", + "enum" : [ "ATLAS_MANAGED", "FIXED_TO_DEDICATED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + } + }, + "configServerType" : { + "type" : "string", + "description" : "Describes a sharded cluster's config server type.", + "enum" : [ "DEDICATED", "EMBEDDED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + }, + "readOnly" : true + }, "connectionStrings" : { "$ref" : "#/components/schemas/ClusterConnectionStrings" }, @@ -23935,6 +25821,17 @@ "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" } }, + "featureCompatibilityVersion" : { + "type" : "string", + "description" : "Feature compatibility version of the cluster.", + "readOnly" : true + }, + "featureCompatibilityVersionExpirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Feature compatibility version expiration date.", + "readOnly" : true + }, "globalClusterSelfManagedSharding" : { "type" : "boolean", "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen 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.\n\nWhen 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.\n\nThis setting cannot be changed once the cluster is deployed.", @@ -23981,6 +25878,9 @@ }, "readOnly" : true }, + "mongoDBEmployeeAccessGrant" : { + "$ref" : "#/components/schemas/EmployeeAccessGrantView" + }, "mongoDBMajorVersion" : { "type" : "string", "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", @@ -24000,7 +25900,7 @@ "description" : "Human-readable label that identifies the advanced cluster.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, "paused" : { "type" : "boolean", @@ -24014,6 +25914,16 @@ "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" } }, + "replicaSetScalingStrategy" : { + "type" : "string", + "default" : "WORKLOAD_TYPE", + "description" : "Set this field to configure the replica set scaling mode for your cluster.\n\nBy default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes.\n\nWhen configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads.\n\nWhen configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads.", + "enum" : [ "SEQUENTIAL", "WORKLOAD_TYPE", "NODE_TYPE" ], + "externalDocs" : { + "description" : "Modify the Replica Set Scaling Mode", + "url" : "https://dochub.mongodb.org/core/scale-nodes" + } + }, "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.", @@ -24884,6 +26794,257 @@ }, "title" : "mappings" }, + "ApiAtlasInvalidPolicyErrorDetailView" : { + "type" : "object", + "properties" : { + "detail" : { + "type" : "string", + "description" : "A string that provides a detailed description of a validation error.", + "readOnly" : true + } + } + }, + "ApiAtlasInvalidPolicyView" : { + "type" : "object", + "properties" : { + "body" : { + "type" : "string", + "description" : "A string that defines the permissions for the policy. The syntax used is the Cedar Policy language.", + "example" : " forbid (\n principal,\n action == cloud::Action::\"cluster.createEdit\",\n resource\n ) when {\n context.cluster.regions.contains(cloud::region::\"aws:us-east-1\")\n };\n", + "readOnly" : true + }, + "errors" : { + "type" : "array", + "description" : "List of validation errors.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasInvalidPolicyErrorDetailView" + }, + "readOnly" : true + } + } + }, + "ApiAtlasInvalidResourcePolicyCreateErrorView" : { + "type" : "object", + "properties" : { + "errorType" : { + "type" : "string", + "description" : "Human-readable label that displays the type of an error.", + "enum" : [ "POLICY_PARSING_ERROR", "POLICY_HAS_FAILED_VALIDATIONS", "POLICY_HAS_INVALID_PRINCIPAL", "POLICY_HAS_BODY_EXCEEDING_MAX_SIZE", "POLICY_HAS_UNEXPECTED_ENTITIES" ] + }, + "invalidPolicies" : { + "type" : "array", + "description" : "List of invalid policies containing details of their validation errors.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasInvalidPolicyView" + }, + "readOnly" : true + } + } + }, + "ApiAtlasNonCompliantResourceView" : { + "type" : "object", + "properties" : { + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization the resource belongs to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resourceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the non-compliant resource.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resourcePoliciesCausingNonCompliance" : { + "type" : "array", + "description" : "List of resource policies causing the resource to be considered non-compliant.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasResourcePolicyMetadataView" + }, + "readOnly" : true + }, + "resourceType" : { + "type" : "string", + "description" : "Human-readable label that displays the type of a resource.", + "enum" : [ "PROJECT", "CLUSTER" ], + "readOnly" : true + } + } + }, + "ApiAtlasPolicyCreateView" : { + "type" : "object", + "properties" : { + "body" : { + "type" : "string", + "description" : "A string that defines the permissions for the policy. The syntax used is the Cedar Policy language.", + "example" : " forbid (\n principal,\n action == cloud::Action::\"cluster.createEdit\",\n resource\n ) when {\n context.cluster.regions.contains(cloud::region::\"aws:us-east-1\")\n };\n" + } + }, + "required" : [ "body" ] + }, + "ApiAtlasPolicyMetadataView" : { + "type" : "object", + "properties" : { + "policyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "ApiAtlasPolicyView" : { + "type" : "object", + "properties" : { + "body" : { + "type" : "string", + "description" : "A string that defines the permissions for the policy. The syntax used is the Cedar Policy language.", + "example" : " forbid (\n principal,\n action == cloud::Action::\"cluster.createEdit\",\n resource\n ) when {\n context.cluster.regions.contains(cloud::region::\"aws:us-east-1\")\n };\n", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "ApiAtlasResourcePolicyCreateView" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that describes the atlas resource policy." + }, + "policies" : { + "type" : "array", + "description" : "List of policies that make up the atlas resource policy.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasPolicyCreateView" + } + } + }, + "required" : [ "name", "policies" ] + }, + "ApiAtlasResourcePolicyEditView" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that describes the atlas resource policy." + }, + "policies" : { + "type" : "array", + "description" : "List of policies that make up the atlas resource policy.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasPolicyCreateView" + } + } + } + }, + "ApiAtlasResourcePolicyMetadataView" : { + "type" : "object", + "properties" : { + "policiesCausingNonCompliance" : { + "type" : "array", + "description" : "List of policies that are in conflict with the current state of the resource.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasPolicyMetadataView" + }, + "readOnly" : true + }, + "resourcePolicyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the atlas resource policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resourcePolicyName" : { + "type" : "string", + "description" : "Human-readable label that describes the atlas resource policy.", + "readOnly" : true + } + } + }, + "ApiAtlasResourcePolicyView" : { + "type" : "object", + "properties" : { + "createdByUser" : { + "$ref" : "#/components/schemas/ApiAtlasUserMetadataView" + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time in UTC when the atlas resource policy was created.", + "example" : "2022-01-01T00:00:00Z", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the atlas resource policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastUpdatedByUser" : { + "$ref" : "#/components/schemas/ApiAtlasUserMetadataView" + }, + "lastUpdatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time in UTC when the atlas resource policy was last updated.", + "example" : "2022-01-01T00:00:00Z", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that describes the atlas resource policy.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization the atlas resource policy belongs to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "policies" : { + "type" : "array", + "description" : "List of policies that make up the atlas resource policy.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasPolicyView" + }, + "readOnly" : true + }, + "version" : { + "type" : "string", + "description" : "A string that identifies the version of the atlas resource policy.", + "example" : "v1", + "readOnly" : true + } + } + }, "ApiAtlasSnapshotScheduleView" : { "type" : "object", "properties" : { @@ -24960,6 +27121,27 @@ }, "required" : [ "clusterCheckpointIntervalMin", "clusterId", "dailySnapshotRetentionDays", "groupId", "monthlySnapshotRetentionMonths", "pointInTimeWindowHours", "snapshotIntervalHours", "snapshotRetentionDays", "weeklySnapshotRetentionWeeks" ] }, + "ApiAtlasUserMetadataView" : { + "type" : "object", + "description" : "The user that last updated the atlas resource policy.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies a user.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that describes a user.", + "readOnly" : true + } + }, + "readOnly" : true + }, "ApiBSONTimestampView" : { "type" : "object", "description" : "BSON timestamp that indicates when the checkpoint token entry in the oplog occurred.", @@ -25016,6 +27198,9 @@ "ApiError" : { "type" : "object", "properties" : { + "badRequestDetail" : { + "$ref" : "#/components/schemas/BadRequestDetail" + }, "detail" : { "type" : "string", "description" : "Describes the specific conditions or reasons that cause each type of error." @@ -25026,24 +27211,30 @@ "description" : "HTTP status code returned with this error.", "externalDocs" : { "url" : "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status" - } + }, + "readOnly" : true }, "errorCode" : { "type" : "string", - "description" : "Application error code returned with this error." + "description" : "Application error code returned with this error.", + "readOnly" : true }, "parameters" : { "type" : "array", "description" : "Parameters used to give more information about the error.", "items" : { - "type" : "object" - } + "type" : "object", + "readOnly" : true + }, + "readOnly" : true }, "reason" : { "type" : "string", - "description" : "Application error message returned with this error." + "description" : "Application error message returned with this error.", + "readOnly" : true } - } + }, + "required" : [ "error", "errorCode" ] }, "ApiHostView_Atlas" : { "type" : "object", @@ -25299,6 +27490,24 @@ } } }, + "ApiPrivateDownloadDeliveryUrl" : { + "type" : "object", + "description" : "One Uniform Resource Locator (URL) that points to the compressed snapshot files for manual download and the corresponding private endpoint.", + "properties" : { + "deliveryUrl" : { + "type" : "string", + "description" : "One Uniform Resource Locator that points to the compressed snapshot files for manual download." + }, + "endpointId" : { + "type" : "string", + "description" : "Unique 22-character alphanumeric string that identifies the private endpoint.", + "example" : "vpce-3bf78b0ddee411ba1", + "maxLength" : 22, + "minLength" : 22, + "pattern" : "^vpce-[0-9a-f]{17}$" + } + } + }, "ApiPublicUsageDetailsQueryRequest" : { "type" : "object", "description" : "Request body for an Invoice Usage Details query with filtering, pagination, and sort.", @@ -25392,7 +27601,12 @@ "ApiStreamsAWSRegionView" : { "type" : "string", "description" : "Atlas Streams AWS Regions.", - "enum" : [ "VIRGINIA_USA" ] + "enum" : [ "SYDNEY_AUS", "MUMBAI_IND", "FRANKFURT_DEU", "DUBLIN_IRL", "LONDON_GBR", "VIRGINIA_USA", "OREGON_USA", "SAOPAULO_BRA", "MONTREAL_CAN", "TOKYO_JPN", "SINGAPORE_SGP" ] + }, + "ApiStreamsAzureRegionView" : { + "type" : "string", + "description" : "Atlas Streams Azure Regions.", + "enum" : [ "VIRGINIA_USA", "AMSTERDAM_NLD" ] }, "ApiUserEventTypeViewForNdsGroup" : { "type" : "string", @@ -25616,6 +27830,15 @@ "required" : [ "created", "eventTypeName", "id" ], "title" : "API User Events" }, + "ApiVersion" : { + "type" : "object", + "properties" : { + "version" : { + "type" : "string", + "description" : "Object representing a version of the Atlas Admin API." + } + } + }, "AppServiceAlertConfigViewForNdsGroup" : { "type" : "object", "description" : "App Services metric alert configuration allows to select which app service conditions and events trigger alerts and how users are notified.", @@ -26038,7 +28261,9 @@ "enum" : [ "AVERAGE" ] }, "operator" : { - "$ref" : "#/components/schemas/Operator" + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, "threshold" : { "type" : "number", @@ -26078,6 +28303,11 @@ "description" : "Atlas Data Federation Azure Regions.", "enum" : [ "VIRGINIA_USA", "AMSTERDAM_NLD" ] }, + "AtlasDataFederationGCPRegion" : { + "type" : "string", + "description" : "Atlas Data Federation GCP Regions.", + "enum" : [ "IOWA_USA", "BELGIUM_EU" ] + }, "AtlasOrganization" : { "type" : "object", "description" : "Details that describe the organization.", @@ -26118,6 +28348,122 @@ }, "required" : [ "name" ] }, + "AtlasResourcePolicyAuditForOrg" : { + "type" : "object", + "description" : "Atlas resource policy audits indicate org level changes to resource policies", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "RESOURCE_POLICY_CREATED", "RESOURCE_POLICY_MODIFIED", "RESOURCE_POLICY_DELETED" ], + "example" : "RESOURCE_POLICY_CREATED", + "title" : "Atlas Resource Policy Audit Types" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "resourcePolicyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the resource policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Atlas Resource Policy Audits" + }, "AtlasSearchAnalyzer" : { "type" : "object", "properties" : { @@ -26633,6 +28979,15 @@ "AzureHardwareSpec" : { "type" : "object", "properties" : { + "diskIOPS" : { + "type" : "integer", + "format" : "int32", + "description" : "Target throughput desired for storage attached to your Azure-provisioned cluster. Change this parameter if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" : \"Azure\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : \"M40\"` or greater not including `Mxx_NVME` tiers.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://www.mongodb.com/docs/atlas/customize-storage/#extend-iops-on-azure" + } + }, "instanceSize" : { "type" : "string", "description" : "Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts of the node type.", @@ -26649,6 +29004,15 @@ "AzureHardwareSpec20240805" : { "type" : "object", "properties" : { + "diskIOPS" : { + "type" : "integer", + "format" : "int32", + "description" : "Target throughput desired for storage attached to your Azure-provisioned cluster. Change this parameter if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" : \"Azure\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : \"M40\"` or greater not including `Mxx_NVME` tiers.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://www.mongodb.com/docs/atlas/customize-storage/#extend-iops-on-azure" + } + }, "diskSizeGB" : { "type" : "number", "format" : "double", @@ -26776,7 +29140,7 @@ "status" : { "type" : "string", "description" : "State of the Encryption At Rest private endpoint.", - "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "ACTIVE", "FAILED" ], + "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "ACTIVE", "FAILED", "PENDING_RECREATION", "DELETING" ], "readOnly" : true } }, @@ -27109,7 +29473,7 @@ "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to create an online archive.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "collName" : { @@ -27193,7 +29557,7 @@ "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to create an online archive.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "collName" : { @@ -27296,7 +29660,7 @@ "description" : "Human-readable label that identifies the cluster containing the snapshots you want to retrieve.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -27453,7 +29817,7 @@ "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\"`.\n\nIf the target cluster doesn't have backup enabled, two resources return parameters with empty values:\n\n- **Get All Snapshots** endpoint returns an empty results array without **clusterId** elements\n- **Get a Snapshot** endpoint doesn't return a **clusterId** parameter.\n\nTo return a response with the **clusterId** parameter, either use the **delivery.targetClusterName** parameter or enable backup on the target cluster.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, "targetGroupId" : { "type" : "string", @@ -27714,6 +30078,20 @@ } } }, + "BadRequestDetail" : { + "type" : "object", + "description" : "Bad request detail.", + "properties" : { + "fields" : { + "type" : "array", + "description" : "Describes all violations in a client request.", + "items" : { + "$ref" : "#/components/schemas/FieldViolation" + } + } + }, + "readOnly" : true + }, "BaseAtlasDataLakeRegion" : { "type" : "object", "description" : "Name of the region to which the data lake routes client connections.", @@ -27721,6 +30099,8 @@ "$ref" : "#/components/schemas/ApiAtlasDataLakeAWSRegionView" }, { "$ref" : "#/components/schemas/AtlasDataFederationAzureRegion" + }, { + "$ref" : "#/components/schemas/AtlasDataFederationGCPRegion" } ] }, "BaseCloudProviderInstanceSize" : { @@ -27788,6 +30168,8 @@ "description" : "Name of the cloud provider region hosting Atlas Stream Processing.", "oneOf" : [ { "$ref" : "#/components/schemas/ApiStreamsAWSRegionView" + }, { + "$ref" : "#/components/schemas/ApiStreamsAzureRegionView" } ] }, "BasicBSONList" : { @@ -28677,7 +31059,7 @@ "description" : "Human-readable label that identifies the cluster.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "nodeCount" : { @@ -28729,6 +31111,11 @@ "format" : "date-time", "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." }, + "description" : { + "type" : "string", + "description" : "Description of this database user.", + "maxLength" : 100 + }, "groupId" : { "type" : "string", "description" : "Unique 24-hexadecimal digit string that identifies the project.", @@ -28907,6 +31294,123 @@ "description" : "Details that describe the features linked to the Amazon Web Services (AWS) Identity and Access Management (IAM) role.", "required" : [ "providerName" ] }, + "CloudProviderAccessAWSIAMRoleRequest" : { + "type" : "object", + "description" : "Details that describe the features linked to the Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "properties" : { + "atlasAWSAccountArn" : { + "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.", + "example" : "arn:aws:iam::772401394250:role/my-test-aws-role", + "maxLength" : 2048, + "minLength" : 20, + "readOnly" : true + }, + "atlasAssumedRoleExternalId" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique external ID that MongoDB Cloud uses when it assumes the IAM role in your Amazon Web Services (AWS) account.", + "readOnly" : true + }, + "authorizedDate" : { + "type" : "string", + "format" : "date-time", + "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.", + "readOnly" : true + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "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.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider of the role.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "roleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + }, + "required" : [ "providerName" ] + }, + "CloudProviderAccessAWSIAMRoleRequestUpdate" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessRoleRequestUpdate" + }, { + "type" : "object", + "properties" : { + "atlasAWSAccountArn" : { + "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.", + "example" : "arn:aws:iam::772401394250:role/my-test-aws-role", + "maxLength" : 2048, + "minLength" : 20, + "readOnly" : true + }, + "atlasAssumedRoleExternalId" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique external ID that MongoDB Cloud uses when it assumes the IAM role in your Amazon Web Services (AWS) account.", + "readOnly" : true + }, + "authorizedDate" : { + "type" : "string", + "format" : "date-time", + "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.", + "readOnly" : true + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "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.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "iamAssumedRoleArn" : { + "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", + "maxLength" : 2048, + "minLength" : 20 + }, + "roleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + } ], + "description" : "Details that describe the features linked to the Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "required" : [ "providerName" ] + }, "CloudProviderAccessAzureServicePrincipal" : { "type" : "object", "allOf" : [ { @@ -28969,6 +31473,130 @@ "description" : "Details that describe the features linked to the Azure Service Principal.", "required" : [ "providerName" ] }, + "CloudProviderAccessAzureServicePrincipalRequest" : { + "type" : "object", + "description" : "Details that describe the features linked to the Azure Service Principal.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "atlasAzureAppId" : { + "type" : "string", + "description" : "Azure Active Directory Application ID of Atlas.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this Azure Service Principal was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Azure Service Principal.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "lastUpdatedDate" : { + "type" : "string", + "format" : "date-time", + "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.", + "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.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "tenantId" : { + "type" : "string", + "description" : "UUID String that identifies the Azure Active Directory Tenant ID.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + } + }, + "required" : [ "providerName" ] + }, + "CloudProviderAccessAzureServicePrincipalRequestUpdate" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessRoleRequestUpdate" + }, { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "atlasAzureAppId" : { + "type" : "string", + "description" : "Azure Active Directory Application ID of Atlas.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this Azure Service Principal was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Azure Service Principal.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "lastUpdatedDate" : { + "type" : "string", + "format" : "date-time", + "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.", + "readOnly" : true + }, + "servicePrincipalId" : { + "type" : "string", + "description" : "UUID string that identifies the Azure Service Principal.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "tenantId" : { + "type" : "string", + "description" : "UUID String that identifies the Azure Active Directory Tenant ID.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + } + } + } ], + "description" : "Details that describe the features linked to the Azure Service Principal.", + "required" : [ "providerName" ] + }, "CloudProviderAccessDataLakeFeatureUsage" : { "type" : "object", "allOf" : [ { @@ -29095,6 +31723,92 @@ } } }, + "CloudProviderAccessGCPServiceAccount" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, { + "type" : "object", + "properties" : { + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this Google Service Account was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Google Service Account.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "gcpServiceAccountForAtlas" : { + "type" : "string", + "description" : "Email address for the Google Service Account created by Atlas.", + "maxLength" : 82, + "minLength" : 57, + "pattern" : "^mongodb-atlas-[0-9a-z]{16}@p-[0-9a-z]{24}.iam.gserviceaccount.com$" + }, + "roleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + } ], + "description" : "Details that describe the features linked to the GCP Service Account.", + "required" : [ "providerName" ] + }, + "CloudProviderAccessGCPServiceAccountRequest" : { + "type" : "object", + "description" : "Details that describe the features linked to the GCP Service Account.", + "properties" : { + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this GCP Service Account was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this GCP Service Account.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "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" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "readOnly" : true + } + }, + "required" : [ "providerName" ] + }, + "CloudProviderAccessGCPServiceAccountRequestUpdate" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessRoleRequestUpdate" + } ], + "description" : "Details that describe the features linked to the GCP Service Account.", + "required" : [ "providerName" ] + }, "CloudProviderAccessPushBasedLogExportFeatureUsage" : { "type" : "object", "allOf" : [ { @@ -29115,20 +31829,63 @@ "discriminator" : { "mapping" : { "AWS" : "#/components/schemas/CloudProviderAccessAWSIAMRole", - "AZURE" : "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + "AZURE" : "#/components/schemas/CloudProviderAccessAzureServicePrincipal", + "GCP" : "#/components/schemas/CloudProviderAccessGCPServiceAccount" + }, + "propertyName" : "providerName" + }, + "properties" : { + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider of the role.", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, + "required" : [ "providerName" ] + }, + "CloudProviderAccessRoleRequest" : { + "type" : "object", + "description" : "Cloud provider access role.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/CloudProviderAccessAWSIAMRoleRequest", + "AZURE" : "#/components/schemas/CloudProviderAccessAzureServicePrincipalRequest", + "GCP" : "#/components/schemas/CloudProviderAccessGCPServiceAccountRequest" }, "propertyName" : "providerName" }, "oneOf" : [ { - "$ref" : "#/components/schemas/CloudProviderAccessAWSIAMRole" + "$ref" : "#/components/schemas/CloudProviderAccessAWSIAMRoleRequest" + }, { + "$ref" : "#/components/schemas/CloudProviderAccessAzureServicePrincipalRequest" }, { - "$ref" : "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + "$ref" : "#/components/schemas/CloudProviderAccessGCPServiceAccountRequest" } ], "properties" : { "providerName" : { "type" : "string", "description" : "Human-readable label that identifies the cloud provider of the role.", - "enum" : [ "AWS", "AZURE" ] + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, + "required" : [ "providerName" ] + }, + "CloudProviderAccessRoleRequestUpdate" : { + "type" : "object", + "description" : "Cloud provider access role.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/CloudProviderAccessAWSIAMRoleRequestUpdate", + "AZURE" : "#/components/schemas/CloudProviderAccessAzureServicePrincipalRequestUpdate", + "GCP" : "#/components/schemas/CloudProviderAccessGCPServiceAccountRequestUpdate" + }, + "propertyName" : "providerName" + }, + "properties" : { + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider of the role.", + "enum" : [ "AWS", "AZURE", "GCP" ] } }, "required" : [ "providerName" ] @@ -29142,6 +31899,13 @@ "items" : { "$ref" : "#/components/schemas/CloudProviderAccessAWSIAMRole" } + }, + "azureServicePrincipals" : { + "type" : "array", + "description" : "List that contains the Azure Service Principals registered with MongoDB Cloud.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + } } } }, @@ -29524,7 +32288,7 @@ "example" : "cluster1", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -29617,6 +32381,7 @@ }, "diskGBEnabled" : { "type" : "boolean", + "default" : false, "description" : "Flag that indicates whether someone enabled disk auto-scaling for this cluster." } }, @@ -29646,10 +32411,12 @@ "properties" : { "enabled" : { "type" : "boolean", + "default" : false, "description" : "Flag that indicates whether cluster tier auto-scaling is enabled. Set to `true` to enable cluster tier auto-scaling. If enabled, you must specify a value for **providerSettings.autoScaling.compute.maxInstanceSize** also. Set to `false` to disable cluster tier auto-scaling." }, "scaleDownEnabled" : { "type" : "boolean", + "default" : false, "description" : "Flag that indicates whether the cluster tier can scale down. This is required if **autoScaling.compute.enabled** is `true`. If you enable this option, specify a value for **providerSettings.autoScaling.compute.minInstanceSize**." } } @@ -29684,14 +32451,14 @@ "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.", + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to Atlas through the interface endpoint that the key names. If the cluster uses an optimized connection string, `awsPrivateLinkSrv` contains the optimized connection string. If the cluster has the non-optimized (legacy) connection string, `awsPrivateLinkSrv` contains the non-optimized connection string even if an optimized connection string is also present.", "externalDocs" : { "description" : "Network Peering Connection", "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" }, "readOnly" : true }, - "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.", + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to Atlas through the interface endpoint that the key names. If the cluster uses an optimized connection string, `awsPrivateLinkSrv` contains the optimized connection string. If the cluster has the non-optimized (legacy) connection string, `awsPrivateLinkSrv` contains the non-optimized connection string even if an optimized connection string is also present.", "externalDocs" : { "description" : "Network Peering Connection", "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" @@ -29771,6 +32538,26 @@ "description" : "Configuration of nodes that comprise the cluster.", "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] }, + "configServerManagementMode" : { + "type" : "string", + "default" : "ATLAS_MANAGED", + "description" : "Config Server Management Mode for creating or updating a sharded cluster.\n\nWhen configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings.\n\nWhen configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server.", + "enum" : [ "ATLAS_MANAGED", "FIXED_TO_DEDICATED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + } + }, + "configServerType" : { + "type" : "string", + "description" : "Describes a sharded cluster's config server type.", + "enum" : [ "DEDICATED", "EMBEDDED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + }, + "readOnly" : true + }, "connectionStrings" : { "$ref" : "#/components/schemas/ClusterConnectionStrings" }, @@ -29799,6 +32586,17 @@ "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" } }, + "featureCompatibilityVersion" : { + "type" : "string", + "description" : "Feature compatibility version of the cluster.", + "readOnly" : true + }, + "featureCompatibilityVersionExpirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Feature compatibility version expiration date.", + "readOnly" : true + }, "globalClusterSelfManagedSharding" : { "type" : "boolean", "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen 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.\n\nWhen 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.\n\nThis setting cannot be changed once the cluster is deployed.", @@ -29845,6 +32643,9 @@ }, "readOnly" : true }, + "mongoDBEmployeeAccessGrant" : { + "$ref" : "#/components/schemas/EmployeeAccessGrantView" + }, "mongoDBMajorVersion" : { "type" : "string", "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", @@ -29864,7 +32665,7 @@ "description" : "Human-readable label that identifies the cluster.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, "paused" : { "type" : "boolean", @@ -29878,6 +32679,24 @@ "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" } }, + "redactClientLogData" : { + "type" : "boolean", + "description" : "Enable or disable log redaction.", + "externalDocs" : { + "description" : "This options corresponds to the ``security.redactClientLogData`` cluster parameter.\n\nThis setting configures the ``mongod`` or ``mongos`` to redact any message accompanying a given log event before logging. This prevents the program from writing potentially sensitive data stored on the database to the diagnostic log. Metadata such as error or operation codes, line numbers, and source file names are still visible in the logs.\n\nUse ``redactClientLogData`` in conjunction with Encryption at Rest and TLS/SSL (Transport Encryption) to assist compliance with regulatory requirements.", + "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.redactClientLogData" + } + }, + "replicaSetScalingStrategy" : { + "type" : "string", + "default" : "WORKLOAD_TYPE", + "description" : "Set this field to configure the replica set scaling mode for your cluster.\n\nBy default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes.\n\nWhen configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads.\n\nWhen configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads.", + "enum" : [ "SEQUENTIAL", "WORKLOAD_TYPE", "NODE_TYPE" ], + "externalDocs" : { + "description" : "Modify the Replica Set Scaling Mode", + "url" : "https://dochub.mongodb.org/core/scale-nodes" + } + }, "replicationSpecs" : { "type" : "array", "description" : "List of settings that configure your cluster regions. This array has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations.", @@ -29987,6 +32806,16 @@ "ClusterDescriptionProcessArgs" : { "type" : "object", "properties" : { + "changeStreamOptionsPreAndPostImagesExpireAfterSeconds" : { + "type" : "integer", + "format" : "int32", + "default" : -1, + "description" : "The minimum pre- and post-image retention time in seconds.", + "externalDocs" : { + "description" : "This option corresponds to the ``changeStreamOptions.preAndPostImages.expireAfterSeconds`` cluster parameter. This setting controls the retention policy of change stream pre- and post-images. Pre- and post-images are the versions of a document before and after document modification, respectively. ``expireAfterSeconds`` controls how long MongoDB retains pre- and post-images. When set to -1 (off), MongoDB uses the default retention policy: pre- and post-images are retained until the corresponding change stream events are removed from the oplog. To set the minimum pre- and post-image retention time, specify an integer value greater than zero. Setting this too low could increase the risk of interrupting Realm sync or triggers processing. The default value is -1 (off).", + "url" : "https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/changeStreamOptions/#mongodb-parameter-param.changeStreamOptions.preAndPostImages.expireAfterSeconds" + } + }, "chunkMigrationConcurrency" : { "type" : "integer", "format" : "int32", @@ -29996,6 +32825,15 @@ "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.chunkMigrationConcurrency" } }, + "defaultMaxTimeMS" : { + "type" : "integer", + "format" : "int32", + "description" : "Default time limit in milliseconds for individual read operations to complete.", + "externalDocs" : { + "description" : "This option corresponds to the defaultMaxTimeMS cluster parameter.", + "url" : "https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/defaultMaxTimeMS/" + } + }, "defaultReadConcern" : { "type" : "string", "default" : "available", @@ -30026,7 +32864,7 @@ }, "javascriptEnabled" : { "type" : "boolean", - "description" : "Flag that indicates whether the cluster allows execution of operations that perform server-side executions of JavaScript.", + "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" @@ -30114,6 +32952,16 @@ "ClusterDescriptionProcessArgs20240805" : { "type" : "object", "properties" : { + "changeStreamOptionsPreAndPostImagesExpireAfterSeconds" : { + "type" : "integer", + "format" : "int32", + "default" : -1, + "description" : "The minimum pre- and post-image retention time in seconds.", + "externalDocs" : { + "description" : "This option corresponds to the ``changeStreamOptions.preAndPostImages.expireAfterSeconds`` cluster parameter. This setting controls the retention policy of change stream pre- and post-images. Pre- and post-images are the versions of a document before and after document modification, respectively. ``expireAfterSeconds`` controls how long MongoDB retains pre- and post-images. When set to -1 (off), MongoDB uses the default retention policy: pre- and post-images are retained until the corresponding change stream events are removed from the oplog. To set the minimum pre- and post-image retention time, specify an integer value greater than zero. Setting this too low could increase the risk of interrupting Realm sync or triggers processing. The default value is -1 (off).", + "url" : "https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/changeStreamOptions/#mongodb-parameter-param.changeStreamOptions.preAndPostImages.expireAfterSeconds" + } + }, "chunkMigrationConcurrency" : { "type" : "integer", "format" : "int32", @@ -30123,6 +32971,15 @@ "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.chunkMigrationConcurrency" } }, + "defaultMaxTimeMS" : { + "type" : "integer", + "format" : "int32", + "description" : "Default time limit in milliseconds for individual read operations to complete.", + "externalDocs" : { + "description" : "This option corresponds to the defaultMaxTimeMS cluster parameter.", + "url" : "https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/defaultMaxTimeMS/" + } + }, "defaultWriteConcern" : { "type" : "string", "description" : "Default level of acknowledgment requested from MongoDB for write operations when none is specified by the driver.", @@ -30133,7 +32990,7 @@ }, "javascriptEnabled" : { "type" : "boolean", - "description" : "Flag that indicates whether the cluster allows execution of operations that perform server-side executions of JavaScript.", + "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" @@ -30400,7 +33257,7 @@ "description" : "Human-readable label that identifies the cluster that undergoes outage simulation.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "groupId" : { @@ -30994,7 +33851,8 @@ "discriminator" : { "mapping" : { "AWS" : "#/components/schemas/AWSCreateDataProcessRegionView", - "AZURE" : "#/components/schemas/AzureCreateDataProcessRegionView" + "AZURE" : "#/components/schemas/AzureCreateDataProcessRegionView", + "GCP" : "#/components/schemas/GCPCreateDataProcessRegionView" }, "propertyName" : "cloudProvider" }, @@ -31491,11 +34349,11 @@ }, "roleId" : { "type" : "string", - "description" : "Unique identifier of the role that Data Federation can use to access the data stores.Required if specifying cloudProviderConfig." + "description" : "Unique identifier of the role that Data Federation can use to access the data stores. Required if specifying cloudProviderConfig." }, "servicePrincipalId" : { "type" : "string", - "description" : "The ID of the Service Principal for which there is an access policyfor Atlas to access Azure resources.", + "description" : "The ID of the Service Principal for which there is an access policy for Atlas to access Azure resources.", "readOnly" : true }, "tenantId" : { @@ -31506,6 +34364,22 @@ }, "required" : [ "roleId" ] }, + "DataFederationGCPCloudProviderConfig" : { + "type" : "object", + "description" : "Configuration for running Data Federation in GCP.", + "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" : { + "type" : "string", + "description" : "Unique identifier of the role that Data Federation can use to access the data stores. Required if specifying cloudProviderConfig." + } + }, + "required" : [ "roleId" ] + }, "DataFederationLimit" : { "type" : "object", "description" : "Details of user managed limits.", @@ -31513,6 +34387,7 @@ "mapping" : { "atlas.project.deployment.clusters" : "#/components/schemas/DefaultLimit", "atlas.project.deployment.nodesPerPrivateLinkRegion" : "#/components/schemas/DefaultLimit", + "atlas.project.deployment.salesSoldM0s" : "#/components/schemas/DefaultLimit", "atlas.project.deployment.serverlessMTMs" : "#/components/schemas/DefaultLimit", "atlas.project.security.databaseAccess.customRoles" : "#/components/schemas/DefaultLimit", "atlas.project.security.databaseAccess.users" : "#/components/schemas/DefaultLimit", @@ -31853,9 +34728,12 @@ }, "azure" : { "$ref" : "#/components/schemas/DataFederationAzureCloudProviderConfig" + }, + "gcp" : { + "$ref" : "#/components/schemas/DataFederationGCPCloudProviderConfig" } }, - "title" : "Data Lake Cloud Provider" + "title" : "Data Federation Cloud Provider" }, "DataLakeDLSAWSStore" : { "type" : "object", @@ -31896,7 +34774,7 @@ "cloudProvider" : { "type" : "string", "description" : "Name of the cloud service that hosts the Federated Database Instance's infrastructure.", - "enum" : [ "AWS", "AZURE" ] + "enum" : [ "AWS", "AZURE", "GCP" ] }, "region" : { "$ref" : "#/components/schemas/BaseAtlasDataLakeRegion" @@ -32318,7 +35196,7 @@ "example" : "cluster1", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -32560,7 +35438,9 @@ "enum" : [ "AVERAGE" ] }, "operator" : { - "$ref" : "#/components/schemas/Operator" + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, "threshold" : { "type" : "number", @@ -32603,7 +35483,8 @@ "discriminator" : { "mapping" : { "AWS" : "#/components/schemas/AWSDataProcessRegionView", - "AZURE" : "#/components/schemas/AzureDataProcessRegionView" + "AZURE" : "#/components/schemas/AzureDataProcessRegionView", + "GCP" : "#/components/schemas/GCPDataProcessRegionView" }, "propertyName" : "cloudProvider" }, @@ -32611,7 +35492,7 @@ "cloudProvider" : { "type" : "string", "description" : "Human-readable label that identifies the Cloud service provider where you store your archived data.", - "enum" : [ "AWS", "AZURE" ], + "enum" : [ "AWS", "AZURE", "GCP" ], "readOnly" : true } }, @@ -32838,7 +35719,7 @@ "action" : { "type" : "string", "description" : "Human-readable label that identifies the privilege action.", - "enum" : [ "FIND", "INSERT", "REMOVE", "UPDATE", "BYPASS_DOCUMENT_VALIDATION", "USE_UUID", "KILL_OP", "CREATE_COLLECTION", "CREATE_INDEX", "DROP_COLLECTION", "ENABLE_PROFILER", "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", "STORAGE_GET_CONFIG", "STORAGE_SET_CONFIG", "FLUSH_ROUTER_CONFIG", "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" ] + "enum" : [ "FIND", "INSERT", "REMOVE", "UPDATE", "BYPASS_DOCUMENT_VALIDATION", "USE_UUID", "KILL_OP", "CREATE_COLLECTION", "CREATE_INDEX", "DROP_COLLECTION", "ENABLE_PROFILER", "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", "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", @@ -33117,7 +35998,7 @@ "title" : "Cps Backup Event Types" }, { "type" : "string", - "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEXES_RESTORE_FAILED" ], + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEXES_RESTORE_FAILED", "FTS_INDEXES_SYNONYM_MAPPING_INVALID" ], "title" : "FTS Index Audit Types" }, { "type" : "string", @@ -33260,7 +36141,7 @@ "title" : "Encryption Event Types" }, { "type" : "string", - "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEXES_RESTORE_FAILED" ], + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEXES_RESTORE_FAILED", "FTS_INDEXES_SYNONYM_MAPPING_INVALID" ], "title" : "FTS Index Audit Types" }, { "type" : "string", @@ -33525,7 +36406,7 @@ "title" : "Tenant Backup Event Types" }, { "type" : "string", - "enum" : [ "CLUSTER_VERSION_FIXED", "CLUSTER_VERSION_UNFIXED", "CLUSTER_FCV_FIXED", "CLUSTER_FCV_UNFIXED", "AGENT_VERSION_FIXED", "AGENT_VERSION_UNFIXED", "FIXED_VERSION_UPDATED", "FIXED_AGENT_VERSION_UPDATED", "CLUSTER_FCV_DOWNGRADED" ], + "enum" : [ "CLUSTER_VERSION_FIXED", "CLUSTER_VERSION_UNFIXED", "CLUSTER_FCV_FIXED", "CLUSTER_FCV_UNFIXED", "CLUSTER_FCV_EXPIRATION_DATE_UPDATED", "AGENT_VERSION_FIXED", "AGENT_VERSION_UNFIXED", "FIXED_VERSION_UPDATED", "FIXED_AGENT_VERSION_UPDATED", "CLUSTER_FCV_DOWNGRADED", "CLUSTER_BINARY_VERSION_DOWNGRADED", "CLUSTER_BINARY_VERSION_UPGRADED" ], "title" : "Version Audit Types" } ] }, @@ -33849,7 +36730,6 @@ }, "hostnameSchemaType" : { "type" : "string", - "default" : "PUBLIC", "description" : "The network type to use between the migration host and the destination cluster.", "enum" : [ "PUBLIC", "PRIVATE_LINK", "VPC_PEERING" ] }, @@ -33973,28 +36853,19 @@ "createdAt" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when someone created this export job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "description" : "Date and time when a user or Atlas created the Export Job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", "readOnly" : true }, "customData" : { "type" : "array", - "description" : "Collection of key-value pairs that represent custom data for the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes.", + "description" : "Collection of key-value pairs that represent custom data for the metadata file that MongoDB Cloud uploads when the Export Job finishes.", "items" : { "$ref" : "#/components/schemas/BackupLabel" } }, - "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\"`.", - "items" : { - "type" : "string", - "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download." - }, - "readOnly" : true - }, "exportBucketId" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket to export to.", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -34007,7 +36878,7 @@ "finishedAt" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when this export job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "description" : "Date and time when this Export Job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", "readOnly" : true }, "id" : { @@ -34033,7 +36904,7 @@ }, "prefix" : { "type" : "string", - "description" : "Full path on the cloud provider bucket to the folder where the snapshot is exported.", + "description" : "Prefix used for all blob storage objects uploaded as part of the Export Job.", "pattern" : "/exported_snapshots/\\{ORG-NAME\\}/\\{PROJECT-NAME\\}/\\{CLUSTER-NAME\\}/\\{SNAPSHOT-INITIATION-DATE\\}/\\{TIMESTAMP\\}", "readOnly" : true }, @@ -34047,7 +36918,7 @@ }, "state" : { "type" : "string", - "description" : "State of the export job.", + "description" : "State of the Export Job.", "enum" : [ "Cancelled", "Failed", "InProgress", "Queued", "Successful" ], "readOnly" : true } @@ -34066,7 +36937,7 @@ }, "exportBucketId" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket to export to.", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -34267,7 +37138,15 @@ "properties" : { "downloadUrl" : { "type" : "string", - "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", + "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.", + "items" : { + "$ref" : "#/components/schemas/ApiPrivateDownloadDeliveryUrl" + }, "readOnly" : true }, "replicaSetName" : { @@ -34695,7 +37574,7 @@ "description" : "One or more Uniform Resource Locators (URLs) that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", "items" : { "type" : "string", - "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download." + "description" : "One Uniform Resource Locator that points to the compressed snapshot files for manual download." }, "readOnly" : true }, @@ -34764,6 +37643,14 @@ "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`.", "minimum" : 1199145600 }, + "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.", + "items" : { + "$ref" : "#/components/schemas/ApiPrivateDownloadDeliveryUrl" + }, + "readOnly" : true + }, "snapshotId" : { "type" : "string", "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", @@ -34777,7 +37664,7 @@ "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.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, "targetGroupId" : { "type" : "string", @@ -34817,7 +37704,7 @@ "description" : "Human-readable label that identifies the cluster with the Snapshot you want to return.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "copySettings" : { @@ -34918,7 +37805,7 @@ "description" : "Human-readable label that identifies the cluster with the Snapshot you want to return.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "copySettings" : { @@ -35013,9 +37900,15 @@ "additionalProperties" : { "type" : "object", "description" : "The stats associated with the stream processor.", + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor" + }, "readOnly" : true }, "description" : "The stats associated with the stream processor.", + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor" + }, "readOnly" : true }, "EARPrivateEndpoint" : { @@ -35058,7 +37951,7 @@ "status" : { "type" : "string", "description" : "State of the Encryption At Rest private endpoint.", - "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "ACTIVE", "FAILED" ], + "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "ACTIVE", "FAILED", "PENDING_RECREATION", "DELETING" ], "readOnly" : true } }, @@ -35098,6 +37991,36 @@ "required" : [ "typeName" ], "title" : "Email Notification" }, + "EmployeeAccessGrantView" : { + "type" : "object", + "description" : "MongoDB employee granted access level and expiration for a cluster.", + "properties" : { + "expirationTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Expiration date for the employee access grant." + }, + "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.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "required" : [ "expirationTime", "grantType" ] + }, "EncryptionAtRest" : { "type" : "object", "properties" : { @@ -35112,27 +38035,6 @@ } } }, - "EncryptionAtRestPrivateEndpointRequest" : { - "type" : "object", - "description" : "Create or delete private endpoints from the specified regions list.", - "properties" : { - "cloudProvider" : { - "type" : "string", - "description" : "Cloud service provider name.", - "enum" : [ "AZURE" ] - }, - "regions" : { - "type" : "array", - "description" : "List of regions.", - "items" : { - "type" : "string" - }, - "uniqueItems" : true - } - }, - "required" : [ "cloudProvider" ], - "title" : "Encryption At Rest Private Endpoints setup." - }, "EncryptionKeyAlertConfigViewForNdsGroup" : { "type" : "object", "description" : "Encryption key alert configuration allows to select thresholds which trigger alerts and how users are notified.", @@ -35358,7 +38260,7 @@ "title" : "Export Bucket Audit Types" }, { "type" : "string", - "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEX_CREATED", "FTS_INDEX_UPDATED", "FTS_INDEX_DELETED", "FTS_INDEX_CLEANED_UP", "FTS_INDEXES_RESTORED", "FTS_INDEXES_RESTORE_FAILED" ], + "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" : "FTS Index Audit Types" }, { "type" : "string", @@ -35378,7 +38280,7 @@ "title" : "Group Integration 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_ENOUGH_DISK_SPACE", "HOST_NOT_ENOUGH_DISK_SPACE" ], + "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_ENOUGH_DISK_SPACE", "HOST_NOT_ENOUGH_DISK_SPACE" ], "title" : "Host Event Types" }, { "type" : "string", @@ -35390,7 +38292,7 @@ "title" : "Index Build 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_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_SSL_ROTATED", "CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER", "CLUSTER_INSTANCE_SSL_REVOKED", "RELOAD_SSL_ON_PROCESSES", "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", "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", "MOVE_SKIPPED", "PROXY_RESTARTED", "PROXY_PANICKED", "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", "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", "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", "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", "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", "PENDING_INDEXES_DELETED", "PENDING_INDEXES_CANCELED", "PROCESS_RESTART_REQUESTED", "AUTO_HEALING_ACTION", "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", "CLUSTER_FORCE_RECONFIG_REQUESTED", "PROJECT_BYPASSED_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", "ATLAS_SQL_SCHEDULED_UPDATE_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_MODIFIED", "ATLAS_SQL_SCHEDULED_UPDATE_REMOVED" ], + "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_SSL_ROTATED", "CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER", "CLUSTER_INSTANCE_SSL_REVOKED", "RELOAD_SSL_ON_PROCESSES", "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", "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", "MOVE_SKIPPED", "PROXY_RESTARTED", "PROXY_PANICKED", "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", "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", "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", "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", "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", "CLUSTER_FORCE_RECONFIG_REQUESTED", "PROJECT_BYPASSED_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" ], "title" : "NDS Audit Types" }, { "type" : "string", @@ -35490,7 +38392,7 @@ "title" : "User Event Types" }, { "type" : "string", - "enum" : [ "CLUSTER_VERSION_FIXED", "CLUSTER_VERSION_UNFIXED", "CLUSTER_FCV_FIXED", "CLUSTER_FCV_UNFIXED", "AGENT_VERSION_FIXED", "AGENT_VERSION_UNFIXED", "FIXED_VERSION_UPDATED", "FIXED_AGENT_VERSION_UPDATED", "CLUSTER_FCV_DOWNGRADED" ], + "enum" : [ "CLUSTER_VERSION_FIXED", "CLUSTER_VERSION_UNFIXED", "CLUSTER_FCV_FIXED", "CLUSTER_FCV_UNFIXED", "CLUSTER_FCV_EXPIRATION_DATE_UPDATED", "AGENT_VERSION_FIXED", "AGENT_VERSION_UNFIXED", "FIXED_VERSION_UPDATED", "FIXED_AGENT_VERSION_UPDATED", "CLUSTER_FCV_DOWNGRADED", "CLUSTER_BINARY_VERSION_DOWNGRADED", "CLUSTER_BINARY_VERSION_UPGRADED" ], "title" : "Version Audit Types" }, { "type" : "string", @@ -35560,6 +38462,10 @@ "type" : "string", "enum" : [ "GROUP_TAGS_MODIFIED" ], "title" : "Resource Event Types" + }, { + "type" : "string", + "enum" : [ "RESOURCE_POLICY_CREATED", "RESOURCE_POLICY_MODIFIED", "RESOURCE_POLICY_DELETED" ], + "title" : "Atlas Resource Policy Audit Types" } ] }, "EventViewForNdsGroup" : { @@ -35638,6 +38544,8 @@ "$ref" : "#/components/schemas/UserEventViewForOrg" }, { "$ref" : "#/components/schemas/ResourceEventViewForOrg" + }, { + "$ref" : "#/components/schemas/AtlasResourcePolicyAuditForOrg" } ] }, "ExampleResourceResponse20230101" : { @@ -35698,7 +38606,7 @@ }, "ExportStatus" : { "type" : "object", - "description" : "State of the export job for the collections on the replica set only.", + "description" : "State of the Export Job.", "properties" : { "exportedCollections" : { "type" : "integer", @@ -35733,7 +38641,7 @@ "FTSIndexAuditTypeView" : { "type" : "string", "description" : "Unique identifier of event type.", - "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEX_CREATED", "FTS_INDEX_UPDATED", "FTS_INDEX_DELETED", "FTS_INDEX_CLEANED_UP", "FTS_INDEXES_RESTORED", "FTS_INDEXES_RESTORE_FAILED" ], + "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" ], "example" : "FTS_INDEX_CREATED", "title" : "FTS Index Audit Types" }, @@ -36639,37 +39547,53 @@ }, "title" : "Field Transformation" }, - "ForNdsGroup" : { + "FieldViolation" : { "type" : "object", - "description" : "ReplicaSet Event identifies different activities about replica set of mongod instances.", "properties" : { - "created" : { + "description" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "description" : "A description of why the request element is bad." }, - "eventTypeName" : { - "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroup" + "field" : { + "type" : "string", + "description" : "A path that leads to a field in the request body." + } + }, + "required" : [ "description", "field" ] + }, + "FlexBackupRestoreJob20250101" : { + "type" : "object", + "description" : "Details for one restore job of a flex cluster.", + "properties" : { + "deliveryType" : { + "type" : "string", + "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", + "enum" : [ "RESTORE", "DOWNLOAD" ], + "readOnly" : true }, - "groupId" : { + "expirationDate" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, + "instanceName" : { + "type" : "string", + "description" : "Human-readable label that identifies the source instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "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.", @@ -36682,485 +39606,317 @@ }, "readOnly" : true }, - "orgId" : { + "projectId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "port" : { - "type" : "integer", - "format" : "int32", - "description" : "IANA port on which the MongoDB process listens for requests.", - "example" : 27017, + "restoreFinishedDate" : { + "type" : "string", + "format" : "date-time", + "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.", "readOnly" : true }, - "raw" : { - "$ref" : "#/components/schemas/raw" - }, - "replicaSetName" : { + "restoreScheduledDate" : { "type" : "string", - "description" : "Human-readable label of the replica set associated with the event.", - "example" : "event-replica-set", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "shardName" : { + "snapshotFinishedDate" : { "type" : "string", - "description" : "Human-readable label of the shard associated with the event.", - "example" : "event-sh-01", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true - } - }, - "required" : [ "created", "eventTypeName", "id" ], - "title" : "ReplicaSet Events" - }, - "GCPCloudProviderContainer" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/CloudProviderContainer" - }, { - "type" : "object", - "properties" : { - "atlasCidrBlock" : { - "type" : "string", - "description" : "IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.\n\nThese CIDR blocks must fall within the ranges reserved per RFC 1918. GCP further limits the block to a lower bound of the `/18` range.\n\nTo modify the CIDR block, the target project cannot have:\n\n- Any M10 or greater clusters\n- Any other VPC peering connections\n\n 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.\n\n **Example:** A project in an Google Cloud (GCP) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets.", - "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" - }, - "gcpProjectId" : { - "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.", - "maxLength" : 26, - "minLength" : 26, - "pattern" : "^p-[0-9a-z]{24}$", - "readOnly" : true - }, - "networkName" : { - "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.", - "maxLength" : 36, - "minLength" : 36, - "pattern" : "^nt-[0-9a-f]{24}-[0-9a-z]{8}$", - "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.", - "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.", - "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" ] - } - } - } - } ], - "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", - "required" : [ "atlasCidrBlock" ], - "title" : "GCP" - }, - "GCPComputeAutoScaling" : { - "type" : "object", - "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", - "properties" : { - "maxInstanceSize" : { + }, + "snapshotId" : { "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" ], - "title" : "GCP Instance Sizes" + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "minInstanceSize" : { + "snapshotUrl" : { "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" ], - "title" : "GCP Instance Sizes" - } - }, - "title" : "GCP" - }, - "GCPConsumerForwardingRule" : { - "type" : "object", - "properties" : { - "endpointName" : { + "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" : "Human-readable label that identifies the Google Cloud consumer forwarding rule that you created.", - "externalDocs" : { - "description" : "Google Cloud Forwarding Rule Concepts", - "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" - }, + "description" : "Phase of the restore workflow for this job at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], "readOnly" : true }, - "ipAddress" : { + "targetDeploymentItemName" : { "type" : "string", - "description" : "One Private Internet Protocol version 4 (IPv4) address to which this Google Cloud consumer forwarding rule resolves.", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "description" : "Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another USS instance or Dedicated cluster tier.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", "readOnly" : true }, - "status" : { + "targetProjectId" : { "type" : "string", - "description" : "State of the MongoDB Cloud endpoint group when MongoDB Cloud received this request.", - "enum" : [ "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true } - } + }, + "title" : "Flex Backup Restore Job" }, - "GCPEndpointService" : { + "FlexBackupRestoreJobCreate20250101" : { "type" : "object", - "description" : "Group of Private Endpoint Service settings.", + "description" : "Details to create one restore job of a flex cluster.", "properties" : { - "cloudProvider" : { + "_snapshotId" : { "type" : "string", - "description" : "Cloud service provider that serves the requested endpoint service.", - "enum" : [ "AWS", "AZURE", "GCP" ], - "readOnly" : true + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true }, - "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" - }, - "items" : { - "type" : "string", - "description" : "One Google Cloud network endpoint group that corresponds to the Private Service Connect endpoint service." - } + "_targetDeploymentItemName" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another flex cluster or dedicated cluster tier.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", + "writeOnly" : true }, - "errorMessage" : { + "_targetProjectId" : { "type" : "string", - "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "deliveryType" : { + "type" : "string", + "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", + "enum" : [ "RESTORE", "DOWNLOAD" ], + "readOnly" : true + }, + "expirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "regionName" : { + "instanceName" : { "type" : "string", - "description" : "Cloud provider region that manages this Private Endpoint Service.", + "description" : "Human-readable label that identifies the source instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, - "serviceAttachmentNames" : { + "links" : { "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.", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", "externalDocs" : { - "description" : "Google Cloud Private Service Connect Service Attachments", - "url" : "https://cloud.google.com/vpc/docs/private-service-connect#service-attachments" + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" }, "items" : { - "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.", - "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\\-]+" - } + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true }, - "status" : { + "projectId" : { "type" : "string", - "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", - "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true - } - }, - "required" : [ "cloudProvider" ], - "title" : "GCP" - }, - "GCPHardwareSpec" : { - "type" : "object", - "properties" : { - "instanceSize" : { + }, + "restoreFinishedDate" : { "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" ], - "title" : "GCP Instance Sizes" + "format" : "date-time", + "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.", + "readOnly" : true }, - "nodeCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." - } - } - }, - "GCPHardwareSpec20240805" : { - "type" : "object", - "properties" : { - "diskSizeGB" : { - "type" : "number", - "format" : "double", - "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", - "maximum" : 4096, - "minimum" : 10 - }, - "instanceSize" : { - "type" : "string", - "description" : "Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as \"base nodes\") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.", - "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], - "title" : "GCP Instance Sizes" - }, - "nodeCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." - } - } - }, - "GCPNetworkPeeringConnectionSettings" : { - "type" : "object", - "description" : "Group of Network Peering connection settings.", - "properties" : { - "containerId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" - }, - "errorMessage" : { + "restoreScheduledDate" : { "type" : "string", - "description" : "Details of the error returned when requesting a GCP network peering resource. The resource returns `null` if the request succeeded.", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "gcpProjectId" : { - "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.", - "maxLength" : 30, - "minLength" : 6, - "pattern" : "^[a-z][0-9a-z-]{4,28}[0-9a-z]{1}" - }, - "id" : { + "snapshotFinishedDate" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "networkName" : { - "type" : "string", - "description" : "Human-readable label that identifies the network to peer with the MongoDB Cloud VPC.", - "maxLength" : 63, - "minLength" : 1, - "pattern" : "[a-z]([-a-z0-9]{0,62}[a-z0-9]{0,1})?" - }, - "providerName" : { + "snapshotUrl" : { "type" : "string", - "description" : "Cloud service provider that serves the requested network peering connection.", - "enum" : [ "AWS", "AZURE", "GCP" ] + "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" : "State of the network peering connection at the time you made the request.", - "enum" : [ "ADDING_PEER", "WAITING_FOR_USER", "AVAILABLE", "FAILED", "DELETING" ], + "description" : "Phase of the restore workflow for this job at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], "readOnly" : true } }, - "required" : [ "containerId", "gcpProjectId", "networkName" ], - "title" : "GCP" - }, - "GCPRegionConfig" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/CloudRegionConfig" - }, { - "type" : "object", - "properties" : { - "analyticsAutoScaling" : { - "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" - }, - "analyticsSpecs" : { - "$ref" : "#/components/schemas/DedicatedHardwareSpec" - }, - "autoScaling" : { - "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" - }, - "readOnlySpecs" : { - "$ref" : "#/components/schemas/DedicatedHardwareSpec" - } - } - } ], - "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", - "title" : "GCP Regional Replication Specifications" + "required" : [ "_snapshotId", "_targetDeploymentItemName" ], + "title" : "Create Flex Backup Restore Job" }, - "GCPRegionConfig20240805" : { + "FlexBackupSettings20250101" : { "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/CloudRegionConfig20240805" - }, { - "type" : "object", - "properties" : { - "analyticsAutoScaling" : { - "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" - }, - "analyticsSpecs" : { - "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" - }, - "autoScaling" : { - "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" - }, - "readOnlySpecs" : { - "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" - } + "description" : "Flex backup configuration", + "properties" : { + "enabled" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether backups are performed for this flex cluster. Backup uses [TODO](TODO) for flex clusters.", + "readOnly" : true } - } ], - "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", - "title" : "GCP Regional Replication Specifications" + }, + "readOnly" : true, + "title" : "Flex Backup Configuration" }, - "GeoSharding" : { + "FlexBackupSnapshot20250101" : { "type" : "object", + "description" : "Details for one snapshot of a flex cluster.", "properties" : { - "customZoneMapping" : { - "type" : "object", - "additionalProperties" : { - "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `id` property.\n\nThis parameter returns an empty object if no custom zones exist.", - "readOnly" : true - }, - "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `id` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "expiration" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "managedNamespaces" : { - "type" : "array", - "description" : "List that contains a namespace for a Global Cluster. MongoDB Cloud manages this cluster.", - "items" : { - "$ref" : "#/components/schemas/ManagedNamespaces" - }, + "finishTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "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 - } - } - }, - "GeoSharding20240805" : { - "type" : "object", - "properties" : { - "customZoneMapping" : { - "type" : "object", - "additionalProperties" : { - "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.\n\nThis parameter returns an empty object if no custom zones exist.", - "readOnly" : true - }, - "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "managedNamespaces" : { + "links" : { "type" : "array", - "description" : "List that contains a namespace for a Global Cluster. MongoDB Cloud manages this cluster.", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, "items" : { - "$ref" : "#/components/schemas/ManagedNamespaces" + "$ref" : "#/components/schemas/Link" }, "readOnly" : true }, - "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.", + "mongoDBVersion" : { + "type" : "string", + "description" : "MongoDB host version that the snapshot runs.", "readOnly" : true - } - } - }, - "GoogleCloudKMS" : { - "type" : "object", - "description" : "Details that define the configuration of Encryption at Rest using Google Cloud Key Management Service (KMS).", - "externalDocs" : { - "description" : "Google Cloud Key Management Service", - "url" : "https://www.mongodb.com/docs/atlas/security-gcp-kms/" - }, - "properties" : { - "enabled" : { - "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" : { + "scheduledTime" : { "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" + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will take the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true }, - "serviceAccountKey" : { + "startTime" : { "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.", - "externalDocs" : { - "description" : "Google Cloud Authentication", - "url" : "https://cloud.google.com/docs/authentication/getting-started" - }, - "writeOnly" : true - }, - "valid" : { - "type" : "boolean", - "description" : "Flag that indicates whether the Google Cloud Key Management Service (KMS) encryption key can encrypt and decrypt data.", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began taking the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true - } - } - }, - "GreaterThanDaysThresholdView" : { - "type" : "object", - "description" : "Threshold value that triggers an alert.", - "properties" : { - "operator" : { - "type" : "string", - "description" : "Comparison operator to apply when checking the current metric value.", - "enum" : [ "GREATER_THAN" ] - }, - "threshold" : { - "type" : "integer", - "format" : "int32", - "description" : "Value of metric that, when exceeded, triggers an alert." }, - "units" : { + "status" : { "type" : "string", - "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", - "enum" : [ "DAYS" ] + "description" : "Phase of the workflow for this snapshot at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true } - } + }, + "title" : "Flex Backup Snapshot" }, - "GreaterThanRawThreshold" : { + "FlexBackupSnapshotDownloadCreate20250101" : { "type" : "object", - "description" : "A Limit that triggers an alert when greater than a number.", + "description" : "Details for one backup snapshot download of a flex cluster.", "properties" : { - "operator" : { + "_snapshotId" : { "type" : "string", - "description" : "Comparison operator to apply when checking the current metric value.", - "enum" : [ "GREATER_THAN" ] - }, - "threshold" : { - "type" : "integer", - "format" : "int32", - "description" : "Value of metric that, when exceeded, triggers an alert." + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to download.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true }, - "units" : { - "$ref" : "#/components/schemas/RawMetricUnits" + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true } }, - "title" : "Greater Than Raw Threshold" + "required" : [ "_snapshotId" ], + "title" : "Flex Backup Snapshot Download Create" }, - "GreaterThanRawThresholdAlertConfigViewForNdsGroup" : { + "FlexClusterDescription20250101" : { "type" : "object", + "description" : "Group of settings that configure a MongoDB Flex cluster.", "properties" : { - "created" : { + "backupSettings" : { + "$ref" : "#/components/schemas/FlexBackupSettings20250101" + }, + "clusterType" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Flex cluster topology.", + "enum" : [ "REPLICASET", "LOADBALANCED" ], "readOnly" : true }, - "enabled" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + "connectionStrings" : { + "$ref" : "#/components/schemas/FlexConnectionStrings20250101" }, - "eventTypeName" : { - "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this instance. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true }, "groupId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "description" : "Unique 24-hexadecimal character string that identifies the project.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -37169,7 +39925,7 @@ }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "description" : "Unique 24-hexadecimal digit string that identifies the instance.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -37188,76 +39944,60 @@ }, "readOnly" : true }, - "matchers" : { - "type" : "array", - "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", - "items" : { - "$ref" : "#/components/schemas/ReplicaSetMatcher" - } + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the instance runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true }, - "notifications" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "readOnly" : true + }, + "providerSettings" : { + "$ref" : "#/components/schemas/FlexProviderSettings20250101" + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of this instance.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { "type" : "array", - "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, "items" : { - "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + "$ref" : "#/components/schemas/ResourceTag" } }, - "threshold" : { - "$ref" : "#/components/schemas/GreaterThanRawThreshold" + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." }, - "updated" : { + "versionReleaseSystem" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions.", + "enum" : [ "LTS" ], "readOnly" : true } }, - "required" : [ "eventTypeName", "notifications" ] - }, - "GreaterThanTimeThreshold" : { - "type" : "object", - "description" : "A Limit that triggers an alert when greater than a time period.", - "properties" : { - "operator" : { - "type" : "string", - "description" : "Comparison operator to apply when checking the current metric value.", - "enum" : [ "GREATER_THAN" ] - }, - "threshold" : { - "type" : "integer", - "format" : "int32", - "description" : "Value of metric that, when exceeded, triggers an alert." - }, - "units" : { - "$ref" : "#/components/schemas/TimeMetricUnits" - } - }, - "title" : "Greater Than Time Threshold" + "required" : [ "providerSettings" ], + "title" : "Flex Cluster Description" }, - "Group" : { + "FlexClusterDescriptionCreate20250101" : { "type" : "object", + "description" : "Settings that you can specify when you create a flex cluster.", "properties" : { - "clusterCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Quantity of MongoDB Cloud clusters deployed in this project.", - "readOnly" : true - }, - "created" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created this project. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true - }, - "id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, "links" : { "type" : "array", "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", @@ -37272,111 +40012,899 @@ }, "name" : { "type" : "string", - "description" : "Human-readable label that identifies the project included in the MongoDB Cloud organization.", + "description" : "Human-readable label that identifies the instance.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" - }, - "orgId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud organization to which the project belongs.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "writeOnly" : true }, - "regionUsageRestrictions" : { - "type" : "string", - "default" : "COMMERCIAL_FEDRAMP_REGIONS_ONLY", - "description" : "Applies to Atlas for Government only.\n\nIn Commercial Atlas, this field will be rejected in requests and missing in responses.\n\nThis field sets restrictions on available regions in the project.\n\n| Value | Available Regions |\n|-----------------------------------|------------|\n| `COMMERCIAL_FEDRAMP_REGIONS_ONLY` | Only allows deployments in FedRAMP Moderate regions.|\n| `GOV_REGIONS_ONLY` | Only allows deployments in GovCloud regions.|", - "enum" : [ "COMMERCIAL_FEDRAMP_REGIONS_ONLY", "GOV_REGIONS_ONLY" ], - "externalDocs" : { - "url" : "https://www.mongodb.com/docs/atlas/government/overview/supported-regions/#supported-cloud-providers-and-regions" - } + "providerSettings" : { + "$ref" : "#/components/schemas/FlexProviderSettingsCreate20250101" }, "tags" : { "type" : "array", - "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the project.", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.", "externalDocs" : { "description" : "Resource Tags", - "url" : "https://www.mongodb.com/docs/atlas/tags" + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" }, "items" : { "$ref" : "#/components/schemas/ResourceTag" } }, - "withDefaultAlertsSettings" : { + "terminationProtectionEnabled" : { "type" : "boolean", - "description" : "Flag that indicates whether to create the project with default alert settings.", - "writeOnly" : true + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." } }, - "required" : [ "clusterCount", "created", "name", "orgId" ] - }, - "GroupAlertsConfig" : { - "type" : "object", - "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/StreamProcessorAlertConfigViewForNdsGroup" - } ] + "required" : [ "name", "providerSettings" ], + "title" : "Flex Cluster Description Create" }, - "GroupIPAddresses" : { + "FlexConnectionStrings20250101" : { "type" : "object", - "description" : "List of IP addresses in a project.", + "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, "properties" : { - "groupId" : { + "standard" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "description" : "Public connection string that you can use to connect to this cluster. This connection string uses the mongodb:// protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, "readOnly" : true }, - "services" : { - "$ref" : "#/components/schemas/GroupService" + "standardSrv" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this flex cluster. This connection string uses the `mongodb+srv://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true } }, - "title" : "Group IP Address" + "readOnly" : true, + "title" : "Flex Cluster Connection Strings" }, - "GroupInvitation" : { + "FlexProviderSettings20250101" : { "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB flex cluster.", "properties" : { - "createdAt" : { + "backingProviderName" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud sent the invitation. This parameter expresses its value in ISO 8601 format in UTC.", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the flex cluster.", + "enum" : [ "AWS", "AZURE", "GCP" ], "readOnly" : true }, - "expiresAt" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud expires the invitation. This parameter expresses its value in ISO 8601 format in UTC.", + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity available to the flex cluster expressed in gigabytes.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "default" : "FLEX", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "FLEX" ], + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB flex cluster. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Cloud Service Provider Settings for a Flex Cluster" + }, + "FlexProviderSettingsCreate20250101" : { + "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB flex cluster.", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the flex cluster.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "writeOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity available to the flex cluster expressed in gigabytes.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "default" : "FLEX", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "FLEX" ], + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB flex cluster. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).", + "writeOnly" : true + } + }, + "required" : [ "backingProviderName", "regionName" ], + "title" : "Cloud Service Provider Settings for a Flex Cluster", + "writeOnly" : true + }, + "ForNdsGroup" : { + "type" : "object", + "description" : "ReplicaSet Event identifies different activities about replica set of mongod instances.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "ReplicaSet Events" + }, + "GCPCloudProviderContainer" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, { + "type" : "object", + "properties" : { + "atlasCidrBlock" : { + "type" : "string", + "description" : "IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.\n\nThese CIDR blocks must fall within the ranges reserved per RFC 1918. GCP further limits the block to a lower bound of the `/18` range.\n\nTo modify the CIDR block, the target project cannot have:\n\n- Any M10 or greater clusters\n- Any other VPC peering connections\n\n 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.\n\n **Example:** A project in an Google Cloud (GCP) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets.", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + }, + "gcpProjectId" : { + "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.", + "maxLength" : 26, + "minLength" : 26, + "pattern" : "^p-[0-9a-z]{24}$", + "readOnly" : true + }, + "networkName" : { + "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.", + "maxLength" : 36, + "minLength" : 36, + "pattern" : "^nt-[0-9a-f]{24}-[0-9a-z]{8}$", + "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.", + "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.", + "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" ] + } + } + } + } ], + "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", + "required" : [ "atlasCidrBlock" ], + "title" : "GCP" + }, + "GCPComputeAutoScaling" : { + "type" : "object", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", + "properties" : { + "maxInstanceSize" : { + "type" : "string", + "description" : "Maximum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "minInstanceSize" : { + "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" ], + "title" : "GCP Instance Sizes" + } + }, + "title" : "GCP" + }, + "GCPConsumerForwardingRule" : { + "type" : "object", + "properties" : { + "endpointName" : { + "type" : "string", + "description" : "Human-readable label that identifies the Google Cloud consumer forwarding rule that you created.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "One Private Internet Protocol version 4 (IPv4) address to which this Google Cloud consumer forwarding rule resolves.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the MongoDB Cloud endpoint group when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + } + }, + "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" ] + } + } + } ] + }, + "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.", + "enum" : [ "CENTRAL_US", "WESTERN_EUROPE" ], + "readOnly" : true + } + } + } ] + }, + "GCPEndpointService" : { + "type" : "object", + "description" : "Group of Private Endpoint Service settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "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" + }, + "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" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "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" + }, + "items" : { + "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.", + "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\\-]+" + } + }, + "status" : { + "type" : "string", + "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "GCP" + }, + "GCPHardwareSpec" : { + "type" : "object", + "properties" : { + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts 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" ], + "title" : "GCP Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "GCPHardwareSpec20240805" : { + "type" : "object", + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as \"base nodes\") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "GCPNetworkPeeringConnectionSettings" : { + "type" : "object", + "description" : "Group of Network Peering connection settings.", + "properties" : { + "containerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "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" : { + "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.", + "maxLength" : 30, + "minLength" : 6, + "pattern" : "^[a-z][0-9a-z-]{4,28}[0-9a-z]{1}" + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "networkName" : { + "type" : "string", + "description" : "Human-readable label that identifies the network to peer with the MongoDB Cloud VPC.", + "maxLength" : 63, + "minLength" : 1, + "pattern" : "[a-z]([-a-z0-9]{0,62}[a-z0-9]{0,1})?" + }, + "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.", + "enum" : [ "ADDING_PEER", "WAITING_FOR_USER", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "containerId", "gcpProjectId", "networkName" ], + "title" : "GCP" + }, + "GCPRegionConfig" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "GCP Regional Replication Specifications" + }, + "GCPRegionConfig20240805" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20240805" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "GCP Regional Replication Specifications" + }, + "GeoSharding" : { + "type" : "object", + "properties" : { + "customZoneMapping" : { + "type" : "object", + "additionalProperties" : { + "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `id` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `id` property.\n\nThis 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.", + "items" : { + "$ref" : "#/components/schemas/ManagedNamespaces" + }, + "readOnly" : true + }, + "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 + } + } + }, + "GeoSharding20240805" : { + "type" : "object", + "properties" : { + "customZoneMapping" : { + "type" : "object", + "additionalProperties" : { + "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.\n\nThis 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.", + "items" : { + "$ref" : "#/components/schemas/ManagedNamespaces" + }, + "readOnly" : true + }, + "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 + } + } + }, + "GoogleCloudKMS" : { + "type" : "object", + "description" : "Details that define the configuration of Encryption at Rest using Google Cloud Key Management Service (KMS).", + "externalDocs" : { + "description" : "Google Cloud Key Management Service", + "url" : "https://www.mongodb.com/docs/atlas/security-gcp-kms/" + }, + "properties" : { + "enabled" : { + "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" + }, + "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.", + "externalDocs" : { + "description" : "Google Cloud Authentication", + "url" : "https://cloud.google.com/docs/authentication/getting-started" + }, + "writeOnly" : true + }, + "valid" : { + "type" : "boolean", + "description" : "Flag that indicates whether the Google Cloud Key Management Service (KMS) encryption key can encrypt and decrypt data.", + "readOnly" : true + } + } + }, + "GreaterThanDaysThresholdView" : { + "type" : "object", + "description" : "Threshold value that triggers an alert.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "GREATER_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "DAYS" ] + } + } + }, + "GreaterThanRawThreshold" : { + "type" : "object", + "description" : "A Limit that triggers an alert when greater than a number.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "GREATER_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/RawMetricUnits" + } + }, + "title" : "Greater Than Raw Threshold" + }, + "GreaterThanRawThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ReplicaSetMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/GreaterThanRawThreshold" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ] + }, + "GreaterThanTimeThreshold" : { + "type" : "object", + "description" : "A Limit that triggers an alert when greater than a time period.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "GREATER_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "title" : "Greater Than Time Threshold" + }, + "Group" : { + "type" : "object", + "properties" : { + "clusterCount" : { + "type" : "integer", + "format" : "int64", + "description" : "Quantity of MongoDB Cloud clusters deployed in this project.", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this project. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the project included in the MongoDB Cloud organization.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud organization to which the project belongs.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "regionUsageRestrictions" : { + "type" : "string", + "default" : "COMMERCIAL_FEDRAMP_REGIONS_ONLY", + "description" : "Applies to Atlas for Government only.\n\nIn Commercial Atlas, this field will be rejected in requests and missing in responses.\n\nThis field sets restrictions on available regions in the project.\n\n| Value | Available Regions |\n|-----------------------------------|------------|\n| `COMMERCIAL_FEDRAMP_REGIONS_ONLY` | Only allows deployments in FedRAMP Moderate regions.|\n| `GOV_REGIONS_ONLY` | Only allows deployments in GovCloud regions.|", + "enum" : [ "COMMERCIAL_FEDRAMP_REGIONS_ONLY", "GOV_REGIONS_ONLY" ], + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/government/overview/supported-regions/#supported-cloud-providers-and-regions" + } + }, + "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" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "withDefaultAlertsSettings" : { + "type" : "boolean", + "description" : "Flag that indicates whether to create the project with default alert settings.", + "writeOnly" : true + } + }, + "required" : [ "clusterCount", "created", "name", "orgId" ] + }, + "GroupAlertsConfig" : { + "type" : "object", + "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/StreamProcessorAlertConfigViewForNdsGroup" + } ] + }, + "GroupIPAddresses" : { + "type" : "object", + "description" : "List of IP addresses in a project.", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "services" : { + "$ref" : "#/components/schemas/GroupService" + } + }, + "title" : "Group IP Address" + }, + "GroupInvitation" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud sent the invitation. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud expires the invitation. This parameter expresses its value in ISO 8601 format in UTC.", "readOnly" : true }, "groupId" : { @@ -37516,22 +41044,27 @@ "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "pattern" : "^([a-f0-9]{24})$" }, "destinationOrgPrivateApiKey" : { "type" : "string", - "description" : "Unique string that identifies the private part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.", + "description" : "Unique string that identifies the private part of the API Key used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.", "example" : "55c3bbb6-b4bb-0be1-e66d20841f3e", - "readOnly" : true + "externalDocs" : { + "description" : "Grant Programmatic Access to Atlas", + "url" : "https://dochub.mongodb.org/core/atlas-create-prog-api-key" + } }, "destinationOrgPublicApiKey" : { "type" : "string", - "description" : "Unique string that identifies the public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.", + "description" : "Unique string that identifies the public part of the API Key used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.", "example" : "zmmrboas", + "externalDocs" : { + "description" : "Grant Programmatic Access to Atlas", + "url" : "https://dochub.mongodb.org/core/atlas-create-prog-api-key" + }, "maxLength" : 8, - "minLength" : 8, - "readOnly" : true + "minLength" : 8 } } }, @@ -37598,7 +41131,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/EventViewForNdsGroup" }, @@ -37631,6 +41164,28 @@ } } }, + "GroupRoleAssignment" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to which these roles belong.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "groupRoles" : { + "type" : "array", + "description" : "One or more project level roles assigned to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_OWNER", "GROUP_CLUSTER_MANAGER", "GROUP_STREAM_PROCESSING_OWNER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR" ] + }, + "uniqueItems" : true + } + } + }, "GroupService" : { "type" : "object", "description" : "List of IP addresses in a project categorized by services.", @@ -37650,37 +41205,37 @@ "GroupServiceAccount" : { "type" : "object", "properties" : { + "clientId" : { + "type" : "string", + "description" : "The Client ID of the Service Account.", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + }, "createdAt" : { "type" : "string", "format" : "date-time", - "description" : "Service account creation time." + "description" : "The date that the Service Account was created on." }, "description" : { "type" : "string", - "description" : "Description of the service account." - }, - "id" : { - "type" : "string", - "description" : "ID for the service account.", - "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + "description" : "Human readable description for the Service Account." }, "name" : { "type" : "string", - "description" : "Name for service account." + "description" : "Human-readable name for the Service Account." }, "roles" : { "type" : "array", - "description" : "Roles assigned to the Service Account group.", + "description" : "A list of Project roles associated with the Service Account.", "items" : { "type" : "string", - "description" : "Project roles associated with the service account.", + "description" : "Project roles available for Service Accounts.", "enum" : [ "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" ] }, "uniqueItems" : true }, "secrets" : { "type" : "array", - "description" : "List of secrets.", + "description" : "A list of secrets associated with the specified Service Account.", "items" : { "$ref" : "#/components/schemas/ServiceAccountSecret" }, @@ -37693,73 +41248,74 @@ "properties" : { "description" : { "type" : "string", - "description" : "Human readable description for the service account.", + "description" : "Human readable description for the Service Account.", "maxLength" : 250, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "name" : { "type" : "string", - "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "description" : "Human-readable name for the Service Account. The name is modifiable and does not have to be unique.", "maxLength" : 64, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "roles" : { "type" : "array", - "description" : "Project roles associated with the service account.", + "description" : "A list of project-level roles for the Service Account.", "items" : { "type" : "string", - "description" : "Project roles associated with the service account.", + "description" : "Project roles available for Service Accounts.", "enum" : [ "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" ] } }, "secretExpiresAfterHours" : { "type" : "integer", "format" : "int32", - "description" : "Secret expiration time." + "description" : "The expiration time of the new Service Account secret. The expiration is provided in hours." } }, - "required" : [ "description", "name", "secretExpiresAfterHours" ] + "required" : [ "description", "name", "roles", "secretExpiresAfterHours" ] }, "GroupServiceAccountRoleAssignment" : { "type" : "object", "properties" : { "roles" : { "type" : "array", - "description" : "Group access roles.", + "description" : "The Project permissions for the Service Account in the specified Project.", "items" : { "type" : "string", - "description" : "Project roles associated with the service account.", + "description" : "Project roles available for Service Accounts.", "enum" : [ "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" ] }, "uniqueItems" : true } - } + }, + "required" : [ "roles" ] }, "GroupServiceAccountUpdateRequest" : { "type" : "object", "properties" : { "description" : { "type" : "string", - "description" : "Human readable description for the service account.", + "description" : "Human readable description for the Service Account.", "maxLength" : 250, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "name" : { "type" : "string", - "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "description" : "Human-readable name for the Service Account. The name is modifiable and does not have to be unique.", "maxLength" : 64, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "roles" : { "type" : "array", - "description" : "Project roles associated with the service account.", + "description" : "A list of Project roles associated with the Service Account.", "items" : { "type" : "string", - "description" : "Project roles associated with the service account.", + "description" : "Project roles available for Service Accounts.", "enum" : [ "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" ] } } @@ -38003,7 +41559,7 @@ "example" : "cluster1", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -38098,14 +41654,14 @@ "HostEventTypeViewForNdsGroup" : { "type" : "string", "description" : "Unique identifier of event type.", - "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_ENOUGH_DISK_SPACE", "HOST_NOT_ENOUGH_DISK_SPACE" ], + "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_ENOUGH_DISK_SPACE", "HOST_NOT_ENOUGH_DISK_SPACE" ], "example" : "HOST_DOWN", "title" : "Host Event Types" }, "HostEventTypeViewForNdsGroupAlertable" : { "type" : "string", "description" : "Event type that triggers an alert.", - "enum" : [ "HOST_DOWN", "HOST_HAS_INDEX_SUGGESTIONS", "HOST_MONGOT_CRASHING_OOM", "HOST_NOT_ENOUGH_DISK_SPACE" ], + "enum" : [ "HOST_DOWN", "HOST_HAS_INDEX_SUGGESTIONS", "HOST_MONGOT_CRASHING_OOM", "HOST_MONGOT_STOP_REPLICATION", "HOST_NOT_ENOUGH_DISK_SPACE" ], "example" : "HOST_DOWN", "title" : "Host Event Types" }, @@ -38391,6 +41947,7 @@ "OPCOUNTER_REPL_INSERT" : "#/components/schemas/RawMetricAlertView", "OPCOUNTER_REPL_UPDATE" : "#/components/schemas/RawMetricAlertView", "OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricAlertView", + "OPERATIONS_QUERIES_KILLED" : "#/components/schemas/RawMetricAlertView", "OPERATIONS_SCAN_AND_ORDER" : "#/components/schemas/RawMetricAlertView", "OPERATION_THROTTLING_REJECTED_OPERATIONS" : "#/components/schemas/RawMetricAlertView", "OPLOG_MASTER_LAG_TIME_DIFF" : "#/components/schemas/TimeMetricAlertView", @@ -38460,7 +42017,7 @@ "example" : "cluster1", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -38769,6 +42326,7 @@ "OPCOUNTER_REPL_INSERT" : "#/components/schemas/RawMetricEventView", "OPCOUNTER_REPL_UPDATE" : "#/components/schemas/RawMetricEventView", "OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricEventView", + "OPERATIONS_QUERIES_KILLED" : "#/components/schemas/RawMetricEventView", "OPERATIONS_SCAN_AND_ORDER" : "#/components/schemas/RawMetricEventView", "OPERATION_THROTTLING_REJECTED_OPERATIONS" : "#/components/schemas/RawMetricEventView", "OPLOG_MASTER_LAG_TIME_DIFF" : "#/components/schemas/TimeMetricEventView", @@ -39074,6 +42632,7 @@ "OPCOUNTER_REPL_INSERT" : "#/components/schemas/RawMetricThresholdView", "OPCOUNTER_REPL_UPDATE" : "#/components/schemas/RawMetricThresholdView", "OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "OPERATIONS_QUERIES_KILLED" : "#/components/schemas/RawMetricThresholdView", "OPERATIONS_SCAN_AND_ORDER" : "#/components/schemas/RawMetricThresholdView", "OPERATION_THROTTLING_REJECTED_OPERATIONS" : "#/components/schemas/RawMetricThresholdView", "OPLOG_MASTER_LAG_TIME_DIFF" : "#/components/schemas/TimeMetricThresholdView", @@ -39120,7 +42679,9 @@ "enum" : [ "AVERAGE" ] }, "operator" : { - "$ref" : "#/components/schemas/Operator" + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, "threshold" : { "type" : "number", @@ -39472,7 +43033,7 @@ "description" : "Human-readable label that identifies the cluster that incurred the charge.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -39526,7 +43087,7 @@ "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.", - "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_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", "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_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_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" ], + "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_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", "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_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_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_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" ], "readOnly" : true }, "startDate" : { @@ -39816,6 +43377,323 @@ "description" : "Configuration of nodes that comprise the cluster.", "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] }, + "configServerManagementMode" : { + "type" : "string", + "default" : "ATLAS_MANAGED", + "description" : "Config Server Management Mode for creating or updating a sharded cluster.\n\nWhen configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings.\n\nWhen configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server.", + "enum" : [ "ATLAS_MANAGED", "FIXED_TO_DEDICATED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + } + }, + "configServerType" : { + "type" : "string", + "description" : "Describes a sharded cluster's config server type.", + "enum" : [ "DEDICATED", "EMBEDDED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + }, + "readOnly" : true + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/ClusterConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "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.", + "maximum" : 4096, + "minimum" : 10 + }, + "diskWarmingMode" : { + "type" : "string", + "default" : "FULLY_WARMED", + "description" : "Disk warming mode selection.", + "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], + "externalDocs" : { + "description" : "Reduce Secondary Disk Warming Impact", + "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" + } + }, + "encryptionAtRestProvider" : { + "type" : "string", + "description" : "Cloud service provider that manages your customer keys to provide an additional layer of Encryption at Rest for the cluster.", + "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "featureCompatibilityVersion" : { + "type" : "string", + "description" : "Feature compatibility version of the cluster.", + "readOnly" : true + }, + "featureCompatibilityVersionExpirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Feature compatibility version expiration date.", + "readOnly" : true + }, + "globalClusterSelfManagedSharding" : { + "type" : "boolean", + "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen 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.\n\nWhen 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.\n\nThis 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" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "labels" : { + "type" : "array", + "deprecated" : true, + "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBEmployeeAccessGrant" : { + "$ref" : "#/components/schemas/EmployeeAccessGrantView" + }, + "mongoDBMajorVersion" : { + "type" : "string", + "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", + "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-" + } + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the cluster runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)" + }, + "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.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "mongoURIUpdated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated the connection string. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "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.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + }, + "numShards" : { + "type" : "integer", + "format" : "int32", + "default" : 1, + "description" : "Number of shards up to 50 to deploy for a sharded cluster. The resource returns `1` to indicate a replica set and values of `2` and higher to indicate a sharded cluster. The returned value equals the number of shards in the cluster.", + "externalDocs" : { + "description" : "Sharding", + "url" : "https://docs.mongodb.com/manual/sharding/" + }, + "maximum" : 50, + "minimum" : 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", + "default" : "WORKLOAD_TYPE", + "description" : "Set this field to configure the replica set scaling mode for your cluster.\n\nBy default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes.\n\nWhen configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads.\n\nWhen configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads.", + "enum" : [ "SEQUENTIAL", "WORKLOAD_TYPE", "NODE_TYPE" ], + "externalDocs" : { + "description" : "Modify the Replica Set Scaling Mode", + "url" : "https://dochub.mongodb.org/core/scale-nodes" + } + }, + "replicationFactor" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "deprecated" : true, + "description" : "Number of members that belong to the replica set. Each member retains a copy of your databases, providing high availability and data redundancy. Use **replicationSpecs** instead.", + "enum" : [ 3, 5, 7 ] + }, + "replicationSpec" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RegionSpec" + }, + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "title" : "Region Configuration" + }, + "replicationSpecs" : { + "type" : "array", + "description" : "List of settings that configure your cluster regions.\n\n- For Global Clusters, each object in the array represents one zone where MongoDB Cloud deploys your clusters nodes.\n- For non-Global sharded clusters and replica sets, the single object represents where MongoDB Cloud deploys your clusters nodes.", + "items" : { + "$ref" : "#/components/schemas/LegacyReplicationSpec" + } + }, + "rootCertType" : { + "type" : "string", + "default" : "ISRGROOTX1", + "description" : "Root Certificate Authority that MongoDB Atlas clusters uses. MongoDB Cloud supports Internet Security Research Group.", + "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.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the cluster.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", + "enum" : [ "LTS", "CONTINUOUS" ] + } + }, + "title" : "Cluster Description" + }, + "LegacyAtlasTenantClusterUpgradeRequest" : { + "type" : "object", + "description" : "Request containing target state of tenant cluster to be upgraded", + "properties" : { + "acceptDataRisksAndForceReplicaSetReconfig" : { + "type" : "string", + "format" : "date-time", + "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", + "externalDocs" : { + "description" : "Reconfiguring a Replica Set during a regional outage", + "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + } + }, + "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", + "default" : "ATLAS_MANAGED", + "description" : "Config Server Management Mode for creating or updating a sharded cluster.\n\nWhen configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings.\n\nWhen configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server.", + "enum" : [ "ATLAS_MANAGED", "FIXED_TO_DEDICATED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + } + }, + "configServerType" : { + "type" : "string", + "description" : "Describes a sharded cluster's config server type.", + "enum" : [ "DEDICATED", "EMBEDDED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + }, + "readOnly" : true + }, "connectionStrings" : { "$ref" : "#/components/schemas/ClusterConnectionStrings" }, @@ -39851,6 +43729,17 @@ "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" } }, + "featureCompatibilityVersion" : { + "type" : "string", + "description" : "Feature compatibility version of the cluster.", + "readOnly" : true + }, + "featureCompatibilityVersionExpirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Feature compatibility version expiration date.", + "readOnly" : true + }, "globalClusterSelfManagedSharding" : { "type" : "boolean", "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen 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.\n\nWhen 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.\n\nThis setting cannot be changed once the cluster is deployed.", @@ -39897,6 +43786,9 @@ }, "readOnly" : true }, + "mongoDBEmployeeAccessGrant" : { + "$ref" : "#/components/schemas/EmployeeAccessGrantView" + }, "mongoDBMajorVersion" : { "type" : "string", "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", @@ -39939,7 +43831,7 @@ "description" : "Human-readable label that identifies the cluster.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, "numShards" : { "type" : "integer", @@ -39972,259 +43864,16 @@ "providerSettings" : { "$ref" : "#/components/schemas/ClusterProviderSettings" }, - "replicationFactor" : { - "type" : "integer", - "format" : "int32", - "default" : 3, - "deprecated" : true, - "description" : "Number of members that belong to the replica set. Each member retains a copy of your databases, providing high availability and data redundancy. Use **replicationSpecs** instead.", - "enum" : [ 3, 5, 7 ] - }, - "replicationSpec" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/RegionSpec" - }, - "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", - "title" : "Region Configuration" - }, - "replicationSpecs" : { - "type" : "array", - "description" : "List of settings that configure your cluster regions.\n\n- For Global Clusters, each object in the array represents one zone where MongoDB Cloud deploys your clusters nodes.\n- For non-Global sharded clusters and replica sets, the single object represents where MongoDB Cloud deploys your clusters nodes.", - "items" : { - "$ref" : "#/components/schemas/LegacyReplicationSpec" - } - }, - "rootCertType" : { - "type" : "string", - "default" : "ISRGROOTX1", - "description" : "Root Certificate Authority that MongoDB Atlas clusters uses. MongoDB Cloud supports Internet Security Research Group.", - "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.", - "externalDocs" : { - "description" : "Connection string URI format.", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, - "readOnly" : true - }, - "stateName" : { + "replicaSetScalingStrategy" : { "type" : "string", - "description" : "Human-readable label that indicates the current operating condition of the cluster.", - "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], - "readOnly" : true - }, - "tags" : { - "type" : "array", - "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "default" : "WORKLOAD_TYPE", + "description" : "Set this field to configure the replica set scaling mode for your cluster.\n\nBy default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes.\n\nWhen configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads.\n\nWhen configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads.", + "enum" : [ "SEQUENTIAL", "WORKLOAD_TYPE", "NODE_TYPE" ], "externalDocs" : { - "description" : "Resource Tags", - "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" - }, - "items" : { - "$ref" : "#/components/schemas/ResourceTag" - } - }, - "terminationProtectionEnabled" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." - }, - "versionReleaseSystem" : { - "type" : "string", - "default" : "LTS", - "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", - "enum" : [ "LTS", "CONTINUOUS" ] - } - }, - "title" : "Cluster Description" - }, - "LegacyAtlasTenantClusterUpgradeRequest" : { - "type" : "object", - "description" : "Request containing target state of tenant cluster to be upgraded", - "properties" : { - "acceptDataRisksAndForceReplicaSetReconfig" : { - "type" : "string", - "format" : "date-time", - "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", - "externalDocs" : { - "description" : "Reconfiguring a Replica Set during a regional outage", - "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + "description" : "Modify the Replica Set Scaling Mode", + "url" : "https://dochub.mongodb.org/core/scale-nodes" } }, - "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" ] - }, - "connectionStrings" : { - "$ref" : "#/components/schemas/ClusterConnectionStrings" - }, - "createDate" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", - "readOnly" : true - }, - "diskSizeGB" : { - "type" : "number", - "format" : "double", - "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.", - "maximum" : 4096, - "minimum" : 10 - }, - "diskWarmingMode" : { - "type" : "string", - "default" : "FULLY_WARMED", - "description" : "Disk warming mode selection.", - "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], - "externalDocs" : { - "description" : "Reduce Secondary Disk Warming Impact", - "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" - } - }, - "encryptionAtRestProvider" : { - "type" : "string", - "description" : "Cloud service provider that manages your customer keys to provide an additional layer of Encryption at Rest for the cluster.", - "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], - "externalDocs" : { - "description" : "Encryption at Rest using Customer Key Management", - "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" - } - }, - "globalClusterSelfManagedSharding" : { - "type" : "boolean", - "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen 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.\n\nWhen 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.\n\nThis 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" : { - "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the project.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "labels" : { - "type" : "array", - "deprecated" : true, - "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", - "items" : { - "$ref" : "#/components/schemas/ComponentLabel" - } - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - }, - "mongoDBMajorVersion" : { - "type" : "string", - "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", - "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-" - } - }, - "mongoDBVersion" : { - "type" : "string", - "description" : "Version of MongoDB that the cluster runs.", - "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)" - }, - "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.", - "externalDocs" : { - "description" : "Connection string URI format.", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, - "readOnly" : true - }, - "mongoURIUpdated" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when someone last updated the connection string. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", - "readOnly" : true - }, - "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.", - "externalDocs" : { - "description" : "Connection string URI format.", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "Human-readable label that identifies the cluster.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - }, - "numShards" : { - "type" : "integer", - "format" : "int32", - "default" : 1, - "description" : "Number of shards up to 50 to deploy for a sharded cluster. The resource returns `1` to indicate a replica set and values of `2` and higher to indicate a sharded cluster. The returned value equals the number of shards in the cluster.", - "externalDocs" : { - "description" : "Sharding", - "url" : "https://docs.mongodb.com/manual/sharding/" - }, - "maximum" : 50, - "minimum" : 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" - }, "replicationFactor" : { "type" : "integer", "format" : "int32", @@ -40771,6 +44420,10 @@ "type" : "string", "enum" : [ "INSTANCE_NAME", "PROCESSOR_NAME" ], "title" : "Streams Matcher Fields" + }, { + "type" : "string", + "enum" : [ "RULE_ID" ], + "title" : "Log Ingestion Matcher Fields" } ] }, "MatcherHostType" : { @@ -41421,7 +45074,7 @@ "NDSAuditTypeViewForNdsGroup" : { "type" : "string", "description" : "Unique identifier of event type.", - "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_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_SSL_ROTATED", "CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER", "CLUSTER_INSTANCE_SSL_REVOKED", "RELOAD_SSL_ON_PROCESSES", "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", "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", "MOVE_SKIPPED", "PROXY_RESTARTED", "PROXY_PANICKED", "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", "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", "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", "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", "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", "PENDING_INDEXES_DELETED", "PENDING_INDEXES_CANCELED", "PROCESS_RESTART_REQUESTED", "AUTO_HEALING_ACTION", "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", "CLUSTER_FORCE_RECONFIG_REQUESTED", "PROJECT_BYPASSED_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", "ATLAS_SQL_SCHEDULED_UPDATE_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_MODIFIED", "ATLAS_SQL_SCHEDULED_UPDATE_REMOVED" ], + "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_SSL_ROTATED", "CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER", "CLUSTER_INSTANCE_SSL_REVOKED", "RELOAD_SSL_ON_PROCESSES", "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", "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", "MOVE_SKIPPED", "PROXY_RESTARTED", "PROXY_PANICKED", "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", "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", "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", "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", "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", "CLUSTER_FORCE_RECONFIG_REQUESTED", "PROJECT_BYPASSED_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" ], "example" : "CLUSTER_CREATED", "title" : "NDS Audit Types" }, @@ -42318,7 +45971,7 @@ "example" : "cluster1", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -42560,7 +46213,9 @@ "enum" : [ "AVERAGE" ] }, "operator" : { - "$ref" : "#/components/schemas/Operator" + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, "threshold" : { "type" : "number", @@ -42744,6 +46399,54 @@ "required" : [ "typeName" ], "title" : "OpsGenie Notification" }, + "OrgActiveUserResponse" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OrgUserResponse" + }, { + "type" : "object", + "properties" : { + "country" : { + "type" : "string", + "description" : "Two alphabet characters that identifies MongoDB Cloud user's geographic location. This parameter uses the ISO 3166-1a2 code format.", + "example" : "US", + "pattern" : "^([A-Z]{2})$", + "readOnly" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the current account. This value is in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "firstName" : { + "type" : "string", + "description" : "First or given name that belongs to the MongoDB Cloud user.", + "example" : "John", + "readOnly" : true + }, + "lastAuth" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the current account last authenticated. This value is in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "lastName" : { + "type" : "string", + "description" : "Last name, family name, or surname that belongs to the MongoDB Cloud user.", + "example" : "Doe", + "readOnly" : true + }, + "mobileNumber" : { + "type" : "string", + "description" : "Mobile phone number that belongs to the MongoDB Cloud user.", + "pattern" : "(?:(?:\\\\+?1\\\\s*(?:[.-]\\\\s*)?)?(?:(\\\\s*([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9])\\\\s*)|([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9]))\\\\s*(?:[.-]\\\\s*)?)([2-9]1[02-9]|[2-9][02-9]1|[2-9][02-9]{2})\\\\s*(?:[.-]\\\\s*)?([0-9]{4})$", + "readOnly" : true + } + } + } ], + "required" : [ "createdAt", "firstName", "id", "lastName", "orgMembershipStatus", "roles", "username" ] + }, "OrgEventTypeViewForOrg" : { "type" : "string", "description" : "Unique identifier of event type.", @@ -43025,7 +46728,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/EventViewForOrg" }, @@ -43040,40 +46743,69 @@ } } }, + "OrgPendingUserResponse" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OrgUserResponse" + }, { + "type" : "object", + "properties" : { + "invitationCreatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud sent the invitation. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "invitationExpiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the invitation from MongoDB Cloud expires. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "inviterUsername" : { + "type" : "string", + "format" : "email", + "description" : "Username of the MongoDB Cloud user who sent the invitation to join the organization.", + "readOnly" : true + } + } + } ], + "required" : [ "id", "invitationCreatedAt", "invitationExpiresAt", "inviterUsername", "orgMembershipStatus", "roles", "username" ] + }, "OrgServiceAccount" : { "type" : "object", "properties" : { + "clientId" : { + "type" : "string", + "description" : "The Client ID of the Service Account.", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + }, "createdAt" : { "type" : "string", "format" : "date-time", - "description" : "Service account creation time." + "description" : "The date that the Service Account was created on." }, "description" : { "type" : "string", - "description" : "Description of the service account." - }, - "id" : { - "type" : "string", - "description" : "ID for the service account.", - "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + "description" : "Human readable description for the Service Account." }, "name" : { "type" : "string", - "description" : "Name for service account." + "description" : "Human-readable name for the Service Account." }, "roles" : { "type" : "array", - "description" : "Organization roles assigned to the Service Account.", + "description" : "A list of Organization roles associated with the Service Account.", "items" : { "type" : "string", - "description" : "Organization roles associated with the service account.", + "description" : "Organization roles available for Service Accounts.", "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] }, "uniqueItems" : true }, "secrets" : { "type" : "array", - "description" : "List of secrets.", + "description" : "A list of secrets associated with the specified Service Account.", "items" : { "$ref" : "#/components/schemas/ServiceAccountSecret" }, @@ -43086,63 +46818,215 @@ "properties" : { "description" : { "type" : "string", - "description" : "Human readable description for the service account.", + "description" : "Human readable description for the Service Account.", "maxLength" : 250, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "name" : { "type" : "string", - "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "description" : "Human-readable name for the Service Account. The name is modifiable and does not have to be unique.", "maxLength" : 64, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "roles" : { "type" : "array", - "description" : "Organization roles associated with the service account.", + "description" : "A list of organization-level roles for the Service Account.", "items" : { "type" : "string", - "description" : "Organization roles associated with the service account.", + "description" : "Organization roles available for Service Accounts.", "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] } }, "secretExpiresAfterHours" : { "type" : "integer", "format" : "int32", - "description" : "Secret expiration time." + "description" : "The expiration time of the new Service Account secret. The expiration is provided in hours." } }, - "required" : [ "description", "name", "secretExpiresAfterHours" ] + "required" : [ "description", "name", "roles", "secretExpiresAfterHours" ] }, "OrgServiceAccountUpdateRequest" : { "type" : "object", "properties" : { "description" : { "type" : "string", - "description" : "Human readable description for the service account.", + "description" : "Human readable description for the Service Account.", "maxLength" : 250, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "name" : { "type" : "string", - "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "description" : "Human-readable name for the Service Account. The name is modifiable and does not have to be unique.", "maxLength" : 64, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "roles" : { "type" : "array", - "description" : "Organization roles associated with the Service account.", + "description" : "A list of organization-level roles for the Service Account.", "items" : { "type" : "string", - "description" : "Organization roles associated with the service account.", + "description" : "Organization roles available for Service Accounts.", "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] } } } }, + "OrgUserRequest" : { + "type" : "object", + "properties" : { + "roles" : { + "$ref" : "#/components/schemas/OrgUserRolesRequest" + }, + "teamIds" : { + "type" : "array", + "description" : "List of unique 24-hexadecimal digit strings that identifies the teams to which this MongoDB Cloud user belongs.", + "items" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "uniqueItems" : true, + "writeOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address that represents the username of the MongoDB Cloud user.", + "writeOnly" : true + } + }, + "required" : [ "roles", "username" ] + }, + "OrgUserResponse" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "ACTIVE" : "#/components/schemas/OrgActiveUserResponse", + "PENDING" : "#/components/schemas/OrgPendingUserResponse" + }, + "propertyName" : "orgMembershipStatus" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/OrgPendingUserResponse" + }, { + "$ref" : "#/components/schemas/OrgActiveUserResponse" + } ], + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgMembershipStatus" : { + "type" : "string", + "description" : "String enum that indicates whether the MongoDB Cloud user has a pending invitation to join the organization or they are already active in the organization.", + "enum" : [ "PENDING", "ACTIVE" ], + "readOnly" : true + }, + "roles" : { + "$ref" : "#/components/schemas/OrgUserRolesResponse" + }, + "teamIds" : { + "type" : "array", + "description" : "List of unique 24-hexadecimal digit strings that identifies the teams to which this MongoDB Cloud user belongs.", + "items" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address that represents the username of the MongoDB Cloud user.", + "readOnly" : true + } + }, + "required" : [ "id", "orgMembershipStatus", "roles", "username" ] + }, + "OrgUserRolesRequest" : { + "type" : "object", + "description" : "Organization and project level roles to assign the MongoDB Cloud user within one organization.", + "properties" : { + "groupRoleAssignments" : { + "type" : "array", + "description" : "List of project level role assignments to assign the MongoDB Cloud user.", + "items" : { + "$ref" : "#/components/schemas/GroupRoleAssignment" + } + }, + "orgRoles" : { + "type" : "array", + "description" : "One or more organization level roles to assign the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_READ_ONLY", "ORG_MEMBER" ] + }, + "minItems" : 1, + "uniqueItems" : true + } + }, + "required" : [ "orgRoles" ], + "writeOnly" : true + }, + "OrgUserRolesResponse" : { + "type" : "object", + "description" : "Organization and project level roles assigned to one MongoDB Cloud user within one organization.", + "properties" : { + "groupRoleAssignments" : { + "type" : "array", + "description" : "List of project level role assignments assigned to the MongoDB Cloud user.", + "items" : { + "$ref" : "#/components/schemas/GroupRoleAssignment" + } + }, + "orgRoles" : { + "type" : "array", + "description" : "One or more organization level roles assigned to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_READ_ONLY", "ORG_MEMBER" ] + }, + "uniqueItems" : true + } + }, + "readOnly" : true + }, + "OrgUserUpdateRequest" : { + "type" : "object", + "properties" : { + "roles" : { + "$ref" : "#/components/schemas/OrgUserRolesRequest" + }, + "teamIds" : { + "type" : "array", + "description" : "List of unique 24-hexadecimal digit strings that identifies the teams to assign the MongoDB Cloud user.", + "items" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "uniqueItems" : true, + "writeOnly" : true + } + } + }, "OrganizationInvitation" : { "type" : "object", "properties" : { @@ -43347,7 +47231,7 @@ }, "restrictEmployeeAccess" : { "type" : "boolean", - "description" : "Flag that indicates whether to block MongoDB Support from accessing Atlas infrastructure 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/." + "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/." } } }, @@ -43494,7 +47378,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/AdvancedClusterDescription" }, @@ -43526,7 +47410,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/GroupAlertsConfig" }, @@ -43558,7 +47442,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/AlertViewForNdsGroup" }, @@ -43590,7 +47474,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ApiKeyUserDetails" }, @@ -43622,7 +47506,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/CloudAppUser" }, @@ -43654,7 +47538,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ApiAtlasCheckpointView" }, @@ -43687,7 +47571,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/CloudDatabaseUser" }, @@ -43719,7 +47603,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/DiskBackupExportJob" }, @@ -43751,7 +47635,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/EARPrivateEndpoint" }, @@ -43766,7 +47650,7 @@ } } }, - "PaginatedApiAtlasProviderRegionsView" : { + "PaginatedApiAtlasFlexBackupRestoreJob20250101View" : { "type" : "object", "properties" : { "links" : { @@ -43783,9 +47667,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/CloudProviderRegions" + "$ref" : "#/components/schemas/FlexBackupRestoreJob20250101" }, "readOnly" : true }, @@ -43798,7 +47682,7 @@ } } }, - "PaginatedApiAtlasServerlessBackupRestoreJobView" : { + "PaginatedApiAtlasFlexBackupSnapshot20240710View" : { "type" : "object", "properties" : { "links" : { @@ -43815,9 +47699,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" + "$ref" : "#/components/schemas/FlexBackupSnapshot20250101" }, "readOnly" : true }, @@ -43830,7 +47714,7 @@ } } }, - "PaginatedApiAtlasServerlessBackupSnapshotView" : { + "PaginatedApiAtlasProviderRegionsView" : { "type" : "object", "properties" : { "links" : { @@ -43847,9 +47731,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/ServerlessBackupSnapshot" + "$ref" : "#/components/schemas/CloudProviderRegions" }, "readOnly" : true }, @@ -43862,7 +47746,7 @@ } } }, - "PaginatedApiAtlasUSSBackupRestoreJob20250101View" : { + "PaginatedApiAtlasServerlessBackupRestoreJobView" : { "type" : "object", "properties" : { "links" : { @@ -43879,9 +47763,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/USSBackupRestoreJob20250101" + "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" }, "readOnly" : true }, @@ -43894,7 +47778,7 @@ } } }, - "PaginatedApiAtlasUSSBackupSnapshot20240710View" : { + "PaginatedApiAtlasServerlessBackupSnapshotView" : { "type" : "object", "properties" : { "links" : { @@ -43911,9 +47795,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/USSBackupSnapshot20250101" + "$ref" : "#/components/schemas/ServerlessBackupSnapshot" }, "readOnly" : true }, @@ -43943,7 +47827,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/BillingInvoiceMetadata" }, @@ -43975,7 +47859,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/BillingInvoice" }, @@ -44007,7 +47891,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/StreamsConnection" }, @@ -44022,6 +47906,38 @@ } } }, + "PaginatedApiStreamsPrivateLinkView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", + "items" : { + "$ref" : "#/components/schemas/StreamsPrivateLinkConnection" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, "PaginatedApiStreamsStreamProcessorWithStatsView" : { "type" : "object", "properties" : { @@ -44039,7 +47955,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/StreamsProcessorWithStats" }, @@ -44071,7 +47987,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/StreamsTenant" }, @@ -44103,7 +48019,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/UserAccessListResponse" }, @@ -44118,6 +48034,38 @@ } } }, + "PaginatedApiVersions" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ApiVersion" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, "PaginatedAppUserView" : { "type" : "object", "properties" : { @@ -44135,7 +48083,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/CloudAppUser" }, @@ -44167,7 +48115,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/Group" }, @@ -44199,7 +48147,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/MdbAvailableVersion" }, @@ -44231,7 +48179,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" }, @@ -44263,7 +48211,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/DiskBackupSnapshotExportBucket" }, @@ -44295,7 +48243,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/DiskBackupSnapshot" }, @@ -44327,7 +48275,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/DiskBackupReplicaSet" }, @@ -44359,7 +48307,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/DiskBackupSnapshotRestoreJob" }, @@ -44391,7 +48339,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/DiskBackupShardedClusterSnapshot" }, @@ -44424,7 +48372,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/CloudProviderContainer" }, @@ -44457,7 +48405,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ClusterDescription20240805" }, @@ -44489,7 +48437,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ConnectedOrgConfig" }, @@ -44522,7 +48470,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" }, @@ -44554,7 +48502,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/MesurementsDatabase" }, @@ -44586,7 +48534,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/MeasurementDiskPartition" }, @@ -44618,7 +48566,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/EventTypeDetails" }, @@ -44650,7 +48598,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/FederationIdentityProvider" }, @@ -44665,9 +48613,41 @@ } } }, + "PaginatedFlexClusters20250101" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", + "items" : { + "type" : "object" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, "PaginatedGroupServiceAccounts" : { "type" : "object", - "description" : "List of Service Accounts", + "description" : "A list of Project Service Accounts.", "properties" : { "links" : { "type" : "array", @@ -44683,7 +48663,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/GroupServiceAccount" }, @@ -44715,7 +48695,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ApiHostView_Atlas" }, @@ -44747,7 +48727,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ThirdPartyIntegration" }, @@ -44779,7 +48759,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/LegacyAtlasCluster" }, @@ -44811,7 +48791,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/NetworkPermissionEntry" }, @@ -44843,7 +48823,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/BackupOnlineArchive" }, @@ -44875,7 +48855,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/OrgGroup" }, @@ -44892,7 +48872,7 @@ }, "PaginatedOrgServiceAccounts" : { "type" : "object", - "description" : "List of Service Accounts", + "description" : "A list of Organization Service Accounts.", "properties" : { "links" : { "type" : "array", @@ -44908,7 +48888,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/OrgServiceAccount" }, @@ -44940,7 +48920,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/AtlasOrganization" }, @@ -44972,7 +48952,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/IngestionPipelineRun" }, @@ -45004,7 +48984,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/PrivateNetworkEndpointIdEntry" }, @@ -45036,7 +49016,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/PublicApiUsageDetailsLineItemView" }, @@ -45068,7 +49048,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/BackupRestoreJob" }, @@ -45101,7 +49081,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/AuthFederationRoleMapping" }, @@ -45133,7 +49113,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ServerlessInstanceDescription" }, @@ -45150,7 +49130,7 @@ }, "PaginatedServiceAccountGroup" : { "type" : "object", - "description" : "List of Service Account projects.", + "description" : "A list of projects associated with the Service Account.", "properties" : { "links" : { "type" : "array", @@ -45166,7 +49146,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ServiceAccountGroup" }, @@ -45181,7 +49161,7 @@ } } }, - "PaginatedSnapshotView" : { + "PaginatedServiceAccountIPAccessEntryView" : { "type" : "object", "properties" : { "links" : { @@ -45198,9 +49178,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/BackupSnapshot" + "$ref" : "#/components/schemas/ServiceAccountIPAccessListEntry" }, "readOnly" : true }, @@ -45213,7 +49193,7 @@ } } }, - "PaginatedTeamRoleView" : { + "PaginatedSnapshotView" : { "type" : "object", "properties" : { "links" : { @@ -45230,9 +49210,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/TeamRole" + "$ref" : "#/components/schemas/BackupSnapshot" }, "readOnly" : true }, @@ -45245,7 +49225,7 @@ } } }, - "PaginatedTeamView" : { + "PaginatedTeamRoleView" : { "type" : "object", "properties" : { "links" : { @@ -45262,9 +49242,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/TeamResponse" + "$ref" : "#/components/schemas/TeamRole" }, "readOnly" : true }, @@ -45277,7 +49257,7 @@ } } }, - "PaginatedTenantRestoreView" : { + "PaginatedTeamView" : { "type" : "object", "properties" : { "links" : { @@ -45294,9 +49274,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/TenantRestore" + "$ref" : "#/components/schemas/TeamResponse" }, "readOnly" : true }, @@ -45309,7 +49289,7 @@ } } }, - "PaginatedTenantSnapshotView" : { + "PaginatedTenantRestoreView" : { "type" : "object", "properties" : { "links" : { @@ -45326,9 +49306,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/BackupTenantSnapshot" + "$ref" : "#/components/schemas/TenantRestore" }, "readOnly" : true }, @@ -45341,7 +49321,7 @@ } } }, - "PaginatedUSSInstance20250101" : { + "PaginatedTenantSnapshotView" : { "type" : "object", "properties" : { "links" : { @@ -45358,9 +49338,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "type" : "object" + "$ref" : "#/components/schemas/BackupTenantSnapshot" }, "readOnly" : true }, @@ -45390,7 +49370,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/UserCert" }, @@ -45897,6 +49877,14 @@ "PrivateNetworkEndpointIdEntry" : { "type" : "object", "properties" : { + "azureConnectionName" : { + "type" : "string", + "description" : "Connection name that identifies the Azure private endpoint connection." + }, + "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." @@ -45905,6 +49893,11 @@ "type" : "string", "description" : "Human-readable label to identify customer's VPC endpoint DNS name." }, + "customerEndpointIPAddress" : { + "type" : "string", + "description" : "IP address used to connect to the Azure private endpoint.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + }, "endpointId" : { "type" : "string", "description" : "Unique 22-character alphanumeric string that identifies the private endpoint.", @@ -45917,6 +49910,10 @@ "minLength" : 22, "pattern" : "^vpce-[0-9a-f]{17}$" }, + "errorMessage" : { + "type" : "string", + "description" : "Error message describing a failure approving the private endpoint request." + }, "provider" : { "type" : "string", "default" : "AWS", @@ -45927,6 +49924,11 @@ "type" : "string", "description" : "Human-readable label to identify the region of customer's VPC endpoint." }, + "status" : { + "type" : "string", + "description" : "Status of the private endpoint connection request.", + "enum" : [ "PENDING", "OK", "FAILED", "DELETING" ] + }, "type" : { "type" : "string", "default" : "DATA_LAKE", @@ -45983,20 +49985,6 @@ "required" : [ "enabled", "serviceDiscovery", "username" ], "title" : "PROMETHEUS" }, - "ProxyInfo" : { - "type" : "object", - "description" : "VPC Proxy Information.", - "properties" : { - "authKey" : { - "type" : "string", - "description" : "Authentication key for the proxy." - }, - "dnsName" : { - "type" : "string", - "description" : "DNS name to use to reach the proxy/s." - } - } - }, "PublicApiUsageDetailsLineItemView" : { "type" : "object", "properties" : { @@ -46094,7 +50082,9 @@ "enum" : [ "AVERAGE" ] }, "operator" : { - "$ref" : "#/components/schemas/Operator" + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, "threshold" : { "type" : "number", @@ -46142,7 +50132,7 @@ "example" : "cluster1", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -46384,7 +50374,9 @@ "enum" : [ "AVERAGE" ] }, "operator" : { - "$ref" : "#/components/schemas/Operator" + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, "threshold" : { "type" : "number", @@ -46562,7 +50554,7 @@ "example" : "cluster1", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -46842,472 +50834,69 @@ } }, "zoneName" : { - "type" : "string", - "description" : "Human-readable label that identifies the zone in a Global Cluster. Provide this value only if `\"clusterType\" : \"GEOSHARDED\"`." - } - }, - "title" : "Replication Specifications" - }, - "ReplicationSpec20240805" : { - "type" : "object", - "description" : "Details that explain how MongoDB Cloud replicates data on the specified MongoDB database.", - "properties" : { - "id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a shard in a Cluster. If you include existing shard replication configurations in the request, you must specify this parameter. If you add a new shard to an existing Cluster, you may specify this parameter. The request deletes any existing shards in the Cluster that you exclude from the request.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "regionConfigs" : { - "type" : "array", - "description" : "Hardware specifications for nodes set for a given region. 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**.\n\n**Example:**\n\nIf you set `\"replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize\" : \"M30\"`, set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : `\"M30\"` if you have electable nodes and `\"replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize\" : `\"M30\"` if you have read-only nodes.", - "items" : { - "$ref" : "#/components/schemas/CloudRegionConfig20240805" - } - }, - "zoneId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the zone in a Global Cluster. This value can be used to configure Global Cluster backup policies.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "zoneName" : { - "type" : "string", - "description" : "Human-readable label that describes the zone this shard belongs to in a Global Cluster. Provide this value only if \"clusterType\" : \"GEOSHARDED\" but not \"selfManagedSharding\" : true." - } - }, - "title" : "Replication Specifications" - }, - "RequestAccepted" : { - "type" : "object", - "description" : "Accepted" - }, - "ResourceEventTypeView" : { - "type" : "string", - "description" : "Unique identifier of event type.", - "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], - "example" : "TAGS_MODIFIED", - "title" : "Resource Event Types" - }, - "ResourceEventTypeViewForOrg" : { - "type" : "string", - "description" : "Unique identifier of event type.", - "enum" : [ "GROUP_TAGS_MODIFIED" ], - "example" : "GROUP_TAGS_MODIFIED", - "title" : "Resource Event Types" - }, - "ResourceEventViewForNdsGroup" : { - "type" : "object", - "description" : "Resource event reflects different activities about resources.", - "properties" : { - "apiKeyId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "created" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true - }, - "eventTypeName" : { - "$ref" : "#/components/schemas/ResourceEventTypeView" - }, - "groupId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "isGlobalAdmin" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", - "readOnly" : true - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - }, - "orgId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "publicKey" : { - "type" : "string", - "format" : "email", - "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "example" : "test.user@mongodb.com", - "readOnly" : true - }, - "raw" : { - "$ref" : "#/components/schemas/raw" - }, - "remoteAddress" : { - "type" : "string", - "description" : "IPv4 or IPv6 address from which the user triggered this event.", - "example" : "216.172.40.186", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", - "readOnly" : true - }, - "resourceId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the resource associated with the event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "resourceType" : { - "type" : "string", - "description" : "Unique identifier of resource type.", - "example" : "cluster" - }, - "userId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "username" : { - "type" : "string", - "format" : "email", - "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", - "example" : "test.user@mongodb.com", - "readOnly" : true - } - }, - "required" : [ "created", "eventTypeName", "id", "resourceType" ], - "title" : "Resource Events" - }, - "ResourceEventViewForOrg" : { - "type" : "object", - "description" : "Resource event reflects different activities about resources.", - "properties" : { - "apiKeyId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "created" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true - }, - "eventTypeName" : { - "$ref" : "#/components/schemas/ResourceEventTypeViewForOrg" - }, - "groupId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "isGlobalAdmin" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", - "readOnly" : true - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - }, - "orgId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "publicKey" : { - "type" : "string", - "format" : "email", - "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "example" : "test.user@mongodb.com", - "readOnly" : true - }, - "raw" : { - "$ref" : "#/components/schemas/raw" - }, - "remoteAddress" : { - "type" : "string", - "description" : "IPv4 or IPv6 address from which the user triggered this event.", - "example" : "216.172.40.186", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", - "readOnly" : true - }, - "resourceId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the resource associated with the event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "resourceType" : { - "type" : "string", - "description" : "Unique identifier of resource type.", - "example" : "cluster" - }, - "userId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "username" : { - "type" : "string", - "format" : "email", - "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", - "example" : "test.user@mongodb.com", - "readOnly" : true - } - }, - "required" : [ "created", "eventTypeName", "id", "resourceType" ], - "title" : "Resource Events" - }, - "ResourceTag" : { - "type" : "object", - "description" : "Key-value pair that tags and categorizes a MongoDB Cloud organization, project, or cluster. For example, `environment : production`.", - "properties" : { - "key" : { - "type" : "string", - "description" : "Constant that defines the set of the tag. For example, `environment` in the `environment : production` tag.", - "maxLength" : 255, - "minLength" : 1 - }, - "value" : { - "type" : "string", - "description" : "Variable that belongs to the set of the tag. For example, `production` in the `environment : production` tag.", - "maxLength" : 255, - "minLength" : 1 - } - }, - "required" : [ "key", "value" ], - "title" : "Resource Tag" - }, - "RestoreJobFileHash" : { - "type" : "object", - "description" : "Key and value pair that map one restore file to one hashed checksum. This parameter applies after you download the corresponding **delivery.url**.", - "properties" : { - "fileName" : { - "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.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - }, - "typeName" : { - "type" : "string", - "description" : "Human-readable label that identifies the hashing algorithm used to compute the hash value.", - "enum" : [ "SHA1" ], - "readOnly" : true - } - }, - "readOnly" : true - }, - "RoleAssignment" : { - "type" : "object", - "properties" : { - "groupId" : { - "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", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" - }, - "orgId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization to which this role belongs. Each element within **roleAssignments** can have a value for **orgId** or **groupId**, but not both.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" - }, - "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.\n\nOrganization Roles\n\n* ORG_OWNER\n* ORG_MEMBER\n* ORG_GROUP_CREATOR\n* ORG_BILLING_ADMIN\n* ORG_READ_ONLY\n\nProject Roles\n\n* GROUP_CLUSTER_MANAGER\n* GROUP_DATA_ACCESS_ADMIN\n* GROUP_DATA_ACCESS_READ_ONLY\n* GROUP_DATA_ACCESS_READ_WRITE\n* GROUP_OWNER\n* GROUP_READ_ONLY\n* GROUP_SEARCH_INDEX_EDITOR\n* GROUP_STREAM_PROCESSING_OWNER\n\n", - "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] - } - } - }, - "SMSNotification" : { - "type" : "object", - "description" : "SMS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", - "properties" : { - "delayMin" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." - }, - "intervalMin" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", - "minimum" : 5 - }, - "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" : { - "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" ] + "type" : "string", + "description" : "Human-readable label that identifies the zone in a Global Cluster. Provide this value only if `\"clusterType\" : \"GEOSHARDED\"`." } }, - "required" : [ "typeName" ], - "title" : "SMS Notification" + "title" : "Replication Specifications" }, - "SampleDatasetStatus" : { + "ReplicationSpec20240805" : { "type" : "object", + "description" : "Details that explain how MongoDB Cloud replicates data on the specified MongoDB database.", "properties" : { - "_id" : { + "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies this sample dataset.", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a shard in a Cluster. If you include existing shard replication configurations in the request, you must specify this parameter. If you add a new shard to an existing Cluster, you may specify this parameter. The request deletes any existing shards in the Cluster that you exclude from the request.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "clusterName" : { - "type" : "string", - "description" : "Human-readable label that identifies the cluster into which you loaded the sample dataset.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "readOnly" : true - }, - "completeDate" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when the sample dataset load job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", - "readOnly" : true - }, - "createDate" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when you started the sample dataset load job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", - "readOnly" : true + "regionConfigs" : { + "type" : "array", + "description" : "Hardware specifications for nodes set for a given region. 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**.\n\n**Example:**\n\nIf you set `\"replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize\" : \"M30\"`, set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : `\"M30\"` if you have electable nodes and `\"replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize\" : `\"M30\"` if you have read-only nodes.", + "items" : { + "$ref" : "#/components/schemas/CloudRegionConfig20240805" + } }, - "errorMessage" : { + "zoneId" : { "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.", + "description" : "Unique 24-hexadecimal digit string that identifies the zone in a Global Cluster. This value can be used to configure Global Cluster backup policies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "state" : { + "zoneName" : { "type" : "string", - "description" : "Status of the sample dataset load job.", - "enum" : [ "WORKING", "FAILED", "COMPLETED" ], - "readOnly" : true + "description" : "Human-readable label that describes the zone this shard belongs to in a Global Cluster. Provide this value only if \"clusterType\" : \"GEOSHARDED\" but not \"selfManagedSharding\" : true." } - } + }, + "title" : "Replication Specifications" }, - "SearchDeploymentAuditTypeView" : { + "RequestAccepted" : { + "type" : "object", + "description" : "Accepted" + }, + "ResourceEventTypeView" : { "type" : "string", "description" : "Unique identifier of event type.", - "enum" : [ "SEARCH_DEPLOYMENT_CREATED", "SEARCH_DEPLOYMENT_UPDATED", "SEARCH_DEPLOYMENT_DELETED" ], - "example" : "SEARCH_DEPLOYMENT_CREATED", - "title" : "Search Deployment Audit Types" + "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], + "example" : "TAGS_MODIFIED", + "title" : "Resource Event Types" }, - "SearchDeploymentAuditView" : { + "ResourceEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "GROUP_TAGS_MODIFIED" ], + "example" : "GROUP_TAGS_MODIFIED", + "title" : "Resource Event Types" + }, + "ResourceEventViewForNdsGroup" : { "type" : "object", - "description" : "Indicates activities on decoupled search nodes.", + "description" : "Resource event reflects different activities about resources.", "properties" : { "apiKeyId" : { "type" : "string", @@ -47325,7 +50914,7 @@ "readOnly" : true }, "eventTypeName" : { - "$ref" : "#/components/schemas/SearchDeploymentAuditTypeView" + "$ref" : "#/components/schemas/ResourceEventTypeView" }, "groupId" : { "type" : "string", @@ -47376,6 +50965,7 @@ "type" : "string", "format" : "email", "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true }, "raw" : { @@ -47388,6 +50978,20 @@ "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", "readOnly" : true }, + "resourceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the resource associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resourceType" : { + "type" : "string", + "description" : "Unique identifier of resource type.", + "example" : "cluster" + }, "userId" : { "type" : "string", "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", @@ -47405,541 +51009,159 @@ "readOnly" : true } }, - "required" : [ "created", "eventTypeName", "id" ], - "title" : "Search Deployment Audits" - }, - "SearchHostStatusDetail" : { - "type" : "object", - "properties" : { - "hostname" : { - "type" : "string", - "description" : "Hostname that corresponds to the status detail." - }, - "mainIndex" : { - "$ref" : "#/components/schemas/SearchMainIndexStatusDetail" - }, - "queryable" : { - "type" : "boolean", - "description" : "Flag that indicates whether the index is queryable on the host." - }, - "stagedIndex" : { - "$ref" : "#/components/schemas/SearchStagedIndexStatusDetail" - }, - "status" : { - "type" : "string", - "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", - "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] - } - }, - "title" : "Search Host Status Detail" - }, - "SearchIndex" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/ClusterSearchIndex" - }, { - "type" : "object", - "properties" : { - "analyzer" : { - "type" : "string", - "default" : "lucene.standard", - "description" : "Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves a variety of changes made to the text in fields:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\n MongoDB Cloud uses the selected process to build the Atlas Search index.", - "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ], - "externalDocs" : { - "description" : "Atlas Search Analyzers", - "url" : "https://dochub.mongodb.org/core/analyzers--fts" - } - }, - "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" - }, - "items" : { - "$ref" : "#/components/schemas/ApiAtlasFTSAnalyzersViewManual" - } - }, - "mappings" : { - "$ref" : "#/components/schemas/ApiAtlasFTSMappingsViewManual" - }, - "searchAnalyzer" : { - "type" : "string", - "default" : "lucene.standard", - "description" : "Method applied to identify words when searching this index.", - "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] - }, - "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" - }, - "items" : { - "$ref" : "#/components/schemas/SearchSynonymMappingDefinition" - } - } - } - } ], - "required" : [ "collectionName", "database", "name" ] - }, - "SearchIndexCreateRequest" : { - "type" : "object", - "discriminator" : { - "mapping" : { - "search" : "#/components/schemas/TextSearchIndexCreateRequest", - "vectorSearch" : "#/components/schemas/VectorSearchIndexCreateRequest" - }, - "propertyName" : "type" - }, - "properties" : { - "collectionName" : { - "type" : "string", - "description" : "Label that identifies the collection to create an Atlas Search index in." - }, - "database" : { - "type" : "string", - "description" : "Label that identifies the database that contains the collection to create an Atlas Search index in." - }, - "name" : { - "type" : "string", - "description" : "Label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique." - }, - "type" : { - "type" : "string", - "description" : "Type of the index. The default type is search.", - "enum" : [ "search", "vectorSearch" ] - } - }, - "required" : [ "collectionName", "database", "name" ] - }, - "SearchIndexDefinition" : { - "type" : "object", - "description" : "The search index definition set by the user.", - "title" : "Search Index Definition" - }, - "SearchIndexDefinitionVersion" : { - "type" : "object", - "description" : "Object which includes the version number of the index definition and the time that the index definition was created.", - "properties" : { - "createdAt" : { - "type" : "string", - "format" : "date-time", - "description" : "The time at which this index definition was created." - }, - "version" : { - "type" : "integer", - "format" : "int64", - "description" : "The version number associated with this index definition when it was created." - } - }, - "title" : "Search Index Definition Version" + "required" : [ "created", "eventTypeName", "id", "resourceType" ], + "title" : "Resource Events" }, - "SearchIndexResponse" : { + "ResourceEventViewForOrg" : { "type" : "object", - "discriminator" : { - "mapping" : { - "search" : "#/components/schemas/TextSearchIndexResponse", - "vectorSearch" : "#/components/schemas/VectorSearchIndexResponse" - }, - "propertyName" : "type" - }, + "description" : "Resource event reflects different activities about resources.", "properties" : { - "collectionName" : { - "type" : "string", - "description" : "Label that identifies the collection that contains one or more Atlas Search indexes." - }, - "database" : { - "type" : "string", - "description" : "Label that identifies the database that contains the collection with one or more Atlas Search indexes." - }, - "indexID" : { + "apiKeyId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies this Atlas Search index.", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" - }, - "latestDefinition" : { - "$ref" : "#/components/schemas/SearchIndexDefinition" - }, - "latestDefinitionVersion" : { - "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" - }, - "name" : { - "type" : "string", - "description" : "Label that identifies this index. Within each namespace, the names of all indexes must be unique." - }, - "queryable" : { - "type" : "boolean", - "description" : "Flag that indicates whether the index is queryable on all hosts." - }, - "status" : { - "type" : "string", - "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", - "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] - }, - "statusDetail" : { - "type" : "array", - "description" : "List of documents detailing index status on each host.", - "items" : { - "$ref" : "#/components/schemas/SearchHostStatusDetail" - } - }, - "type" : { - "type" : "string", - "description" : "Type of the index. The default type is search.", - "enum" : [ "search", "vectorSearch" ] - } - }, - "title" : "Search Index Response" - }, - "SearchIndexUpdateRequest" : { - "type" : "object", - "properties" : { - "definition" : { - "type" : "object", - "description" : "The index definition to update the search index to.", - "oneOf" : [ { - "$ref" : "#/components/schemas/TextSearchIndexDefinition" - }, { - "$ref" : "#/components/schemas/VectorSearchIndexDefinition" - } ] - } - }, - "required" : [ "definition" ], - "title" : "Search Index Update Request" - }, - "SearchMainIndexStatusDetail" : { - "type" : "object", - "description" : "Contains status information about the active index.", - "properties" : { - "definition" : { - "$ref" : "#/components/schemas/SearchIndexDefinition" - }, - "definitionVersion" : { - "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" - }, - "message" : { - "type" : "string", - "description" : "Optional message describing an error." - }, - "queryable" : { - "type" : "boolean", - "description" : "Flag that indicates whether the index generation is queryable on the host." - }, - "status" : { - "type" : "string", - "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", - "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] - } - }, - "title" : "Search Main Index Status Detail" - }, - "SearchMappings" : { - "type" : "object", - "description" : "Index specifications for the collection's fields.", - "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/field-mapping-definition-fts#static-and-dynamic-mappings" - } - }, - "fields" : { - "type" : "object", - "additionalProperties" : { - "type" : "object", - "description" : "One or more field specifications for the Atlas Search index. Required if **mappings.dynamic** is omitted or set to **false**.", - "externalDocs" : { - "description" : "Atlas Search Index", - "url" : "https://dochub.mongodb.org/core/index-definitions-fts" - }, - "x-additionalPropertiesName" : "Field Name" - }, - "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" - }, - "x-additionalPropertiesName" : "Field Name" - } - }, - "title" : "Mappings" - }, - "SearchStagedIndexStatusDetail" : { - "type" : "object", - "description" : "Contains status information about an index building in the background.", - "properties" : { - "definition" : { - "$ref" : "#/components/schemas/SearchIndexDefinition" - }, - "definitionVersion" : { - "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" - }, - "message" : { - "type" : "string", - "description" : "Optional message describing an error." - }, - "queryable" : { - "type" : "boolean", - "description" : "Flag that indicates whether the index generation is queryable on the host." + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "status" : { - "type" : "string", - "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", - "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] - } - }, - "title" : "Search Staged Index Status Detail" - }, - "SearchSynonymMappingDefinition" : { - "type" : "object", - "description" : "Synonyms used for this full text index.", - "properties" : { - "analyzer" : { + "created" : { "type" : "string", - "description" : "Specific pre-defined method chosen to apply to the synonyms to be searched.", - "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true }, - "name" : { - "type" : "string", - "description" : "Label that identifies the synonym definition. Each **synonym.name** must be unique within the same index definition." + "eventTypeName" : { + "$ref" : "#/components/schemas/ResourceEventTypeViewForOrg" }, - "source" : { - "$ref" : "#/components/schemas/SynonymSource" - } - }, - "required" : [ "analyzer", "name", "source" ], - "title" : "Synonym Mapping Definition" - }, - "ServerlessAWSTenantEndpoint" : { - "type" : "object", - "description" : "View for a serverless AWS tenant endpoint.", - "properties" : { - "_id" : { + "groupId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "cloudProviderEndpointId" : { - "type" : "string", - "description" : "Unique string that identifies the private endpoint's network interface.", - "pattern" : "^vpce-[0-9a-f]{17}$", - "readOnly" : true - }, - "comment" : { - "type" : "string", - "description" : "Human-readable comment associated with the private endpoint.", - "maxLength" : 80, - "readOnly" : true - }, - "endpointServiceName" : { + "id" : { "type" : "string", - "description" : "Unique string that identifies the Amazon Web Services (AWS) PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", - "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "errorMessage" : { - "type" : "string", - "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", "readOnly" : true }, - "providerName" : { - "type" : "string", - "description" : "Human-readable label that identifies the cloud service provider.", - "enum" : [ "AWS" ], + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, "readOnly" : true }, - "status" : { - "type" : "string", - "description" : "Human-readable label that indicates the current operating status of the private endpoint.", - "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], - "readOnly" : true - } - }, - "title" : "AWS" - }, - "ServerlessAWSTenantEndpointUpdate" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" - }, { - "type" : "object", - "properties" : { - "cloudProviderEndpointId" : { - "type" : "string", - "description" : "Unique string that identifies the private endpoint's network interface.", - "pattern" : "^vpce-[0-9a-f]{17}$", - "writeOnly" : true - } - } - } ], - "description" : "Updates to a serverless AWS tenant endpoint.", - "required" : [ "providerName" ], - "title" : "AWS" - }, - "ServerlessAzureTenantEndpoint" : { - "type" : "object", - "description" : "View for a serverless Azure tenant endpoint.", - "properties" : { - "_id" : { + "orgId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "cloudProviderEndpointId" : { - "type" : "string", - "description" : "Unique string that identifies the Azure private endpoint's network interface that someone added to this private endpoint service.", - "pattern" : "^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\\.Network/privateEndpoints/[-\\w._()]+$", - "readOnly" : true - }, - "comment" : { + "publicKey" : { "type" : "string", - "description" : "Human-readable comment associated with the private endpoint.", - "maxLength" : 80, + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true }, - "endpointServiceName" : { - "type" : "string", - "description" : "Unique string that identifies the Azure private endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", - "pattern" : "^pls_[0-9a-f]{24}$", - "readOnly" : true + "raw" : { + "$ref" : "#/components/schemas/raw" }, - "errorMessage" : { + "remoteAddress" : { "type" : "string", - "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", "readOnly" : true }, - "privateEndpointIpAddress" : { + "resourceId" : { "type" : "string", - "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "description" : "Unique 24-hexadecimal digit string that identifies the resource associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "privateLinkServiceResourceId" : { + "resourceType" : { "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 + "description" : "Unique identifier of resource type.", + "example" : "cluster" }, - "providerName" : { + "userId" : { "type" : "string", - "description" : "Human-readable label that identifies the cloud service provider.", - "enum" : [ "AZURE" ], + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "status" : { + "username" : { "type" : "string", - "description" : "Human-readable label that indicates the current operating status of the private endpoint.", - "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true } }, - "title" : "Azure" - }, - "ServerlessAzureTenantEndpointUpdate" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" - }, { - "type" : "object", - "properties" : { - "cloudProviderEndpointId" : { - "type" : "string", - "description" : "Unique string that identifies the Azure private endpoint's network interface for this private endpoint service.", - "pattern" : "^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\\.Network/privateEndpoints/[-\\w._()]+$", - "writeOnly" : true - }, - "privateEndpointIpAddress" : { - "type" : "string", - "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", - "writeOnly" : true - } - } - } ], - "description" : "Updates to a serverless Azure tenant endpoint.", - "required" : [ "providerName" ], - "title" : "AZURE" + "required" : [ "created", "eventTypeName", "id", "resourceType" ], + "title" : "Resource Events" }, - "ServerlessBackupRestoreJob" : { + "ResourceTag" : { "type" : "object", + "description" : "Key-value pair that tags and categorizes a MongoDB Cloud organization, project, or cluster. For example, `environment : production`.", "properties" : { - "cancelled" : { - "type" : "boolean", - "description" : "Flag that indicates whether someone canceled this restore job.", - "readOnly" : true - }, - "deliveryType" : { + "key" : { "type" : "string", - "description" : "Human-readable label that categorizes the restore job to create.", - "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\"`.", - "items" : { - "type" : "string", - "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download." - }, - "readOnly" : true - }, - "desiredTimestamp" : { - "$ref" : "#/components/schemas/ApiBSONTimestampView" - }, - "expired" : { - "type" : "boolean", - "description" : "Flag that indicates whether the restore job expired.", - "readOnly" : true + "description" : "Constant that defines the set of the tag. For example, `environment` in the `environment : production` tag.", + "maxLength" : 255, + "minLength" : 1 }, - "expiresAt" : { + "value" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when the restore job expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true - }, - "failed" : { - "type" : "boolean", - "description" : "Flag that indicates whether the restore job failed.", - "readOnly" : true - }, - "finishedAt" : { + "description" : "Variable that belongs to the set of the tag. For example, `production` in the `environment : production` tag.", + "maxLength" : 255, + "minLength" : 1 + } + }, + "required" : [ "key", "value" ], + "title" : "Resource Tag" + }, + "RestoreJobFileHash" : { + "type" : "object", + "description" : "Key and value pair that map one restore file to one hashed checksum. This parameter applies after you download the corresponding **delivery.url**.", + "properties" : { + "fileName" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when the restore job completed. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Human-readable label that identifies the hashed file.", "readOnly" : true }, - "id" : { + "hash" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the restore job.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "description" : "Hashed checksum that maps to the restore file.", "readOnly" : true }, "links" : { @@ -47954,87 +51176,173 @@ }, "readOnly" : true }, - "oplogInc" : { - "type" : "integer", - "format" : "int32", - "description" : "Oplog operation number from which you want to restore this snapshot. This number represents the second part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", - "example" : 1, - "minimum" : 1 + "typeName" : { + "type" : "string", + "description" : "Human-readable label that identifies the hashing algorithm used to compute the hash value.", + "enum" : [ "SHA1" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "RoleAssignment" : { + "type" : "object", + "properties" : { + "groupId" : { + "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", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" }, - "oplogTs" : { + "orgId" : { + "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", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "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.\n\nOrganization Roles\n\n* ORG_OWNER\n* ORG_MEMBER\n* ORG_GROUP_CREATOR\n* ORG_BILLING_ADMIN\n* ORG_READ_ONLY\n\nProject Roles\n\n* GROUP_CLUSTER_MANAGER\n* GROUP_DATA_ACCESS_ADMIN\n* GROUP_DATA_ACCESS_READ_ONLY\n* GROUP_DATA_ACCESS_READ_WRITE\n* GROUP_OWNER\n* GROUP_READ_ONLY\n* GROUP_SEARCH_INDEX_EDITOR\n* GROUP_STREAM_PROCESSING_OWNER\n\n", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + } + }, + "SMSNotification" : { + "type" : "object", + "description" : "SMS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { "type" : "integer", "format" : "int32", - "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`.", - "minimum" : 1199145600 + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." }, - "pointInTimeUTCSeconds" : { + "intervalMin" : { "type" : "integer", "format" : "int32", - "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`.", - "minimum" : 1199145600 + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 }, - "snapshotId" : { + "mobileNumber" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "description" : "Mobile phone number to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"SMS\"`.", + "example" : "1233337892" + }, + "notifierId" : { + "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" ] + } + }, + "required" : [ "typeName" ], + "title" : "SMS Notification" + }, + "SampleDatasetStatus" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies this sample dataset.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "targetClusterName" : { + "clusterName" : { "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\"`.", + "description" : "Human-readable label that identifies the cluster into which you loaded the sample dataset.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "readOnly" : true }, - "targetGroupId" : { + "completeDate" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the target project for the specified **targetClusterName**.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" + "format" : "date-time", + "description" : "Date and time when the sample dataset load job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true }, - "timestamp" : { + "createDate" : { "type" : "string", "format" : "date-time", - "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.", + "description" : "Date and time when you started the sample dataset load job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "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.", + "enum" : [ "WORKING", "FAILED", "COMPLETED" ], "readOnly" : true } - }, - "required" : [ "deliveryType", "targetClusterName", "targetGroupId" ] + } }, - "ServerlessBackupSnapshot" : { + "SearchDeploymentAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "SEARCH_DEPLOYMENT_CREATED", "SEARCH_DEPLOYMENT_UPDATED", "SEARCH_DEPLOYMENT_DELETED" ], + "example" : "SEARCH_DEPLOYMENT_CREATED", + "title" : "Search Deployment Audit Types" + }, + "SearchDeploymentAuditView" : { "type" : "object", + "description" : "Indicates activities on decoupled search nodes.", "properties" : { - "createdAt" : { + "apiKeyId" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "expiresAt" : { + "created" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "frequencyType" : { + "eventTypeName" : { + "$ref" : "#/components/schemas/SearchDeploymentAuditTypeView" + }, + "groupId" : { "type" : "string", - "description" : "Human-readable label that identifies how often this snapshot triggers.", - "enum" : [ "hourly", "daily", "weekly", "monthly" ], + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, "links" : { "type" : "array", "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", @@ -48047,450 +51355,445 @@ }, "readOnly" : true }, - "mongodVersion" : { + "orgId" : { "type" : "string", - "description" : "Version of the MongoDB host that this snapshot backs up.", - "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "serverlessInstanceName" : { + "publicKey" : { "type" : "string", - "description" : "Human-readable label given to the serverless instance from which MongoDB Cloud took this snapshot.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", "readOnly" : true }, - "snapshotType" : { + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { "type" : "string", - "description" : "Human-readable label that identifies when this snapshot triggers.", - "enum" : [ "onDemand", "scheduled" ], + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", "readOnly" : true }, - "status" : { + "userId" : { "type" : "string", - "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", - "enum" : [ "queued", "inProgress", "completed", "failed" ], + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "storageSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "Number of bytes taken to store the backup snapshot.", + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true } - } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Search Deployment Audits" }, - "ServerlessConnectionStringsPrivateEndpointItem" : { + "SearchHostStatusDetail" : { "type" : "object", - "description" : "Details of a private endpoint deployed for this serverless instance.", "properties" : { - "endpointId" : { + "hostname" : { "type" : "string", - "description" : "Unique string that the cloud provider uses to identify the private endpoint.", - "readOnly" : true + "description" : "Hostname that corresponds to the status detail." }, - "providerName" : { - "type" : "string", - "description" : "Cloud provider where the private endpoint is deployed.", - "enum" : [ "AWS", "AZURE" ], - "readOnly" : true + "mainIndex" : { + "$ref" : "#/components/schemas/SearchMainIndexStatusDetail" }, - "region" : { + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on the host." + }, + "stagedIndex" : { + "$ref" : "#/components/schemas/SearchStagedIndexStatusDetail" + }, + "status" : { "type" : "string", - "description" : "Region where the private endpoint is deployed.", - "readOnly" : true + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] } }, - "title" : "Serverless Instance Private Endpoint Connection Strings Endpoint" + "title" : "Search Host Status Detail" }, - "ServerlessConnectionStringsPrivateEndpointList" : { + "SearchIndex" : { "type" : "object", - "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/" + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, { + "type" : "object", + "properties" : { + "analyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves a variety of changes made to the text in fields:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\n MongoDB Cloud uses the selected process to build the Atlas Search index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ], + "externalDocs" : { + "description" : "Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/analyzers--fts" + } + }, + "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" + }, + "items" : { + "$ref" : "#/components/schemas/ApiAtlasFTSAnalyzersViewManual" + } + }, + "mappings" : { + "$ref" : "#/components/schemas/ApiAtlasFTSMappingsViewManual" + }, + "searchAnalyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Method applied to identify words when searching this index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] + }, + "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" + }, + "items" : { + "$ref" : "#/components/schemas/SearchSynonymMappingDefinition" + } + } + } + } ], + "required" : [ "collectionName", "database", "name" ] + }, + "SearchIndexCreateRequest" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "search" : "#/components/schemas/TextSearchIndexCreateRequest", + "vectorSearch" : "#/components/schemas/VectorSearchIndexCreateRequest" + }, + "propertyName" : "type" }, "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**.", - "items" : { - "$ref" : "#/components/schemas/ServerlessConnectionStringsPrivateEndpointItem" - }, - "readOnly" : true + "collectionName" : { + "type" : "string", + "description" : "Label that identifies the collection to create an Atlas Search index in." }, - "srvConnectionString" : { + "database" : { "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 + "description" : "Label that identifies the database that contains the collection to create an Atlas Search index in." + }, + "name" : { + "type" : "string", + "description" : "Label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique." }, "type" : { "type" : "string", - "description" : "MongoDB process type to which your application connects.", - "enum" : [ "MONGOS" ], - "readOnly" : true + "description" : "Type of the index. The default type is search.", + "enum" : [ "search", "vectorSearch" ] } }, - "title" : "Serverless Instance Private Endpoint Connection String" + "required" : [ "collectionName", "database", "name" ] }, - "ServerlessEventTypeViewAlertable" : { - "type" : "string", - "description" : "Event type that triggers an alert.", - "enum" : [ "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], - "example" : "OUTSIDE_SERVERLESS_METRIC_THRESHOLD", - "title" : "Serverless Event Types" + "SearchIndexDefinition" : { + "type" : "object", + "description" : "The search index definition set by the user.", + "title" : "Search Index Definition" + }, + "SearchIndexDefinitionVersion" : { + "type" : "object", + "description" : "Object which includes the version number of the index definition and the time that the index definition was created.", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "The time at which this index definition was created." + }, + "version" : { + "type" : "integer", + "format" : "int64", + "description" : "The version number associated with this index definition when it was created." + } + }, + "title" : "Search Index Definition Version" }, - "ServerlessInstanceDescription" : { + "SearchIndexResponse" : { "type" : "object", - "description" : "Group of settings that configure a MongoDB serverless instance.", - "properties" : { - "connectionStrings" : { - "$ref" : "#/components/schemas/ServerlessInstanceDescriptionConnectionStrings" + "discriminator" : { + "mapping" : { + "search" : "#/components/schemas/TextSearchIndexResponse", + "vectorSearch" : "#/components/schemas/VectorSearchIndexResponse" }, - "createDate" : { + "propertyName" : "type" + }, + "properties" : { + "collectionName" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", - "readOnly" : true + "description" : "Label that identifies the collection that contains one or more Atlas Search indexes." }, - "groupId" : { + "database" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the project.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "description" : "Label that identifies the database that contains the collection with one or more Atlas Search indexes." }, - "id" : { + "indexID" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the serverless instance.", + "description" : "Unique 24-hexadecimal digit string that identifies this Atlas Search index.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "pattern" : "^([a-f0-9]{24})$" }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true + "latestDefinition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" }, - "mongoDBVersion" : { - "type" : "string", - "description" : "Version of MongoDB that the serverless instance runs.", - "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", - "readOnly" : true + "latestDefinitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" }, "name" : { "type" : "string", - "description" : "Human-readable label that identifies the serverless instance.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - }, - "providerSettings" : { - "$ref" : "#/components/schemas/ServerlessProviderSettings" + "description" : "Label that identifies this index. Within each namespace, the names of all indexes must be unique." }, - "serverlessBackupOptions" : { - "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on all hosts." }, - "stateName" : { + "status" : { "type" : "string", - "description" : "Human-readable label that indicates the current operating condition of the serverless instance.", - "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], - "readOnly" : true + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] }, - "tags" : { + "statusDetail" : { "type" : "array", - "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", + "description" : "List of documents detailing index status on each host.", "items" : { - "$ref" : "#/components/schemas/ResourceTag" + "$ref" : "#/components/schemas/SearchHostStatusDetail" } }, - "terminationProtectionEnabled" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." + "type" : { + "type" : "string", + "description" : "Type of the index. The default type is search.", + "enum" : [ "search", "vectorSearch" ] } }, - "required" : [ "providerSettings" ], - "title" : "Serverless Instance Description" + "title" : "Search Index Response" }, - "ServerlessInstanceDescriptionConnectionStrings" : { + "SearchIndexUpdateRequest" : { "type" : "object", - "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", - "externalDocs" : { - "description" : "Connection string URI format.", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, "properties" : { - "privateEndpoint" : { - "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.", - "items" : { - "$ref" : "#/components/schemas/ServerlessConnectionStringsPrivateEndpointList" - }, - "readOnly" : true - }, - "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.", - "externalDocs" : { - "description" : "Connection String URI Format", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, - "readOnly" : true + "definition" : { + "type" : "object", + "description" : "The index definition to update the search index to.", + "oneOf" : [ { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + }, { + "$ref" : "#/components/schemas/VectorSearchIndexDefinition" + } ] } }, - "readOnly" : true, - "title" : "Serverless Instance Connection Strings" + "required" : [ "definition" ], + "title" : "Search Index Update Request" }, - "ServerlessInstanceDescriptionCreate" : { + "SearchMainIndexStatusDetail" : { "type" : "object", - "description" : "Settings that you can specify when you create a serverless instance.", + "description" : "Contains status information about the active index.", "properties" : { - "name" : { - "type" : "string", - "description" : "Human-readable label that identifies the serverless instance.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "writeOnly" : true - }, - "providerSettings" : { - "$ref" : "#/components/schemas/ServerlessProviderSettings" + "definition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" }, - "serverlessBackupOptions" : { - "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" }, - "stateName" : { + "message" : { "type" : "string", - "description" : "Human-readable label that indicates the current operating condition of the serverless instance.", - "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], - "readOnly" : true - }, - "tags" : { - "type" : "array", - "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", - "items" : { - "$ref" : "#/components/schemas/ResourceTag" - } + "description" : "Optional message describing an error." }, - "terminationProtectionEnabled" : { + "queryable" : { "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." + "description" : "Flag that indicates whether the index generation is queryable on the host." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] } }, - "required" : [ "name", "providerSettings" ], - "title" : "Serverless Instance Description Create" + "title" : "Search Main Index Status Detail" }, - "ServerlessInstanceDescriptionUpdate" : { + "SearchMappings" : { "type" : "object", - "description" : "Settings that you can update when you request a serverless cluster update.", + "description" : "Index specifications for the collection's fields.", "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.", - "items" : { - "$ref" : "#/components/schemas/ResourceTag" + "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/field-mapping-definition-fts#static-and-dynamic-mappings" } }, - "terminationProtectionEnabled" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." + "fields" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "One or more field specifications for the Atlas Search index. Required if **mappings.dynamic** is omitted or set to **false**.", + "externalDocs" : { + "description" : "Atlas Search Index", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "x-additionalPropertiesName" : "Field Name" + }, + "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" + }, + "x-additionalPropertiesName" : "Field Name" } }, - "title" : "Serverless Instance Description Update" + "title" : "Mappings" }, - "ServerlessMetricAlertConfigViewForNdsGroup" : { + "SearchStagedIndexStatusDetail" : { "type" : "object", - "description" : "Serverless metric alert configuration allows to select which serverless database metrics trigger alerts and how users are notified.", + "description" : "Contains status information about an index building in the background.", "properties" : { - "created" : { + "definition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" + }, + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "message" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "description" : "Optional message describing an error." }, - "enabled" : { + "queryable" : { "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + "description" : "Flag that indicates whether the index generation is queryable on the host." }, - "eventTypeName" : { - "$ref" : "#/components/schemas/ServerlessEventTypeViewAlertable" + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Search Staged Index Status Detail" + }, + "SearchSynonymMappingDefinition" : { + "type" : "object", + "description" : "Synonyms used for this full text index.", + "properties" : { + "analyzer" : { + "type" : "string", + "description" : "Specific pre-defined method chosen to apply to the synonyms to be searched.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] }, - "groupId" : { + "name" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "description" : "Label that identifies the synonym definition. Each **synonym.name** must be unique within the same index definition." }, - "id" : { + "source" : { + "$ref" : "#/components/schemas/SynonymSource" + } + }, + "required" : [ "analyzer", "name", "source" ], + "title" : "Synonym Mapping Definition" + }, + "ServerlessAWSTenantEndpoint" : { + "type" : "object", + "description" : "View for a serverless AWS tenant endpoint.", + "properties" : { + "_id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - }, - "matchers" : { - "type" : "array", - "description" : "Matching conditions for target resources.", - "items" : { - "$ref" : "#/components/schemas/AlertMatcher" - } - }, - "metricThreshold" : { - "$ref" : "#/components/schemas/ServerlessMetricThreshold" - }, - "notifications" : { - "type" : "array", - "description" : "List that contains the targets that MongoDB Cloud sends notifications.", - "items" : { - "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" - } - }, - "updated" : { + "cloudProviderEndpointId" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Unique string that identifies the private endpoint's network interface.", + "pattern" : "^vpce-[0-9a-f]{17}$", "readOnly" : true - } - }, - "required" : [ "eventTypeName", "notifications" ], - "title" : "Serverless Alert Configuration" - }, - "ServerlessMetricThreshold" : { - "type" : "object", - "description" : "Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.", - "discriminator" : { - "mapping" : { - "SERVERLESS_AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", - "SERVERLESS_AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", - "SERVERLESS_AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", - "SERVERLESS_CONNECTIONS" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricThresholdView", - "SERVERLESS_NETWORK_BYTES_IN" : "#/components/schemas/DataMetricThresholdView", - "SERVERLESS_NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricThresholdView", - "SERVERLESS_NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_OPCOUNTER_CMD" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_OPCOUNTER_QUERY" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_TOTAL_READ_UNITS" : "#/components/schemas/RPUMetricThresholdView", - "SERVERLESS_TOTAL_WRITE_UNITS" : "#/components/schemas/RPUMetricThresholdView" }, - "propertyName" : "metricName" - }, - "properties" : { - "metricName" : { + "comment" : { "type" : "string", - "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "readOnly" : true }, - "mode" : { + "endpointServiceName" : { "type" : "string", - "description" : "MongoDB Cloud computes the current metric value as an average.", - "enum" : [ "AVERAGE" ] - }, - "operator" : { - "$ref" : "#/components/schemas/Operator" - }, - "threshold" : { - "type" : "number", - "format" : "double", - "description" : "Value of metric that, when exceeded, triggers an alert." + "description" : "Unique string that identifies the Amazon Web Services (AWS) PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}", + "readOnly" : true }, - "units" : { - "type" : "string", - "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", - "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] - } - }, - "required" : [ "metricName" ], - "title" : "Serverless Metric Threshold" - }, - "ServerlessMetricUnits" : { - "type" : "string", - "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", - "enum" : [ "RPU", "THOUSAND_RPU", "MILLION_RPU", "WPU", "THOUSAND_WPU", "MILLION_WPU" ], - "example" : "RPU", - "title" : "Serverless Metric Units" - }, - "ServerlessProviderSettings" : { - "type" : "object", - "description" : "Group of cloud provider settings that configure the provisioned MongoDB serverless instance.", - "properties" : { - "backingProviderName" : { + "errorMessage" : { "type" : "string", - "description" : "Cloud service provider on which MongoDB Cloud provisioned the serverless instance.", - "enum" : [ "AWS", "AZURE", "GCP" ] + "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", + "readOnly" : true }, "providerName" : { "type" : "string", - "default" : "SERVERLESS", "description" : "Human-readable label that identifies the cloud service provider.", - "enum" : [ "SERVERLESS" ] + "enum" : [ "AWS" ], + "readOnly" : true }, - "regionName" : { + "status" : { "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/)." + "description" : "Human-readable label that indicates the current operating status of the private endpoint.", + "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true } }, - "required" : [ "backingProviderName", "regionName" ], - "title" : "Cloud Service Provider Settings for a Serverless Instance" + "title" : "AWS" }, - "ServerlessTenantCreateRequest" : { + "ServerlessAWSTenantEndpointUpdate" : { "type" : "object", - "properties" : { - "comment" : { - "type" : "string", - "description" : "Human-readable comment associated with the private endpoint.", - "maxLength" : 80, - "writeOnly" : true + "allOf" : [ { + "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" + }, { + "type" : "object", + "properties" : { + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface.", + "pattern" : "^vpce-[0-9a-f]{17}$", + "writeOnly" : true + } } - } + } ], + "description" : "Updates to a serverless AWS tenant endpoint.", + "required" : [ "providerName" ], + "title" : "AWS" }, - "ServerlessTenantEndpoint" : { + "ServerlessAzureTenantEndpoint" : { "type" : "object", - "oneOf" : [ { - "$ref" : "#/components/schemas/ServerlessAWSTenantEndpoint" - }, { - "$ref" : "#/components/schemas/ServerlessAzureTenantEndpoint" - } ], + "description" : "View for a serverless Azure tenant endpoint.", "properties" : { "_id" : { "type" : "string", @@ -48503,7 +51806,8 @@ }, "cloudProviderEndpointId" : { "type" : "string", - "description" : "Unique string that identifies the private endpoint's network interface.", + "description" : "Unique string that identifies the Azure private endpoint's network interface that someone added to this private endpoint service.", + "pattern" : "^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\\.Network/privateEndpoints/[-\\w._()]+$", "readOnly" : true }, "comment" : { @@ -48514,8 +51818,8 @@ }, "endpointServiceName" : { "type" : "string", - "description" : "Unique string that identifies the PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", - "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}|pls_[0-9a-f]{24}$", + "description" : "Unique string that identifies the Azure private endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^pls_[0-9a-f]{24}$", "readOnly" : true }, "errorMessage" : { @@ -48523,112 +51827,113 @@ "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", "readOnly" : true }, - "status" : { + "privateEndpointIpAddress" : { "type" : "string", - "description" : "Human-readable label that indicates the current operating status of the private endpoint.", - "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", "readOnly" : true - } - } - }, - "ServerlessTenantEndpointUpdate" : { - "type" : "object", - "description" : "Update view for a serverless tenant endpoint.", - "discriminator" : { - "mapping" : { - "AWS" : "#/components/schemas/ServerlessAWSTenantEndpointUpdate", - "AZURE" : "#/components/schemas/ServerlessAzureTenantEndpointUpdate" }, - "propertyName" : "providerName" - }, - "properties" : { - "comment" : { + "privateLinkServiceResourceId" : { "type" : "string", - "description" : "Human-readable comment associated with the private endpoint.", - "maxLength" : 80, - "writeOnly" : true + "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 provider of the tenant endpoint.", - "enum" : [ "AWS", "AZURE" ], - "writeOnly" : true + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "AZURE" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating status of the private endpoint.", + "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true } }, - "required" : [ "providerName" ] - }, - "ServiceAccountEventTypeViewForNdsGroup" : { - "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" ], - "title" : "Service Account Event Types" - }, - "ServiceAccountEventTypeViewForOrg" : { - "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" ], - "title" : "Service Account Event Types" + "title" : "Azure" }, - "ServiceAccountGroup" : { + "ServerlessAzureTenantEndpointUpdate" : { "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "allOf" : [ { + "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" + }, { + "type" : "object", + "properties" : { + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure private endpoint's network interface for this private endpoint service.", + "pattern" : "^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\\.Network/privateEndpoints/[-\\w._()]+$", + "writeOnly" : true + }, + "privateEndpointIpAddress" : { + "type" : "string", + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "writeOnly" : true + } } - } + } ], + "description" : "Updates to a serverless Azure tenant endpoint.", + "required" : [ "providerName" ], + "title" : "AZURE" }, - "ServiceAccountGroupEvents" : { + "ServerlessBackupRestoreJob" : { "type" : "object", - "description" : "Service Account event identifies different activities around user api keys.", "properties" : { - "apiKeyId" : { + "cancelled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone canceled this restore job.", + "readOnly" : true + }, + "deliveryType" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "description" : "Human-readable label that categorizes the restore job to create.", + "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\"`.", + "items" : { + "type" : "string", + "description" : "One Uniform Resource Locator that points to the compressed snapshot files for manual download." + }, "readOnly" : true }, - "created" : { + "desiredTimestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "expired" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job expired.", + "readOnly" : true + }, + "expiresAt" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Date and time when the restore job expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "eventTypeName" : { - "$ref" : "#/components/schemas/ServiceAccountEventTypeViewForNdsGroup" + "failed" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job failed.", + "readOnly" : true }, - "groupId" : { + "finishedAt" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "format" : "date-time", + "description" : "Date and time when the restore job completed. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "description" : "Unique 24-hexadecimal character string that identifies the restore job.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "isGlobalAdmin" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", - "readOnly" : true - }, "links" : { "type" : "array", "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", @@ -48641,98 +51946,87 @@ }, "readOnly" : true }, - "orgId" : { + "oplogInc" : { + "type" : "integer", + "format" : "int32", + "description" : "Oplog operation number from which you want to restore this snapshot. This number represents the second part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", + "example" : 1, + "minimum" : 1 + }, + "oplogTs" : { + "type" : "integer", + "format" : "int32", + "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`.", + "minimum" : 1199145600 + }, + "pointInTimeUTCSeconds" : { + "type" : "integer", + "format" : "int32", + "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`.", + "minimum" : 1199145600 + }, + "snapshotId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "publicKey" : { - "type" : "string", - "format" : "email", - "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "example" : "test.user@mongodb.com", - "readOnly" : true - }, - "raw" : { - "$ref" : "#/components/schemas/raw" + "pattern" : "^([a-f0-9]{24})$" }, - "remoteAddress" : { + "targetClusterName" : { "type" : "string", - "description" : "IPv4 or IPv6 address from which the user triggered this event.", - "example" : "216.172.40.186", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", - "readOnly" : true + "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\"`.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, - "userId" : { + "targetGroupId" : { "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.", + "description" : "Unique 24-hexadecimal digit string that identifies the target project for the specified **targetClusterName**.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "pattern" : "^([a-f0-9]{24})$" }, - "username" : { + "timestamp" : { "type" : "string", - "format" : "email", - "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", - "example" : "test.user@mongodb.com", + "format" : "date-time", + "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.", "readOnly" : true } }, - "required" : [ "created", "eventTypeName", "id" ], - "title" : "ServiceAccount Events" + "required" : [ "deliveryType", "targetClusterName", "targetGroupId" ] }, - "ServiceAccountOrgEvents" : { + "ServerlessBackupSnapshot" : { "type" : "object", - "description" : "Service Account event identifies different activities around user api keys.", "properties" : { - "apiKeyId" : { + "createdAt" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "created" : { + "expiresAt" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "eventTypeName" : { - "$ref" : "#/components/schemas/ServiceAccountEventTypeViewForOrg" - }, - "groupId" : { + "frequencyType" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "description" : "Human-readable label that identifies how often this snapshot triggers.", + "enum" : [ "hourly", "daily", "weekly", "monthly" ], "readOnly" : true }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "isGlobalAdmin" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", - "readOnly" : true - }, "links" : { "type" : "array", "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", @@ -48745,332 +52039,278 @@ }, "readOnly" : true }, - "orgId" : { + "mongodVersion" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "description" : "Version of the MongoDB host that this snapshot backs up.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", "readOnly" : true }, - "publicKey" : { + "serverlessInstanceName" : { "type" : "string", - "format" : "email", - "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "example" : "test.user@mongodb.com", + "description" : "Human-readable label given to the serverless instance from which MongoDB Cloud took this snapshot.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, - "raw" : { - "$ref" : "#/components/schemas/raw" - }, - "remoteAddress" : { + "snapshotType" : { "type" : "string", - "description" : "IPv4 or IPv6 address from which the user triggered this event.", - "example" : "216.172.40.186", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "description" : "Human-readable label that identifies when this snapshot triggers.", + "enum" : [ "onDemand", "scheduled" ], "readOnly" : true }, - "userId" : { + "status" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", + "enum" : [ "queued", "inProgress", "completed", "failed" ], "readOnly" : true }, - "username" : { - "type" : "string", - "format" : "email", - "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", - "example" : "test.user@mongodb.com", + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of bytes taken to store the backup snapshot.", "readOnly" : true } - }, - "required" : [ "created", "eventTypeName", "id" ], - "title" : "ServiceAccount Events" + } }, - "ServiceAccountSecret" : { + "ServerlessConnectionStringsPrivateEndpointItem" : { "type" : "object", + "description" : "Details of a private endpoint deployed for this serverless instance.", "properties" : { - "createdAt" : { + "endpointId" : { "type" : "string", - "format" : "date-time", - "description" : "Timestamp representing creation time.", + "description" : "Unique string that the cloud provider uses to identify the private endpoint.", "readOnly" : true }, - "expiresAt" : { + "providerName" : { "type" : "string", - "format" : "date-time", - "description" : "Timestamp representing secret expiration time.", + "description" : "Cloud provider where the private endpoint is deployed.", + "enum" : [ "AWS", "AZURE" ], "readOnly" : true }, - "id" : { + "region" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the secret.", - "example" : "32b6e34b3d91647abb20e7b8", - "pattern" : "^([a-f0-9]{24})$", + "description" : "Region where the private endpoint is deployed.", "readOnly" : true - }, - "lastUsedAt" : { - "type" : "string", - "format" : "date-time", - "description" : "Timestamp representing last secret usage.", + } + }, + "title" : "Serverless Instance Private Endpoint Connection Strings Endpoint" + }, + "ServerlessConnectionStringsPrivateEndpointList" : { + "type" : "object", + "description" : "Private endpoint connection string that you can use to connect to this serverless instance through a private endpoint.", + "externalDocs" : { + "description" : "Private Endpoint for Serverless Instance", + "url" : "https://docs.atlas.mongodb.com/security-serverless-private-endpoint/" + }, + "properties" : { + "endpoints" : { + "type" : "array", + "description" : "List that contains the private endpoints through which you connect to MongoDB Cloud when you use **connectionStrings.privateEndpoint[n].srvConnectionString**.", + "items" : { + "$ref" : "#/components/schemas/ServerlessConnectionStringsPrivateEndpointItem" + }, "readOnly" : true }, - "maskedSecretValue" : { + "srvConnectionString" : { "type" : "string", - "description" : "Service Account secret with masked values of the first 20 characters.", - "example" : "mdb_ic_sk_...12ce", + "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 }, - "secret" : { + "type" : { "type" : "string", - "description" : "Secret for the service account. It will be returned only the first time after service account creation.", - "pattern" : "^mdb_sa_sk_[0-9a-zA-Z]{40}$", + "description" : "MongoDB process type to which your application connects.", + "enum" : [ "MONGOS" ], "readOnly" : true } }, - "required" : [ "createdAt", "expiresAt", "id" ] + "title" : "Serverless Instance Private Endpoint Connection String" }, - "ServiceAccountSecretRequest" : { - "type" : "object", - "properties" : { - "secretExpiresAfterHours" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of hours representing validity duration for secret." - } - }, - "required" : [ "secretExpiresAfterHours" ] + "ServerlessEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], + "example" : "OUTSIDE_SERVERLESS_METRIC_THRESHOLD", + "title" : "Serverless Event Types" }, - "ShardEntry" : { + "ServerlessInstanceDescription" : { "type" : "object", - "description" : "Sharding configuration for a collection to be sharded on the destination cluster.", + "description" : "Group of settings that configure a MongoDB serverless instance.", "properties" : { - "collection" : { + "connectionStrings" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescriptionConnectionStrings" + }, + "createDate" : { "type" : "string", - "description" : "Human-readable label that identifies the collection to be sharded on the destination cluster.", - "writeOnly" : true + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true }, - "database" : { + "groupId" : { "type" : "string", - "description" : "Human-readable label that identifies the database that contains the collection to be sharded on the destination cluster.", - "writeOnly" : true + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "shardCollection" : { - "$ref" : "#/components/schemas/ShardKeys" - } - }, - "required" : [ "collection", "database", "shardCollection" ] - }, - "ShardKeys" : { - "type" : "object", - "description" : "Document that configures the shard key on the destination cluster.", - "properties" : { - "key" : { - "type" : "array", - "description" : "List of fields to use for the shard key.", - "items" : { - "type" : "object", - "additionalProperties" : { - "type" : "object" - } - }, - "uniqueItems" : true, - "writeOnly" : true - } - }, - "writeOnly" : true - }, - "ShardingRequest" : { - "type" : "object", - "description" : "Document that configures sharding on the destination cluster when migrating from a replica set source to a sharded cluster destination on MongoDB 6.0 or higher. If you don't wish to shard any collections on the destination cluster, leave this empty.", - "properties" : { - "createSupportingIndexes" : { - "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 + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the serverless instance.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "shardingEntries" : { + "links" : { "type" : "array", - "description" : "List of shard configurations to shard destination collections. Atlas shards only those collections that you include in the sharding entries array.", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, "items" : { - "$ref" : "#/components/schemas/ShardEntry" + "$ref" : "#/components/schemas/Link" }, - "uniqueItems" : true, - "writeOnly" : true - } - }, - "required" : [ "createSupportingIndexes" ], - "writeOnly" : true - }, - "Slack" : { - "type" : "object", - "description" : "Details to integrate one Slack account with one MongoDB Cloud project.", - "properties" : { - "apiToken" : { + "readOnly" : true + }, + "mongoDBVersion" : { "type" : "string", - "description" : "Key that allows MongoDB Cloud to access your Slack account.\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.\n\n**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" + "description" : "Version of MongoDB that the serverless instance runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true }, - "channelName" : { + "name" : { "type" : "string", - "description" : "Name of the Slack channel to which MongoDB Cloud sends alert notifications.", - "example" : "alerts", - "maxLength" : 80, + "description" : "Human-readable label that identifies the serverless instance.", + "maxLength" : 64, "minLength" : 1, - "nullable" : true + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, - "id" : { - "type" : "string", - "description" : "Integration id.", - "nullable" : true + "providerSettings" : { + "$ref" : "#/components/schemas/ServerlessProviderSettings" }, - "teamName" : { - "type" : "string", - "description" : "Human-readable label that identifies your Slack team. Set this parameter when you configure a legacy Slack integration.", - "example" : "MongoDB" + "serverlessBackupOptions" : { + "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" }, - "type" : { + "stateName" : { "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" : "Human-readable label that indicates the current operating condition of the serverless instance.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." } }, - "required" : [ "apiToken", "channelName" ], - "title" : "SLACK" + "required" : [ "providerSettings" ], + "title" : "Serverless Instance Description" }, - "SlackNotification" : { + "ServerlessInstanceDescriptionConnectionStrings" : { "type" : "object", - "description" : "Slack notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, "properties" : { - "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", - "format" : "int32", - "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." - }, - "integrationId" : { - "type" : "string", - "description" : "The id of the associated integration, the credentials of which to use for requests.", - "example" : "32b6e34b3d91647abb20e7b8" - }, - "intervalMin" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", - "minimum" : 5 - }, - "notifierId" : { - "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" + "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.", + "items" : { + "$ref" : "#/components/schemas/ServerlessConnectionStringsPrivateEndpointList" + }, + "readOnly" : true }, - "typeName" : { + "standardSrv" : { "type" : "string", - "description" : "Human-readable label that displays the alert notification type.", - "enum" : [ "SLACK" ] + "description" : "Public connection string that you can use to connect to this serverless instance. This connection string uses the `mongodb+srv://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true } }, - "required" : [ "typeName" ], - "title" : "Slack Notification" + "readOnly" : true, + "title" : "Serverless Instance Connection Strings" }, - "Source" : { + "ServerlessInstanceDescriptionCreate" : { "type" : "object", - "description" : "Document that describes the source of the migration.", + "description" : "Settings that you can specify when you create a serverless instance.", "properties" : { - "caCertificatePath" : { + "name" : { "type" : "string", - "description" : "Path to the CA certificate that signed SSL certificates use to authenticate to the source cluster." + "description" : "Human-readable label that identifies the serverless instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "writeOnly" : true }, - "clusterName" : { - "type" : "string", - "description" : "Label that identifies the source cluster name." + "providerSettings" : { + "$ref" : "#/components/schemas/ServerlessProviderSettings" }, - "groupId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the source project.", - "example" : "9b43a5b329223c3a1591a678", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" + "serverlessBackupOptions" : { + "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" }, - "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." + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the serverless instance.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true }, - "password" : { - "type" : "string", - "description" : "Password that authenticates the username to the source cluster.", - "writeOnly" : true + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } }, - "ssl" : { + "terminationProtectionEnabled" : { "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 - } - }, - "required" : [ "clusterName", "groupId", "managedAuthentication", "ssl" ] - }, - "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/" + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." } }, - "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/" - } + "required" : [ "name", "providerSettings" ], + "title" : "Serverless Instance Description Create" }, - "StreamConfig" : { + "ServerlessInstanceDescriptionUpdate" : { "type" : "object", - "description" : "Configuration options for an Atlas Stream Processing Instance.", - "nullable" : true, + "description" : "Settings that you can update when you request a serverless cluster update.", "properties" : { - "links" : { + "serverlessBackupOptions" : { + "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" + }, + "tags" : { "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true + "$ref" : "#/components/schemas/ResourceTag" + } }, - "tier" : { - "type" : "string", - "description" : "Selected tier for the Stream Instance. Configures Memory / VCPU allowances.", - "enum" : [ "SP30", "SP10" ], - "title" : "Stream Instance Tier" + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." } - } + }, + "title" : "Serverless Instance Description Update" }, - "StreamProcessorAlertConfigViewForNdsGroup" : { + "ServerlessMetricAlertConfigViewForNdsGroup" : { "type" : "object", - "description" : "Host metric alert configuration allows to select which Atlas streams processors trigger alerts and how users are notified.", + "description" : "Serverless metric alert configuration allows to select which serverless database metrics trigger alerts and how users are notified.", "properties" : { "created" : { "type" : "string", @@ -49084,7 +52324,7 @@ "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." }, "eventTypeName" : { - "$ref" : "#/components/schemas/StreamProcessorEventTypeViewAlertable" + "$ref" : "#/components/schemas/ServerlessEventTypeViewAlertable" }, "groupId" : { "type" : "string", @@ -49118,11 +52358,14 @@ }, "matchers" : { "type" : "array", - "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration.", + "description" : "Matching conditions for target resources.", "items" : { - "$ref" : "#/components/schemas/StreamsMatcher" + "$ref" : "#/components/schemas/AlertMatcher" } }, + "metricThreshold" : { + "$ref" : "#/components/schemas/ServerlessMetricThreshold" + }, "notifications" : { "type" : "array", "description" : "List that contains the targets that MongoDB Cloud sends notifications.", @@ -49138,157 +52381,215 @@ } }, "required" : [ "eventTypeName", "notifications" ], - "title" : "Stream Processor Alert Configuration" + "title" : "Serverless Alert Configuration" }, - "StreamProcessorAlertViewForNdsGroup" : { + "ServerlessMetricThreshold" : { "type" : "object", - "description" : "Stream Processor alert notifies about activities on Stream Processor in AtlasStreams.", + "description" : "Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.", + "discriminator" : { + "mapping" : { + "SERVERLESS_AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_CONNECTIONS" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_BYTES_IN" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_CMD" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_QUERY" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_TOTAL_READ_UNITS" : "#/components/schemas/RPUMetricThresholdView", + "SERVERLESS_TOTAL_WRITE_UNITS" : "#/components/schemas/RPUMetricThresholdView" + }, + "propertyName" : "metricName" + }, "properties" : { - "acknowledgedUntil" : { + "metricName" : { "type" : "string", - "format" : "date-time", - "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.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." }, - "acknowledgementComment" : { + "mode" : { "type" : "string", - "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", - "example" : "Expiration on 3/19. Silencing for 7days.", - "maxLength" : 200 + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] }, - "acknowledgingUsername" : { + "operator" : { "type" : "string", - "format" : "email", - "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", - "readOnly" : true + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, - "alertConfigId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." }, - "created" : { + "units" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true - }, - "eventTypeName" : { - "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroupAlertable" - }, - "groupId" : { + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] + } + }, + "required" : [ "metricName" ], + "title" : "Serverless Metric Threshold" + }, + "ServerlessMetricUnits" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "RPU", "THOUSAND_RPU", "MILLION_RPU", "WPU", "THOUSAND_WPU", "MILLION_WPU" ], + "example" : "RPU", + "title" : "Serverless Metric Units" + }, + "ServerlessProviderSettings" : { + "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB serverless instance.", + "properties" : { + "backingProviderName" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "description" : "Cloud service provider on which MongoDB Cloud provisioned the serverless instance.", + "enum" : [ "AWS", "AZURE", "GCP" ] }, - "id" : { + "providerName" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies this alert.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "default" : "SERVERLESS", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "SERVERLESS" ] }, - "instanceName" : { + "regionName" : { "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.", - "example" : "foobar", - "readOnly" : true - }, - "lastNotified" : { + "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/)." + } + }, + "required" : [ "backingProviderName", "regionName" ], + "title" : "Cloud Service Provider Settings for a Serverless Instance" + }, + "ServerlessTenantCreateRequest" : { + "type" : "object", + "properties" : { + "comment" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", - "readOnly" : true - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - }, - "orgId" : { + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "writeOnly" : true + } + } + }, + "ServerlessTenantEndpoint" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/ServerlessAWSTenantEndpoint" + }, { + "$ref" : "#/components/schemas/ServerlessAzureTenantEndpoint" + } ], + "properties" : { + "_id" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "processorErrorMsg" : { + "cloudProviderEndpointId" : { "type" : "string", - "description" : "The error message associated with the Stream Processor to which this alert applies.", - "example" : "MongoServerError: Failed to start stream processor: (Location77175) Could not connect to the Kafka topic with kafka error code: -195, message: Local: Broker transport failure.: (Location77175)", + "description" : "Unique string that identifies the private endpoint's network interface.", "readOnly" : true }, - "processorName" : { + "comment" : { "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.", - "example" : "foobar", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, "readOnly" : true }, - "processorState" : { + "endpointServiceName" : { "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.", - "example" : "STARTED", + "description" : "Unique string that identifies the PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}|pls_[0-9a-f]{24}$", "readOnly" : true }, - "resolved" : { + "errorMessage" : { "type" : "string", - "format" : "date-time", - "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\"`.", + "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", "readOnly" : true }, "status" : { "type" : "string", - "description" : "State of this alert at the time you requested its details.", - "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], - "example" : "OPEN", + "description" : "Human-readable label that indicates the current operating status of the private endpoint.", + "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], "readOnly" : true + } + } + }, + "ServerlessTenantEndpointUpdate" : { + "type" : "object", + "description" : "Update view for a serverless tenant endpoint.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/ServerlessAWSTenantEndpointUpdate", + "AZURE" : "#/components/schemas/ServerlessAzureTenantEndpointUpdate" }, - "updated" : { + "propertyName" : "providerName" + }, + "properties" : { + "comment" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "writeOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider of the tenant endpoint.", + "enum" : [ "AWS", "AZURE" ], + "writeOnly" : true } }, - "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], - "title" : "Stream Processor Alerts" + "required" : [ "providerName" ] }, - "StreamProcessorEventTypeViewAlertable" : { + "ServiceAccountEventTypeViewForNdsGroup" : { "type" : "string", - "description" : "Event type that triggers an alert.", - "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], - "example" : "STREAM_PROCESSOR_STATE_IS_FAILED", - "title" : "Stream Processor Event Types" + "description" : "Unique identifier of event type.", + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" }, - "StreamProcessorEventTypeViewForNdsGroup" : { + "ServiceAccountEventTypeViewForOrg" : { "type" : "string", "description" : "Unique identifier of event type.", - "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], - "example" : "STREAM_PROCESSOR_STATE_IS_FAILED", - "title" : "Stream Processor Event Types" + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" }, - "StreamProcessorEventViewForNdsGroup" : { + "ServiceAccountGroup" : { "type" : "object", - "description" : "Stream Processor event identifies different activities about a stream processor in Atlas Streams.", "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies your project. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "ServiceAccountGroupEvents" : { + "type" : "object", + "description" : "Service Account event identifies different activities around user api keys.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, "created" : { "type" : "string", "format" : "date-time", @@ -49296,7 +52597,7 @@ "readOnly" : true }, "eventTypeName" : { - "$ref" : "#/components/schemas/StreamProcessorEventTypeViewForNdsGroup" + "$ref" : "#/components/schemas/ServiceAccountEventTypeViewForNdsGroup" }, "groupId" : { "type" : "string", @@ -49316,10 +52617,10 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "instanceName" : { - "type" : "string", - "description" : "Name of the stream processing instance associated with the event.", - "example" : "foobar", + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", "readOnly" : true }, "links" : { @@ -49343,159 +52644,96 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "processorErrorMsg" : { - "type" : "string", - "description" : "Error message linked to the stream processor associated with the event.", - "example" : "invalid auth", - "readOnly" : true - }, - "processorName" : { - "type" : "string", - "description" : "Name of the stream processor associated with the event.", - "example" : "foobar", - "readOnly" : true - }, - "processorState" : { + "publicKey" : { "type" : "string", - "description" : "State of the stream processor associated with the event.", - "example" : "FAILED", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true }, "raw" : { "$ref" : "#/components/schemas/raw" - } - }, - "required" : [ "created", "eventTypeName", "id" ], - "title" : "Stream Processor Events" - }, - "StreamsClusterConnection" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/StreamsConnection" - }, { - "type" : "object", - "properties" : { - "clusterName" : { - "type" : "string", - "description" : "Name of the cluster configured for this connection." - }, - "dbRoleToExecute" : { - "$ref" : "#/components/schemas/DBRoleToExecute" - } - } - } ] - }, - "StreamsConnection" : { - "type" : "object", - "description" : "Settings that define a connection to an external data store.", - "discriminator" : { - "mapping" : { - "Cluster" : "#/components/schemas/StreamsClusterConnection", - "Kafka" : "#/components/schemas/StreamsKafkaConnection", - "Sample" : "#/components/schemas/StreamsSampleConnection" }, - "propertyName" : "type" - }, - "oneOf" : [ { - "$ref" : "#/components/schemas/StreamsSampleConnection" - }, { - "$ref" : "#/components/schemas/StreamsClusterConnection" - }, { - "$ref" : "#/components/schemas/StreamsKafkaConnection" - } ], - "properties" : { - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", "readOnly" : true }, - "name" : { + "userId" : { "type" : "string", - "description" : "Human-readable label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source." + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "type" : { + "username" : { "type" : "string", - "description" : "Type of the connection. Can be either Cluster or Kafka.", - "enum" : [ "Kafka", "Cluster", "Sample" ] + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true } }, - "readOnly" : true + "required" : [ "created", "eventTypeName", "id" ], + "title" : "ServiceAccount Events" }, - "StreamsDLQ" : { + "ServiceAccountIPAccessListEntry" : { "type" : "object", - "description" : "Dead letter queue for the stream processor.", "properties" : { - "coll" : { + "cidrBlock" : { "type" : "string", - "description" : "Name of the collection that will be used for the DLQ." + "description" : "Range of network addresses in the access list for the Service Account. This parameter requires the range to be expressed in Classless Inter-Domain Routing (CIDR) notation of Internet Protocol version 4 or version 6 addresses. You can set a value for this parameter or **ipAddress**, but not for both in the same request.", + "example" : "203.0.113.0/24", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" }, - "connectionName" : { + "createdAt" : { "type" : "string", - "description" : "Connection name that will be used to write DLQ messages to. Has to be an Atlas connection." + "format" : "date-time", + "description" : "Date MongoDB Cloud added the entry was added to the Access List.", + "readOnly" : true }, - "db" : { + "ipAddress" : { "type" : "string", - "description" : "Name of the database that will be used for the DLQ." + "description" : "Network address in the access list for the Service Account. This parameter requires the address to be expressed as one Internet Protocol version 4 or version 6 address. You can set a value for this parameter or **cidrBlock**, but not for both in the same request.", + "example" : "203.0.113.10", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - } - } - }, - "StreamsDataProcessRegion" : { - "type" : "object", - "description" : "Information about the cloud provider region in which MongoDB Cloud processes the stream.", - "properties" : { - "cloudProvider" : { + "lastUsedAddress" : { "type" : "string", - "description" : "Label that identifies the cloud service provider where MongoDB Cloud performs stream processing. Currently, this parameter supports AWS only.", - "enum" : [ "AWS", "GCP", "AZURE", "TENANT", "SERVERLESS" ] + "description" : "Network address that issued the most recent request to the API. This parameter requires the address to be expressed as one Internet Protocol version 4 or version 6 address. The resource returns this parameter after this IP address makes at least one request.", + "readOnly" : true }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, + "lastUsedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date when MongoDB Cloud received the most recent request that originated from this Internet Protocol version 4 or version 6 address. The resource returns this parameter when at least one request originates from this IP address. MongoDB Cloud updates this parameter each time a client accesses the permitted resource, with a delay of up to 5 minutes.", "readOnly" : true }, - "region" : { - "$ref" : "#/components/schemas/BaseStreamsRegion" + "requestCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of requests that has originated from this network address.", + "readOnly" : true } - }, - "required" : [ "cloudProvider", "region" ] - }, - "StreamsEventTypeViewForNdsGroup" : { - "type" : "string", - "description" : "Unique identifier of event type.", - "enum" : [ "MAX_PROCESSOR_COUNT_REACHED" ], - "example" : "MAX_PROCESSOR_COUNT_REACHED", - "title" : "Streams Event Types" + } }, - "StreamsEventViewForNdsGroup" : { + "ServiceAccountOrgEvents" : { "type" : "object", - "description" : "Streams event identifies different activities about Atlas Streams.", + "description" : "Service Account event identifies different activities around user api keys.", "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, "created" : { "type" : "string", "format" : "date-time", @@ -49503,7 +52741,7 @@ "readOnly" : true }, "eventTypeName" : { - "$ref" : "#/components/schemas/StreamsEventTypeViewForNdsGroup" + "$ref" : "#/components/schemas/ServiceAccountEventTypeViewForOrg" }, "groupId" : { "type" : "string", @@ -49523,10 +52761,10 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "instanceName" : { - "type" : "string", - "description" : "Name of the stream processing instance associated with the event.", - "example" : "foobar", + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", "readOnly" : true }, "links" : { @@ -49550,387 +52788,217 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, "raw" : { "$ref" : "#/components/schemas/raw" - } - }, - "required" : [ "created", "eventTypeName", "id" ], - "title" : "Streams Events" - }, - "StreamsKafkaAuthentication" : { - "type" : "object", - "description" : "User credentials required to connect to a Kafka Cluster. Includes the authentication type, as well as the parameters for that authentication mode.", - "properties" : { - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true }, - "mechanism" : { + "remoteAddress" : { "type" : "string", - "description" : "Style of authentication. Can be one of PLAIN, SCRAM-256, or SCRAM-512." + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true }, - "password" : { + "userId" : { "type" : "string", - "format" : "password", - "description" : "Password of the account to connect to the Kafka cluster.", - "writeOnly" : true + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, "username" : { "type" : "string", - "description" : "Username of the account to connect to the Kafka cluster." - } - } - }, - "StreamsKafkaConnection" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/StreamsConnection" - }, { - "type" : "object", - "properties" : { - "authentication" : { - "$ref" : "#/components/schemas/StreamsKafkaAuthentication" - }, - "bootstrapServers" : { - "type" : "string", - "description" : "Comma separated list of server addresses." - }, - "config" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "description" : "A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.", - "example" : "{\"group.protocol.type\":\"consumer\",\"debug\":\"queue, msg, protocol\"}" - }, - "description" : "A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.", - "example" : { - "debug" : "queue, msg, protocol", - "group.protocol.type" : "consumer" - } - }, - "networking" : { - "$ref" : "#/components/schemas/StreamsKafkaNetworking" - }, - "proxyInfo" : { - "$ref" : "#/components/schemas/ProxyInfo" - }, - "security" : { - "$ref" : "#/components/schemas/StreamsKafkaSecurity" - } - } - } ] - }, - "StreamsKafkaNetworking" : { - "type" : "object", - "description" : "Networking Access Type can either be 'PUBLIC' (default) or VPC. VPC type is in public preview, please file a support ticket to enable VPC Network Access", - "properties" : { - "access" : { - "$ref" : "#/components/schemas/StreamsKafkaNetworkingAccess" - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true } - } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "ServiceAccount Events" }, - "StreamsKafkaNetworkingAccess" : { + "ServiceAccountSecret" : { "type" : "object", - "description" : "Information about the networking access.", "properties" : { - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "The date that the secret was created on.", "readOnly" : true }, - "name" : { + "expiresAt" : { "type" : "string", - "description" : "Id of the vpc peer when the type is VPC." + "format" : "date-time", + "description" : "The date for the expiration of the secret.", + "readOnly" : true }, - "type" : { + "id" : { "type" : "string", - "description" : "Selected networking type. Either PUBLIC or VPC. Defaults to PUBLIC", - "enum" : [ "PUBLIC", "VPC" ], - "title" : "Networking Access Type" - } - } - }, - "StreamsKafkaSecurity" : { - "type" : "object", - "description" : "Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use.", - "properties" : { - "brokerPublicCertificate" : { + "description" : "Unique 24-hexadecimal digit string that identifies the secret.", + "example" : "32b6e34b3d91647abb20e7b8", + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastUsedAt" : { "type" : "string", - "description" : "A trusted, public x509 certificate for connecting to Kafka over SSL." + "format" : "date-time", + "description" : "The last time the secret was used.", + "readOnly" : true }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, + "maskedSecretValue" : { + "type" : "string", + "description" : "The masked Service Account secret.", + "example" : "mdb_ic_sk_...12ce", "readOnly" : true }, - "protocol" : { + "secret" : { "type" : "string", - "description" : "Describes the transport type. Can be either PLAINTEXT or SSL." + "description" : "The secret for the Service Account. It will be returned only the first time after creation.", + "pattern" : "^mdb_sa_sk_[0-9a-zA-Z_-]{40}$", + "readOnly" : true } - } + }, + "required" : [ "createdAt", "expiresAt", "id" ] }, - "StreamsMatcher" : { + "ServiceAccountSecretRequest" : { "type" : "object", - "description" : "Rules to apply when comparing a stream processing instance or stream processor against this alert configuration.", "properties" : { - "fieldName" : { - "$ref" : "#/components/schemas/StreamsMatcherField" - }, - "operator" : { + "secretExpiresAfterHours" : { + "type" : "integer", + "format" : "int32", + "description" : "The expiration time of the new Service Account secret. The expiration is provided in hours." + } + }, + "required" : [ "secretExpiresAfterHours" ] + }, + "ShardEntry" : { + "type" : "object", + "description" : "Sharding configuration for a collection to be sharded on the destination cluster.", + "properties" : { + "collection" : { "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" ] + "description" : "Human-readable label that identifies the collection to be sharded on the destination cluster.", + "writeOnly" : true }, - "value" : { + "database" : { "type" : "string", - "description" : "Value to match or exceed using the specified **matchers.operator**.", - "example" : "event-replica-set" + "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" } }, - "required" : [ "fieldName", "operator", "value" ], - "title" : "Matchers" - }, - "StreamsMatcherField" : { - "type" : "string", - "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", - "enum" : [ "INSTANCE_NAME", "PROCESSOR_NAME" ], - "example" : "INSTANCE_NAME", - "title" : "Streams Matcher Fields" + "required" : [ "collection", "database", "shardCollection" ] }, - "StreamsOptions" : { + "ShardKeys" : { "type" : "object", - "description" : "Optional configuration for the stream processor.", + "description" : "Document that configures the shard key on the destination cluster.", "properties" : { - "dlq" : { - "$ref" : "#/components/schemas/StreamsDLQ" - }, - "links" : { + "key" : { "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, + "description" : "List of fields to use for the shard key.", "items" : { - "$ref" : "#/components/schemas/Link" + "type" : "object", + "additionalProperties" : { + "type" : "object" + } }, - "readOnly" : true + "uniqueItems" : true, + "writeOnly" : true } - } + }, + "writeOnly" : true }, - "StreamsProcessor" : { + "ShardingRequest" : { "type" : "object", - "description" : "An atlas stream processor.", + "description" : "Document that configures sharding on the destination cluster when migrating from a replica set source to a sharded cluster destination on MongoDB 6.0 or higher. If you don't wish to shard any collections on the destination cluster, leave this empty.", "properties" : { - "_id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the stream processor.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "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 }, - "links" : { + "shardingEntries" : { "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, + "description" : "List of shard configurations to shard destination collections. Atlas shards only those collections that you include in the sharding entries array.", "items" : { - "$ref" : "#/components/schemas/Link" + "$ref" : "#/components/schemas/ShardEntry" }, - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "Human-readable name of the stream processor." - }, - "options" : { - "$ref" : "#/components/schemas/StreamsOptions" - }, - "pipeline" : { - "type" : "array", - "description" : "Stream aggregation pipeline you want to apply to your streaming data.", - "items" : { - "$ref" : "#/components/schemas/Document" - } + "uniqueItems" : true, + "writeOnly" : true } - } + }, + "required" : [ "createSupportingIndexes" ], + "writeOnly" : true }, - "StreamsProcessorWithStats" : { + "Slack" : { "type" : "object", - "description" : "An atlas stream processor with optional stats.", + "description" : "Details to integrate one Slack account with one MongoDB Cloud project.", "properties" : { - "_id" : { + "apiToken" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the stream processor.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true + "description" : "Key that allows MongoDB Cloud to access your Slack account.\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.\n\n**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" }, - "name" : { + "channelName" : { "type" : "string", - "description" : "Human-readable name of the stream processor.", - "readOnly" : true + "description" : "Name of the Slack channel to which MongoDB Cloud sends alert notifications.", + "example" : "alerts", + "maxLength" : 80, + "minLength" : 1, + "nullable" : true }, - "pipeline" : { - "type" : "array", - "description" : "Stream aggregation pipeline you want to apply to your streaming data.", - "items" : { - "$ref" : "#/components/schemas/Document" - }, - "readOnly" : true + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true }, - "state" : { + "teamName" : { "type" : "string", - "description" : "The state of the stream processor.", - "readOnly" : true + "description" : "Human-readable label that identifies your Slack team. Set this parameter when you configure a legacy Slack integration.", + "example" : "MongoDB" }, - "stats" : { - "type" : "object", - "additionalProperties" : { - "type" : "object", - "description" : "The stats associated with the stream processor.", - "readOnly" : true - }, - "description" : "The stats associated with the stream processor.", - "readOnly" : 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" : [ "SLACK" ] } }, - "required" : [ "_id", "name", "pipeline", "state" ] - }, - "StreamsSampleConnection" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/StreamsConnection" - } ] + "required" : [ "apiToken", "channelName" ], + "title" : "SLACK" }, - "StreamsTenant" : { + "SlackNotification" : { "type" : "object", + "description" : "Slack notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", "properties" : { - "_id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the project.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "connections" : { - "type" : "array", - "description" : "List of connections configured in the stream instance.", - "items" : { - "$ref" : "#/components/schemas/StreamsConnection" - }, - "readOnly" : true - }, - "dataProcessRegion" : { - "$ref" : "#/components/schemas/StreamsDataProcessRegion" - }, - "groupId" : { + "apiToken" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the project.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "hostnames" : { - "type" : "array", - "description" : "List that contains the hostnames assigned to the stream instance.", - "items" : { - "type" : "string", - "description" : "Unique hostname assigned to the stream instance.", - "readOnly" : true - }, - "readOnly" : true - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true + "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" }, - "name" : { + "channelName" : { "type" : "string", - "description" : "Human-readable label that identifies the stream instance." + "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" }, - "streamConfig" : { - "$ref" : "#/components/schemas/StreamConfig" - } - } - }, - "SummaryNotification" : { - "type" : "object", - "description" : "Summary notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", - "properties" : { "delayMin" : { "type" : "integer", "format" : "int32", "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." }, - "emailAddress" : { + "integrationId" : { "type" : "string", - "format" : "email", - "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:\n\n- specific MongoDB Cloud users (`\"notifications.[n].typeName\" : \"USER\"`)\n- MongoDB Cloud users with specific project roles (`\"notifications.[n].typeName\" : \"GROUP\"`)\n- MongoDB Cloud users with specific organization roles (`\"notifications.[n].typeName\" : \"ORG\"`)\n- MongoDB Cloud teams (`\"notifications.[n].typeName\" : \"TEAM\"`)\n\nTo send emails to one MongoDB Cloud user or grouping of users, set the **notifications.[n].emailEnabled** parameter." + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" }, "intervalMin" : { "type" : "integer", @@ -49946,68 +53014,74 @@ "typeName" : { "type" : "string", "description" : "Human-readable label that displays the alert notification type.", - "enum" : [ "SUMMARY" ] + "enum" : [ "SLACK" ] } }, "required" : [ "typeName" ], - "title" : "Summary Notification" + "title" : "Slack Notification" }, - "SynonymMappingStatusDetail" : { + "Source" : { "type" : "object", - "description" : "Contains the status of the index's synonym mappings on each search host. This field (and its subfields) only appear if the index has synonyms defined.", + "description" : "Document that describes the source of the migration.", "properties" : { - "message" : { + "caCertificatePath" : { "type" : "string", - "description" : "Optional message describing an error." + "description" : "Path to the CA certificate that signed SSL certificates use to authenticate to the source cluster." }, - "queryable" : { + "clusterName" : { + "type" : "string", + "description" : "Label that identifies the source cluster name." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the source project.", + "example" : "9b43a5b329223c3a1591a678", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "managedAuthentication" : { "type" : "boolean", - "description" : "Flag that indicates whether the synonym mapping is queryable on a host." + "description" : "Flag that indicates whether MongoDB Automation manages authentication to the source cluster. If true, do not provide values for username and password." }, - "status" : { + "password" : { "type" : "string", - "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", - "enum" : [ "FAILED", "BUILDING", "READY" ] + "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 } }, - "title" : "Synonym Mapping Status Detail" + "required" : [ "clusterName", "groupId", "managedAuthentication", "ssl" ] }, - "SynonymMappingStatusDetailMap" : { + "StorageEngine" : { "type" : "object", "additionalProperties" : { - "$ref" : "#/components/schemas/SynonymMappingStatusDetail" - }, - "x-additionalPropertiesName" : "Synonym Mapping Name" - }, - "SynonymSource" : { - "type" : "object", - "description" : "Data set that stores words and their applicable synonyms.", - "properties" : { - "collection" : { - "type" : "string", - "description" : "Label that identifies the MongoDB collection that stores words and their applicable synonyms." + "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/" } }, - "required" : [ "collection" ] + "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/" + } }, - "SystemStatus" : { + "StreamConfig" : { "type" : "object", + "description" : "Configuration options for an Atlas Stream Processing Instance.", + "nullable" : true, "properties" : { - "apiKey" : { - "$ref" : "#/components/schemas/ApiKey" - }, - "appName" : { - "type" : "string", - "description" : "Human-readable label that identifies the service from which you requested this response.", - "enum" : [ "MongoDB Atlas" ], - "readOnly" : true - }, - "build" : { - "type" : "string", - "description" : "Unique 40-hexadecimal digit hash that identifies the latest git commit merged for this application.", - "example" : "83be55e140f493c88e7f578aae96548dd881587b", - "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.", @@ -50020,43 +53094,44 @@ }, "readOnly" : true }, - "throttling" : { - "type" : "boolean", - "description" : "Flag that indicates whether someone enabled throttling on this service.", - "readOnly" : true - } - }, - "required" : [ "apiKey", "appName", "build", "throttling" ] - }, - "TargetOrg" : { - "type" : "object", - "properties" : { - "linkToken" : { + "tier" : { "type" : "string", - "description" : "Link token that contains all the information required to complete the link." - } - }, - "required" : [ "linkToken" ] - }, - "TargetOrgRequest" : { - "type" : "object", - "properties" : { - "accessListIps" : { - "type" : "array", - "description" : "IP address access list entries associated with the API key.", - "items" : { - "type" : "string", - "description" : "One IP address access list entry associated with the API key." - } + "description" : "Selected tier for the Stream Instance. Configures Memory / VCPU allowances.", + "enum" : [ "SP30", "SP10" ], + "title" : "Stream Instance Tier" } } }, - "Team" : { + "StreamProcessorAlertConfigViewForNdsGroup" : { "type" : "object", + "description" : "Host metric alert configuration allows to select which Atlas streams processors trigger alerts and how users are notified.", "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/StreamProcessorEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies this team.", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -50075,30 +53150,54 @@ }, "readOnly" : true }, - "name" : { - "type" : "string", - "description" : "Human-readable label that identifies the team." + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration.", + "items" : { + "$ref" : "#/components/schemas/StreamsMatcher" + } }, - "usernames" : { + "notifications" : { "type" : "array", - "description" : "List that contains the MongoDB Cloud users in this team.", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", "items" : { - "type" : "string", - "format" : "email", - "description" : "List that contains email addresses that identify MongoDB Cloud users to in this team." - }, - "uniqueItems" : true + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true } }, - "required" : [ "name" ] + "required" : [ "eventTypeName", "notifications" ], + "title" : "Stream Processor Alert Configuration" }, - "TeamEvent" : { + "StreamProcessorAlertViewForNdsGroup" : { "type" : "object", - "description" : "Team event identifies different activities around organization teams.", + "description" : "Stream Processor alert notifies about activities on Stream Processor in AtlasStreams.", "properties" : { - "apiKeyId" : { + "acknowledgedUntil" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "format" : "date-time", + "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.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -50108,15 +53207,15 @@ "created" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, "eventTypeName" : { - "$ref" : "#/components/schemas/TeamEventTypeView" + "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroupAlertable" }, "groupId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -50125,17 +53224,23 @@ }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "isGlobalAdmin" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "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.", + "example" : "foobar", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", "readOnly" : true }, "links" : { @@ -50152,86 +53257,72 @@ }, "orgId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "publicKey" : { + "processorErrorMsg" : { "type" : "string", - "format" : "email", - "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "example" : "test.user@mongodb.com", + "description" : "The error message associated with the Stream Processor to which this alert applies.", + "example" : "MongoServerError: Failed to start stream processor: (Location77175) Could not connect to the Kafka topic with kafka error code: -195, message: Local: Broker transport failure.: (Location77175)", "readOnly" : true }, - "raw" : { - "$ref" : "#/components/schemas/raw" + "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.", + "example" : "foobar", + "readOnly" : true }, - "remoteAddress" : { + "processorState" : { "type" : "string", - "description" : "IPv4 or IPv6 address from which the user triggered this event.", - "example" : "216.172.40.186", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "description" : "The state of the Stream Processor to which this alert applies. The resource returns this parameter for alerts of events impacting Stream Processors.", + "example" : "STARTED", "readOnly" : true }, - "teamId" : { + "resolved" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization team associated with this event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "format" : "date-time", + "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\"`.", "readOnly" : true }, - "userId" : { + "status" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", "readOnly" : true }, - "username" : { + "updated" : { "type" : "string", - "format" : "email", - "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", - "example" : "test.user@mongodb.com", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true } }, - "required" : [ "created", "eventTypeName", "id" ], - "title" : "Team Events" + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Stream Processor Alerts" }, - "TeamEventTypeView" : { + "StreamProcessorEventTypeViewAlertable" : { "type" : "string", - "description" : "Unique identifier of event type.", - "enum" : [ "TEAM_CREATED", "TEAM_DELETED", "TEAM_UPDATED", "TEAM_NAME_CHANGED", "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], - "example" : "TEAM_ADDED_TO_GROUP", - "title" : "Team Event Types" + "description" : "Event type that triggers an alert.", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "example" : "STREAM_PROCESSOR_STATE_IS_FAILED", + "title" : "Stream Processor Event Types" }, - "TeamEventTypeViewForNdsGroup" : { + "StreamProcessorEventTypeViewForNdsGroup" : { "type" : "string", "description" : "Unique identifier of event type.", - "enum" : [ "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], - "example" : "TEAM_ADDED_TO_GROUP", - "title" : "Team Event Types" + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "example" : "STREAM_PROCESSOR_STATE_IS_FAILED", + "title" : "Stream Processor Event Types" }, - "TeamEventViewForNdsGroup" : { + "StreamProcessorEventViewForNdsGroup" : { "type" : "object", - "description" : "Team event identifies different activities around organization teams.", + "description" : "Stream Processor event identifies different activities about a stream processor in Atlas Streams.", "properties" : { - "apiKeyId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, "created" : { "type" : "string", "format" : "date-time", @@ -50239,7 +53330,7 @@ "readOnly" : true }, "eventTypeName" : { - "$ref" : "#/components/schemas/TeamEventTypeViewForNdsGroup" + "$ref" : "#/components/schemas/StreamProcessorEventTypeViewForNdsGroup" }, "groupId" : { "type" : "string", @@ -50259,10 +53350,10 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "isGlobalAdmin" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "instanceName" : { + "type" : "string", + "description" : "Name of the stream processing instance associated with the event.", + "example" : "foobar", "readOnly" : true }, "links" : { @@ -50286,113 +53377,297 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "publicKey" : { + "processorErrorMsg" : { "type" : "string", - "format" : "email", - "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "example" : "test.user@mongodb.com", + "description" : "Error message linked to the stream processor associated with the event.", + "example" : "invalid auth", + "readOnly" : true + }, + "processorName" : { + "type" : "string", + "description" : "Name of the stream processor associated with the event.", + "example" : "foobar", + "readOnly" : true + }, + "processorState" : { + "type" : "string", + "description" : "State of the stream processor associated with the event.", + "example" : "FAILED", "readOnly" : true }, "raw" : { "$ref" : "#/components/schemas/raw" + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Stream Processor Events" + }, + "StreamsClusterConnection" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/StreamsConnection" + }, { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Name of the cluster configured for this connection." + }, + "dbRoleToExecute" : { + "$ref" : "#/components/schemas/DBRoleToExecute" + } + } + } ] + }, + "StreamsConnection" : { + "type" : "object", + "description" : "Settings that define a connection to an external data store.", + "discriminator" : { + "mapping" : { + "Cluster" : "#/components/schemas/StreamsClusterConnection", + "Kafka" : "#/components/schemas/StreamsKafkaConnection", + "Sample" : "#/components/schemas/StreamsSampleConnection" }, - "remoteAddress" : { + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/StreamsSampleConnection" + }, { + "$ref" : "#/components/schemas/StreamsClusterConnection" + }, { + "$ref" : "#/components/schemas/StreamsKafkaConnection" + } ], + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { "type" : "string", - "description" : "IPv4 or IPv6 address from which the user triggered this event.", - "example" : "216.172.40.186", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "description" : "Human-readable label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source." + }, + "type" : { + "type" : "string", + "description" : "Type of the connection. Can be either Cluster or Kafka.", + "enum" : [ "Kafka", "Cluster", "Sample" ] + } + }, + "readOnly" : true + }, + "StreamsDLQ" : { + "type" : "object", + "description" : "Dead letter queue for the stream processor.", + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/reference/glossary/#std-term-dead-letter-queue" + }, + "properties" : { + "coll" : { + "type" : "string", + "description" : "Name of the collection to use for the DLQ." + }, + "connectionName" : { + "type" : "string", + "description" : "Name of the connection to write DLQ messages to. Must be an Atlas connection." + }, + "db" : { + "type" : "string", + "description" : "Name of the database to use for the DLQ." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, "readOnly" : true + } + } + }, + "StreamsDataProcessRegion" : { + "type" : "object", + "description" : "Information about the cloud provider region in which MongoDB Cloud processes the stream.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Label that identifies the cloud service provider where MongoDB Cloud performs stream processing. Currently, this parameter supports AWS only.", + "enum" : [ "AWS", "GCP", "AZURE", "TENANT", "SERVERLESS" ] }, - "teamId" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "region" : { + "$ref" : "#/components/schemas/BaseStreamsRegion" + } + }, + "required" : [ "cloudProvider", "region" ] + }, + "StreamsEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "MAX_PROCESSOR_COUNT_REACHED" ], + "example" : "MAX_PROCESSOR_COUNT_REACHED", + "title" : "Streams Event Types" + }, + "StreamsEventViewForNdsGroup" : { + "type" : "object", + "description" : "Streams event identifies different activities about Atlas Streams.", + "properties" : { + "created" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization team associated with this event.", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/StreamsEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "userId" : { + "id" : { "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.", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "username" : { + "instanceName" : { "type" : "string", - "format" : "email", - "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", - "example" : "test.user@mongodb.com", + "description" : "Name of the stream processing instance associated with the event.", + "example" : "foobar", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" } }, "required" : [ "created", "eventTypeName", "id" ], - "title" : "Team Events" + "title" : "Streams Events" }, - "TeamNotification" : { + "StreamsKafkaAuthentication" : { "type" : "object", - "description" : "Team notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "description" : "User credentials required to connect to a Kafka Cluster. Includes the authentication type, as well as the parameters for that authentication mode.", "properties" : { - "delayMin" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." - }, - "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:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" - }, - "intervalMin" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", - "minimum" : 5 - }, - "notifierId" : { - "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:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true }, - "teamId" : { + "mechanism" : { "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", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" + "description" : "Style of authentication. Can be one of PLAIN, SCRAM-256, or SCRAM-512." }, - "teamName" : { + "password" : { "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" + "format" : "password", + "description" : "Password of the account to connect to the Kafka cluster.", + "writeOnly" : true }, - "typeName" : { + "username" : { "type" : "string", - "description" : "Human-readable label that displays the alert notification type.", - "enum" : [ "TEAM" ] + "description" : "Username of the account to connect to the Kafka cluster." } - }, - "required" : [ "typeName" ], - "title" : "Team Notification" + } }, - "TeamResponse" : { + "StreamsKafkaConnection" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/StreamsConnection" + }, { + "type" : "object", + "properties" : { + "authentication" : { + "$ref" : "#/components/schemas/StreamsKafkaAuthentication" + }, + "bootstrapServers" : { + "type" : "string", + "description" : "Comma separated list of server addresses." + }, + "config" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.", + "example" : "{\"group.protocol.type\":\"consumer\",\"debug\":\"queue, msg, protocol\"}" + }, + "description" : "A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.", + "example" : { + "debug" : "queue, msg, protocol", + "group.protocol.type" : "consumer" + } + }, + "networking" : { + "$ref" : "#/components/schemas/StreamsKafkaNetworking" + }, + "security" : { + "$ref" : "#/components/schemas/StreamsKafkaSecurity" + } + } + } ] + }, + "StreamsKafkaNetworking" : { "type" : "object", + "description" : "Networking Access Type can either be 'PUBLIC' (default) or VPC. VPC type is in public preview, please file a support ticket to enable VPC Network Access", "properties" : { - "id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies this team.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "access" : { + "$ref" : "#/components/schemas/StreamsKafkaNetworkingAccess" }, "links" : { "type" : "array", @@ -50405,16 +53680,21 @@ "$ref" : "#/components/schemas/Link" }, "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "Human-readable label that identifies the team." } } }, - "TeamRole" : { + "StreamsKafkaNetworkingAccess" : { "type" : "object", + "description" : "Information about the networking access.", "properties" : { + "connectionId" : { + "type" : "string", + "description" : "Reserved. Will be used by PRIVATE_LINK connection type.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, "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.", @@ -50427,28 +53707,26 @@ }, "readOnly" : true }, - "roleNames" : { - "type" : "array", - "description" : "One or more organization- or project-level roles to assign to the MongoDB Cloud user.", - "items" : { - "type" : "string", - "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] - }, - "uniqueItems" : true + "name" : { + "type" : "string", + "description" : "Reserved. Will be used by PRIVATE_LINK connection type." }, - "teamId" : { + "type" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the team.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" + "description" : "Selected networking type. Either PUBLIC, VPC or PRIVATE_LINK. Defaults to PUBLIC. For VPC, ensure that VPC peering exists and connectivity has been established between Atlas VPC and the VPC where Kafka cluster is hosted for the connection to function properly. PRIVATE_LINK support is coming soon.", + "enum" : [ "PUBLIC", "VPC", "PRIVATE_LINK" ], + "title" : "Networking Access Type" } } }, - "TeamUpdate" : { + "StreamsKafkaSecurity" : { "type" : "object", + "description" : "Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use.", "properties" : { + "brokerPublicCertificate" : { + "type" : "string", + "description" : "A trusted, public x509 certificate for connecting to Kafka over SSL." + }, "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.", @@ -50461,108 +53739,83 @@ }, "readOnly" : true }, - "name" : { - "type" : "string", - "description" : "Human-readable label that identifies the team.", - "writeOnly" : true - } - }, - "required" : [ "name" ] - }, - "TenantHardwareSpec" : { - "type" : "object", - "properties" : { - "instanceSize" : { + "protocol" : { "type" : "string", - "description" : "Hardware specification for the instances in this M0/M2/M5 tier cluster.", - "enum" : [ "M0", "M2", "M5" ], - "title" : "Tenant Instance Sizes" + "description" : "Describes the transport type. Can be either PLAINTEXT or SSL." } } }, - "TenantHardwareSpec20240805" : { + "StreamsMatcher" : { "type" : "object", + "description" : "Rules to apply when comparing a stream processing instance or stream processor against this alert configuration.", "properties" : { - "diskSizeGB" : { - "type" : "number", - "format" : "double", - "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", - "maximum" : 4096, - "minimum" : 10 + "fieldName" : { + "$ref" : "#/components/schemas/StreamsMatcherField" }, - "instanceSize" : { + "operator" : { "type" : "string", - "description" : "Hardware specification for the instances in this M0/M2/M5 tier cluster.", - "enum" : [ "M0", "M2", "M5" ], - "title" : "Tenant Instance Sizes" + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" } - } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" }, - "TenantRegionConfig" : { - "type" : "object", - "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`.", - "enum" : [ "AWS", "GCP", "AZURE" ] - } - } - } ], - "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", - "title" : "Tenant Regional Replication Specifications" + "StreamsMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "INSTANCE_NAME", "PROCESSOR_NAME" ], + "example" : "INSTANCE_NAME", + "title" : "Streams Matcher Fields" }, - "TenantRegionConfig20240805" : { + "StreamsOptions" : { "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/CloudRegionConfig20240805" - }, { - "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`.", - "enum" : [ "AWS", "GCP", "AZURE" ] - } + "description" : "Optional configuration for the stream processor.", + "properties" : { + "dlq" : { + "$ref" : "#/components/schemas/StreamsDLQ" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true } - } ], - "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", - "title" : "Tenant Regional Replication Specifications" + } }, - "TenantRestore" : { + "StreamsPrivateLinkConnection" : { "type" : "object", + "description" : "Container for metadata needed to create a Private Link connection.", "properties" : { - "clusterName" : { + "_id" : { "type" : "string", - "description" : "Human-readable label that identifies the source cluster.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "readOnly" : true + "description" : "The ID of the Private Link connection." }, - "deliveryType" : { + "dnsDomain" : { "type" : "string", - "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", - "enum" : [ "RESTORE", "DOWNLOAD" ], - "readOnly" : true + "description" : "Domain name of Confluent cluster." }, - "expirationDate" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "dnsSubDomain" : { + "type" : "array", + "description" : "Sub-Domain name of Confluent cluster. These are typically your availability zones.", + "items" : { + "type" : "string" + } }, - "id" : { + "interfaceEndpointId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "description" : "Interface endpoint ID that is created from the service endpoint ID provided." }, "links" : { "type" : "array", @@ -50576,354 +53829,451 @@ }, "readOnly" : true }, - "projectId" : { + "provider" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "description" : "Provider where the Kafka cluster is deployed." }, - "restoreFinishedDate" : { + "region" : { "type" : "string", - "format" : "date-time", - "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.", - "readOnly" : true + "description" : "Domain name of Confluent cluster." }, - "restoreScheduledDate" : { + "serviceEndpointId" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "description" : "AWS Service Endpoint ID." }, - "snapshotFinishedDate" : { + "state" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "description" : "State the connection is in." }, - "snapshotId" : { + "vendor" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "description" : "Vendor who manages the Kafka cluster." + } + } + }, + "StreamsProcessor" : { + "type" : "object", + "description" : "An atlas stream processor.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the stream processor.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" - }, - "snapshotUrl" : { - "type" : "string", - "description" : "Internet address from which you can download the compressed snapshot files. The resource returns this parameter when `\"deliveryType\" : \"DOWNLOAD\"`.", + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "status" : { - "type" : "string", - "description" : "Phase of the restore workflow for this job at the time this resource made this request.", - "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, "readOnly" : true }, - "targetDeploymentItemName" : { + "name" : { "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.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + "description" : "Human-readable name of the stream processor." }, - "targetProjectId" : { - "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", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" + "options" : { + "$ref" : "#/components/schemas/StreamsOptions" + }, + "pipeline" : { + "type" : "array", + "description" : "Stream aggregation pipeline you want to apply to your streaming data.", + "externalDocs" : { + "description" : "Supported Aggregation Pipeline Stages", + "url" : "https://www.mongodb.com/docs/atlas/atlas-stream-processing/stream-aggregation/#std-label-stream-aggregation" + }, + "items" : { + "$ref" : "#/components/schemas/Document" + } } - }, - "required" : [ "snapshotId", "targetDeploymentItemName" ] + } }, - "TextSearchHostStatusDetail" : { + "StreamsProcessorWithStats" : { "type" : "object", + "description" : "An atlas stream processor with optional stats.", "properties" : { - "hostname" : { + "_id" : { "type" : "string", - "description" : "Hostname that corresponds to the status detail." + "description" : "Unique 24-hexadecimal character string that identifies the stream processor.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "mainIndex" : { - "$ref" : "#/components/schemas/TextSearchIndexStatusDetail" + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true }, - "queryable" : { - "type" : "boolean", - "description" : "Flag that indicates whether the index is queryable on the host." + "name" : { + "type" : "string", + "description" : "Human-readable name of the stream processor.", + "readOnly" : true }, - "stagedIndex" : { - "$ref" : "#/components/schemas/TextSearchIndexStatusDetail" + "options" : { + "$ref" : "#/components/schemas/StreamsOptions" }, - "status" : { + "pipeline" : { + "type" : "array", + "description" : "Stream aggregation pipeline you want to apply to your streaming data.", + "items" : { + "$ref" : "#/components/schemas/Document" + }, + "readOnly" : true + }, + "state" : { "type" : "string", - "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", - "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + "description" : "The state of the stream processor. Commonly occurring states are 'CREATED', 'STARTED', 'STOPPED' and 'FAILED'.", + "readOnly" : true + }, + "stats" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "The stats associated with the stream processor.", + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor" + }, + "readOnly" : true + }, + "description" : "The stats associated with the stream processor.", + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor" + }, + "readOnly" : true } }, - "title" : "Text Search Host Status Detail" + "required" : [ "_id", "name", "pipeline", "state" ] }, - "TextSearchIndexCreateRequest" : { + "StreamsSampleConnection" : { "type" : "object", "allOf" : [ { - "$ref" : "#/components/schemas/SearchIndexCreateRequest" - }, { - "type" : "object", - "properties" : { - "definition" : { - "$ref" : "#/components/schemas/TextSearchIndexDefinition" - } + "$ref" : "#/components/schemas/StreamsConnection" + } ] + }, + "StreamsSampleConnections" : { + "type" : "object", + "description" : "Sample connections to add to SPI.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "solar" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to add a 'sample_stream_solar' connection." } - } ], - "description" : "Text Search Index Create Request", - "required" : [ "collectionName", "database", "definition", "name" ] + } }, - "TextSearchIndexDefinition" : { + "StreamsTenant" : { "type" : "object", - "description" : "The text search index definition set by the user.", "properties" : { - "analyzer" : { + "_id" : { "type" : "string", - "default" : "lucene.standard", - "description" : "Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves making the following changes to the text in fields:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\n MongoDB Cloud uses the process you select to build the Atlas Search index.", - "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ], - "externalDocs" : { - "description" : "Atlas Search Analyzers", - "url" : "https://dochub.mongodb.org/core/analyzers--fts" - } + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "analyzers" : { + "connections" : { "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" - }, + "description" : "List of connections configured in the stream instance.", "items" : { - "$ref" : "#/components/schemas/AtlasSearchAnalyzer" - } + "$ref" : "#/components/schemas/StreamsConnection" + }, + "readOnly" : true }, - "mappings" : { - "$ref" : "#/components/schemas/SearchMappings" + "dataProcessRegion" : { + "$ref" : "#/components/schemas/StreamsDataProcessRegion" }, - "searchAnalyzer" : { + "groupId" : { "type" : "string", - "default" : "lucene.standard", - "description" : "Method applied to identify words when searching this index.", - "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "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 Stored Source Fields.", - "example" : { - "include | exclude" : [ "field1", "field2" ] + "hostnames" : { + "type" : "array", + "description" : "List that contains the hostnames assigned to the stream instance.", + "items" : { + "type" : "string", + "description" : "Unique hostname assigned to the stream instance.", + "readOnly" : true }, - "externalDocs" : { - "description" : "Stored Source Fields", - "url" : "https://dochub.mongodb.org/core/atlas-search-stored-source" - } + "readOnly" : true }, - "synonyms" : { + "links" : { "type" : "array", - "description" : "Rule sets that map words to their synonyms in this index.", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", "externalDocs" : { - "description" : "Synonym Mapping", - "url" : "https://dochub.mongodb.org/core/fts-synonym-mappings" + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" }, "items" : { - "$ref" : "#/components/schemas/SearchSynonymMappingDefinition" - } - } - }, - "required" : [ "mappings" ], - "title" : "Text Search Index Definition" - }, - "TextSearchIndexResponse" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/SearchIndexResponse" - }, { - "type" : "object", - "properties" : { - "latestDefinition" : { - "$ref" : "#/components/schemas/TextSearchIndexDefinition" - }, - "statusDetail" : { - "type" : "array", - "description" : "List of documents detailing index status on each host.", - "items" : { - "$ref" : "#/components/schemas/TextSearchHostStatusDetail" - } - }, - "synonymMappingStatus" : { - "type" : "string", - "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", - "enum" : [ "FAILED", "BUILDING", "READY" ] - }, - "synonymMappingStatusDetail" : { - "type" : "array", - "description" : "A list of documents describing the status of the index's synonym mappings on each search host. Only appears if the index has synonyms defined.", - "items" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/SynonymMappingStatusDetail" - } - } - } + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the stream instance." + }, + "sampleConnections" : { + "$ref" : "#/components/schemas/StreamsSampleConnections" + }, + "streamConfig" : { + "$ref" : "#/components/schemas/StreamConfig" } - } ], - "title" : "Text Search Index Response" + } }, - "TextSearchIndexStatusDetail" : { + "SummaryNotification" : { "type" : "object", - "description" : "Contains status information about a text search index.", + "description" : "Summary notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", "properties" : { - "definition" : { - "$ref" : "#/components/schemas/TextSearchIndexDefinition" + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." }, - "definitionVersion" : { - "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + "emailAddress" : { + "type" : "string", + "format" : "email", + "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:\n\n- specific MongoDB Cloud users (`\"notifications.[n].typeName\" : \"USER\"`)\n- MongoDB Cloud users with specific project roles (`\"notifications.[n].typeName\" : \"GROUP\"`)\n- MongoDB Cloud users with specific organization roles (`\"notifications.[n].typeName\" : \"ORG\"`)\n- MongoDB Cloud teams (`\"notifications.[n].typeName\" : \"TEAM\"`)\n\nTo send emails to one MongoDB Cloud user or grouping of users, set the **notifications.[n].emailEnabled** parameter." + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "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" ] + } + }, + "required" : [ "typeName" ], + "title" : "Summary Notification" + }, + "SynonymMappingStatusDetail" : { + "type" : "object", + "description" : "Contains the status of the index's synonym mappings on each search host. This field (and its subfields) only appear if the index has synonyms defined.", + "properties" : { "message" : { "type" : "string", "description" : "Optional message describing an error." }, "queryable" : { "type" : "boolean", - "description" : "Flag that indicates whether the index generation is queryable on the host." + "description" : "Flag that indicates whether the synonym mapping is queryable on a host." }, "status" : { - "type" : "string", - "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", - "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] - }, - "synonymMappingStatus" : { "type" : "string", "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", "enum" : [ "FAILED", "BUILDING", "READY" ] - }, - "synonymMappingStatusDetail" : { - "type" : "array", - "description" : "List of synonym statuses by mapping.", - "items" : { - "$ref" : "#/components/schemas/SynonymMappingStatusDetailMap" - } } }, - "title" : "Text Search Index Status Detail" + "title" : "Synonym Mapping Status Detail" }, - "ThirdPartyIntegration" : { + "SynonymMappingStatusDetailMap" : { "type" : "object", - "description" : "Collection of settings that describe third-party integrations.", - "discriminator" : { - "mapping" : { - "DATADOG" : "#/components/schemas/Datadog", - "MICROSOFT_TEAMS" : "#/components/schemas/MicrosoftTeams", - "NEW_RELIC" : "#/components/schemas/NewRelic", - "OPS_GENIE" : "#/components/schemas/OpsGenie", - "PAGER_DUTY" : "#/components/schemas/PagerDuty", - "PROMETHEUS" : "#/components/schemas/Prometheus", - "SLACK" : "#/components/schemas/Slack", - "VICTOR_OPS" : "#/components/schemas/VictorOps", - "WEBHOOK" : "#/components/schemas/Webhook" - }, - "propertyName" : "type" + "additionalProperties" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetail" }, + "x-additionalPropertiesName" : "Synonym Mapping Name" + }, + "SynonymSource" : { + "type" : "object", + "description" : "Data set that stores words and their applicable synonyms.", "properties" : { - "id" : { - "type" : "string", - "description" : "Integration id.", - "nullable" : true - }, - "type" : { + "collection" : { "type" : "string", - "description" : "Integration type", - "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], - "title" : "Integration Type" + "description" : "Label that identifies the MongoDB collection that stores words and their applicable synonyms." } }, - "title" : "Third-Party Integration" + "required" : [ "collection" ] }, - "TimeMetricAlertView" : { + "SystemStatus" : { "type" : "object", "properties" : { - "acknowledgedUntil" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + "apiKey" : { + "$ref" : "#/components/schemas/ApiKey" }, - "acknowledgementComment" : { + "appName" : { "type" : "string", - "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", - "example" : "Expiration on 3/19. Silencing for 7days.", - "maxLength" : 200 + "description" : "Human-readable label that identifies the service from which you requested this response.", + "enum" : [ "MongoDB Atlas" ], + "readOnly" : true }, - "acknowledgingUsername" : { + "build" : { "type" : "string", - "format" : "email", - "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "description" : "Unique 40-hexadecimal digit hash that identifies the latest git commit merged for this application.", + "example" : "83be55e140f493c88e7f578aae96548dd881587b", "readOnly" : true }, - "alertConfigId" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "throttling" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled throttling on this service.", + "readOnly" : true + } + }, + "required" : [ "apiKey", "appName", "build", "throttling" ] + }, + "TargetOrg" : { + "type" : "object", + "properties" : { + "linkToken" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "description" : "Link token that contains all the information required to complete the link." + } + }, + "required" : [ "linkToken" ] + }, + "TargetOrgRequest" : { + "type" : "object", + "properties" : { + "accessListIps" : { + "type" : "array", + "description" : "IP address access list entries associated with the API key.", + "items" : { + "type" : "string", + "description" : "One IP address access list entry associated with the API key." + } + } + } + }, + "Team" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this team.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "clusterName" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { "type" : "string", - "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", - "example" : "cluster1", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "description" : "Human-readable label that identifies the team." + }, + "usernames" : { + "type" : "array", + "description" : "List that contains the MongoDB Cloud users in this team.", + "items" : { + "type" : "string", + "format" : "email", + "description" : "List that contains email addresses that identify MongoDB Cloud users to in this team." + }, + "uniqueItems" : true + } + }, + "required" : [ "name" ] + }, + "TeamEvent" : { + "type" : "object", + "description" : "Team event identifies different activities around organization teams.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, "created" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "currentValue" : { - "$ref" : "#/components/schemas/TimeMetricValueView" - }, "eventTypeName" : { - "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + "$ref" : "#/components/schemas/TeamEventTypeView" }, "groupId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "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.", - "example" : "cloud-test.mongodb.com:27017", - "readOnly" : true - }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "lastNotified" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", "readOnly" : true }, "links" : { @@ -50938,51 +54288,78 @@ }, "readOnly" : true }, - "metricName" : { - "type" : "string", - "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", - "example" : "ASSERT_USER", - "readOnly" : true - }, "orgId" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "replicaSetName" : { + "publicKey" : { "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.", - "example" : "event-replica-set", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true }, - "resolved" : { + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { "type" : "string", - "format" : "date-time", - "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\"`.", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", "readOnly" : true }, - "status" : { + "teamId" : { "type" : "string", - "description" : "State of this alert at the time you requested its details.", - "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], - "example" : "OPEN", + "description" : "Unique 24-hexadecimal digit string that identifies the organization team associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "updated" : { + "userId" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true } }, - "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Team Events" }, - "TimeMetricEventView" : { + "TeamEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TEAM_CREATED", "TEAM_DELETED", "TEAM_UPDATED", "TEAM_NAME_CHANGED", "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "example" : "TEAM_ADDED_TO_GROUP", + "title" : "Team Event Types" + }, + "TeamEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "example" : "TEAM_ADDED_TO_GROUP", + "title" : "Team Event Types" + }, + "TeamEventViewForNdsGroup" : { "type" : "object", + "description" : "Team event identifies different activities around organization teams.", "properties" : { "apiKeyId" : { "type" : "string", @@ -50999,11 +54376,8 @@ "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "currentValue" : { - "$ref" : "#/components/schemas/TimeMetricValueView" - }, "eventTypeName" : { - "$ref" : "#/components/schemas/HostMetricEventTypeView" + "$ref" : "#/components/schemas/TeamEventTypeViewForNdsGroup" }, "groupId" : { "type" : "string", @@ -51041,11 +54415,6 @@ }, "readOnly" : true }, - "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" : { "type" : "string", "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", @@ -51055,13 +54424,6 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "port" : { - "type" : "integer", - "format" : "int32", - "description" : "IANA port on which the MongoDB process listens for requests.", - "example" : 27017, - "readOnly" : true - }, "publicKey" : { "type" : "string", "format" : "email", @@ -51079,16 +54441,13 @@ "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", "readOnly" : true }, - "replicaSetName" : { - "type" : "string", - "description" : "Human-readable label of the replica set associated with the event.", - "example" : "event-replica-set", - "readOnly" : true - }, - "shardName" : { + "teamId" : { "type" : "string", - "description" : "Human-readable label of the shard associated with the event.", - "example" : "event-sh-01", + "description" : "Unique 24-hexadecimal digit string that identifies the organization team associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, "userId" : { @@ -51108,250 +54467,220 @@ "readOnly" : true } }, - "required" : [ "created", "eventTypeName", "id" ] + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Team Events" }, - "TimeMetricThresholdView" : { + "TeamNotification" : { "type" : "object", + "description" : "Team notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", "properties" : { - "metricName" : { - "type" : "string", - "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." }, - "mode" : { + "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:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { "type" : "string", - "description" : "MongoDB Cloud computes the current metric value as an average.", - "enum" : [ "AVERAGE" ] + "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" }, - "operator" : { - "$ref" : "#/components/schemas/Operator" + "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:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" }, - "threshold" : { - "type" : "number", - "format" : "double", - "description" : "Value of metric that, when exceeded, triggers an alert." + "teamId" : { + "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", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" }, - "units" : { - "$ref" : "#/components/schemas/TimeMetricUnits" - } - }, - "required" : [ "metricName" ] - }, - "TimeMetricUnits" : { - "type" : "string", - "default" : "HOURS", - "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", - "enum" : [ "NANOSECONDS", "MILLISECONDS", "MILLION_MINUTES", "SECONDS", "MINUTES", "HOURS", "DAYS" ], - "title" : "Time Metric Units" - }, - "TimeMetricValueView" : { - "type" : "object", - "description" : "Measurement of the **metricName** recorded at the time of the event.", - "properties" : { - "number" : { - "type" : "number", - "format" : "double", - "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", - "readOnly" : true + "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" }, - "units" : { - "$ref" : "#/components/schemas/TimeMetricUnits" - } - }, - "readOnly" : true, - "title" : "Time Metric Value" - }, - "TokenFilterEnglishPossessive" : { - "type" : "object", - "description" : "Filter that removes possessives (trailing 's) from words.", - "properties" : { - "type" : { + "typeName" : { "type" : "string", - "description" : "Human-readable label that identifies this token filter type.", - "enum" : [ "englishPossessive" ] + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "TEAM" ] } }, - "required" : [ "type" ], - "title" : "englishPossessive" + "required" : [ "typeName" ], + "title" : "Team Notification" }, - "TokenFilterFlattenGraph" : { + "TeamResponse" : { "type" : "object", - "description" : "Filter that transforms a token filter graph, such as the token filter graph that the wordDelimiterGraph token filter produces, into a flat form suitable for indexing.", "properties" : { - "type" : { + "id" : { "type" : "string", - "description" : "Human-readable label that identifies this token filter type.", - "enum" : [ "flattenGraph" ] + "description" : "Unique 24-hexadecimal digit string that identifies this team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the team." } - }, - "required" : [ "type" ], - "title" : "flattenGraph" + } }, - "TokenFilterPorterStemming" : { + "TeamRole" : { "type" : "object", - "description" : "Filter that uses the porter stemming algorithm to remove the common morphological and inflectional suffixes from words in English. It expects lowercase text and doesn't work as expected for uppercase text.", "properties" : { - "type" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "roleNames" : { + "type" : "array", + "description" : "One or more organization- or project-level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "teamId" : { "type" : "string", - "description" : "Human-readable label that identifies this token filter type.", - "enum" : [ "porterStemming" ] + "description" : "Unique 24-hexadecimal character string that identifies the team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" } - }, - "required" : [ "type" ], - "title" : "porterStemming" + } }, - "TokenFilterSpanishPluralStemming" : { + "TeamUpdate" : { "type" : "object", - "description" : "Filter that stems Spanish plural words. It expects lowercase text.", "properties" : { - "type" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { "type" : "string", - "description" : "Human-readable label that identifies this token filter type.", - "enum" : [ "spanishPluralStemming" ] + "description" : "Human-readable label that identifies the team.", + "writeOnly" : true } }, - "required" : [ "type" ], - "title" : "spanishPluralStemming" + "required" : [ "name" ] }, - "TokenFilterStempel" : { + "TenantHardwareSpec" : { "type" : "object", - "description" : "Filter that uses Lucene's default Polish stemmer table to stem words in the Polish language. It expects lowercase text.", - "externalDocs" : { - "description" : "Default Polish stemmer table", - "url" : "https://lucene.apache.org/core/9_2_0/analysis/stempel/org/apache/lucene/analysis/pl/PolishAnalyzer.html#DEFAULT_STEMMER_FILE" - }, "properties" : { - "type" : { + "instanceSize" : { "type" : "string", - "description" : "Human-readable label that identifies this token filter type.", - "enum" : [ "stempel" ] + "description" : "Hardware specification for the instances in this M0/M2/M5 tier cluster.", + "enum" : [ "M0", "M2", "M5" ], + "title" : "Tenant Instance Sizes" } - }, - "required" : [ "type" ], - "title" : "stempel" + } }, - "TokenFilterWordDelimiterGraph" : { + "TenantHardwareSpec20240805" : { "type" : "object", - "description" : "Filter that splits tokens into sub-tokens based on configured rules.", "properties" : { - "delimiterOptions" : { - "type" : "object", - "description" : "Object that contains the rules that determine how to split words into sub-words.", - "properties" : { - "concatenateAll" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether to concatenate runs." - }, - "concatenateNumbers" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether to concatenate runs of sub-numbers." - }, - "concatenateWords" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether to concatenate runs of sub-words." - }, - "generateNumberParts" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether to split tokens based on sub-numbers. For example, if `true`, this option splits `100-2` into `100` and `2`." - }, - "generateWordParts" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether to split tokens based on sub-words." - }, - "ignoreKeywords" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether to skip tokens with the `keyword` attribute set to `true`" - }, - "preserveOriginal" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether to generate tokens of the original words." - }, - "splitOnCaseChange" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether to split tokens based on letter-case transitions." - }, - "splitOnNumerics" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether to split tokens based on letter-number transitions." - }, - "stemEnglishPossessive" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether to remove trailing possessives from each sub-word." - } - } - }, - "protectedWords" : { - "type" : "object", - "description" : "Object that contains options for protected words.", - "properties" : { - "ignoreCase" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether to ignore letter case sensitivity for protected words." - }, - "words" : { - "type" : "array", - "description" : "List that contains the tokens to protect from delimination.", - "items" : { - "type" : "string" - } - } - }, - "required" : [ "words" ] + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 }, - "type" : { + "instanceSize" : { "type" : "string", - "description" : "Human-readable label that identifies this token filter type.", - "enum" : [ "wordDelimiterGraph" ] + "description" : "Hardware specification for the instances in this M0/M2/M5 tier cluster.", + "enum" : [ "M0", "M2", "M5" ], + "title" : "Tenant Instance Sizes" } - }, - "required" : [ "type" ], - "title" : "wordDelimiterGraph" + } }, - "TokenFilterkStemming" : { + "TenantRegionConfig" : { "type" : "object", - "description" : "Filter that combines algorithmic stemming with a built-in dictionary for the English language to stem words.", - "properties" : { - "type" : { - "type" : "string", - "description" : "Human-readable label that identifies this token filter type.", - "enum" : [ "kStemming" ] + "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`.", + "enum" : [ "AWS", "GCP", "AZURE" ] + } } - }, - "required" : [ "type" ], - "title" : "kStemming" + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Tenant Regional Replication Specifications" }, - "TriggerIngestionPipelineRequest" : { + "TenantRegionConfig20240805" : { "type" : "object", - "properties" : { - "datasetRetentionPolicy" : { - "$ref" : "#/components/schemas/DatasetRetentionPolicy" - }, - "snapshotId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "writeOnly" : true + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20240805" + }, { + "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`.", + "enum" : [ "AWS", "GCP", "AZURE" ] + } } - }, - "required" : [ "snapshotId" ] + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Tenant Regional Replication Specifications" }, - "USSBackupRestoreJob20250101" : { + "TenantRestore" : { "type" : "object", - "description" : "Details for one restore job of a USS instance.", "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the source cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "readOnly" : true + }, "deliveryType" : { "type" : "string", "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", @@ -51373,14 +54702,6 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "instanceName" : { - "type" : "string", - "description" : "Human-readable label that identifies the source instance.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "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.", @@ -51426,8 +54747,7 @@ "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "pattern" : "^([a-f0-9]{24})$" }, "snapshotUrl" : { "type" : "string", @@ -51442,176 +54762,311 @@ }, "targetDeploymentItemName" : { "type" : "string", - "description" : "Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another USS instance or Dedicated cluster tier.", + "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.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", - "readOnly" : true + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" }, "targetProjectId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the cluster to which you want to restore the snapshot.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "pattern" : "^([a-f0-9]{24})$" } }, - "title" : "USS Backup Restore Job" + "required" : [ "snapshotId", "targetDeploymentItemName" ] + }, + "TenantWithSampleConnections" : { + "type" : "object" }, - "USSBackupRestoreJobCreate20250101" : { + "TextSearchHostStatusDetail" : { "type" : "object", - "description" : "Details to create one restore job of a USS instance.", "properties" : { - "_snapshotId" : { + "hostname" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "writeOnly" : true + "description" : "Hostname that corresponds to the status detail." }, - "_targetDeploymentItemName" : { - "type" : "string", - "description" : "Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another USS instance or Dedicated cluster tier.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", - "writeOnly" : true + "mainIndex" : { + "$ref" : "#/components/schemas/TextSearchIndexStatusDetail" }, - "_targetProjectId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "writeOnly" : true + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on the host." }, - "deliveryType" : { - "type" : "string", - "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", - "enum" : [ "RESTORE", "DOWNLOAD" ], - "readOnly" : true + "stagedIndex" : { + "$ref" : "#/components/schemas/TextSearchIndexStatusDetail" }, - "expirationDate" : { + "status" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true - }, - "id" : { + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Text Search Host Status Detail" + }, + "TextSearchIndexCreateRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexCreateRequest" + }, { + "type" : "object", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + } + } + } ], + "description" : "Text Search Index Create Request", + "required" : [ "collectionName", "database", "definition", "name" ] + }, + "TextSearchIndexDefinition" : { + "type" : "object", + "description" : "The text search index definition set by the user.", + "properties" : { + "analyzer" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "default" : "lucene.standard", + "description" : "Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves making the following changes to the text in fields:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\n MongoDB Cloud uses the process you select to build the Atlas Search index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ], + "externalDocs" : { + "description" : "Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/analyzers--fts" + } }, - "instanceName" : { + "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" + }, + "items" : { + "$ref" : "#/components/schemas/AtlasSearchAnalyzer" + } + }, + "mappings" : { + "$ref" : "#/components/schemas/SearchMappings" + }, + "searchAnalyzer" : { "type" : "string", - "description" : "Human-readable label that identifies the source instance.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "readOnly" : true + "default" : "lucene.standard", + "description" : "Method applied to identify words when searching this index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] }, - "links" : { + "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 Stored Source Fields.", + "example" : { + "include | exclude" : [ "field1", "field2" ] + }, + "externalDocs" : { + "description" : "Stored Source Fields", + "url" : "https://dochub.mongodb.org/core/atlas-search-stored-source" + } + }, + "synonyms" : { "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.", + "description" : "Rule sets that map words to their synonyms in this index.", "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + "description" : "Synonym Mapping", + "url" : "https://dochub.mongodb.org/core/fts-synonym-mappings" }, "items" : { - "$ref" : "#/components/schemas/Link" + "$ref" : "#/components/schemas/SearchSynonymMappingDefinition" + } + } + }, + "required" : [ "mappings" ], + "title" : "Text Search Index Definition" + }, + "TextSearchIndexResponse" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexResponse" + }, { + "type" : "object", + "properties" : { + "latestDefinition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" }, - "readOnly" : true + "statusDetail" : { + "type" : "array", + "description" : "List of documents detailing index status on each host.", + "items" : { + "$ref" : "#/components/schemas/TextSearchHostStatusDetail" + } + }, + "synonymMappingStatus" : { + "type" : "string", + "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", + "enum" : [ "FAILED", "BUILDING", "READY" ] + }, + "synonymMappingStatusDetail" : { + "type" : "array", + "description" : "A list of documents describing the status of the index's synonym mappings on each search host. Only appears if the index has synonyms defined.", + "items" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetail" + } + } + } + } + } ], + "title" : "Text Search Index Response" + }, + "TextSearchIndexStatusDetail" : { + "type" : "object", + "description" : "Contains status information about a text search index.", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" }, - "projectId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" }, - "restoreFinishedDate" : { + "message" : { "type" : "string", - "format" : "date-time", - "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.", - "readOnly" : true + "description" : "Optional message describing an error." }, - "restoreScheduledDate" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index generation is queryable on the host." }, - "snapshotFinishedDate" : { + "status" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] }, - "snapshotUrl" : { + "synonymMappingStatus" : { "type" : "string", - "description" : "Internet address from which you can download the compressed snapshot files. The resource returns this parameter when `\"deliveryType\" : \"DOWNLOAD\"`.", - "readOnly" : true + "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", + "enum" : [ "FAILED", "BUILDING", "READY" ] }, - "status" : { - "type" : "string", - "description" : "Phase of the restore workflow for this job at the time this resource made this request.", - "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], - "readOnly" : true + "synonymMappingStatusDetail" : { + "type" : "array", + "description" : "List of synonym statuses by mapping.", + "items" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetailMap" + } } }, - "required" : [ "_snapshotId", "_targetDeploymentItemName" ], - "title" : "Create USS Backup Restore Job" + "title" : "Text Search Index Status Detail" }, - "USSBackupSettings20250101" : { + "ThirdPartyIntegration" : { "type" : "object", - "description" : "USS backup configuration", + "description" : "Collection of settings that describe third-party integrations.", + "discriminator" : { + "mapping" : { + "DATADOG" : "#/components/schemas/Datadog", + "MICROSOFT_TEAMS" : "#/components/schemas/MicrosoftTeams", + "NEW_RELIC" : "#/components/schemas/NewRelic", + "OPS_GENIE" : "#/components/schemas/OpsGenie", + "PAGER_DUTY" : "#/components/schemas/PagerDuty", + "PROMETHEUS" : "#/components/schemas/Prometheus", + "SLACK" : "#/components/schemas/Slack", + "VICTOR_OPS" : "#/components/schemas/VictorOps", + "WEBHOOK" : "#/components/schemas/Webhook" + }, + "propertyName" : "type" + }, "properties" : { - "enabled" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether backups are performed for this USS instance. Backup uses [TODO](TODO) for USS instances.", - "readOnly" : true + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "type" : { + "type" : "string", + "description" : "Integration type", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" } }, - "readOnly" : true, - "title" : "USS backup configuration" + "title" : "Third-Party Integration" }, - "USSBackupSnapshot20250101" : { + "TimeMetricAlertView" : { "type" : "object", - "description" : "Details for one snapshot of a USS instance.", "properties" : { - "expiration" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "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.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "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.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "readOnly" : true + }, + "created" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "finishTime" : { + "currentValue" : { + "$ref" : "#/components/schemas/TimeMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "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.", + "example" : "cloud-test.mongodb.com:27017", "readOnly" : true }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, "links" : { "type" : "array", "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", @@ -51624,116 +55079,76 @@ }, "readOnly" : true }, - "mongoDBVersion" : { + "metricName" : { "type" : "string", - "description" : "MongoDB host version that the snapshot runs.", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", "readOnly" : true }, - "scheduledTime" : { + "orgId" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud will take the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "startTime" : { + "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.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when MongoDB Cloud began taking the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "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\"`.", "readOnly" : true }, "status" : { "type" : "string", - "description" : "Phase of the workflow for this snapshot at the time this resource made this request.", - "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true } }, - "title" : "USS Backup Snapshot" + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] }, - "USSBackupSnapshotDownloadCreate20250101" : { + "TimeMetricEventView" : { "type" : "object", - "description" : "Details for one backup snapshot download of a USS instance.", "properties" : { - "_snapshotId" : { + "apiKeyId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to download.", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", - "writeOnly" : true - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - } - }, - "required" : [ "_snapshotId" ], - "title" : "USS Backup Snapshot Download Create" - }, - "USSConnectionStrings20250101" : { - "type" : "object", - "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", - "externalDocs" : { - "description" : "Connection string URI format.", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, - "properties" : { - "standard" : { - "type" : "string", - "description" : "Public connection string that you can use to connect to this cluster. This connection string uses the mongodb:// protocol.", - "externalDocs" : { - "description" : "Connection String URI Format", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, - "readOnly" : true - }, - "standardSrv" : { - "type" : "string", - "description" : "Public connection string that you can use to connect to this USS instance. This connection string uses the `mongodb+srv://` protocol.", - "externalDocs" : { - "description" : "Connection String URI Format", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, "readOnly" : true - } - }, - "readOnly" : true, - "title" : "USS Instance Connection Strings" - }, - "USSInstanceDescription20250101" : { - "type" : "object", - "description" : "Group of settings that configure a MongoDB USS instance.", - "properties" : { - "backupSettings" : { - "$ref" : "#/components/schemas/USSBackupSettings20250101" }, - "clusterType" : { + "created" : { "type" : "string", - "description" : "USS instance topology.", - "enum" : [ "REPLICASET", "LOADBALANCED" ], + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "connectionStrings" : { - "$ref" : "#/components/schemas/USSConnectionStrings20250101" + "currentValue" : { + "$ref" : "#/components/schemas/TimeMetricValueView" }, - "createDate" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created this instance. This parameter expresses its value in ISO 8601 format in UTC.", - "readOnly" : true + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" }, "groupId" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the project.", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -51742,13 +55157,19 @@ }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the instance.", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, "links" : { "type" : "array", "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", @@ -51761,167 +55182,314 @@ }, "readOnly" : true }, - "mongoDBVersion" : { + "metricName" : { "type" : "string", - "description" : "Version of MongoDB that the instance runs.", - "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", "readOnly" : true }, - "name" : { + "orgId" : { "type" : "string", - "description" : "Human-readable label that identifies the instance.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "providerSettings" : { - "$ref" : "#/components/schemas/USSProviderSettings20250101" + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true }, - "stateName" : { + "publicKey" : { "type" : "string", - "description" : "Human-readable label that indicates the current operating condition of this instance.", - "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true }, - "tags" : { - "type" : "array", - "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.", - "externalDocs" : { - "description" : "Resource Tags", - "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" - }, - "items" : { - "$ref" : "#/components/schemas/ResourceTag" - } + "raw" : { + "$ref" : "#/components/schemas/raw" }, - "terminationProtectionEnabled" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true }, - "versionReleaseSystem" : { + "replicaSetName" : { "type" : "string", - "default" : "LTS", - "description" : "Method by which the cluster maintains the MongoDB versions.", - "enum" : [ "LTS" ], + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true } }, - "required" : [ "providerSettings" ], - "title" : "USS Instance Description" + "required" : [ "created", "eventTypeName", "id" ] }, - "USSInstanceDescriptionCreate20250101" : { + "TimeMetricThresholdView" : { "type" : "object", - "description" : "Settings that you can specify when you create a USS instance.", "properties" : { - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." }, - "name" : { + "mode" : { "type" : "string", - "description" : "Human-readable label that identifies the instance.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "writeOnly" : true + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] }, - "providerSettings" : { - "$ref" : "#/components/schemas/USSProviderSettingsCreate20250101" + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, - "tags" : { - "type" : "array", - "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.", - "externalDocs" : { - "description" : "Resource Tags", - "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" - }, - "items" : { - "$ref" : "#/components/schemas/ResourceTag" - } + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." }, - "terminationProtectionEnabled" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" } }, - "required" : [ "name", "providerSettings" ], - "title" : "USS Instance Description Create" + "required" : [ "metricName" ] + }, + "TimeMetricUnits" : { + "type" : "string", + "default" : "HOURS", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "NANOSECONDS", "MILLISECONDS", "MILLION_MINUTES", "SECONDS", "MINUTES", "HOURS", "DAYS" ], + "title" : "Time Metric Units" }, - "USSProviderSettings20250101" : { + "TimeMetricValueView" : { "type" : "object", - "description" : "Group of cloud provider settings that configure the provisioned MongoDB USS instance.", + "description" : "Measurement of the **metricName** recorded at the time of the event.", "properties" : { - "backingProviderName" : { - "type" : "string", - "description" : "Cloud service provider on which MongoDB Cloud provisioned the USS instance.", - "enum" : [ "AWS", "AZURE", "GCP" ], - "readOnly" : true - }, - "diskSizeGB" : { + "number" : { "type" : "number", "format" : "double", - "description" : "Storage capacity available to the USS instance expressed in gigabytes.", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", "readOnly" : true }, - "providerName" : { + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "readOnly" : true, + "title" : "Time Metric Value" + }, + "TokenFilterEnglishPossessive" : { + "type" : "object", + "description" : "Filter that removes possessives (trailing 's) from words.", + "properties" : { + "type" : { "type" : "string", - "default" : "USS", - "description" : "Human-readable label that identifies the cloud service provider.", - "enum" : [ "USS" ], - "readOnly" : true - }, - "regionName" : { + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "englishPossessive" ] + } + }, + "required" : [ "type" ], + "title" : "englishPossessive" + }, + "TokenFilterFlattenGraph" : { + "type" : "object", + "description" : "Filter that transforms a token filter graph, such as the token filter graph that the wordDelimiterGraph token filter produces, into a flat form suitable for indexing.", + "properties" : { + "type" : { "type" : "string", - "description" : "Human-readable label that identifies the geographic location of your MongoDB USS 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/).", - "readOnly" : true + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "flattenGraph" ] } }, - "readOnly" : true, - "title" : "Cloud Service Provider Settings for a USS Instance" + "required" : [ "type" ], + "title" : "flattenGraph" }, - "USSProviderSettingsCreate20250101" : { + "TokenFilterPorterStemming" : { "type" : "object", - "description" : "Group of cloud provider settings that configure the provisioned MongoDB USS instance.", + "description" : "Filter that uses the porter stemming algorithm to remove the common morphological and inflectional suffixes from words in English. It expects lowercase text and doesn't work as expected for uppercase text.", "properties" : { - "backingProviderName" : { + "type" : { "type" : "string", - "description" : "Cloud service provider on which MongoDB Cloud provisioned the serverless instance.", - "enum" : [ "AWS", "AZURE", "GCP" ], - "writeOnly" : true + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "porterStemming" ] + } + }, + "required" : [ "type" ], + "title" : "porterStemming" + }, + "TokenFilterSpanishPluralStemming" : { + "type" : "object", + "description" : "Filter that stems Spanish plural words. It expects lowercase text.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "spanishPluralStemming" ] + } + }, + "required" : [ "type" ], + "title" : "spanishPluralStemming" + }, + "TokenFilterStempel" : { + "type" : "object", + "description" : "Filter that uses Lucene's default Polish stemmer table to stem words in the Polish language. It expects lowercase text.", + "externalDocs" : { + "description" : "Default Polish stemmer table", + "url" : "https://lucene.apache.org/core/9_2_0/analysis/stempel/org/apache/lucene/analysis/pl/PolishAnalyzer.html#DEFAULT_STEMMER_FILE" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "stempel" ] + } + }, + "required" : [ "type" ], + "title" : "stempel" + }, + "TokenFilterWordDelimiterGraph" : { + "type" : "object", + "description" : "Filter that splits tokens into sub-tokens based on configured rules.", + "properties" : { + "delimiterOptions" : { + "type" : "object", + "description" : "Object that contains the rules that determine how to split words into sub-words.", + "properties" : { + "concatenateAll" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to concatenate runs." + }, + "concatenateNumbers" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to concatenate runs of sub-numbers." + }, + "concatenateWords" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to concatenate runs of sub-words." + }, + "generateNumberParts" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on sub-numbers. For example, if `true`, this option splits `100-2` into `100` and `2`." + }, + "generateWordParts" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on sub-words." + }, + "ignoreKeywords" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to skip tokens with the `keyword` attribute set to `true`" + }, + "preserveOriginal" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to generate tokens of the original words." + }, + "splitOnCaseChange" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on letter-case transitions." + }, + "splitOnNumerics" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on letter-number transitions." + }, + "stemEnglishPossessive" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to remove trailing possessives from each sub-word." + } + } }, - "diskSizeGB" : { - "type" : "number", - "format" : "double", - "description" : "Storage capacity available to the USS instance expressed in gigabytes.", - "readOnly" : true + "protectedWords" : { + "type" : "object", + "description" : "Object that contains options for protected words.", + "properties" : { + "ignoreCase" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to ignore letter case sensitivity for protected words." + }, + "words" : { + "type" : "array", + "description" : "List that contains the tokens to protect from delimination.", + "items" : { + "type" : "string" + } + } + }, + "required" : [ "words" ] }, - "providerName" : { + "type" : { "type" : "string", - "default" : "USS", - "description" : "Human-readable label that identifies the cloud service provider.", - "enum" : [ "USS" ], - "readOnly" : true + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "wordDelimiterGraph" ] + } + }, + "required" : [ "type" ], + "title" : "wordDelimiterGraph" + }, + "TokenFilterkStemming" : { + "type" : "object", + "description" : "Filter that combines algorithmic stemming with a built-in dictionary for the English language to stem words.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "kStemming" ] + } + }, + "required" : [ "type" ], + "title" : "kStemming" + }, + "TriggerIngestionPipelineRequest" : { + "type" : "object", + "properties" : { + "datasetRetentionPolicy" : { + "$ref" : "#/components/schemas/DatasetRetentionPolicy" }, - "regionName" : { + "snapshotId" : { "type" : "string", - "description" : "Human-readable label that identifies the geographic location of your MongoDB USS 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/).", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "writeOnly" : true } }, - "required" : [ "backingProviderName", "regionName" ], - "title" : "Cloud Service Provider Settings for a USS Instance", - "writeOnly" : true + "required" : [ "snapshotId" ] }, "UpdateAtlasOrganizationApiKey" : { "type" : "object", @@ -52559,7 +56127,7 @@ "description" : "Human-readable label that identifies the cluster or MongoDB Atlas Data Lake that this database user can access.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, "type" : { "type" : "string", @@ -52615,6 +56183,32 @@ "required" : [ "match" ], "title" : "User to Distinguished Name Mapping" }, + "VPCPeeringActionChallenge" : { + "type" : "object", + "description" : "Container for elements used to challenge the user before taking certain actions on VPC Peering connections.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "requesterAccountId" : { + "type" : "string", + "description" : "The AWS requester account ID." + }, + "requesterVpcId" : { + "type" : "string", + "description" : "The AWS requester VPC ID." + } + } + }, "VectorSearchHostStatusDetail" : { "type" : "object", "properties" : { diff --git a/tools/cli/test/data/split/dev/openapi-v2-2025-01-01.yaml b/tools/cli/test/data/split/dev/openapi-v2-2025-01-01.yaml index 117c35b41a..5e1074c0e0 100644 --- a/tools/cli/test/data/split/dev/openapi-v2-2025-01-01.yaml +++ b/tools/cli/test/data/split/dev/openapi-v2-2025-01-01.yaml @@ -13,13 +13,15 @@ info: ``` To learn more, see [Get Started with the Atlas Administration API](https://www.mongodb.com/docs/atlas/configure-api-access/). For support, see [MongoDB Support](https://www.mongodb.com/support/get-started). + + You can also explore the various endpoints available through the Atlas Administration API in MongoDB's [Postman workspace](https://www.postman.com/mongodb-devrel/workspace/mongodb-atlas-administration-apis/). license: name: CC BY-NC-SA 3.0 US url: https://creativecommons.org/licenses/by-nc-sa/3.0/us/ termsOfService: https://www.mongodb.com/mongodb-management-service-terms-and-conditions title: MongoDB Atlas Administration API version: "2.0" - x-xgen-sha: 09d9d18db2111c955a8e01702a27ca2763417782 + x-xgen-sha: e6ba3136dbd0be2a81dd4ed21b9e6c470edd4420 servers: - url: https://cloud.mongodb.com tags: @@ -82,8 +84,12 @@ tags: \ resource requires your project ID. Changes to federated database instance configurations\ \ can affect costs." name: Data Federation -- description: "Returns, adds, edits, and removes Atlas Data Lake Pipelines and associated\ +- description: "Returns, edits, and removes Atlas Data Lake Pipelines and associated\ \ runs." + externalDocs: + description: Data Lake Pipelines are deprecated. Please see Data Lake Deprecation + Guide. + url: https://dochub.mongodb.org/core/data-lake-deprecation name: Data Lake Pipelines - description: "Returns, adds, edits, and removes database users." name: Database Users @@ -158,6 +164,8 @@ tags: - description: "You can continually push logs from mongod, mongos, and audit logs\ \ to an AWS S3 bucket. Atlas exports logs every 5 minutes." name: Push-Based Log Export +- description: Configure and manage Atlas Resource Policies within your organization. + name: Resource Policies - description: Creates one index to a database deployment in a rolling manner. You can't create a rolling index on an `M0` free cluster or `M2/M5` shared cluster. name: Rolling Index @@ -173,6 +181,13 @@ tags: description: Set Up a Private Endpoint for a Serverless Instance Tutorial url: https://dochub.mongodb.org/core/serverless-private-endpoint name: Serverless Private Endpoints +- description: Endpoints for managing Service Accounts and secrets. Service Accounts + are used for programmatic access to the Atlas Admin API through the OAuth 2.0 + Client Credentials flow. This feature is available as a Preview feature. + externalDocs: + description: Get Started with the Atlas Administration API + url: https://www.mongodb.com/docs/atlas/configure-api-access/ + name: Service Accounts - description: Returns and adds restore jobs for shared-tier database deployments. name: Shared-Tier Restore Jobs - description: Returns and requests to download shared-tier database deployment snapshots. @@ -2347,9 +2362,9 @@ paths: - AWS Clusters DNS /api/atlas/v2/groups/{groupId}/backup/exportBuckets: get: - description: "Returns all AWS S3 buckets and Azure Blob Storage Containers associated\ - \ with the specified Project. To use this resource, the requesting API Key\ - \ must have the Project Read Only role. Deprecated versions: v2-{2023-01-01}" + description: "Returns all Export Buckets associated with the specified Project.\ + \ To use this resource, the requesting API Key must have the Project Read\ + \ Only role. Deprecated versions: v2-{2023-01-01}" operationId: listExportBuckets parameters: - $ref: "#/components/parameters/envelope" @@ -2372,15 +2387,15 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Return All AWS S3 Buckets and Azure Blob Storage Containers Used for - Cloud Backup Snapshot Exports + summary: Return All Snapshot Export Buckets tags: - Cloud Backups post: - description: "Grants MongoDB Cloud access to the specified AWS S3 Bucket or\ - \ Azure Blob Storage Container. This enables this Export Bucket to receive\ - \ Atlas Cloud Backup Snapshots. To use this resource, the requesting API Key\ - \ must have the Project Owner role. Deprecated versions: v2-{2023-01-01}" + description: "Creates a Snapshot Export Bucket for an AWS S3 Bucket or Azure\ + \ Blob Storage Container. Once created, an snapshots can be exported to the\ + \ Export Bucket and its referenced AWS S3 Bucket or Azure Blob Storage Container.\ + \ To use this resource, the requesting API Key must have the Project Owner\ + \ role. Deprecated versions: v2-{2023-01-01}" operationId: createExportBucket parameters: - $ref: "#/components/parameters/envelope" @@ -2407,8 +2422,8 @@ paths: schema: $ref: "#/components/schemas/DiskBackupSnapshotExportBucket" x-xgen-version: 2024-05-30 - description: Grants MongoDB Cloud access to the specified AWS S3 Bucket or - Azure Blob Storage Container. + description: Specifies the role and AWS S3 Bucket or Azure Blob Storage Container + that the Export Bucket should reference. required: true responses: "200": @@ -2451,24 +2466,21 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Grant Access to AWS S3 Bucket or Azure Blob Storage Container for Cloud - Backup Snapshot Exports + summary: Create One Snapshot Export Bucket tags: - Cloud Backups /api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}: delete: - description: "Revoke MongoDB Cloud access to the specified AWS S3 Bucket or\ - \ Azure Blob Storage Container. This prevents this Export Bucket from receiving\ - \ Atlas Cloud Backup Snapshots. 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 API Key must have the Project Owner\ - \ role." + 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 API Key must have the Project\ + \ Owner role." operationId: deleteExportBucket parameters: - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/groupId" - - description: Unique string that identifies the AWS S3 Bucket or Azure Blob - Storage Container to which you export your Snapshots. + - description: Unique 24-hexadecimal character string that identifies the Export + Bucket. in: path name: exportBucketId required: true @@ -2496,14 +2508,13 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Revoke Access to AWS S3 Bucket or Azure Blob Storage Container for - Cloud Backup Snapshot Exports + summary: Delete One Snapshot Export Bucket tags: - Cloud Backups get: - description: "Returns one AWS S3 Bucket or Azure Blob Storage Container associated\ - \ with the specified Project. To use this resource, the requesting API Key\ - \ must have the Project Read Only role. Deprecated versions: v2-{2023-01-01}" + description: "Returns one Export Bucket associated with the specified Project.\ + \ To use this resource, the requesting API Key must have the Project Read\ + \ Only role. Deprecated versions: v2-{2023-01-01}" operationId: getExportBucket parameters: - $ref: "#/components/parameters/envelope" @@ -2558,8 +2569,7 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Return One AWS S3 Bucket or Azure Blob Storage Container Used for Cloud - Backup Snapshot Exports + summary: Return One Snapshot Export Bucket tags: - Cloud Backups /api/atlas/v2/groups/{groupId}/backupCompliancePolicy: @@ -2680,7 +2690,7 @@ paths: content: application/vnd.atlas.2023-01-01+json: schema: - $ref: "#/components/schemas/CloudProviderAccessRole" + $ref: "#/components/schemas/CloudProviderAccessRoleRequest" description: Creates one role for the specified cloud provider. required: true responses: @@ -2719,6 +2729,8 @@ paths: type: string enum: - AWS + - AZURE + - GCP - description: Unique 24-hexadecimal digit string that identifies the role. in: path name: roleId @@ -2785,7 +2797,8 @@ paths: description: "Grants access to the specified project for the specified access\ \ role. To use this resource, the requesting API Key must have the Project\ \ Owner role. This API endpoint is one step in a procedure to create unified\ - \ access for MongoDB Cloud services." + \ 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/ @@ -2807,7 +2820,7 @@ paths: content: application/vnd.atlas.2023-01-01+json: schema: - $ref: "#/components/schemas/CloudProviderAccessRole" + $ref: "#/components/schemas/CloudProviderAccessRoleRequestUpdate" description: Grants access to the specified project for the specified access role. required: true @@ -2889,130 +2902,72 @@ paths: examples: Cluster: description: Cluster - value: | - { - "clusterType": "SHARDED", - "links": [], - "name": "myCluster", - "replicationSpecs": [ - { - "regionConfigs": [ - { - "analyticsAutoScaling": { - "autoIndexing": { - "enabled": false - }, - "compute": { - "enabled": true, - "maxInstanceSize": "M40", - "minInstanceSize": "M30", - "scaleDownEnabled": true - }, - "diskGB": { - "enabled": true - } - }, - "analyticsSpecs": { - "instanceSize": "M30", - "nodeCount": 0, - "diskSizeGB": 10.0 - }, - "autoScaling": { - "autoIndexing": { - "enabled": false - }, - "compute": { - "enabled": true, - "maxInstanceSize": "M40", - "minInstanceSize": "M30", - "scaleDownEnabled": true - }, - "diskGB": { - "enabled": true - } - }, - "electableSpecs": { - "instanceSize": "M30", - "nodeCount": 3, - "diskSizeGB": 10.0 - }, - "hiddenSecondarySpecs": { - "instanceSize": "M30", - "nodeCount": 0, - "diskSizeGB": 10.0 - }, - "priority": 7, - "providerName": "AWS", - "readOnlySpecs": { - "instanceSize": "M30", - "nodeCount": 0, - "diskSizeGB": 10.0 - }, - "regionName": "US_EAST_1" - } - ], - "zoneName": "Zone 1" - }, - { - "regionConfigs": [ - { - "analyticsAutoScaling": { - "autoIndexing": { - "enabled": false - }, - "compute": { - "enabled": true, - "maxInstanceSize": "M20", - "minInstanceSize": "M10", - "scaleDownEnabled": true - }, - "diskGB": { - "enabled": true - } - }, - "analyticsSpecs": { - "instanceSize": "M10", - "nodeCount": 0, - "diskSizeGB": 10.0 - }, - "autoScaling": { - "autoIndexing": { - "enabled": false - }, - "compute": { - "enabled": true, - "maxInstanceSize": "M20", - "minInstanceSize": "M10", - "scaleDownEnabled": true - }, - "diskGB": { - "enabled": true - } - }, - "electableSpecs": { - "instanceSize": "M10", - "nodeCount": 3, - "diskSizeGB": 10.0 - }, - "hiddenSecondarySpecs": { - "instanceSize": "M10", - "nodeCount": 0, - "diskSizeGB": 10.0 - }, - "priority": 7, - "providerName": "AWS", - "readOnlySpecs": { - "instanceSize": "M10", - "nodeCount": 0, - "diskSizeGB": 10.0 - }, - "regionName": "US_EAST_1" - } - ], - "zoneName": "Zone 1" - }, - ] - } + value: + clusterType: SHARDED + name: myCluster + replicationSpecs: + - regionConfigs: + - analyticsAutoScaling: + autoIndexing: + enabled: false + compute: + enabled: false + diskGB: + enabled: true + analyticsSpecs: + diskSizeGB: 10.0 + instanceSize: M30 + nodeCount: 0 + autoScaling: + autoIndexing: + enabled: false + compute: + enabled: false + diskGB: + enabled: true + electableSpecs: + diskSizeGB: 10.0 + instanceSize: M30 + nodeCount: 3 + priority: 7 + providerName: AWS + readOnlySpecs: + diskSizeGB: 10.0 + instanceSize: M30 + nodeCount: 0 + regionName: US_EAST_1 + zoneName: Zone 1 + - regionConfigs: + - analyticsAutoScaling: + autoIndexing: + enabled: false + compute: + enabled: false + diskGB: + enabled: true + analyticsSpecs: + diskSizeGB: 10.0 + instanceSize: M10 + nodeCount: 0 + autoScaling: + autoIndexing: + enabled: false + compute: + enabled: false + diskGB: + enabled: true + electableSpecs: + diskSizeGB: 10.0 + instanceSize: M10 + nodeCount: 3 + priority: 7 + providerName: AWS + readOnlySpecs: + diskSizeGB: 10.0 + instanceSize: M10 + nodeCount: 0 + regionName: US_EAST_1 + zoneName: Zone 1 schema: $ref: "#/components/schemas/ClusterDescription20240805" x-xgen-version: 2024-08-05 @@ -3190,7 +3145,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster. in: query @@ -3238,7 +3193,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -3284,7 +3239,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2024-08-05+json: @@ -3318,7 +3273,7 @@ paths: - Clusters /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports: get: - description: "Returns all Cloud Backup snapshot export jobs associated with\ + description: "Returns all Cloud Backup Snapshot Export Jobs associated with\ \ the specified Atlas cluster. To use this resource, the requesting API Key\ \ must have the Project Atlas Admin role." operationId: listBackupExportJobs @@ -3337,7 +3292,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -3352,11 +3307,11 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Return All Cloud Backup Snapshot Export Jobs + summary: Return All Snapshot Export Jobs tags: - Cloud Backups post: - description: "Exports one backup snapshot for dedicated Atlas cluster using\ + description: "Exports one backup Snapshot for dedicated Atlas cluster using\ \ Cloud Backups to an Export Bucket. To use this resource, the requesting\ \ API Key must have the Project Atlas Admin role." operationId: createBackupExportJob @@ -3371,7 +3326,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -3399,12 +3354,12 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Create One Cloud Backup Snapshot Export Job + summary: Create One Snapshot Export Job tags: - Cloud Backups /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}: get: - description: "Returns one Cloud Backup snapshot export job associated with the\ + description: "Returns one Cloud Backup Snapshot Export Job associated with the\ \ specified Atlas cluster. To use this resource, the requesting API Key must\ \ have the Project Atlas Admin role." operationId: getBackupExportJob @@ -3419,13 +3374,18 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - - description: Unique string that identifies the export job to return. + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + - description: Unique 24-hexadecimal character string that identifies the Export + Job. in: path name: exportId required: true schema: type: string + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" responses: "200": content: @@ -3440,7 +3400,7 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Return One Cloud Backup Snapshot Export Job + summary: Return One Snapshot Export Job tags: - Cloud Backups /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs: @@ -3465,7 +3425,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -3501,7 +3461,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -3550,7 +3510,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the restore job to remove. in: path @@ -3598,7 +3558,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the restore job to return. in: path @@ -3644,7 +3604,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -3683,7 +3643,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -3719,7 +3679,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2024-08-05+json: @@ -3770,7 +3730,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -3808,7 +3768,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -3853,7 +3813,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -3898,7 +3858,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -3946,7 +3906,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -3983,7 +3943,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -4029,7 +3989,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -4075,7 +4035,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -4130,7 +4090,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/groupId" - $ref: "#/components/parameters/pretty" @@ -4184,7 +4144,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/groupId" - $ref: "#/components/parameters/pretty" @@ -4233,7 +4193,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/groupId" - $ref: "#/components/parameters/pretty" @@ -4270,7 +4230,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/groupId" - $ref: "#/components/parameters/pretty" @@ -4321,7 +4281,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -4359,7 +4319,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -4412,7 +4372,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -4459,7 +4419,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -4498,7 +4458,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -4536,7 +4496,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-11-15+json: @@ -4590,7 +4550,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-11-15+json: @@ -4644,7 +4604,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-11-15+json: @@ -4699,7 +4659,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -4753,7 +4713,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Name of the collection that contains one or more Atlas Search indexes. in: path @@ -4811,7 +4771,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: "Unique 24-hexadecimal digit string that identifies the Atlas\ \ Search index. Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/)\ \ endpoint to find the IDs of all Atlas Search indexes." @@ -4866,7 +4826,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - 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/)\ @@ -4920,7 +4880,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - 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/)\ @@ -4985,7 +4945,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5027,7 +4987,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5068,7 +5028,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2024-08-05+json: @@ -5119,7 +5079,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - $ref: "#/components/parameters/groupId" - description: Human-readable label that identifies the database that contains the collection. @@ -5174,7 +5134,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2024-08-05+json: @@ -5229,7 +5189,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -5344,7 +5304,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5383,7 +5343,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -5461,7 +5421,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Flag that indicates whether to download logs for queries against your online archive only or both your online archive and cluster. in: query @@ -5528,7 +5488,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "204": content: @@ -5579,7 +5539,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5632,7 +5592,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -5683,7 +5643,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5724,7 +5684,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5765,7 +5725,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -5792,6 +5752,100 @@ paths: summary: Start an Outage Simulation tags: - Cluster Outage Simulation + /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/suggestedIndexes: + get: + description: "Returns the indexes that the Performance Advisor suggests. The\ + \ Performance Advisor monitors queries that MongoDB considers slow and suggests\ + \ new indexes to improve query performance. To use this resource, the requesting\ + \ API Key must have the Project Read Only role." + operationId: listSuggestedIndexes_1 + parameters: + - $ref: "#/components/parameters/groupId" + - description: Human-readable label that identifies the cluster. + in: path + name: clusterName + required: true + schema: + type: string + maxLength: 64 + minLength: 1 + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + - description: "ProcessIds from which to retrieve suggested indexes. A processId\ + \ is a combination of host and port that serves the MongoDB process. The\ + \ host must be the hostname, FQDN, IPv4 address, or IPv6 address of the\ + \ host that runs the MongoDB process (`mongod` or `mongos`). The port must\ + \ be the IANA port on which the MongoDB process listens for requests. To\ + \ include multiple processIds, pass the parameter multiple times delimited\ + \ with an ampersand (`&`) between each processId." + in: query + name: processIds + schema: + type: array + items: + type: string + pattern: "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\\ + .){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + style: form + - 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." + in: query + name: namespaces + schema: + type: array + items: + type: string + style: form + - description: "HostType determines the source of index advice from logs. If\ + \ **hostType**=All, index advice from logs will come from all processes\ + \ within a cluster and **processIds** will be ignored. If hostType=Null,\ + \ index advice from logs will come from the subset of processes within this\ + \ cluster specified using *processIds**." + in: query + name: hostType + schema: + type: string + - description: |- + Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time). + + - If you don't specify the **until** parameter, the endpoint returns data covering from the **since** value and the current time. + - If you specify neither the **since** nor the **until** parameters, the endpoint returns data from the previous 24 hours. + in: query + name: since + schema: + type: integer + format: int64 + minimum: 1199145600000 + - description: |- + Date and time up until which the query retrieves the suggested indexes. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time). + + - If you specify the **until** parameter, you must specify the **since** parameter. + - If you specify neither the **since** nor the **until** parameters, the endpoint returns data from the previous 24 hours. + in: query + name: until + schema: + type: integer + format: int64 + minimum: 1199145600000 + responses: + "200": + content: + application/vnd.atlas.2025-01-01+json: + schema: + $ref: "#/components/schemas/PerformanceAdvisorResponse" + x-xgen-version: 2025-01-01 + description: OK + "401": + $ref: "#/components/responses/unauthorized" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Return Suggested Indexes + tags: + - Performance Advisor /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs: get: description: "Returns the advanced configuration details for one cluster in\ @@ -5817,7 +5871,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5861,7 +5915,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2024-08-05+json: @@ -5913,7 +5967,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5966,7 +6020,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -6016,7 +6070,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -6064,7 +6118,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the restore job. in: path @@ -6110,7 +6164,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "204": content: @@ -6149,7 +6203,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -6186,7 +6240,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2024-05-30+json: @@ -6230,7 +6284,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2024-05-30+json: @@ -6282,7 +6336,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -6333,7 +6387,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2024-05-30+json: @@ -6385,7 +6439,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Name of the collection that contains one or more Atlas Search indexes. in: path @@ -6449,7 +6503,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Name of the collection that contains one or more Atlas Search indexes. in: path @@ -6512,7 +6566,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Name of the collection that contains one or more Atlas Search indexes. in: path @@ -6575,7 +6629,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Name of the collection that contains one or more Atlas Search indexes. in: path @@ -6646,7 +6700,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: "Unique 24-hexadecimal digit string that identifies the Atlas\ \ Search index. Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/)\ \ endpoint to find the IDs of all Atlas Search indexes." @@ -6699,7 +6753,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - 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/)\ @@ -6759,7 +6813,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - 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/)\ @@ -6821,7 +6875,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -6859,7 +6913,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -6913,7 +6967,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: "Human-readable label that specifies whether to return only completed,\ \ incomplete, or all snapshots. By default, MongoDB Cloud only returns completed\ \ snapshots." @@ -6968,7 +7022,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -7022,7 +7076,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -7075,7 +7129,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -7130,7 +7184,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -7164,7 +7218,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Human-readable label that identifies the cluster topology to retrieve metrics for. in: path @@ -7213,7 +7267,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Human-readable label that identifies the cluster topology to retrieve metrics for. in: path @@ -7290,6 +7344,55 @@ paths: summary: Return Cluster-Level Query Latency tags: - Collection Level Metrics + /api/atlas/v2/groups/{groupId}/clusters/{clusterName}:grantMongoDBEmployeeAccess: + post: + description: Grants MongoDB employee cluster access for the given duration and + at the specified level for one cluster. + operationId: grantMongoDBEmployeeAccess + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/pretty" + - $ref: "#/components/parameters/groupId" + - description: Human-readable label that identifies this cluster. + in: path + name: clusterName + required: true + schema: + type: string + maxLength: 64 + minLength: 1 + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + requestBody: + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/EmployeeAccessGrantView" + x-xgen-version: 2024-08-05 + description: Grant access level and expiration. + required: true + responses: + "204": + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/NoBody" + x-xgen-version: 2024-08-05 + description: This endpoint does not return a response body. + "400": + $ref: "#/components/responses/badRequest" + "401": + $ref: "#/components/responses/unauthorized" + "404": + $ref: "#/components/responses/notFound" + "409": + $ref: "#/components/responses/conflict" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Grant MongoDB employee cluster access for one cluster. + tags: + - Clusters /api/atlas/v2/groups/{groupId}/clusters/{clusterName}:pinFeatureCompatibilityVersion: post: description: Pins the FCV to the current MongoDB version. @@ -7306,7 +7409,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2024-05-30+json: @@ -7337,6 +7440,46 @@ paths: summary: Pin FCV for One Cluster from One Project tags: - Clusters + /api/atlas/v2/groups/{groupId}/clusters/{clusterName}:revokeMongoDBEmployeeAccess: + post: + description: Revokes a previously granted MongoDB employee cluster access. + operationId: revokeMongoDBEmployeeAccess + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/pretty" + - $ref: "#/components/parameters/groupId" + - description: Human-readable label that identifies this cluster. + in: path + name: clusterName + required: true + schema: + type: string + maxLength: 64 + minLength: 1 + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + responses: + "204": + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/NoBody" + x-xgen-version: 2024-08-05 + description: This endpoint does not return a response body. + "400": + $ref: "#/components/responses/badRequest" + "401": + $ref: "#/components/responses/unauthorized" + "404": + $ref: "#/components/responses/notFound" + "409": + $ref: "#/components/responses/conflict" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Revoke granted MongoDB employee cluster access for one cluster. + tags: + - Clusters /api/atlas/v2/groups/{groupId}/clusters/{clusterName}:unpinFeatureCompatibilityVersion: post: description: Unpins the current fixed Feature Compatibility Version. This feature @@ -7354,7 +7497,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "204": content: @@ -7424,18 +7567,22 @@ paths: externalDocs: description: Set up Database Auditing url: https://docs.atlas.mongodb.com/database-auditing/ - - description: Date and time when the period specifies the inclusive ending - point for the range of log messages to retrieve. This parameter expresses - its value in the number of seconds that have elapsed since the UNIX epoch. + - description: "Specifies the date and time for the ending point of the range\ + \ of log messages to retrieve, in the number of seconds that have elapsed\ + \ since the UNIX epoch. This value will default to 24 hours after the start\ + \ date. If the start date is also unspecified, the value will default to\ + \ the time of the request." in: query name: endDate schema: type: integer format: int64 minimum: 1199145600 - - description: Date and time when the period specifies the inclusive starting - point for the range of log messages to retrieve. This parameter expresses - its value in the number of seconds that have elapsed since the UNIX epoch. + - description: "Specifies the date and time for the starting point of the range\ + \ of log messages to retrieve, in the number of seconds that have elapsed\ + \ since the UNIX epoch. This value will default to 24 hours prior to the\ + \ end date. If the end date is also unspecified, the value will default\ + \ to 24 hours prior to the time of the request." in: query name: startDate schema: @@ -8901,7 +9048,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: "Date and time when to stop retrieving database history. If you\ \ specify **end**, you must also specify **start**. This parameter uses\ \ UNIX epoch time in milliseconds." @@ -9120,6 +9267,9 @@ paths: - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/pretty" - $ref: "#/components/parameters/groupId" + - $ref: "#/components/parameters/includeCount" + - $ref: "#/components/parameters/itemsPerPage" + - $ref: "#/components/parameters/pageNum" - description: Human-readable label that identifies the cloud provider for the private endpoints to return. in: path @@ -9217,14 +9367,6 @@ paths: maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" - requestBody: - content: - application/vnd.atlas.2023-01-01+json: - schema: - $ref: "#/components/schemas/EncryptionAtRestPrivateEndpointRequest" - description: Cloud provider of the private endpoints to delete and the list - of cloud provider regions in which to delete the private endpoints. - required: true responses: "204": content: @@ -9279,6 +9421,8 @@ paths: description: OK "403": $ref: "#/components/responses/forbidden" + "404": + $ref: "#/components/responses/notFound" "500": $ref: "#/components/responses/internalServerError" security: @@ -9310,7 +9454,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" style: form - description: |- Category of incident recorded at this moment in time. @@ -9426,6 +9570,236 @@ paths: summary: Return One Event from One Project tags: - Events + /api/atlas/v2/groups/{groupId}/flexClusters: + get: + description: "Returns details for all flex clusters in the specified project.\ + \ To use this resource, the requesting API Key must have the Project Read\ + \ Only role." + operationId: listFlexClusters + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/groupId" + - $ref: "#/components/parameters/includeCount" + - $ref: "#/components/parameters/itemsPerPage" + - $ref: "#/components/parameters/pageNum" + - $ref: "#/components/parameters/pretty" + responses: + "200": + content: + application/vnd.atlas.2025-01-01+json: + schema: + $ref: "#/components/schemas/PaginatedFlexClusters20250101" + x-xgen-version: 2025-01-01 + description: OK + "409": + $ref: "#/components/responses/conflict" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Return All Flex Clusters from One Project + tags: + - Flex Clusters + post: + description: "Creates one flex cluster in the specified project. To use this\ + \ resource, the requesting API Key must have the Project Owner role." + operationId: createFlexcluster + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/groupId" + - $ref: "#/components/parameters/pretty" + requestBody: + content: + application/vnd.atlas.2025-01-01+json: + schema: + $ref: "#/components/schemas/FlexClusterDescriptionCreate20250101" + description: Create One Flex Cluster in One Project. + required: true + responses: + "201": + content: + application/vnd.atlas.2025-01-01+json: + schema: + $ref: "#/components/schemas/FlexClusterDescription20250101" + x-xgen-version: 2025-01-01 + description: Created + "400": + $ref: "#/components/responses/badRequest" + "402": + $ref: "#/components/responses/paymentRequired" + "409": + $ref: "#/components/responses/conflict" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Create One Flex Cluster in One Project + tags: + - Flex Clusters + /api/atlas/v2/groups/{groupId}/flexClusters/{name}: + delete: + description: "Removes one flex cluster from the specified project. The flex\ + \ cluster must have termination protection disabled in order to be deleted.\ + \ To use this resource, the requesting API Key must have the Project Owner\ + \ role." + operationId: deleteFlexCluster + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/pretty" + - $ref: "#/components/parameters/groupId" + - description: Human-readable label that identifies the flex cluster. + in: path + name: name + required: true + schema: + type: string + maxLength: 64 + minLength: 1 + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + responses: + "204": + content: + application/vnd.atlas.2025-01-01+json: + schema: + $ref: "#/components/schemas/NoBody" + x-xgen-version: 2025-01-01 + description: This endpoint does not return a response body. + "400": + $ref: "#/components/responses/badRequest" + "404": + $ref: "#/components/responses/notFound" + "409": + $ref: "#/components/responses/conflict" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Remove One Flex Cluster from One Project + tags: + - Flex Clusters + get: + description: "Returns details for one flex cluster in the specified project.\ + \ To use this resource, the requesting API Key must have the Project Read\ + \ Only role." + operationId: getFlexCluster + parameters: + - $ref: "#/components/parameters/groupId" + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/pretty" + - description: Human-readable label that identifies the flex cluster. + in: path + name: name + required: true + schema: + type: string + maxLength: 64 + minLength: 1 + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + responses: + "200": + content: + application/vnd.atlas.2025-01-01+json: + schema: + $ref: "#/components/schemas/FlexClusterDescription20250101" + x-xgen-version: 2025-01-01 + description: OK + "400": + $ref: "#/components/responses/badRequest" + "404": + $ref: "#/components/responses/notFound" + "409": + $ref: "#/components/responses/conflict" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Return One Flex Cluster from One Project + tags: + - Flex Clusters + patch: + description: "Updates one flex cluster in the specified project. To use this\ + \ resource, the requesting API Key must have the Project Owner role." + operationId: updateFlexCluster + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/groupId" + - $ref: "#/components/parameters/pretty" + - description: Human-readable label that identifies the flex cluster. + in: path + name: name + required: true + schema: + type: string + maxLength: 64 + minLength: 1 + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + requestBody: + content: + application/vnd.atlas.2025-01-01+json: + schema: + $ref: "#/components/schemas/FlexClusterDescription20250101" + description: Update One Flex Cluster in One Project. + required: true + responses: + "200": + content: + application/vnd.atlas.2025-01-01+json: + schema: + $ref: "#/components/schemas/FlexClusterDescription20250101" + x-xgen-version: 2025-01-01 + description: OK + "400": + $ref: "#/components/responses/badRequest" + "402": + $ref: "#/components/responses/paymentRequired" + "409": + $ref: "#/components/responses/conflict" + security: + - DigestAuth: [] + summary: Update One Flex Cluster in One Project + tags: + - Flex Clusters + /api/atlas/v2/groups/{groupId}/flexClusters:tenantUpgrade: + post: + description: "Upgrades a flex cluster in the specified project. To use this\ + \ resource, the requesting API key must have the Project Cluster Manager role." + operationId: upgradeFlexCluster + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/groupId" + - $ref: "#/components/parameters/pretty" + requestBody: + content: + application/vnd.atlas.2025-01-01+json: + schema: + $ref: "#/components/schemas/FlexClusterDescription20250101" + description: Details of the flex cluster upgrade in the specified project. + required: true + responses: + "200": + content: + application/vnd.atlas.2025-01-01+json: + schema: + $ref: "#/components/schemas/FlexClusterDescription20250101" + x-xgen-version: 2025-01-01 + description: OK + "400": + $ref: "#/components/responses/badRequest" + "401": + $ref: "#/components/responses/unauthorized" + "402": + $ref: "#/components/responses/paymentRequired" + "403": + $ref: "#/components/responses/forbidden" + "409": + $ref: "#/components/responses/conflict" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Upgrade One Flex Cluster + tags: + - Flex Clusters /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics: get: description: Returns all Atlas Search metric types available for one process @@ -9937,7 +10311,7 @@ paths: summary: Return All Project Invitations tags: - Projects - x-sunset: 2024-10-04 + x-sunset: 2024-11-04 patch: deprecated: true description: "Updates the details of one pending invitation to the specified\ @@ -9978,7 +10352,7 @@ paths: summary: Update One Project Invitation tags: - Projects - x-sunset: 2024-10-04 + x-sunset: 2024-11-04 post: deprecated: true description: "Invites one MongoDB Cloud user to join the specified project.\ @@ -10014,7 +10388,7 @@ paths: summary: Invite One MongoDB Cloud User to Join One Project tags: - Projects - x-sunset: 2024-10-04 + x-sunset: 2024-11-04 /api/atlas/v2/groups/{groupId}/invites/{invitationId}: delete: deprecated: true @@ -10052,7 +10426,7 @@ paths: summary: Cancel One Project Invitation tags: - Projects - x-sunset: 2024-10-04 + x-sunset: 2024-11-04 get: deprecated: true description: "Returns the details of one pending invitation to the specified\ @@ -10091,7 +10465,7 @@ paths: summary: Return One Project Invitation tags: - Projects - x-sunset: 2024-10-04 + x-sunset: 2024-11-04 patch: deprecated: true description: "Updates the details of one pending invitation to the specified\ @@ -10141,7 +10515,7 @@ paths: summary: Update One Project Invitation by Invitation ID tags: - Projects - x-sunset: 2024-10-04 + x-sunset: 2024-11-04 /api/atlas/v2/groups/{groupId}/ipAddresses: get: description: "Returns all IP addresses for this project. To use this resource,\ @@ -10217,7 +10591,7 @@ paths: | Limit Name | Description | Default | API Override Limit | | --- | --- | --- | --- | - | atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 | + | atlas.project.deployment.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 | @@ -10229,6 +10603,7 @@ paths: | 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 | in: path name: limitName required: true @@ -10248,6 +10623,7 @@ paths: - 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" @@ -10282,7 +10658,7 @@ paths: | Limit Name | Description | Default | API Override Limit | | --- | --- | --- | --- | - | atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 | + | atlas.project.deployment.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 | @@ -10294,6 +10670,7 @@ paths: | 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 | in: path name: limitName required: true @@ -10313,6 +10690,7 @@ paths: - 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" @@ -10351,7 +10729,7 @@ paths: | Limit Name | Description | Default | API Override Limit | | --- | --- | --- | --- | - | atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 | + | atlas.project.deployment.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 | @@ -10363,6 +10741,7 @@ paths: | 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 | in: path name: limitName required: true @@ -10382,6 +10761,7 @@ paths: - 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" @@ -11154,6 +11534,7 @@ paths: - Network Peering /api/atlas/v2/groups/{groupId}/pipelines: get: + deprecated: true description: "Returns a list of Data Lake Pipelines. To use this resource, the\ \ requesting API Key must have the Project Read Only role." operationId: listPipelines @@ -11181,8 +11562,14 @@ paths: summary: Return All Data Lake Pipelines from One Project tags: - Data Lake Pipelines + x-sunset: 2025-09-09 post: + deprecated: true description: Creates one Data Lake Pipeline. + externalDocs: + description: Data Lake Pipelines are deprecated. Please see Data Lake Deprecation + Guide. + url: https://dochub.mongodb.org/core/data-lake-deprecation operationId: createPipeline parameters: - $ref: "#/components/parameters/envelope" @@ -11215,8 +11602,10 @@ paths: summary: Create One Data Lake Pipeline tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}: delete: + deprecated: true description: Removes one Data Lake Pipeline. operationId: deletePipeline parameters: @@ -11250,7 +11639,9 @@ paths: summary: Remove One Data Lake Pipeline tags: - Data Lake Pipelines + x-sunset: 2025-09-09 get: + deprecated: true description: "Returns the details of one Data Lake Pipeline within the specified\ \ project. To use this resource, the requesting API Key must have the Project\ \ Read Only role." @@ -11287,7 +11678,9 @@ paths: summary: Return One Data Lake Pipeline tags: - Data Lake Pipelines + x-sunset: 2025-09-09 patch: + deprecated: true description: Updates one Data Lake Pipeline. operationId: updatePipeline parameters: @@ -11332,8 +11725,10 @@ paths: summary: Update One Data Lake Pipeline tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules: get: + deprecated: true description: "Returns a list of backup schedule policy items that you can use\ \ as a Data Lake Pipeline source. To use this resource, the requesting API\ \ Key must have the Project Read Only role." @@ -11372,8 +11767,10 @@ paths: summary: Return Available Ingestion Schedules for One Data Lake Pipeline tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots: get: + deprecated: true description: "Returns a list of backup snapshots that you can use to trigger\ \ an on demand pipeline run. To use this resource, the requesting API Key\ \ must have the Project Read Only role." @@ -11423,8 +11820,10 @@ paths: summary: Return Available Backup Snapshots for One Data Lake Pipeline tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause: post: + deprecated: true description: "Pauses ingestion for a Data Lake Pipeline within the specified\ \ project. To use this resource, the requesting API Key must have the Project\ \ Read Only role." @@ -11461,8 +11860,10 @@ paths: summary: Pause One Data Lake Pipeline tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume: post: + deprecated: true description: "Resumes ingestion for a Data Lake Pipeline within the specified\ \ project. To use this resource, the requesting API Key must have the Project\ \ Read Only role." @@ -11499,8 +11900,10 @@ paths: summary: Resume One Data Lake Pipeline tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs: get: + deprecated: true description: "Returns a list of past Data Lake Pipeline runs. To use this resource,\ \ the requesting API Key must have the Project Read Only role." operationId: listPipelineRuns @@ -11547,8 +11950,10 @@ paths: summary: Return All Data Lake Pipeline Runs from One Project tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}: delete: + deprecated: true description: Deletes dataset that Atlas generated during the specified pipeline run. operationId: deletePipelineRunDataset @@ -11595,7 +12000,9 @@ paths: summary: Delete Pipeline Run Dataset tags: - Data Lake Pipelines + x-sunset: 2025-09-09 get: + deprecated: true description: "Returns the details of one Data Lake Pipeline run within the specified\ \ project. To use this resource, the requesting API Key must have the Project\ \ Read Only role." @@ -11643,8 +12050,10 @@ paths: summary: Return One Data Lake Pipeline Run tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger: post: + deprecated: true description: Triggers a Data Lake Pipeline ingestion of a specified snapshot. operationId: triggerSnapshotIngestion parameters: @@ -11686,6 +12095,7 @@ paths: summary: Trigger on demand snapshot ingestion tags: - Data Lake Pipelines + x-sunset: 2025-09-09 /api/atlas/v2/groups/{groupId}/privateEndpoint/endpointService: post: description: "Creates one private endpoint service for the specified cloud service\ @@ -11817,7 +12227,7 @@ paths: schema: type: string maxLength: 64 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -11859,7 +12269,7 @@ paths: schema: type: string maxLength: 64 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -11903,7 +12313,7 @@ paths: schema: type: string maxLength: 64 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be removed. in: path @@ -11949,7 +12359,7 @@ paths: schema: type: string maxLength: 64 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the tenant endpoint. in: path @@ -11994,7 +12404,7 @@ paths: schema: type: string maxLength: 64 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be updated. in: path @@ -13016,6 +13426,8 @@ paths: - 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 maxItems: 10 minItems: 1 uniqueItems: true @@ -13100,6 +13512,8 @@ paths: - CACHE_BYTES_WRITTEN_FROM - CACHE_DIRTY_BYTES - CACHE_USED_BYTES + - CACHE_FILL_RATIO + - DIRTY_FILL_RATIO - COMPUTED_MEMORY - CONNECTIONS - CURSORS_TOTAL_OPEN @@ -13181,6 +13595,7 @@ paths: - 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 @@ -13723,7 +14138,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "201": content: @@ -13868,7 +14283,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -13906,7 +14321,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -13956,7 +14371,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the restore job to return. in: path @@ -14007,7 +14422,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -14044,7 +14459,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -14089,7 +14504,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/pretty" responses: @@ -14122,7 +14537,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Value that we want to set for the Serverless Auto Indexing toggle. in: query name: enable @@ -14166,15 +14581,15 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: - "204": + "202": content: application/vnd.atlas.2023-01-01+json: schema: - $ref: "#/components/schemas/NoBody" + $ref: "#/components/schemas/RequestAccepted" x-xgen-version: 2023-01-01 - description: This endpoint does not return a response body. + description: Accepted "400": $ref: "#/components/responses/badRequest" "404": @@ -14205,7 +14620,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -14243,7 +14658,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -14272,8 +14687,8 @@ paths: - Serverless Instances /api/atlas/v2/groups/{groupId}/serviceAccounts: get: - description: Returns list of Service Accounts for a project with service account - details. + description: Returns all Service Accounts for the specified Project. Available + as a preview feature. operationId: listProjectServiceAccounts parameters: - $ref: "#/components/parameters/groupId" @@ -14284,10 +14699,10 @@ paths: responses: "200": content: - application/vnd.atlas.2023-10-01+json: + application/vnd.atlas.2024-08-05+json: schema: $ref: "#/components/schemas/PaginatedGroupServiceAccounts" - x-xgen-version: 2023-10-01 + x-xgen-version: 2024-08-05 description: OK "401": $ref: "#/components/responses/unauthorized" @@ -14297,12 +14712,13 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Return All project Service Accounts + summary: List All Project Service Accounts tags: - - Groups + - Service Accounts post: - description: Creates and assigns the specified Service Account to the specified - Project. + description: Creates one Service Account for the specified Project. The Service + Account will automatically be added as an Organization Member to the Organization + that the specified Project is a part of. Available as a preview feature. operationId: createProjectServiceAccount parameters: - $ref: "#/components/parameters/groupId" @@ -14310,19 +14726,19 @@ paths: - $ref: "#/components/parameters/pretty" requestBody: content: - application/vnd.atlas.2023-10-01+json: + application/vnd.atlas.2024-08-05+json: schema: $ref: "#/components/schemas/GroupServiceAccountRequest" - x-xgen-version: 2023-10-01 - description: Details to create service account and add to the specified project. + x-xgen-version: 2024-08-05 + description: Details of the new Service Account. required: true responses: "201": content: - application/vnd.atlas.2023-10-01+json: + application/vnd.atlas.2024-08-05+json: schema: $ref: "#/components/schemas/GroupServiceAccount" - x-xgen-version: 2023-10-01 + x-xgen-version: 2024-08-05 description: Created "400": $ref: "#/components/responses/badRequest" @@ -14332,32 +14748,37 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Create and Assign one Service Account to one project + summary: Create and Assign one Service Account to one Project tags: - - Groups - /api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}: + - Service Accounts + /api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}: delete: - description: Removes one Service Account from the specified project. + description: "Removes the specified Service Account from the specified project.\ + \ The Service Account will still be a part of the Organization it was created\ + \ in, and the credentials will remain active until expired or manually revoked.\ + \ Available as a preview feature." operationId: deleteProjectServiceAccount parameters: - - description: Id of the service account. + - description: The Client ID of the Service Account. in: path - name: serviceAccountId + name: clientId required: true schema: type: string + example: mdb_sa_id_667066535bc75b03c37b3038 + pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" - $ref: "#/components/parameters/groupId" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/pretty" responses: "204": content: - application/vnd.atlas.2023-10-01+json: + application/vnd.atlas.2024-08-05+json: schema: $ref: "#/components/schemas/NoBody" - x-xgen-version: 2023-10-01 + x-xgen-version: 2024-08-05 description: This endpoint does not return a response body. - x-xgen-version: 2023-10-01 + x-xgen-version: 2024-08-05 "401": $ref: "#/components/responses/unauthorized" "404": @@ -14366,29 +14787,32 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Unassign One Service Account from One Project. + summary: Unassign One Service Account from One Project tags: - - Groups + - Service Accounts get: - description: Get project Service Account Details. + description: Returns one Service Account in the specified Project. Available + as a preview feature. operationId: getProjectServiceAccount parameters: - $ref: "#/components/parameters/groupId" - - description: Id of the service account. + - description: The Client ID of the Service Account. in: path - name: serviceAccountId + name: clientId required: true schema: type: string + example: mdb_sa_id_667066535bc75b03c37b3038 + pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/pretty" responses: "200": content: - application/vnd.atlas.2023-10-01+json: + application/vnd.atlas.2024-08-05+json: schema: $ref: "#/components/schemas/GroupServiceAccount" - x-xgen-version: 2023-10-01 + x-xgen-version: 2024-08-05 description: OK "401": $ref: "#/components/responses/unauthorized" @@ -14398,36 +14822,39 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Service Account Fetching + summary: Get one Project Service Account tags: - - Groups + - Service Accounts patch: - description: Update Service Account in Project. + description: Updates one Service Account in the specified Project. Available + as a preview feature. operationId: updateProjectServiceAccount parameters: - - description: Id of the service account. + - description: The Client ID of the Service Account. in: path - name: serviceAccountId + name: clientId required: true schema: type: string + example: mdb_sa_id_667066535bc75b03c37b3038 + pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" - $ref: "#/components/parameters/groupId" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/pretty" requestBody: content: - application/vnd.atlas.2023-10-01+json: + application/vnd.atlas.2024-08-05+json: schema: $ref: "#/components/schemas/GroupServiceAccountUpdateRequest" - description: Details to update service account in the specified Project. + description: The new details for the Service Account. required: true responses: "200": content: - application/vnd.atlas.2023-10-01+json: + application/vnd.atlas.2024-08-05+json: schema: $ref: "#/components/schemas/GroupServiceAccount" - x-xgen-version: 2023-10-01 + x-xgen-version: 2024-08-05 description: OK "400": $ref: "#/components/responses/badRequest" @@ -14439,42 +14866,182 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Service Account Update in Project + summary: Update one Project Service Account tags: - - Groups + - Service Accounts + /api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList: + get: + description: Returns all access list entries that you configured for the specified + Service Account for the project. Available as a preview feature. + operationId: listProjectServiceAccountAccessList + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/includeCount" + - $ref: "#/components/parameters/itemsPerPage" + - $ref: "#/components/parameters/groupId" + - $ref: "#/components/parameters/pageNum" + - $ref: "#/components/parameters/pretty" + - description: The Client ID of the Service Account. + in: path + name: clientId + required: true + schema: + type: string + example: mdb_sa_id_667066535bc75b03c37b3038 + pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" + responses: + "200": + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/PaginatedServiceAccountIPAccessEntryView" + x-xgen-version: 2024-08-05 + description: OK + "401": + $ref: "#/components/responses/unauthorized" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Return All Access List entries for one Project Service Account + tags: + - Service Accounts post: - description: Assigns the specified organization Service Account to the specified - project. + description: Add Access List Entries for the specified Service Account for the + project. Resources require all API requests to originate from IP addresses + on the API access list. Available as a preview feature. + operationId: createProjectServiceAccountAccessList + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/includeCount" + - $ref: "#/components/parameters/itemsPerPage" + - $ref: "#/components/parameters/groupId" + - $ref: "#/components/parameters/pageNum" + - $ref: "#/components/parameters/pretty" + - description: The Client ID of the Service Account. + in: path + name: clientId + required: true + schema: + type: string + example: mdb_sa_id_667066535bc75b03c37b3038 + pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" + requestBody: + content: + application/vnd.atlas.2024-08-05+json: + schema: + type: array + items: + $ref: "#/components/schemas/ServiceAccountIPAccessListEntry" + x-xgen-version: 2024-08-05 + description: A list of access list entries to add to the access list of the + specified Service Account for the project. + required: true + responses: + "200": + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/PaginatedServiceAccountIPAccessEntryView" + x-xgen-version: 2024-08-05 + description: OK + "400": + $ref: "#/components/responses/badRequest" + "401": + $ref: "#/components/responses/unauthorized" + "409": + $ref: "#/components/responses/conflict" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Add Access List entries for one Project Service Account + tags: + - Service Accounts + /api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList/{ipAddress}: + delete: + description: Removes the specified access list entry from the specified Service + Account for the project. You can't remove the requesting IP address from the + access list. Available as a preview feature. + operationId: deleteProjectServiceAccountAccessListEntry + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/groupId" + - $ref: "#/components/parameters/pretty" + - description: The Client ID of the Service Account. + in: path + name: clientId + required: true + schema: + type: string + example: mdb_sa_id_667066535bc75b03c37b3038 + pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" + - description: "One IP address or multiple IP addresses represented as one CIDR\ + \ block. When specifying a CIDR block with a subnet mask, such as 192.0.2.0/24,\ + \ use the URL-encoded value %2F for the forward slash /." + in: path + name: ipAddress + required: true + schema: + type: string + example: 192.0.2.0%2F24 + pattern: "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\\ + :){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})?$" + responses: + "204": + content: + application/vnd.atlas.2024-08-05+json: + x-xgen-version: 2024-08-05 + description: This endpoint does not return a response body. + "400": + $ref: "#/components/responses/badRequest" + "401": + $ref: "#/components/responses/unauthorized" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Remove One Access List entry from one Project Service Account + tags: + - Service Accounts + /api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}:invite: + post: + description: Assigns the specified Service Account to the specified Project. + Available as a preview feature. operationId: addProjectServiceAccount parameters: - - description: Id of the service account. + - description: The Client ID of the Service Account. in: path - name: serviceAccountId + name: clientId required: true schema: type: string + example: mdb_sa_id_667066535bc75b03c37b3038 + pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" - $ref: "#/components/parameters/groupId" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/pretty" requestBody: content: - application/vnd.atlas.2023-10-01+json: + application/vnd.atlas.2024-08-05+json: schema: type: array items: $ref: "#/components/schemas/GroupServiceAccountRoleAssignment" - x-xgen-version: 2023-10-01 - description: Service Account Roles to be assigned to the specified project. + x-xgen-version: 2024-08-05 + description: The Project permissions for the Service Account in the specified + Project. required: true responses: - "204": + "200": content: - application/vnd.atlas.2023-10-01+json: + application/vnd.atlas.2024-08-05+json: schema: - $ref: "#/components/schemas/NoBody" - x-xgen-version: 2023-10-01 - description: This endpoint does not return a response body. - x-xgen-version: 2023-10-01 + $ref: "#/components/schemas/GroupServiceAccount" + x-xgen-version: 2024-08-05 + description: OK "401": $ref: "#/components/responses/unauthorized" "404": @@ -14485,7 +15052,7 @@ paths: - DigestAuth: [] summary: Assign One Service Account to One Project tags: - - Groups + - Service Accounts /api/atlas/v2/groups/{groupId}/settings: get: description: "Returns details about the specified project's settings. To use\ @@ -14622,6 +15189,292 @@ paths: x-xgen-changelog: "2023-09-11": "The MongoDB Atlas Streams Processing API is now exposed as\ \ part of private preview, but is subject to change until GA." + /api/atlas/v2/groups/{groupId}/streams/privateLinkConnections: + get: + description: "Returns all Private Link connections for the specified project.To\ + \ use this resource, the requesting API Key must have the Project Data Access\ + \ roles, Project Owner role or Project Stream Processing Owner role." + operationId: listPrivateLinkConnections + parameters: + - $ref: "#/components/parameters/groupId" + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/itemsPerPage" + - $ref: "#/components/parameters/pageNum" + - $ref: "#/components/parameters/pretty" + responses: + "200": + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/PaginatedApiStreamsPrivateLinkView" + x-xgen-version: 2023-02-01 + description: OK + "401": + $ref: "#/components/responses/unauthorized" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Return All Private Link + tags: + - Streams + x-xgen-changelog: + "2024-10-02": "The MongoDB Atlas Streams Processing Private Link API is now\ + \ exposed as part of private preview, but is subject to change until GA." + post: + description: "Creates one Private Link in the specified project. To use this\ + \ resource, the requesting API Key must have the Project Owner or Project\ + \ Stream Processing Owner role." + operationId: createPrivateLinkConnection + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/pretty" + - $ref: "#/components/parameters/groupId" + requestBody: + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/StreamsPrivateLinkConnection" + description: Details to create one Private Link connection for a project. + project. + required: true + responses: + "200": + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/StreamsPrivateLinkConnection" + x-xgen-version: 2023-02-01 + description: OK + "400": + $ref: "#/components/responses/badRequest" + "401": + $ref: "#/components/responses/unauthorized" + "409": + $ref: "#/components/responses/unauthorized" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Create One Private Link connection + tags: + - Streams + x-xgen-changelog: + "2024-10-02": "The MongoDB Atlas Streams Processing Private Link API is now\ + \ exposed as part of private preview, but is subject to change until GA." + /api/atlas/v2/groups/{groupId}/streams/privateLinkConnections/{connectionId}: + delete: + description: "Deletes one Private Link in the specified project. To use this\ + \ resource, the requesting API Key must have the Project Owner or Project\ + \ Stream Processing Owner role." + operationId: deletePrivateLinkConnection + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/pretty" + - $ref: "#/components/parameters/groupId" + - description: Unique ID that identifies the Private Link connection. + in: path + name: connectionId + required: true + schema: + type: string + responses: + "202": + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/NoBody" + x-xgen-version: 2023-02-01 + description: Accepted + "401": + $ref: "#/components/responses/unauthorized" + "403": + $ref: "#/components/responses/forbidden" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Delete One Private Link connection + tags: + - Streams + x-xgen-changelog: + "2024-10-02": "The MongoDB Atlas Streams Processing Private Link API is now\ + \ exposed as part of private preview, but is subject to change until GA." + get: + description: "Returns the details of one Private Link connection within the\ + \ project. To use this resource, the requesting API Key must have the Project\ + \ Read Only role." + operationId: getPrivateLinkConnection + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/groupId" + - description: Unique ID that identifies the Private Link connection. + in: path + name: connectionId + required: true + schema: + type: string + responses: + "200": + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/StreamsPrivateLinkConnection" + x-xgen-version: 2023-02-01 + description: OK + "401": + $ref: "#/components/responses/unauthorized" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Return One PrivateLink Connection + tags: + - Streams + x-xgen-changelog: + "2024-10-02": "The MongoDB Atlas Streams Processing Private Link API is now\ + \ exposed as part of private preview, but is subject to change until GA." + /api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections: + get: + description: Returns a list of incoming VPC Peering Connections. + operationId: getVPCPeeringConnections + parameters: + - $ref: "#/components/parameters/groupId" + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/itemsPerPage" + - $ref: "#/components/parameters/pageNum" + - $ref: "#/components/parameters/pretty" + responses: + "200": + content: + application/vnd.atlas.2023-02-01+json: + x-xgen-version: 2023-02-01 + description: OK + "401": + $ref: "#/components/responses/unauthorized" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Return All VPC Peering Connections. + tags: + - Streams + /api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}: + delete: + description: Deletes an incoming VPC Peering connection. + operationId: deleteVPCPeeringConnection + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/groupId" + - description: The VPC Peering Connection id. + in: path + name: id + required: true + schema: + type: string + responses: + "202": + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/NoBody" + x-xgen-version: 2023-02-01 + description: Accepted + "401": + $ref: "#/components/responses/unauthorized" + "403": + $ref: "#/components/responses/forbidden" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Deletes an incoming VPC Peering connection. + tags: + - Streams + /api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:accept: + post: + description: Requests the acceptance of an incoming VPC Peering connection. + operationId: acceptVPCPeeringConnection + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/groupId" + - description: The VPC Peering Connection id. + in: path + name: id + required: true + schema: + type: string + requestBody: + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/VPCPeeringActionChallenge" + description: "Challenge values for VPC Peering requester account ID, and requester\ + \ VPC ID." + required: true + responses: + "202": + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/NoBody" + x-xgen-version: 2023-02-01 + description: Accepted + "401": + $ref: "#/components/responses/unauthorized" + "403": + $ref: "#/components/responses/forbidden" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Requests the acceptance of an incoming VPC Peering connection. + tags: + - Streams + /api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:reject: + post: + description: Requests the rejection of an incoming VPC Peering connection. + operationId: rejectVPCPeeringConnection + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/groupId" + - description: The VPC Peering Connection id. + in: path + name: id + required: true + schema: + type: string + responses: + "202": + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/NoBody" + x-xgen-version: 2023-02-01 + description: Accepted + "401": + $ref: "#/components/responses/unauthorized" + "403": + $ref: "#/components/responses/forbidden" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Requests the rejection of an incoming VPC Peering connection. + tags: + - Streams /api/atlas/v2/groups/{groupId}/streams/{tenantName}: delete: description: "Delete one stream instance in the specified project. To use this\ @@ -15307,6 +16160,43 @@ paths: summary: Return All Stream Processors In The Stream Instance. tags: - Streams + /api/atlas/v2/groups/{groupId}/streams:withSampleConnections: + post: + description: "Creates one stream instance in the specified project with sample\ + \ connections. To use this resource the requesting API Key must have the Project\ + \ Data Access Admin role, Project Owner role or Project Stream Processing\ + \ Owner role." + operationId: createStreamInstanceWithSampleConnections + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/pretty" + - $ref: "#/components/parameters/groupId" + requestBody: + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/TenantWithSampleConnections" + description: Details to create one streams instance in the specified project. + required: true + responses: + "200": + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/StreamsTenant" + x-xgen-version: 2024-08-05 + description: OK + "400": + $ref: "#/components/responses/badRequest" + "401": + $ref: "#/components/responses/unauthorized" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Create One Stream Instance With Sample Connections + tags: + - Streams /api/atlas/v2/groups/{groupId}/teams: get: description: "Returns all teams to which the authenticated user has access in\ @@ -15821,194 +16711,6 @@ paths: summary: Update Project Roles for One MongoDB Cloud User tags: - Projects - /api/atlas/v2/groups/{groupId}/uss: - get: - description: "Returns details for all USS instances in the specified project.\ - \ To use this resource, the requesting API Key must have the Project Read\ - \ Only role." - operationId: listUSSInstances - parameters: - - $ref: "#/components/parameters/envelope" - - $ref: "#/components/parameters/groupId" - - $ref: "#/components/parameters/includeCount" - - $ref: "#/components/parameters/itemsPerPage" - - $ref: "#/components/parameters/pageNum" - - $ref: "#/components/parameters/pretty" - responses: - "200": - content: - application/vnd.atlas.2025-01-01+json: - schema: - $ref: "#/components/schemas/PaginatedUSSInstance20250101" - x-xgen-version: 2025-01-01 - description: OK - "409": - $ref: "#/components/responses/conflict" - "500": - $ref: "#/components/responses/internalServerError" - security: - - DigestAuth: [] - summary: Return All USS Instances from One Project - tags: - - USS Instances - post: - description: "Creates one USS instance in the specified project. To use this\ - \ resource, the requesting API Key must have the Project Owner role." - operationId: createUSSInstance - parameters: - - $ref: "#/components/parameters/envelope" - - $ref: "#/components/parameters/groupId" - - $ref: "#/components/parameters/pretty" - requestBody: - content: - application/vnd.atlas.2025-01-01+json: - schema: - $ref: "#/components/schemas/USSInstanceDescriptionCreate20250101" - description: Create One USS Instance in One Project. - required: true - responses: - "201": - content: - application/vnd.atlas.2025-01-01+json: - schema: - $ref: "#/components/schemas/USSInstanceDescription20250101" - x-xgen-version: 2025-01-01 - description: Created - "400": - $ref: "#/components/responses/badRequest" - "402": - $ref: "#/components/responses/paymentRequired" - "409": - $ref: "#/components/responses/conflict" - "500": - $ref: "#/components/responses/internalServerError" - security: - - DigestAuth: [] - summary: Create One USS Instance in One Project - tags: - - USS Instances - /api/atlas/v2/groups/{groupId}/uss/{name}: - delete: - description: "Removes one USS instance from the specified project. The USS instance\ - \ must have termination protection disabled in order to be deleted. To use\ - \ this resource, the requesting API Key must have the Project Owner role." - operationId: deleteUSSInstance - parameters: - - $ref: "#/components/parameters/envelope" - - $ref: "#/components/parameters/pretty" - - $ref: "#/components/parameters/groupId" - - description: Human-readable label that identifies the USS instance. - in: path - name: name - required: true - schema: - type: string - maxLength: 64 - minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - responses: - "204": - content: - application/vnd.atlas.2025-01-01+json: - schema: - $ref: "#/components/schemas/NoBody" - x-xgen-version: 2025-01-01 - description: This endpoint does not return a response body. - "400": - $ref: "#/components/responses/badRequest" - "404": - $ref: "#/components/responses/notFound" - "409": - $ref: "#/components/responses/conflict" - "500": - $ref: "#/components/responses/internalServerError" - security: - - DigestAuth: [] - summary: Remove One USS Instance from One Project - tags: - - USS Instances - get: - description: "Returns details for one USS instance in the specified project.\ - \ To use this resource, the requesting API Key must have the Project Read\ - \ Only role." - operationId: getUSSInstance - parameters: - - $ref: "#/components/parameters/groupId" - - $ref: "#/components/parameters/envelope" - - $ref: "#/components/parameters/pretty" - - description: Human-readable label that identifies the USS instance. - in: path - name: name - required: true - schema: - type: string - maxLength: 64 - minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - responses: - "200": - content: - application/vnd.atlas.2025-01-01+json: - schema: - $ref: "#/components/schemas/USSInstanceDescription20250101" - x-xgen-version: 2025-01-01 - description: OK - "400": - $ref: "#/components/responses/badRequest" - "404": - $ref: "#/components/responses/notFound" - "409": - $ref: "#/components/responses/conflict" - "500": - $ref: "#/components/responses/internalServerError" - security: - - DigestAuth: [] - summary: Return One USS Instance from One Project - tags: - - USS Instances - patch: - description: "Updates one USS instance in the specified project. To use this\ - \ resource, the requesting API Key must have the Project Owner role." - operationId: updateUSSInstance - parameters: - - $ref: "#/components/parameters/envelope" - - $ref: "#/components/parameters/groupId" - - $ref: "#/components/parameters/pretty" - - description: Human-readable label that identifies the USS instance. - in: path - name: name - required: true - schema: - type: string - maxLength: 64 - minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - requestBody: - content: - application/vnd.atlas.2025-01-01+json: - schema: - $ref: "#/components/schemas/USSInstanceDescription20250101" - description: Update One USS Instance in One Project. - required: true - responses: - "200": - content: - application/vnd.atlas.2025-01-01+json: - schema: - $ref: "#/components/schemas/USSInstanceDescription20250101" - x-xgen-version: 2025-01-01 - description: OK - "400": - $ref: "#/components/responses/badRequest" - "402": - $ref: "#/components/responses/paymentRequired" - "409": - $ref: "#/components/responses/conflict" - security: - - DigestAuth: [] - summary: Update One USS Instance in One Project - tags: - - USS Instances /api/atlas/v2/groups/{groupId}:migrate: post: description: "Migrates a project from its current organization to another organization.\ @@ -17388,7 +18090,7 @@ paths: summary: Return One Organization Invoice as CSV tags: - Invoices - /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/lineItems/:search: + /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/lineItems:search: get: description: Query the lineItems of the specified invoice and return the result JSON. A unique 24-hexadecimal digit string identifies the invoice. @@ -17411,7 +18113,7 @@ paths: pattern: "^([a-f0-9]{24})$" requestBody: content: - application/vnd.atlas.2025-01-01+json: + application/vnd.atlas.2024-08-05+json: schema: $ref: "#/components/schemas/ApiPublicUsageDetailsQueryRequest" description: Filter parameters for the lineItems query. Send a request with @@ -17421,10 +18123,10 @@ paths: responses: "200": content: - application/vnd.atlas.2025-01-01+json: + application/vnd.atlas.2024-08-05+json: schema: $ref: "#/components/schemas/PaginatedPublicApiUsageDetailsLineItemView" - x-xgen-version: 2025-01-01 + x-xgen-version: 2024-08-05 description: OK "400": $ref: "#/components/responses/badRequest" @@ -17533,9 +18235,316 @@ paths: summary: Create One Link-Token tags: - Cloud Migration Service + /api/atlas/v2/orgs/{orgId}/nonCompliantResources: + get: + description: Return all non-compliant resources for an org. + externalDocs: + description: Atlas Resource Policies + url: https://docs.atlas.mongodb.com + operationId: getResourcesNonCompliant + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/pretty" + - $ref: "#/components/parameters/orgId" + responses: + "200": + content: + application/vnd.atlas.2024-08-05+json: + schema: + type: array + items: + $ref: "#/components/schemas/ApiAtlasNonCompliantResourceView" + x-xgen-version: 2024-08-05 + description: OK + "400": + $ref: "#/components/responses/badRequest" + "401": + $ref: "#/components/responses/unauthorized" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Return all non-compliant resources + tags: + - Resource Policies + /api/atlas/v2/orgs/{orgId}/resourcePolicies: + get: + description: Return all Atlas Resource Policies for the org. + externalDocs: + description: Atlas Resource Policies + url: https://docs.atlas.mongodb.com + operationId: getAtlasResourcePolicies + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/pretty" + - $ref: "#/components/parameters/orgId" + responses: + "200": + content: + application/vnd.atlas.2024-08-05+json: + schema: + type: array + items: + $ref: "#/components/schemas/ApiAtlasResourcePolicyView" + x-xgen-version: 2024-08-05 + description: OK + "400": + $ref: "#/components/responses/badRequest" + "401": + $ref: "#/components/responses/unauthorized" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Return all Atlas Resource Policies + tags: + - Resource Policies + post: + description: Create one Atlas Resource Policy for an org. + externalDocs: + description: Atlas Resource Policies + url: https://docs.atlas.mongodb.com + operationId: createAtlasResourcePolicy + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/pretty" + - $ref: "#/components/parameters/orgId" + requestBody: + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/ApiAtlasResourcePolicyCreateView" + x-xgen-version: 2024-08-05 + description: Atlas Resource Policy to create. + required: true + responses: + "201": + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/ApiAtlasResourcePolicyView" + x-xgen-version: 2024-08-05 + description: Created + "400": + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/ApiAtlasInvalidResourcePolicyCreateErrorView" + x-xgen-version: 2024-08-05 + description: Bad request. + "401": + $ref: "#/components/responses/unauthorized" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Create one Atlas Resource Policy + tags: + - Resource Policies + /api/atlas/v2/orgs/{orgId}/resourcePolicies/{resourcePolicyId}: + delete: + description: Delete one Atlas Resource Policy for an org. + externalDocs: + description: Atlas Resource Policies + url: https://docs.atlas.mongodb.com + operationId: deleteAtlasResourcePolicy + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/pretty" + - $ref: "#/components/parameters/orgId" + - description: Unique 24-hexadecimal digit string that identifies an atlas resource + policy. + in: path + name: resourcePolicyId + required: true + schema: + type: string + description: Unique 24-hexadecimal character string that identifies the + atlas resource policy. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + responses: + "200": + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/NoBody" + x-xgen-version: 2024-08-05 + description: This endpoint does not return a response body. + "400": + $ref: "#/components/responses/badRequest" + "401": + $ref: "#/components/responses/unauthorized" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Delete one Atlas Resource Policy + tags: + - Resource Policies + get: + description: Return one Atlas Resource Policy for an org. + externalDocs: + description: Atlas Resource Policies + url: https://docs.atlas.mongodb.com + operationId: getAtlasResourcePolicy + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/pretty" + - $ref: "#/components/parameters/orgId" + - description: Unique 24-hexadecimal digit string that identifies an atlas resource + policy. + in: path + name: resourcePolicyId + required: true + schema: + type: string + description: Unique 24-hexadecimal character string that identifies the + atlas resource policy. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + responses: + "200": + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/ApiAtlasResourcePolicyView" + x-xgen-version: 2024-08-05 + description: OK + "400": + $ref: "#/components/responses/badRequest" + "401": + $ref: "#/components/responses/unauthorized" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Return one Atlas Resource Policy + tags: + - Resource Policies + patch: + description: Update one Atlas Resource Policy for an org. + externalDocs: + description: Atlas Resource Policies + url: https://docs.atlas.mongodb.com + operationId: updateAtlasResourcePolicy + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/pretty" + - $ref: "#/components/parameters/orgId" + - description: Unique 24-hexadecimal digit string that identifies an atlas resource + policy. + in: path + name: resourcePolicyId + required: true + schema: + type: string + description: Unique 24-hexadecimal character string that identifies the + atlas resource policy. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + requestBody: + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/ApiAtlasResourcePolicyEditView" + x-xgen-version: 2024-08-05 + description: Atlas Resource Policy to update. + required: true + responses: + "200": + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/ApiAtlasResourcePolicyView" + x-xgen-version: 2024-08-05 + description: Ok + "400": + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/ApiAtlasInvalidResourcePolicyCreateErrorView" + x-xgen-version: 2024-08-05 + description: Bad request. + "401": + $ref: "#/components/responses/unauthorized" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Update one Atlas Resource Policy + tags: + - Resource Policies + /api/atlas/v2/orgs/{orgId}/resourcePolicies:validate: + post: + description: Validate one Atlas Resource Policy for an org. + externalDocs: + description: Atlas Resource Policies + url: https://docs.atlas.mongodb.com + operationId: validateAtlasResourcePolicy + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/pretty" + - $ref: "#/components/parameters/orgId" + requestBody: + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/ApiAtlasResourcePolicyCreateView" + x-xgen-version: 2024-08-05 + description: Atlas Resource Policy to create. + required: true + responses: + "200": + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/ApiAtlasResourcePolicyView" + x-xgen-version: 2024-08-05 + description: Ok + "400": + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/ApiAtlasInvalidResourcePolicyCreateErrorView" + x-xgen-version: 2024-08-05 + description: Bad request. + "401": + $ref: "#/components/responses/unauthorized" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Validate one Atlas Resource Policy + tags: + - Resource Policies /api/atlas/v2/orgs/{orgId}/serviceAccounts: get: - description: Returns list of Service Accounts with service account details. + description: Returns all Service Accounts for the specified Organization. Available + as a preview feature. operationId: listServiceAccounts parameters: - $ref: "#/components/parameters/orgId" @@ -17546,10 +18555,10 @@ paths: responses: "200": content: - application/vnd.atlas.2023-10-01+json: + application/vnd.atlas.2024-08-05+json: schema: $ref: "#/components/schemas/PaginatedOrgServiceAccounts" - x-xgen-version: 2023-10-01 + x-xgen-version: 2024-08-05 description: OK "401": $ref: "#/components/responses/unauthorized" @@ -17559,11 +18568,12 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Return All Service Accounts + summary: List All Organization Service Accounts tags: - - Organizations + - Service Accounts post: - description: Create Service Account containing client id and client secrets. + description: Creates one Service Account for the specified Organization. Available + as a preview feature. operationId: createServiceAccount parameters: - $ref: "#/components/parameters/orgId" @@ -17571,18 +18581,18 @@ paths: - $ref: "#/components/parameters/pretty" requestBody: content: - application/vnd.atlas.2023-10-01+json: + application/vnd.atlas.2024-08-05+json: schema: $ref: "#/components/schemas/OrgServiceAccountRequest" - description: Details to create service account in the specified organization. + description: Details of the new Service Account. required: true responses: "201": content: - application/vnd.atlas.2023-10-01+json: + application/vnd.atlas.2024-08-05+json: schema: $ref: "#/components/schemas/OrgServiceAccount" - x-xgen-version: 2023-10-01 + x-xgen-version: 2024-08-05 description: Created "400": $ref: "#/components/responses/badRequest" @@ -17592,28 +18602,30 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Service Account Creation + summary: Create one Organization Service Account tags: - - Organizations - /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}: + - Service Accounts + /api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}: delete: - description: Delete Service Account. + description: Deletes the specified Service Account. Available as a preview feature. operationId: deleteServiceAccount parameters: - - description: Id of the service account. + - description: The Client ID of the Service Account. in: path - name: serviceAccountId + name: clientId required: true schema: type: string + example: mdb_sa_id_667066535bc75b03c37b3038 + pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" - $ref: "#/components/parameters/orgId" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/pretty" responses: "204": content: - application/vnd.atlas.2023-10-01+json: - x-xgen-version: 2023-10-01 + application/vnd.atlas.2024-08-05+json: + x-xgen-version: 2024-08-05 description: This endpoint does not return a response body. "401": $ref: "#/components/responses/unauthorized" @@ -17623,29 +18635,31 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Service Account Deletion. + summary: Delete one Organization Service Account tags: - - Organizations + - Service Accounts get: - description: Get Service Account Details. + description: Returns the specified Service Account. Available as a preview feature. operationId: getServiceAccount parameters: - $ref: "#/components/parameters/orgId" - - description: Id of the service account. + - description: The Client ID of the Service Account. in: path - name: serviceAccountId + name: clientId required: true schema: type: string + example: mdb_sa_id_667066535bc75b03c37b3038 + pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/pretty" responses: "200": content: - application/vnd.atlas.2023-10-01+json: + application/vnd.atlas.2024-08-05+json: schema: $ref: "#/components/schemas/OrgServiceAccount" - x-xgen-version: 2023-10-01 + x-xgen-version: 2024-08-05 description: OK "401": $ref: "#/components/responses/unauthorized" @@ -17655,36 +18669,39 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Service Account Fetching + summary: Get one Organization Service Account tags: - - Organizations + - Service Accounts patch: - description: Update Service Account. + description: Updates the specified Service Account in the specified Organization. + Available as a preview feature. operationId: updateServiceAccount parameters: - - description: Id of the service account. + - description: The Client ID of the Service Account. in: path - name: serviceAccountId + name: clientId required: true schema: type: string + example: mdb_sa_id_667066535bc75b03c37b3038 + pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" - $ref: "#/components/parameters/orgId" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/pretty" requestBody: content: - application/vnd.atlas.2023-10-01+json: + application/vnd.atlas.2024-08-05+json: schema: $ref: "#/components/schemas/OrgServiceAccountUpdateRequest" - description: Details to update service account in the specified organization. + description: The new details for the Service Account. required: true responses: "200": content: - application/vnd.atlas.2023-10-01+json: + application/vnd.atlas.2024-08-05+json: schema: $ref: "#/components/schemas/OrgServiceAccount" - x-xgen-version: 2023-10-01 + x-xgen-version: 2024-08-05 description: OK "400": $ref: "#/components/responses/badRequest" @@ -17696,21 +18713,24 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Service Account Update + summary: Update one Organization Service Account tags: - - Organizations - /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/groups: + - Service Accounts + /api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/groups: get: - description: Returns list of Service Account projects. + description: Returns a list of all projects the specified Service Account is + a part of. Available as a preview feature. operationId: listServiceAccountProjects parameters: - $ref: "#/components/parameters/orgId" - - description: Id of the service account. + - description: The Client ID of the Service Account. in: path - name: serviceAccountId + name: clientId required: true schema: type: string + example: mdb_sa_id_667066535bc75b03c37b3038 + pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" - $ref: "#/components/parameters/itemsPerPage" - $ref: "#/components/parameters/pageNum" - $ref: "#/components/parameters/pretty" @@ -17718,10 +18738,10 @@ paths: responses: "200": content: - application/vnd.atlas.2023-10-01+json: + application/vnd.atlas.2024-08-05+json: schema: $ref: "#/components/schemas/PaginatedServiceAccountGroup" - x-xgen-version: 2023-10-01 + x-xgen-version: 2024-08-05 description: OK "401": $ref: "#/components/responses/unauthorized" @@ -17731,37 +18751,40 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Return All Service Account projects + summary: Return All Service Account Project assignments tags: - - Organizations - /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets: + - Service Accounts + /api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/secrets: post: - description: Create Service Account secret. + description: Create a secret for the specified Service Account. Available as + a preview feature. operationId: createServiceAccountSecret parameters: - $ref: "#/components/parameters/orgId" - - description: Id of the service account. + - description: The Client ID of the Service Account. in: path - name: serviceAccountId + name: clientId required: true schema: type: string + example: mdb_sa_id_667066535bc75b03c37b3038 + pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/pretty" requestBody: content: - application/vnd.atlas.2023-10-01+json: + application/vnd.atlas.2024-08-05+json: schema: $ref: "#/components/schemas/ServiceAccountSecretRequest" - description: Details to create secret in the specified service account. + description: Details for the new secret. required: true responses: "201": content: - application/vnd.atlas.2023-10-01+json: + application/vnd.atlas.2024-08-05+json: schema: $ref: "#/components/schemas/ServiceAccountSecret" - x-xgen-version: 2023-10-01 + x-xgen-version: 2024-08-05 description: Created "400": $ref: "#/components/responses/badRequest" @@ -17771,21 +18794,24 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Service Account Secret Creation + summary: Create one Organization Service Account Secret tags: - - Organizations - /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets/{secretId}: + - Service Accounts + /api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/secrets/{secretId}: delete: - description: Delete Service Account Secret. + description: Deletes the specified Service Account secret. Available as a preview + feature. operationId: deleteServiceAccountSecret parameters: - - description: Id of the service account. + - description: The Client ID of the Service Account. in: path - name: serviceAccountId + name: clientId required: true schema: type: string - - description: Id of the secret. + example: mdb_sa_id_667066535bc75b03c37b3038 + pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" + - description: Unique 24-hexadecimal digit string that identifies the secret. in: path name: secretId required: true @@ -17797,8 +18823,8 @@ paths: responses: "204": content: - application/vnd.atlas.2023-10-01+json: - x-xgen-version: 2023-10-01 + application/vnd.atlas.2024-08-05+json: + x-xgen-version: 2024-08-05 description: This endpoint does not return a response body. "401": $ref: "#/components/responses/unauthorized" @@ -17808,9 +18834,9 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Service Account Secret Deletion. + summary: Delete a Organization Service Account Secret tags: - - Organizations + - Service Accounts /api/atlas/v2/orgs/{orgId}/settings: get: description: "Returns details about the specified organization's settings. To\ @@ -17865,6 +18891,8 @@ paths: $ref: "#/components/schemas/OrganizationSettings" x-xgen-version: 2023-01-01 description: OK + "400": + $ref: "#/components/responses/badRequest" "401": $ref: "#/components/responses/unauthorized" "403": @@ -18337,15 +19365,58 @@ paths: summary: Return All MongoDB Cloud Users in One Organization tags: - Organizations + post: + description: |- + Invites one new or existing MongoDB Cloud user to join the organization. The invitation to join the organization will be sent to the username provided and must be accepted within 30 days. To use this resource, the requesting API Key must have the Organization Owner role. + + **Note**: If the user does not have an existing MongoDB Cloud account, they will be prompted to finish setting up an account upon accepting the invitation. If the user already has an account, they will still receive an invitation to access the organization. + operationId: createOrganizationUser + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/orgId" + - $ref: "#/components/parameters/pretty" + requestBody: + content: + application/vnd.atlas.2025-01-01+json: + schema: + $ref: "#/components/schemas/OrgUserRequest" + description: Represents the MongoDB Cloud user to be created within the organization. + required: true + responses: + "201": + content: + application/vnd.atlas.2025-01-01+json: + schema: + $ref: "#/components/schemas/OrgUserResponse" + x-xgen-version: 2025-01-01 + description: Created + "400": + $ref: "#/components/responses/badRequest" + "401": + $ref: "#/components/responses/unauthorized" + "403": + $ref: "#/components/responses/forbidden" + "404": + $ref: "#/components/responses/notFound" + "409": + $ref: "#/components/responses/conflict" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Create One MongoDB Cloud User in One Organization + tags: + - MongoDB Cloud Users /api/atlas/v2/orgs/{orgId}/users/{userId}: delete: description: "Removes one MongoDB Cloud user from the specified organization.\ \ To use this resource, the requesting API Key must have the Organization\ - \ User Admin role." + \ User Admin role. Deprecated versions: v2-{2023-01-01}" operationId: removeOrganizationUser parameters: - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/orgId" + - $ref: "#/components/parameters/pretty" - description: Unique 24-hexadecimal digit string that identifies the user to be deleted. in: path @@ -18359,10 +19430,10 @@ paths: responses: "204": content: - application/vnd.atlas.2023-01-01+json: + application/vnd.atlas.2025-01-01+json: schema: $ref: "#/components/schemas/NoBody" - x-xgen-version: 2023-01-01 + x-xgen-version: 2025-01-01 description: This endpoint does not return a response body. "400": $ref: "#/components/responses/badRequest" @@ -18376,9 +19447,110 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Remove One MongoDB Cloud User from One Organization + summary: Remove One MongoDB Cloud User From One Organization tags: - Organizations + get: + description: |- + Returns information about the specified MongoDB Cloud user within the context of the specified organization. To use this resource, the requesting API Key must have the Organization Read Only role. + + **Note**: This resource can only be used to fetch information about MongoDB Cloud human users. To return information about an API Key, use the [Return One Organization API Key](#tag/Programmatic-API-Keys/operation/getApiKey) endpoint. + + **Note**: This resource does not return information about pending users invited via the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint. + operationId: getOrganizationUser + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/orgId" + - $ref: "#/components/parameters/pretty" + - description: "Unique 24-hexadecimal digit string that identifies the pending\ + \ or active user in the organization. If you need to lookup a user's userId\ + \ or verify a user's status in the organization, use the Return All MongoDB\ + \ Cloud Users in One Organization resource and filter by username." + in: path + name: userId + required: true + schema: + type: string + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + responses: + "200": + content: + application/vnd.atlas.2025-01-01+json: + schema: + $ref: "#/components/schemas/OrgUserResponse" + x-xgen-version: 2025-01-01 + description: OK + "400": + $ref: "#/components/responses/badRequest" + "401": + $ref: "#/components/responses/unauthorized" + "403": + $ref: "#/components/responses/forbidden" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Return One MongoDB Cloud User in One Organization + tags: + - MongoDB Cloud Users + patch: + description: |- + Updates one MongoDB Cloud user in the specified organization. You can update an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting API Key must have the Organization Owner role. + + **Note**: Only include the fields you wish to update in the request body. Supplying a field with an empty value will reset that field on the user. + + **Note**: This resource cannot be used to update pending users invited via the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint. + operationId: updateOrganizationUser + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/orgId" + - $ref: "#/components/parameters/pretty" + - description: "Unique 24-hexadecimal digit string that identifies the pending\ + \ or active user in the organization. If you need to lookup a user's userId\ + \ or verify a user's status in the organization, use the Return All MongoDB\ + \ Cloud Users in One Organization resource and filter by username." + in: path + name: userId + required: true + schema: + type: string + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + requestBody: + content: + application/vnd.atlas.2025-01-01+json: + schema: + $ref: "#/components/schemas/OrgUserUpdateRequest" + description: Represents the roles and teams to assign the MongoDB Cloud user. + required: true + responses: + "200": + content: + application/vnd.atlas.2025-01-01+json: + schema: + $ref: "#/components/schemas/OrgUserResponse" + x-xgen-version: 2025-01-01 + description: OK + "400": + $ref: "#/components/responses/badRequest" + "401": + $ref: "#/components/responses/unauthorized" + "403": + $ref: "#/components/responses/forbidden" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Update One MongoDB Cloud User in One Organization + tags: + - MongoDB Cloud Users /api/atlas/v2/orgs/{orgId}/users/{userId}/roles: put: description: "Updates the roles of the specified user in the specified organization.\ @@ -18428,6 +19600,128 @@ paths: summary: Update Organization Roles for One MongoDB Cloud User tags: - Organizations + /api/atlas/v2/orgs/{orgId}/users/{userId}:addRole: + post: + description: |- + Adds one organization level role to the MongoDB Cloud user. You can add a role to an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting API Key must have the Organization Owner role. + + **Note**: This operation is atomic. + + **Note**: This resource cannot be used to add a role to users invited using the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint. + operationId: addOrganizationRole + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/orgId" + - $ref: "#/components/parameters/pretty" + - description: "Unique 24-hexadecimal digit string that identifies the pending\ + \ or active user in the organization. If you need to lookup a user's userId\ + \ or verify a user's status in the organization, use the Return All MongoDB\ + \ Cloud Users in One Organization resource and filter by username." + in: path + name: userId + required: true + schema: + type: string + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + - description: Organization level role to assign to the MongoDB Cloud user. + in: query + name: role + required: true + schema: + type: string + enum: + - ORG_OWNER + - ORG_GROUP_CREATOR + - ORG_BILLING_ADMIN + - ORG_BILLING_READ_ONLY + - ORG_READ_ONLY + - ORG_MEMBER + responses: + "200": + content: + application/vnd.atlas.2025-01-01+json: + schema: + $ref: "#/components/schemas/OrgUserResponse" + x-xgen-version: 2025-01-01 + description: OK + "400": + $ref: "#/components/responses/badRequest" + "401": + $ref: "#/components/responses/unauthorized" + "403": + $ref: "#/components/responses/forbidden" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Add One Organization Role to One MongoDB Cloud User + tags: + - MongoDB Cloud Users + /api/atlas/v2/orgs/{orgId}/users/{userId}:removeRole: + post: + description: |- + Removes one organization level role from the MongoDB Cloud user. You can remove a role from an active user or a user that has not yet accepted the invitation to join the organization. To replace a user's only role, add the new role before removing the old role. A user must have at least one role at all times. To use this resource, the requesting API Key must have the Organization Owner role. + + **Note**: This operation is atomic. + + **Note**: This resource cannot be used to remove a role from users invited using the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint. + operationId: removeOrganizationRole + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/orgId" + - $ref: "#/components/parameters/pretty" + - description: "Unique 24-hexadecimal digit string that identifies the pending\ + \ or active user in the organization. If you need to lookup a user's userId\ + \ or verify a user's status in the organization, use the Return All MongoDB\ + \ Cloud Users in One Organization resource and filter by username." + in: path + name: userId + required: true + schema: + type: string + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + - description: Organization level role to remove from the MongoDB Cloud user. + in: query + name: role + required: true + schema: + type: string + enum: + - ORG_OWNER + - ORG_GROUP_CREATOR + - ORG_BILLING_ADMIN + - ORG_BILLING_READ_ONLY + - ORG_READ_ONLY + - ORG_MEMBER + responses: + "200": + content: + application/vnd.atlas.2025-01-01+json: + schema: + $ref: "#/components/schemas/OrgUserResponse" + x-xgen-version: 2025-01-01 + description: OK + "400": + $ref: "#/components/responses/badRequest" + "401": + $ref: "#/components/responses/unauthorized" + "403": + $ref: "#/components/responses/forbidden" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Remove One Organization Role from One MongoDB Cloud User + tags: + - MongoDB Cloud Users /api/atlas/v2/unauth/controlPlaneIPAddresses: get: description: "Returns all control plane IP addresses. Currently, inbound Atlas\ @@ -18450,6 +19744,43 @@ paths: summary: Return All Control Plane IP Addresses tags: - Root + /api/atlas/v2/unauth/openapi/versions: + get: + description: API that provides a list of available versionsfor a given environment. + operationId: getApiVersions + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/itemsPerPage" + - $ref: "#/components/parameters/pageNum" + - $ref: "#/components/parameters/pretty" + - description: "The environment to get the versions from. If not provided, it\ + \ returnsthe versions for the given MongoDB URL. (E.g. prod for cloud.mongodb.com)" + in: query + name: env + schema: + type: string + enum: + - dev + - qa + - prod + - stage + responses: + "200": + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/PaginatedApiVersions" + x-xgen-version: 2024-08-05 + application/vnd.atlas.2024-08-05+yaml: + schema: + $ref: "#/components/schemas/PaginatedApiVersions" + x-xgen-version: 2024-08-05 + description: OK + "500": + $ref: "#/components/responses/internalServerError" + summary: Provides a list of versions for a given environment. + tags: + - OpenAPI /api/atlas/v2/users: post: description: |- @@ -19205,7 +20536,7 @@ components: description: |- Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. - Change this parameter only if you: + 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). @@ -19281,7 +20612,7 @@ components: You can set different IOPS values on different shards when provisioned IOPS are supported. - Change this parameter only if you: + 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). @@ -19712,6 +21043,31 @@ components: - REPLICASET - SHARDED - GEOSHARDED + configServerManagementMode: + type: string + default: ATLAS_MANAGED + description: |- + Config Server Management Mode for creating or updating a sharded cluster. + + When configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings. + + When configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server. + enum: + - ATLAS_MANAGED + - FIXED_TO_DEDICATED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + configServerType: + type: string + description: Describes a sharded cluster's config server type. + enum: + - DEDICATED + - EMBEDDED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + readOnly: true connectionStrings: $ref: "#/components/schemas/ClusterConnectionStrings" createDate: @@ -19759,6 +21115,15 @@ components: externalDocs: description: Encryption at Rest using Customer Key Management url: https://www.mongodb.com/docs/atlas/security-kms-encryption/ + featureCompatibilityVersion: + type: string + description: Feature compatibility version of the cluster. + readOnly: true + featureCompatibilityVersionExpirationDate: + type: string + format: date-time + description: Feature compatibility version expiration date. + readOnly: true globalClusterSelfManagedSharding: type: boolean description: |- @@ -19809,6 +21174,8 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true + mongoDBEmployeeAccessGrant: + $ref: "#/components/schemas/EmployeeAccessGrantView" mongoDBMajorVersion: type: string description: |- @@ -19830,7 +21197,7 @@ components: description: Human-readable label that identifies the advanced cluster. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" paused: type: boolean description: Flag that indicates whether the cluster is paused. @@ -19841,6 +21208,24 @@ components: externalDocs: description: Continuous Cloud Backups url: https://docs.atlas.mongodb.com/backup/cloud-backup/overview/ + replicaSetScalingStrategy: + type: string + default: WORKLOAD_TYPE + description: |- + Set this field to configure the replica set scaling mode for your cluster. + + By default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes. + + When configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads. + + When configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads. + enum: + - SEQUENTIAL + - WORKLOAD_TYPE + - NODE_TYPE + externalDocs: + description: Modify the Replica Set Scaling Mode + url: https://dochub.mongodb.org/core/scale-nodes replicationSpecs: type: array description: "List of settings that configure your cluster regions. For\ @@ -20719,6 +22104,246 @@ components: description: Atlas Search Index url: https://dochub.mongodb.org/core/index-definitions-fts title: mappings + ApiAtlasInvalidPolicyErrorDetailView: + type: object + properties: + detail: + type: string + description: A string that provides a detailed description of a validation + error. + readOnly: true + ApiAtlasInvalidPolicyView: + type: object + properties: + body: + type: string + description: A string that defines the permissions for the policy. The syntax + used is the Cedar Policy language. + example: |2 + forbid ( + principal, + action == cloud::Action::"cluster.createEdit", + resource + ) when { + context.cluster.regions.contains(cloud::region::"aws:us-east-1") + }; + readOnly: true + errors: + type: array + description: List of validation errors. + items: + $ref: "#/components/schemas/ApiAtlasInvalidPolicyErrorDetailView" + readOnly: true + ApiAtlasInvalidResourcePolicyCreateErrorView: + type: object + properties: + errorType: + type: string + description: Human-readable label that displays the type of an error. + enum: + - POLICY_PARSING_ERROR + - POLICY_HAS_FAILED_VALIDATIONS + - POLICY_HAS_INVALID_PRINCIPAL + - POLICY_HAS_BODY_EXCEEDING_MAX_SIZE + - POLICY_HAS_UNEXPECTED_ENTITIES + invalidPolicies: + type: array + description: List of invalid policies containing details of their validation + errors. + items: + $ref: "#/components/schemas/ApiAtlasInvalidPolicyView" + readOnly: true + ApiAtlasNonCompliantResourceView: + type: object + properties: + orgId: + type: string + description: Unique 24-hexadecimal character string that identifies the + organization the resource belongs to. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + resourceId: + type: string + description: Unique 24-hexadecimal character string that identifies the + non-compliant resource. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + resourcePoliciesCausingNonCompliance: + type: array + description: List of resource policies causing the resource to be considered + non-compliant. + items: + $ref: "#/components/schemas/ApiAtlasResourcePolicyMetadataView" + readOnly: true + resourceType: + type: string + description: Human-readable label that displays the type of a resource. + enum: + - PROJECT + - CLUSTER + readOnly: true + ApiAtlasPolicyCreateView: + type: object + properties: + body: + type: string + description: A string that defines the permissions for the policy. The syntax + used is the Cedar Policy language. + example: |2 + forbid ( + principal, + action == cloud::Action::"cluster.createEdit", + resource + ) when { + context.cluster.regions.contains(cloud::region::"aws:us-east-1") + }; + required: + - body + ApiAtlasPolicyMetadataView: + type: object + properties: + policyId: + type: string + description: Unique 24-hexadecimal character string that identifies the + policy. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + ApiAtlasPolicyView: + type: object + properties: + body: + type: string + description: A string that defines the permissions for the policy. The syntax + used is the Cedar Policy language. + example: |2 + forbid ( + principal, + action == cloud::Action::"cluster.createEdit", + resource + ) when { + context.cluster.regions.contains(cloud::region::"aws:us-east-1") + }; + readOnly: true + id: + type: string + description: Unique 24-hexadecimal character string that identifies the + policy. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + ApiAtlasResourcePolicyCreateView: + type: object + properties: + name: + type: string + description: Human-readable label that describes the atlas resource policy. + policies: + type: array + description: List of policies that make up the atlas resource policy. + items: + $ref: "#/components/schemas/ApiAtlasPolicyCreateView" + required: + - name + - policies + ApiAtlasResourcePolicyEditView: + type: object + properties: + name: + type: string + description: Human-readable label that describes the atlas resource policy. + policies: + type: array + description: List of policies that make up the atlas resource policy. + items: + $ref: "#/components/schemas/ApiAtlasPolicyCreateView" + ApiAtlasResourcePolicyMetadataView: + type: object + properties: + policiesCausingNonCompliance: + type: array + description: List of policies that are in conflict with the current state + of the resource. + items: + $ref: "#/components/schemas/ApiAtlasPolicyMetadataView" + readOnly: true + resourcePolicyId: + type: string + description: Unique 24-hexadecimal character string that identifies the + atlas resource policy. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + resourcePolicyName: + type: string + description: Human-readable label that describes the atlas resource policy. + readOnly: true + ApiAtlasResourcePolicyView: + type: object + properties: + createdByUser: + $ref: "#/components/schemas/ApiAtlasUserMetadataView" + createdDate: + type: string + format: date-time + description: Date and time in UTC when the atlas resource policy was created. + example: 2022-01-01T00:00:00Z + readOnly: true + id: + type: string + description: Unique 24-hexadecimal character string that identifies the + atlas resource policy. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + lastUpdatedByUser: + $ref: "#/components/schemas/ApiAtlasUserMetadataView" + lastUpdatedDate: + type: string + format: date-time + description: Date and time in UTC when the atlas resource policy was last + updated. + example: 2022-01-01T00:00:00Z + readOnly: true + name: + type: string + description: Human-readable label that describes the atlas resource policy. + readOnly: true + orgId: + type: string + description: Unique 24-hexadecimal character string that identifies the + organization the atlas resource policy belongs to. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + policies: + type: array + description: List of policies that make up the atlas resource policy. + items: + $ref: "#/components/schemas/ApiAtlasPolicyView" + readOnly: true + version: + type: string + description: A string that identifies the version of the atlas resource + policy. + example: v1 + readOnly: true ApiAtlasSnapshotScheduleView: type: object properties: @@ -20855,6 +22480,23 @@ components: - snapshotIntervalHours - snapshotRetentionDays - weeklySnapshotRetentionWeeks + ApiAtlasUserMetadataView: + type: object + description: The user that last updated the atlas resource policy. + properties: + id: + type: string + description: Unique 24-hexadecimal character string that identifies a user. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + name: + type: string + description: Human-readable label that describes a user. + readOnly: true + readOnly: true ApiBSONTimestampView: type: object description: BSON timestamp that indicates when the checkpoint token entry in @@ -20911,6 +22553,8 @@ components: ApiError: type: object properties: + badRequestDetail: + $ref: "#/components/schemas/BadRequestDetail" detail: type: string description: Describes the specific conditions or reasons that cause each @@ -20921,17 +22565,25 @@ components: description: HTTP status code returned with this error. externalDocs: url: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status + readOnly: true 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. items: type: object + readOnly: true + readOnly: true reason: type: string description: Application error message returned with this error. + readOnly: true + required: + - error + - errorCode ApiHostView_Atlas: type: object properties: @@ -21220,6 +22872,23 @@ components: \ and **period** in the same request. This parameter expresses its value\ \ in the ISO 8601 timestamp format in UTC." readOnly: true + ApiPrivateDownloadDeliveryUrl: + type: object + description: One Uniform Resource Locator (URL) that points to the compressed + snapshot files for manual download and the corresponding private endpoint. + properties: + deliveryUrl: + type: string + description: One Uniform Resource Locator that points to the compressed + snapshot files for manual download. + endpointId: + type: string + description: Unique 22-character alphanumeric string that identifies the + private endpoint. + example: vpce-3bf78b0ddee411ba1 + maxLength: 22 + minLength: 22 + pattern: "^vpce-[0-9a-f]{17}$" ApiPublicUsageDetailsQueryRequest: type: object description: "Request body for an Invoice Usage Details query with filtering,\ @@ -21331,7 +23000,23 @@ components: type: string description: Atlas Streams AWS Regions. enum: + - SYDNEY_AUS + - MUMBAI_IND + - FRANKFURT_DEU + - DUBLIN_IRL + - LONDON_GBR + - VIRGINIA_USA + - OREGON_USA + - SAOPAULO_BRA + - MONTREAL_CAN + - TOKYO_JPN + - SINGAPORE_SGP + ApiStreamsAzureRegionView: + type: string + description: Atlas Streams Azure Regions. + enum: - VIRGINIA_USA + - AMSTERDAM_NLD ApiUserEventTypeViewForNdsGroup: type: string description: Unique identifier of event type. @@ -21578,6 +23263,12 @@ components: - eventTypeName - id title: API User Events + ApiVersion: + type: object + properties: + version: + type: string + description: Object representing a version of the Atlas Admin API. AppServiceAlertConfigViewForNdsGroup: type: object description: App Services metric alert configuration allows to select which @@ -22059,7 +23750,12 @@ components: enum: - AVERAGE operator: - $ref: "#/components/schemas/Operator" + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - LESS_THAN + - GREATER_THAN threshold: type: number format: double @@ -22137,6 +23833,12 @@ components: enum: - VIRGINIA_USA - AMSTERDAM_NLD + AtlasDataFederationGCPRegion: + type: string + description: Atlas Data Federation GCP Regions. + enum: + - IOWA_USA + - BELGIUM_EU AtlasOrganization: type: object description: Details that describe the organization. @@ -22172,6 +23874,128 @@ components: pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" required: - name + AtlasResourcePolicyAuditForOrg: + type: object + description: Atlas resource policy audits indicate org level changes to resource + policies + properties: + apiKeyId: + type: string + description: "Unique 24-hexadecimal digit string that identifies the [API\ + \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\ + \ triggered the event. If this resource returns this parameter, it doesn't\ + \ return the **userId** parameter." + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + created: + type: string + format: date-time + description: Date and time when this event occurred. This parameter expresses + its value in the ISO 8601 timestamp format in UTC. + readOnly: true + eventTypeName: + type: string + description: Unique identifier of event type. + enum: + - RESOURCE_POLICY_CREATED + - RESOURCE_POLICY_MODIFIED + - RESOURCE_POLICY_DELETED + example: RESOURCE_POLICY_CREATED + title: Atlas Resource Policy Audit Types + groupId: + type: string + description: Unique 24-hexadecimal digit string that identifies the project + in which the event occurred. The **eventId** identifies the specific event. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + id: + type: string + description: Unique 24-hexadecimal digit string that identifies the event. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + isGlobalAdmin: + type: boolean + default: false + description: Flag that indicates whether a MongoDB employee triggered the + specified event. + readOnly: true + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + orgId: + type: string + description: Unique 24-hexadecimal digit string that identifies the organization + to which these events apply. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + publicKey: + type: string + format: email + description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\ + \ that triggered the event. If this resource returns this parameter, it\ + \ doesn't return the **username** parameter." + readOnly: true + raw: + $ref: "#/components/schemas/raw" + remoteAddress: + type: string + description: IPv4 or IPv6 address from which the user triggered this event. + example: 216.172.40.186 + pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + readOnly: true + resourcePolicyId: + type: string + description: Unique 24-hexadecimal character string that identifies the + resource policy. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + userId: + type: string + description: "Unique 24-hexadecimal digit string that identifies the console\ + \ user who triggered the event. If this resource returns this parameter,\ + \ it doesn't return the **apiKeyId** parameter." + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + username: + type: string + format: email + description: "Email address for the user who triggered this event. If this\ + \ resource returns this parameter, it doesn't return the **publicApiKey**\ + \ parameter." + example: test.user@mongodb.com + readOnly: true + required: + - created + - eventTypeName + - id + title: Atlas Resource Policy Audits AtlasSearchAnalyzer: type: object properties: @@ -22893,6 +24717,21 @@ components: AzureHardwareSpec: type: object properties: + diskIOPS: + type: integer + format: int32 + description: |- + Target throughput desired for storage attached to your Azure-provisioned cluster. Change this parameter if you: + + - set `"replicationSpecs[n].regionConfigs[m].providerName" : "Azure"`. + - set `"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize" : "M40"` or greater not including `Mxx_NVME` tiers. + + The maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**. + This parameter defaults to the cluster tier's standard IOPS value. + Changing this value impacts cluster cost. + externalDocs: + description: Programmatic API Keys + url: https://www.mongodb.com/docs/atlas/customize-storage/#extend-iops-on-azure instanceSize: type: string description: Hardware specification for the instance sizes in this region. @@ -22930,6 +24769,21 @@ components: AzureHardwareSpec20240805: type: object properties: + diskIOPS: + type: integer + format: int32 + description: |- + Target throughput desired for storage attached to your Azure-provisioned cluster. Change this parameter if you: + + - set `"replicationSpecs[n].regionConfigs[m].providerName" : "Azure"`. + - set `"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize" : "M40"` or greater not including `Mxx_NVME` tiers. + + The maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**. + This parameter defaults to the cluster tier's standard IOPS value. + Changing this value impacts cluster cost. + externalDocs: + description: Programmatic API Keys + url: https://www.mongodb.com/docs/atlas/customize-storage/#extend-iops-on-azure diskSizeGB: type: number format: double @@ -23145,6 +24999,8 @@ components: - PENDING_ACCEPTANCE - ACTIVE - FAILED + - PENDING_RECREATION + - DELETING readOnly: true title: Azure Key Vault EAR Private Endpoint AzureNetworkPeeringConnectionSettings: @@ -23579,7 +25435,7 @@ components: the collection for which you want to create an online archive. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true collName: type: string @@ -23691,7 +25547,7 @@ components: the collection for which you want to create an online archive. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true collName: type: string @@ -23830,7 +25686,7 @@ components: the snapshots you want to retrieve. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -24043,7 +25899,7 @@ components: To return a response with the **clusterId** parameter, either use the **delivery.targetClusterName** parameter or enable backup on the target cluster. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" targetGroupId: type: string description: "Unique 24-hexadecimal digit string that identifies the project\ @@ -24315,12 +26171,23 @@ components: - FAILED - COMPLETED readOnly: true + BadRequestDetail: + type: object + description: Bad request detail. + properties: + fields: + type: array + description: Describes all violations in a client request. + items: + $ref: "#/components/schemas/FieldViolation" + readOnly: true BaseAtlasDataLakeRegion: type: object description: Name of the region to which the data lake routes client connections. oneOf: - $ref: "#/components/schemas/ApiAtlasDataLakeAWSRegionView" - $ref: "#/components/schemas/AtlasDataFederationAzureRegion" + - $ref: "#/components/schemas/AtlasDataFederationGCPRegion" BaseCloudProviderInstanceSize: type: object description: "Minimum instance size to which your cluster can automatically\ @@ -24448,6 +26315,7 @@ components: description: Name of the cloud provider region hosting Atlas Stream Processing. oneOf: - $ref: "#/components/schemas/ApiStreamsAWSRegionView" + - $ref: "#/components/schemas/ApiStreamsAzureRegionView" BasicBSONList: type: array description: "List that contains the search criteria that the query uses. To\ @@ -25535,7 +27403,7 @@ components: description: Human-readable label that identifies the cluster. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true nodeCount: type: integer @@ -25596,6 +27464,10 @@ components: 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. + description: + type: string + description: Description of this database user. + maxLength: 100 groupId: type: string description: Unique 24-hexadecimal digit string that identifies the project. @@ -25863,6 +27735,127 @@ components: (AWS) Identity and Access Management (IAM) role. required: - providerName + CloudProviderAccessAWSIAMRoleRequest: + type: object + description: Details that describe the features linked to the Amazon Web Services + (AWS) Identity and Access Management (IAM) role. + properties: + atlasAWSAccountArn: + 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. + example: arn:aws:iam::772401394250:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + readOnly: true + atlasAssumedRoleExternalId: + type: string + format: uuid + description: Unique external ID that MongoDB Cloud uses when it assumes + the IAM role in your Amazon Web Services (AWS) account. + readOnly: true + authorizedDate: + type: string + format: date-time + 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. + readOnly: true + createdDate: + type: string + format: date-time + 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. + readOnly: true + featureUsages: + type: array + description: List that contains application features associated with this + Amazon Web Services (AWS) Identity and Access Management (IAM) role. + items: + $ref: "#/components/schemas/CloudProviderAccessFeatureUsage" + readOnly: true + providerName: + type: string + description: Human-readable label that identifies the cloud provider of + the role. + enum: + - AWS + - AZURE + - GCP + roleId: + type: string + description: Unique 24-hexadecimal digit string that identifies the role. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + required: + - providerName + CloudProviderAccessAWSIAMRoleRequestUpdate: + type: object + allOf: + - $ref: "#/components/schemas/CloudProviderAccessRoleRequestUpdate" + - type: object + properties: + atlasAWSAccountArn: + 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. + example: arn:aws:iam::772401394250:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + readOnly: true + atlasAssumedRoleExternalId: + type: string + format: uuid + description: Unique external ID that MongoDB Cloud uses when it assumes + the IAM role in your Amazon Web Services (AWS) account. + readOnly: true + authorizedDate: + type: string + format: date-time + 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. + readOnly: true + createdDate: + type: string + format: date-time + 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. + readOnly: true + featureUsages: + type: array + description: List that contains application features associated with this + Amazon Web Services (AWS) Identity and Access Management (IAM) role. + items: + $ref: "#/components/schemas/CloudProviderAccessFeatureUsage" + readOnly: true + iamAssumedRoleArn: + 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 + maxLength: 2048 + minLength: 20 + roleId: + type: string + description: Unique 24-hexadecimal digit string that identifies the role. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + description: Details that describe the features linked to the Amazon Web Services + (AWS) Identity and Access Management (IAM) role. + required: + - providerName CloudProviderAccessAzureServicePrincipal: type: object allOf: @@ -25924,6 +27917,133 @@ components: Principal. required: - providerName + CloudProviderAccessAzureServicePrincipalRequest: + type: object + description: Details that describe the features linked to the Azure Service + Principal. + properties: + _id: + type: string + description: Unique 24-hexadecimal digit string that identifies the role. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + atlasAzureAppId: + type: string + description: Azure Active Directory Application ID of Atlas. + maxLength: 36 + minLength: 32 + pattern: "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\\ + b-[0-9a-fA-F]{12}$" + createdDate: + type: string + format: date-time + description: Date and time when this Azure Service Principal was created. + This parameter expresses its value in the ISO 8601 timestamp format in + UTC. + readOnly: true + featureUsages: + type: array + description: List that contains application features associated with this + Azure Service Principal. + items: + $ref: "#/components/schemas/CloudProviderAccessFeatureUsage" + readOnly: true + lastUpdatedDate: + type: string + format: date-time + 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. + 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. + maxLength: 36 + minLength: 32 + pattern: "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\\ + b-[0-9a-fA-F]{12}$" + tenantId: + type: string + description: UUID String that identifies the Azure Active Directory Tenant + ID. + maxLength: 36 + minLength: 32 + pattern: "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\\ + b-[0-9a-fA-F]{12}$" + required: + - providerName + CloudProviderAccessAzureServicePrincipalRequestUpdate: + type: object + allOf: + - $ref: "#/components/schemas/CloudProviderAccessRoleRequestUpdate" + - type: object + properties: + _id: + type: string + description: Unique 24-hexadecimal digit string that identifies the role. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + atlasAzureAppId: + type: string + description: Azure Active Directory Application ID of Atlas. + maxLength: 36 + minLength: 32 + pattern: "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\\ + b-[0-9a-fA-F]{12}$" + createdDate: + type: string + format: date-time + description: Date and time when this Azure Service Principal was created. + This parameter expresses its value in the ISO 8601 timestamp format + in UTC. + readOnly: true + featureUsages: + type: array + description: List that contains application features associated with this + Azure Service Principal. + items: + $ref: "#/components/schemas/CloudProviderAccessFeatureUsage" + readOnly: true + lastUpdatedDate: + type: string + format: date-time + 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. + readOnly: true + servicePrincipalId: + type: string + description: UUID string that identifies the Azure Service Principal. + maxLength: 36 + minLength: 32 + pattern: "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\\ + b-[0-9a-fA-F]{12}$" + tenantId: + type: string + description: UUID String that identifies the Azure Active Directory Tenant + ID. + maxLength: 36 + minLength: 32 + pattern: "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\\ + b-[0-9a-fA-F]{12}$" + description: Details that describe the features linked to the Azure Service + Principal. + required: + - providerName CloudProviderAccessDataLakeFeatureUsage: type: object allOf: @@ -26036,6 +28156,85 @@ components: minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true + CloudProviderAccessGCPServiceAccount: + type: object + allOf: + - $ref: "#/components/schemas/CloudProviderAccessRole" + - type: object + properties: + createdDate: + type: string + format: date-time + description: Date and time when this Google Service Account was created. + This parameter expresses its value in the ISO 8601 timestamp format + in UTC. + readOnly: true + featureUsages: + type: array + description: List that contains application features associated with this + Google Service Account. + items: + $ref: "#/components/schemas/CloudProviderAccessFeatureUsage" + readOnly: true + gcpServiceAccountForAtlas: + type: string + description: Email address for the Google Service Account created by Atlas. + maxLength: 82 + minLength: 57 + pattern: "^mongodb-atlas-[0-9a-z]{16}@p-[0-9a-z]{24}.iam.gserviceaccount.com$" + roleId: + type: string + description: Unique 24-hexadecimal digit string that identifies the role. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + description: Details that describe the features linked to the GCP Service Account. + required: + - providerName + CloudProviderAccessGCPServiceAccountRequest: + type: object + description: Details that describe the features linked to the GCP Service Account. + properties: + createdDate: + type: string + format: date-time + description: Date and time when this GCP Service Account was created. This + parameter expresses its value in the ISO 8601 timestamp format in UTC. + readOnly: true + featureUsages: + type: array + description: List that contains application features associated with this + GCP Service Account. + items: + $ref: "#/components/schemas/CloudProviderAccessFeatureUsage" + readOnly: true + 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: + type: string + description: Unique 24-hexadecimal digit string that identifies the role. + readOnly: true + required: + - providerName + CloudProviderAccessGCPServiceAccountRequestUpdate: + type: object + allOf: + - $ref: "#/components/schemas/CloudProviderAccessRoleRequestUpdate" + description: Details that describe the features linked to the GCP Service Account. + required: + - providerName CloudProviderAccessPushBasedLogExportFeatureUsage: type: object allOf: @@ -26054,10 +28253,52 @@ components: mapping: AWS: "#/components/schemas/CloudProviderAccessAWSIAMRole" AZURE: "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + GCP: "#/components/schemas/CloudProviderAccessGCPServiceAccount" + propertyName: providerName + properties: + providerName: + type: string + description: Human-readable label that identifies the cloud provider of + the role. + enum: + - AWS + - AZURE + - GCP + required: + - providerName + CloudProviderAccessRoleRequest: + type: object + description: Cloud provider access role. + discriminator: + mapping: + AWS: "#/components/schemas/CloudProviderAccessAWSIAMRoleRequest" + AZURE: "#/components/schemas/CloudProviderAccessAzureServicePrincipalRequest" + GCP: "#/components/schemas/CloudProviderAccessGCPServiceAccountRequest" propertyName: providerName oneOf: - - $ref: "#/components/schemas/CloudProviderAccessAWSIAMRole" - - $ref: "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + - $ref: "#/components/schemas/CloudProviderAccessAWSIAMRoleRequest" + - $ref: "#/components/schemas/CloudProviderAccessAzureServicePrincipalRequest" + - $ref: "#/components/schemas/CloudProviderAccessGCPServiceAccountRequest" + properties: + providerName: + type: string + description: Human-readable label that identifies the cloud provider of + the role. + enum: + - AWS + - AZURE + - GCP + required: + - providerName + CloudProviderAccessRoleRequestUpdate: + type: object + description: Cloud provider access role. + discriminator: + mapping: + AWS: "#/components/schemas/CloudProviderAccessAWSIAMRoleRequestUpdate" + AZURE: "#/components/schemas/CloudProviderAccessAzureServicePrincipalRequestUpdate" + GCP: "#/components/schemas/CloudProviderAccessGCPServiceAccountRequestUpdate" + propertyName: providerName properties: providerName: type: string @@ -26066,6 +28307,7 @@ components: enum: - AWS - AZURE + - GCP required: - providerName CloudProviderAccessRoles: @@ -26077,6 +28319,12 @@ components: registered and authorized with MongoDB Cloud. items: $ref: "#/components/schemas/CloudProviderAccessAWSIAMRole" + azureServicePrincipals: + type: array + description: List that contains the Azure Service Principals registered + with MongoDB Cloud. + items: + $ref: "#/components/schemas/CloudProviderAccessAzureServicePrincipal" CloudProviderAzureAutoScaling: type: object description: Range of instance sizes to which your cluster can scale. @@ -26745,7 +28993,7 @@ components: example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -26849,6 +29097,7 @@ components: $ref: "#/components/schemas/ClusterComputeAutoScaling" diskGBEnabled: type: boolean + default: false description: Flag that indicates whether someone enabled disk auto-scaling for this cluster. title: Automatic Cluster Scaling Settings @@ -26875,12 +29124,14 @@ components: properties: enabled: type: boolean + default: false description: "Flag that indicates whether cluster tier auto-scaling is enabled.\ \ Set to `true` to enable cluster tier auto-scaling. If enabled, you must\ \ specify a value for **providerSettings.autoScaling.compute.maxInstanceSize**\ \ also. Set to `false` to disable cluster tier auto-scaling." scaleDownEnabled: type: boolean + default: false description: "Flag that indicates whether the cluster tier can scale down.\ \ This is required if **autoScaling.compute.enabled** is `true`. If you\ \ enable this option, specify a value for **providerSettings.autoScaling.compute.minInstanceSize**." @@ -26918,20 +29169,28 @@ components: 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. + description: "Private endpoint-aware connection strings that use AWS-hosted\ + \ clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies\ + \ an Amazon Web Services (AWS) interface endpoint. Each value identifies\ + \ the related `mongodb://` connection string that you use to connect\ + \ to Atlas through the interface endpoint that the key names. If the\ + \ cluster uses an optimized connection string, `awsPrivateLinkSrv` contains\ + \ the optimized connection string. If the cluster has the non-optimized\ + \ (legacy) connection string, `awsPrivateLinkSrv` contains the non-optimized\ + \ connection string even if an optimized connection string is also present." externalDocs: description: Network Peering Connection url: https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/ readOnly: true - 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. + description: "Private endpoint-aware connection strings that use AWS-hosted\ + \ clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies\ + \ an Amazon Web Services (AWS) interface endpoint. Each value identifies\ + \ the related `mongodb://` connection string that you use to connect to\ + \ Atlas through the interface endpoint that the key names. If the cluster\ + \ uses an optimized connection string, `awsPrivateLinkSrv` contains the\ + \ optimized connection string. If the cluster has the non-optimized (legacy)\ + \ connection string, `awsPrivateLinkSrv` contains the non-optimized connection\ + \ string even if an optimized connection string is also present." externalDocs: description: Network Peering Connection url: https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/ @@ -27033,6 +29292,31 @@ components: - REPLICASET - SHARDED - GEOSHARDED + configServerManagementMode: + type: string + default: ATLAS_MANAGED + description: |- + Config Server Management Mode for creating or updating a sharded cluster. + + When configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings. + + When configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server. + enum: + - ATLAS_MANAGED + - FIXED_TO_DEDICATED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + configServerType: + type: string + description: Describes a sharded cluster's config server type. + enum: + - DEDICATED + - EMBEDDED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + readOnly: true connectionStrings: $ref: "#/components/schemas/ClusterConnectionStrings" createDate: @@ -27066,6 +29350,15 @@ components: externalDocs: description: Encryption at Rest using Customer Key Management url: https://www.mongodb.com/docs/atlas/security-kms-encryption/ + featureCompatibilityVersion: + type: string + description: Feature compatibility version of the cluster. + readOnly: true + featureCompatibilityVersionExpirationDate: + type: string + format: date-time + description: Feature compatibility version expiration date. + readOnly: true globalClusterSelfManagedSharding: type: boolean description: |- @@ -27116,6 +29409,8 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true + mongoDBEmployeeAccessGrant: + $ref: "#/components/schemas/EmployeeAccessGrantView" mongoDBMajorVersion: type: string description: |- @@ -27137,7 +29432,7 @@ components: description: Human-readable label that identifies the cluster. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" paused: type: boolean description: Flag that indicates whether the cluster is paused. @@ -27148,6 +29443,35 @@ components: externalDocs: description: Continuous Cloud Backups url: https://docs.atlas.mongodb.com/backup/cloud-backup/overview/ + redactClientLogData: + type: boolean + description: Enable or disable log redaction. + externalDocs: + description: |- + This options corresponds to the ``security.redactClientLogData`` cluster parameter. + + This setting configures the ``mongod`` or ``mongos`` to redact any message accompanying a given log event before logging. This prevents the program from writing potentially sensitive data stored on the database to the diagnostic log. Metadata such as error or operation codes, line numbers, and source file names are still visible in the logs. + + Use ``redactClientLogData`` in conjunction with Encryption at Rest and TLS/SSL (Transport Encryption) to assist compliance with regulatory requirements. + url: https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.redactClientLogData + replicaSetScalingStrategy: + type: string + default: WORKLOAD_TYPE + description: |- + Set this field to configure the replica set scaling mode for your cluster. + + By default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes. + + When configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads. + + When configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads. + enum: + - SEQUENTIAL + - WORKLOAD_TYPE + - NODE_TYPE + externalDocs: + description: Modify the Replica Set Scaling Mode + url: https://dochub.mongodb.org/core/scale-nodes replicationSpecs: type: array description: List of settings that configure your cluster regions. This @@ -27273,6 +29597,24 @@ components: ClusterDescriptionProcessArgs: type: object properties: + changeStreamOptionsPreAndPostImagesExpireAfterSeconds: + type: integer + format: int32 + default: -1 + description: The minimum pre- and post-image retention time in seconds. + externalDocs: + description: "This option corresponds to the ``changeStreamOptions.preAndPostImages.expireAfterSeconds``\ + \ cluster parameter. This setting controls the retention policy of change\ + \ stream pre- and post-images. Pre- and post-images are the versions\ + \ of a document before and after document modification, respectively.\ + \ ``expireAfterSeconds`` controls how long MongoDB retains pre- and\ + \ post-images. When set to -1 (off), MongoDB uses the default retention\ + \ policy: pre- and post-images are retained until the corresponding\ + \ change stream events are removed from the oplog. To set the minimum\ + \ pre- and post-image retention time, specify an integer value greater\ + \ than zero. Setting this too low could increase the risk of interrupting\ + \ Realm sync or triggers processing. The default value is -1 (off)." + url: https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/changeStreamOptions/#mongodb-parameter-param.changeStreamOptions.preAndPostImages.expireAfterSeconds chunkMigrationConcurrency: type: integer format: int32 @@ -27283,6 +29625,14 @@ components: description: This option corresponds to the `chunkMigrationConcurrency` `mongod` configuration file option. url: https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.chunkMigrationConcurrency + defaultMaxTimeMS: + type: integer + format: int32 + description: Default time limit in milliseconds for individual read operations + to complete. + externalDocs: + description: This option corresponds to the defaultMaxTimeMS cluster parameter. + url: https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/defaultMaxTimeMS/ defaultReadConcern: type: string default: available @@ -27319,8 +29669,10 @@ components: url: https://docs.mongodb.com/upcoming/reference/parameters/#mongodb-parameter-param.failIndexKeyTooLong javascriptEnabled: type: boolean - description: Flag that indicates whether the cluster allows execution of - operations that perform server-side executions of JavaScript. + 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. @@ -27413,6 +29765,24 @@ components: ClusterDescriptionProcessArgs20240805: type: object properties: + changeStreamOptionsPreAndPostImagesExpireAfterSeconds: + type: integer + format: int32 + default: -1 + description: The minimum pre- and post-image retention time in seconds. + externalDocs: + description: "This option corresponds to the ``changeStreamOptions.preAndPostImages.expireAfterSeconds``\ + \ cluster parameter. This setting controls the retention policy of change\ + \ stream pre- and post-images. Pre- and post-images are the versions\ + \ of a document before and after document modification, respectively.\ + \ ``expireAfterSeconds`` controls how long MongoDB retains pre- and\ + \ post-images. When set to -1 (off), MongoDB uses the default retention\ + \ policy: pre- and post-images are retained until the corresponding\ + \ change stream events are removed from the oplog. To set the minimum\ + \ pre- and post-image retention time, specify an integer value greater\ + \ than zero. Setting this too low could increase the risk of interrupting\ + \ Realm sync or triggers processing. The default value is -1 (off)." + url: https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/changeStreamOptions/#mongodb-parameter-param.changeStreamOptions.preAndPostImages.expireAfterSeconds chunkMigrationConcurrency: type: integer format: int32 @@ -27423,6 +29793,14 @@ components: description: This option corresponds to the `chunkMigrationConcurrency` `mongod` configuration file option. url: https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.chunkMigrationConcurrency + defaultMaxTimeMS: + type: integer + format: int32 + description: Default time limit in milliseconds for individual read operations + to complete. + externalDocs: + description: This option corresponds to the defaultMaxTimeMS cluster parameter. + url: https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/defaultMaxTimeMS/ defaultWriteConcern: type: string description: Default level of acknowledgment requested from MongoDB for @@ -27433,8 +29811,10 @@ components: url: https://docs.mongodb.com/manual/reference/write-concern/ javascriptEnabled: type: boolean - description: Flag that indicates whether the cluster allows execution of - operations that perform server-side executions of JavaScript. + 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. @@ -27719,7 +30099,7 @@ components: outage simulation. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true groupId: type: string @@ -28534,6 +30914,7 @@ components: mapping: AWS: "#/components/schemas/AWSCreateDataProcessRegionView" AZURE: "#/components/schemas/AzureCreateDataProcessRegionView" + GCP: "#/components/schemas/GCPCreateDataProcessRegionView" propertyName: cloudProvider properties: cloudProvider: @@ -29016,11 +31397,11 @@ components: roleId: type: string description: Unique identifier of the role that Data Federation can use - to access the data stores.Required if specifying cloudProviderConfig. + to access the data stores. Required if specifying cloudProviderConfig. servicePrincipalId: type: string description: The ID of the Service Principal for which there is an access - policyfor Atlas to access Azure resources. + policy for Atlas to access Azure resources. readOnly: true tenantId: type: string @@ -29029,6 +31410,22 @@ components: readOnly: true required: - roleId + DataFederationGCPCloudProviderConfig: + type: object + description: Configuration for running Data Federation in GCP. + 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: + type: string + description: Unique identifier of the role that Data Federation can use + to access the data stores. Required if specifying cloudProviderConfig. + required: + - roleId DataFederationLimit: type: object description: Details of user managed limits. @@ -29036,6 +31433,7 @@ components: mapping: atlas.project.deployment.clusters: "#/components/schemas/DefaultLimit" atlas.project.deployment.nodesPerPrivateLinkRegion: "#/components/schemas/DefaultLimit" + atlas.project.deployment.salesSoldM0s: "#/components/schemas/DefaultLimit" atlas.project.deployment.serverlessMTMs: "#/components/schemas/DefaultLimit" atlas.project.security.databaseAccess.customRoles: "#/components/schemas/DefaultLimit" atlas.project.security.databaseAccess.users: "#/components/schemas/DefaultLimit" @@ -29406,7 +31804,9 @@ components: $ref: "#/components/schemas/DataLakeAWSCloudProviderConfig" azure: $ref: "#/components/schemas/DataFederationAzureCloudProviderConfig" - title: Data Lake Cloud Provider + gcp: + $ref: "#/components/schemas/DataFederationGCPCloudProviderConfig" + title: Data Federation Cloud Provider DataLakeDLSAWSStore: type: object allOf: @@ -29531,6 +31931,7 @@ components: enum: - AWS - AZURE + - GCP region: $ref: "#/components/schemas/BaseAtlasDataLakeRegion" required: @@ -30007,7 +32408,7 @@ components: example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -30266,7 +32667,12 @@ components: enum: - AVERAGE operator: - $ref: "#/components/schemas/Operator" + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - LESS_THAN + - GREATER_THAN threshold: type: number format: double @@ -30314,6 +32720,7 @@ components: mapping: AWS: "#/components/schemas/AWSDataProcessRegionView" AZURE: "#/components/schemas/AzureDataProcessRegionView" + GCP: "#/components/schemas/GCPDataProcessRegionView" propertyName: cloudProvider properties: cloudProvider: @@ -30323,6 +32730,7 @@ components: enum: - AWS - AZURE + - GCP readOnly: true readOnly: true DataProtectionSettings: @@ -30614,6 +33022,8 @@ components: - SQL_SET_SCHEMA - VIEW_ALL_HISTORY - OUT_TO_S3 + - OUT_TO_AZURE + - OUT_TO_GCS - STORAGE_GET_CONFIG - STORAGE_SET_CONFIG - FLUSH_ROUTER_CONFIG @@ -30973,6 +33383,7 @@ components: - FTS_INDEX_BUILD_COMPLETE - FTS_INDEX_BUILD_FAILED - FTS_INDEXES_RESTORE_FAILED + - FTS_INDEXES_SYNONYM_MAPPING_INVALID title: FTS Index Audit Types - type: string enum: @@ -31173,6 +33584,7 @@ components: - FTS_INDEX_BUILD_COMPLETE - FTS_INDEX_BUILD_FAILED - FTS_INDEXES_RESTORE_FAILED + - FTS_INDEXES_SYNONYM_MAPPING_INVALID title: FTS Index Audit Types - type: string enum: @@ -31628,11 +34040,14 @@ components: - CLUSTER_VERSION_UNFIXED - CLUSTER_FCV_FIXED - CLUSTER_FCV_UNFIXED + - CLUSTER_FCV_EXPIRATION_DATE_UPDATED - AGENT_VERSION_FIXED - AGENT_VERSION_UNFIXED - FIXED_VERSION_UPDATED - FIXED_AGENT_VERSION_UPDATED - CLUSTER_FCV_DOWNGRADED + - CLUSTER_BINARY_VERSION_DOWNGRADED + - CLUSTER_BINARY_VERSION_UPGRADED title: Version Audit Types groupId: type: string @@ -32020,7 +34435,6 @@ components: pattern: "^([a-f0-9]{24})$" hostnameSchemaType: type: string - default: PUBLIC description: The network type to use between the migration host and the destination cluster. enum: @@ -32221,30 +34635,19 @@ components: createdAt: type: string format: date-time - description: Date and time when someone created this export job. MongoDB - Cloud represents this timestamp in ISO 8601 format in UTC. + description: Date and time when a user or Atlas created the Export Job. + MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. readOnly: true customData: type: array description: Collection of key-value pairs that represent custom data for - the metadata file that MongoDB Cloud uploads to the bucket when the export - job finishes. + the metadata file that MongoDB Cloud uploads when the Export Job finishes. items: $ref: "#/components/schemas/BackupLabel" - 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\"`." - items: - type: string - description: One Uniform Resource Locator that point to the compressed - snapshot files for manual download. - readOnly: true exportBucketId: type: string description: Unique 24-hexadecimal character string that identifies the - Export Bucket to export to. + Export Bucket. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 @@ -32255,7 +34658,7 @@ components: finishedAt: type: string format: date-time - description: Date and time when this export job completed. MongoDB Cloud + description: Date and time when this Export Job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. readOnly: true id: @@ -32280,8 +34683,8 @@ components: readOnly: true prefix: type: string - description: Full path on the cloud provider bucket to the folder where - the snapshot is exported. + description: Prefix used for all blob storage objects uploaded as part of + the Export Job. pattern: "/exported_snapshots/\\{ORG-NAME\\}/\\{PROJECT-NAME\\}/\\{CLUSTER-NAME\\\ }/\\{SNAPSHOT-INITIATION-DATE\\}/\\{TIMESTAMP\\}" readOnly: true @@ -32295,7 +34698,7 @@ components: pattern: "^([a-f0-9]{24})$" state: type: string - description: State of the export job. + description: State of the Export Job. enum: - Cancelled - Failed @@ -32318,7 +34721,7 @@ components: exportBucketId: type: string description: Unique 24-hexadecimal character string that identifies the - Export Bucket to export to. + Export Bucket. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 @@ -32525,10 +34928,19 @@ components: properties: downloadUrl: type: string - description: "One Uniform Resource Locator that point to the compressed\ + 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." + items: + $ref: "#/components/schemas/ApiPrivateDownloadDeliveryUrl" + readOnly: true replicaSetName: type: string description: Human-readable label that identifies the replica set on the @@ -32980,7 +35392,7 @@ components: \ this parameter when `\"deliveryType\" : \"download\"`." items: type: string - description: One Uniform Resource Locator that point to the compressed + description: One Uniform Resource Locator that points to the compressed snapshot files for manual download. readOnly: true desiredTimestamp: @@ -33052,6 +35464,15 @@ components: \ when `\"deliveryType\" : \"pointInTime\"` and **pointInTimeUTCSeconds**\ \ exceeds `0`." minimum: 1199145600 + 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." + items: + $ref: "#/components/schemas/ApiPrivateDownloadDeliveryUrl" + readOnly: true snapshotId: type: string description: Unique 24-hexadecimal character string that identifies the @@ -33068,7 +35489,7 @@ components: and `pointInTime` restore types. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" targetGroupId: type: string description: Unique 24-hexadecimal digit string that identifies the target @@ -33109,7 +35530,7 @@ components: you want to return. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true copySettings: type: array @@ -33203,7 +35624,7 @@ components: you want to return. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true copySettings: type: array @@ -33289,8 +35710,12 @@ components: additionalProperties: type: object description: The stats associated with the stream processor. + externalDocs: + url: https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor readOnly: true description: The stats associated with the stream processor. + externalDocs: + url: https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor readOnly: true EARPrivateEndpoint: type: object @@ -33385,6 +35810,8 @@ components: - PENDING_ACCEPTANCE - ACTIVE - FAILED + - PENDING_RECREATION + - DELETING readOnly: true title: Encryption At Rest Private Endpoint EmailNotification: @@ -33431,6 +35858,36 @@ components: required: - typeName title: Email Notification + EmployeeAccessGrantView: + type: object + description: MongoDB employee granted access level and expiration for a cluster. + properties: + expirationTime: + type: string + format: date-time + description: Expiration date for the employee access grant. + 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." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + readOnly: true + required: + - expirationTime + - grantType EncryptionAtRest: type: object properties: @@ -33440,24 +35897,6 @@ components: $ref: "#/components/schemas/AzureKeyVault" googleCloudKms: $ref: "#/components/schemas/GoogleCloudKMS" - EncryptionAtRestPrivateEndpointRequest: - type: object - description: Create or delete private endpoints from the specified regions list. - properties: - cloudProvider: - type: string - description: Cloud service provider name. - enum: - - AZURE - regions: - type: array - description: List of regions. - items: - type: string - uniqueItems: true - required: - - cloudProvider - title: Encryption At Rest Private Endpoints setup. EncryptionKeyAlertConfigViewForNdsGroup: type: object description: Encryption key alert configuration allows to select thresholds which @@ -33804,6 +36243,7 @@ components: - FTS_INDEX_CLEANED_UP - FTS_INDEXES_RESTORED - FTS_INDEXES_RESTORE_FAILED + - FTS_INDEXES_SYNONYM_MAPPING_INVALID title: FTS Index Audit Types - type: string enum: @@ -33857,6 +36297,8 @@ components: - HOST_HAS_INDEX_SUGGESTIONS - HOST_MONGOT_RECOVERED_OOM - HOST_MONGOT_CRASHING_OOM + - HOST_MONGOT_RESUME_REPLICATION + - HOST_MONGOT_STOP_REPLICATION - HOST_ENOUGH_DISK_SPACE - HOST_NOT_ENOUGH_DISK_SPACE title: Host Event Types @@ -33894,6 +36336,7 @@ components: - 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 @@ -33971,6 +36414,8 @@ components: - 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 @@ -34000,6 +36445,9 @@ components: - 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 @@ -34058,9 +36506,13 @@ components: - 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 title: NDS Audit Types - type: string enum: @@ -34257,11 +36709,14 @@ components: - CLUSTER_VERSION_UNFIXED - CLUSTER_FCV_FIXED - CLUSTER_FCV_UNFIXED + - CLUSTER_FCV_EXPIRATION_DATE_UPDATED - AGENT_VERSION_FIXED - AGENT_VERSION_UNFIXED - FIXED_VERSION_UPDATED - FIXED_AGENT_VERSION_UPDATED - CLUSTER_FCV_DOWNGRADED + - CLUSTER_BINARY_VERSION_DOWNGRADED + - CLUSTER_BINARY_VERSION_UPGRADED title: Version Audit Types - type: string enum: @@ -34537,6 +36992,12 @@ components: enum: - GROUP_TAGS_MODIFIED title: Resource Event Types + - type: string + enum: + - RESOURCE_POLICY_CREATED + - RESOURCE_POLICY_MODIFIED + - RESOURCE_POLICY_DELETED + title: Atlas Resource Policy Audit Types EventViewForNdsGroup: type: object oneOf: @@ -34578,6 +37039,7 @@ components: - $ref: "#/components/schemas/TeamEvent" - $ref: "#/components/schemas/UserEventViewForOrg" - $ref: "#/components/schemas/ResourceEventViewForOrg" + - $ref: "#/components/schemas/AtlasResourcePolicyAuditForOrg" ExampleResourceResponse20230101: type: object properties: @@ -34627,8 +37089,7 @@ components: - description ExportStatus: type: object - description: State of the export job for the collections on the replica set - only. + description: State of the Export Job. properties: exportedCollections: type: integer @@ -34674,6 +37135,7 @@ components: - FTS_INDEX_CLEANED_UP - FTS_INDEXES_RESTORED - FTS_INDEXES_RESTORE_FAILED + - FTS_INDEXES_SYNONYM_MAPPING_INVALID example: FTS_INDEX_CREATED title: FTS Index Audit Types FTSIndexAuditView: @@ -35601,37 +38063,52 @@ components: enum: - EXCLUDE title: Field Transformation - ForNdsGroup: + FieldViolation: type: object - description: ReplicaSet Event identifies different activities about replica - set of mongod instances. properties: - created: + description: type: string - format: date-time - description: Date and time when this event occurred. This parameter expresses - its value in the ISO 8601 timestamp format in UTC. + 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. + required: + - description + - field + FlexBackupRestoreJob20250101: + type: object + description: Details for one restore job of a flex cluster. + properties: + deliveryType: + type: string + description: Means by which this resource returns the snapshot to the requesting + MongoDB Cloud user. + enum: + - RESTORE + - DOWNLOAD readOnly: true - eventTypeName: - $ref: "#/components/schemas/ReplicaSetEventTypeViewForNdsGroup" - groupId: + expirationDate: type: string - description: Unique 24-hexadecimal digit string that identifies the project - in which the event occurred. The **eventId** identifies the specific event. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" + format: date-time + description: Date and time when the download link no longer works. This + parameter expresses its value in the ISO 8601 timestamp format in UTC. readOnly: true id: type: string - description: Unique 24-hexadecimal digit string that identifies the event. + description: Unique 24-hexadecimal digit string that identifies the restore + job. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true + instanceName: + type: string + description: Human-readable label that identifies the source instance. + maxLength: 64 + minLength: 1 + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + readOnly: true links: type: array description: "List of one or more Uniform Resource Locators (URLs) that\ @@ -35643,656 +38120,296 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true - orgId: + projectId: type: string - description: Unique 24-hexadecimal digit string that identifies the organization - to which these events apply. + description: Unique 24-hexadecimal digit string that identifies the project + from which the restore job originated. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true - port: - type: integer - format: int32 - description: IANA port on which the MongoDB process listens for requests. - example: 27017 - readOnly: true - raw: - $ref: "#/components/schemas/raw" - replicaSetName: + restoreFinishedDate: type: string - description: Human-readable label of the replica set associated with the - event. - example: event-replica-set + format: date-time + 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. readOnly: true - shardName: + restoreScheduledDate: type: string - description: Human-readable label of the shard associated with the event. - example: event-sh-01 + format: date-time + description: Date and time when MongoDB Cloud will restore this snapshot. + This parameter expresses its value in the ISO 8601 timestamp format in + UTC. readOnly: true - required: - - created - - eventTypeName - - id - title: ReplicaSet Events - GCPCloudProviderContainer: - type: object - allOf: - - $ref: "#/components/schemas/CloudProviderContainer" - - type: object - properties: - atlasCidrBlock: - type: string - description: |- - IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project. - - These CIDR blocks must fall within the ranges reserved per RFC 1918. GCP further limits the block to a lower bound of the `/18` range. - - To modify the CIDR block, the target project cannot have: - - - Any M10 or greater clusters - - Any other VPC peering connections - - You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project. - - **Example:** A project in an Google Cloud (GCP) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets. - pattern: "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" - gcpProjectId: - 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. - maxLength: 26 - minLength: 26 - pattern: "^p-[0-9a-z]{24}$" - readOnly: true - networkName: - 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. - maxLength: 36 - minLength: 36 - pattern: "^nt-[0-9a-f]{24}-[0-9a-z]{8}$" - 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." - 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." - 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 - description: Collection of settings that configures the network container for - a virtual private connection on Amazon Web Services. - required: - - atlasCidrBlock - title: GCP - GCPComputeAutoScaling: - type: object - description: Collection of settings that configures how a cluster might scale - its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling - is unavailable for clusters using Low CPU or NVME storage classes. - properties: - maxInstanceSize: - type: string - description: Maximum instance size to which your cluster can automatically - scale. - enum: - - M10 - - M20 - - M30 - - M40 - - M50 - - M60 - - M80 - - M140 - - M200 - - M250 - - M300 - - M400 - - R40 - - R50 - - R60 - - R80 - - R200 - - R300 - - R400 - - R600 - title: GCP Instance Sizes - minInstanceSize: + snapshotFinishedDate: 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 - title: GCP Instance Sizes - title: GCP - GCPConsumerForwardingRule: - type: object - properties: - endpointName: + format: date-time + description: Date and time when MongoDB Cloud completed writing this snapshot. + This parameter expresses its value in the ISO 8601 timestamp format in + UTC. + readOnly: true + snapshotId: type: string - description: Human-readable label that identifies the Google Cloud consumer - forwarding rule that you created. - externalDocs: - description: Google Cloud Forwarding Rule Concepts - url: https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts + description: Unique 24-hexadecimal digit string that identifies the snapshot + to restore. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" readOnly: true - ipAddress: + snapshotUrl: type: string - description: One Private Internet Protocol version 4 (IPv4) address to which - this Google Cloud consumer forwarding rule resolves. - pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + 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: State of the MongoDB Cloud endpoint group when MongoDB Cloud - received this request. + description: Phase of the restore workflow for this job at the time this + resource made this request. enum: - - INITIATING - - AVAILABLE + - PENDING + - QUEUED + - RUNNING - FAILED - - DELETING + - COMPLETED readOnly: true - GCPEndpointService: + targetDeploymentItemName: + type: string + description: Human-readable label that identifies the instance or cluster + on the target project to which you want to restore the snapshot. You can + restore the snapshot to another USS instance or Dedicated cluster tier. + maxLength: 64 + minLength: 1 + pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + readOnly: true + targetProjectId: + type: string + description: Unique 24-hexadecimal digit string that identifies the project + that contains the instance or cluster to which you want to restore the + snapshot. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + title: Flex Backup Restore Job + FlexBackupRestoreJobCreate20250101: type: object - description: Group of Private Endpoint Service settings. + description: Details to create one restore job of a flex cluster. properties: - cloudProvider: + _snapshotId: type: string - description: Cloud service provider that serves the requested endpoint service. + description: Unique 24-hexadecimal digit string that identifies the snapshot + to restore. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + writeOnly: true + _targetDeploymentItemName: + type: string + description: Human-readable label that identifies the instance or cluster + on the target project to which you want to restore the snapshot. You can + restore the snapshot to another flex cluster or dedicated cluster tier. + maxLength: 64 + minLength: 1 + pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + writeOnly: true + _targetProjectId: + type: string + description: Unique 24-hexadecimal digit string that identifies the project + that contains the instance or cluster to which you want to restore the + snapshot. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + writeOnly: true + deliveryType: + type: string + description: Means by which this resource returns the snapshot to the requesting + MongoDB Cloud user. enum: - - AWS - - AZURE - - GCP + - RESTORE + - DOWNLOAD readOnly: true - 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 - items: - type: string - description: One Google Cloud network endpoint group that corresponds - to the Private Service Connect endpoint service. - errorMessage: + expirationDate: type: string - description: Error message returned when requesting private connection resource. - The resource returns `null` if the request succeeded. + format: date-time + description: Date and time when the download link no longer works. This + parameter expresses its value in the ISO 8601 timestamp format in UTC. readOnly: true id: type: string - description: Unique 24-hexadecimal digit string that identifies the Private - Endpoint Service. + description: Unique 24-hexadecimal digit string that identifies the restore + job. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true - regionName: + instanceName: type: string - description: Cloud provider region that manages this Private Endpoint Service. + description: Human-readable label that identifies the source instance. + maxLength: 64 + minLength: 1 + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true - serviceAttachmentNames: + links: 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. + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." externalDocs: - description: Google Cloud Private Service Connect Service Attachments - url: https://cloud.google.com/vpc/docs/private-service-connect#service-attachments + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 items: - 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. - 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\\-]+" - status: + $ref: "#/components/schemas/Link" + readOnly: true + projectId: type: string - description: State of the Private Endpoint Service connection when MongoDB - Cloud received this request. - enum: - - INITIATING - - AVAILABLE - - WAITING_FOR_USER - - FAILED - - DELETING - readOnly: true - required: - - cloudProvider - title: GCP - GCPHardwareSpec: - type: object - properties: - instanceSize: - type: string - description: Hardware specification for the instance sizes in this region. - Each instance size has a default storage and memory capacity. The instance - size you select applies to all the data-bearing hosts 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 - title: GCP Instance Sizes - nodeCount: - type: integer - format: int32 - description: Number of nodes of the given type for MongoDB Cloud to deploy - to the region. - GCPHardwareSpec20240805: - type: object - properties: - diskSizeGB: - type: number - format: double - description: "Storage capacity of instance data volumes expressed in gigabytes.\ - \ Increase this number to add capacity.\n\n This value must be equal for\ - \ all shards and node types.\n\n This value is not configurable on M0/M2/M5\ - \ clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\ - \n If you specify a disk size below the minimum (10 GB), this parameter\ - \ defaults to the minimum disk size value. \n\n Storage charge calculations\ - \ depend on whether you choose the default value or a custom value.\n\n\ - \ The maximum value for disk storage cannot exceed 50 times the maximum\ - \ RAM for the selected cluster. If you require more storage space, consider\ - \ upgrading your cluster to a higher tier." - maximum: 4096 - minimum: 10 - instanceSize: - type: string - description: Hardware specification for the instance sizes in this region - in this shard. Each instance size has a default storage and memory capacity. - Electable nodes and read-only nodes (known as "base nodes") within a single - shard must use the same instance size. Analytics nodes can scale independently - from base nodes within a shard. Both base nodes and analytics nodes can - scale independently from their equivalents in other shards. - enum: - - M10 - - M20 - - M30 - - M40 - - M50 - - M60 - - M80 - - M140 - - M200 - - M250 - - M300 - - M400 - - R40 - - R50 - - R60 - - R80 - - R200 - - R300 - - R400 - - R600 - title: GCP Instance Sizes - nodeCount: - type: integer - format: int32 - description: Number of nodes of the given type for MongoDB Cloud to deploy - to the region. - GCPNetworkPeeringConnectionSettings: - type: object - description: Group of Network Peering connection settings. - properties: - containerId: - type: string - description: Unique 24-hexadecimal digit string that identifies the MongoDB - Cloud network container that contains the specified network peering connection. + description: Unique 24-hexadecimal digit string that identifies the project + from which the restore job originated. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" - 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: + restoreFinishedDate: 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. - maxLength: 30 - minLength: 6 - pattern: "^[a-z][0-9a-z-]{4,28}[0-9a-z]{1}" - id: + format: date-time + 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. + readOnly: true + restoreScheduledDate: type: string - description: Unique 24-hexadecimal digit string that identifies the network - peering connection. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" + format: date-time + description: Date and time when MongoDB Cloud will restore this snapshot. + This parameter expresses its value in the ISO 8601 timestamp format in + UTC. readOnly: true - networkName: + snapshotFinishedDate: type: string - description: Human-readable label that identifies the network to peer with - the MongoDB Cloud VPC. - maxLength: 63 - minLength: 1 - pattern: "[a-z]([-a-z0-9]{0,62}[a-z0-9]{0,1})?" - providerName: + format: date-time + description: Date and time when MongoDB Cloud completed writing this snapshot. + This parameter expresses its value in the ISO 8601 timestamp format in + UTC. + readOnly: true + snapshotUrl: type: string - description: Cloud service provider that serves the requested network peering - connection. - enum: - - AWS - - AZURE - - GCP + 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: State of the network peering connection at the time you made - the request. + description: Phase of the restore workflow for this job at the time this + resource made this request. enum: - - ADDING_PEER - - WAITING_FOR_USER - - AVAILABLE + - PENDING + - QUEUED + - RUNNING - FAILED - - DELETING + - COMPLETED readOnly: true required: - - containerId - - gcpProjectId - - networkName - title: GCP - GCPRegionConfig: - type: object - allOf: - - $ref: "#/components/schemas/CloudRegionConfig" - - type: object - properties: - analyticsAutoScaling: - $ref: "#/components/schemas/AdvancedAutoScalingSettings" - analyticsSpecs: - $ref: "#/components/schemas/DedicatedHardwareSpec" - autoScaling: - $ref: "#/components/schemas/AdvancedAutoScalingSettings" - readOnlySpecs: - $ref: "#/components/schemas/DedicatedHardwareSpec" - description: Details that explain how MongoDB Cloud replicates data in one region - on the specified MongoDB database. - title: GCP Regional Replication Specifications - GCPRegionConfig20240805: - type: object - allOf: - - $ref: "#/components/schemas/CloudRegionConfig20240805" - - type: object - properties: - analyticsAutoScaling: - $ref: "#/components/schemas/AdvancedAutoScalingSettings" - analyticsSpecs: - $ref: "#/components/schemas/DedicatedHardwareSpec20240805" - autoScaling: - $ref: "#/components/schemas/AdvancedAutoScalingSettings" - readOnlySpecs: - $ref: "#/components/schemas/DedicatedHardwareSpec20240805" - description: Details that explain how MongoDB Cloud replicates data in one region - on the specified MongoDB database. - title: GCP Regional Replication Specifications - GeoSharding: + - _snapshotId + - _targetDeploymentItemName + title: Create Flex Backup Restore Job + FlexBackupSettings20250101: type: object + description: Flex backup configuration properties: - customZoneMapping: - type: object - additionalProperties: - 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 - 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. - items: - $ref: "#/components/schemas/ManagedNamespaces" - readOnly: true - selfManagedSharding: + enabled: 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. + default: true + description: "Flag that indicates whether backups are performed for this\ + \ flex cluster. Backup uses [TODO](TODO) for flex clusters." readOnly: true - GeoSharding20240805: + readOnly: true + title: Flex Backup Configuration + FlexBackupSnapshot20250101: type: object + description: Details for one snapshot of a flex cluster. properties: - customZoneMapping: - type: object - additionalProperties: - type: string - description: |- - List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone. - - The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property. - - This parameter returns an empty object if no custom zones exist. - readOnly: true - description: |- - List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone. - - The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property. - - This parameter returns an empty object if no custom zones exist. - readOnly: true - managedNamespaces: - type: array - description: List that contains a namespace for a Global Cluster. MongoDB - Cloud manages this cluster. - items: - $ref: "#/components/schemas/ManagedNamespaces" - readOnly: true - 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. + expiration: + type: string + format: date-time + description: Date and time when the download link no longer works. This + parameter expresses its value in the ISO 8601 timestamp format in UTC. readOnly: true - GoogleCloudKMS: - type: object - description: Details that define the configuration of Encryption at Rest using - Google Cloud Key Management Service (KMS). - externalDocs: - description: Google Cloud Key Management Service - url: https://www.mongodb.com/docs/atlas/security-gcp-kms/ - properties: - enabled: - 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: + finishTime: 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 - serviceAccountKey: + format: date-time + description: Date and time when MongoDB Cloud completed writing this snapshot. + This parameter expresses its value in the ISO 8601 timestamp format in + UTC. + readOnly: true + id: type: string - description: 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. + description: Unique 24-hexadecimal digit string that identifies the snapshot. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." externalDocs: - description: Google Cloud Authentication - url: https://cloud.google.com/docs/authentication/getting-started - writeOnly: true - valid: - type: boolean - description: Flag that indicates whether the Google Cloud Key Management - Service (KMS) encryption key can encrypt and decrypt data. + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" readOnly: true - GreaterThanDaysThresholdView: - type: object - description: Threshold value that triggers an alert. - properties: - operator: - type: string - description: Comparison operator to apply when checking the current metric - value. - enum: - - GREATER_THAN - threshold: - type: integer - format: int32 - description: "Value of metric that, when exceeded, triggers an alert." - units: + mongoDBVersion: type: string - description: "Element used to express the quantity. This can be an element\ - \ of time, storage capacity, and the like." - enum: - - DAYS - GreaterThanRawThreshold: - type: object - description: A Limit that triggers an alert when greater than a number. - properties: - operator: + description: MongoDB host version that the snapshot runs. + readOnly: true + scheduledTime: type: string - description: Comparison operator to apply when checking the current metric - value. - enum: - - GREATER_THAN - threshold: - type: integer - format: int32 - description: "Value of metric that, when exceeded, triggers an alert." - units: - $ref: "#/components/schemas/RawMetricUnits" - title: Greater Than Raw Threshold - GreaterThanRawThresholdAlertConfigViewForNdsGroup: - type: object - properties: - created: + format: date-time + description: Date and time when MongoDB Cloud will take the snapshot. This + parameter expresses its value in the ISO 8601 timestamp format in UTC. + readOnly: true + startTime: type: string format: date-time - description: Date and time when MongoDB Cloud created the alert configuration. - This parameter expresses its value in the ISO 8601 timestamp format - in UTC. + description: Date and time when MongoDB Cloud began taking the snapshot. + This parameter expresses its value in the ISO 8601 timestamp format in + UTC. readOnly: true - enabled: - type: boolean - default: false - description: Flag that indicates whether someone enabled this alert configuration - for the specified project. - eventTypeName: - $ref: "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" - groupId: + status: type: string - description: Unique 24-hexadecimal digit string that identifies the project - that owns this alert configuration. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" + description: Phase of the workflow for this snapshot at the time this resource + made this request. + enum: + - PENDING + - QUEUED + - RUNNING + - FAILED + - COMPLETED readOnly: true - id: + title: Flex Backup Snapshot + FlexBackupSnapshotDownloadCreate20250101: + type: object + description: Details for one backup snapshot download of a flex cluster. + properties: + _snapshotId: type: string - description: Unique 24-hexadecimal digit string that identifies this alert - configuration. + description: Unique 24-hexadecimal digit string that identifies the snapshot + to download. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" - readOnly: true + writeOnly: true links: type: array description: "List of one or more Uniform Resource Locators (URLs) that\ @@ -36304,67 +38421,42 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true - matchers: - type: array - description: "List of rules that determine whether MongoDB Cloud checks\ - \ an object for the alert configuration. You can filter using the matchers\ - \ array if the **eventTypeName** specifies an event for a host, replica\ - \ set, or sharded cluster." - items: - $ref: "#/components/schemas/ReplicaSetMatcher" - notifications: - type: array - description: List that contains the targets that MongoDB Cloud sends notifications. - items: - $ref: "#/components/schemas/AlertsNotificationRootForGroup" - threshold: - $ref: "#/components/schemas/GreaterThanRawThreshold" - updated: - type: string - format: date-time - description: Date and time when someone last updated this alert configuration. - This parameter expresses its value in the ISO 8601 timestamp format - in UTC. - readOnly: true required: - - eventTypeName - - notifications - GreaterThanTimeThreshold: + - _snapshotId + title: Flex Backup Snapshot Download Create + FlexClusterDescription20250101: type: object - description: A Limit that triggers an alert when greater than a time period. + description: Group of settings that configure a MongoDB Flex cluster. properties: - operator: + backupSettings: + $ref: "#/components/schemas/FlexBackupSettings20250101" + clusterType: type: string - description: Comparison operator to apply when checking the current metric - value. + description: Flex cluster topology. enum: - - GREATER_THAN - threshold: - type: integer - format: int32 - description: "Value of metric that, when exceeded, triggers an alert." - units: - $ref: "#/components/schemas/TimeMetricUnits" - title: Greater Than Time Threshold - Group: - type: object - properties: - clusterCount: - type: integer - format: int64 - description: Quantity of MongoDB Cloud clusters deployed in this project. + - REPLICASET + - LOADBALANCED readOnly: true - created: + connectionStrings: + $ref: "#/components/schemas/FlexConnectionStrings20250101" + createDate: type: string format: date-time - description: Date and time when MongoDB Cloud created this project. This - parameter expresses its value in the ISO 8601 timestamp format in UTC. + description: Date and time when MongoDB Cloud created this instance. This + parameter expresses its value in ISO 8601 format in UTC. + readOnly: true + groupId: + type: string + description: Unique 24-hexadecimal character string that identifies the + project. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" readOnly: true id: type: string - description: Unique 24-hexadecimal digit string that identifies the MongoDB - Cloud project. + description: Unique 24-hexadecimal digit string that identifies the instance. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 @@ -36381,18 +38473,1021 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true + mongoDBVersion: + type: string + description: Version of MongoDB that the instance runs. + pattern: "([\\d]+\\.[\\d]+\\.[\\d]+)" + readOnly: true name: type: string - description: Human-readable label that identifies the project included in - the MongoDB Cloud organization. + description: Human-readable label that identifies the instance. maxLength: 64 minLength: 1 - pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" - orgId: + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + readOnly: true + providerSettings: + $ref: "#/components/schemas/FlexProviderSettings20250101" + stateName: type: string - description: Unique 24-hexadecimal digit string that identifies the MongoDB - Cloud organization to which the project belongs. - example: 32b6e34b3d91647abb20e7b8 + description: Human-readable label that indicates the current operating condition + of this instance. + enum: + - IDLE + - CREATING + - UPDATING + - DELETING + - REPAIRING + readOnly: true + tags: + type: array + description: List that contains key-value pairs between 1 to 255 characters + in length for tagging and categorizing the instance. + externalDocs: + description: Resource Tags + url: https://dochub.mongodb.org/core/add-cluster-tag-atlas + items: + $ref: "#/components/schemas/ResourceTag" + terminationProtectionEnabled: + type: boolean + default: false + description: "Flag that indicates whether termination protection is enabled\ + \ on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster.\ + \ If set to `false`, MongoDB Cloud will delete the cluster." + versionReleaseSystem: + type: string + default: LTS + description: Method by which the cluster maintains the MongoDB versions. + enum: + - LTS + readOnly: true + required: + - providerSettings + title: Flex Cluster Description + FlexClusterDescriptionCreate20250101: + type: object + description: Settings that you can specify when you create a flex cluster. + properties: + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + name: + type: string + description: Human-readable label that identifies the instance. + maxLength: 64 + minLength: 1 + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + writeOnly: true + providerSettings: + $ref: "#/components/schemas/FlexProviderSettingsCreate20250101" + tags: + type: array + description: List that contains key-value pairs between 1 to 255 characters + in length for tagging and categorizing the instance. + externalDocs: + description: Resource Tags + url: https://dochub.mongodb.org/core/add-cluster-tag-atlas + items: + $ref: "#/components/schemas/ResourceTag" + terminationProtectionEnabled: + type: boolean + default: false + description: "Flag that indicates whether termination protection is enabled\ + \ on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster.\ + \ If set to `false`, MongoDB Cloud will delete the cluster." + required: + - name + - providerSettings + title: Flex Cluster Description Create + FlexConnectionStrings20250101: + type: object + description: Collection of Uniform Resource Locators that point to the MongoDB + database. + externalDocs: + description: Connection string URI format. + url: https://docs.mongodb.com/manual/reference/connection-string/ + properties: + standard: + type: string + description: Public connection string that you can use to connect to this + cluster. This connection string uses the mongodb:// protocol. + externalDocs: + description: Connection String URI Format + url: https://docs.mongodb.com/manual/reference/connection-string/ + readOnly: true + standardSrv: + type: string + description: Public connection string that you can use to connect to this + flex cluster. This connection string uses the `mongodb+srv://` protocol. + externalDocs: + description: Connection String URI Format + url: https://docs.mongodb.com/manual/reference/connection-string/ + readOnly: true + readOnly: true + title: Flex Cluster Connection Strings + FlexProviderSettings20250101: + type: object + description: Group of cloud provider settings that configure the provisioned + MongoDB flex cluster. + properties: + backingProviderName: + type: string + description: Cloud service provider on which MongoDB Cloud provisioned the + flex cluster. + enum: + - AWS + - AZURE + - GCP + readOnly: true + diskSizeGB: + type: number + format: double + description: Storage capacity available to the flex cluster expressed in + gigabytes. + readOnly: true + providerName: + type: string + default: FLEX + description: Human-readable label that identifies the cloud service provider. + enum: + - FLEX + readOnly: true + regionName: + type: string + description: "Human-readable label that identifies the geographic location\ + \ of your MongoDB flex cluster. The region you choose can affect network\ + \ latency for clients accessing your databases. For a complete list of\ + \ region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws),\ + \ [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/)." + readOnly: true + readOnly: true + title: Cloud Service Provider Settings for a Flex Cluster + FlexProviderSettingsCreate20250101: + type: object + description: Group of cloud provider settings that configure the provisioned + MongoDB flex cluster. + properties: + backingProviderName: + type: string + description: Cloud service provider on which MongoDB Cloud provisioned the + flex cluster. + enum: + - AWS + - AZURE + - GCP + writeOnly: true + diskSizeGB: + type: number + format: double + description: Storage capacity available to the flex cluster expressed in + gigabytes. + readOnly: true + providerName: + type: string + default: FLEX + description: Human-readable label that identifies the cloud service provider. + enum: + - FLEX + readOnly: true + regionName: + type: string + description: "Human-readable label that identifies the geographic location\ + \ of your MongoDB flex cluster. The region you choose can affect network\ + \ latency for clients accessing your databases. For a complete list of\ + \ region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws),\ + \ [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/)." + writeOnly: true + required: + - backingProviderName + - regionName + title: Cloud Service Provider Settings for a Flex Cluster + writeOnly: true + ForNdsGroup: + type: object + description: ReplicaSet Event identifies different activities about replica + set of mongod instances. + properties: + created: + type: string + format: date-time + description: Date and time when this event occurred. This parameter expresses + its value in the ISO 8601 timestamp format in UTC. + readOnly: true + eventTypeName: + $ref: "#/components/schemas/ReplicaSetEventTypeViewForNdsGroup" + groupId: + type: string + description: Unique 24-hexadecimal digit string that identifies the project + in which the event occurred. The **eventId** identifies the specific event. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + id: + type: string + description: Unique 24-hexadecimal digit string that identifies the event. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + orgId: + type: string + description: Unique 24-hexadecimal digit string that identifies the organization + to which these events apply. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + port: + type: integer + format: int32 + description: IANA port on which the MongoDB process listens for requests. + example: 27017 + readOnly: true + raw: + $ref: "#/components/schemas/raw" + replicaSetName: + type: string + description: Human-readable label of the replica set associated with the + event. + example: event-replica-set + readOnly: true + shardName: + type: string + description: Human-readable label of the shard associated with the event. + example: event-sh-01 + readOnly: true + required: + - created + - eventTypeName + - id + title: ReplicaSet Events + GCPCloudProviderContainer: + type: object + allOf: + - $ref: "#/components/schemas/CloudProviderContainer" + - type: object + properties: + atlasCidrBlock: + type: string + description: |- + IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project. + + These CIDR blocks must fall within the ranges reserved per RFC 1918. GCP further limits the block to a lower bound of the `/18` range. + + To modify the CIDR block, the target project cannot have: + + - Any M10 or greater clusters + - Any other VPC peering connections + + You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project. + + **Example:** A project in an Google Cloud (GCP) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets. + pattern: "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + gcpProjectId: + 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. + maxLength: 26 + minLength: 26 + pattern: "^p-[0-9a-z]{24}$" + readOnly: true + networkName: + 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. + maxLength: 36 + minLength: 36 + pattern: "^nt-[0-9a-f]{24}-[0-9a-z]{8}$" + 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." + 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." + 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 + description: Collection of settings that configures the network container for + a virtual private connection on Amazon Web Services. + required: + - atlasCidrBlock + title: GCP + GCPComputeAutoScaling: + type: object + description: Collection of settings that configures how a cluster might scale + its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling + is unavailable for clusters using Low CPU or NVME storage classes. + properties: + maxInstanceSize: + type: string + description: Maximum instance size to which your cluster can automatically + scale. + enum: + - M10 + - M20 + - M30 + - M40 + - M50 + - M60 + - M80 + - M140 + - M200 + - M250 + - M300 + - M400 + - R40 + - R50 + - R60 + - R80 + - R200 + - R300 + - R400 + - R600 + title: GCP Instance Sizes + minInstanceSize: + 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 + title: GCP Instance Sizes + title: GCP + GCPConsumerForwardingRule: + type: object + properties: + endpointName: + type: string + description: Human-readable label that identifies the Google Cloud consumer + forwarding rule that you created. + externalDocs: + description: Google Cloud Forwarding Rule Concepts + url: https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts + readOnly: true + ipAddress: + type: string + description: One Private Internet Protocol version 4 (IPv4) address to which + this Google Cloud consumer forwarding rule resolves. + pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + readOnly: true + status: + type: string + description: State of the MongoDB Cloud endpoint group when MongoDB Cloud + received this request. + enum: + - INITIATING + - AVAILABLE + - FAILED + - DELETING + readOnly: true + 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 + 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. + enum: + - CENTRAL_US + - WESTERN_EUROPE + readOnly: true + GCPEndpointService: + type: object + description: Group of Private Endpoint Service settings. + properties: + cloudProvider: + type: string + description: Cloud service provider that serves the requested endpoint service. + enum: + - AWS + - AZURE + - GCP + readOnly: true + 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 + 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: + type: string + description: Unique 24-hexadecimal digit string that identifies the Private + Endpoint Service. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + 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 + items: + 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. + 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\\-]+" + status: + type: string + description: State of the Private Endpoint Service connection when MongoDB + Cloud received this request. + enum: + - INITIATING + - AVAILABLE + - WAITING_FOR_USER + - FAILED + - DELETING + readOnly: true + required: + - cloudProvider + title: GCP + GCPHardwareSpec: + type: object + properties: + instanceSize: + type: string + description: Hardware specification for the instance sizes in this region. + Each instance size has a default storage and memory capacity. The instance + size you select applies to all the data-bearing hosts 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 + title: GCP Instance Sizes + nodeCount: + type: integer + format: int32 + description: Number of nodes of the given type for MongoDB Cloud to deploy + to the region. + GCPHardwareSpec20240805: + type: object + properties: + diskSizeGB: + type: number + format: double + description: "Storage capacity of instance data volumes expressed in gigabytes.\ + \ Increase this number to add capacity.\n\n This value must be equal for\ + \ all shards and node types.\n\n This value is not configurable on M0/M2/M5\ + \ clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\ + \n If you specify a disk size below the minimum (10 GB), this parameter\ + \ defaults to the minimum disk size value. \n\n Storage charge calculations\ + \ depend on whether you choose the default value or a custom value.\n\n\ + \ The maximum value for disk storage cannot exceed 50 times the maximum\ + \ RAM for the selected cluster. If you require more storage space, consider\ + \ upgrading your cluster to a higher tier." + maximum: 4096 + minimum: 10 + instanceSize: + type: string + description: Hardware specification for the instance sizes in this region + in this shard. Each instance size has a default storage and memory capacity. + Electable nodes and read-only nodes (known as "base nodes") within a single + shard must use the same instance size. Analytics nodes can scale independently + from base nodes within a shard. Both base nodes and analytics nodes can + scale independently from their equivalents in other shards. + enum: + - M10 + - M20 + - M30 + - M40 + - M50 + - M60 + - M80 + - M140 + - M200 + - M250 + - M300 + - M400 + - R40 + - R50 + - R60 + - R80 + - R200 + - R300 + - R400 + - R600 + title: GCP Instance Sizes + nodeCount: + type: integer + format: int32 + description: Number of nodes of the given type for MongoDB Cloud to deploy + to the region. + GCPNetworkPeeringConnectionSettings: + type: object + description: Group of Network Peering connection settings. + properties: + containerId: + type: string + description: Unique 24-hexadecimal digit string that identifies the MongoDB + Cloud network container that contains the specified network peering connection. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + 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: + 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. + maxLength: 30 + minLength: 6 + pattern: "^[a-z][0-9a-z-]{4,28}[0-9a-z]{1}" + id: + type: string + description: Unique 24-hexadecimal digit string that identifies the network + peering connection. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + networkName: + type: string + description: Human-readable label that identifies the network to peer with + the MongoDB Cloud VPC. + maxLength: 63 + minLength: 1 + pattern: "[a-z]([-a-z0-9]{0,62}[a-z0-9]{0,1})?" + 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. + enum: + - ADDING_PEER + - WAITING_FOR_USER + - AVAILABLE + - FAILED + - DELETING + readOnly: true + required: + - containerId + - gcpProjectId + - networkName + title: GCP + GCPRegionConfig: + type: object + allOf: + - $ref: "#/components/schemas/CloudRegionConfig" + - type: object + properties: + analyticsAutoScaling: + $ref: "#/components/schemas/AdvancedAutoScalingSettings" + analyticsSpecs: + $ref: "#/components/schemas/DedicatedHardwareSpec" + autoScaling: + $ref: "#/components/schemas/AdvancedAutoScalingSettings" + readOnlySpecs: + $ref: "#/components/schemas/DedicatedHardwareSpec" + description: Details that explain how MongoDB Cloud replicates data in one region + on the specified MongoDB database. + title: GCP Regional Replication Specifications + GCPRegionConfig20240805: + type: object + allOf: + - $ref: "#/components/schemas/CloudRegionConfig20240805" + - type: object + properties: + analyticsAutoScaling: + $ref: "#/components/schemas/AdvancedAutoScalingSettings" + analyticsSpecs: + $ref: "#/components/schemas/DedicatedHardwareSpec20240805" + autoScaling: + $ref: "#/components/schemas/AdvancedAutoScalingSettings" + readOnlySpecs: + $ref: "#/components/schemas/DedicatedHardwareSpec20240805" + description: Details that explain how MongoDB Cloud replicates data in one region + on the specified MongoDB database. + title: GCP Regional Replication Specifications + GeoSharding: + type: object + properties: + customZoneMapping: + type: object + additionalProperties: + 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 + 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. + items: + $ref: "#/components/schemas/ManagedNamespaces" + readOnly: true + 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 + GeoSharding20240805: + type: object + properties: + customZoneMapping: + type: object + additionalProperties: + type: string + description: |- + List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone. + + The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property. + + This parameter returns an empty object if no custom zones exist. + readOnly: true + description: |- + List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone. + + The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property. + + This parameter returns an empty object if no custom zones exist. + readOnly: true + managedNamespaces: + type: array + description: List that contains a namespace for a Global Cluster. MongoDB + Cloud manages this cluster. + items: + $ref: "#/components/schemas/ManagedNamespaces" + readOnly: true + 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 + GoogleCloudKMS: + type: object + description: Details that define the configuration of Encryption at Rest using + Google Cloud Key Management Service (KMS). + externalDocs: + description: Google Cloud Key Management Service + url: https://www.mongodb.com/docs/atlas/security-gcp-kms/ + properties: + enabled: + 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 + 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. + externalDocs: + description: Google Cloud Authentication + url: https://cloud.google.com/docs/authentication/getting-started + writeOnly: true + valid: + type: boolean + description: Flag that indicates whether the Google Cloud Key Management + Service (KMS) encryption key can encrypt and decrypt data. + readOnly: true + GreaterThanDaysThresholdView: + type: object + description: Threshold value that triggers an alert. + properties: + operator: + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - GREATER_THAN + threshold: + type: integer + format: int32 + description: "Value of metric that, when exceeded, triggers an alert." + units: + type: string + description: "Element used to express the quantity. This can be an element\ + \ of time, storage capacity, and the like." + enum: + - DAYS + GreaterThanRawThreshold: + type: object + description: A Limit that triggers an alert when greater than a number. + properties: + operator: + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - GREATER_THAN + threshold: + type: integer + format: int32 + description: "Value of metric that, when exceeded, triggers an alert." + units: + $ref: "#/components/schemas/RawMetricUnits" + title: Greater Than Raw Threshold + GreaterThanRawThresholdAlertConfigViewForNdsGroup: + type: object + properties: + created: + type: string + format: date-time + description: Date and time when MongoDB Cloud created the alert configuration. + This parameter expresses its value in the ISO 8601 timestamp format + in UTC. + readOnly: true + enabled: + type: boolean + default: false + description: Flag that indicates whether someone enabled this alert configuration + for the specified project. + eventTypeName: + $ref: "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" + groupId: + type: string + description: Unique 24-hexadecimal digit string that identifies the project + that owns this alert configuration. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + id: + type: string + description: Unique 24-hexadecimal digit string that identifies this alert + configuration. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + matchers: + type: array + description: "List of rules that determine whether MongoDB Cloud checks\ + \ an object for the alert configuration. You can filter using the matchers\ + \ array if the **eventTypeName** specifies an event for a host, replica\ + \ set, or sharded cluster." + items: + $ref: "#/components/schemas/ReplicaSetMatcher" + notifications: + type: array + description: List that contains the targets that MongoDB Cloud sends notifications. + items: + $ref: "#/components/schemas/AlertsNotificationRootForGroup" + threshold: + $ref: "#/components/schemas/GreaterThanRawThreshold" + updated: + type: string + format: date-time + description: Date and time when someone last updated this alert configuration. + This parameter expresses its value in the ISO 8601 timestamp format + in UTC. + readOnly: true + required: + - eventTypeName + - notifications + GreaterThanTimeThreshold: + type: object + description: A Limit that triggers an alert when greater than a time period. + properties: + operator: + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - GREATER_THAN + threshold: + type: integer + format: int32 + description: "Value of metric that, when exceeded, triggers an alert." + units: + $ref: "#/components/schemas/TimeMetricUnits" + title: Greater Than Time Threshold + Group: + type: object + properties: + clusterCount: + type: integer + format: int64 + description: Quantity of MongoDB Cloud clusters deployed in this project. + readOnly: true + created: + type: string + format: date-time + description: Date and time when MongoDB Cloud created this project. This + parameter expresses its value in the ISO 8601 timestamp format in UTC. + readOnly: true + id: + type: string + description: Unique 24-hexadecimal digit string that identifies the MongoDB + Cloud project. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + name: + type: string + description: Human-readable label that identifies the project included in + the MongoDB Cloud organization. + maxLength: 64 + minLength: 1 + pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + orgId: + type: string + description: Unique 24-hexadecimal digit string that identifies the MongoDB + Cloud organization to which the project belongs. + example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" @@ -36641,25 +39736,26 @@ components: maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" - readOnly: true destinationOrgPrivateApiKey: type: string - description: "Unique string that identifies the private part of the [API\ - \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) used\ - \ to verify access to the destination organization. This parameter is\ - \ required only when you authenticate with Programmatic API Keys." + description: Unique string that identifies the private part of the API Key + used to verify access to the destination organization. This parameter + is required only when you authenticate with Programmatic API Keys. example: 55c3bbb6-b4bb-0be1-e66d20841f3e - readOnly: true + externalDocs: + description: Grant Programmatic Access to Atlas + url: https://dochub.mongodb.org/core/atlas-create-prog-api-key destinationOrgPublicApiKey: type: string - description: "Unique string that identifies the public part of the [API\ - \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) used\ - \ to verify access to the destination organization. This parameter is\ - \ required only when you authenticate with Programmatic API Keys." + description: Unique string that identifies the public part of the API Key + used to verify access to the destination organization. This parameter + is required only when you authenticate with Programmatic API Keys. example: zmmrboas + externalDocs: + description: Grant Programmatic Access to Atlas + url: https://dochub.mongodb.org/core/atlas-create-prog-api-key maxLength: 8 minLength: 8 - readOnly: true GroupNotification: type: object description: Group notification configuration for MongoDB Cloud to send information @@ -36749,7 +39845,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/EventViewForNdsGroup" @@ -36797,6 +39893,33 @@ components: - GROUP_READ_ONLY - GROUP_SEARCH_INDEX_EDITOR - GROUP_STREAM_PROCESSING_OWNER + GroupRoleAssignment: + type: object + properties: + groupId: + type: string + description: Unique 24-hexadecimal digit string that identifies the project + to which these roles belong. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + groupRoles: + type: array + description: One or more project level roles assigned to the MongoDB Cloud + user. + items: + type: string + enum: + - GROUP_OWNER + - GROUP_CLUSTER_MANAGER + - GROUP_STREAM_PROCESSING_OWNER + - GROUP_DATA_ACCESS_ADMIN + - GROUP_DATA_ACCESS_READ_WRITE + - GROUP_DATA_ACCESS_READ_ONLY + - GROUP_READ_ONLY + - GROUP_SEARCH_INDEX_EDITOR + uniqueItems: true GroupService: type: object description: List of IP addresses in a project categorized by services. @@ -36812,26 +39935,26 @@ components: GroupServiceAccount: type: object properties: + clientId: + type: string + description: The Client ID of the Service Account. + pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" createdAt: type: string format: date-time - description: Service account creation time. + description: The date that the Service Account was created on. description: type: string - description: Description of the service account. - id: - type: string - description: ID for the service account. - pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" + description: Human readable description for the Service Account. name: type: string - description: Name for service account. + description: Human-readable name for the Service Account. roles: type: array - description: Roles assigned to the Service Account group. + description: A list of Project roles associated with the Service Account. items: type: string - description: Project roles associated with the service account. + description: Project roles available for Service Accounts. enum: - GROUP_OWNER - GROUP_READ_ONLY @@ -36844,7 +39967,7 @@ components: uniqueItems: true secrets: type: array - description: List of secrets. + description: A list of secrets associated with the specified Service Account. items: $ref: "#/components/schemas/ServiceAccountSecret" uniqueItems: true @@ -36853,23 +39976,23 @@ components: properties: description: type: string - description: Human readable description for the service account. + description: Human readable description for the Service Account. maxLength: 250 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" name: type: string - description: Human-readable name for the service account. The name is modifiable + description: Human-readable name for the Service Account. The name is modifiable and does not have to be unique. maxLength: 64 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" roles: type: array - description: Project roles associated with the service account. + description: A list of project-level roles for the Service Account. items: type: string - description: Project roles associated with the service account. + description: Project roles available for Service Accounts. enum: - GROUP_OWNER - GROUP_READ_ONLY @@ -36882,20 +40005,23 @@ components: secretExpiresAfterHours: type: integer format: int32 - description: Secret expiration time. + description: The expiration time of the new Service Account secret. The + expiration is provided in hours. required: - description - name + - roles - secretExpiresAfterHours GroupServiceAccountRoleAssignment: type: object properties: roles: type: array - description: Group access roles. + description: The Project permissions for the Service Account in the specified + Project. items: type: string - description: Project roles associated with the service account. + description: Project roles available for Service Accounts. enum: - GROUP_OWNER - GROUP_READ_ONLY @@ -36906,28 +40032,30 @@ components: - GROUP_SEARCH_INDEX_EDITOR - GROUP_STREAM_PROCESSING_OWNER uniqueItems: true + required: + - roles GroupServiceAccountUpdateRequest: type: object properties: description: type: string - description: Human readable description for the service account. + description: Human readable description for the Service Account. maxLength: 250 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" name: type: string - description: Human-readable name for the service account. The name is modifiable + description: Human-readable name for the Service Account. The name is modifiable and does not have to be unique. maxLength: 64 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" roles: type: array - description: Project roles associated with the service account. + description: A list of Project roles associated with the Service Account. items: type: string - description: Project roles associated with the service account. + description: Project roles available for Service Accounts. enum: - GROUP_OWNER - GROUP_READ_ONLY @@ -37191,7 +40319,7 @@ components: example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -37310,6 +40438,8 @@ components: - HOST_HAS_INDEX_SUGGESTIONS - HOST_MONGOT_RECOVERED_OOM - HOST_MONGOT_CRASHING_OOM + - HOST_MONGOT_RESUME_REPLICATION + - HOST_MONGOT_STOP_REPLICATION - HOST_ENOUGH_DISK_SPACE - HOST_NOT_ENOUGH_DISK_SPACE example: HOST_DOWN @@ -37321,6 +40451,7 @@ components: - HOST_DOWN - HOST_HAS_INDEX_SUGGESTIONS - HOST_MONGOT_CRASHING_OOM + - HOST_MONGOT_STOP_REPLICATION - HOST_NOT_ENOUGH_DISK_SPACE example: HOST_DOWN title: Host Event Types @@ -37617,6 +40748,7 @@ components: OPCOUNTER_REPL_INSERT: "#/components/schemas/RawMetricAlertView" OPCOUNTER_REPL_UPDATE: "#/components/schemas/RawMetricAlertView" OPCOUNTER_UPDATE: "#/components/schemas/RawMetricAlertView" + OPERATIONS_QUERIES_KILLED: "#/components/schemas/RawMetricAlertView" OPERATIONS_SCAN_AND_ORDER: "#/components/schemas/RawMetricAlertView" OPERATION_THROTTLING_REJECTED_OPERATIONS: "#/components/schemas/RawMetricAlertView" OPLOG_MASTER_LAG_TIME_DIFF: "#/components/schemas/TimeMetricAlertView" @@ -37691,7 +40823,7 @@ components: example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -38020,6 +41152,7 @@ components: OPCOUNTER_REPL_INSERT: "#/components/schemas/RawMetricEventView" OPCOUNTER_REPL_UPDATE: "#/components/schemas/RawMetricEventView" OPCOUNTER_UPDATE: "#/components/schemas/RawMetricEventView" + OPERATIONS_QUERIES_KILLED: "#/components/schemas/RawMetricEventView" OPERATIONS_SCAN_AND_ORDER: "#/components/schemas/RawMetricEventView" OPERATION_THROTTLING_REJECTED_OPERATIONS: "#/components/schemas/RawMetricEventView" OPLOG_MASTER_LAG_TIME_DIFF: "#/components/schemas/TimeMetricEventView" @@ -38325,6 +41458,7 @@ components: OPCOUNTER_REPL_INSERT: "#/components/schemas/RawMetricThresholdView" OPCOUNTER_REPL_UPDATE: "#/components/schemas/RawMetricThresholdView" OPCOUNTER_UPDATE: "#/components/schemas/RawMetricThresholdView" + OPERATIONS_QUERIES_KILLED: "#/components/schemas/RawMetricThresholdView" OPERATIONS_SCAN_AND_ORDER: "#/components/schemas/RawMetricThresholdView" OPERATION_THROTTLING_REJECTED_OPERATIONS: "#/components/schemas/RawMetricThresholdView" OPLOG_MASTER_LAG_TIME_DIFF: "#/components/schemas/TimeMetricThresholdView" @@ -38369,7 +41503,12 @@ components: enum: - AVERAGE operator: - $ref: "#/components/schemas/Operator" + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - LESS_THAN + - GREATER_THAN threshold: type: number format: double @@ -38846,7 +41985,7 @@ components: the charge. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -39282,6 +42421,21 @@ components: - ATLAS_AWS_STREAM_PROCESSING_DATA_TRANSFER - ATLAS_AZURE_STREAM_PROCESSING_DATA_TRANSFER - ATLAS_AWS_STREAM_PROCESSING_VPC_PEERING + - 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 readOnly: true startDate: type: string @@ -39607,6 +42761,371 @@ components: - REPLICASET - SHARDED - GEOSHARDED + configServerManagementMode: + type: string + default: ATLAS_MANAGED + description: |- + Config Server Management Mode for creating or updating a sharded cluster. + + When configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings. + + When configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server. + enum: + - ATLAS_MANAGED + - FIXED_TO_DEDICATED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + configServerType: + type: string + description: Describes a sharded cluster's config server type. + enum: + - DEDICATED + - EMBEDDED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + readOnly: true + connectionStrings: + $ref: "#/components/schemas/ClusterConnectionStrings" + createDate: + type: string + format: date-time + description: Date and time when MongoDB Cloud created this serverless instance. + MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. + readOnly: true + diskSizeGB: + type: number + format: double + 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." + maximum: 4096 + minimum: 10 + diskWarmingMode: + type: string + default: FULLY_WARMED + description: Disk warming mode selection. + enum: + - FULLY_WARMED + - VISIBLE_EARLIER + externalDocs: + description: Reduce Secondary Disk Warming Impact + url: https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact + encryptionAtRestProvider: + type: string + description: Cloud service provider that manages your customer keys to provide + an additional layer of Encryption at Rest for the cluster. + enum: + - NONE + - AWS + - AZURE + - GCP + externalDocs: + description: Encryption at Rest using Customer Key Management + url: https://www.mongodb.com/docs/atlas/security-kms-encryption/ + featureCompatibilityVersion: + type: string + description: Feature compatibility version of the cluster. + readOnly: true + featureCompatibilityVersionExpirationDate: + type: string + format: date-time + description: Feature compatibility version expiration date. + 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: + type: string + description: Unique 24-hexadecimal character string that identifies the + project. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + id: + type: string + description: Unique 24-hexadecimal digit string that identifies the cluster. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + labels: + type: array + deprecated: true + description: |- + Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels. + + Cluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead. + items: + $ref: "#/components/schemas/ComponentLabel" + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + 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- + mongoDBVersion: + type: string + description: Version of MongoDB that the cluster runs. + pattern: "([\\d]+\\.[\\d]+\\.[\\d]+)" + 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." + externalDocs: + description: Connection string URI format. + url: https://docs.mongodb.com/manual/reference/connection-string/ + readOnly: true + mongoURIUpdated: + type: string + format: date-time + description: Date and time when someone last updated the connection string. + MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. + readOnly: true + 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." + externalDocs: + description: Connection string URI format. + url: https://docs.mongodb.com/manual/reference/connection-string/ + readOnly: true + name: + type: string + description: Human-readable label that identifies the cluster. + maxLength: 64 + minLength: 1 + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + numShards: + type: integer + format: int32 + default: 1 + description: Number of shards up to 50 to deploy for a sharded cluster. + The resource returns `1` to indicate a replica set and values of `2` and + higher to indicate a sharded cluster. The returned value equals the number + of shards in the cluster. + externalDocs: + description: Sharding + url: https://docs.mongodb.com/manual/sharding/ + maximum: 50 + minimum: 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 + default: WORKLOAD_TYPE + description: |- + Set this field to configure the replica set scaling mode for your cluster. + + By default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes. + + When configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads. + + When configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads. + enum: + - SEQUENTIAL + - WORKLOAD_TYPE + - NODE_TYPE + externalDocs: + description: Modify the Replica Set Scaling Mode + url: https://dochub.mongodb.org/core/scale-nodes + replicationFactor: + type: integer + format: int32 + default: 3 + deprecated: true + description: "Number of members that belong to the replica set. Each member\ + \ retains a copy of your databases, providing high availability and data\ + \ redundancy. Use **replicationSpecs** instead." + enum: + - 3 + - 5 + - 7 + replicationSpec: + type: object + additionalProperties: + $ref: "#/components/schemas/RegionSpec" + description: Physical location where MongoDB Cloud provisions cluster nodes. + title: Region Configuration + 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. + items: + $ref: "#/components/schemas/LegacyReplicationSpec" + rootCertType: + type: string + default: ISRGROOTX1 + description: Root Certificate Authority that MongoDB Atlas clusters uses. + MongoDB Cloud supports Internet Security Research Group. + 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. + externalDocs: + description: Connection string URI format. + url: https://docs.mongodb.com/manual/reference/connection-string/ + readOnly: true + stateName: + type: string + description: Human-readable label that indicates the current operating condition + of the cluster. + enum: + - IDLE + - CREATING + - UPDATING + - DELETING + - REPAIRING + readOnly: true + tags: + type: array + description: List that contains key-value pairs between 1 to 255 characters + in length for tagging and categorizing the cluster. + externalDocs: + description: Resource Tags + url: https://dochub.mongodb.org/core/add-cluster-tag-atlas + items: + $ref: "#/components/schemas/ResourceTag" + terminationProtectionEnabled: + type: boolean + default: false + description: "Flag that indicates whether termination protection is enabled\ + \ on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster.\ + \ If set to `false`, MongoDB Cloud will delete the cluster." + versionReleaseSystem: + type: string + default: LTS + description: "Method by which the cluster maintains the MongoDB versions.\ + \ If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**." + enum: + - LTS + - CONTINUOUS + title: Cluster Description + LegacyAtlasTenantClusterUpgradeRequest: + type: object + description: Request containing target state of tenant cluster to be upgraded + properties: + acceptDataRisksAndForceReplicaSetReconfig: + type: string + format: date-time + description: "If reconfiguration is necessary to regain a primary due to\ + \ a regional outage, submit this field alongside your topology reconfiguration\ + \ to request a new regional outage resistant topology. Forced reconfigurations\ + \ during an outage of the majority of electable nodes carry a risk of\ + \ data loss if replicated writes (even majority committed writes) have\ + \ not been replicated to the new primary node. MongoDB Atlas docs contain\ + \ more information. To proceed with an operation which carries that risk,\ + \ set **acceptDataRisksAndForceReplicaSetReconfig** to the current date." + externalDocs: + description: Reconfiguring a Replica Set during a regional outage + url: https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set + 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 + default: ATLAS_MANAGED + description: |- + Config Server Management Mode for creating or updating a sharded cluster. + + When configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings. + + When configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server. + enum: + - ATLAS_MANAGED + - FIXED_TO_DEDICATED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + configServerType: + type: string + description: Describes a sharded cluster's config server type. + enum: + - DEDICATED + - EMBEDDED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + readOnly: true connectionStrings: $ref: "#/components/schemas/ClusterConnectionStrings" createDate: @@ -39651,6 +43170,15 @@ components: externalDocs: description: Encryption at Rest using Customer Key Management url: https://www.mongodb.com/docs/atlas/security-kms-encryption/ + featureCompatibilityVersion: + type: string + description: Feature compatibility version of the cluster. + readOnly: true + featureCompatibilityVersionExpirationDate: + type: string + format: date-time + description: Feature compatibility version expiration date. + readOnly: true globalClusterSelfManagedSharding: type: boolean description: |- @@ -39701,6 +43229,8 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true + mongoDBEmployeeAccessGrant: + $ref: "#/components/schemas/EmployeeAccessGrantView" mongoDBMajorVersion: type: string description: |- @@ -39747,7 +43277,7 @@ components: description: Human-readable label that identifies the cluster. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" numShards: type: integer format: int32 @@ -39779,292 +43309,24 @@ components: \ use MongoDB Cloud backups." providerSettings: $ref: "#/components/schemas/ClusterProviderSettings" - replicationFactor: - type: integer - format: int32 - default: 3 - deprecated: true - description: "Number of members that belong to the replica set. Each member\ - \ retains a copy of your databases, providing high availability and data\ - \ redundancy. Use **replicationSpecs** instead." - enum: - - 3 - - 5 - - 7 - replicationSpec: - type: object - additionalProperties: - $ref: "#/components/schemas/RegionSpec" - description: Physical location where MongoDB Cloud provisions cluster nodes. - title: Region Configuration - 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. - items: - $ref: "#/components/schemas/LegacyReplicationSpec" - rootCertType: - type: string - default: ISRGROOTX1 - description: Root Certificate Authority that MongoDB Atlas clusters uses. - MongoDB Cloud supports Internet Security Research Group. - 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. - externalDocs: - description: Connection string URI format. - url: https://docs.mongodb.com/manual/reference/connection-string/ - readOnly: true - stateName: - type: string - description: Human-readable label that indicates the current operating condition - of the cluster. - enum: - - IDLE - - CREATING - - UPDATING - - DELETING - - REPAIRING - readOnly: true - tags: - type: array - description: List that contains key-value pairs between 1 to 255 characters - in length for tagging and categorizing the cluster. - externalDocs: - description: Resource Tags - url: https://dochub.mongodb.org/core/add-cluster-tag-atlas - items: - $ref: "#/components/schemas/ResourceTag" - terminationProtectionEnabled: - type: boolean - default: false - description: "Flag that indicates whether termination protection is enabled\ - \ on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster.\ - \ If set to `false`, MongoDB Cloud will delete the cluster." - versionReleaseSystem: - type: string - default: LTS - description: "Method by which the cluster maintains the MongoDB versions.\ - \ If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**." - enum: - - LTS - - CONTINUOUS - title: Cluster Description - LegacyAtlasTenantClusterUpgradeRequest: - type: object - description: Request containing target state of tenant cluster to be upgraded - properties: - acceptDataRisksAndForceReplicaSetReconfig: - type: string - format: date-time - description: "If reconfiguration is necessary to regain a primary due to\ - \ a regional outage, submit this field alongside your topology reconfiguration\ - \ to request a new regional outage resistant topology. Forced reconfigurations\ - \ during an outage of the majority of electable nodes carry a risk of\ - \ data loss if replicated writes (even majority committed writes) have\ - \ not been replicated to the new primary node. MongoDB Atlas docs contain\ - \ more information. To proceed with an operation which carries that risk,\ - \ set **acceptDataRisksAndForceReplicaSetReconfig** to the current date." - externalDocs: - description: Reconfiguring a Replica Set during a regional outage - url: https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set - 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 - connectionStrings: - $ref: "#/components/schemas/ClusterConnectionStrings" - createDate: - type: string - format: date-time - description: Date and time when MongoDB Cloud created this serverless instance. - MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. - readOnly: true - diskSizeGB: - type: number - format: double - 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." - maximum: 4096 - minimum: 10 - diskWarmingMode: - type: string - default: FULLY_WARMED - description: Disk warming mode selection. - enum: - - FULLY_WARMED - - VISIBLE_EARLIER - externalDocs: - description: Reduce Secondary Disk Warming Impact - url: https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact - encryptionAtRestProvider: - type: string - description: Cloud service provider that manages your customer keys to provide - an additional layer of Encryption at Rest for the cluster. - enum: - - NONE - - AWS - - AZURE - - GCP - externalDocs: - description: Encryption at Rest using Customer Key Management - url: https://www.mongodb.com/docs/atlas/security-kms-encryption/ - 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: - type: string - description: Unique 24-hexadecimal character string that identifies the - project. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - id: + replicaSetScalingStrategy: type: string - description: Unique 24-hexadecimal digit string that identifies the cluster. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - labels: - type: array - deprecated: true + default: WORKLOAD_TYPE 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. + Set this field to configure the replica set scaling mode for your cluster. - Cluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead. - items: - $ref: "#/components/schemas/ComponentLabel" - links: - type: array - description: "List of one or more Uniform Resource Locators (URLs) that\ - \ point to API sub-resources, related API resources, or both. RFC 5988\ - \ outlines these relationships." - externalDocs: - description: Web Linking Specification (RFC 5988) - url: https://datatracker.ietf.org/doc/html/rfc5988 - items: - $ref: "#/components/schemas/Link" - readOnly: true - mongoDBMajorVersion: - type: string - description: |- - MongoDB major version of the cluster. + By default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes. - 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). + When configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads. - 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- - mongoDBVersion: - type: string - description: Version of MongoDB that the cluster runs. - pattern: "([\\d]+\\.[\\d]+\\.[\\d]+)" - 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." - externalDocs: - description: Connection string URI format. - url: https://docs.mongodb.com/manual/reference/connection-string/ - readOnly: true - mongoURIUpdated: - type: string - format: date-time - description: Date and time when someone last updated the connection string. - MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. - readOnly: true - 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." - externalDocs: - description: Connection string URI format. - url: https://docs.mongodb.com/manual/reference/connection-string/ - readOnly: true - name: - type: string - description: Human-readable label that identifies the cluster. - maxLength: 64 - minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - numShards: - type: integer - format: int32 - default: 1 - description: Number of shards up to 50 to deploy for a sharded cluster. - The resource returns `1` to indicate a replica set and values of `2` and - higher to indicate a sharded cluster. The returned value equals the number - of shards in the cluster. - externalDocs: - description: Sharding - url: https://docs.mongodb.com/manual/sharding/ - maximum: 50 - minimum: 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. + When configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads. + enum: + - SEQUENTIAL + - WORKLOAD_TYPE + - NODE_TYPE externalDocs: - description: 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" + description: Modify the Replica Set Scaling Mode + url: https://dochub.mongodb.org/core/scale-nodes replicationFactor: type: integer format: int32 @@ -40627,6 +43889,10 @@ components: - INSTANCE_NAME - PROCESSOR_NAME title: Streams Matcher Fields + - type: string + enum: + - RULE_ID + title: Log Ingestion Matcher Fields MatcherHostType: type: string description: Value to match or exceed using the specified **matchers.operator**. @@ -41341,6 +44607,7 @@ components: - 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 @@ -41418,6 +44685,8 @@ components: - 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 @@ -41447,6 +44716,9 @@ components: - 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 @@ -41505,9 +44777,13 @@ components: - 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 example: CLUSTER_CREATED title: NDS Audit Types NDSAuditTypeViewForOrg: @@ -42483,7 +45759,7 @@ components: example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -42742,7 +46018,12 @@ components: enum: - AVERAGE operator: - $ref: "#/components/schemas/Operator" + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - LESS_THAN + - GREATER_THAN threshold: type: number format: double @@ -42932,6 +46213,57 @@ components: required: - typeName title: OpsGenie Notification + OrgActiveUserResponse: + type: object + allOf: + - $ref: "#/components/schemas/OrgUserResponse" + - type: object + properties: + country: + type: string + description: Two alphabet characters that identifies MongoDB Cloud user's + geographic location. This parameter uses the ISO 3166-1a2 code format. + example: US + pattern: "^([A-Z]{2})$" + readOnly: true + createdAt: + type: string + format: date-time + description: Date and time when MongoDB Cloud created the current account. + This value is in the ISO 8601 timestamp format in UTC. + readOnly: true + firstName: + type: string + description: First or given name that belongs to the MongoDB Cloud user. + example: John + readOnly: true + lastAuth: + type: string + format: date-time + description: Date and time when the current account last authenticated. + This value is in the ISO 8601 timestamp format in UTC. + readOnly: true + lastName: + type: string + description: "Last name, family name, or surname that belongs to the MongoDB\ + \ Cloud user." + example: Doe + readOnly: true + mobileNumber: + type: string + description: Mobile phone number that belongs to the MongoDB Cloud user. + pattern: "(?:(?:\\\\+?1\\\\s*(?:[.-]\\\\s*)?)?(?:(\\\\s*([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9])\\\ + \\s*)|([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9]))\\\\s*(?:[.-]\\\\\ + s*)?)([2-9]1[02-9]|[2-9][02-9]1|[2-9][02-9]{2})\\\\s*(?:[.-]\\\\s*)?([0-9]{4})$" + readOnly: true + required: + - createdAt + - firstName + - id + - lastName + - orgMembershipStatus + - roles + - username OrgEventTypeViewForOrg: type: string description: Unique identifier of event type. @@ -43282,7 +46614,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/EventViewForOrg" @@ -43294,29 +46626,61 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true + OrgPendingUserResponse: + type: object + allOf: + - $ref: "#/components/schemas/OrgUserResponse" + - type: object + properties: + invitationCreatedAt: + type: string + format: date-time + description: Date and time when MongoDB Cloud sent the invitation. MongoDB + Cloud represents this timestamp in ISO 8601 format in UTC. + readOnly: true + invitationExpiresAt: + type: string + format: date-time + description: Date and time when the invitation from MongoDB Cloud expires. + MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. + readOnly: true + inviterUsername: + type: string + format: email + description: Username of the MongoDB Cloud user who sent the invitation + to join the organization. + readOnly: true + required: + - id + - invitationCreatedAt + - invitationExpiresAt + - inviterUsername + - orgMembershipStatus + - roles + - username OrgServiceAccount: type: object properties: + clientId: + type: string + description: The Client ID of the Service Account. + pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" createdAt: type: string format: date-time - description: Service account creation time. + description: The date that the Service Account was created on. description: type: string - description: Description of the service account. - id: - type: string - description: ID for the service account. - pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" + description: Human readable description for the Service Account. name: type: string - description: Name for service account. + description: Human-readable name for the Service Account. roles: type: array - description: Organization roles assigned to the Service Account. + description: A list of Organization roles associated with the Service Account. items: type: string - description: Organization roles associated with the service account. + description: Organization roles available for Service Accounts. enum: - ORG_MEMBER - ORG_READ_ONLY @@ -43327,7 +46691,7 @@ components: uniqueItems: true secrets: type: array - description: List of secrets. + description: A list of secrets associated with the specified Service Account. items: $ref: "#/components/schemas/ServiceAccountSecret" uniqueItems: true @@ -43336,23 +46700,23 @@ components: properties: description: type: string - description: Human readable description for the service account. + description: Human readable description for the Service Account. maxLength: 250 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" name: type: string - description: Human-readable name for the service account. The name is modifiable + description: Human-readable name for the Service Account. The name is modifiable and does not have to be unique. maxLength: 64 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" roles: type: array - description: Organization roles associated with the service account. + description: A list of organization-level roles for the Service Account. items: type: string - description: Organization roles associated with the service account. + description: Organization roles available for Service Accounts. enum: - ORG_MEMBER - ORG_READ_ONLY @@ -43363,33 +46727,35 @@ components: secretExpiresAfterHours: type: integer format: int32 - description: Secret expiration time. + description: The expiration time of the new Service Account secret. The + expiration is provided in hours. required: - description - name + - roles - secretExpiresAfterHours OrgServiceAccountUpdateRequest: type: object properties: description: type: string - description: Human readable description for the service account. + description: Human readable description for the Service Account. maxLength: 250 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" name: type: string - description: Human-readable name for the service account. The name is modifiable + description: Human-readable name for the Service Account. The name is modifiable and does not have to be unique. maxLength: 64 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" roles: type: array - description: Organization roles associated with the Service account. + description: A list of organization-level roles for the Service Account. items: type: string - description: Organization roles associated with the service account. + description: Organization roles available for Service Accounts. enum: - ORG_MEMBER - ORG_READ_ONLY @@ -43397,6 +46763,158 @@ components: - ORG_BILLING_READ_ONLY - ORG_GROUP_CREATOR - ORG_OWNER + OrgUserRequest: + type: object + properties: + roles: + $ref: "#/components/schemas/OrgUserRolesRequest" + teamIds: + type: array + description: List of unique 24-hexadecimal digit strings that identifies + the teams to which this MongoDB Cloud user belongs. + items: + type: string + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + uniqueItems: true + writeOnly: true + username: + type: string + format: email + description: Email address that represents the username of the MongoDB Cloud + user. + writeOnly: true + required: + - roles + - username + OrgUserResponse: + type: object + discriminator: + mapping: + ACTIVE: "#/components/schemas/OrgActiveUserResponse" + PENDING: "#/components/schemas/OrgPendingUserResponse" + propertyName: orgMembershipStatus + oneOf: + - $ref: "#/components/schemas/OrgPendingUserResponse" + - $ref: "#/components/schemas/OrgActiveUserResponse" + properties: + id: + type: string + description: Unique 24-hexadecimal digit string that identifies the MongoDB + Cloud user. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + orgMembershipStatus: + type: string + description: String enum that indicates whether the MongoDB Cloud user has + a pending invitation to join the organization or they are already active + in the organization. + enum: + - PENDING + - ACTIVE + readOnly: true + roles: + $ref: "#/components/schemas/OrgUserRolesResponse" + teamIds: + type: array + description: List of unique 24-hexadecimal digit strings that identifies + the teams to which this MongoDB Cloud user belongs. + items: + type: string + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + uniqueItems: true + username: + type: string + format: email + description: Email address that represents the username of the MongoDB Cloud + user. + readOnly: true + required: + - id + - orgMembershipStatus + - roles + - username + OrgUserRolesRequest: + type: object + description: Organization and project level roles to assign the MongoDB Cloud + user within one organization. + properties: + groupRoleAssignments: + type: array + description: List of project level role assignments to assign the MongoDB + Cloud user. + items: + $ref: "#/components/schemas/GroupRoleAssignment" + orgRoles: + type: array + description: One or more organization level roles to assign the MongoDB + Cloud user. + items: + type: string + enum: + - ORG_OWNER + - ORG_GROUP_CREATOR + - ORG_BILLING_ADMIN + - ORG_BILLING_READ_ONLY + - ORG_READ_ONLY + - ORG_MEMBER + minItems: 1 + uniqueItems: true + required: + - orgRoles + writeOnly: true + OrgUserRolesResponse: + type: object + description: Organization and project level roles assigned to one MongoDB Cloud + user within one organization. + properties: + groupRoleAssignments: + type: array + description: List of project level role assignments assigned to the MongoDB + Cloud user. + items: + $ref: "#/components/schemas/GroupRoleAssignment" + orgRoles: + type: array + description: One or more organization level roles assigned to the MongoDB + Cloud user. + items: + type: string + enum: + - ORG_OWNER + - ORG_GROUP_CREATOR + - ORG_BILLING_ADMIN + - ORG_BILLING_READ_ONLY + - ORG_READ_ONLY + - ORG_MEMBER + uniqueItems: true + readOnly: true + OrgUserUpdateRequest: + type: object + properties: + roles: + $ref: "#/components/schemas/OrgUserRolesRequest" + teamIds: + type: array + description: List of unique 24-hexadecimal digit strings that identifies + the teams to assign the MongoDB Cloud user. + items: + type: string + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + uniqueItems: true + writeOnly: true OrganizationInvitation: type: object properties: @@ -43608,10 +47126,11 @@ components: restrictEmployeeAccess: type: boolean description: "Flag that indicates whether to block MongoDB Support from\ - \ accessing Atlas infrastructure 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/." + \ 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/." OutboundControlPlaneCloudProviderIPAddresses: type: object description: "List of outbound IP addresses from the Atlas control plane, categorized\ @@ -43784,7 +47303,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/AdvancedClusterDescription" @@ -43812,7 +47331,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/GroupAlertsConfig" @@ -43840,7 +47359,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/AlertViewForNdsGroup" @@ -43868,7 +47387,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ApiKeyUserDetails" @@ -43896,7 +47415,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/CloudAppUser" @@ -43924,7 +47443,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ApiAtlasCheckpointView" @@ -43954,7 +47473,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/CloudDatabaseUser" @@ -43982,7 +47501,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/DiskBackupExportJob" @@ -44010,7 +47529,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/EARPrivateEndpoint" @@ -44022,7 +47541,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedApiAtlasProviderRegionsView: + PaginatedApiAtlasFlexBackupRestoreJob20250101View: type: object properties: links: @@ -44038,10 +47557,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/CloudProviderRegions" + $ref: "#/components/schemas/FlexBackupRestoreJob20250101" readOnly: true totalCount: type: integer @@ -44050,7 +47569,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedApiAtlasServerlessBackupRestoreJobView: + PaginatedApiAtlasFlexBackupSnapshot20240710View: type: object properties: links: @@ -44066,10 +47585,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/ServerlessBackupRestoreJob" + $ref: "#/components/schemas/FlexBackupSnapshot20250101" readOnly: true totalCount: type: integer @@ -44078,7 +47597,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedApiAtlasServerlessBackupSnapshotView: + PaginatedApiAtlasProviderRegionsView: type: object properties: links: @@ -44094,10 +47613,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/ServerlessBackupSnapshot" + $ref: "#/components/schemas/CloudProviderRegions" readOnly: true totalCount: type: integer @@ -44106,7 +47625,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedApiAtlasUSSBackupRestoreJob20250101View: + PaginatedApiAtlasServerlessBackupRestoreJobView: type: object properties: links: @@ -44122,10 +47641,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/USSBackupRestoreJob20250101" + $ref: "#/components/schemas/ServerlessBackupRestoreJob" readOnly: true totalCount: type: integer @@ -44134,7 +47653,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedApiAtlasUSSBackupSnapshot20240710View: + PaginatedApiAtlasServerlessBackupSnapshotView: type: object properties: links: @@ -44150,10 +47669,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/USSBackupSnapshot20250101" + $ref: "#/components/schemas/ServerlessBackupSnapshot" readOnly: true totalCount: type: integer @@ -44178,7 +47697,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/BillingInvoiceMetadata" @@ -44206,7 +47725,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/BillingInvoice" @@ -44234,7 +47753,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/StreamsConnection" @@ -44246,6 +47765,34 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true + PaginatedApiStreamsPrivateLinkView: + type: object + properties: + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + results: + type: array + description: List of returned documents that MongoDB Cloud provides when + completing this request. + items: + $ref: "#/components/schemas/StreamsPrivateLinkConnection" + readOnly: true + totalCount: + type: integer + format: int32 + description: Total number of documents available. MongoDB Cloud omits this + value if `includeCount` is set to `false`. + minimum: 0 + readOnly: true PaginatedApiStreamsStreamProcessorWithStatsView: type: object properties: @@ -44262,7 +47809,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/StreamsProcessorWithStats" @@ -44290,7 +47837,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/StreamsTenant" @@ -44318,7 +47865,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/UserAccessListResponse" @@ -44330,6 +47877,34 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true + PaginatedApiVersions: + type: object + properties: + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + results: + type: array + description: List of returned documents that MongoDB Cloud provides when + completing this request. + items: + $ref: "#/components/schemas/ApiVersion" + readOnly: true + totalCount: + type: integer + format: int32 + description: Total number of documents available. MongoDB Cloud omits this + value if `includeCount` is set to `false`. + minimum: 0 + readOnly: true PaginatedAppUserView: type: object properties: @@ -44346,7 +47921,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/CloudAppUser" @@ -44374,7 +47949,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/Group" @@ -44402,7 +47977,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/MdbAvailableVersion" @@ -44430,7 +48005,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/DiskBackupSnapshotAWSExportBucket" @@ -44458,7 +48033,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/DiskBackupSnapshotExportBucket" @@ -44486,7 +48061,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/DiskBackupSnapshot" @@ -44514,7 +48089,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/DiskBackupReplicaSet" @@ -44542,7 +48117,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/DiskBackupSnapshotRestoreJob" @@ -44570,7 +48145,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/DiskBackupShardedClusterSnapshot" @@ -44599,7 +48174,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/CloudProviderContainer" @@ -44628,7 +48203,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ClusterDescription20240805" @@ -44656,7 +48231,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ConnectedOrgConfig" @@ -44685,7 +48260,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/BaseNetworkPeeringConnectionSettings" @@ -44713,7 +48288,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/MesurementsDatabase" @@ -44741,7 +48316,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/MeasurementDiskPartition" @@ -44769,7 +48344,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/EventTypeDetails" @@ -44797,7 +48372,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/FederationIdentityProvider" @@ -44809,9 +48384,37 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true + PaginatedFlexClusters20250101: + type: object + properties: + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + results: + type: array + description: List of returned documents that MongoDB Cloud provides when + completing this request. + items: + type: object + readOnly: true + totalCount: + type: integer + format: int32 + description: Total number of documents available. MongoDB Cloud omits this + value if `includeCount` is set to `false`. + minimum: 0 + readOnly: true PaginatedGroupServiceAccounts: type: object - description: List of Service Accounts + description: A list of Project Service Accounts. properties: links: type: array @@ -44826,7 +48429,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/GroupServiceAccount" @@ -44854,7 +48457,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ApiHostView_Atlas" @@ -44882,7 +48485,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ThirdPartyIntegration" @@ -44910,7 +48513,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/LegacyAtlasCluster" @@ -44938,7 +48541,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/NetworkPermissionEntry" @@ -44966,7 +48569,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/BackupOnlineArchive" @@ -44994,7 +48597,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/OrgGroup" @@ -45008,7 +48611,7 @@ components: readOnly: true PaginatedOrgServiceAccounts: type: object - description: List of Service Accounts + description: A list of Organization Service Accounts. properties: links: type: array @@ -45023,7 +48626,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/OrgServiceAccount" @@ -45051,7 +48654,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/AtlasOrganization" @@ -45079,7 +48682,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/IngestionPipelineRun" @@ -45107,7 +48710,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/PrivateNetworkEndpointIdEntry" @@ -45135,7 +48738,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/PublicApiUsageDetailsLineItemView" @@ -45163,7 +48766,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/BackupRestoreJob" @@ -45193,7 +48796,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/AuthFederationRoleMapping" @@ -45221,7 +48824,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ServerlessInstanceDescription" @@ -45235,7 +48838,7 @@ components: readOnly: true PaginatedServiceAccountGroup: type: object - description: List of Service Account projects. + description: A list of projects associated with the Service Account. properties: links: type: array @@ -45250,7 +48853,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ServiceAccountGroup" @@ -45262,7 +48865,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedSnapshotView: + PaginatedServiceAccountIPAccessEntryView: type: object properties: links: @@ -45278,10 +48881,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/BackupSnapshot" + $ref: "#/components/schemas/ServiceAccountIPAccessListEntry" readOnly: true totalCount: type: integer @@ -45290,7 +48893,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedTeamRoleView: + PaginatedSnapshotView: type: object properties: links: @@ -45306,10 +48909,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/TeamRole" + $ref: "#/components/schemas/BackupSnapshot" readOnly: true totalCount: type: integer @@ -45318,7 +48921,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedTeamView: + PaginatedTeamRoleView: type: object properties: links: @@ -45334,10 +48937,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/TeamResponse" + $ref: "#/components/schemas/TeamRole" readOnly: true totalCount: type: integer @@ -45346,7 +48949,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedTenantRestoreView: + PaginatedTeamView: type: object properties: links: @@ -45362,10 +48965,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/TenantRestore" + $ref: "#/components/schemas/TeamResponse" readOnly: true totalCount: type: integer @@ -45374,7 +48977,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedTenantSnapshotView: + PaginatedTenantRestoreView: type: object properties: links: @@ -45390,10 +48993,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/BackupTenantSnapshot" + $ref: "#/components/schemas/TenantRestore" readOnly: true totalCount: type: integer @@ -45402,7 +49005,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedUSSInstance20250101: + PaginatedTenantSnapshotView: type: object properties: links: @@ -45418,10 +49021,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - type: object + $ref: "#/components/schemas/BackupTenantSnapshot" readOnly: true totalCount: type: integer @@ -45446,7 +49049,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/UserCert" @@ -45934,6 +49537,13 @@ components: PrivateNetworkEndpointIdEntry: type: object properties: + azureConnectionName: + type: string + description: Connection name that identifies the Azure private endpoint + connection. + 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. @@ -45941,6 +49551,10 @@ components: type: string description: Human-readable label to identify customer's VPC endpoint DNS name. + customerEndpointIPAddress: + type: string + description: IP address used to connect to the Azure private endpoint. + pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" endpointId: type: string description: Unique 22-character alphanumeric string that identifies the @@ -45953,6 +49567,10 @@ components: maxLength: 22 minLength: 22 pattern: "^vpce-[0-9a-f]{17}$" + errorMessage: + type: string + description: Error message describing a failure approving the private endpoint + request. provider: type: string default: AWS @@ -45964,6 +49582,14 @@ components: type: string description: Human-readable label to identify the region of customer's VPC endpoint. + status: + type: string + description: Status of the private endpoint connection request. + enum: + - PENDING + - OK + - FAILED + - DELETING type: type: string default: DATA_LAKE @@ -46033,16 +49659,6 @@ components: - serviceDiscovery - username title: PROMETHEUS - ProxyInfo: - type: object - description: VPC Proxy Information. - properties: - authKey: - type: string - description: Authentication key for the proxy. - dnsName: - type: string - description: DNS name to use to reach the proxy/s. PublicApiUsageDetailsLineItemView: type: object properties: @@ -46134,7 +49750,12 @@ components: enum: - AVERAGE operator: - $ref: "#/components/schemas/Operator" + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - LESS_THAN + - GREATER_THAN threshold: type: number format: double @@ -46185,7 +49806,7 @@ components: example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -46444,7 +50065,12 @@ components: enum: - AVERAGE operator: - $ref: "#/components/schemas/Operator" + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - LESS_THAN + - GREATER_THAN threshold: type: number format: double @@ -46634,7 +50260,7 @@ components: example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -47435,7 +51061,7 @@ components: you loaded the sample dataset. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true completeDate: type: string @@ -48249,7 +51875,7 @@ components: \ this parameter when `\"deliveryType\" : \"download\"`." items: type: string - description: One Uniform Resource Locator that point to the compressed + description: One Uniform Resource Locator that points to the compressed snapshot files for manual download. readOnly: true desiredTimestamp: @@ -48336,7 +51962,7 @@ components: parameter when `"deliveryType":` `"automated"`. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" targetGroupId: type: string description: Unique 24-hexadecimal digit string that identifies the target @@ -48411,7 +52037,7 @@ components: which MongoDB Cloud took this snapshot. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true snapshotType: type: string @@ -48543,7 +52169,7 @@ components: description: Human-readable label that identifies the serverless instance. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" providerSettings: $ref: "#/components/schemas/ServerlessProviderSettings" serverlessBackupOptions: @@ -48612,7 +52238,7 @@ components: description: Human-readable label that identifies the serverless instance. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" writeOnly: true providerSettings: $ref: "#/components/schemas/ServerlessProviderSettings" @@ -48776,7 +52402,12 @@ components: enum: - AVERAGE operator: - $ref: "#/components/schemas/Operator" + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - LESS_THAN + - GREATER_THAN threshold: type: number format: double @@ -48986,7 +52617,11 @@ components: properties: groupId: type: string - description: Unique 24-hexadecimal digit string that identifies the project. + description: "Unique 24-hexadecimal digit string that identifies your project.\ + \ **NOTE**: Groups and projects are synonymous terms. Your group id is\ + \ the same as your project id. For existing groups, your group/project\ + \ id remains the same. The resource and corresponding endpoints use the\ + \ term groups." example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 @@ -49099,6 +52734,54 @@ components: - eventTypeName - id title: ServiceAccount Events + ServiceAccountIPAccessListEntry: + type: object + properties: + cidrBlock: + type: string + description: "Range of network addresses in the access list for the Service\ + \ Account. This parameter requires the range to be expressed in Classless\ + \ Inter-Domain Routing (CIDR) notation of Internet Protocol version 4\ + \ or version 6 addresses. You can set a value for this parameter or **ipAddress**,\ + \ but not for both in the same request." + example: 203.0.113.0/24 + pattern: "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + createdAt: + type: string + format: date-time + description: Date MongoDB Cloud added the entry was added to the Access + List. + readOnly: true + ipAddress: + type: string + description: "Network address in the access list for the Service Account.\ + \ This parameter requires the address to be expressed as one Internet\ + \ Protocol version 4 or version 6 address. You can set a value for this\ + \ parameter or **cidrBlock**, but not for both in the same request." + example: 203.0.113.10 + pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + 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 makes at least one request. + readOnly: true + lastUsedAt: + type: string + format: date-time + description: "Date when MongoDB Cloud received the most recent request that\ + \ originated from this Internet Protocol version 4 or version 6 address.\ + \ The resource returns this parameter when at least one request originates\ + \ from this IP address. MongoDB Cloud updates this parameter each time\ + \ a client accesses the permitted resource, with a delay of up to 5 minutes." + readOnly: true + requestCount: + type: integer + format: int32 + description: The number of requests that has originated from this network + address. + readOnly: true ServiceAccountOrgEvents: type: object description: Service Account event identifies different activities around user @@ -49212,35 +52895,34 @@ components: createdAt: type: string format: date-time - description: Timestamp representing creation time. + description: The date that the secret was created on. readOnly: true expiresAt: type: string format: date-time - description: Timestamp representing secret expiration time. + description: The date for the expiration of the secret. readOnly: true id: type: string - description: Unique 24-hexadecimal character string that identifies the - secret. + description: Unique 24-hexadecimal digit string that identifies the secret. example: 32b6e34b3d91647abb20e7b8 pattern: "^([a-f0-9]{24})$" readOnly: true lastUsedAt: type: string format: date-time - description: Timestamp representing last secret usage. + description: The last time the secret was used. readOnly: true maskedSecretValue: type: string - description: Service Account secret with masked values of the first 20 characters. + description: The masked Service Account secret. example: mdb_ic_sk_...12ce readOnly: true secret: type: string - description: Secret for the service account. It will be returned only the - first time after service account creation. - pattern: "^mdb_sa_sk_[0-9a-zA-Z]{40}$" + description: The secret for the Service Account. It will be returned only + the first time after creation. + pattern: "^mdb_sa_sk_[0-9a-zA-Z_-]{40}$" readOnly: true required: - createdAt @@ -49252,7 +52934,8 @@ components: secretExpiresAfterHours: type: integer format: int32 - description: Number of hours representing validity duration for secret. + description: The expiration time of the new Service Account secret. The + expiration is provided in hours. required: - secretExpiresAfterHours ShardEntry: @@ -49875,17 +53558,19 @@ components: StreamsDLQ: type: object description: Dead letter queue for the stream processor. + externalDocs: + url: https://www.mongodb.com/docs/atlas/reference/glossary/#std-term-dead-letter-queue properties: coll: type: string - description: Name of the collection that will be used for the DLQ. + description: Name of the collection to use for the DLQ. connectionName: type: string - description: Connection name that will be used to write DLQ messages to. - Has to be an Atlas connection. + description: Name of the connection to write DLQ messages to. Must be an + Atlas connection. db: type: string - description: Name of the database that will be used for the DLQ. + description: Name of the database to use for the DLQ. links: type: array description: "List of one or more Uniform Resource Locators (URLs) that\ @@ -50054,8 +53739,6 @@ components: group.protocol.type: consumer networking: $ref: "#/components/schemas/StreamsKafkaNetworking" - proxyInfo: - $ref: "#/components/schemas/ProxyInfo" security: $ref: "#/components/schemas/StreamsKafkaSecurity" StreamsKafkaNetworking: @@ -50081,6 +53764,13 @@ components: type: object description: Information about the networking access. properties: + connectionId: + type: string + description: Reserved. Will be used by PRIVATE_LINK connection type. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" links: type: array description: "List of one or more Uniform Resource Locators (URLs) that\ @@ -50094,14 +53784,18 @@ components: readOnly: true name: type: string - description: Id of the vpc peer when the type is VPC. + description: Reserved. Will be used by PRIVATE_LINK connection type. type: type: string - description: Selected networking type. Either PUBLIC or VPC. Defaults to - PUBLIC + description: "Selected networking type. Either PUBLIC, VPC or PRIVATE_LINK.\ + \ Defaults to PUBLIC. For VPC, ensure that VPC peering exists and connectivity\ + \ has been established between Atlas VPC and the VPC where Kafka cluster\ + \ is hosted for the connection to function properly. PRIVATE_LINK support\ + \ is coming soon." enum: - PUBLIC - VPC + - PRIVATE_LINK title: Networking Access Type StreamsKafkaSecurity: type: object @@ -50180,6 +53874,52 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true + StreamsPrivateLinkConnection: + type: object + description: Container for metadata needed to create a Private Link connection. + properties: + _id: + type: string + description: The ID of the Private Link connection. + dnsDomain: + type: string + description: Domain name of Confluent cluster. + dnsSubDomain: + type: array + description: Sub-Domain name of Confluent cluster. These are typically your + availability zones. + items: + type: string + interfaceEndpointId: + type: string + description: Interface endpoint ID that is created from the service endpoint + ID provided. + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + provider: + type: string + description: Provider where the Kafka cluster is deployed. + region: + type: string + description: Domain name of Confluent cluster. + serviceEndpointId: + type: string + description: AWS Service Endpoint ID. + state: + type: string + description: State the connection is in. + vendor: + type: string + description: Vendor who manages the Kafka cluster. StreamsProcessor: type: object description: An atlas stream processor. @@ -50213,6 +53953,9 @@ components: type: array description: Stream aggregation pipeline you want to apply to your streaming data. + externalDocs: + description: Supported Aggregation Pipeline Stages + url: https://www.mongodb.com/docs/atlas/atlas-stream-processing/stream-aggregation/#std-label-stream-aggregation items: $ref: "#/components/schemas/Document" StreamsProcessorWithStats: @@ -50243,6 +53986,8 @@ components: type: string description: Human-readable name of the stream processor. readOnly: true + options: + $ref: "#/components/schemas/StreamsOptions" pipeline: type: array description: Stream aggregation pipeline you want to apply to your streaming @@ -50252,15 +53997,20 @@ components: readOnly: true state: type: string - description: The state of the stream processor. + description: "The state of the stream processor. Commonly occurring states\ + \ are 'CREATED', 'STARTED', 'STOPPED' and 'FAILED'." readOnly: true stats: type: object additionalProperties: type: object description: The stats associated with the stream processor. + externalDocs: + url: https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor readOnly: true description: The stats associated with the stream processor. + externalDocs: + url: https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor readOnly: true required: - _id @@ -50271,6 +54021,26 @@ components: type: object allOf: - $ref: "#/components/schemas/StreamsConnection" + StreamsSampleConnections: + type: object + description: Sample connections to add to SPI. + properties: + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + solar: + type: boolean + default: false + description: Flag that indicates whether to add a 'sample_stream_solar' + connection. StreamsTenant: type: object properties: @@ -50322,6 +54092,8 @@ components: name: type: string description: Human-readable label that identifies the stream instance. + sampleConnections: + $ref: "#/components/schemas/StreamsSampleConnections" streamConfig: $ref: "#/components/schemas/StreamConfig" SummaryNotification: @@ -50982,7 +54754,7 @@ components: description: Human-readable label that identifies the source cluster. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true deliveryType: type: string @@ -51092,6 +54864,8 @@ components: required: - snapshotId - targetDeploymentItemName + TenantWithSampleConnections: + type: object TextSearchHostStatusDetail: type: object properties: @@ -51308,808 +55082,199 @@ components: type: array description: List of documents detailing index status on each host. items: - $ref: "#/components/schemas/TextSearchHostStatusDetail" - synonymMappingStatus: - type: string - description: Status that describes this index's synonym mappings. This - status appears only if the index has synonyms defined. - enum: - - FAILED - - BUILDING - - READY - synonymMappingStatusDetail: - type: array - description: A list of documents describing the status of the index's - synonym mappings on each search host. Only appears if the index has - synonyms defined. - items: - type: object - additionalProperties: - $ref: "#/components/schemas/SynonymMappingStatusDetail" - title: Text Search Index Response - TextSearchIndexStatusDetail: - type: object - description: Contains status information about a text search index. - properties: - definition: - $ref: "#/components/schemas/TextSearchIndexDefinition" - definitionVersion: - $ref: "#/components/schemas/SearchIndexDefinitionVersion" - message: - type: string - description: Optional message describing an error. - queryable: - type: boolean - description: Flag that indicates whether the index generation is queryable - on the host. - status: - type: string - description: | - Condition of the search index when you made this request. - - | Status | Index Condition | - |---|---| - | DELETING | The index is being deleted. | - | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. | - | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. | - | PENDING | Atlas has not yet started building the index. | - | BUILDING | Atlas is building or re-building the index after an edit. | - | READY | The index is ready and can support queries. | - enum: - - DELETING - - FAILED - - STALE - - PENDING - - BUILDING - - READY - - DOES_NOT_EXIST - synonymMappingStatus: - type: string - description: Status that describes this index's synonym mappings. This status - appears only if the index has synonyms defined. - enum: - - FAILED - - BUILDING - - READY - synonymMappingStatusDetail: - type: array - description: List of synonym statuses by mapping. - items: - $ref: "#/components/schemas/SynonymMappingStatusDetailMap" - title: Text Search Index Status Detail - ThirdPartyIntegration: - type: object - description: Collection of settings that describe third-party integrations. - discriminator: - mapping: - DATADOG: "#/components/schemas/Datadog" - MICROSOFT_TEAMS: "#/components/schemas/MicrosoftTeams" - NEW_RELIC: "#/components/schemas/NewRelic" - OPS_GENIE: "#/components/schemas/OpsGenie" - PAGER_DUTY: "#/components/schemas/PagerDuty" - PROMETHEUS: "#/components/schemas/Prometheus" - SLACK: "#/components/schemas/Slack" - VICTOR_OPS: "#/components/schemas/VictorOps" - WEBHOOK: "#/components/schemas/Webhook" - propertyName: type - properties: - id: - type: string - description: Integration id. - nullable: true - type: - type: string - description: Integration type - enum: - - PAGER_DUTY - - SLACK - - DATADOG - - NEW_RELIC - - OPS_GENIE - - VICTOR_OPS - - WEBHOOK - - HIP_CHAT - - PROMETHEUS - - MICROSOFT_TEAMS - title: Integration Type - title: Third-Party Integration - TimeMetricAlertView: - type: object - properties: - acknowledgedUntil: - type: string - format: date-time - description: |- - Date and time until which this alert has been acknowledged. This parameter expresses its value in the 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. - acknowledgementComment: - type: string - description: Comment that a MongoDB Cloud user submitted when acknowledging - the alert. - example: Expiration on 3/19. Silencing for 7days. - maxLength: 200 - acknowledgingUsername: - type: string - format: email - description: MongoDB Cloud username of the person who acknowledged the alert. - The response returns this parameter if a MongoDB Cloud user previously - acknowledged this alert. - readOnly: true - alertConfigId: - type: string - description: Unique 24-hexadecimal digit string that identifies the alert - configuration that sets this alert. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - clusterName: - 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." - example: cluster1 - maxLength: 64 - minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - readOnly: true - created: - type: string - format: date-time - description: Date and time when MongoDB Cloud created this alert. This parameter - expresses its value in the ISO 8601 timestamp format - in UTC. - readOnly: true - currentValue: - $ref: "#/components/schemas/TimeMetricValueView" - eventTypeName: - $ref: "#/components/schemas/HostMetricEventTypeViewAlertable" - groupId: - type: string - description: Unique 24-hexadecimal digit string that identifies the project - that owns this alert. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - 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. - example: cloud-test.mongodb.com:27017 - readOnly: true - id: - type: string - description: Unique 24-hexadecimal digit string that identifies this alert. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - lastNotified: - type: string - format: date-time - description: Date and time that any notifications were last sent for this - alert. This parameter expresses its value in the ISO 8601 timestamp format - in UTC. The resource returns this parameter if MongoDB Cloud has sent - notifications for this alert. - readOnly: true - links: - type: array - description: "List of one or more Uniform Resource Locators (URLs) that\ - \ point to API sub-resources, related API resources, or both. RFC 5988\ - \ outlines these relationships." - externalDocs: - description: Web Linking Specification (RFC 5988) - url: https://datatracker.ietf.org/doc/html/rfc5988 - items: - $ref: "#/components/schemas/Link" - readOnly: true - 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. - example: ASSERT_USER - readOnly: true - orgId: - type: string - description: Unique 24-hexadecimal character string that identifies the - organization that owns the project to which this alert applies. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - 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." - example: event-replica-set - readOnly: true - resolved: - type: string - format: date-time - description: "Date and time that this alert changed to `\"status\" : \"\ - CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp\ - \ format in UTC. The resource returns this parameter once `\"status\"\ - \ : \"CLOSED\"`." - readOnly: true - status: - type: string - description: State of this alert at the time you requested its details. - enum: - - CANCELLED - - CLOSED - - OPEN - - TRACKING - example: OPEN - readOnly: true - updated: - type: string - format: date-time - description: Date and time when someone last updated this alert. This parameter - expresses its value in the ISO 8601 timestamp format - in UTC. - readOnly: true - required: - - alertConfigId - - created - - eventTypeName - - id - - status - - updated - TimeMetricEventView: - type: object - properties: - apiKeyId: - type: string - description: "Unique 24-hexadecimal digit string that identifies the [API\ - \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\ - \ triggered the event. If this resource returns this parameter, it doesn't\ - \ return the **userId** parameter." - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - created: - type: string - format: date-time - description: Date and time when this event occurred. This parameter expresses - its value in the ISO 8601 timestamp format in UTC. - readOnly: true - currentValue: - $ref: "#/components/schemas/TimeMetricValueView" - eventTypeName: - $ref: "#/components/schemas/HostMetricEventTypeView" - groupId: - type: string - description: Unique 24-hexadecimal digit string that identifies the project - in which the event occurred. The **eventId** identifies the specific event. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - id: - type: string - description: Unique 24-hexadecimal digit string that identifies the event. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - isGlobalAdmin: - type: boolean - default: false - description: Flag that indicates whether a MongoDB employee triggered the - specified event. - readOnly: true - links: - type: array - description: "List of one or more Uniform Resource Locators (URLs) that\ - \ point to API sub-resources, related API resources, or both. RFC 5988\ - \ outlines these relationships." - externalDocs: - description: Web Linking Specification (RFC 5988) - url: https://datatracker.ietf.org/doc/html/rfc5988 - items: - $ref: "#/components/schemas/Link" - readOnly: true - 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: - type: string - description: Unique 24-hexadecimal digit string that identifies the organization - to which these events apply. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - port: - type: integer - format: int32 - description: IANA port on which the MongoDB process listens for requests. - example: 27017 - readOnly: true - publicKey: - type: string - format: email - description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\ - \ that triggered the event. If this resource returns this parameter, it\ - \ doesn't return the **username** parameter." - example: test.user@mongodb.com - readOnly: true - raw: - $ref: "#/components/schemas/raw" - remoteAddress: - type: string - description: IPv4 or IPv6 address from which the user triggered this event. - example: 216.172.40.186 - pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" - readOnly: true - replicaSetName: - type: string - description: Human-readable label of the replica set associated with the - event. - example: event-replica-set - readOnly: true - shardName: - type: string - description: Human-readable label of the shard associated with the event. - example: event-sh-01 - readOnly: true - userId: - type: string - description: "Unique 24-hexadecimal digit string that identifies the console\ - \ user who triggered the event. If this resource returns this parameter,\ - \ it doesn't return the **apiKeyId** parameter." - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - username: - type: string - format: email - description: "Email address for the user who triggered this event. If this\ - \ resource returns this parameter, it doesn't return the **publicApiKey**\ - \ parameter." - example: test.user@mongodb.com - readOnly: true - required: - - created - - eventTypeName - - id - TimeMetricThresholdView: - 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: - $ref: "#/components/schemas/Operator" - threshold: - type: number - format: double - description: "Value of metric that, when exceeded, triggers an alert." - units: - $ref: "#/components/schemas/TimeMetricUnits" - required: - - metricName - TimeMetricUnits: - type: string - default: HOURS - description: "Element used to express the quantity. This can be an element of\ - \ time, storage capacity, and the like." - enum: - - NANOSECONDS - - MILLISECONDS - - MILLION_MINUTES - - SECONDS - - MINUTES - - HOURS - - DAYS - title: Time Metric Units - TimeMetricValueView: - type: object - description: Measurement of the **metricName** recorded at the time of the event. - properties: - number: - type: number - format: double - description: Amount of the **metricName** recorded at the time of the event. - This value triggered the alert. - readOnly: true - units: - $ref: "#/components/schemas/TimeMetricUnits" - readOnly: true - title: Time Metric Value - TokenFilterEnglishPossessive: - type: object - description: Filter that removes possessives (trailing 's) from words. - properties: - type: - type: string - description: Human-readable label that identifies this token filter type. - enum: - - englishPossessive - required: - - type - title: englishPossessive - TokenFilterFlattenGraph: - type: object - description: "Filter that transforms a token filter graph, such as the token\ - \ filter graph that the wordDelimiterGraph token filter produces, into a flat\ - \ form suitable for indexing." - properties: - type: - type: string - description: Human-readable label that identifies this token filter type. - enum: - - flattenGraph - required: - - type - title: flattenGraph - TokenFilterPorterStemming: + $ref: "#/components/schemas/TextSearchHostStatusDetail" + synonymMappingStatus: + type: string + description: Status that describes this index's synonym mappings. This + status appears only if the index has synonyms defined. + enum: + - FAILED + - BUILDING + - READY + synonymMappingStatusDetail: + type: array + description: A list of documents describing the status of the index's + synonym mappings on each search host. Only appears if the index has + synonyms defined. + items: + type: object + additionalProperties: + $ref: "#/components/schemas/SynonymMappingStatusDetail" + title: Text Search Index Response + TextSearchIndexStatusDetail: type: object - 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. + description: Contains status information about a text search index. properties: - type: + definition: + $ref: "#/components/schemas/TextSearchIndexDefinition" + definitionVersion: + $ref: "#/components/schemas/SearchIndexDefinitionVersion" + message: type: string - description: Human-readable label that identifies this token filter type. - enum: - - porterStemming - required: - - type - title: porterStemming - TokenFilterSpanishPluralStemming: - type: object - description: Filter that stems Spanish plural words. It expects lowercase text. - properties: - type: + description: Optional message describing an error. + queryable: + type: boolean + description: Flag that indicates whether the index generation is queryable + on the host. + status: type: string - description: Human-readable label that identifies this token filter type. + description: | + Condition of the search index when you made this request. + + | Status | Index Condition | + |---|---| + | DELETING | The index is being deleted. | + | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. | + | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. | + | PENDING | Atlas has not yet started building the index. | + | BUILDING | Atlas is building or re-building the index after an edit. | + | READY | The index is ready and can support queries. | enum: - - spanishPluralStemming - required: - - type - title: spanishPluralStemming - TokenFilterStempel: - type: object - description: Filter that uses Lucene's default Polish stemmer table to stem - words in the Polish language. It expects lowercase text. - externalDocs: - description: Default Polish stemmer table - url: https://lucene.apache.org/core/9_2_0/analysis/stempel/org/apache/lucene/analysis/pl/PolishAnalyzer.html#DEFAULT_STEMMER_FILE - properties: - type: + - DELETING + - FAILED + - STALE + - PENDING + - BUILDING + - READY + - DOES_NOT_EXIST + synonymMappingStatus: type: string - description: Human-readable label that identifies this token filter type. + description: Status that describes this index's synonym mappings. This status + appears only if the index has synonyms defined. enum: - - stempel - required: - - type - title: stempel - TokenFilterWordDelimiterGraph: + - FAILED + - BUILDING + - READY + synonymMappingStatusDetail: + type: array + description: List of synonym statuses by mapping. + items: + $ref: "#/components/schemas/SynonymMappingStatusDetailMap" + title: Text Search Index Status Detail + ThirdPartyIntegration: type: object - description: Filter that splits tokens into sub-tokens based on configured rules. + description: Collection of settings that describe third-party integrations. + discriminator: + mapping: + DATADOG: "#/components/schemas/Datadog" + MICROSOFT_TEAMS: "#/components/schemas/MicrosoftTeams" + NEW_RELIC: "#/components/schemas/NewRelic" + OPS_GENIE: "#/components/schemas/OpsGenie" + PAGER_DUTY: "#/components/schemas/PagerDuty" + PROMETHEUS: "#/components/schemas/Prometheus" + SLACK: "#/components/schemas/Slack" + VICTOR_OPS: "#/components/schemas/VictorOps" + WEBHOOK: "#/components/schemas/Webhook" + propertyName: type properties: - delimiterOptions: - type: object - description: Object that contains the rules that determine how to split - words into sub-words. - properties: - concatenateAll: - type: boolean - default: false - description: Flag that indicates whether to concatenate runs. - concatenateNumbers: - type: boolean - default: false - description: Flag that indicates whether to concatenate runs of sub-numbers. - concatenateWords: - type: boolean - default: false - description: Flag that indicates whether to concatenate runs of sub-words. - generateNumberParts: - type: boolean - default: true - description: "Flag that indicates whether to split tokens based on sub-numbers.\ - \ For example, if `true`, this option splits `100-2` into `100` and\ - \ `2`." - generateWordParts: - type: boolean - default: true - description: Flag that indicates whether to split tokens based on sub-words. - ignoreKeywords: - type: boolean - default: false - description: Flag that indicates whether to skip tokens with the `keyword` - attribute set to `true` - preserveOriginal: - type: boolean - default: true - description: Flag that indicates whether to generate tokens of the original - words. - splitOnCaseChange: - type: boolean - default: true - description: Flag that indicates whether to split tokens based on letter-case - transitions. - splitOnNumerics: - type: boolean - default: true - description: Flag that indicates whether to split tokens based on letter-number - transitions. - stemEnglishPossessive: - type: boolean - default: true - description: Flag that indicates whether to remove trailing possessives - from each sub-word. - protectedWords: - type: object - description: Object that contains options for protected words. - properties: - ignoreCase: - type: boolean - default: true - description: Flag that indicates whether to ignore letter case sensitivity - for protected words. - words: - type: array - description: List that contains the tokens to protect from delimination. - items: - type: string - required: - - words - type: + id: type: string - description: Human-readable label that identifies this token filter type. - enum: - - wordDelimiterGraph - required: - - type - title: wordDelimiterGraph - TokenFilterkStemming: - type: object - description: Filter that combines algorithmic stemming with a built-in dictionary - for the English language to stem words. - properties: + description: Integration id. + nullable: true type: type: string - description: Human-readable label that identifies this token filter type. + description: Integration type enum: - - kStemming - required: - - type - title: kStemming - TriggerIngestionPipelineRequest: - type: object - properties: - datasetRetentionPolicy: - $ref: "#/components/schemas/DatasetRetentionPolicy" - snapshotId: - type: string - description: Unique 24-hexadecimal character string that identifies the - snapshot. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - writeOnly: true - required: - - snapshotId - USSBackupRestoreJob20250101: + - PAGER_DUTY + - SLACK + - DATADOG + - NEW_RELIC + - OPS_GENIE + - VICTOR_OPS + - WEBHOOK + - HIP_CHAT + - PROMETHEUS + - MICROSOFT_TEAMS + title: Integration Type + title: Third-Party Integration + TimeMetricAlertView: type: object - description: Details for one restore job of a USS instance. properties: - deliveryType: - type: string - description: Means by which this resource returns the snapshot to the requesting - MongoDB Cloud user. - enum: - - RESTORE - - DOWNLOAD - readOnly: true - expirationDate: - type: string - format: date-time - description: Date and time when the download link no longer works. This - parameter expresses its value in the ISO 8601 timestamp format in UTC. - readOnly: true - id: - type: string - description: Unique 24-hexadecimal digit string that identifies the restore - job. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - instanceName: - type: string - description: Human-readable label that identifies the source instance. - maxLength: 64 - minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - readOnly: true - links: - type: array - description: "List of one or more Uniform Resource Locators (URLs) that\ - \ point to API sub-resources, related API resources, or both. RFC 5988\ - \ outlines these relationships." - externalDocs: - description: Web Linking Specification (RFC 5988) - url: https://datatracker.ietf.org/doc/html/rfc5988 - items: - $ref: "#/components/schemas/Link" - readOnly: true - projectId: - type: string - description: Unique 24-hexadecimal digit string that identifies the project - from which the restore job originated. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - restoreFinishedDate: + acknowledgedUntil: type: string format: date-time - 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. - readOnly: true - restoreScheduledDate: + 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. + acknowledgementComment: type: string - format: date-time - description: Date and time when MongoDB Cloud will restore this snapshot. - This parameter expresses its value in the ISO 8601 timestamp format in - UTC. - readOnly: true - snapshotFinishedDate: + description: Comment that a MongoDB Cloud user submitted when acknowledging + the alert. + example: Expiration on 3/19. Silencing for 7days. + maxLength: 200 + acknowledgingUsername: type: string - format: date-time - description: Date and time when MongoDB Cloud completed writing this snapshot. - This parameter expresses its value in the ISO 8601 timestamp format in - UTC. + format: email + description: MongoDB Cloud username of the person who acknowledged the alert. + The response returns this parameter if a MongoDB Cloud user previously + acknowledged this alert. readOnly: true - snapshotId: + alertConfigId: type: string - description: Unique 24-hexadecimal digit string that identifies the snapshot - to restore. + description: Unique 24-hexadecimal digit string that identifies the alert + configuration that sets this alert. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true - 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. - enum: - - PENDING - - QUEUED - - RUNNING - - FAILED - - COMPLETED - readOnly: true - targetDeploymentItemName: + clusterName: type: string - description: Human-readable label that identifies the instance or cluster - on the target project to which you want to restore the snapshot. You can - restore the snapshot to another USS instance or Dedicated cluster tier. + description: "Human-readable label that identifies the cluster to which\ + \ this alert applies. This resource returns this parameter for alerts\ + \ of events impacting backups, replica sets, or sharded clusters." + example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true - targetProjectId: + created: type: string - description: Unique 24-hexadecimal digit string that identifies the project - that contains the instance or cluster to which you want to restore the - snapshot. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" + format: date-time + description: Date and time when MongoDB Cloud created this alert. This parameter + expresses its value in the ISO 8601 timestamp format + in UTC. readOnly: true - title: USS Backup Restore Job - USSBackupRestoreJobCreate20250101: - type: object - description: Details to create one restore job of a USS instance. - properties: - _snapshotId: - type: string - description: Unique 24-hexadecimal digit string that identifies the snapshot - to restore. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - writeOnly: true - _targetDeploymentItemName: - type: string - description: Human-readable label that identifies the instance or cluster - on the target project to which you want to restore the snapshot. You can - restore the snapshot to another USS instance or Dedicated cluster tier. - maxLength: 64 - minLength: 1 - pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" - writeOnly: true - _targetProjectId: + currentValue: + $ref: "#/components/schemas/TimeMetricValueView" + eventTypeName: + $ref: "#/components/schemas/HostMetricEventTypeViewAlertable" + groupId: type: string description: Unique 24-hexadecimal digit string that identifies the project - that contains the instance or cluster to which you want to restore the - snapshot. + that owns this alert. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" - writeOnly: true - deliveryType: - type: string - description: Means by which this resource returns the snapshot to the requesting - MongoDB Cloud user. - enum: - - RESTORE - - DOWNLOAD readOnly: true - expirationDate: + hostnameAndPort: type: string - format: date-time - description: Date and time when the download link no longer works. This - parameter expresses its value in the ISO 8601 timestamp format in UTC. + description: Hostname and port of the host to which this alert applies. + The resource returns this parameter for alerts of events impacting hosts + or replica sets. + example: cloud-test.mongodb.com:27017 readOnly: true id: type: string - description: Unique 24-hexadecimal digit string that identifies the restore - job. + description: Unique 24-hexadecimal digit string that identifies this alert. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true - instanceName: + lastNotified: type: string - description: Human-readable label that identifies the source instance. - maxLength: 64 - minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + format: date-time + 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. readOnly: true links: type: array @@ -52122,94 +55287,114 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true - projectId: + metricName: type: string - description: Unique 24-hexadecimal digit string that identifies the project - from which the restore job originated. + 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. + example: ASSERT_USER + readOnly: true + orgId: + type: string + description: Unique 24-hexadecimal character string that identifies the + organization that owns the project to which this alert applies. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true - restoreFinishedDate: - type: string - format: date-time - 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. - readOnly: true - restoreScheduledDate: + replicaSetName: type: string - format: date-time - description: Date and time when MongoDB Cloud will restore this snapshot. - This parameter expresses its value in the ISO 8601 timestamp format in - UTC. + description: "Name of the replica set to which this alert applies. The response\ + \ returns this parameter for alerts of events impacting backups, hosts,\ + \ or replica sets." + example: event-replica-set readOnly: true - snapshotFinishedDate: + resolved: type: string format: date-time - description: Date and time when MongoDB Cloud completed writing this snapshot. - This parameter expresses its value in the ISO 8601 timestamp format in - UTC. - readOnly: true - snapshotUrl: - type: string - description: "Internet address from which you can download the compressed\ - \ snapshot files. The resource returns this parameter when `\"deliveryType\"\ - \ : \"DOWNLOAD\"`." + 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\"`." readOnly: true status: type: string - description: Phase of the restore workflow for this job at the time this - resource made this request. + description: State of this alert at the time you requested its details. enum: - - PENDING - - QUEUED - - RUNNING - - FAILED - - COMPLETED + - CANCELLED + - CLOSED + - OPEN + - TRACKING + example: OPEN + readOnly: true + updated: + type: string + format: date-time + description: Date and time when someone last updated this alert. This parameter + expresses its value in the ISO 8601 timestamp format + in UTC. readOnly: true required: - - _snapshotId - - _targetDeploymentItemName - title: Create USS Backup Restore Job - USSBackupSettings20250101: + - alertConfigId + - created + - eventTypeName + - id + - status + - updated + TimeMetricEventView: type: object - description: USS backup configuration properties: - enabled: - type: boolean - default: true - description: "Flag that indicates whether backups are performed for this\ - \ USS instance. Backup uses [TODO](TODO) for USS instances." + apiKeyId: + type: string + description: "Unique 24-hexadecimal digit string that identifies the [API\ + \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\ + \ triggered the event. If this resource returns this parameter, it doesn't\ + \ return the **userId** parameter." + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" readOnly: true - readOnly: true - title: USS backup configuration - USSBackupSnapshot20250101: - type: object - description: Details for one snapshot of a USS instance. - properties: - expiration: + created: type: string format: date-time - description: Date and time when the download link no longer works. This - parameter expresses its value in the ISO 8601 timestamp format in UTC. + description: Date and time when this event occurred. This parameter expresses + its value in the ISO 8601 timestamp format in UTC. readOnly: true - finishTime: + currentValue: + $ref: "#/components/schemas/TimeMetricValueView" + eventTypeName: + $ref: "#/components/schemas/HostMetricEventTypeView" + groupId: type: string - format: date-time - description: Date and time when MongoDB Cloud completed writing this snapshot. - This parameter expresses its value in the ISO 8601 timestamp format in - UTC. + description: Unique 24-hexadecimal digit string that identifies the project + in which the event occurred. The **eventId** identifies the specific event. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" readOnly: true id: type: string - description: Unique 24-hexadecimal digit string that identifies the snapshot. + description: Unique 24-hexadecimal digit string that identifies the event. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true + isGlobalAdmin: + type: boolean + default: false + description: Flag that indicates whether a MongoDB employee triggered the + specified event. + readOnly: true links: type: array description: "List of one or more Uniform Resource Locators (URLs) that\ @@ -52221,307 +55406,307 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true - mongoDBVersion: - type: string - description: MongoDB host version that the snapshot runs. - readOnly: true - scheduledTime: - type: string - format: date-time - description: Date and time when MongoDB Cloud will take the snapshot. This - parameter expresses its value in the ISO 8601 timestamp format in UTC. - readOnly: true - startTime: - type: string - format: date-time - description: Date and time when MongoDB Cloud began taking the snapshot. - This parameter expresses its value in the ISO 8601 timestamp format in - UTC. - readOnly: true - status: + metricName: type: string - description: Phase of the workflow for this snapshot at the time this resource - made this request. - enum: - - PENDING - - QUEUED - - RUNNING - - FAILED - - COMPLETED + description: Human-readable label of the metric associated with the **alertId**. + This field may change type of **currentValue** field. readOnly: true - title: USS Backup Snapshot - USSBackupSnapshotDownloadCreate20250101: - type: object - description: Details for one backup snapshot download of a USS instance. - properties: - _snapshotId: + orgId: type: string - description: Unique 24-hexadecimal digit string that identifies the snapshot - to download. + description: Unique 24-hexadecimal digit string that identifies the organization + to which these events apply. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" - writeOnly: true - links: - type: array - description: "List of one or more Uniform Resource Locators (URLs) that\ - \ point to API sub-resources, related API resources, or both. RFC 5988\ - \ outlines these relationships." - externalDocs: - description: Web Linking Specification (RFC 5988) - url: https://datatracker.ietf.org/doc/html/rfc5988 - items: - $ref: "#/components/schemas/Link" readOnly: true - required: - - _snapshotId - title: USS Backup Snapshot Download Create - USSConnectionStrings20250101: - type: object - description: Collection of Uniform Resource Locators that point to the MongoDB - database. - externalDocs: - description: Connection string URI format. - url: https://docs.mongodb.com/manual/reference/connection-string/ - properties: - standard: - type: string - description: Public connection string that you can use to connect to this - cluster. This connection string uses the mongodb:// protocol. - externalDocs: - description: Connection String URI Format - url: https://docs.mongodb.com/manual/reference/connection-string/ + port: + type: integer + format: int32 + description: IANA port on which the MongoDB process listens for requests. + example: 27017 readOnly: true - standardSrv: + publicKey: type: string - description: Public connection string that you can use to connect to this - USS instance. This connection string uses the `mongodb+srv://` protocol. - externalDocs: - description: Connection String URI Format - url: https://docs.mongodb.com/manual/reference/connection-string/ + format: email + description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\ + \ that triggered the event. If this resource returns this parameter, it\ + \ doesn't return the **username** parameter." + example: test.user@mongodb.com readOnly: true - readOnly: true - title: USS Instance Connection Strings - USSInstanceDescription20250101: - type: object - description: Group of settings that configure a MongoDB USS instance. - properties: - backupSettings: - $ref: "#/components/schemas/USSBackupSettings20250101" - clusterType: + raw: + $ref: "#/components/schemas/raw" + remoteAddress: type: string - description: USS instance topology. - enum: - - REPLICASET - - LOADBALANCED + description: IPv4 or IPv6 address from which the user triggered this event. + example: 216.172.40.186 + pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" readOnly: true - connectionStrings: - $ref: "#/components/schemas/USSConnectionStrings20250101" - createDate: + replicaSetName: type: string - format: date-time - description: Date and time when MongoDB Cloud created this instance. This - parameter expresses its value in ISO 8601 format in UTC. + description: Human-readable label of the replica set associated with the + event. + example: event-replica-set readOnly: true - groupId: + shardName: type: string - description: Unique 24-hexadecimal character string that identifies the - project. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" + description: Human-readable label of the shard associated with the event. + example: event-sh-01 readOnly: true - id: + userId: type: string - description: Unique 24-hexadecimal digit string that identifies the instance. + description: "Unique 24-hexadecimal digit string that identifies the console\ + \ user who triggered the event. If this resource returns this parameter,\ + \ it doesn't return the **apiKeyId** parameter." example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true - links: - type: array - description: "List of one or more Uniform Resource Locators (URLs) that\ - \ point to API sub-resources, related API resources, or both. RFC 5988\ - \ outlines these relationships." - externalDocs: - description: Web Linking Specification (RFC 5988) - url: https://datatracker.ietf.org/doc/html/rfc5988 - items: - $ref: "#/components/schemas/Link" - readOnly: true - mongoDBVersion: + username: type: string - description: Version of MongoDB that the instance runs. - pattern: "([\\d]+\\.[\\d]+\\.[\\d]+)" + format: email + description: "Email address for the user who triggered this event. If this\ + \ resource returns this parameter, it doesn't return the **publicApiKey**\ + \ parameter." + example: test.user@mongodb.com readOnly: true - name: + required: + - created + - eventTypeName + - id + TimeMetricThresholdView: + type: object + properties: + metricName: type: string - description: Human-readable label that identifies the instance. - maxLength: 64 - minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - readOnly: true - providerSettings: - $ref: "#/components/schemas/USSProviderSettings20250101" - stateName: + description: Human-readable label that identifies the metric against which + MongoDB Cloud checks the configured **metricThreshold.threshold**. + mode: type: string - description: Human-readable label that indicates the current operating condition - of this instance. + description: MongoDB Cloud computes the current metric value as an average. enum: - - IDLE - - CREATING - - UPDATING - - DELETING - - REPAIRING - readOnly: true - tags: - type: array - description: List that contains key-value pairs between 1 to 255 characters - in length for tagging and categorizing the instance. - externalDocs: - description: Resource Tags - url: https://dochub.mongodb.org/core/add-cluster-tag-atlas - items: - $ref: "#/components/schemas/ResourceTag" - terminationProtectionEnabled: - type: boolean - default: false - description: "Flag that indicates whether termination protection is enabled\ - \ on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster.\ - \ If set to `false`, MongoDB Cloud will delete the cluster." - versionReleaseSystem: + - AVERAGE + operator: type: string - default: LTS - description: Method by which the cluster maintains the MongoDB versions. + description: Comparison operator to apply when checking the current metric + value. enum: - - LTS - readOnly: true + - LESS_THAN + - GREATER_THAN + threshold: + type: number + format: double + description: "Value of metric that, when exceeded, triggers an alert." + units: + $ref: "#/components/schemas/TimeMetricUnits" required: - - providerSettings - title: USS Instance Description - USSInstanceDescriptionCreate20250101: + - metricName + TimeMetricUnits: + type: string + default: HOURS + description: "Element used to express the quantity. This can be an element of\ + \ time, storage capacity, and the like." + enum: + - NANOSECONDS + - MILLISECONDS + - MILLION_MINUTES + - SECONDS + - MINUTES + - HOURS + - DAYS + title: Time Metric Units + TimeMetricValueView: type: object - description: Settings that you can specify when you create a USS instance. + description: Measurement of the **metricName** recorded at the time of the event. properties: - links: - type: array - description: "List of one or more Uniform Resource Locators (URLs) that\ - \ point to API sub-resources, related API resources, or both. RFC 5988\ - \ outlines these relationships." - externalDocs: - description: Web Linking Specification (RFC 5988) - url: https://datatracker.ietf.org/doc/html/rfc5988 - items: - $ref: "#/components/schemas/Link" + number: + type: number + format: double + description: Amount of the **metricName** recorded at the time of the event. + This value triggered the alert. readOnly: true - name: + units: + $ref: "#/components/schemas/TimeMetricUnits" + readOnly: true + title: Time Metric Value + TokenFilterEnglishPossessive: + type: object + description: Filter that removes possessives (trailing 's) from words. + properties: + type: type: string - description: Human-readable label that identifies the instance. - maxLength: 64 - minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - writeOnly: true - providerSettings: - $ref: "#/components/schemas/USSProviderSettingsCreate20250101" - tags: - type: array - description: List that contains key-value pairs between 1 to 255 characters - in length for tagging and categorizing the instance. - externalDocs: - description: Resource Tags - url: https://dochub.mongodb.org/core/add-cluster-tag-atlas - items: - $ref: "#/components/schemas/ResourceTag" - terminationProtectionEnabled: - type: boolean - default: false - description: "Flag that indicates whether termination protection is enabled\ - \ on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster.\ - \ If set to `false`, MongoDB Cloud will delete the cluster." + description: Human-readable label that identifies this token filter type. + enum: + - englishPossessive required: - - name - - providerSettings - title: USS Instance Description Create - USSProviderSettings20250101: + - type + title: englishPossessive + TokenFilterFlattenGraph: type: object - description: Group of cloud provider settings that configure the provisioned - MongoDB USS instance. + description: "Filter that transforms a token filter graph, such as the token\ + \ filter graph that the wordDelimiterGraph token filter produces, into a flat\ + \ form suitable for indexing." properties: - backingProviderName: + type: type: string - description: Cloud service provider on which MongoDB Cloud provisioned the - USS instance. + description: Human-readable label that identifies this token filter type. enum: - - AWS - - AZURE - - GCP - readOnly: true - diskSizeGB: - type: number - format: double - description: Storage capacity available to the USS instance expressed in - gigabytes. - readOnly: true - providerName: + - flattenGraph + required: + - type + title: flattenGraph + TokenFilterPorterStemming: + type: object + description: Filter that uses the porter stemming algorithm to remove the common + morphological and inflectional suffixes from words in English. It expects + lowercase text and doesn't work as expected for uppercase text. + properties: + type: type: string - default: USS - description: Human-readable label that identifies the cloud service provider. + description: Human-readable label that identifies this token filter type. enum: - - USS - readOnly: true - regionName: + - porterStemming + required: + - type + title: porterStemming + TokenFilterSpanishPluralStemming: + type: object + description: Filter that stems Spanish plural words. It expects lowercase text. + properties: + type: type: string - description: "Human-readable label that identifies the geographic location\ - \ of your MongoDB USS 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/)." - readOnly: true - readOnly: true - title: Cloud Service Provider Settings for a USS Instance - USSProviderSettingsCreate20250101: + description: Human-readable label that identifies this token filter type. + enum: + - spanishPluralStemming + required: + - type + title: spanishPluralStemming + TokenFilterStempel: type: object - description: Group of cloud provider settings that configure the provisioned - MongoDB USS instance. + description: Filter that uses Lucene's default Polish stemmer table to stem + words in the Polish language. It expects lowercase text. + externalDocs: + description: Default Polish stemmer table + url: https://lucene.apache.org/core/9_2_0/analysis/stempel/org/apache/lucene/analysis/pl/PolishAnalyzer.html#DEFAULT_STEMMER_FILE properties: - backingProviderName: + type: type: string - description: Cloud service provider on which MongoDB Cloud provisioned the - serverless instance. + description: Human-readable label that identifies this token filter type. enum: - - AWS - - AZURE - - GCP - writeOnly: true - diskSizeGB: - type: number - format: double - description: Storage capacity available to the USS instance expressed in - gigabytes. - readOnly: true - providerName: + - stempel + required: + - type + title: stempel + TokenFilterWordDelimiterGraph: + type: object + description: Filter that splits tokens into sub-tokens based on configured rules. + properties: + delimiterOptions: + type: object + description: Object that contains the rules that determine how to split + words into sub-words. + properties: + concatenateAll: + type: boolean + default: false + description: Flag that indicates whether to concatenate runs. + concatenateNumbers: + type: boolean + default: false + description: Flag that indicates whether to concatenate runs of sub-numbers. + concatenateWords: + type: boolean + default: false + description: Flag that indicates whether to concatenate runs of sub-words. + generateNumberParts: + type: boolean + default: true + description: "Flag that indicates whether to split tokens based on sub-numbers.\ + \ For example, if `true`, this option splits `100-2` into `100` and\ + \ `2`." + generateWordParts: + type: boolean + default: true + description: Flag that indicates whether to split tokens based on sub-words. + ignoreKeywords: + type: boolean + default: false + description: Flag that indicates whether to skip tokens with the `keyword` + attribute set to `true` + preserveOriginal: + type: boolean + default: true + description: Flag that indicates whether to generate tokens of the original + words. + splitOnCaseChange: + type: boolean + default: true + description: Flag that indicates whether to split tokens based on letter-case + transitions. + splitOnNumerics: + type: boolean + default: true + description: Flag that indicates whether to split tokens based on letter-number + transitions. + stemEnglishPossessive: + type: boolean + default: true + description: Flag that indicates whether to remove trailing possessives + from each sub-word. + protectedWords: + type: object + description: Object that contains options for protected words. + properties: + ignoreCase: + type: boolean + default: true + description: Flag that indicates whether to ignore letter case sensitivity + for protected words. + words: + type: array + description: List that contains the tokens to protect from delimination. + items: + type: string + required: + - words + type: type: string - default: USS - description: Human-readable label that identifies the cloud service provider. + description: Human-readable label that identifies this token filter type. enum: - - USS - readOnly: true - regionName: + - wordDelimiterGraph + required: + - type + title: wordDelimiterGraph + TokenFilterkStemming: + type: object + description: Filter that combines algorithmic stemming with a built-in dictionary + for the English language to stem words. + properties: + type: type: string - description: "Human-readable label that identifies the geographic location\ - \ of your MongoDB USS 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/)." + description: Human-readable label that identifies this token filter type. + enum: + - kStemming + required: + - type + title: kStemming + TriggerIngestionPipelineRequest: + type: object + properties: + datasetRetentionPolicy: + $ref: "#/components/schemas/DatasetRetentionPolicy" + snapshotId: + type: string + description: Unique 24-hexadecimal character string that identifies the + snapshot. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" writeOnly: true required: - - backingProviderName - - regionName - title: Cloud Service Provider Settings for a USS Instance - writeOnly: true + - snapshotId UpdateAtlasOrganizationApiKey: type: object properties: @@ -53236,7 +56421,7 @@ components: Atlas Data Lake that this database user can access. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" type: type: string description: Category of resource that this database user can access. @@ -53295,6 +56480,28 @@ components: required: - match title: User to Distinguished Name Mapping + VPCPeeringActionChallenge: + type: object + description: Container for elements used to challenge the user before taking + certain actions on VPC Peering connections. + properties: + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + requesterAccountId: + type: string + description: The AWS requester account ID. + requesterVpcId: + type: string + description: The AWS requester VPC ID. VectorSearchHostStatusDetail: type: object properties: diff --git a/tools/cli/test/data/split/dev/openapi-v2.json b/tools/cli/test/data/split/dev/openapi-v2.json index 9bcf3c68e6..b8d238b1eb 100644 --- a/tools/cli/test/data/split/dev/openapi-v2.json +++ b/tools/cli/test/data/split/dev/openapi-v2.json @@ -1,7 +1,7 @@ { "openapi" : "3.0.1", "info" : { - "description" : "The MongoDB Atlas Administration API allows developers to manage all components in MongoDB Atlas.\n\nThe Atlas Administration API uses HTTP Digest Authentication to authenticate requests. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request. For example, to [return database access history](#tag/Access-Tracking/operation/listAccessLogsByClusterName) with [cURL](https://en.wikipedia.org/wiki/CURL), run the following command in the terminal:\n\n```\ncurl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true\"\n```\n\nTo learn more, see [Get Started with the Atlas Administration API](https://www.mongodb.com/docs/atlas/configure-api-access/). For support, see [MongoDB Support](https://www.mongodb.com/support/get-started).", + "description" : "The MongoDB Atlas Administration API allows developers to manage all components in MongoDB Atlas.\n\nThe Atlas Administration API uses HTTP Digest Authentication to authenticate requests. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request. For example, to [return database access history](#tag/Access-Tracking/operation/listAccessLogsByClusterName) with [cURL](https://en.wikipedia.org/wiki/CURL), run the following command in the terminal:\n\n```\ncurl --user \"{PUBLIC-KEY}:{PRIVATE-KEY}\" \\\n --digest \\\n --header \"Accept: application/vnd.atlas.2025-01-01+json\" \\\n -X GET \"https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/dbAccessHistory/clusters/{clusterName}?pretty=true\"\n```\n\nTo learn more, see [Get Started with the Atlas Administration API](https://www.mongodb.com/docs/atlas/configure-api-access/). For support, see [MongoDB Support](https://www.mongodb.com/support/get-started).\n\nYou can also explore the various endpoints available through the Atlas Administration API in MongoDB's [Postman workspace](https://www.postman.com/mongodb-devrel/workspace/mongodb-atlas-administration-apis/).", "license" : { "name" : "CC BY-NC-SA 3.0 US", "url" : "https://creativecommons.org/licenses/by-nc-sa/3.0/us/" @@ -9,7 +9,7 @@ "termsOfService" : "https://www.mongodb.com/mongodb-management-service-terms-and-conditions", "title" : "MongoDB Atlas Administration API", "version" : "2.0", - "x-xgen-sha" : "09d9d18db2111c955a8e01702a27ca2763417782" + "x-xgen-sha" : "e6ba3136dbd0be2a81dd4ed21b9e6c470edd4420" }, "servers" : [ { "url" : "https://cloud.mongodb.com" @@ -57,7 +57,11 @@ "description" : "Returns, adds, edits, and removes Federated Database Instances. This resource requires your project ID. Changes to federated database instance configurations can affect costs.", "name" : "Data Federation" }, { - "description" : "Returns, adds, edits, and removes Atlas Data Lake Pipelines and associated runs.", + "description" : "Returns, edits, and removes Atlas Data Lake Pipelines and associated runs.", + "externalDocs" : { + "description" : "Data Lake Pipelines are deprecated. Please see Data Lake Deprecation Guide.", + "url" : "https://dochub.mongodb.org/core/data-lake-deprecation" + }, "name" : "Data Lake Pipelines" }, { "description" : "Returns, adds, edits, and removes database users.", @@ -119,6 +123,9 @@ }, { "description" : "You can continually push logs from mongod, mongos, and audit logs to an AWS S3 bucket. Atlas exports logs every 5 minutes.", "name" : "Push-Based Log Export" + }, { + "description" : "Configure and manage Atlas Resource Policies within your organization.", + "name" : "Resource Policies" }, { "description" : "Creates one index to a database deployment in a rolling manner. You can't create a rolling index on an `M0` free cluster or `M2/M5` shared cluster.", "name" : "Rolling Index" @@ -135,6 +142,13 @@ "url" : "https://dochub.mongodb.org/core/serverless-private-endpoint" }, "name" : "Serverless Private Endpoints" + }, { + "description" : "Endpoints for managing Service Accounts and secrets. Service Accounts are used for programmatic access to the Atlas Admin API through the OAuth 2.0 Client Credentials flow. This feature is available as a Preview feature.", + "externalDocs" : { + "description" : "Get Started with the Atlas Administration API", + "url" : "https://www.mongodb.com/docs/atlas/configure-api-access/" + }, + "name" : "Service Accounts" }, { "description" : "Returns and adds restore jobs for shared-tier database deployments.", "name" : "Shared-Tier Restore Jobs" @@ -2904,7 +2918,7 @@ }, "/api/atlas/v2/groups/{groupId}/backup/exportBuckets" : { "get" : { - "description" : "Returns all AWS S3 buckets and Azure Blob Storage Containers associated with the specified Project. To use this resource, the requesting API Key must have the Project Read Only role.", + "description" : "Returns all Export Buckets associated with the specified Project. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "listExportBuckets", "parameters" : [ { "$ref" : "#/components/parameters/envelope" @@ -2926,7 +2940,7 @@ "schema" : { "$ref" : "#/components/schemas/PaginatedBackupSnapshotExportBucketView" }, - "x-sunset" : "2025-05-30", + "x-sunset" : "2026-05-30", "x-xgen-version" : "2023-01-01" }, "application/vnd.atlas.2024-05-30+json" : { @@ -2948,11 +2962,11 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Return All AWS S3 Buckets and Azure Blob Storage Containers Used for Cloud Backup Snapshot Exports", + "summary" : "Return All Snapshot Export Buckets", "tags" : [ "Cloud Backups" ] }, "post" : { - "description" : "Grants MongoDB Cloud access to the specified AWS S3 Bucket or Azure Blob Storage Container. This enables this Export Bucket to receive Atlas Cloud Backup Snapshots. To use this resource, the requesting API Key must have the Project Owner role.", + "description" : "Creates a Snapshot Export Bucket for an AWS S3 Bucket or Azure Blob Storage Container. Once created, an snapshots can be exported to the Export Bucket and its referenced AWS S3 Bucket or Azure Blob Storage Container. To use this resource, the requesting API Key must have the Project Owner role.", "operationId" : "createExportBucket", "parameters" : [ { "$ref" : "#/components/parameters/envelope" @@ -2997,7 +3011,7 @@ "x-xgen-version" : "2024-05-30" } }, - "description" : "Grants MongoDB Cloud access to the specified AWS S3 Bucket or Azure Blob Storage Container.", + "description" : "Specifies the role and AWS S3 Bucket or Azure Blob Storage Container that the Export Bucket should reference.", "required" : true }, "responses" : { @@ -3007,7 +3021,7 @@ "schema" : { "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" }, - "x-sunset" : "2025-05-30", + "x-sunset" : "2026-05-30", "x-xgen-version" : "2023-01-01" }, "application/vnd.atlas.2024-05-30+json" : { @@ -3065,20 +3079,20 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Grant Access to AWS S3 Bucket or Azure Blob Storage Container for Cloud Backup Snapshot Exports", + "summary" : "Create One Snapshot Export Bucket", "tags" : [ "Cloud Backups" ] } }, "/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}" : { "delete" : { - "description" : "Revoke MongoDB Cloud access to the specified AWS S3 Bucket or Azure Blob Storage Container. This prevents this Export Bucket from receiving Atlas Cloud Backup Snapshots. 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 API Key must have the Project Owner role.", + "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 API Key must have the Project Owner role.", "operationId" : "deleteExportBucket", "parameters" : [ { "$ref" : "#/components/parameters/envelope" }, { "$ref" : "#/components/parameters/groupId" }, { - "description" : "Unique string that identifies the AWS S3 Bucket or Azure Blob Storage Container to which you export your Snapshots.", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", "in" : "path", "name" : "exportBucketId", "required" : true, @@ -3118,11 +3132,11 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Revoke Access to AWS S3 Bucket or Azure Blob Storage Container for Cloud Backup Snapshot Exports", + "summary" : "Delete One Snapshot Export Bucket", "tags" : [ "Cloud Backups" ] }, "get" : { - "description" : "Returns one AWS S3 Bucket or Azure Blob Storage Container associated with the specified Project. To use this resource, the requesting API Key must have the Project Read Only role.", + "description" : "Returns one Export Bucket associated with the specified Project. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "getExportBucket", "parameters" : [ { "$ref" : "#/components/parameters/envelope" @@ -3148,7 +3162,7 @@ "schema" : { "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" }, - "x-sunset" : "2025-05-30", + "x-sunset" : "2026-05-30", "x-xgen-version" : "2023-01-01" }, "application/vnd.atlas.2024-05-30+json" : { @@ -3203,7 +3217,7 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Return One AWS S3 Bucket or Azure Blob Storage Container Used for Cloud Backup Snapshot Exports", + "summary" : "Return One Snapshot Export Bucket", "tags" : [ "Cloud Backups" ] } }, @@ -3225,7 +3239,7 @@ "schema" : { "$ref" : "#/components/schemas/DataProtectionSettings" }, - "x-sunset" : "2024-10-01", + "x-sunset" : "2026-10-01", "x-xgen-version" : "2023-01-01" }, "application/vnd.atlas.2023-10-01+json" : { @@ -3297,7 +3311,7 @@ "schema" : { "$ref" : "#/components/schemas/DataProtectionSettings" }, - "x-sunset" : "2024-10-01", + "x-sunset" : "2025-10-01", "x-xgen-version" : "2023-01-01" }, "application/vnd.atlas.2023-10-01+json" : { @@ -3383,7 +3397,7 @@ "content" : { "application/vnd.atlas.2023-01-01+json" : { "schema" : { - "$ref" : "#/components/schemas/CloudProviderAccessRole" + "$ref" : "#/components/schemas/CloudProviderAccessRoleRequest" } } }, @@ -3433,7 +3447,7 @@ "required" : true, "schema" : { "type" : "string", - "enum" : [ "AWS" ] + "enum" : [ "AWS", "AZURE", "GCP" ] } }, { "description" : "Unique 24-hexadecimal digit string that identifies the role.", @@ -3521,7 +3535,7 @@ "tags" : [ "Cloud Provider Access" ] }, "patch" : { - "description" : "Grants access to the specified project for the specified access role. To use this resource, the requesting API Key must have the Project Owner role. This API endpoint is one step in a procedure to create unified access for MongoDB Cloud services.", + "description" : "Grants access to the specified project for the specified access role. To use this resource, the requesting API Key must have the Project Owner role. This API endpoint is one step in a procedure to create unified access for MongoDB Cloud services. 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/" @@ -3549,7 +3563,7 @@ "content" : { "application/vnd.atlas.2023-01-01+json" : { "schema" : { - "$ref" : "#/components/schemas/CloudProviderAccessRole" + "$ref" : "#/components/schemas/CloudProviderAccessRoleRequestUpdate" } } }, @@ -3678,7 +3692,99 @@ "examples" : { "Cluster" : { "description" : "Cluster", - "value" : "{\n \"clusterType\": \"SHARDED\",\n \"links\": [],\n \"name\": \"myCluster\",\n \"replicationSpecs\": [\n {\n \"regionConfigs\": [\n {\n \"analyticsAutoScaling\": {\n \"autoIndexing\": {\n \"enabled\": false\n },\n \"compute\": {\n \"enabled\": true,\n \"maxInstanceSize\": \"M40\",\n \"minInstanceSize\": \"M30\",\n \"scaleDownEnabled\": true\n },\n \"diskGB\": {\n \"enabled\": true\n }\n },\n \"analyticsSpecs\": {\n \"instanceSize\": \"M30\",\n \"nodeCount\": 0,\n \"diskSizeGB\": 10.0\n },\n \"autoScaling\": {\n \"autoIndexing\": {\n \"enabled\": false\n },\n \"compute\": {\n \"enabled\": true,\n \"maxInstanceSize\": \"M40\",\n \"minInstanceSize\": \"M30\",\n \"scaleDownEnabled\": true\n },\n \"diskGB\": {\n \"enabled\": true\n }\n },\n \"electableSpecs\": {\n \"instanceSize\": \"M30\",\n \"nodeCount\": 3,\n \"diskSizeGB\": 10.0\n },\n \"hiddenSecondarySpecs\": {\n \"instanceSize\": \"M30\",\n \"nodeCount\": 0,\n \"diskSizeGB\": 10.0\n },\n \"priority\": 7,\n \"providerName\": \"AWS\",\n \"readOnlySpecs\": {\n \"instanceSize\": \"M30\",\n \"nodeCount\": 0,\n \"diskSizeGB\": 10.0\n },\n \"regionName\": \"US_EAST_1\"\n }\n ],\n \"zoneName\": \"Zone 1\"\n },\n {\n \"regionConfigs\": [\n {\n \"analyticsAutoScaling\": {\n \"autoIndexing\": {\n \"enabled\": false\n },\n \"compute\": {\n \"enabled\": true,\n \"maxInstanceSize\": \"M20\",\n \"minInstanceSize\": \"M10\",\n \"scaleDownEnabled\": true\n },\n \"diskGB\": {\n \"enabled\": true\n }\n },\n \"analyticsSpecs\": {\n \"instanceSize\": \"M10\",\n \"nodeCount\": 0,\n \"diskSizeGB\": 10.0\n },\n \"autoScaling\": {\n \"autoIndexing\": {\n \"enabled\": false\n },\n \"compute\": {\n \"enabled\": true,\n \"maxInstanceSize\": \"M20\",\n \"minInstanceSize\": \"M10\",\n \"scaleDownEnabled\": true\n },\n \"diskGB\": {\n \"enabled\": true\n }\n },\n \"electableSpecs\": {\n \"instanceSize\": \"M10\",\n \"nodeCount\": 3,\n \"diskSizeGB\": 10.0\n },\n \"hiddenSecondarySpecs\": {\n \"instanceSize\": \"M10\",\n \"nodeCount\": 0,\n \"diskSizeGB\": 10.0\n },\n \"priority\": 7,\n \"providerName\": \"AWS\",\n \"readOnlySpecs\": {\n \"instanceSize\": \"M10\",\n \"nodeCount\": 0,\n \"diskSizeGB\": 10.0\n },\n \"regionName\": \"US_EAST_1\"\n }\n ],\n \"zoneName\": \"Zone 1\"\n },\n ]\n}\n" + "value" : { + "clusterType" : "SHARDED", + "name" : "myCluster", + "replicationSpecs" : [ { + "regionConfigs" : [ { + "analyticsAutoScaling" : { + "autoIndexing" : { + "enabled" : false + }, + "compute" : { + "enabled" : false + }, + "diskGB" : { + "enabled" : true + } + }, + "analyticsSpecs" : { + "diskSizeGB" : 10.0, + "instanceSize" : "M30", + "nodeCount" : 0 + }, + "autoScaling" : { + "autoIndexing" : { + "enabled" : false + }, + "compute" : { + "enabled" : false + }, + "diskGB" : { + "enabled" : true + } + }, + "electableSpecs" : { + "diskSizeGB" : 10.0, + "instanceSize" : "M30", + "nodeCount" : 3 + }, + "priority" : 7, + "providerName" : "AWS", + "readOnlySpecs" : { + "diskSizeGB" : 10.0, + "instanceSize" : "M30", + "nodeCount" : 0 + }, + "regionName" : "US_EAST_1" + } ], + "zoneName" : "Zone 1" + }, { + "regionConfigs" : [ { + "analyticsAutoScaling" : { + "autoIndexing" : { + "enabled" : false + }, + "compute" : { + "enabled" : false + }, + "diskGB" : { + "enabled" : true + } + }, + "analyticsSpecs" : { + "diskSizeGB" : 10.0, + "instanceSize" : "M10", + "nodeCount" : 0 + }, + "autoScaling" : { + "autoIndexing" : { + "enabled" : false + }, + "compute" : { + "enabled" : false + }, + "diskGB" : { + "enabled" : true + } + }, + "electableSpecs" : { + "diskSizeGB" : 10.0, + "instanceSize" : "M10", + "nodeCount" : 3 + }, + "priority" : 7, + "providerName" : "AWS", + "readOnlySpecs" : { + "diskSizeGB" : 10.0, + "instanceSize" : "M10", + "nodeCount" : 0 + }, + "regionName" : "US_EAST_1" + } ], + "zoneName" : "Zone 1" + } ] + } } }, "schema" : { @@ -3941,7 +4047,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster.", @@ -4004,7 +4110,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -4070,7 +4176,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -4146,7 +4252,7 @@ }, "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports" : { "get" : { - "description" : "Returns all Cloud Backup snapshot export jobs associated with the specified Atlas cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role.", + "description" : "Returns all Cloud Backup Snapshot Export Jobs associated with the specified Atlas cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role.", "operationId" : "listBackupExportJobs", "parameters" : [ { "$ref" : "#/components/parameters/envelope" @@ -4169,7 +4275,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -4194,11 +4300,11 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Return All Cloud Backup Snapshot Export Jobs", + "summary" : "Return All Snapshot Export Jobs", "tags" : [ "Cloud Backups" ] }, "post" : { - "description" : "Exports one backup snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. To use this resource, the requesting API Key must have the Project Atlas Admin role.", + "description" : "Exports one backup Snapshot for dedicated Atlas cluster using Cloud Backups to an Export Bucket. To use this resource, the requesting API Key must have the Project Atlas Admin role.", "operationId" : "createBackupExportJob", "parameters" : [ { "$ref" : "#/components/parameters/envelope" @@ -4213,7 +4319,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -4258,13 +4364,13 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Create One Cloud Backup Snapshot Export Job", + "summary" : "Create One Snapshot Export Job", "tags" : [ "Cloud Backups" ] } }, "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}" : { "get" : { - "description" : "Returns one Cloud Backup snapshot export job associated with the specified Atlas cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role.", + "description" : "Returns one Cloud Backup Snapshot Export Job associated with the specified Atlas cluster. To use this resource, the requesting API Key must have the Project Atlas Admin role.", "operationId" : "getBackupExportJob", "parameters" : [ { "$ref" : "#/components/parameters/envelope" @@ -4279,15 +4385,19 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { - "description" : "Unique string that identifies the export job to return.", + "description" : "Unique 24-hexadecimal character string that identifies the Export Job.", "in" : "path", "name" : "exportId", "required" : true, "schema" : { - "type" : "string" + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" } } ], "responses" : { @@ -4312,7 +4422,7 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Return One Cloud Backup Snapshot Export Job", + "summary" : "Return One Snapshot Export Job", "tags" : [ "Cloud Backups" ] } }, @@ -4341,7 +4451,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -4387,7 +4497,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -4455,7 +4565,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the restore job to remove.", @@ -4515,7 +4625,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the restore job to return.", @@ -4572,7 +4682,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -4582,7 +4692,7 @@ "schema" : { "$ref" : "#/components/schemas/DiskBackupSnapshotSchedule" }, - "x-sunset" : "2025-08-05", + "x-sunset" : "2026-05-30", "x-xgen-version" : "2023-01-01" }, "application/vnd.atlas.2024-08-05+json" : { @@ -4628,7 +4738,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -4638,7 +4748,7 @@ "schema" : { "$ref" : "#/components/schemas/DiskBackupSnapshotSchedule" }, - "x-sunset" : "2025-08-05", + "x-sunset" : "2026-05-30", "x-xgen-version" : "2023-01-01" }, "application/vnd.atlas.2024-08-05+json" : { @@ -4681,7 +4791,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -4707,7 +4817,7 @@ "schema" : { "$ref" : "#/components/schemas/DiskBackupSnapshotSchedule" }, - "x-sunset" : "2025-08-05", + "x-sunset" : "2026-05-30", "x-xgen-version" : "2023-01-01" }, "application/vnd.atlas.2024-08-05+json" : { @@ -4761,7 +4871,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -4810,7 +4920,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -4872,7 +4982,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -4929,7 +5039,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -4991,7 +5101,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -5042,7 +5152,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -5102,7 +5212,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -5162,7 +5272,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -5229,7 +5339,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "$ref" : "#/components/parameters/envelope" @@ -5300,7 +5410,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "$ref" : "#/components/parameters/envelope" @@ -5368,7 +5478,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "$ref" : "#/components/parameters/envelope" @@ -5419,7 +5529,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "$ref" : "#/components/parameters/envelope" @@ -5487,7 +5597,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -5538,7 +5648,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -5607,7 +5717,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -5667,7 +5777,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -5719,7 +5829,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -5769,7 +5879,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -5841,7 +5951,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -5915,7 +6025,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -5985,7 +6095,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -6056,7 +6166,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Name of the collection that contains one or more Atlas Search indexes.", @@ -6129,7 +6239,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the Atlas Search index. Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes.", @@ -6195,7 +6305,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "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.", @@ -6258,7 +6368,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "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.", @@ -6339,7 +6449,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -6405,7 +6515,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -6469,7 +6579,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -6558,7 +6668,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "$ref" : "#/components/parameters/groupId" @@ -6641,7 +6751,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -6735,7 +6845,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -6889,7 +6999,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -6939,7 +7049,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -7032,7 +7142,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Flag that indicates whether to download logs for queries against your online archive only or both your online archive and cluster.", @@ -7111,7 +7221,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -7175,7 +7285,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -7242,7 +7352,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -7314,7 +7424,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -7370,7 +7480,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -7426,7 +7536,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -7469,6 +7579,98 @@ "tags" : [ "Cluster Outage Simulation" ] } }, + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/suggestedIndexes" : { + "get" : { + "description" : "Returns the indexes that the Performance Advisor suggests. The Performance Advisor monitors queries that MongoDB considers slow and suggests new indexes to improve query performance. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "listSuggestedIndexes_1", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + } + }, { + "description" : "ProcessIds from which to retrieve suggested indexes. A processId is a combination of host and port that serves the MongoDB process. The host must be the hostname, FQDN, IPv4 address, or IPv6 address of the host that runs the MongoDB process (`mongod` or `mongos`). The port must be the IANA port on which the MongoDB process listens for requests. To include multiple processIds, pass the parameter multiple times delimited with an ampersand (`&`) between each processId.", + "in" : "query", + "name" : "processIds", + "schema" : { + "type" : "array", + "items" : { + "type" : "string", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + } + }, + "style" : "form" + }, { + "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.", + "in" : "query", + "name" : "namespaces", + "schema" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "style" : "form" + }, { + "description" : "HostType determines the source of index advice from logs. If **hostType**=All, index advice from logs will come from all processes within a cluster and **processIds** will be ignored. If hostType=Null, index advice from logs will come from the subset of processes within this cluster specified using *processIds**.", + "in" : "query", + "name" : "hostType", + "schema" : { + "type" : "string" + } + }, { + "description" : "Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).\n\n- If you don't specify the **until** parameter, the endpoint returns data covering from the **since** value and the current time.\n- If you specify neither the **since** nor the **until** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "since", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600000 + } + }, { + "description" : "Date and time up until which the query retrieves the suggested indexes. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time).\n\n- If you specify the **until** parameter, you must specify the **since** parameter.\n- If you specify neither the **since** nor the **until** parameters, the endpoint returns data from the previous 24 hours.", + "in" : "query", + "name" : "until", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600000 + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PerformanceAdvisorResponse" + }, + "x-xgen-version" : "2025-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return Suggested Indexes", + "tags" : [ "Performance Advisor" ] + } + }, "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs" : { "get" : { "description" : "Returns the advanced configuration details for one cluster in the specified project. Clusters contain a group of hosts that maintain the same data set. Advanced configuration details include the read/write concern, index and oplog limits, and other database settings. This feature isn't available for `M0` free clusters, `M2` and `M5` shared-tier clusters, or serverless clusters. To use this resource, the requesting API Key must have the Project Read Only role.", @@ -7492,7 +7694,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -7552,7 +7754,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -7631,7 +7833,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -7697,7 +7899,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -7747,7 +7949,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -7810,7 +8012,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", @@ -7872,7 +8074,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -7933,7 +8135,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -7989,7 +8191,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -8064,7 +8266,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -8150,7 +8352,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -8216,7 +8418,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -8285,7 +8487,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Name of the collection that contains one or more Atlas Search indexes.", @@ -8369,7 +8571,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Name of the collection that contains one or more Atlas Search indexes.", @@ -8446,7 +8648,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Name of the collection that contains one or more Atlas Search indexes.", @@ -8523,7 +8725,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Name of the collection that contains one or more Atlas Search indexes.", @@ -8616,7 +8818,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the Atlas Search index. Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/) endpoint to find the IDs of all Atlas Search indexes.", @@ -8680,7 +8882,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "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.", @@ -8754,7 +8956,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "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.", @@ -8831,7 +9033,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -8878,7 +9080,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -8944,7 +9146,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Human-readable label that specifies whether to return only completed, incomplete, or all snapshots. By default, MongoDB Cloud only returns completed snapshots.", @@ -9002,7 +9204,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -9063,7 +9265,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -9121,7 +9323,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -9191,7 +9393,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -9235,7 +9437,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Human-readable label that identifies the cluster topology to retrieve metrics for.", @@ -9296,7 +9498,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Human-readable label that identifies the cluster topology to retrieve metrics for.", @@ -9367,10 +9569,10 @@ "tags" : [ "Collection Level Metrics" ] } }, - "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:pinFeatureCompatibilityVersion" : { + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:grantMongoDBEmployeeAccess" : { "post" : { - "description" : "Pins the FCV to the current MongoDB version.", - "operationId" : "pinFeatureCompatibilityVersion", + "description" : "Grants MongoDB employee cluster access for the given duration and at the specified level for one cluster.", + "operationId" : "grantMongoDBEmployeeAccess", "parameters" : [ { "$ref" : "#/components/parameters/envelope" }, { @@ -9386,28 +9588,29 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { "content" : { - "application/vnd.atlas.2024-05-30+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { - "$ref" : "#/components/schemas/PinFCVView" + "$ref" : "#/components/schemas/EmployeeAccessGrantView" }, - "x-xgen-version" : "2024-05-30" + "x-xgen-version" : "2024-08-05" } }, - "description" : "Optional request params for tuning FCV pinning configuration." + "description" : "Grant access level and expiration.", + "required" : true }, "responses" : { "204" : { "content" : { - "application/vnd.atlas.2024-05-30+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { "$ref" : "#/components/schemas/NoBody" }, - "x-xgen-version" : "2024-05-30" + "x-xgen-version" : "2024-08-05" } }, "description" : "This endpoint does not return a response body." @@ -9431,20 +9634,20 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Pin FCV for One Cluster from One Project", + "summary" : "Grant MongoDB employee cluster access for one cluster.", "tags" : [ "Clusters" ] } }, - "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:unpinFeatureCompatibilityVersion" : { + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:pinFeatureCompatibilityVersion" : { "post" : { - "description" : "Unpins the current fixed Feature Compatibility Version. This feature is not available for clusters on rapid release.", - "operationId" : "unpinFeatureCompatibilityVersion", + "description" : "Pins the FCV to the current MongoDB version.", + "operationId" : "pinFeatureCompatibilityVersion", "parameters" : [ { "$ref" : "#/components/parameters/envelope" - }, { - "$ref" : "#/components/parameters/groupId" }, { "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" }, { "description" : "Human-readable label that identifies this cluster.", "in" : "path", @@ -9454,9 +9657,20 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2024-05-30+json" : { + "schema" : { + "$ref" : "#/components/schemas/PinFCVView" + }, + "x-xgen-version" : "2024-05-30" + } + }, + "description" : "Optional request params for tuning FCV pinning configuration." + }, "responses" : { "204" : { "content" : { @@ -9475,11 +9689,8 @@ "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" @@ -9491,81 +9702,43 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Unpins FCV for One Cluster from One Project", + "summary" : "Pin FCV for One Cluster from One Project", "tags" : [ "Clusters" ] } }, - "/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz" : { - "get" : { - "description" : "Returns a compressed (.gz) log file that contains a range of log messages for the specified host for the specified project. MongoDB updates process and audit logs from the cluster backend infrastructure every five minutes and contain log data from the previous five minutes. If you poll the API for log files, we recommend polling every five minutes. For example, if the logs are updated at 4:00 UTC and then you poll the API, the API returns log data from the interval between 3:55 UTC and 4:00 UTC. This feature isn't available for `M0` free clusters, `M2`, `M5`, or serverless clusters. To use this resource, the requesting API Key must have the Project Data Access Read Only or higher role. 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", + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:revokeMongoDBEmployeeAccess" : { + "post" : { + "description" : "Revokes a previously granted MongoDB employee cluster access.", + "operationId" : "revokeMongoDBEmployeeAccess", "parameters" : [ { "$ref" : "#/components/parameters/envelope" }, { - "$ref" : "#/components/parameters/groupId" + "$ref" : "#/components/parameters/pretty" }, { - "description" : "Human-readable label that identifies the host that stores the log files that you want to download.", - "in" : "path", - "name" : "hostName", - "required" : true, - "schema" : { - "type" : "string", - "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$" - } + "$ref" : "#/components/parameters/groupId" }, { - "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.", + "description" : "Human-readable label that identifies this cluster.", "in" : "path", - "name" : "logName", + "name" : "clusterName", "required" : true, "schema" : { "type" : "string", - "enum" : [ "mongodb", "mongos", "mongodb-audit-log", "mongos-audit-log" ], - "externalDocs" : { - "description" : "Set up Database Auditing", - "url" : "https://docs.atlas.mongodb.com/database-auditing/" - } - } - }, { - "description" : "Date and time when the period specifies the inclusive ending point for the range of log messages to retrieve. This parameter expresses its value in the number of seconds that have elapsed since the UNIX epoch.", - "in" : "query", - "name" : "endDate", - "schema" : { - "type" : "integer", - "format" : "int64", - "minimum" : 1199145600 - } - }, { - "description" : "Date and time when the period specifies the inclusive starting point for the range of log messages to retrieve. This parameter expresses its value in the number of seconds that have elapsed since the UNIX epoch.", - "in" : "query", - "name" : "startDate", - "schema" : { - "type" : "integer", - "format" : "int64", - "minimum" : 1199145600 + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { - "200" : { + "204" : { "content" : { - "application/vnd.atlas.2023-01-01+gzip" : { - "schema" : { - "type" : "string", - "format" : "binary", - "description" : "Compressed (.gz) log file that contains a range of log messages for the specified host for the specified project" - }, - "x-sunset" : "2025-06-01", - "x-xgen-version" : "2023-01-01" - }, - "application/vnd.atlas.2023-02-01+gzip" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { - "type" : "string", - "format" : "binary", - "description" : "Compressed (.gz) log file that contains a range of log messages for the specified host for the specified project" + "$ref" : "#/components/schemas/NoBody" }, - "x-xgen-version" : "2023-02-01" + "x-xgen-version" : "2024-08-05" } }, - "description" : "OK" + "description" : "This endpoint does not return a response body." }, "400" : { "$ref" : "#/components/responses/badRequest" @@ -9573,9 +9746,6 @@ "401" : { "$ref" : "#/components/responses/unauthorized" }, - "403" : { - "$ref" : "#/components/responses/forbidden" - }, "404" : { "$ref" : "#/components/responses/notFound" }, @@ -9589,39 +9759,58 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Download Logs for One Cluster Host in One Project", - "tags" : [ "Monitoring and Logs" ] + "summary" : "Revoke granted MongoDB employee cluster access for one cluster.", + "tags" : [ "Clusters" ] } }, - "/api/atlas/v2/groups/{groupId}/collStats/metrics" : { - "get" : { - "description" : "Returns all available Coll Stats Latency metric names and their respective units for the specified project at the time of request.", - "operationId" : "getCollStatsLatencyNamespaceMetrics", + "/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:unpinFeatureCompatibilityVersion" : { + "post" : { + "description" : "Unpins the current fixed Feature Compatibility Version. This feature is not available for clusters on rapid release.", + "operationId" : "unpinFeatureCompatibilityVersion", "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { "$ref" : "#/components/parameters/groupId" }, { - "$ref" : "#/components/parameters/envelope" + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies this cluster.", + "in" : "path", + "name" : "clusterName", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + } } ], "responses" : { - "200" : { + "204" : { "content" : { - "application/vnd.atlas.2023-11-15+json" : { + "application/vnd.atlas.2024-05-30+json" : { "schema" : { "$ref" : "#/components/schemas/NoBody" }, - "x-xgen-version" : "2023-11-15" + "x-xgen-version" : "2024-05-30" } }, - "description" : "Succeeded" + "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" @@ -9630,94 +9819,233 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Return all metric names", - "tags" : [ "Collection Level Metrics" ] + "summary" : "Unpins FCV for One Cluster from One Project", + "tags" : [ "Clusters" ] } }, - "/api/atlas/v2/groups/{groupId}/containers" : { + "/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz" : { "get" : { - "description" : "Returns details about all network peering containers in the specified project for the specified cloud provider. If you do not specify the cloud provider, MongoDB Cloud returns details about all network peering containers in the project for Amazon Web Services (AWS). To use this resource, the requesting API Key must have the Project Read Only role.", - "operationId" : "listPeeringContainerByCloudProvider", + "description" : "Returns a compressed (.gz) log file that contains a range of log messages for the specified host for the specified project. MongoDB updates process and audit logs from the cluster backend infrastructure every five minutes and contain log data from the previous five minutes. If you poll the API for log files, we recommend polling every five minutes. For example, if the logs are updated at 4:00 UTC and then you poll the API, the API returns log data from the interval between 3:55 UTC and 4:00 UTC. This feature isn't available for `M0` free clusters, `M2`, `M5`, or serverless clusters. To use this resource, the requesting API Key must have the Project Data Access Read Only or higher role. 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" }, { - "$ref" : "#/components/parameters/includeCount" - }, { - "$ref" : "#/components/parameters/itemsPerPage" + "description" : "Human-readable label that identifies the host that stores the log files that you want to download.", + "in" : "path", + "name" : "hostName", + "required" : true, + "schema" : { + "type" : "string", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\.){1,10}[a-z]+)?$" + } }, { - "$ref" : "#/components/parameters/pageNum" + "description" : "Human-readable label that identifies the log file that you want to return. To return audit logs, enable *Database Auditing* for the specified project.", + "in" : "path", + "name" : "logName", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "mongodb", "mongos", "mongodb-audit-log", "mongos-audit-log" ], + "externalDocs" : { + "description" : "Set up Database Auditing", + "url" : "https://docs.atlas.mongodb.com/database-auditing/" + } + } }, { - "$ref" : "#/components/parameters/pretty" + "description" : "Specifies the date and time for the ending point of the range of log messages to retrieve, in the number of seconds that have elapsed since the UNIX epoch. This value will default to 24 hours after the start date. If the start date is also unspecified, the value will default to the time of the request.", + "in" : "query", + "name" : "endDate", + "schema" : { + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600 + } }, { - "description" : "Cloud service provider that serves the desired network peering containers.", + "description" : "Specifies the date and time for the starting point of the range of log messages to retrieve, in the number of seconds that have elapsed since the UNIX epoch. This value will default to 24 hours prior to the end date. If the end date is also unspecified, the value will default to 24 hours prior to the time of the request.", "in" : "query", - "name" : "providerName", - "required" : true, + "name" : "startDate", "schema" : { - "type" : "string", - "default" : "AWS", - "enum" : [ "AWS", "AZURE", "GCP" ] + "type" : "integer", + "format" : "int64", + "minimum" : 1199145600 } } ], "responses" : { "200" : { "content" : { - "application/vnd.atlas.2023-01-01+json" : { + "application/vnd.atlas.2023-01-01+gzip" : { "schema" : { - "$ref" : "#/components/schemas/PaginatedCloudProviderContainerView" + "type" : "string", + "format" : "binary", + "description" : "Compressed (.gz) log file that contains a range of log messages for the specified host for the specified project" }, + "x-sunset" : "2025-06-01", "x-xgen-version" : "2023-01-01" - } - }, - "description" : "OK" - }, - "401" : { - "$ref" : "#/components/responses/unauthorized" - }, - "404" : { - "$ref" : "#/components/responses/notFound" - }, - "500" : { - "$ref" : "#/components/responses/internalServerError" - } - }, - "security" : [ { - "DigestAuth" : [ ] - } ], - "summary" : "Return All Network Peering Containers in One Project for One Cloud Provider", - "tags" : [ "Network Peering" ] - }, - "post" : { - "description" : "Creates one new network peering container in the specified project. MongoDB Cloud can deploy Network Peering connections in a network peering container. GCP can have one container per project. AWS and Azure can have one container per cloud provider region. To use this resource, the requesting API Key must have the Project Owner role.", - "operationId" : "createPeeringContainer", - "parameters" : [ { - "$ref" : "#/components/parameters/envelope" - }, { - "$ref" : "#/components/parameters/groupId" - }, { - "$ref" : "#/components/parameters/pretty" - } ], - "requestBody" : { - "content" : { - "application/vnd.atlas.2023-01-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/CloudProviderContainer" - } - } - }, - "description" : "Creates one new network peering container in the specified project.", - "required" : true - }, - "responses" : { - "200" : { - "content" : { - "application/vnd.atlas.2023-01-01+json" : { + }, + "application/vnd.atlas.2023-02-01+gzip" : { "schema" : { - "$ref" : "#/components/schemas/CloudProviderContainer" + "type" : "string", + "format" : "binary", + "description" : "Compressed (.gz) log file that contains a range of log messages for the specified host for the specified project" }, - "x-xgen-version" : "2023-01-01" + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Download Logs for One Cluster Host in One Project", + "tags" : [ "Monitoring and Logs" ] + } + }, + "/api/atlas/v2/groups/{groupId}/collStats/metrics" : { + "get" : { + "description" : "Returns all available Coll Stats Latency metric names and their respective units for the specified project at the time of request.", + "operationId" : "getCollStatsLatencyNamespaceMetrics", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-11-15+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-11-15" + } + }, + "description" : "Succeeded" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return all metric names", + "tags" : [ "Collection Level Metrics" ] + } + }, + "/api/atlas/v2/groups/{groupId}/containers" : { + "get" : { + "description" : "Returns details about all network peering containers in the specified project for the specified cloud provider. If you do not specify the cloud provider, MongoDB Cloud returns details about all network peering containers in the project for Amazon Web Services (AWS). To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "listPeeringContainerByCloudProvider", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Cloud service provider that serves the desired network peering containers.", + "in" : "query", + "name" : "providerName", + "required" : true, + "schema" : { + "type" : "string", + "default" : "AWS", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedCloudProviderContainerView" + }, + "x-xgen-version" : "2023-01-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Network Peering Containers in One Project for One Cloud Provider", + "tags" : [ "Network Peering" ] + }, + "post" : { + "description" : "Creates one new network peering container in the specified project. MongoDB Cloud can deploy Network Peering connections in a network peering container. GCP can have one container per project. AWS and Azure can have one container per cloud provider region. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "createPeeringContainer", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + } + } + }, + "description" : "Creates one new network peering container in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, + "x-xgen-version" : "2023-01-01" } }, "description" : "OK" @@ -11352,7 +11680,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Date and time when to stop retrieving database history. If you specify **end**, you must also specify **start**. This parameter uses UNIX epoch time in milliseconds.", @@ -11615,6 +11943,12 @@ "$ref" : "#/components/parameters/pretty" }, { "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" }, { "description" : "Human-readable label that identifies the cloud provider for the private endpoints to return.", "in" : "path", @@ -11737,17 +12071,6 @@ "pattern" : "^([a-f0-9]{24})$" } } ], - "requestBody" : { - "content" : { - "application/vnd.atlas.2023-01-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/EncryptionAtRestPrivateEndpointRequest" - } - } - }, - "description" : "Cloud provider of the private endpoints to delete and the list of cloud provider regions in which to delete the private endpoints.", - "required" : true - }, "responses" : { "204" : { "content" : { @@ -11818,6 +12141,9 @@ "403" : { "$ref" : "#/components/responses/forbidden" }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, "500" : { "$ref" : "#/components/responses/internalServerError" } @@ -11855,7 +12181,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, "style" : "form" @@ -11992,6 +12318,327 @@ "tags" : [ "Events" ] } }, + "/api/atlas/v2/groups/{groupId}/flexClusters" : { + "get" : { + "description" : "Returns details for all flex clusters in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "listFlexClusters", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedFlexClusters20250101" + }, + "x-xgen-version" : "2025-01-01" + } + }, + "description" : "OK" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Flex Clusters from One Project", + "tags" : [ "Flex Clusters" ] + }, + "post" : { + "description" : "Creates one flex cluster in the specified project. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "createFlexcluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/FlexClusterDescriptionCreate20250101" + } + } + }, + "description" : "Create One Flex Cluster in One Project.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/FlexClusterDescription20250101" + }, + "x-xgen-version" : "2025-01-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Flex Cluster in One Project", + "tags" : [ "Flex Clusters" ] + } + }, + "/api/atlas/v2/groups/{groupId}/flexClusters/{name}" : { + "delete" : { + "description" : "Removes one flex cluster from the specified project. The flex cluster must have termination protection disabled in order to be deleted. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "deleteFlexCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the flex cluster.", + "in" : "path", + "name" : "name", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2025-01-01" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Flex Cluster from One Project", + "tags" : [ "Flex Clusters" ] + }, + "get" : { + "description" : "Returns details for one flex cluster in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "getFlexCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the flex cluster.", + "in" : "path", + "name" : "name", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/FlexClusterDescription20250101" + }, + "x-xgen-version" : "2025-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One Flex Cluster from One Project", + "tags" : [ "Flex Clusters" ] + }, + "patch" : { + "description" : "Updates one flex cluster in the specified project. To use this resource, the requesting API Key must have the Project Owner role.", + "operationId" : "updateFlexCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Human-readable label that identifies the flex cluster.", + "in" : "path", + "name" : "name", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/FlexClusterDescription20250101" + } + } + }, + "description" : "Update One Flex Cluster in One Project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/FlexClusterDescription20250101" + }, + "x-xgen-version" : "2025-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One Flex Cluster in One Project", + "tags" : [ "Flex Clusters" ] + } + }, + "/api/atlas/v2/groups/{groupId}/flexClusters:tenantUpgrade" : { + "post" : { + "description" : "Upgrades a flex cluster in the specified project. To use this resource, the requesting API key must have the Project Cluster Manager role.", + "operationId" : "upgradeFlexCluster", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/FlexClusterDescription20250101" + } + } + }, + "description" : "Details of the flex cluster upgrade in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/FlexClusterDescription20250101" + }, + "x-xgen-version" : "2025-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "402" : { + "$ref" : "#/components/responses/paymentRequired" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Upgrade One Flex Cluster", + "tags" : [ "Flex Clusters" ] + } + }, "/api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics" : { "get" : { "description" : "Returns all Atlas Search metric types available for one process in the specified project. You must have the Project Read Only or higher role to view the Atlas Search metric types.", @@ -12556,7 +13203,7 @@ "$ref" : "#/components/schemas/GroupInvitation" } }, - "x-sunset" : "2024-10-04", + "x-sunset" : "2024-11-04", "x-xgen-version" : "2023-01-01" } }, @@ -12604,7 +13251,7 @@ "schema" : { "$ref" : "#/components/schemas/GroupInvitation" }, - "x-sunset" : "2024-10-04", + "x-sunset" : "2024-11-04", "x-xgen-version" : "2023-01-01" } }, @@ -12658,7 +13305,7 @@ "schema" : { "$ref" : "#/components/schemas/GroupInvitation" }, - "x-sunset" : "2024-10-04", + "x-sunset" : "2024-11-04", "x-xgen-version" : "2023-01-01" } }, @@ -12706,7 +13353,7 @@ "schema" : { "$ref" : "#/components/schemas/NoBody" }, - "x-sunset" : "2024-10-04", + "x-sunset" : "2024-11-04", "x-xgen-version" : "2023-01-01" } }, @@ -12754,7 +13401,7 @@ "schema" : { "$ref" : "#/components/schemas/GroupInvitation" }, - "x-sunset" : "2024-10-04", + "x-sunset" : "2024-11-04", "x-xgen-version" : "2023-01-01" } }, @@ -12814,7 +13461,7 @@ "schema" : { "$ref" : "#/components/schemas/GroupInvitation" }, - "x-sunset" : "2024-10-04", + "x-sunset" : "2024-11-04", "x-xgen-version" : "2023-01-01" } }, @@ -12934,13 +13581,13 @@ "description" : "Removes the specified project limit. Depending on the limit, Atlas either resets the limit to its default value or removes the limit entirely. To use this resource, the requesting API Key must have the Project Owner role.", "operationId" : "deleteProjectLimit", "parameters" : [ { - "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", + "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| 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 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n| atlas.project.deployment.salesSoldM0s | Limit on the number of M0 clusters in this project if the org is sales-sold | 100 | 100 |\n", "in" : "path", "name" : "limitName", "required" : true, "schema" : { "type" : "string", - "enum" : [ "atlas.project.security.databaseAccess.users", "atlas.project.deployment.clusters", "atlas.project.deployment.serverlessMTMs", "atlas.project.security.databaseAccess.customRoles", "atlas.project.security.networkAccess.entries", "atlas.project.security.networkAccess.crossRegionEntries", "atlas.project.deployment.nodesPerPrivateLinkRegion", "dataFederation.bytesProcessed.query", "dataFederation.bytesProcessed.daily", "dataFederation.bytesProcessed.weekly", "dataFederation.bytesProcessed.monthly", "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", "atlas.project.deployment.privateServiceConnectionsSubnetMask" ] + "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" @@ -12984,13 +13631,13 @@ "description" : "Returns the specified limit for the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "getProjectLimit", "parameters" : [ { - "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", + "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| 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 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n| atlas.project.deployment.salesSoldM0s | Limit on the number of M0 clusters in this project if the org is sales-sold | 100 | 100 |\n", "in" : "path", "name" : "limitName", "required" : true, "schema" : { "type" : "string", - "enum" : [ "atlas.project.security.databaseAccess.users", "atlas.project.deployment.clusters", "atlas.project.deployment.serverlessMTMs", "atlas.project.security.databaseAccess.customRoles", "atlas.project.security.networkAccess.entries", "atlas.project.security.networkAccess.crossRegionEntries", "atlas.project.deployment.nodesPerPrivateLinkRegion", "dataFederation.bytesProcessed.query", "dataFederation.bytesProcessed.daily", "dataFederation.bytesProcessed.weekly", "dataFederation.bytesProcessed.monthly", "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", "atlas.project.deployment.privateServiceConnectionsSubnetMask" ] + "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" @@ -13037,13 +13684,13 @@ "description" : "Sets the specified project limit. To use this resource, the requesting API Key must have the Project Owner role.\n\n**NOTE**: Increasing the following configuration limits might lead to slower response times in the MongoDB Cloud UI or increased user management overhead leading to authentication or authorization re-architecture. If possible, we recommend that you create additional projects to gain access to more of these resources for a more sustainable growth pattern.", "operationId" : "setProjectLimit", "parameters" : [ { - "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n", + "description" : "Human-readable label that identifies this project limit.\n\n| Limit Name | Description | Default | API Override Limit |\n| --- | --- | --- | --- |\n| 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 |\n| atlas.project.deployment.nodesPerPrivateLinkRegion | Limit on the number of nodes per Private Link region in this project | 50 | 90 |\n| atlas.project.security.databaseAccess.customRoles | Limit on the number of custom roles in this project | 100 | 1400 |\n| atlas.project.security.databaseAccess.users | Limit on the number of database users in this project | 100 | 900 |\n| atlas.project.security.networkAccess.crossRegionEntries | Limit on the number of cross-region network access entries in this project | 40 | 220 |\n| atlas.project.security.networkAccess.entries | Limit on the number of network access entries in this project | 200 | 20 |\n| dataFederation.bytesProcessed.query | Limit on the number of bytes processed during a single Data Federation query | N/A | N/A |\n| dataFederation.bytesProcessed.daily | Limit on the number of bytes processed across all Data Federation tenants for the current day | N/A | N/A |\n| dataFederation.bytesProcessed.weekly | Limit on the number of bytes processed across all Data Federation tenants for the current week | N/A | N/A |\n| dataFederation.bytesProcessed.monthly | Limit on the number of bytes processed across all Data Federation tenants for the current month | N/A | N/A |\n| atlas.project.deployment.privateServiceConnectionsPerRegionGroup | Number of Private Service Connections per Region Group | 50 | 100|\n| atlas.project.deployment.privateServiceConnectionsSubnetMask | Subnet mask for GCP PSC Networks. Has lower limit of 20. | 27 | 27|\n| atlas.project.deployment.salesSoldM0s | Limit on the number of M0 clusters in this project if the org is sales-sold | 100 | 100 |\n", "in" : "path", "name" : "limitName", "required" : true, "schema" : { "type" : "string", - "enum" : [ "atlas.project.security.databaseAccess.users", "atlas.project.deployment.clusters", "atlas.project.deployment.serverlessMTMs", "atlas.project.security.databaseAccess.customRoles", "atlas.project.security.networkAccess.entries", "atlas.project.security.networkAccess.crossRegionEntries", "atlas.project.deployment.nodesPerPrivateLinkRegion", "dataFederation.bytesProcessed.query", "dataFederation.bytesProcessed.daily", "dataFederation.bytesProcessed.weekly", "dataFederation.bytesProcessed.monthly", "atlas.project.deployment.privateServiceConnectionsPerRegionGroup", "atlas.project.deployment.privateServiceConnectionsSubnetMask" ] + "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" @@ -14054,6 +14701,7 @@ }, "/api/atlas/v2/groups/{groupId}/pipelines" : { "get" : { + "deprecated" : true, "description" : "Returns a list of Data Lake Pipelines. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "listPipelines", "parameters" : [ { @@ -14071,6 +14719,7 @@ "$ref" : "#/components/schemas/DataLakeIngestionPipeline" } }, + "x-sunset" : "2025-09-09", "x-xgen-version" : "2023-01-01" } }, @@ -14093,7 +14742,12 @@ "tags" : [ "Data Lake Pipelines" ] }, "post" : { + "deprecated" : true, "description" : "Creates one Data Lake Pipeline.", + "externalDocs" : { + "description" : "Data Lake Pipelines are deprecated. Please see Data Lake Deprecation Guide.", + "url" : "https://dochub.mongodb.org/core/data-lake-deprecation" + }, "operationId" : "createPipeline", "parameters" : [ { "$ref" : "#/components/parameters/envelope" @@ -14118,6 +14772,7 @@ "schema" : { "$ref" : "#/components/schemas/DataLakeIngestionPipeline" }, + "x-sunset" : "2025-09-09", "x-xgen-version" : "2023-01-01" } }, @@ -14145,6 +14800,7 @@ }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}" : { "delete" : { + "deprecated" : true, "description" : "Removes one Data Lake Pipeline.", "operationId" : "deletePipeline", "parameters" : [ { @@ -14170,6 +14826,7 @@ "schema" : { "$ref" : "#/components/schemas/NoBody" }, + "x-sunset" : "2025-09-09", "x-xgen-version" : "2023-01-01" } }, @@ -14192,6 +14849,7 @@ "tags" : [ "Data Lake Pipelines" ] }, "get" : { + "deprecated" : true, "description" : "Returns the details of one Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "getPipeline", "parameters" : [ { @@ -14219,6 +14877,7 @@ "schema" : { "$ref" : "#/components/schemas/DataLakeIngestionPipeline" }, + "x-sunset" : "2025-09-09", "x-xgen-version" : "2023-01-01" } }, @@ -14241,6 +14900,7 @@ "tags" : [ "Data Lake Pipelines" ] }, "patch" : { + "deprecated" : true, "description" : "Updates one Data Lake Pipeline.", "operationId" : "updatePipeline", "parameters" : [ { @@ -14277,6 +14937,7 @@ "schema" : { "$ref" : "#/components/schemas/DataLakeIngestionPipeline" }, + "x-sunset" : "2025-09-09", "x-xgen-version" : "2023-01-01" } }, @@ -14307,6 +14968,7 @@ }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules" : { "get" : { + "deprecated" : true, "description" : "Returns a list of backup schedule policy items that you can use as a Data Lake Pipeline source. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "listPipelineSchedules", "parameters" : [ { @@ -14337,6 +14999,7 @@ "$ref" : "#/components/schemas/DiskBackupApiPolicyItem" } }, + "x-sunset" : "2025-09-09", "x-xgen-version" : "2023-01-01" } }, @@ -14361,6 +15024,7 @@ }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots" : { "get" : { + "deprecated" : true, "description" : "Returns a list of backup snapshots that you can use to trigger an on demand pipeline run. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "listPipelineSnapshots", "parameters" : [ { @@ -14403,6 +15067,7 @@ "schema" : { "$ref" : "#/components/schemas/PaginatedBackupSnapshotView" }, + "x-sunset" : "2025-09-09", "x-xgen-version" : "2023-01-01" } }, @@ -14427,6 +15092,7 @@ }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause" : { "post" : { + "deprecated" : true, "description" : "Pauses ingestion for a Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "pausePipeline", "parameters" : [ { @@ -14454,6 +15120,7 @@ "schema" : { "$ref" : "#/components/schemas/DataLakeIngestionPipeline" }, + "x-sunset" : "2025-09-09", "x-xgen-version" : "2023-01-01" } }, @@ -14478,6 +15145,7 @@ }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume" : { "post" : { + "deprecated" : true, "description" : "Resumes ingestion for a Data Lake Pipeline within the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "resumePipeline", "parameters" : [ { @@ -14505,6 +15173,7 @@ "schema" : { "$ref" : "#/components/schemas/DataLakeIngestionPipeline" }, + "x-sunset" : "2025-09-09", "x-xgen-version" : "2023-01-01" } }, @@ -14529,6 +15198,7 @@ }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs" : { "get" : { + "deprecated" : true, "description" : "Returns a list of past Data Lake Pipeline runs. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "listPipelineRuns", "parameters" : [ { @@ -14571,6 +15241,7 @@ "schema" : { "$ref" : "#/components/schemas/PaginatedPipelineRunView" }, + "x-sunset" : "2025-09-09", "x-xgen-version" : "2023-01-01" } }, @@ -14595,6 +15266,7 @@ }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}" : { "delete" : { + "deprecated" : true, "description" : "Deletes dataset that Atlas generated during the specified pipeline run.", "operationId" : "deletePipelineRunDataset", "parameters" : [ { @@ -14634,6 +15306,7 @@ "schema" : { "$ref" : "#/components/schemas/RequestAccepted" }, + "x-sunset" : "2025-09-09", "x-xgen-version" : "2023-01-01" } }, @@ -14656,6 +15329,7 @@ "tags" : [ "Data Lake Pipelines" ] }, "get" : { + "deprecated" : true, "description" : "Returns the details of one Data Lake Pipeline run within the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", "operationId" : "getPipelineRun", "parameters" : [ { @@ -14695,6 +15369,7 @@ "schema" : { "$ref" : "#/components/schemas/IngestionPipelineRun" }, + "x-sunset" : "2025-09-09", "x-xgen-version" : "2023-01-01" } }, @@ -14719,6 +15394,7 @@ }, "/api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger" : { "post" : { + "deprecated" : true, "description" : "Triggers a Data Lake Pipeline ingestion of a specified snapshot.", "operationId" : "triggerSnapshotIngestion", "parameters" : [ { @@ -14757,6 +15433,7 @@ "schema" : { "$ref" : "#/components/schemas/IngestionPipelineRun" }, + "x-sunset" : "2025-09-09", "x-xgen-version" : "2023-01-01" } }, @@ -14936,7 +15613,7 @@ "schema" : { "type" : "string", "maxLength" : 64, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -14989,7 +15666,7 @@ "schema" : { "type" : "string", "maxLength" : 64, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -15048,7 +15725,7 @@ "schema" : { "type" : "string", "maxLength" : 64, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be removed.", @@ -15105,7 +15782,7 @@ "schema" : { "type" : "string", "maxLength" : 64, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the tenant endpoint.", @@ -15162,7 +15839,7 @@ "schema" : { "type" : "string", "maxLength" : 64, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be updated.", @@ -16338,7 +17015,7 @@ "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" ] + "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" ] }, "maxItems" : 10, "minItems" : 1, @@ -16417,7 +17094,7 @@ "items" : { "type" : "string", "description" : "One measurement requested for this MongoDB process.", - "enum" : [ "ASSERT_MSG", "ASSERT_REGULAR", "ASSERT_USER", "ASSERT_WARNING", "BACKGROUND_FLUSH_AVG", "CACHE_BYTES_READ_INTO", "CACHE_BYTES_WRITTEN_FROM", "CACHE_DIRTY_BYTES", "CACHE_USED_BYTES", "COMPUTED_MEMORY", "CONNECTIONS", "CURSORS_TOTAL_OPEN", "CURSORS_TOTAL_TIMED_OUT", "DB_DATA_SIZE_TOTAL", "DB_STORAGE_TOTAL", "DOCUMENT_METRICS_DELETED", "DOCUMENT_METRICS_INSERTED", "DOCUMENT_METRICS_RETURNED", "DOCUMENT_METRICS_UPDATED", "EXTRA_INFO_PAGE_FAULTS", "FTS_DISK_UTILIZATION", "FTS_MEMORY_MAPPED", "FTS_MEMORY_RESIDENT", "FTS_MEMORY_VIRTUAL", "FTS_PROCESS_CPU_KERNEL", "FTS_PROCESS_CPU_USER", "FTS_PROCESS_NORMALIZED_CPU_KERNEL", "FTS_PROCESS_NORMALIZED_CPU_USER", "GLOBAL_ACCESSES_NOT_IN_MEMORY", "GLOBAL_LOCK_CURRENT_QUEUE_READERS", "GLOBAL_LOCK_CURRENT_QUEUE_TOTAL", "GLOBAL_LOCK_CURRENT_QUEUE_WRITERS", "GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN", "INDEX_COUNTERS_BTREE_ACCESSES", "INDEX_COUNTERS_BTREE_HITS", "INDEX_COUNTERS_BTREE_MISS_RATIO", "INDEX_COUNTERS_BTREE_MISSES", "JOURNALING_COMMITS_IN_WRITE_LOCK", "JOURNALING_MB", "JOURNALING_WRITE_DATA_FILES_MB", "MAX_PROCESS_CPU_CHILDREN_KERNEL", "MAX_PROCESS_CPU_CHILDREN_USER", "MAX_PROCESS_CPU_KERNEL", "MAX_PROCESS_CPU_USER", "MAX_PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL", "MAX_PROCESS_NORMALIZED_CPU_CHILDREN_USER", "MAX_PROCESS_NORMALIZED_CPU_KERNEL", "MAX_PROCESS_NORMALIZED_CPU_USER", "MAX_SWAP_USAGE_FREE", "MAX_SWAP_USAGE_USED ", "MAX_SYSTEM_CPU_GUEST", "MAX_SYSTEM_CPU_IOWAIT", "MAX_SYSTEM_CPU_IRQ", "MAX_SYSTEM_CPU_KERNEL", "MAX_SYSTEM_CPU_SOFTIRQ", "MAX_SYSTEM_CPU_STEAL", "MAX_SYSTEM_CPU_USER", "MAX_SYSTEM_MEMORY_AVAILABLE", "MAX_SYSTEM_MEMORY_FREE", "MAX_SYSTEM_MEMORY_USED", "MAX_SYSTEM_NETWORK_IN", "MAX_SYSTEM_NETWORK_OUT", "MAX_SYSTEM_NORMALIZED_CPU_GUEST", "MAX_SYSTEM_NORMALIZED_CPU_IOWAIT", "MAX_SYSTEM_NORMALIZED_CPU_IRQ", "MAX_SYSTEM_NORMALIZED_CPU_KERNEL", "MAX_SYSTEM_NORMALIZED_CPU_NICE", "MAX_SYSTEM_NORMALIZED_CPU_SOFTIRQ", "MAX_SYSTEM_NORMALIZED_CPU_STEAL", "MAX_SYSTEM_NORMALIZED_CPU_USER", "MEMORY_MAPPED", "MEMORY_RESIDENT", "MEMORY_VIRTUAL", "NETWORK_BYTES_IN", "NETWORK_BYTES_OUT", "NETWORK_NUM_REQUESTS", "OP_EXECUTION_TIME_COMMANDS", "OP_EXECUTION_TIME_READS", "OP_EXECUTION_TIME_WRITES", "OPCOUNTER_CMD", "OPCOUNTER_DELETE", "OPCOUNTER_GETMORE", "OPCOUNTER_INSERT", "OPCOUNTER_QUERY", "OPCOUNTER_REPL_CMD", "OPCOUNTER_REPL_DELETE", "OPCOUNTER_REPL_INSERT", "OPCOUNTER_REPL_UPDATE", "OPCOUNTER_UPDATE", "OPERATIONS_SCAN_AND_ORDER", "OPLOG_MASTER_LAG_TIME_DIFF", "OPLOG_MASTER_TIME", "OPLOG_RATE_GB_PER_HOUR", "OPLOG_SLAVE_LAG_MASTER_TIME", "OPLOG_REPLICATION_LAG", "PROCESS_CPU_CHILDREN_KERNEL", "PROCESS_CPU_CHILDREN_USER", "PROCESS_CPU_KERNEL", "PROCESS_CPU_USER", "PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL", "PROCESS_NORMALIZED_CPU_CHILDREN_USER", "PROCESS_NORMALIZED_CPU_KERNEL", "PROCESS_NORMALIZED_CPU_USER", "QUERY_EXECUTOR_SCANNED", "QUERY_EXECUTOR_SCANNED_OBJECTS", "QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED", "QUERY_TARGETING_SCANNED_PER_RETURNED", "RESTARTS_IN_LAST_HOUR", "SWAP_USAGE_FREE", "SWAP_USAGE_USED", "SYSTEM_CPU_GUEST", "SYSTEM_CPU_IOWAIT", "SYSTEM_CPU_IRQ", "SYSTEM_CPU_KERNEL", "SYSTEM_CPU_NICE", "SYSTEM_CPU_SOFTIRQ", "SYSTEM_CPU_STEAL", "SYSTEM_CPU_USER", "SYSTEM_MEMORY_AVAILABLE", "SYSTEM_MEMORY_FREE", "SYSTEM_MEMORY_USED", "SYSTEM_NETWORK_IN", "SYSTEM_NETWORK_OUT", "SYSTEM_NORMALIZED_CPU_GUEST", "SYSTEM_NORMALIZED_CPU_IOWAIT", "SYSTEM_NORMALIZED_CPU_IRQ", "SYSTEM_NORMALIZED_CPU_KERNEL", "SYSTEM_NORMALIZED_CPU_NICE", "SYSTEM_NORMALIZED_CPU_SOFTIRQ", "SYSTEM_NORMALIZED_CPU_STEAL", "SYSTEM_NORMALIZED_CPU_USER", "TICKETS_AVAILABLE_READS", "TICKETS_AVAILABLE_WRITE", "OPERATION_THROTTLING_REJECTED_OPERATIONS" ] + "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_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" ] }, "maxItems" : 10, "minItems" : 1, @@ -16987,7 +17664,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -17188,7 +17865,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -17237,7 +17914,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -17305,7 +17982,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the restore job to return.", @@ -17373,7 +18050,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -17422,7 +18099,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Unique 24-hexadecimal digit string that identifies the desired snapshot.", @@ -17481,7 +18158,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "$ref" : "#/components/parameters/envelope" @@ -17527,7 +18204,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } }, { "description" : "Value that we want to set for the Serverless Auto Indexing toggle.", @@ -17585,20 +18262,20 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { - "204" : { + "202" : { "content" : { "application/vnd.atlas.2023-01-01+json" : { "schema" : { - "$ref" : "#/components/schemas/NoBody" + "$ref" : "#/components/schemas/RequestAccepted" }, "x-xgen-version" : "2023-01-01" } }, - "description" : "This endpoint does not return a response body." + "description" : "Accepted" }, "400" : { "$ref" : "#/components/responses/badRequest" @@ -17637,7 +18314,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "responses" : { @@ -17689,7 +18366,7 @@ "type" : "string", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" } } ], "requestBody" : { @@ -17734,7 +18411,7 @@ }, "/api/atlas/v2/groups/{groupId}/serviceAccounts" : { "get" : { - "description" : "Returns list of Service Accounts for a project with service account details.", + "description" : "Returns all Service Accounts for the specified Project. Available as a preview feature.", "operationId" : "listProjectServiceAccounts", "parameters" : [ { "$ref" : "#/components/parameters/groupId" @@ -17750,11 +18427,11 @@ "responses" : { "200" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { "$ref" : "#/components/schemas/PaginatedGroupServiceAccounts" }, - "x-xgen-version" : "2023-10-01" + "x-xgen-version" : "2024-08-05" } }, "description" : "OK" @@ -17772,11 +18449,11 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Return All project Service Accounts", - "tags" : [ "Groups" ] + "summary" : "List All Project Service Accounts", + "tags" : [ "Service Accounts" ] }, "post" : { - "description" : "Creates and assigns the specified Service Account to the specified Project.", + "description" : "Creates one Service Account for the specified Project. The Service Account will automatically be added as an Organization Member to the Organization that the specified Project is a part of. Available as a preview feature.", "operationId" : "createProjectServiceAccount", "parameters" : [ { "$ref" : "#/components/parameters/groupId" @@ -17787,24 +18464,24 @@ } ], "requestBody" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { "$ref" : "#/components/schemas/GroupServiceAccountRequest" }, - "x-xgen-version" : "2023-10-01" + "x-xgen-version" : "2024-08-05" } }, - "description" : "Details to create service account and add to the specified project.", + "description" : "Details of the new Service Account.", "required" : true }, "responses" : { "201" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { "$ref" : "#/components/schemas/GroupServiceAccount" }, - "x-xgen-version" : "2023-10-01" + "x-xgen-version" : "2024-08-05" } }, "description" : "Created" @@ -17822,21 +18499,23 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Create and Assign one Service Account to one project", - "tags" : [ "Groups" ] + "summary" : "Create and Assign one Service Account to one Project", + "tags" : [ "Service Accounts" ] } }, - "/api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}" : { + "/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}" : { "delete" : { - "description" : "Removes one Service Account from the specified project.", + "description" : "Removes the specified Service Account from the specified project. The Service Account will still be a part of the Organization it was created in, and the credentials will remain active until expired or manually revoked. Available as a preview feature.", "operationId" : "deleteProjectServiceAccount", "parameters" : [ { - "description" : "Id of the service account.", + "description" : "The Client ID of the Service Account.", "in" : "path", - "name" : "serviceAccountId", + "name" : "clientId", "required" : true, "schema" : { - "type" : "string" + "type" : "string", + "example" : "mdb_sa_id_667066535bc75b03c37b3038", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" } }, { "$ref" : "#/components/parameters/groupId" @@ -17848,15 +18527,15 @@ "responses" : { "204" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { "$ref" : "#/components/schemas/NoBody" }, - "x-xgen-version" : "2023-10-01" + "x-xgen-version" : "2024-08-05" } }, "description" : "This endpoint does not return a response body.", - "x-xgen-version" : "2023-10-01" + "x-xgen-version" : "2024-08-05" }, "401" : { "$ref" : "#/components/responses/unauthorized" @@ -17871,21 +18550,23 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Unassign One Service Account from One Project.", - "tags" : [ "Groups" ] + "summary" : "Unassign One Service Account from One Project", + "tags" : [ "Service Accounts" ] }, "get" : { - "description" : "Get project Service Account Details.", + "description" : "Returns one Service Account in the specified Project. Available as a preview feature.", "operationId" : "getProjectServiceAccount", "parameters" : [ { "$ref" : "#/components/parameters/groupId" }, { - "description" : "Id of the service account.", + "description" : "The Client ID of the Service Account.", "in" : "path", - "name" : "serviceAccountId", + "name" : "clientId", "required" : true, "schema" : { - "type" : "string" + "type" : "string", + "example" : "mdb_sa_id_667066535bc75b03c37b3038", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" } }, { "$ref" : "#/components/parameters/envelope" @@ -17895,11 +18576,11 @@ "responses" : { "200" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { "$ref" : "#/components/schemas/GroupServiceAccount" }, - "x-xgen-version" : "2023-10-01" + "x-xgen-version" : "2024-08-05" } }, "description" : "OK" @@ -17917,19 +18598,21 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Service Account Fetching", - "tags" : [ "Groups" ] + "summary" : "Get one Project Service Account", + "tags" : [ "Service Accounts" ] }, "patch" : { - "description" : "Update Service Account in Project.", + "description" : "Updates one Service Account in the specified Project. Available as a preview feature.", "operationId" : "updateProjectServiceAccount", "parameters" : [ { - "description" : "Id of the service account.", + "description" : "The Client ID of the Service Account.", "in" : "path", - "name" : "serviceAccountId", + "name" : "clientId", "required" : true, "schema" : { - "type" : "string" + "type" : "string", + "example" : "mdb_sa_id_667066535bc75b03c37b3038", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" } }, { "$ref" : "#/components/parameters/groupId" @@ -17940,23 +18623,23 @@ } ], "requestBody" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { "$ref" : "#/components/schemas/GroupServiceAccountUpdateRequest" } } }, - "description" : "Details to update service account in the specified Project.", + "description" : "The new details for the Service Account.", "required" : true }, "responses" : { "200" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { "$ref" : "#/components/schemas/GroupServiceAccount" }, - "x-xgen-version" : "2023-10-01" + "x-xgen-version" : "2024-08-05" } }, "description" : "OK" @@ -17977,19 +18660,208 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Service Account Update in Project", - "tags" : [ "Groups" ] + "summary" : "Update one Project Service Account", + "tags" : [ "Service Accounts" ] + } + }, + "/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList" : { + "get" : { + "description" : "Returns all access list entries that you configured for the specified Service Account for the project. Available as a preview feature.", + "operationId" : "listProjectServiceAccountAccessList", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "The Client ID of the Service Account.", + "in" : "path", + "name" : "clientId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mdb_sa_id_667066535bc75b03c37b3038", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedServiceAccountIPAccessEntryView" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Access List entries for one Project Service Account", + "tags" : [ "Service Accounts" ] }, "post" : { - "description" : "Assigns the specified organization Service Account to the specified project.", + "description" : "Add Access List Entries for the specified Service Account for the project. Resources require all API requests to originate from IP addresses on the API access list. Available as a preview feature.", + "operationId" : "createProjectServiceAccountAccessList", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/includeCount" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "The Client ID of the Service Account.", + "in" : "path", + "name" : "clientId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mdb_sa_id_667066535bc75b03c37b3038", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ServiceAccountIPAccessListEntry" + } + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "A list of access list entries to add to the access list of the specified Service Account for the project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedServiceAccountIPAccessEntryView" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add Access List entries for one Project Service Account", + "tags" : [ "Service Accounts" ] + } + }, + "/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList/{ipAddress}" : { + "delete" : { + "description" : "Removes the specified access list entry from the specified Service Account for the project. You can't remove the requesting IP address from the access list. Available as a preview feature.", + "operationId" : "deleteProjectServiceAccountAccessListEntry", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "The Client ID of the Service Account.", + "in" : "path", + "name" : "clientId", + "required" : true, + "schema" : { + "type" : "string", + "example" : "mdb_sa_id_667066535bc75b03c37b3038", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + } + }, { + "description" : "One IP address or multiple IP addresses represented as one CIDR block. When specifying a CIDR block with a subnet mask, such as 192.0.2.0/24, use the URL-encoded value %2F for the forward slash /.", + "in" : "path", + "name" : "ipAddress", + "required" : true, + "schema" : { + "type" : "string", + "example" : "192.0.2.0%2F24", + "pattern" : "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})?$" + } + } ], + "responses" : { + "204" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Access List entry from one Project Service Account", + "tags" : [ "Service Accounts" ] + } + }, + "/api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}:invite" : { + "post" : { + "description" : "Assigns the specified Service Account to the specified Project. Available as a preview feature.", "operationId" : "addProjectServiceAccount", "parameters" : [ { - "description" : "Id of the service account.", + "description" : "The Client ID of the Service Account.", "in" : "path", - "name" : "serviceAccountId", + "name" : "clientId", "required" : true, "schema" : { - "type" : "string" + "type" : "string", + "example" : "mdb_sa_id_667066535bc75b03c37b3038", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" } }, { "$ref" : "#/components/parameters/groupId" @@ -18000,31 +18872,30 @@ } ], "requestBody" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/GroupServiceAccountRoleAssignment" } }, - "x-xgen-version" : "2023-10-01" + "x-xgen-version" : "2024-08-05" } }, - "description" : "Service Account Roles to be assigned to the specified project.", + "description" : "The Project permissions for the Service Account in the specified Project.", "required" : true }, "responses" : { - "204" : { + "200" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { - "$ref" : "#/components/schemas/NoBody" + "$ref" : "#/components/schemas/GroupServiceAccount" }, - "x-xgen-version" : "2023-10-01" + "x-xgen-version" : "2024-08-05" } }, - "description" : "This endpoint does not return a response body.", - "x-xgen-version" : "2023-10-01" + "description" : "OK" }, "401" : { "$ref" : "#/components/responses/unauthorized" @@ -18040,7 +18911,7 @@ "DigestAuth" : [ ] } ], "summary" : "Assign One Service Account to One Project", - "tags" : [ "Groups" ] + "tags" : [ "Service Accounts" ] } }, "/api/atlas/v2/groups/{groupId}/settings" : { @@ -18234,10 +19105,112 @@ } } }, - "/api/atlas/v2/groups/{groupId}/streams/{tenantName}" : { + "/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections" : { + "get" : { + "description" : "Returns all Private Link connections for the specified project.To use this resource, the requesting API Key must have the Project Data Access roles, Project Owner role or Project Stream Processing Owner role.", + "operationId" : "listPrivateLinkConnections", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiStreamsPrivateLinkView" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All Private Link", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2024-10-02" : "The MongoDB Atlas Streams Processing Private Link API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "post" : { + "description" : "Creates one Private Link in the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Stream Processing Owner role.", + "operationId" : "createPrivateLinkConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsPrivateLinkConnection" + } + } + }, + "description" : "Details to create one Private Link connection for a project. project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsPrivateLinkConnection" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "409" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Private Link connection", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2024-10-02" : "The MongoDB Atlas Streams Processing Private Link API is now exposed as part of private preview, but is subject to change until GA." + } + } + }, + "/api/atlas/v2/groups/{groupId}/streams/privateLinkConnections/{connectionId}" : { "delete" : { - "description" : "Delete one stream instance in the specified project. To use this resource, the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role.", - "operationId" : "deleteStreamInstance", + "description" : "Deletes one Private Link in the specified project. To use this resource, the requesting API Key must have the Project Owner or Project Stream Processing Owner role.", + "operationId" : "deletePrivateLinkConnection", "parameters" : [ { "$ref" : "#/components/parameters/envelope" }, { @@ -18245,9 +19218,306 @@ }, { "$ref" : "#/components/parameters/groupId" }, { - "description" : "Human-readable label that identifies the stream instance to delete.", + "description" : "Unique ID that identifies the Private Link connection.", "in" : "path", - "name" : "tenantName", + "name" : "connectionId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Accepted" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete One Private Link connection", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2024-10-02" : "The MongoDB Atlas Streams Processing Private Link API is now exposed as part of private preview, but is subject to change until GA." + } + }, + "get" : { + "description" : "Returns the details of one Private Link connection within the project. To use this resource, the requesting API Key must have the Project Read Only role.", + "operationId" : "getPrivateLinkConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Unique ID that identifies the Private Link connection.", + "in" : "path", + "name" : "connectionId", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsPrivateLinkConnection" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One PrivateLink Connection", + "tags" : [ "Streams" ], + "x-xgen-changelog" : { + "2024-10-02" : "The MongoDB Atlas Streams Processing Private Link API is now exposed as part of private preview, but is subject to change until GA." + } + } + }, + "/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections" : { + "get" : { + "description" : "Returns a list of incoming VPC Peering Connections.", + "operationId" : "getVPCPeeringConnections", + "parameters" : [ { + "$ref" : "#/components/parameters/groupId" + }, { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "OK" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return All VPC Peering Connections.", + "tags" : [ "Streams" ] + } + }, + "/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}" : { + "delete" : { + "description" : "Deletes an incoming VPC Peering connection.", + "operationId" : "deleteVPCPeeringConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "The VPC Peering Connection id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Accepted" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Deletes an incoming VPC Peering connection.", + "tags" : [ "Streams" ] + } + }, + "/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:accept" : { + "post" : { + "description" : "Requests the acceptance of an incoming VPC Peering connection.", + "operationId" : "acceptVPCPeeringConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "The VPC Peering Connection id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/VPCPeeringActionChallenge" + } + } + }, + "description" : "Challenge values for VPC Peering requester account ID, and requester VPC ID.", + "required" : true + }, + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Accepted" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Requests the acceptance of an incoming VPC Peering connection.", + "tags" : [ "Streams" ] + } + }, + "/api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:reject" : { + "post" : { + "description" : "Requests the rejection of an incoming VPC Peering connection.", + "operationId" : "rejectVPCPeeringConnection", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "The VPC Peering Connection id.", + "in" : "path", + "name" : "id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "202" : { + "content" : { + "application/vnd.atlas.2023-02-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2023-02-01" + } + }, + "description" : "Accepted" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Requests the rejection of an incoming VPC Peering connection.", + "tags" : [ "Streams" ] + } + }, + "/api/atlas/v2/groups/{groupId}/streams/{tenantName}" : { + "delete" : { + "description" : "Delete one stream instance in the specified project. To use this resource, the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role.", + "operationId" : "deleteStreamInstance", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + }, { + "description" : "Human-readable label that identifies the stream instance to delete.", + "in" : "path", + "name" : "tenantName", "required" : true, "schema" : { "type" : "string" @@ -19147,6 +20417,57 @@ "tags" : [ "Streams" ] } }, + "/api/atlas/v2/groups/{groupId}/streams:withSampleConnections" : { + "post" : { + "description" : "Creates one stream instance in the specified project with sample connections. To use this resource the requesting API Key must have the Project Data Access Admin role, Project Owner role or Project Stream Processing Owner role.", + "operationId" : "createStreamInstanceWithSampleConnections", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/groupId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/TenantWithSampleConnections" + } + } + }, + "description" : "Details to create one streams instance in the specified project.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/StreamsTenant" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One Stream Instance With Sample Connections", + "tags" : [ "Streams" ] + } + }, "/api/atlas/v2/groups/{groupId}/teams" : { "get" : { "description" : "Returns all teams to which the authenticated user has access in the project specified using its unique 24-hexadecimal digit identifier. All members of the team share the same project access. To use this resource, the requesting API Key must have the Project Read Only role.", @@ -19819,267 +21140,6 @@ "tags" : [ "Projects" ] } }, - "/api/atlas/v2/groups/{groupId}/uss" : { - "get" : { - "description" : "Returns details for all USS instances in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", - "operationId" : "listUSSInstances", - "parameters" : [ { - "$ref" : "#/components/parameters/envelope" - }, { - "$ref" : "#/components/parameters/groupId" - }, { - "$ref" : "#/components/parameters/includeCount" - }, { - "$ref" : "#/components/parameters/itemsPerPage" - }, { - "$ref" : "#/components/parameters/pageNum" - }, { - "$ref" : "#/components/parameters/pretty" - } ], - "responses" : { - "200" : { - "content" : { - "application/vnd.atlas.2025-01-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/PaginatedUSSInstance20250101" - }, - "x-xgen-version" : "2025-01-01" - } - }, - "description" : "OK" - }, - "409" : { - "$ref" : "#/components/responses/conflict" - }, - "500" : { - "$ref" : "#/components/responses/internalServerError" - } - }, - "security" : [ { - "DigestAuth" : [ ] - } ], - "summary" : "Return All USS Instances from One Project", - "tags" : [ "USS Instances" ] - }, - "post" : { - "description" : "Creates one USS instance in the specified project. To use this resource, the requesting API Key must have the Project Owner role.", - "operationId" : "createUSSInstance", - "parameters" : [ { - "$ref" : "#/components/parameters/envelope" - }, { - "$ref" : "#/components/parameters/groupId" - }, { - "$ref" : "#/components/parameters/pretty" - } ], - "requestBody" : { - "content" : { - "application/vnd.atlas.2025-01-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/USSInstanceDescriptionCreate20250101" - } - } - }, - "description" : "Create One USS Instance in One Project.", - "required" : true - }, - "responses" : { - "201" : { - "content" : { - "application/vnd.atlas.2025-01-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/USSInstanceDescription20250101" - }, - "x-xgen-version" : "2025-01-01" - } - }, - "description" : "Created" - }, - "400" : { - "$ref" : "#/components/responses/badRequest" - }, - "402" : { - "$ref" : "#/components/responses/paymentRequired" - }, - "409" : { - "$ref" : "#/components/responses/conflict" - }, - "500" : { - "$ref" : "#/components/responses/internalServerError" - } - }, - "security" : [ { - "DigestAuth" : [ ] - } ], - "summary" : "Create One USS Instance in One Project", - "tags" : [ "USS Instances" ] - } - }, - "/api/atlas/v2/groups/{groupId}/uss/{name}" : { - "delete" : { - "description" : "Removes one USS instance from the specified project. The USS instance must have termination protection disabled in order to be deleted. To use this resource, the requesting API Key must have the Project Owner role.", - "operationId" : "deleteUSSInstance", - "parameters" : [ { - "$ref" : "#/components/parameters/envelope" - }, { - "$ref" : "#/components/parameters/pretty" - }, { - "$ref" : "#/components/parameters/groupId" - }, { - "description" : "Human-readable label that identifies the USS instance.", - "in" : "path", - "name" : "name", - "required" : true, - "schema" : { - "type" : "string", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - } - } ], - "responses" : { - "204" : { - "content" : { - "application/vnd.atlas.2025-01-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/NoBody" - }, - "x-xgen-version" : "2025-01-01" - } - }, - "description" : "This endpoint does not return a response body." - }, - "400" : { - "$ref" : "#/components/responses/badRequest" - }, - "404" : { - "$ref" : "#/components/responses/notFound" - }, - "409" : { - "$ref" : "#/components/responses/conflict" - }, - "500" : { - "$ref" : "#/components/responses/internalServerError" - } - }, - "security" : [ { - "DigestAuth" : [ ] - } ], - "summary" : "Remove One USS Instance from One Project", - "tags" : [ "USS Instances" ] - }, - "get" : { - "description" : "Returns details for one USS instance in the specified project. To use this resource, the requesting API Key must have the Project Read Only role.", - "operationId" : "getUSSInstance", - "parameters" : [ { - "$ref" : "#/components/parameters/groupId" - }, { - "$ref" : "#/components/parameters/envelope" - }, { - "$ref" : "#/components/parameters/pretty" - }, { - "description" : "Human-readable label that identifies the USS instance.", - "in" : "path", - "name" : "name", - "required" : true, - "schema" : { - "type" : "string", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - } - } ], - "responses" : { - "200" : { - "content" : { - "application/vnd.atlas.2025-01-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/USSInstanceDescription20250101" - }, - "x-xgen-version" : "2025-01-01" - } - }, - "description" : "OK" - }, - "400" : { - "$ref" : "#/components/responses/badRequest" - }, - "404" : { - "$ref" : "#/components/responses/notFound" - }, - "409" : { - "$ref" : "#/components/responses/conflict" - }, - "500" : { - "$ref" : "#/components/responses/internalServerError" - } - }, - "security" : [ { - "DigestAuth" : [ ] - } ], - "summary" : "Return One USS Instance from One Project", - "tags" : [ "USS Instances" ] - }, - "patch" : { - "description" : "Updates one USS instance in the specified project. To use this resource, the requesting API Key must have the Project Owner role.", - "operationId" : "updateUSSInstance", - "parameters" : [ { - "$ref" : "#/components/parameters/envelope" - }, { - "$ref" : "#/components/parameters/groupId" - }, { - "$ref" : "#/components/parameters/pretty" - }, { - "description" : "Human-readable label that identifies the USS instance.", - "in" : "path", - "name" : "name", - "required" : true, - "schema" : { - "type" : "string", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - } - } ], - "requestBody" : { - "content" : { - "application/vnd.atlas.2025-01-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/USSInstanceDescription20250101" - } - } - }, - "description" : "Update One USS Instance in One Project.", - "required" : true - }, - "responses" : { - "200" : { - "content" : { - "application/vnd.atlas.2025-01-01+json" : { - "schema" : { - "$ref" : "#/components/schemas/USSInstanceDescription20250101" - }, - "x-xgen-version" : "2025-01-01" - } - }, - "description" : "OK" - }, - "400" : { - "$ref" : "#/components/responses/badRequest" - }, - "402" : { - "$ref" : "#/components/responses/paymentRequired" - }, - "409" : { - "$ref" : "#/components/responses/conflict" - } - }, - "security" : [ { - "DigestAuth" : [ ] - } ], - "summary" : "Update One USS Instance in One Project", - "tags" : [ "USS Instances" ] - } - }, "/api/atlas/v2/groups/{groupId}:migrate" : { "post" : { "description" : "Migrates a project from its current organization to another organization. All project users and their roles will be copied to the same project in the destination organization. You must include an organization API key with the Organization Owner role for the destination organization to verify access to the destination organization when you authenticate with Programmatic API Keys. Otherwise, the requesting user must have the Organization Owner role in both organizations. To use this resource, the requesting API Key must have the Organization Owner role.", @@ -21828,7 +22888,7 @@ "tags" : [ "Invoices" ] } }, - "/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/lineItems/:search" : { + "/api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/lineItems:search" : { "get" : { "description" : "Query the lineItems of the specified invoice and return the result JSON. A unique 24-hexadecimal digit string identifies the invoice.", "operationId" : "queryLineItemsFromSingleInvoice", @@ -21854,7 +22914,7 @@ } ], "requestBody" : { "content" : { - "application/vnd.atlas.2025-01-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { "$ref" : "#/components/schemas/ApiPublicUsageDetailsQueryRequest" } @@ -21866,11 +22926,11 @@ "responses" : { "200" : { "content" : { - "application/vnd.atlas.2025-01-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { "$ref" : "#/components/schemas/PaginatedPublicApiUsageDetailsLineItemView" }, - "x-xgen-version" : "2025-01-01" + "x-xgen-version" : "2024-08-05" } }, "description" : "OK" @@ -22022,9 +23082,440 @@ "tags" : [ "Cloud Migration Service" ] } }, + "/api/atlas/v2/orgs/{orgId}/nonCompliantResources" : { + "get" : { + "description" : "Return all non-compliant resources for an org.", + "externalDocs" : { + "description" : "Atlas Resource Policies", + "url" : "https://docs.atlas.mongodb.com" + }, + "operationId" : "getResourcesNonCompliant", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasNonCompliantResourceView" + } + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return all non-compliant resources", + "tags" : [ "Resource Policies" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/resourcePolicies" : { + "get" : { + "description" : "Return all Atlas Resource Policies for the org.", + "externalDocs" : { + "description" : "Atlas Resource Policies", + "url" : "https://docs.atlas.mongodb.com" + }, + "operationId" : "getAtlasResourcePolicies", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasResourcePolicyView" + } + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return all Atlas Resource Policies", + "tags" : [ "Resource Policies" ] + }, + "post" : { + "description" : "Create one Atlas Resource Policy for an org.", + "externalDocs" : { + "description" : "Atlas Resource Policies", + "url" : "https://docs.atlas.mongodb.com" + }, + "operationId" : "createAtlasResourcePolicy", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasResourcePolicyCreateView" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "Atlas Resource Policy to create.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasResourcePolicyView" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "Created" + }, + "400" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasInvalidResourcePolicyCreateErrorView" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "Bad request." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create one Atlas Resource Policy", + "tags" : [ "Resource Policies" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/resourcePolicies/{resourcePolicyId}" : { + "delete" : { + "description" : "Delete one Atlas Resource Policy for an org.", + "externalDocs" : { + "description" : "Atlas Resource Policies", + "url" : "https://docs.atlas.mongodb.com" + }, + "operationId" : "deleteAtlasResourcePolicy", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies an atlas resource policy.", + "in" : "path", + "name" : "resourcePolicyId", + "required" : true, + "schema" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the atlas resource policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "This endpoint does not return a response body." + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Delete one Atlas Resource Policy", + "tags" : [ "Resource Policies" ] + }, + "get" : { + "description" : "Return one Atlas Resource Policy for an org.", + "externalDocs" : { + "description" : "Atlas Resource Policies", + "url" : "https://docs.atlas.mongodb.com" + }, + "operationId" : "getAtlasResourcePolicy", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies an atlas resource policy.", + "in" : "path", + "name" : "resourcePolicyId", + "required" : true, + "schema" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the atlas resource policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasResourcePolicyView" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return one Atlas Resource Policy", + "tags" : [ "Resource Policies" ] + }, + "patch" : { + "description" : "Update one Atlas Resource Policy for an org.", + "externalDocs" : { + "description" : "Atlas Resource Policies", + "url" : "https://docs.atlas.mongodb.com" + }, + "operationId" : "updateAtlasResourcePolicy", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies an atlas resource policy.", + "in" : "path", + "name" : "resourcePolicyId", + "required" : true, + "schema" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the atlas resource policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasResourcePolicyEditView" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "Atlas Resource Policy to update.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasResourcePolicyView" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "Ok" + }, + "400" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasInvalidResourcePolicyCreateErrorView" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "Bad request." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update one Atlas Resource Policy", + "tags" : [ "Resource Policies" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/resourcePolicies:validate" : { + "post" : { + "description" : "Validate one Atlas Resource Policy for an org.", + "externalDocs" : { + "description" : "Atlas Resource Policies", + "url" : "https://docs.atlas.mongodb.com" + }, + "operationId" : "validateAtlasResourcePolicy", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "$ref" : "#/components/parameters/orgId" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasResourcePolicyCreateView" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "Atlas Resource Policy to create.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasResourcePolicyView" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "Ok" + }, + "400" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/ApiAtlasInvalidResourcePolicyCreateErrorView" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "Bad request." + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Validate one Atlas Resource Policy", + "tags" : [ "Resource Policies" ] + } + }, "/api/atlas/v2/orgs/{orgId}/serviceAccounts" : { "get" : { - "description" : "Returns list of Service Accounts with service account details.", + "description" : "Returns all Service Accounts for the specified Organization. Available as a preview feature.", "operationId" : "listServiceAccounts", "parameters" : [ { "$ref" : "#/components/parameters/orgId" @@ -22040,11 +23531,11 @@ "responses" : { "200" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { "$ref" : "#/components/schemas/PaginatedOrgServiceAccounts" }, - "x-xgen-version" : "2023-10-01" + "x-xgen-version" : "2024-08-05" } }, "description" : "OK" @@ -22062,11 +23553,11 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Return All Service Accounts", - "tags" : [ "Organizations" ] + "summary" : "List All Organization Service Accounts", + "tags" : [ "Service Accounts" ] }, "post" : { - "description" : "Create Service Account containing client id and client secrets.", + "description" : "Creates one Service Account for the specified Organization. Available as a preview feature.", "operationId" : "createServiceAccount", "parameters" : [ { "$ref" : "#/components/parameters/orgId" @@ -22077,23 +23568,23 @@ } ], "requestBody" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { "$ref" : "#/components/schemas/OrgServiceAccountRequest" } } }, - "description" : "Details to create service account in the specified organization.", + "description" : "Details of the new Service Account.", "required" : true }, "responses" : { "201" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { "$ref" : "#/components/schemas/OrgServiceAccount" }, - "x-xgen-version" : "2023-10-01" + "x-xgen-version" : "2024-08-05" } }, "description" : "Created" @@ -22111,21 +23602,23 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Service Account Creation", - "tags" : [ "Organizations" ] + "summary" : "Create one Organization Service Account", + "tags" : [ "Service Accounts" ] } }, - "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}" : { + "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}" : { "delete" : { - "description" : "Delete Service Account.", + "description" : "Deletes the specified Service Account. Available as a preview feature.", "operationId" : "deleteServiceAccount", "parameters" : [ { - "description" : "Id of the service account.", + "description" : "The Client ID of the Service Account.", "in" : "path", - "name" : "serviceAccountId", + "name" : "clientId", "required" : true, "schema" : { - "type" : "string" + "type" : "string", + "example" : "mdb_sa_id_667066535bc75b03c37b3038", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" } }, { "$ref" : "#/components/parameters/orgId" @@ -22137,8 +23630,8 @@ "responses" : { "204" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "x-xgen-version" : "2023-10-01" + "application/vnd.atlas.2024-08-05+json" : { + "x-xgen-version" : "2024-08-05" } }, "description" : "This endpoint does not return a response body." @@ -22156,21 +23649,23 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Service Account Deletion.", - "tags" : [ "Organizations" ] + "summary" : "Delete one Organization Service Account", + "tags" : [ "Service Accounts" ] }, "get" : { - "description" : "Get Service Account Details.", + "description" : "Returns the specified Service Account. Available as a preview feature.", "operationId" : "getServiceAccount", "parameters" : [ { "$ref" : "#/components/parameters/orgId" }, { - "description" : "Id of the service account.", + "description" : "The Client ID of the Service Account.", "in" : "path", - "name" : "serviceAccountId", + "name" : "clientId", "required" : true, "schema" : { - "type" : "string" + "type" : "string", + "example" : "mdb_sa_id_667066535bc75b03c37b3038", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" } }, { "$ref" : "#/components/parameters/envelope" @@ -22180,11 +23675,11 @@ "responses" : { "200" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { "$ref" : "#/components/schemas/OrgServiceAccount" }, - "x-xgen-version" : "2023-10-01" + "x-xgen-version" : "2024-08-05" } }, "description" : "OK" @@ -22202,19 +23697,21 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Service Account Fetching", - "tags" : [ "Organizations" ] + "summary" : "Get one Organization Service Account", + "tags" : [ "Service Accounts" ] }, "patch" : { - "description" : "Update Service Account.", + "description" : "Updates the specified Service Account in the specified Organization. Available as a preview feature.", "operationId" : "updateServiceAccount", "parameters" : [ { - "description" : "Id of the service account.", + "description" : "The Client ID of the Service Account.", "in" : "path", - "name" : "serviceAccountId", + "name" : "clientId", "required" : true, "schema" : { - "type" : "string" + "type" : "string", + "example" : "mdb_sa_id_667066535bc75b03c37b3038", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" } }, { "$ref" : "#/components/parameters/orgId" @@ -22225,23 +23722,23 @@ } ], "requestBody" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { "$ref" : "#/components/schemas/OrgServiceAccountUpdateRequest" } } }, - "description" : "Details to update service account in the specified organization.", + "description" : "The new details for the Service Account.", "required" : true }, "responses" : { "200" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { "$ref" : "#/components/schemas/OrgServiceAccount" }, - "x-xgen-version" : "2023-10-01" + "x-xgen-version" : "2024-08-05" } }, "description" : "OK" @@ -22262,23 +23759,25 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Service Account Update", - "tags" : [ "Organizations" ] + "summary" : "Update one Organization Service Account", + "tags" : [ "Service Accounts" ] } }, - "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/groups" : { + "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/groups" : { "get" : { - "description" : "Returns list of Service Account projects.", + "description" : "Returns a list of all projects the specified Service Account is a part of. Available as a preview feature.", "operationId" : "listServiceAccountProjects", "parameters" : [ { "$ref" : "#/components/parameters/orgId" }, { - "description" : "Id of the service account.", + "description" : "The Client ID of the Service Account.", "in" : "path", - "name" : "serviceAccountId", + "name" : "clientId", "required" : true, "schema" : { - "type" : "string" + "type" : "string", + "example" : "mdb_sa_id_667066535bc75b03c37b3038", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" } }, { "$ref" : "#/components/parameters/itemsPerPage" @@ -22292,11 +23791,11 @@ "responses" : { "200" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { "$ref" : "#/components/schemas/PaginatedServiceAccountGroup" }, - "x-xgen-version" : "2023-10-01" + "x-xgen-version" : "2024-08-05" } }, "description" : "OK" @@ -22314,23 +23813,25 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Return All Service Account projects", - "tags" : [ "Organizations" ] + "summary" : "Return All Service Account Project assignments", + "tags" : [ "Service Accounts" ] } }, - "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets" : { + "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/secrets" : { "post" : { - "description" : "Create Service Account secret.", + "description" : "Create a secret for the specified Service Account. Available as a preview feature.", "operationId" : "createServiceAccountSecret", "parameters" : [ { "$ref" : "#/components/parameters/orgId" }, { - "description" : "Id of the service account.", + "description" : "The Client ID of the Service Account.", "in" : "path", - "name" : "serviceAccountId", + "name" : "clientId", "required" : true, "schema" : { - "type" : "string" + "type" : "string", + "example" : "mdb_sa_id_667066535bc75b03c37b3038", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" } }, { "$ref" : "#/components/parameters/envelope" @@ -22339,23 +23840,23 @@ } ], "requestBody" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { "$ref" : "#/components/schemas/ServiceAccountSecretRequest" } } }, - "description" : "Details to create secret in the specified service account.", + "description" : "Details for the new secret.", "required" : true }, "responses" : { "201" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { + "application/vnd.atlas.2024-08-05+json" : { "schema" : { "$ref" : "#/components/schemas/ServiceAccountSecret" }, - "x-xgen-version" : "2023-10-01" + "x-xgen-version" : "2024-08-05" } }, "description" : "Created" @@ -22373,24 +23874,26 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Service Account Secret Creation", - "tags" : [ "Organizations" ] + "summary" : "Create one Organization Service Account Secret", + "tags" : [ "Service Accounts" ] } }, - "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets/{secretId}" : { + "/api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/secrets/{secretId}" : { "delete" : { - "description" : "Delete Service Account Secret.", + "description" : "Deletes the specified Service Account secret. Available as a preview feature.", "operationId" : "deleteServiceAccountSecret", "parameters" : [ { - "description" : "Id of the service account.", + "description" : "The Client ID of the Service Account.", "in" : "path", - "name" : "serviceAccountId", + "name" : "clientId", "required" : true, "schema" : { - "type" : "string" + "type" : "string", + "example" : "mdb_sa_id_667066535bc75b03c37b3038", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" } }, { - "description" : "Id of the secret.", + "description" : "Unique 24-hexadecimal digit string that identifies the secret.", "in" : "path", "name" : "secretId", "required" : true, @@ -22407,8 +23910,8 @@ "responses" : { "204" : { "content" : { - "application/vnd.atlas.2023-10-01+json" : { - "x-xgen-version" : "2023-10-01" + "application/vnd.atlas.2024-08-05+json" : { + "x-xgen-version" : "2024-08-05" } }, "description" : "This endpoint does not return a response body." @@ -22426,8 +23929,8 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Service Account Secret Deletion.", - "tags" : [ "Organizations" ] + "summary" : "Delete a Organization Service Account Secret", + "tags" : [ "Service Accounts" ] } }, "/api/atlas/v2/orgs/{orgId}/settings" : { @@ -22505,6 +24008,9 @@ }, "description" : "OK" }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, "401" : { "$ref" : "#/components/responses/unauthorized" }, @@ -23127,6 +24633,64 @@ } ], "summary" : "Return All MongoDB Cloud Users in One Organization", "tags" : [ "Organizations" ] + }, + "post" : { + "description" : "Invites one new or existing MongoDB Cloud user to join the organization. The invitation to join the organization will be sent to the username provided and must be accepted within 30 days. To use this resource, the requesting API Key must have the Organization Owner role.\n\n**Note**: If the user does not have an existing MongoDB Cloud account, they will be prompted to finish setting up an account upon accepting the invitation. If the user already has an account, they will still receive an invitation to access the organization.", + "operationId" : "createOrganizationUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrgUserRequest" + } + } + }, + "description" : "Represents the MongoDB Cloud user to be created within the organization.", + "required" : true + }, + "responses" : { + "201" : { + "content" : { + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrgUserResponse" + }, + "x-xgen-version" : "2025-01-01" + } + }, + "description" : "Created" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "409" : { + "$ref" : "#/components/responses/conflict" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Create One MongoDB Cloud User in One Organization", + "tags" : [ "MongoDB Cloud Users" ] } }, "/api/atlas/v2/orgs/{orgId}/users/{userId}" : { @@ -23137,6 +24701,8 @@ "$ref" : "#/components/parameters/envelope" }, { "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" }, { "description" : "Unique 24-hexadecimal digit string that identifies the user to be deleted.", "in" : "path", @@ -23156,7 +24722,14 @@ "schema" : { "$ref" : "#/components/schemas/NoBody" }, + "x-sunset" : "2026-01-01", "x-xgen-version" : "2023-01-01" + }, + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/NoBody" + }, + "x-xgen-version" : "2025-01-01" } }, "description" : "This endpoint does not return a response body." @@ -23180,8 +24753,129 @@ "security" : [ { "DigestAuth" : [ ] } ], - "summary" : "Remove One MongoDB Cloud User from One Organization", + "summary" : "Remove One MongoDB Cloud User From One Organization", "tags" : [ "Organizations" ] + }, + "get" : { + "description" : "Returns information about the specified MongoDB Cloud user within the context of the specified organization. To use this resource, the requesting API Key must have the Organization Read Only role.\n\n**Note**: This resource can only be used to fetch information about MongoDB Cloud human users. To return information about an API Key, use the [Return One Organization API Key](#tag/Programmatic-API-Keys/operation/getApiKey) endpoint.\n\n**Note**: This resource does not return information about pending users invited via the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint.", + "operationId" : "getOrganizationUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the pending or active user in the organization. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Organization resource and filter by username.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrgUserResponse" + }, + "x-xgen-version" : "2025-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Return One MongoDB Cloud User in One Organization", + "tags" : [ "MongoDB Cloud Users" ] + }, + "patch" : { + "description" : "Updates one MongoDB Cloud user in the specified organization. You can update an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting API Key must have the Organization Owner role.\n\n**Note**: Only include the fields you wish to update in the request body. Supplying a field with an empty value will reset that field on the user.\n\n**Note**: This resource cannot be used to update pending users invited via the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint.", + "operationId" : "updateOrganizationUser", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the pending or active user in the organization. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Organization resource and filter by username.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + } ], + "requestBody" : { + "content" : { + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrgUserUpdateRequest" + } + } + }, + "description" : "Represents the roles and teams to assign the MongoDB Cloud user.", + "required" : true + }, + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrgUserResponse" + }, + "x-xgen-version" : "2025-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Update One MongoDB Cloud User in One Organization", + "tags" : [ "MongoDB Cloud Users" ] } }, "/api/atlas/v2/orgs/{orgId}/users/{userId}/roles" : { @@ -23249,6 +24943,138 @@ "tags" : [ "Organizations" ] } }, + "/api/atlas/v2/orgs/{orgId}/users/{userId}:addRole" : { + "post" : { + "description" : "Adds one organization level role to the MongoDB Cloud user. You can add a role to an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting API Key must have the Organization Owner role.\n\n**Note**: This operation is atomic.\n\n**Note**: This resource cannot be used to add a role to users invited using the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint.", + "operationId" : "addOrganizationRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the pending or active user in the organization. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Organization resource and filter by username.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Organization level role to assign to the MongoDB Cloud user.", + "in" : "query", + "name" : "role", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_READ_ONLY", "ORG_MEMBER" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrgUserResponse" + }, + "x-xgen-version" : "2025-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Add One Organization Role to One MongoDB Cloud User", + "tags" : [ "MongoDB Cloud Users" ] + } + }, + "/api/atlas/v2/orgs/{orgId}/users/{userId}:removeRole" : { + "post" : { + "description" : "Removes one organization level role from the MongoDB Cloud user. You can remove a role from an active user or a user that has not yet accepted the invitation to join the organization. To replace a user's only role, add the new role before removing the old role. A user must have at least one role at all times. To use this resource, the requesting API Key must have the Organization Owner role.\n\n**Note**: This operation is atomic.\n\n**Note**: This resource cannot be used to remove a role from users invited using the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint.", + "operationId" : "removeOrganizationRole", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/orgId" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "Unique 24-hexadecimal digit string that identifies the pending or active user in the organization. If you need to lookup a user's userId or verify a user's status in the organization, use the Return All MongoDB Cloud Users in One Organization resource and filter by username.", + "in" : "path", + "name" : "userId", + "required" : true, + "schema" : { + "type" : "string", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + } + }, { + "description" : "Organization level role to remove from the MongoDB Cloud user.", + "in" : "query", + "name" : "role", + "required" : true, + "schema" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_READ_ONLY", "ORG_MEMBER" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2025-01-01+json" : { + "schema" : { + "$ref" : "#/components/schemas/OrgUserResponse" + }, + "x-xgen-version" : "2025-01-01" + } + }, + "description" : "OK" + }, + "400" : { + "$ref" : "#/components/responses/badRequest" + }, + "401" : { + "$ref" : "#/components/responses/unauthorized" + }, + "403" : { + "$ref" : "#/components/responses/forbidden" + }, + "404" : { + "$ref" : "#/components/responses/notFound" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "security" : [ { + "DigestAuth" : [ ] + } ], + "summary" : "Remove One Organization Role from One MongoDB Cloud User", + "tags" : [ "MongoDB Cloud Users" ] + } + }, "/api/atlas/v2/unauth/controlPlaneIPAddresses" : { "get" : { "description" : "Returns all control plane IP addresses. Currently, inbound Atlas control plane IP addresses are not yet available. The inbound IP address list in your API response is empty. To manually retrieve a list of inbound Atlas control plane IP addresses, see [Required Inbound Access](https://www.mongodb.com/docs/atlas/setup-cluster-security/#std-label-atlas-required-inbound-access).", @@ -23276,6 +25102,53 @@ "tags" : [ "Root" ] } }, + "/api/atlas/v2/unauth/openapi/versions" : { + "get" : { + "description" : "API that provides a list of available versionsfor a given environment.", + "operationId" : "getApiVersions", + "parameters" : [ { + "$ref" : "#/components/parameters/envelope" + }, { + "$ref" : "#/components/parameters/itemsPerPage" + }, { + "$ref" : "#/components/parameters/pageNum" + }, { + "$ref" : "#/components/parameters/pretty" + }, { + "description" : "The environment to get the versions from. If not provided, it returnsthe versions for the given MongoDB URL. (E.g. prod for cloud.mongodb.com)", + "in" : "query", + "name" : "env", + "schema" : { + "type" : "string", + "enum" : [ "dev", "qa", "prod", "stage" ] + } + } ], + "responses" : { + "200" : { + "content" : { + "application/vnd.atlas.2024-08-05+json" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiVersions" + }, + "x-xgen-version" : "2024-08-05" + }, + "application/vnd.atlas.2024-08-05+yaml" : { + "schema" : { + "$ref" : "#/components/schemas/PaginatedApiVersions" + }, + "x-xgen-version" : "2024-08-05" + } + }, + "description" : "OK" + }, + "500" : { + "$ref" : "#/components/responses/internalServerError" + } + }, + "summary" : "Provides a list of versions for a given environment.", + "tags" : [ "OpenAPI" ] + } + }, "/api/atlas/v2/users" : { "post" : { "description" : "Creates one MongoDB Cloud user account. A MongoDB Cloud user account grants access to only the MongoDB Cloud application. To grant database access, create a database user. MongoDB Cloud sends an email to the users you specify, inviting them to join the project. Invited users don't have access to the project until they accept the invitation. Invitations expire after 30 days.\n\n 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.\n\n To use this resource, the requesting API Key can have any role.", @@ -23929,7 +25802,7 @@ "diskIOPS" : { "type" : "integer", "format" : "int32", - "description" : "Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.\n\n Change this parameter only if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" to \"AWS\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" to \"M30\"` or greater (not including `Mxx_NVME` tiers).\n\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType\" to \"PROVISIONED\"`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1." + "description" : "Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.\n\n Change this parameter if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" to \"AWS\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" to \"M30\"` or greater (not including `Mxx_NVME` tiers).\n\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType\" to \"PROVISIONED\"`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1." }, "ebsVolumeType" : { "type" : "string", @@ -23958,7 +25831,7 @@ "diskIOPS" : { "type" : "integer", "format" : "int32", - "description" : "Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.\n\n You can set different IOPS values on different shards when provisioned IOPS are supported.\n\n Change this parameter only if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" to \"AWS\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" to \"M30\"` or greater (not including `Mxx_NVME` tiers).\n\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType\" to \"PROVISIONED\"`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1." + "description" : "Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware.\n\n You can set different IOPS values on different shards when provisioned IOPS are supported.\n\n Change this parameter if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" to \"AWS\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" to \"M30\"` or greater (not including `Mxx_NVME` tiers).\n\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.ebsVolumeType\" to \"PROVISIONED\"`.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.\nMongoDB Cloud enforces minimum ratios of storage capacity to system memory for given cluster tiers. This keeps cluster performance consistent with large datasets.\n\n- Instance sizes `M10` to `M40` have a ratio of disk capacity to system memory of 60:1.\n- Instance sizes greater than `M40` have a ratio of 120:1." }, "diskSizeGB" : { "type" : "number", @@ -24289,6 +26162,26 @@ "description" : "Configuration of nodes that comprise the cluster.", "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] }, + "configServerManagementMode" : { + "type" : "string", + "default" : "ATLAS_MANAGED", + "description" : "Config Server Management Mode for creating or updating a sharded cluster.\n\nWhen configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings.\n\nWhen configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server.", + "enum" : [ "ATLAS_MANAGED", "FIXED_TO_DEDICATED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + } + }, + "configServerType" : { + "type" : "string", + "description" : "Describes a sharded cluster's config server type.", + "enum" : [ "DEDICATED", "EMBEDDED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + }, + "readOnly" : true + }, "connectionStrings" : { "$ref" : "#/components/schemas/ClusterConnectionStrings" }, @@ -24324,6 +26217,17 @@ "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" } }, + "featureCompatibilityVersion" : { + "type" : "string", + "description" : "Feature compatibility version of the cluster.", + "readOnly" : true + }, + "featureCompatibilityVersionExpirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Feature compatibility version expiration date.", + "readOnly" : true + }, "globalClusterSelfManagedSharding" : { "type" : "boolean", "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen 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.\n\nWhen 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.\n\nThis setting cannot be changed once the cluster is deployed.", @@ -24370,6 +26274,9 @@ }, "readOnly" : true }, + "mongoDBEmployeeAccessGrant" : { + "$ref" : "#/components/schemas/EmployeeAccessGrantView" + }, "mongoDBMajorVersion" : { "type" : "string", "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", @@ -24389,7 +26296,7 @@ "description" : "Human-readable label that identifies the advanced cluster.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, "paused" : { "type" : "boolean", @@ -24403,6 +26310,16 @@ "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" } }, + "replicaSetScalingStrategy" : { + "type" : "string", + "default" : "WORKLOAD_TYPE", + "description" : "Set this field to configure the replica set scaling mode for your cluster.\n\nBy default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes.\n\nWhen configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads.\n\nWhen configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads.", + "enum" : [ "SEQUENTIAL", "WORKLOAD_TYPE", "NODE_TYPE" ], + "externalDocs" : { + "description" : "Modify the Replica Set Scaling Mode", + "url" : "https://dochub.mongodb.org/core/scale-nodes" + } + }, "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.", @@ -25273,6 +27190,257 @@ }, "title" : "mappings" }, + "ApiAtlasInvalidPolicyErrorDetailView" : { + "type" : "object", + "properties" : { + "detail" : { + "type" : "string", + "description" : "A string that provides a detailed description of a validation error.", + "readOnly" : true + } + } + }, + "ApiAtlasInvalidPolicyView" : { + "type" : "object", + "properties" : { + "body" : { + "type" : "string", + "description" : "A string that defines the permissions for the policy. The syntax used is the Cedar Policy language.", + "example" : " forbid (\n principal,\n action == cloud::Action::\"cluster.createEdit\",\n resource\n ) when {\n context.cluster.regions.contains(cloud::region::\"aws:us-east-1\")\n };\n", + "readOnly" : true + }, + "errors" : { + "type" : "array", + "description" : "List of validation errors.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasInvalidPolicyErrorDetailView" + }, + "readOnly" : true + } + } + }, + "ApiAtlasInvalidResourcePolicyCreateErrorView" : { + "type" : "object", + "properties" : { + "errorType" : { + "type" : "string", + "description" : "Human-readable label that displays the type of an error.", + "enum" : [ "POLICY_PARSING_ERROR", "POLICY_HAS_FAILED_VALIDATIONS", "POLICY_HAS_INVALID_PRINCIPAL", "POLICY_HAS_BODY_EXCEEDING_MAX_SIZE", "POLICY_HAS_UNEXPECTED_ENTITIES" ] + }, + "invalidPolicies" : { + "type" : "array", + "description" : "List of invalid policies containing details of their validation errors.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasInvalidPolicyView" + }, + "readOnly" : true + } + } + }, + "ApiAtlasNonCompliantResourceView" : { + "type" : "object", + "properties" : { + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization the resource belongs to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resourceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the non-compliant resource.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resourcePoliciesCausingNonCompliance" : { + "type" : "array", + "description" : "List of resource policies causing the resource to be considered non-compliant.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasResourcePolicyMetadataView" + }, + "readOnly" : true + }, + "resourceType" : { + "type" : "string", + "description" : "Human-readable label that displays the type of a resource.", + "enum" : [ "PROJECT", "CLUSTER" ], + "readOnly" : true + } + } + }, + "ApiAtlasPolicyCreateView" : { + "type" : "object", + "properties" : { + "body" : { + "type" : "string", + "description" : "A string that defines the permissions for the policy. The syntax used is the Cedar Policy language.", + "example" : " forbid (\n principal,\n action == cloud::Action::\"cluster.createEdit\",\n resource\n ) when {\n context.cluster.regions.contains(cloud::region::\"aws:us-east-1\")\n };\n" + } + }, + "required" : [ "body" ] + }, + "ApiAtlasPolicyMetadataView" : { + "type" : "object", + "properties" : { + "policyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "ApiAtlasPolicyView" : { + "type" : "object", + "properties" : { + "body" : { + "type" : "string", + "description" : "A string that defines the permissions for the policy. The syntax used is the Cedar Policy language.", + "example" : " forbid (\n principal,\n action == cloud::Action::\"cluster.createEdit\",\n resource\n ) when {\n context.cluster.regions.contains(cloud::region::\"aws:us-east-1\")\n };\n", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "ApiAtlasResourcePolicyCreateView" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that describes the atlas resource policy." + }, + "policies" : { + "type" : "array", + "description" : "List of policies that make up the atlas resource policy.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasPolicyCreateView" + } + } + }, + "required" : [ "name", "policies" ] + }, + "ApiAtlasResourcePolicyEditView" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that describes the atlas resource policy." + }, + "policies" : { + "type" : "array", + "description" : "List of policies that make up the atlas resource policy.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasPolicyCreateView" + } + } + } + }, + "ApiAtlasResourcePolicyMetadataView" : { + "type" : "object", + "properties" : { + "policiesCausingNonCompliance" : { + "type" : "array", + "description" : "List of policies that are in conflict with the current state of the resource.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasPolicyMetadataView" + }, + "readOnly" : true + }, + "resourcePolicyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the atlas resource policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resourcePolicyName" : { + "type" : "string", + "description" : "Human-readable label that describes the atlas resource policy.", + "readOnly" : true + } + } + }, + "ApiAtlasResourcePolicyView" : { + "type" : "object", + "properties" : { + "createdByUser" : { + "$ref" : "#/components/schemas/ApiAtlasUserMetadataView" + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time in UTC when the atlas resource policy was created.", + "example" : "2022-01-01T00:00:00Z", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the atlas resource policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastUpdatedByUser" : { + "$ref" : "#/components/schemas/ApiAtlasUserMetadataView" + }, + "lastUpdatedDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time in UTC when the atlas resource policy was last updated.", + "example" : "2022-01-01T00:00:00Z", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that describes the atlas resource policy.", + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the organization the atlas resource policy belongs to.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "policies" : { + "type" : "array", + "description" : "List of policies that make up the atlas resource policy.", + "items" : { + "$ref" : "#/components/schemas/ApiAtlasPolicyView" + }, + "readOnly" : true + }, + "version" : { + "type" : "string", + "description" : "A string that identifies the version of the atlas resource policy.", + "example" : "v1", + "readOnly" : true + } + } + }, "ApiAtlasSnapshotScheduleView" : { "type" : "object", "properties" : { @@ -25349,6 +27517,27 @@ }, "required" : [ "clusterCheckpointIntervalMin", "clusterId", "dailySnapshotRetentionDays", "groupId", "monthlySnapshotRetentionMonths", "pointInTimeWindowHours", "snapshotIntervalHours", "snapshotRetentionDays", "weeklySnapshotRetentionWeeks" ] }, + "ApiAtlasUserMetadataView" : { + "type" : "object", + "description" : "The user that last updated the atlas resource policy.", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies a user.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that describes a user.", + "readOnly" : true + } + }, + "readOnly" : true + }, "ApiBSONTimestampView" : { "type" : "object", "description" : "BSON timestamp that indicates when the checkpoint token entry in the oplog occurred.", @@ -25405,6 +27594,9 @@ "ApiError" : { "type" : "object", "properties" : { + "badRequestDetail" : { + "$ref" : "#/components/schemas/BadRequestDetail" + }, "detail" : { "type" : "string", "description" : "Describes the specific conditions or reasons that cause each type of error." @@ -25415,24 +27607,30 @@ "description" : "HTTP status code returned with this error.", "externalDocs" : { "url" : "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status" - } + }, + "readOnly" : true }, "errorCode" : { "type" : "string", - "description" : "Application error code returned with this error." + "description" : "Application error code returned with this error.", + "readOnly" : true }, "parameters" : { "type" : "array", "description" : "Parameters used to give more information about the error.", "items" : { - "type" : "object" - } + "type" : "object", + "readOnly" : true + }, + "readOnly" : true }, "reason" : { "type" : "string", - "description" : "Application error message returned with this error." + "description" : "Application error message returned with this error.", + "readOnly" : true } - } + }, + "required" : [ "error", "errorCode" ] }, "ApiHostView_Atlas" : { "type" : "object", @@ -25688,6 +27886,24 @@ } } }, + "ApiPrivateDownloadDeliveryUrl" : { + "type" : "object", + "description" : "One Uniform Resource Locator (URL) that points to the compressed snapshot files for manual download and the corresponding private endpoint.", + "properties" : { + "deliveryUrl" : { + "type" : "string", + "description" : "One Uniform Resource Locator that points to the compressed snapshot files for manual download." + }, + "endpointId" : { + "type" : "string", + "description" : "Unique 22-character alphanumeric string that identifies the private endpoint.", + "example" : "vpce-3bf78b0ddee411ba1", + "maxLength" : 22, + "minLength" : 22, + "pattern" : "^vpce-[0-9a-f]{17}$" + } + } + }, "ApiPublicUsageDetailsQueryRequest" : { "type" : "object", "description" : "Request body for an Invoice Usage Details query with filtering, pagination, and sort.", @@ -25781,7 +27997,12 @@ "ApiStreamsAWSRegionView" : { "type" : "string", "description" : "Atlas Streams AWS Regions.", - "enum" : [ "VIRGINIA_USA" ] + "enum" : [ "SYDNEY_AUS", "MUMBAI_IND", "FRANKFURT_DEU", "DUBLIN_IRL", "LONDON_GBR", "VIRGINIA_USA", "OREGON_USA", "SAOPAULO_BRA", "MONTREAL_CAN", "TOKYO_JPN", "SINGAPORE_SGP" ] + }, + "ApiStreamsAzureRegionView" : { + "type" : "string", + "description" : "Atlas Streams Azure Regions.", + "enum" : [ "VIRGINIA_USA", "AMSTERDAM_NLD" ] }, "ApiUserEventTypeViewForNdsGroup" : { "type" : "string", @@ -26005,6 +28226,15 @@ "required" : [ "created", "eventTypeName", "id" ], "title" : "API User Events" }, + "ApiVersion" : { + "type" : "object", + "properties" : { + "version" : { + "type" : "string", + "description" : "Object representing a version of the Atlas Admin API." + } + } + }, "AppServiceAlertConfigViewForNdsGroup" : { "type" : "object", "description" : "App Services metric alert configuration allows to select which app service conditions and events trigger alerts and how users are notified.", @@ -26427,7 +28657,9 @@ "enum" : [ "AVERAGE" ] }, "operator" : { - "$ref" : "#/components/schemas/Operator" + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, "threshold" : { "type" : "number", @@ -26467,6 +28699,11 @@ "description" : "Atlas Data Federation Azure Regions.", "enum" : [ "VIRGINIA_USA", "AMSTERDAM_NLD" ] }, + "AtlasDataFederationGCPRegion" : { + "type" : "string", + "description" : "Atlas Data Federation GCP Regions.", + "enum" : [ "IOWA_USA", "BELGIUM_EU" ] + }, "AtlasOrganization" : { "type" : "object", "description" : "Details that describe the organization.", @@ -26507,6 +28744,122 @@ }, "required" : [ "name" ] }, + "AtlasResourcePolicyAuditForOrg" : { + "type" : "object", + "description" : "Atlas resource policy audits indicate org level changes to resource policies", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "RESOURCE_POLICY_CREATED", "RESOURCE_POLICY_MODIFIED", "RESOURCE_POLICY_DELETED" ], + "example" : "RESOURCE_POLICY_CREATED", + "title" : "Atlas Resource Policy Audit Types" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "resourcePolicyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the resource policy.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Atlas Resource Policy Audits" + }, "AtlasSearchAnalyzer" : { "type" : "object", "properties" : { @@ -27022,6 +29375,15 @@ "AzureHardwareSpec" : { "type" : "object", "properties" : { + "diskIOPS" : { + "type" : "integer", + "format" : "int32", + "description" : "Target throughput desired for storage attached to your Azure-provisioned cluster. Change this parameter if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" : \"Azure\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : \"M40\"` or greater not including `Mxx_NVME` tiers.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://www.mongodb.com/docs/atlas/customize-storage/#extend-iops-on-azure" + } + }, "instanceSize" : { "type" : "string", "description" : "Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts of the node type.", @@ -27038,6 +29400,15 @@ "AzureHardwareSpec20240805" : { "type" : "object", "properties" : { + "diskIOPS" : { + "type" : "integer", + "format" : "int32", + "description" : "Target throughput desired for storage attached to your Azure-provisioned cluster. Change this parameter if you:\n\n- set `\"replicationSpecs[n].regionConfigs[m].providerName\" : \"Azure\"`.\n- set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : \"M40\"` or greater not including `Mxx_NVME` tiers.\n\nThe maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**.\nThis parameter defaults to the cluster tier's standard IOPS value.\nChanging this value impacts cluster cost.", + "externalDocs" : { + "description" : "Programmatic API Keys", + "url" : "https://www.mongodb.com/docs/atlas/customize-storage/#extend-iops-on-azure" + } + }, "diskSizeGB" : { "type" : "number", "format" : "double", @@ -27165,7 +29536,7 @@ "status" : { "type" : "string", "description" : "State of the Encryption At Rest private endpoint.", - "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "ACTIVE", "FAILED" ], + "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "ACTIVE", "FAILED", "PENDING_RECREATION", "DELETING" ], "readOnly" : true } }, @@ -27498,7 +29869,7 @@ "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to create an online archive.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "collName" : { @@ -27582,7 +29953,7 @@ "description" : "Human-readable label that identifies the cluster that contains the collection for which you want to create an online archive.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "collName" : { @@ -27685,7 +30056,7 @@ "description" : "Human-readable label that identifies the cluster containing the snapshots you want to retrieve.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -27842,7 +30213,7 @@ "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\"`.\n\nIf the target cluster doesn't have backup enabled, two resources return parameters with empty values:\n\n- **Get All Snapshots** endpoint returns an empty results array without **clusterId** elements\n- **Get a Snapshot** endpoint doesn't return a **clusterId** parameter.\n\nTo return a response with the **clusterId** parameter, either use the **delivery.targetClusterName** parameter or enable backup on the target cluster.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, "targetGroupId" : { "type" : "string", @@ -28103,6 +30474,20 @@ } } }, + "BadRequestDetail" : { + "type" : "object", + "description" : "Bad request detail.", + "properties" : { + "fields" : { + "type" : "array", + "description" : "Describes all violations in a client request.", + "items" : { + "$ref" : "#/components/schemas/FieldViolation" + } + } + }, + "readOnly" : true + }, "BaseAtlasDataLakeRegion" : { "type" : "object", "description" : "Name of the region to which the data lake routes client connections.", @@ -28110,6 +30495,8 @@ "$ref" : "#/components/schemas/ApiAtlasDataLakeAWSRegionView" }, { "$ref" : "#/components/schemas/AtlasDataFederationAzureRegion" + }, { + "$ref" : "#/components/schemas/AtlasDataFederationGCPRegion" } ] }, "BaseCloudProviderInstanceSize" : { @@ -28177,6 +30564,8 @@ "description" : "Name of the cloud provider region hosting Atlas Stream Processing.", "oneOf" : [ { "$ref" : "#/components/schemas/ApiStreamsAWSRegionView" + }, { + "$ref" : "#/components/schemas/ApiStreamsAzureRegionView" } ] }, "BasicBSONList" : { @@ -29066,7 +31455,7 @@ "description" : "Human-readable label that identifies the cluster.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "nodeCount" : { @@ -29118,6 +31507,11 @@ "format" : "date-time", "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." }, + "description" : { + "type" : "string", + "description" : "Description of this database user.", + "maxLength" : 100 + }, "groupId" : { "type" : "string", "description" : "Unique 24-hexadecimal digit string that identifies the project.", @@ -29296,6 +31690,123 @@ "description" : "Details that describe the features linked to the Amazon Web Services (AWS) Identity and Access Management (IAM) role.", "required" : [ "providerName" ] }, + "CloudProviderAccessAWSIAMRoleRequest" : { + "type" : "object", + "description" : "Details that describe the features linked to the Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "properties" : { + "atlasAWSAccountArn" : { + "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.", + "example" : "arn:aws:iam::772401394250:role/my-test-aws-role", + "maxLength" : 2048, + "minLength" : 20, + "readOnly" : true + }, + "atlasAssumedRoleExternalId" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique external ID that MongoDB Cloud uses when it assumes the IAM role in your Amazon Web Services (AWS) account.", + "readOnly" : true + }, + "authorizedDate" : { + "type" : "string", + "format" : "date-time", + "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.", + "readOnly" : true + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "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.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider of the role.", + "enum" : [ "AWS", "AZURE", "GCP" ] + }, + "roleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + }, + "required" : [ "providerName" ] + }, + "CloudProviderAccessAWSIAMRoleRequestUpdate" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessRoleRequestUpdate" + }, { + "type" : "object", + "properties" : { + "atlasAWSAccountArn" : { + "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.", + "example" : "arn:aws:iam::772401394250:role/my-test-aws-role", + "maxLength" : 2048, + "minLength" : 20, + "readOnly" : true + }, + "atlasAssumedRoleExternalId" : { + "type" : "string", + "format" : "uuid", + "description" : "Unique external ID that MongoDB Cloud uses when it assumes the IAM role in your Amazon Web Services (AWS) account.", + "readOnly" : true + }, + "authorizedDate" : { + "type" : "string", + "format" : "date-time", + "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.", + "readOnly" : true + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "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.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "iamAssumedRoleArn" : { + "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", + "maxLength" : 2048, + "minLength" : 20 + }, + "roleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + } ], + "description" : "Details that describe the features linked to the Amazon Web Services (AWS) Identity and Access Management (IAM) role.", + "required" : [ "providerName" ] + }, "CloudProviderAccessAzureServicePrincipal" : { "type" : "object", "allOf" : [ { @@ -29358,6 +31869,130 @@ "description" : "Details that describe the features linked to the Azure Service Principal.", "required" : [ "providerName" ] }, + "CloudProviderAccessAzureServicePrincipalRequest" : { + "type" : "object", + "description" : "Details that describe the features linked to the Azure Service Principal.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "atlasAzureAppId" : { + "type" : "string", + "description" : "Azure Active Directory Application ID of Atlas.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this Azure Service Principal was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Azure Service Principal.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "lastUpdatedDate" : { + "type" : "string", + "format" : "date-time", + "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.", + "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.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "tenantId" : { + "type" : "string", + "description" : "UUID String that identifies the Azure Active Directory Tenant ID.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + } + }, + "required" : [ "providerName" ] + }, + "CloudProviderAccessAzureServicePrincipalRequestUpdate" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessRoleRequestUpdate" + }, { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "atlasAzureAppId" : { + "type" : "string", + "description" : "Azure Active Directory Application ID of Atlas.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this Azure Service Principal was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Azure Service Principal.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "lastUpdatedDate" : { + "type" : "string", + "format" : "date-time", + "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.", + "readOnly" : true + }, + "servicePrincipalId" : { + "type" : "string", + "description" : "UUID string that identifies the Azure Service Principal.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + }, + "tenantId" : { + "type" : "string", + "description" : "UUID String that identifies the Azure Active Directory Tenant ID.", + "maxLength" : 36, + "minLength" : 32, + "pattern" : "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{12}$" + } + } + } ], + "description" : "Details that describe the features linked to the Azure Service Principal.", + "required" : [ "providerName" ] + }, "CloudProviderAccessDataLakeFeatureUsage" : { "type" : "object", "allOf" : [ { @@ -29484,6 +32119,92 @@ } } }, + "CloudProviderAccessGCPServiceAccount" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessRole" + }, { + "type" : "object", + "properties" : { + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this Google Service Account was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this Google Service Account.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "gcpServiceAccountForAtlas" : { + "type" : "string", + "description" : "Email address for the Google Service Account created by Atlas.", + "maxLength" : 82, + "minLength" : 57, + "pattern" : "^mongodb-atlas-[0-9a-z]{16}@p-[0-9a-z]{24}.iam.gserviceaccount.com$" + }, + "roleId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + } ], + "description" : "Details that describe the features linked to the GCP Service Account.", + "required" : [ "providerName" ] + }, + "CloudProviderAccessGCPServiceAccountRequest" : { + "type" : "object", + "description" : "Details that describe the features linked to the GCP Service Account.", + "properties" : { + "createdDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this GCP Service Account was created. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "featureUsages" : { + "type" : "array", + "description" : "List that contains application features associated with this GCP Service Account.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessFeatureUsage" + }, + "readOnly" : true + }, + "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" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the role.", + "readOnly" : true + } + }, + "required" : [ "providerName" ] + }, + "CloudProviderAccessGCPServiceAccountRequestUpdate" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderAccessRoleRequestUpdate" + } ], + "description" : "Details that describe the features linked to the GCP Service Account.", + "required" : [ "providerName" ] + }, "CloudProviderAccessPushBasedLogExportFeatureUsage" : { "type" : "object", "allOf" : [ { @@ -29504,20 +32225,63 @@ "discriminator" : { "mapping" : { "AWS" : "#/components/schemas/CloudProviderAccessAWSIAMRole", - "AZURE" : "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + "AZURE" : "#/components/schemas/CloudProviderAccessAzureServicePrincipal", + "GCP" : "#/components/schemas/CloudProviderAccessGCPServiceAccount" + }, + "propertyName" : "providerName" + }, + "properties" : { + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider of the role.", + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, + "required" : [ "providerName" ] + }, + "CloudProviderAccessRoleRequest" : { + "type" : "object", + "description" : "Cloud provider access role.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/CloudProviderAccessAWSIAMRoleRequest", + "AZURE" : "#/components/schemas/CloudProviderAccessAzureServicePrincipalRequest", + "GCP" : "#/components/schemas/CloudProviderAccessGCPServiceAccountRequest" }, "propertyName" : "providerName" }, "oneOf" : [ { - "$ref" : "#/components/schemas/CloudProviderAccessAWSIAMRole" + "$ref" : "#/components/schemas/CloudProviderAccessAWSIAMRoleRequest" + }, { + "$ref" : "#/components/schemas/CloudProviderAccessAzureServicePrincipalRequest" }, { - "$ref" : "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + "$ref" : "#/components/schemas/CloudProviderAccessGCPServiceAccountRequest" } ], "properties" : { "providerName" : { "type" : "string", "description" : "Human-readable label that identifies the cloud provider of the role.", - "enum" : [ "AWS", "AZURE" ] + "enum" : [ "AWS", "AZURE", "GCP" ] + } + }, + "required" : [ "providerName" ] + }, + "CloudProviderAccessRoleRequestUpdate" : { + "type" : "object", + "description" : "Cloud provider access role.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/CloudProviderAccessAWSIAMRoleRequestUpdate", + "AZURE" : "#/components/schemas/CloudProviderAccessAzureServicePrincipalRequestUpdate", + "GCP" : "#/components/schemas/CloudProviderAccessGCPServiceAccountRequestUpdate" + }, + "propertyName" : "providerName" + }, + "properties" : { + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider of the role.", + "enum" : [ "AWS", "AZURE", "GCP" ] } }, "required" : [ "providerName" ] @@ -29531,6 +32295,13 @@ "items" : { "$ref" : "#/components/schemas/CloudProviderAccessAWSIAMRole" } + }, + "azureServicePrincipals" : { + "type" : "array", + "description" : "List that contains the Azure Service Principals registered with MongoDB Cloud.", + "items" : { + "$ref" : "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + } } } }, @@ -29913,7 +32684,7 @@ "example" : "cluster1", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -30006,6 +32777,7 @@ }, "diskGBEnabled" : { "type" : "boolean", + "default" : false, "description" : "Flag that indicates whether someone enabled disk auto-scaling for this cluster." } }, @@ -30035,10 +32807,12 @@ "properties" : { "enabled" : { "type" : "boolean", + "default" : false, "description" : "Flag that indicates whether cluster tier auto-scaling is enabled. Set to `true` to enable cluster tier auto-scaling. If enabled, you must specify a value for **providerSettings.autoScaling.compute.maxInstanceSize** also. Set to `false` to disable cluster tier auto-scaling." }, "scaleDownEnabled" : { "type" : "boolean", + "default" : false, "description" : "Flag that indicates whether the cluster tier can scale down. This is required if **autoScaling.compute.enabled** is `true`. If you enable this option, specify a value for **providerSettings.autoScaling.compute.minInstanceSize**." } } @@ -30073,14 +32847,14 @@ "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.", + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to Atlas through the interface endpoint that the key names. If the cluster uses an optimized connection string, `awsPrivateLinkSrv` contains the optimized connection string. If the cluster has the non-optimized (legacy) connection string, `awsPrivateLinkSrv` contains the non-optimized connection string even if an optimized connection string is also present.", "externalDocs" : { "description" : "Network Peering Connection", "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" }, "readOnly" : true }, - "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.", + "description" : "Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related `mongodb://` connection string that you use to connect to Atlas through the interface endpoint that the key names. If the cluster uses an optimized connection string, `awsPrivateLinkSrv` contains the optimized connection string. If the cluster has the non-optimized (legacy) connection string, `awsPrivateLinkSrv` contains the non-optimized connection string even if an optimized connection string is also present.", "externalDocs" : { "description" : "Network Peering Connection", "url" : "https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/" @@ -30160,6 +32934,26 @@ "description" : "Configuration of nodes that comprise the cluster.", "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] }, + "configServerManagementMode" : { + "type" : "string", + "default" : "ATLAS_MANAGED", + "description" : "Config Server Management Mode for creating or updating a sharded cluster.\n\nWhen configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings.\n\nWhen configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server.", + "enum" : [ "ATLAS_MANAGED", "FIXED_TO_DEDICATED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + } + }, + "configServerType" : { + "type" : "string", + "description" : "Describes a sharded cluster's config server type.", + "enum" : [ "DEDICATED", "EMBEDDED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + }, + "readOnly" : true + }, "connectionStrings" : { "$ref" : "#/components/schemas/ClusterConnectionStrings" }, @@ -30188,6 +32982,17 @@ "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" } }, + "featureCompatibilityVersion" : { + "type" : "string", + "description" : "Feature compatibility version of the cluster.", + "readOnly" : true + }, + "featureCompatibilityVersionExpirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Feature compatibility version expiration date.", + "readOnly" : true + }, "globalClusterSelfManagedSharding" : { "type" : "boolean", "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen 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.\n\nWhen 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.\n\nThis setting cannot be changed once the cluster is deployed.", @@ -30234,6 +33039,9 @@ }, "readOnly" : true }, + "mongoDBEmployeeAccessGrant" : { + "$ref" : "#/components/schemas/EmployeeAccessGrantView" + }, "mongoDBMajorVersion" : { "type" : "string", "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", @@ -30253,7 +33061,7 @@ "description" : "Human-readable label that identifies the cluster.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, "paused" : { "type" : "boolean", @@ -30267,6 +33075,24 @@ "url" : "https://docs.atlas.mongodb.com/backup/cloud-backup/overview/" } }, + "redactClientLogData" : { + "type" : "boolean", + "description" : "Enable or disable log redaction.", + "externalDocs" : { + "description" : "This options corresponds to the ``security.redactClientLogData`` cluster parameter.\n\nThis setting configures the ``mongod`` or ``mongos`` to redact any message accompanying a given log event before logging. This prevents the program from writing potentially sensitive data stored on the database to the diagnostic log. Metadata such as error or operation codes, line numbers, and source file names are still visible in the logs.\n\nUse ``redactClientLogData`` in conjunction with Encryption at Rest and TLS/SSL (Transport Encryption) to assist compliance with regulatory requirements.", + "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.redactClientLogData" + } + }, + "replicaSetScalingStrategy" : { + "type" : "string", + "default" : "WORKLOAD_TYPE", + "description" : "Set this field to configure the replica set scaling mode for your cluster.\n\nBy default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes.\n\nWhen configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads.\n\nWhen configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads.", + "enum" : [ "SEQUENTIAL", "WORKLOAD_TYPE", "NODE_TYPE" ], + "externalDocs" : { + "description" : "Modify the Replica Set Scaling Mode", + "url" : "https://dochub.mongodb.org/core/scale-nodes" + } + }, "replicationSpecs" : { "type" : "array", "description" : "List of settings that configure your cluster regions. This array has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations.", @@ -30376,6 +33202,16 @@ "ClusterDescriptionProcessArgs" : { "type" : "object", "properties" : { + "changeStreamOptionsPreAndPostImagesExpireAfterSeconds" : { + "type" : "integer", + "format" : "int32", + "default" : -1, + "description" : "The minimum pre- and post-image retention time in seconds.", + "externalDocs" : { + "description" : "This option corresponds to the ``changeStreamOptions.preAndPostImages.expireAfterSeconds`` cluster parameter. This setting controls the retention policy of change stream pre- and post-images. Pre- and post-images are the versions of a document before and after document modification, respectively. ``expireAfterSeconds`` controls how long MongoDB retains pre- and post-images. When set to -1 (off), MongoDB uses the default retention policy: pre- and post-images are retained until the corresponding change stream events are removed from the oplog. To set the minimum pre- and post-image retention time, specify an integer value greater than zero. Setting this too low could increase the risk of interrupting Realm sync or triggers processing. The default value is -1 (off).", + "url" : "https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/changeStreamOptions/#mongodb-parameter-param.changeStreamOptions.preAndPostImages.expireAfterSeconds" + } + }, "chunkMigrationConcurrency" : { "type" : "integer", "format" : "int32", @@ -30385,6 +33221,15 @@ "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.chunkMigrationConcurrency" } }, + "defaultMaxTimeMS" : { + "type" : "integer", + "format" : "int32", + "description" : "Default time limit in milliseconds for individual read operations to complete.", + "externalDocs" : { + "description" : "This option corresponds to the defaultMaxTimeMS cluster parameter.", + "url" : "https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/defaultMaxTimeMS/" + } + }, "defaultReadConcern" : { "type" : "string", "default" : "available", @@ -30415,7 +33260,7 @@ }, "javascriptEnabled" : { "type" : "boolean", - "description" : "Flag that indicates whether the cluster allows execution of operations that perform server-side executions of JavaScript.", + "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" @@ -30503,6 +33348,16 @@ "ClusterDescriptionProcessArgs20240805" : { "type" : "object", "properties" : { + "changeStreamOptionsPreAndPostImagesExpireAfterSeconds" : { + "type" : "integer", + "format" : "int32", + "default" : -1, + "description" : "The minimum pre- and post-image retention time in seconds.", + "externalDocs" : { + "description" : "This option corresponds to the ``changeStreamOptions.preAndPostImages.expireAfterSeconds`` cluster parameter. This setting controls the retention policy of change stream pre- and post-images. Pre- and post-images are the versions of a document before and after document modification, respectively. ``expireAfterSeconds`` controls how long MongoDB retains pre- and post-images. When set to -1 (off), MongoDB uses the default retention policy: pre- and post-images are retained until the corresponding change stream events are removed from the oplog. To set the minimum pre- and post-image retention time, specify an integer value greater than zero. Setting this too low could increase the risk of interrupting Realm sync or triggers processing. The default value is -1 (off).", + "url" : "https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/changeStreamOptions/#mongodb-parameter-param.changeStreamOptions.preAndPostImages.expireAfterSeconds" + } + }, "chunkMigrationConcurrency" : { "type" : "integer", "format" : "int32", @@ -30512,6 +33367,15 @@ "url" : "https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.chunkMigrationConcurrency" } }, + "defaultMaxTimeMS" : { + "type" : "integer", + "format" : "int32", + "description" : "Default time limit in milliseconds for individual read operations to complete.", + "externalDocs" : { + "description" : "This option corresponds to the defaultMaxTimeMS cluster parameter.", + "url" : "https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/defaultMaxTimeMS/" + } + }, "defaultWriteConcern" : { "type" : "string", "description" : "Default level of acknowledgment requested from MongoDB for write operations when none is specified by the driver.", @@ -30522,7 +33386,7 @@ }, "javascriptEnabled" : { "type" : "boolean", - "description" : "Flag that indicates whether the cluster allows execution of operations that perform server-side executions of JavaScript.", + "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" @@ -30789,7 +33653,7 @@ "description" : "Human-readable label that identifies the cluster that undergoes outage simulation.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "groupId" : { @@ -31383,7 +34247,8 @@ "discriminator" : { "mapping" : { "AWS" : "#/components/schemas/AWSCreateDataProcessRegionView", - "AZURE" : "#/components/schemas/AzureCreateDataProcessRegionView" + "AZURE" : "#/components/schemas/AzureCreateDataProcessRegionView", + "GCP" : "#/components/schemas/GCPCreateDataProcessRegionView" }, "propertyName" : "cloudProvider" }, @@ -31880,11 +34745,11 @@ }, "roleId" : { "type" : "string", - "description" : "Unique identifier of the role that Data Federation can use to access the data stores.Required if specifying cloudProviderConfig." + "description" : "Unique identifier of the role that Data Federation can use to access the data stores. Required if specifying cloudProviderConfig." }, "servicePrincipalId" : { "type" : "string", - "description" : "The ID of the Service Principal for which there is an access policyfor Atlas to access Azure resources.", + "description" : "The ID of the Service Principal for which there is an access policy for Atlas to access Azure resources.", "readOnly" : true }, "tenantId" : { @@ -31895,6 +34760,22 @@ }, "required" : [ "roleId" ] }, + "DataFederationGCPCloudProviderConfig" : { + "type" : "object", + "description" : "Configuration for running Data Federation in GCP.", + "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" : { + "type" : "string", + "description" : "Unique identifier of the role that Data Federation can use to access the data stores. Required if specifying cloudProviderConfig." + } + }, + "required" : [ "roleId" ] + }, "DataFederationLimit" : { "type" : "object", "description" : "Details of user managed limits.", @@ -31902,6 +34783,7 @@ "mapping" : { "atlas.project.deployment.clusters" : "#/components/schemas/DefaultLimit", "atlas.project.deployment.nodesPerPrivateLinkRegion" : "#/components/schemas/DefaultLimit", + "atlas.project.deployment.salesSoldM0s" : "#/components/schemas/DefaultLimit", "atlas.project.deployment.serverlessMTMs" : "#/components/schemas/DefaultLimit", "atlas.project.security.databaseAccess.customRoles" : "#/components/schemas/DefaultLimit", "atlas.project.security.databaseAccess.users" : "#/components/schemas/DefaultLimit", @@ -32242,9 +35124,12 @@ }, "azure" : { "$ref" : "#/components/schemas/DataFederationAzureCloudProviderConfig" + }, + "gcp" : { + "$ref" : "#/components/schemas/DataFederationGCPCloudProviderConfig" } }, - "title" : "Data Lake Cloud Provider" + "title" : "Data Federation Cloud Provider" }, "DataLakeDLSAWSStore" : { "type" : "object", @@ -32285,7 +35170,7 @@ "cloudProvider" : { "type" : "string", "description" : "Name of the cloud service that hosts the Federated Database Instance's infrastructure.", - "enum" : [ "AWS", "AZURE" ] + "enum" : [ "AWS", "AZURE", "GCP" ] }, "region" : { "$ref" : "#/components/schemas/BaseAtlasDataLakeRegion" @@ -32707,7 +35592,7 @@ "example" : "cluster1", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -32949,7 +35834,9 @@ "enum" : [ "AVERAGE" ] }, "operator" : { - "$ref" : "#/components/schemas/Operator" + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, "threshold" : { "type" : "number", @@ -32992,7 +35879,8 @@ "discriminator" : { "mapping" : { "AWS" : "#/components/schemas/AWSDataProcessRegionView", - "AZURE" : "#/components/schemas/AzureDataProcessRegionView" + "AZURE" : "#/components/schemas/AzureDataProcessRegionView", + "GCP" : "#/components/schemas/GCPDataProcessRegionView" }, "propertyName" : "cloudProvider" }, @@ -33000,7 +35888,7 @@ "cloudProvider" : { "type" : "string", "description" : "Human-readable label that identifies the Cloud service provider where you store your archived data.", - "enum" : [ "AWS", "AZURE" ], + "enum" : [ "AWS", "AZURE", "GCP" ], "readOnly" : true } }, @@ -33227,7 +36115,7 @@ "action" : { "type" : "string", "description" : "Human-readable label that identifies the privilege action.", - "enum" : [ "FIND", "INSERT", "REMOVE", "UPDATE", "BYPASS_DOCUMENT_VALIDATION", "USE_UUID", "KILL_OP", "CREATE_COLLECTION", "CREATE_INDEX", "DROP_COLLECTION", "ENABLE_PROFILER", "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", "STORAGE_GET_CONFIG", "STORAGE_SET_CONFIG", "FLUSH_ROUTER_CONFIG", "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" ] + "enum" : [ "FIND", "INSERT", "REMOVE", "UPDATE", "BYPASS_DOCUMENT_VALIDATION", "USE_UUID", "KILL_OP", "CREATE_COLLECTION", "CREATE_INDEX", "DROP_COLLECTION", "ENABLE_PROFILER", "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", "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", @@ -33506,7 +36394,7 @@ "title" : "Cps Backup Event Types" }, { "type" : "string", - "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEXES_RESTORE_FAILED" ], + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEXES_RESTORE_FAILED", "FTS_INDEXES_SYNONYM_MAPPING_INVALID" ], "title" : "FTS Index Audit Types" }, { "type" : "string", @@ -33649,7 +36537,7 @@ "title" : "Encryption Event Types" }, { "type" : "string", - "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEXES_RESTORE_FAILED" ], + "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEXES_RESTORE_FAILED", "FTS_INDEXES_SYNONYM_MAPPING_INVALID" ], "title" : "FTS Index Audit Types" }, { "type" : "string", @@ -33914,7 +36802,7 @@ "title" : "Tenant Backup Event Types" }, { "type" : "string", - "enum" : [ "CLUSTER_VERSION_FIXED", "CLUSTER_VERSION_UNFIXED", "CLUSTER_FCV_FIXED", "CLUSTER_FCV_UNFIXED", "AGENT_VERSION_FIXED", "AGENT_VERSION_UNFIXED", "FIXED_VERSION_UPDATED", "FIXED_AGENT_VERSION_UPDATED", "CLUSTER_FCV_DOWNGRADED" ], + "enum" : [ "CLUSTER_VERSION_FIXED", "CLUSTER_VERSION_UNFIXED", "CLUSTER_FCV_FIXED", "CLUSTER_FCV_UNFIXED", "CLUSTER_FCV_EXPIRATION_DATE_UPDATED", "AGENT_VERSION_FIXED", "AGENT_VERSION_UNFIXED", "FIXED_VERSION_UPDATED", "FIXED_AGENT_VERSION_UPDATED", "CLUSTER_FCV_DOWNGRADED", "CLUSTER_BINARY_VERSION_DOWNGRADED", "CLUSTER_BINARY_VERSION_UPGRADED" ], "title" : "Version Audit Types" } ] }, @@ -34238,7 +37126,6 @@ }, "hostnameSchemaType" : { "type" : "string", - "default" : "PUBLIC", "description" : "The network type to use between the migration host and the destination cluster.", "enum" : [ "PUBLIC", "PRIVATE_LINK", "VPC_PEERING" ] }, @@ -34362,28 +37249,19 @@ "createdAt" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when someone created this export job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "description" : "Date and time when a user or Atlas created the Export Job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", "readOnly" : true }, "customData" : { "type" : "array", - "description" : "Collection of key-value pairs that represent custom data for the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes.", + "description" : "Collection of key-value pairs that represent custom data for the metadata file that MongoDB Cloud uploads when the Export Job finishes.", "items" : { "$ref" : "#/components/schemas/BackupLabel" } }, - "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\"`.", - "items" : { - "type" : "string", - "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download." - }, - "readOnly" : true - }, "exportBucketId" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket to export to.", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -34396,7 +37274,7 @@ "finishedAt" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when this export job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "description" : "Date and time when this Export Job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", "readOnly" : true }, "id" : { @@ -34422,7 +37300,7 @@ }, "prefix" : { "type" : "string", - "description" : "Full path on the cloud provider bucket to the folder where the snapshot is exported.", + "description" : "Prefix used for all blob storage objects uploaded as part of the Export Job.", "pattern" : "/exported_snapshots/\\{ORG-NAME\\}/\\{PROJECT-NAME\\}/\\{CLUSTER-NAME\\}/\\{SNAPSHOT-INITIATION-DATE\\}/\\{TIMESTAMP\\}", "readOnly" : true }, @@ -34436,7 +37314,7 @@ }, "state" : { "type" : "string", - "description" : "State of the export job.", + "description" : "State of the Export Job.", "enum" : [ "Cancelled", "Failed", "InProgress", "Queued", "Successful" ], "readOnly" : true } @@ -34455,7 +37333,7 @@ }, "exportBucketId" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket to export to.", + "description" : "Unique 24-hexadecimal character string that identifies the Export Bucket.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -34656,7 +37534,15 @@ "properties" : { "downloadUrl" : { "type" : "string", - "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", + "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.", + "items" : { + "$ref" : "#/components/schemas/ApiPrivateDownloadDeliveryUrl" + }, "readOnly" : true }, "replicaSetName" : { @@ -35084,7 +37970,7 @@ "description" : "One or more Uniform Resource Locators (URLs) that point to the compressed snapshot files for manual download. MongoDB Cloud returns this parameter when `\"deliveryType\" : \"download\"`.", "items" : { "type" : "string", - "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download." + "description" : "One Uniform Resource Locator that points to the compressed snapshot files for manual download." }, "readOnly" : true }, @@ -35153,6 +38039,14 @@ "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`.", "minimum" : 1199145600 }, + "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.", + "items" : { + "$ref" : "#/components/schemas/ApiPrivateDownloadDeliveryUrl" + }, + "readOnly" : true + }, "snapshotId" : { "type" : "string", "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", @@ -35166,7 +38060,7 @@ "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.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, "targetGroupId" : { "type" : "string", @@ -35206,7 +38100,7 @@ "description" : "Human-readable label that identifies the cluster with the Snapshot you want to return.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "copySettings" : { @@ -35307,7 +38201,7 @@ "description" : "Human-readable label that identifies the cluster with the Snapshot you want to return.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "copySettings" : { @@ -35402,9 +38296,15 @@ "additionalProperties" : { "type" : "object", "description" : "The stats associated with the stream processor.", + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor" + }, "readOnly" : true }, "description" : "The stats associated with the stream processor.", + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor" + }, "readOnly" : true }, "EARPrivateEndpoint" : { @@ -35447,7 +38347,7 @@ "status" : { "type" : "string", "description" : "State of the Encryption At Rest private endpoint.", - "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "ACTIVE", "FAILED" ], + "enum" : [ "INITIATING", "PENDING_ACCEPTANCE", "ACTIVE", "FAILED", "PENDING_RECREATION", "DELETING" ], "readOnly" : true } }, @@ -35487,6 +38387,36 @@ "required" : [ "typeName" ], "title" : "Email Notification" }, + "EmployeeAccessGrantView" : { + "type" : "object", + "description" : "MongoDB employee granted access level and expiration for a cluster.", + "properties" : { + "expirationTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Expiration date for the employee access grant." + }, + "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.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + } + }, + "readOnly" : true, + "required" : [ "expirationTime", "grantType" ] + }, "EncryptionAtRest" : { "type" : "object", "properties" : { @@ -35501,27 +38431,6 @@ } } }, - "EncryptionAtRestPrivateEndpointRequest" : { - "type" : "object", - "description" : "Create or delete private endpoints from the specified regions list.", - "properties" : { - "cloudProvider" : { - "type" : "string", - "description" : "Cloud service provider name.", - "enum" : [ "AZURE" ] - }, - "regions" : { - "type" : "array", - "description" : "List of regions.", - "items" : { - "type" : "string" - }, - "uniqueItems" : true - } - }, - "required" : [ "cloudProvider" ], - "title" : "Encryption At Rest Private Endpoints setup." - }, "EncryptionKeyAlertConfigViewForNdsGroup" : { "type" : "object", "description" : "Encryption key alert configuration allows to select thresholds which trigger alerts and how users are notified.", @@ -35747,7 +38656,7 @@ "title" : "Export Bucket Audit Types" }, { "type" : "string", - "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEX_CREATED", "FTS_INDEX_UPDATED", "FTS_INDEX_DELETED", "FTS_INDEX_CLEANED_UP", "FTS_INDEXES_RESTORED", "FTS_INDEXES_RESTORE_FAILED" ], + "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" : "FTS Index Audit Types" }, { "type" : "string", @@ -35767,7 +38676,7 @@ "title" : "Group Integration 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_ENOUGH_DISK_SPACE", "HOST_NOT_ENOUGH_DISK_SPACE" ], + "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_ENOUGH_DISK_SPACE", "HOST_NOT_ENOUGH_DISK_SPACE" ], "title" : "Host Event Types" }, { "type" : "string", @@ -35779,7 +38688,7 @@ "title" : "Index Build 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_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_SSL_ROTATED", "CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER", "CLUSTER_INSTANCE_SSL_REVOKED", "RELOAD_SSL_ON_PROCESSES", "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", "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", "MOVE_SKIPPED", "PROXY_RESTARTED", "PROXY_PANICKED", "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", "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", "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", "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", "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", "PENDING_INDEXES_DELETED", "PENDING_INDEXES_CANCELED", "PROCESS_RESTART_REQUESTED", "AUTO_HEALING_ACTION", "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", "CLUSTER_FORCE_RECONFIG_REQUESTED", "PROJECT_BYPASSED_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", "ATLAS_SQL_SCHEDULED_UPDATE_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_MODIFIED", "ATLAS_SQL_SCHEDULED_UPDATE_REMOVED" ], + "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_SSL_ROTATED", "CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER", "CLUSTER_INSTANCE_SSL_REVOKED", "RELOAD_SSL_ON_PROCESSES", "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", "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", "MOVE_SKIPPED", "PROXY_RESTARTED", "PROXY_PANICKED", "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", "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", "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", "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", "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", "CLUSTER_FORCE_RECONFIG_REQUESTED", "PROJECT_BYPASSED_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" ], "title" : "NDS Audit Types" }, { "type" : "string", @@ -35879,7 +38788,7 @@ "title" : "User Event Types" }, { "type" : "string", - "enum" : [ "CLUSTER_VERSION_FIXED", "CLUSTER_VERSION_UNFIXED", "CLUSTER_FCV_FIXED", "CLUSTER_FCV_UNFIXED", "AGENT_VERSION_FIXED", "AGENT_VERSION_UNFIXED", "FIXED_VERSION_UPDATED", "FIXED_AGENT_VERSION_UPDATED", "CLUSTER_FCV_DOWNGRADED" ], + "enum" : [ "CLUSTER_VERSION_FIXED", "CLUSTER_VERSION_UNFIXED", "CLUSTER_FCV_FIXED", "CLUSTER_FCV_UNFIXED", "CLUSTER_FCV_EXPIRATION_DATE_UPDATED", "AGENT_VERSION_FIXED", "AGENT_VERSION_UNFIXED", "FIXED_VERSION_UPDATED", "FIXED_AGENT_VERSION_UPDATED", "CLUSTER_FCV_DOWNGRADED", "CLUSTER_BINARY_VERSION_DOWNGRADED", "CLUSTER_BINARY_VERSION_UPGRADED" ], "title" : "Version Audit Types" }, { "type" : "string", @@ -35949,6 +38858,10 @@ "type" : "string", "enum" : [ "GROUP_TAGS_MODIFIED" ], "title" : "Resource Event Types" + }, { + "type" : "string", + "enum" : [ "RESOURCE_POLICY_CREATED", "RESOURCE_POLICY_MODIFIED", "RESOURCE_POLICY_DELETED" ], + "title" : "Atlas Resource Policy Audit Types" } ] }, "EventViewForNdsGroup" : { @@ -36027,6 +38940,8 @@ "$ref" : "#/components/schemas/UserEventViewForOrg" }, { "$ref" : "#/components/schemas/ResourceEventViewForOrg" + }, { + "$ref" : "#/components/schemas/AtlasResourcePolicyAuditForOrg" } ] }, "ExampleResourceResponse20230101" : { @@ -36087,7 +39002,7 @@ }, "ExportStatus" : { "type" : "object", - "description" : "State of the export job for the collections on the replica set only.", + "description" : "State of the Export Job.", "properties" : { "exportedCollections" : { "type" : "integer", @@ -36122,7 +39037,7 @@ "FTSIndexAuditTypeView" : { "type" : "string", "description" : "Unique identifier of event type.", - "enum" : [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEX_CREATED", "FTS_INDEX_UPDATED", "FTS_INDEX_DELETED", "FTS_INDEX_CLEANED_UP", "FTS_INDEXES_RESTORED", "FTS_INDEXES_RESTORE_FAILED" ], + "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" ], "example" : "FTS_INDEX_CREATED", "title" : "FTS Index Audit Types" }, @@ -37028,37 +39943,53 @@ }, "title" : "Field Transformation" }, - "ForNdsGroup" : { + "FieldViolation" : { "type" : "object", - "description" : "ReplicaSet Event identifies different activities about replica set of mongod instances.", "properties" : { - "created" : { + "description" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "description" : "A description of why the request element is bad." }, - "eventTypeName" : { - "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroup" + "field" : { + "type" : "string", + "description" : "A path that leads to a field in the request body." + } + }, + "required" : [ "description", "field" ] + }, + "FlexBackupRestoreJob20250101" : { + "type" : "object", + "description" : "Details for one restore job of a flex cluster.", + "properties" : { + "deliveryType" : { + "type" : "string", + "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", + "enum" : [ "RESTORE", "DOWNLOAD" ], + "readOnly" : true }, - "groupId" : { + "expirationDate" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, + "instanceName" : { + "type" : "string", + "description" : "Human-readable label that identifies the source instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "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.", @@ -37071,485 +40002,317 @@ }, "readOnly" : true }, - "orgId" : { + "projectId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "port" : { - "type" : "integer", - "format" : "int32", - "description" : "IANA port on which the MongoDB process listens for requests.", - "example" : 27017, + "restoreFinishedDate" : { + "type" : "string", + "format" : "date-time", + "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.", "readOnly" : true }, - "raw" : { - "$ref" : "#/components/schemas/raw" - }, - "replicaSetName" : { + "restoreScheduledDate" : { "type" : "string", - "description" : "Human-readable label of the replica set associated with the event.", - "example" : "event-replica-set", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "shardName" : { + "snapshotFinishedDate" : { "type" : "string", - "description" : "Human-readable label of the shard associated with the event.", - "example" : "event-sh-01", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true - } - }, - "required" : [ "created", "eventTypeName", "id" ], - "title" : "ReplicaSet Events" - }, - "GCPCloudProviderContainer" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/CloudProviderContainer" - }, { - "type" : "object", - "properties" : { - "atlasCidrBlock" : { - "type" : "string", - "description" : "IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.\n\nThese CIDR blocks must fall within the ranges reserved per RFC 1918. GCP further limits the block to a lower bound of the `/18` range.\n\nTo modify the CIDR block, the target project cannot have:\n\n- Any M10 or greater clusters\n- Any other VPC peering connections\n\n 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.\n\n **Example:** A project in an Google Cloud (GCP) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets.", - "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" - }, - "gcpProjectId" : { - "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.", - "maxLength" : 26, - "minLength" : 26, - "pattern" : "^p-[0-9a-z]{24}$", - "readOnly" : true - }, - "networkName" : { - "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.", - "maxLength" : 36, - "minLength" : 36, - "pattern" : "^nt-[0-9a-f]{24}-[0-9a-z]{8}$", - "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.", - "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.", - "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" ] - } - } - } - } ], - "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", - "required" : [ "atlasCidrBlock" ], - "title" : "GCP" - }, - "GCPComputeAutoScaling" : { - "type" : "object", - "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", - "properties" : { - "maxInstanceSize" : { + }, + "snapshotId" : { "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" ], - "title" : "GCP Instance Sizes" + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "minInstanceSize" : { + "snapshotUrl" : { "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" ], - "title" : "GCP Instance Sizes" - } - }, - "title" : "GCP" - }, - "GCPConsumerForwardingRule" : { - "type" : "object", - "properties" : { - "endpointName" : { + "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" : "Human-readable label that identifies the Google Cloud consumer forwarding rule that you created.", - "externalDocs" : { - "description" : "Google Cloud Forwarding Rule Concepts", - "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" - }, + "description" : "Phase of the restore workflow for this job at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], "readOnly" : true }, - "ipAddress" : { + "targetDeploymentItemName" : { "type" : "string", - "description" : "One Private Internet Protocol version 4 (IPv4) address to which this Google Cloud consumer forwarding rule resolves.", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "description" : "Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another USS instance or Dedicated cluster tier.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", "readOnly" : true }, - "status" : { + "targetProjectId" : { "type" : "string", - "description" : "State of the MongoDB Cloud endpoint group when MongoDB Cloud received this request.", - "enum" : [ "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true } - } + }, + "title" : "Flex Backup Restore Job" }, - "GCPEndpointService" : { + "FlexBackupRestoreJobCreate20250101" : { "type" : "object", - "description" : "Group of Private Endpoint Service settings.", + "description" : "Details to create one restore job of a flex cluster.", "properties" : { - "cloudProvider" : { + "_snapshotId" : { "type" : "string", - "description" : "Cloud service provider that serves the requested endpoint service.", - "enum" : [ "AWS", "AZURE", "GCP" ], - "readOnly" : true + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true }, - "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" - }, - "items" : { - "type" : "string", - "description" : "One Google Cloud network endpoint group that corresponds to the Private Service Connect endpoint service." - } + "_targetDeploymentItemName" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another flex cluster or dedicated cluster tier.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", + "writeOnly" : true }, - "errorMessage" : { + "_targetProjectId" : { "type" : "string", - "description" : "Error message returned when requesting private connection resource. The resource returns `null` if the request succeeded.", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true + }, + "deliveryType" : { + "type" : "string", + "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", + "enum" : [ "RESTORE", "DOWNLOAD" ], + "readOnly" : true + }, + "expirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "regionName" : { + "instanceName" : { "type" : "string", - "description" : "Cloud provider region that manages this Private Endpoint Service.", + "description" : "Human-readable label that identifies the source instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, - "serviceAttachmentNames" : { + "links" : { "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.", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", "externalDocs" : { - "description" : "Google Cloud Private Service Connect Service Attachments", - "url" : "https://cloud.google.com/vpc/docs/private-service-connect#service-attachments" + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" }, "items" : { - "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.", - "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\\-]+" - } + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true }, - "status" : { + "projectId" : { "type" : "string", - "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", - "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true - } - }, - "required" : [ "cloudProvider" ], - "title" : "GCP" - }, - "GCPHardwareSpec" : { - "type" : "object", - "properties" : { - "instanceSize" : { + }, + "restoreFinishedDate" : { "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" ], - "title" : "GCP Instance Sizes" + "format" : "date-time", + "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.", + "readOnly" : true }, - "nodeCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." - } - } - }, - "GCPHardwareSpec20240805" : { - "type" : "object", - "properties" : { - "diskSizeGB" : { - "type" : "number", - "format" : "double", - "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", - "maximum" : 4096, - "minimum" : 10 - }, - "instanceSize" : { - "type" : "string", - "description" : "Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as \"base nodes\") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.", - "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], - "title" : "GCP Instance Sizes" - }, - "nodeCount" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." - } - } - }, - "GCPNetworkPeeringConnectionSettings" : { - "type" : "object", - "description" : "Group of Network Peering connection settings.", - "properties" : { - "containerId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" - }, - "errorMessage" : { + "restoreScheduledDate" : { "type" : "string", - "description" : "Details of the error returned when requesting a GCP network peering resource. The resource returns `null` if the request succeeded.", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "gcpProjectId" : { - "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.", - "maxLength" : 30, - "minLength" : 6, - "pattern" : "^[a-z][0-9a-z-]{4,28}[0-9a-z]{1}" - }, - "id" : { + "snapshotFinishedDate" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "networkName" : { - "type" : "string", - "description" : "Human-readable label that identifies the network to peer with the MongoDB Cloud VPC.", - "maxLength" : 63, - "minLength" : 1, - "pattern" : "[a-z]([-a-z0-9]{0,62}[a-z0-9]{0,1})?" - }, - "providerName" : { + "snapshotUrl" : { "type" : "string", - "description" : "Cloud service provider that serves the requested network peering connection.", - "enum" : [ "AWS", "AZURE", "GCP" ] + "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" : "State of the network peering connection at the time you made the request.", - "enum" : [ "ADDING_PEER", "WAITING_FOR_USER", "AVAILABLE", "FAILED", "DELETING" ], + "description" : "Phase of the restore workflow for this job at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], "readOnly" : true } }, - "required" : [ "containerId", "gcpProjectId", "networkName" ], - "title" : "GCP" - }, - "GCPRegionConfig" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/CloudRegionConfig" - }, { - "type" : "object", - "properties" : { - "analyticsAutoScaling" : { - "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" - }, - "analyticsSpecs" : { - "$ref" : "#/components/schemas/DedicatedHardwareSpec" - }, - "autoScaling" : { - "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" - }, - "readOnlySpecs" : { - "$ref" : "#/components/schemas/DedicatedHardwareSpec" - } - } - } ], - "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", - "title" : "GCP Regional Replication Specifications" + "required" : [ "_snapshotId", "_targetDeploymentItemName" ], + "title" : "Create Flex Backup Restore Job" }, - "GCPRegionConfig20240805" : { + "FlexBackupSettings20250101" : { "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/CloudRegionConfig20240805" - }, { - "type" : "object", - "properties" : { - "analyticsAutoScaling" : { - "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" - }, - "analyticsSpecs" : { - "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" - }, - "autoScaling" : { - "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" - }, - "readOnlySpecs" : { - "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" - } + "description" : "Flex backup configuration", + "properties" : { + "enabled" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether backups are performed for this flex cluster. Backup uses [TODO](TODO) for flex clusters.", + "readOnly" : true } - } ], - "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", - "title" : "GCP Regional Replication Specifications" + }, + "readOnly" : true, + "title" : "Flex Backup Configuration" }, - "GeoSharding" : { + "FlexBackupSnapshot20250101" : { "type" : "object", + "description" : "Details for one snapshot of a flex cluster.", "properties" : { - "customZoneMapping" : { - "type" : "object", - "additionalProperties" : { - "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `id` property.\n\nThis parameter returns an empty object if no custom zones exist.", - "readOnly" : true - }, - "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `id` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "expiration" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "managedNamespaces" : { - "type" : "array", - "description" : "List that contains a namespace for a Global Cluster. MongoDB Cloud manages this cluster.", - "items" : { - "$ref" : "#/components/schemas/ManagedNamespaces" - }, + "finishTime" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "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 - } - } - }, - "GeoSharding20240805" : { - "type" : "object", - "properties" : { - "customZoneMapping" : { - "type" : "object", - "additionalProperties" : { - "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.\n\nThis parameter returns an empty object if no custom zones exist.", - "readOnly" : true - }, - "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "managedNamespaces" : { + "links" : { "type" : "array", - "description" : "List that contains a namespace for a Global Cluster. MongoDB Cloud manages this cluster.", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, "items" : { - "$ref" : "#/components/schemas/ManagedNamespaces" + "$ref" : "#/components/schemas/Link" }, "readOnly" : true }, - "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.", + "mongoDBVersion" : { + "type" : "string", + "description" : "MongoDB host version that the snapshot runs.", "readOnly" : true - } - } - }, - "GoogleCloudKMS" : { - "type" : "object", - "description" : "Details that define the configuration of Encryption at Rest using Google Cloud Key Management Service (KMS).", - "externalDocs" : { - "description" : "Google Cloud Key Management Service", - "url" : "https://www.mongodb.com/docs/atlas/security-gcp-kms/" - }, - "properties" : { - "enabled" : { - "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" : { + "scheduledTime" : { "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" + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud will take the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true }, - "serviceAccountKey" : { + "startTime" : { "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.", - "externalDocs" : { - "description" : "Google Cloud Authentication", - "url" : "https://cloud.google.com/docs/authentication/getting-started" - }, - "writeOnly" : true - }, - "valid" : { - "type" : "boolean", - "description" : "Flag that indicates whether the Google Cloud Key Management Service (KMS) encryption key can encrypt and decrypt data.", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud began taking the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true - } - } - }, - "GreaterThanDaysThresholdView" : { - "type" : "object", - "description" : "Threshold value that triggers an alert.", - "properties" : { - "operator" : { - "type" : "string", - "description" : "Comparison operator to apply when checking the current metric value.", - "enum" : [ "GREATER_THAN" ] - }, - "threshold" : { - "type" : "integer", - "format" : "int32", - "description" : "Value of metric that, when exceeded, triggers an alert." }, - "units" : { + "status" : { "type" : "string", - "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", - "enum" : [ "DAYS" ] + "description" : "Phase of the workflow for this snapshot at the time this resource made this request.", + "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "readOnly" : true } - } + }, + "title" : "Flex Backup Snapshot" }, - "GreaterThanRawThreshold" : { + "FlexBackupSnapshotDownloadCreate20250101" : { "type" : "object", - "description" : "A Limit that triggers an alert when greater than a number.", + "description" : "Details for one backup snapshot download of a flex cluster.", "properties" : { - "operator" : { + "_snapshotId" : { "type" : "string", - "description" : "Comparison operator to apply when checking the current metric value.", - "enum" : [ "GREATER_THAN" ] - }, - "threshold" : { - "type" : "integer", - "format" : "int32", - "description" : "Value of metric that, when exceeded, triggers an alert." + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to download.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "writeOnly" : true }, - "units" : { - "$ref" : "#/components/schemas/RawMetricUnits" + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true } }, - "title" : "Greater Than Raw Threshold" + "required" : [ "_snapshotId" ], + "title" : "Flex Backup Snapshot Download Create" }, - "GreaterThanRawThresholdAlertConfigViewForNdsGroup" : { + "FlexClusterDescription20250101" : { "type" : "object", + "description" : "Group of settings that configure a MongoDB Flex cluster.", "properties" : { - "created" : { + "backupSettings" : { + "$ref" : "#/components/schemas/FlexBackupSettings20250101" + }, + "clusterType" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Flex cluster topology.", + "enum" : [ "REPLICASET", "LOADBALANCED" ], "readOnly" : true }, - "enabled" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + "connectionStrings" : { + "$ref" : "#/components/schemas/FlexConnectionStrings20250101" }, - "eventTypeName" : { - "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this instance. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true }, "groupId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "description" : "Unique 24-hexadecimal character string that identifies the project.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -37558,7 +40321,7 @@ }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "description" : "Unique 24-hexadecimal digit string that identifies the instance.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -37577,76 +40340,60 @@ }, "readOnly" : true }, - "matchers" : { - "type" : "array", - "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", - "items" : { - "$ref" : "#/components/schemas/ReplicaSetMatcher" - } + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the instance runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true }, - "notifications" : { + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "readOnly" : true + }, + "providerSettings" : { + "$ref" : "#/components/schemas/FlexProviderSettings20250101" + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of this instance.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { "type" : "array", - "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, "items" : { - "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + "$ref" : "#/components/schemas/ResourceTag" } }, - "threshold" : { - "$ref" : "#/components/schemas/GreaterThanRawThreshold" + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." }, - "updated" : { + "versionReleaseSystem" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions.", + "enum" : [ "LTS" ], "readOnly" : true } }, - "required" : [ "eventTypeName", "notifications" ] - }, - "GreaterThanTimeThreshold" : { - "type" : "object", - "description" : "A Limit that triggers an alert when greater than a time period.", - "properties" : { - "operator" : { - "type" : "string", - "description" : "Comparison operator to apply when checking the current metric value.", - "enum" : [ "GREATER_THAN" ] - }, - "threshold" : { - "type" : "integer", - "format" : "int32", - "description" : "Value of metric that, when exceeded, triggers an alert." - }, - "units" : { - "$ref" : "#/components/schemas/TimeMetricUnits" - } - }, - "title" : "Greater Than Time Threshold" + "required" : [ "providerSettings" ], + "title" : "Flex Cluster Description" }, - "Group" : { + "FlexClusterDescriptionCreate20250101" : { "type" : "object", + "description" : "Settings that you can specify when you create a flex cluster.", "properties" : { - "clusterCount" : { - "type" : "integer", - "format" : "int64", - "description" : "Quantity of MongoDB Cloud clusters deployed in this project.", - "readOnly" : true - }, - "created" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created this project. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true - }, - "id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, "links" : { "type" : "array", "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", @@ -37661,111 +40408,899 @@ }, "name" : { "type" : "string", - "description" : "Human-readable label that identifies the project included in the MongoDB Cloud organization.", + "description" : "Human-readable label that identifies the instance.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" - }, - "orgId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud organization to which the project belongs.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "writeOnly" : true }, - "regionUsageRestrictions" : { - "type" : "string", - "default" : "COMMERCIAL_FEDRAMP_REGIONS_ONLY", - "description" : "Applies to Atlas for Government only.\n\nIn Commercial Atlas, this field will be rejected in requests and missing in responses.\n\nThis field sets restrictions on available regions in the project.\n\n| Value | Available Regions |\n|-----------------------------------|------------|\n| `COMMERCIAL_FEDRAMP_REGIONS_ONLY` | Only allows deployments in FedRAMP Moderate regions.|\n| `GOV_REGIONS_ONLY` | Only allows deployments in GovCloud regions.|", - "enum" : [ "COMMERCIAL_FEDRAMP_REGIONS_ONLY", "GOV_REGIONS_ONLY" ], - "externalDocs" : { - "url" : "https://www.mongodb.com/docs/atlas/government/overview/supported-regions/#supported-cloud-providers-and-regions" - } + "providerSettings" : { + "$ref" : "#/components/schemas/FlexProviderSettingsCreate20250101" }, "tags" : { "type" : "array", - "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the project.", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.", "externalDocs" : { "description" : "Resource Tags", - "url" : "https://www.mongodb.com/docs/atlas/tags" + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" }, "items" : { "$ref" : "#/components/schemas/ResourceTag" } }, - "withDefaultAlertsSettings" : { + "terminationProtectionEnabled" : { "type" : "boolean", - "description" : "Flag that indicates whether to create the project with default alert settings.", - "writeOnly" : true + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." } }, - "required" : [ "clusterCount", "created", "name", "orgId" ] - }, - "GroupAlertsConfig" : { - "type" : "object", - "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/StreamProcessorAlertConfigViewForNdsGroup" - } ] + "required" : [ "name", "providerSettings" ], + "title" : "Flex Cluster Description Create" }, - "GroupIPAddresses" : { + "FlexConnectionStrings20250101" : { "type" : "object", - "description" : "List of IP addresses in a project.", + "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, "properties" : { - "groupId" : { + "standard" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "description" : "Public connection string that you can use to connect to this cluster. This connection string uses the mongodb:// protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, "readOnly" : true }, - "services" : { - "$ref" : "#/components/schemas/GroupService" + "standardSrv" : { + "type" : "string", + "description" : "Public connection string that you can use to connect to this flex cluster. This connection string uses the `mongodb+srv://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true } }, - "title" : "Group IP Address" + "readOnly" : true, + "title" : "Flex Cluster Connection Strings" }, - "GroupInvitation" : { + "FlexProviderSettings20250101" : { "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB flex cluster.", "properties" : { - "createdAt" : { + "backingProviderName" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud sent the invitation. This parameter expresses its value in ISO 8601 format in UTC.", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the flex cluster.", + "enum" : [ "AWS", "AZURE", "GCP" ], "readOnly" : true }, - "expiresAt" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud expires the invitation. This parameter expresses its value in ISO 8601 format in UTC.", + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity available to the flex cluster expressed in gigabytes.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "default" : "FLEX", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "FLEX" ], + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB flex cluster. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).", + "readOnly" : true + } + }, + "readOnly" : true, + "title" : "Cloud Service Provider Settings for a Flex Cluster" + }, + "FlexProviderSettingsCreate20250101" : { + "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB flex cluster.", + "properties" : { + "backingProviderName" : { + "type" : "string", + "description" : "Cloud service provider on which MongoDB Cloud provisioned the flex cluster.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "writeOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity available to the flex cluster expressed in gigabytes.", + "readOnly" : true + }, + "providerName" : { + "type" : "string", + "default" : "FLEX", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "FLEX" ], + "readOnly" : true + }, + "regionName" : { + "type" : "string", + "description" : "Human-readable label that identifies the geographic location of your MongoDB flex cluster. The region you choose can affect network latency for clients accessing your databases. For a complete list of region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws), [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/).", + "writeOnly" : true + } + }, + "required" : [ "backingProviderName", "regionName" ], + "title" : "Cloud Service Provider Settings for a Flex Cluster", + "writeOnly" : true + }, + "ForNdsGroup" : { + "type" : "object", + "description" : "ReplicaSet Event identifies different activities about replica set of mongod instances.", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "replicaSetName" : { + "type" : "string", + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "ReplicaSet Events" + }, + "GCPCloudProviderContainer" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudProviderContainer" + }, { + "type" : "object", + "properties" : { + "atlasCidrBlock" : { + "type" : "string", + "description" : "IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project.\n\nThese CIDR blocks must fall within the ranges reserved per RFC 1918. GCP further limits the block to a lower bound of the `/18` range.\n\nTo modify the CIDR block, the target project cannot have:\n\n- Any M10 or greater clusters\n- Any other VPC peering connections\n\n 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.\n\n **Example:** A project in an Google Cloud (GCP) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets.", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + }, + "gcpProjectId" : { + "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.", + "maxLength" : 26, + "minLength" : 26, + "pattern" : "^p-[0-9a-z]{24}$", + "readOnly" : true + }, + "networkName" : { + "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.", + "maxLength" : 36, + "minLength" : 36, + "pattern" : "^nt-[0-9a-f]{24}-[0-9a-z]{8}$", + "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.", + "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.", + "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" ] + } + } + } + } ], + "description" : "Collection of settings that configures the network container for a virtual private connection on Amazon Web Services.", + "required" : [ "atlasCidrBlock" ], + "title" : "GCP" + }, + "GCPComputeAutoScaling" : { + "type" : "object", + "description" : "Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.", + "properties" : { + "maxInstanceSize" : { + "type" : "string", + "description" : "Maximum instance size to which your cluster can automatically scale.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "minInstanceSize" : { + "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" ], + "title" : "GCP Instance Sizes" + } + }, + "title" : "GCP" + }, + "GCPConsumerForwardingRule" : { + "type" : "object", + "properties" : { + "endpointName" : { + "type" : "string", + "description" : "Human-readable label that identifies the Google Cloud consumer forwarding rule that you created.", + "externalDocs" : { + "description" : "Google Cloud Forwarding Rule Concepts", + "url" : "https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts" + }, + "readOnly" : true + }, + "ipAddress" : { + "type" : "string", + "description" : "One Private Internet Protocol version 4 (IPv4) address to which this Google Cloud consumer forwarding rule resolves.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "State of the MongoDB Cloud endpoint group when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + } + }, + "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" ] + } + } + } ] + }, + "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.", + "enum" : [ "CENTRAL_US", "WESTERN_EUROPE" ], + "readOnly" : true + } + } + } ] + }, + "GCPEndpointService" : { + "type" : "object", + "description" : "Group of Private Endpoint Service settings.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Cloud service provider that serves the requested endpoint service.", + "enum" : [ "AWS", "AZURE", "GCP" ], + "readOnly" : true + }, + "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" + }, + "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" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the Private Endpoint Service.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "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" + }, + "items" : { + "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.", + "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\\-]+" + } + }, + "status" : { + "type" : "string", + "description" : "State of the Private Endpoint Service connection when MongoDB Cloud received this request.", + "enum" : [ "INITIATING", "AVAILABLE", "WAITING_FOR_USER", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "cloudProvider" ], + "title" : "GCP" + }, + "GCPHardwareSpec" : { + "type" : "object", + "properties" : { + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts 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" ], + "title" : "GCP Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "GCPHardwareSpec20240805" : { + "type" : "object", + "properties" : { + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 + }, + "instanceSize" : { + "type" : "string", + "description" : "Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as \"base nodes\") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.", + "enum" : [ "M10", "M20", "M30", "M40", "M50", "M60", "M80", "M140", "M200", "M250", "M300", "M400", "R40", "R50", "R60", "R80", "R200", "R300", "R400", "R600" ], + "title" : "GCP Instance Sizes" + }, + "nodeCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of nodes of the given type for MongoDB Cloud to deploy to the region." + } + } + }, + "GCPNetworkPeeringConnectionSettings" : { + "type" : "object", + "description" : "Group of Network Peering connection settings.", + "properties" : { + "containerId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud network container that contains the specified network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "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" : { + "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.", + "maxLength" : 30, + "minLength" : 6, + "pattern" : "^[a-z][0-9a-z-]{4,28}[0-9a-z]{1}" + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the network peering connection.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "networkName" : { + "type" : "string", + "description" : "Human-readable label that identifies the network to peer with the MongoDB Cloud VPC.", + "maxLength" : 63, + "minLength" : 1, + "pattern" : "[a-z]([-a-z0-9]{0,62}[a-z0-9]{0,1})?" + }, + "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.", + "enum" : [ "ADDING_PEER", "WAITING_FOR_USER", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true + } + }, + "required" : [ "containerId", "gcpProjectId", "networkName" ], + "title" : "GCP" + }, + "GCPRegionConfig" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "GCP Regional Replication Specifications" + }, + "GCPRegionConfig20240805" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20240805" + }, { + "type" : "object", + "properties" : { + "analyticsAutoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "analyticsSpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" + }, + "autoScaling" : { + "$ref" : "#/components/schemas/AdvancedAutoScalingSettings" + }, + "readOnlySpecs" : { + "$ref" : "#/components/schemas/DedicatedHardwareSpec20240805" + } + } + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "GCP Regional Replication Specifications" + }, + "GeoSharding" : { + "type" : "object", + "properties" : { + "customZoneMapping" : { + "type" : "object", + "additionalProperties" : { + "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `id` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `id` property.\n\nThis 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.", + "items" : { + "$ref" : "#/components/schemas/ManagedNamespaces" + }, + "readOnly" : true + }, + "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 + } + } + }, + "GeoSharding20240805" : { + "type" : "object", + "properties" : { + "customZoneMapping" : { + "type" : "object", + "additionalProperties" : { + "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.\n\nThis parameter returns an empty object if no custom zones exist.", + "readOnly" : true + }, + "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.\n\n The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property.\n\nThis 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.", + "items" : { + "$ref" : "#/components/schemas/ManagedNamespaces" + }, + "readOnly" : true + }, + "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 + } + } + }, + "GoogleCloudKMS" : { + "type" : "object", + "description" : "Details that define the configuration of Encryption at Rest using Google Cloud Key Management Service (KMS).", + "externalDocs" : { + "description" : "Google Cloud Key Management Service", + "url" : "https://www.mongodb.com/docs/atlas/security-gcp-kms/" + }, + "properties" : { + "enabled" : { + "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" + }, + "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.", + "externalDocs" : { + "description" : "Google Cloud Authentication", + "url" : "https://cloud.google.com/docs/authentication/getting-started" + }, + "writeOnly" : true + }, + "valid" : { + "type" : "boolean", + "description" : "Flag that indicates whether the Google Cloud Key Management Service (KMS) encryption key can encrypt and decrypt data.", + "readOnly" : true + } + } + }, + "GreaterThanDaysThresholdView" : { + "type" : "object", + "description" : "Threshold value that triggers an alert.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "GREATER_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "DAYS" ] + } + } + }, + "GreaterThanRawThreshold" : { + "type" : "object", + "description" : "A Limit that triggers an alert when greater than a number.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "GREATER_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/RawMetricUnits" + } + }, + "title" : "Greater Than Raw Threshold" + }, + "GreaterThanRawThresholdAlertConfigViewForNdsGroup" : { + "type" : "object", + "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the **eventTypeName** specifies an event for a host, replica set, or sharded cluster.", + "items" : { + "$ref" : "#/components/schemas/ReplicaSetMatcher" + } + }, + "notifications" : { + "type" : "array", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", + "items" : { + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "threshold" : { + "$ref" : "#/components/schemas/GreaterThanRawThreshold" + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + } + }, + "required" : [ "eventTypeName", "notifications" ] + }, + "GreaterThanTimeThreshold" : { + "type" : "object", + "description" : "A Limit that triggers an alert when greater than a time period.", + "properties" : { + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "GREATER_THAN" ] + }, + "threshold" : { + "type" : "integer", + "format" : "int32", + "description" : "Value of metric that, when exceeded, triggers an alert." + }, + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "title" : "Greater Than Time Threshold" + }, + "Group" : { + "type" : "object", + "properties" : { + "clusterCount" : { + "type" : "integer", + "format" : "int64", + "description" : "Quantity of MongoDB Cloud clusters deployed in this project.", + "readOnly" : true + }, + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this project. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the project included in the MongoDB Cloud organization.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud organization to which the project belongs.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "regionUsageRestrictions" : { + "type" : "string", + "default" : "COMMERCIAL_FEDRAMP_REGIONS_ONLY", + "description" : "Applies to Atlas for Government only.\n\nIn Commercial Atlas, this field will be rejected in requests and missing in responses.\n\nThis field sets restrictions on available regions in the project.\n\n| Value | Available Regions |\n|-----------------------------------|------------|\n| `COMMERCIAL_FEDRAMP_REGIONS_ONLY` | Only allows deployments in FedRAMP Moderate regions.|\n| `GOV_REGIONS_ONLY` | Only allows deployments in GovCloud regions.|", + "enum" : [ "COMMERCIAL_FEDRAMP_REGIONS_ONLY", "GOV_REGIONS_ONLY" ], + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/government/overview/supported-regions/#supported-cloud-providers-and-regions" + } + }, + "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" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "withDefaultAlertsSettings" : { + "type" : "boolean", + "description" : "Flag that indicates whether to create the project with default alert settings.", + "writeOnly" : true + } + }, + "required" : [ "clusterCount", "created", "name", "orgId" ] + }, + "GroupAlertsConfig" : { + "type" : "object", + "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/StreamProcessorAlertConfigViewForNdsGroup" + } ] + }, + "GroupIPAddresses" : { + "type" : "object", + "description" : "List of IP addresses in a project.", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "services" : { + "$ref" : "#/components/schemas/GroupService" + } + }, + "title" : "Group IP Address" + }, + "GroupInvitation" : { + "type" : "object", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud sent the invitation. This parameter expresses its value in ISO 8601 format in UTC.", + "readOnly" : true + }, + "expiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud expires the invitation. This parameter expresses its value in ISO 8601 format in UTC.", "readOnly" : true }, "groupId" : { @@ -37905,22 +41440,27 @@ "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "pattern" : "^([a-f0-9]{24})$" }, "destinationOrgPrivateApiKey" : { "type" : "string", - "description" : "Unique string that identifies the private part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.", + "description" : "Unique string that identifies the private part of the API Key used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.", "example" : "55c3bbb6-b4bb-0be1-e66d20841f3e", - "readOnly" : true + "externalDocs" : { + "description" : "Grant Programmatic Access to Atlas", + "url" : "https://dochub.mongodb.org/core/atlas-create-prog-api-key" + } }, "destinationOrgPublicApiKey" : { "type" : "string", - "description" : "Unique string that identifies the public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.", + "description" : "Unique string that identifies the public part of the API Key used to verify access to the destination organization. This parameter is required only when you authenticate with Programmatic API Keys.", "example" : "zmmrboas", + "externalDocs" : { + "description" : "Grant Programmatic Access to Atlas", + "url" : "https://dochub.mongodb.org/core/atlas-create-prog-api-key" + }, "maxLength" : 8, - "minLength" : 8, - "readOnly" : true + "minLength" : 8 } } }, @@ -37987,7 +41527,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/EventViewForNdsGroup" }, @@ -38020,6 +41560,28 @@ } } }, + "GroupRoleAssignment" : { + "type" : "object", + "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project to which these roles belong.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "groupRoles" : { + "type" : "array", + "description" : "One or more project level roles assigned to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_OWNER", "GROUP_CLUSTER_MANAGER", "GROUP_STREAM_PROCESSING_OWNER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR" ] + }, + "uniqueItems" : true + } + } + }, "GroupService" : { "type" : "object", "description" : "List of IP addresses in a project categorized by services.", @@ -38039,37 +41601,37 @@ "GroupServiceAccount" : { "type" : "object", "properties" : { + "clientId" : { + "type" : "string", + "description" : "The Client ID of the Service Account.", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + }, "createdAt" : { "type" : "string", "format" : "date-time", - "description" : "Service account creation time." + "description" : "The date that the Service Account was created on." }, "description" : { "type" : "string", - "description" : "Description of the service account." - }, - "id" : { - "type" : "string", - "description" : "ID for the service account.", - "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + "description" : "Human readable description for the Service Account." }, "name" : { "type" : "string", - "description" : "Name for service account." + "description" : "Human-readable name for the Service Account." }, "roles" : { "type" : "array", - "description" : "Roles assigned to the Service Account group.", + "description" : "A list of Project roles associated with the Service Account.", "items" : { "type" : "string", - "description" : "Project roles associated with the service account.", + "description" : "Project roles available for Service Accounts.", "enum" : [ "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" ] }, "uniqueItems" : true }, "secrets" : { "type" : "array", - "description" : "List of secrets.", + "description" : "A list of secrets associated with the specified Service Account.", "items" : { "$ref" : "#/components/schemas/ServiceAccountSecret" }, @@ -38082,73 +41644,74 @@ "properties" : { "description" : { "type" : "string", - "description" : "Human readable description for the service account.", + "description" : "Human readable description for the Service Account.", "maxLength" : 250, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "name" : { "type" : "string", - "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "description" : "Human-readable name for the Service Account. The name is modifiable and does not have to be unique.", "maxLength" : 64, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "roles" : { "type" : "array", - "description" : "Project roles associated with the service account.", + "description" : "A list of project-level roles for the Service Account.", "items" : { "type" : "string", - "description" : "Project roles associated with the service account.", + "description" : "Project roles available for Service Accounts.", "enum" : [ "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" ] } }, "secretExpiresAfterHours" : { "type" : "integer", "format" : "int32", - "description" : "Secret expiration time." + "description" : "The expiration time of the new Service Account secret. The expiration is provided in hours." } }, - "required" : [ "description", "name", "secretExpiresAfterHours" ] + "required" : [ "description", "name", "roles", "secretExpiresAfterHours" ] }, "GroupServiceAccountRoleAssignment" : { "type" : "object", "properties" : { "roles" : { "type" : "array", - "description" : "Group access roles.", + "description" : "The Project permissions for the Service Account in the specified Project.", "items" : { "type" : "string", - "description" : "Project roles associated with the service account.", + "description" : "Project roles available for Service Accounts.", "enum" : [ "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" ] }, "uniqueItems" : true } - } + }, + "required" : [ "roles" ] }, "GroupServiceAccountUpdateRequest" : { "type" : "object", "properties" : { "description" : { "type" : "string", - "description" : "Human readable description for the service account.", + "description" : "Human readable description for the Service Account.", "maxLength" : 250, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "name" : { "type" : "string", - "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "description" : "Human-readable name for the Service Account. The name is modifiable and does not have to be unique.", "maxLength" : 64, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "roles" : { "type" : "array", - "description" : "Project roles associated with the service account.", + "description" : "A list of Project roles associated with the Service Account.", "items" : { "type" : "string", - "description" : "Project roles associated with the service account.", + "description" : "Project roles available for Service Accounts.", "enum" : [ "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" ] } } @@ -38392,7 +41955,7 @@ "example" : "cluster1", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -38487,14 +42050,14 @@ "HostEventTypeViewForNdsGroup" : { "type" : "string", "description" : "Unique identifier of event type.", - "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_ENOUGH_DISK_SPACE", "HOST_NOT_ENOUGH_DISK_SPACE" ], + "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_ENOUGH_DISK_SPACE", "HOST_NOT_ENOUGH_DISK_SPACE" ], "example" : "HOST_DOWN", "title" : "Host Event Types" }, "HostEventTypeViewForNdsGroupAlertable" : { "type" : "string", "description" : "Event type that triggers an alert.", - "enum" : [ "HOST_DOWN", "HOST_HAS_INDEX_SUGGESTIONS", "HOST_MONGOT_CRASHING_OOM", "HOST_NOT_ENOUGH_DISK_SPACE" ], + "enum" : [ "HOST_DOWN", "HOST_HAS_INDEX_SUGGESTIONS", "HOST_MONGOT_CRASHING_OOM", "HOST_MONGOT_STOP_REPLICATION", "HOST_NOT_ENOUGH_DISK_SPACE" ], "example" : "HOST_DOWN", "title" : "Host Event Types" }, @@ -38780,6 +42343,7 @@ "OPCOUNTER_REPL_INSERT" : "#/components/schemas/RawMetricAlertView", "OPCOUNTER_REPL_UPDATE" : "#/components/schemas/RawMetricAlertView", "OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricAlertView", + "OPERATIONS_QUERIES_KILLED" : "#/components/schemas/RawMetricAlertView", "OPERATIONS_SCAN_AND_ORDER" : "#/components/schemas/RawMetricAlertView", "OPERATION_THROTTLING_REJECTED_OPERATIONS" : "#/components/schemas/RawMetricAlertView", "OPLOG_MASTER_LAG_TIME_DIFF" : "#/components/schemas/TimeMetricAlertView", @@ -38849,7 +42413,7 @@ "example" : "cluster1", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -39158,6 +42722,7 @@ "OPCOUNTER_REPL_INSERT" : "#/components/schemas/RawMetricEventView", "OPCOUNTER_REPL_UPDATE" : "#/components/schemas/RawMetricEventView", "OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricEventView", + "OPERATIONS_QUERIES_KILLED" : "#/components/schemas/RawMetricEventView", "OPERATIONS_SCAN_AND_ORDER" : "#/components/schemas/RawMetricEventView", "OPERATION_THROTTLING_REJECTED_OPERATIONS" : "#/components/schemas/RawMetricEventView", "OPLOG_MASTER_LAG_TIME_DIFF" : "#/components/schemas/TimeMetricEventView", @@ -39463,6 +43028,7 @@ "OPCOUNTER_REPL_INSERT" : "#/components/schemas/RawMetricThresholdView", "OPCOUNTER_REPL_UPDATE" : "#/components/schemas/RawMetricThresholdView", "OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "OPERATIONS_QUERIES_KILLED" : "#/components/schemas/RawMetricThresholdView", "OPERATIONS_SCAN_AND_ORDER" : "#/components/schemas/RawMetricThresholdView", "OPERATION_THROTTLING_REJECTED_OPERATIONS" : "#/components/schemas/RawMetricThresholdView", "OPLOG_MASTER_LAG_TIME_DIFF" : "#/components/schemas/TimeMetricThresholdView", @@ -39509,7 +43075,9 @@ "enum" : [ "AVERAGE" ] }, "operator" : { - "$ref" : "#/components/schemas/Operator" + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, "threshold" : { "type" : "number", @@ -39861,7 +43429,7 @@ "description" : "Human-readable label that identifies the cluster that incurred the charge.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -39915,7 +43483,7 @@ "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.", - "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_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", "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_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_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" ], + "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_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", "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_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_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_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" ], "readOnly" : true }, "startDate" : { @@ -40205,6 +43773,323 @@ "description" : "Configuration of nodes that comprise the cluster.", "enum" : [ "REPLICASET", "SHARDED", "GEOSHARDED" ] }, + "configServerManagementMode" : { + "type" : "string", + "default" : "ATLAS_MANAGED", + "description" : "Config Server Management Mode for creating or updating a sharded cluster.\n\nWhen configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings.\n\nWhen configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server.", + "enum" : [ "ATLAS_MANAGED", "FIXED_TO_DEDICATED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + } + }, + "configServerType" : { + "type" : "string", + "description" : "Describes a sharded cluster's config server type.", + "enum" : [ "DEDICATED", "EMBEDDED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + }, + "readOnly" : true + }, + "connectionStrings" : { + "$ref" : "#/components/schemas/ClusterConnectionStrings" + }, + "createDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "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.", + "maximum" : 4096, + "minimum" : 10 + }, + "diskWarmingMode" : { + "type" : "string", + "default" : "FULLY_WARMED", + "description" : "Disk warming mode selection.", + "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], + "externalDocs" : { + "description" : "Reduce Secondary Disk Warming Impact", + "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" + } + }, + "encryptionAtRestProvider" : { + "type" : "string", + "description" : "Cloud service provider that manages your customer keys to provide an additional layer of Encryption at Rest for the cluster.", + "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], + "externalDocs" : { + "description" : "Encryption at Rest using Customer Key Management", + "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" + } + }, + "featureCompatibilityVersion" : { + "type" : "string", + "description" : "Feature compatibility version of the cluster.", + "readOnly" : true + }, + "featureCompatibilityVersionExpirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Feature compatibility version expiration date.", + "readOnly" : true + }, + "globalClusterSelfManagedSharding" : { + "type" : "boolean", + "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen 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.\n\nWhen 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.\n\nThis 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" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "labels" : { + "type" : "array", + "deprecated" : true, + "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", + "items" : { + "$ref" : "#/components/schemas/ComponentLabel" + } + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "mongoDBEmployeeAccessGrant" : { + "$ref" : "#/components/schemas/EmployeeAccessGrantView" + }, + "mongoDBMajorVersion" : { + "type" : "string", + "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", + "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-" + } + }, + "mongoDBVersion" : { + "type" : "string", + "description" : "Version of MongoDB that the cluster runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)" + }, + "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.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "mongoURIUpdated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated the connection string. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "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.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + }, + "numShards" : { + "type" : "integer", + "format" : "int32", + "default" : 1, + "description" : "Number of shards up to 50 to deploy for a sharded cluster. The resource returns `1` to indicate a replica set and values of `2` and higher to indicate a sharded cluster. The returned value equals the number of shards in the cluster.", + "externalDocs" : { + "description" : "Sharding", + "url" : "https://docs.mongodb.com/manual/sharding/" + }, + "maximum" : 50, + "minimum" : 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", + "default" : "WORKLOAD_TYPE", + "description" : "Set this field to configure the replica set scaling mode for your cluster.\n\nBy default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes.\n\nWhen configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads.\n\nWhen configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads.", + "enum" : [ "SEQUENTIAL", "WORKLOAD_TYPE", "NODE_TYPE" ], + "externalDocs" : { + "description" : "Modify the Replica Set Scaling Mode", + "url" : "https://dochub.mongodb.org/core/scale-nodes" + } + }, + "replicationFactor" : { + "type" : "integer", + "format" : "int32", + "default" : 3, + "deprecated" : true, + "description" : "Number of members that belong to the replica set. Each member retains a copy of your databases, providing high availability and data redundancy. Use **replicationSpecs** instead.", + "enum" : [ 3, 5, 7 ] + }, + "replicationSpec" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/RegionSpec" + }, + "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", + "title" : "Region Configuration" + }, + "replicationSpecs" : { + "type" : "array", + "description" : "List of settings that configure your cluster regions.\n\n- For Global Clusters, each object in the array represents one zone where MongoDB Cloud deploys your clusters nodes.\n- For non-Global sharded clusters and replica sets, the single object represents where MongoDB Cloud deploys your clusters nodes.", + "items" : { + "$ref" : "#/components/schemas/LegacyReplicationSpec" + } + }, + "rootCertType" : { + "type" : "string", + "default" : "ISRGROOTX1", + "description" : "Root Certificate Authority that MongoDB Atlas clusters uses. MongoDB Cloud supports Internet Security Research Group.", + "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.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true + }, + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the cluster.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "externalDocs" : { + "description" : "Resource Tags", + "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" + }, + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + }, + "versionReleaseSystem" : { + "type" : "string", + "default" : "LTS", + "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", + "enum" : [ "LTS", "CONTINUOUS" ] + } + }, + "title" : "Cluster Description" + }, + "LegacyAtlasTenantClusterUpgradeRequest" : { + "type" : "object", + "description" : "Request containing target state of tenant cluster to be upgraded", + "properties" : { + "acceptDataRisksAndForceReplicaSetReconfig" : { + "type" : "string", + "format" : "date-time", + "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", + "externalDocs" : { + "description" : "Reconfiguring a Replica Set during a regional outage", + "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + } + }, + "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", + "default" : "ATLAS_MANAGED", + "description" : "Config Server Management Mode for creating or updating a sharded cluster.\n\nWhen configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings.\n\nWhen configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server.", + "enum" : [ "ATLAS_MANAGED", "FIXED_TO_DEDICATED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + } + }, + "configServerType" : { + "type" : "string", + "description" : "Describes a sharded cluster's config server type.", + "enum" : [ "DEDICATED", "EMBEDDED" ], + "externalDocs" : { + "description" : "MongoDB Sharded Cluster Config Servers", + "url" : "https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers" + }, + "readOnly" : true + }, "connectionStrings" : { "$ref" : "#/components/schemas/ClusterConnectionStrings" }, @@ -40240,6 +44125,17 @@ "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" } }, + "featureCompatibilityVersion" : { + "type" : "string", + "description" : "Feature compatibility version of the cluster.", + "readOnly" : true + }, + "featureCompatibilityVersionExpirationDate" : { + "type" : "string", + "format" : "date-time", + "description" : "Feature compatibility version expiration date.", + "readOnly" : true + }, "globalClusterSelfManagedSharding" : { "type" : "boolean", "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen 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.\n\nWhen 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.\n\nThis setting cannot be changed once the cluster is deployed.", @@ -40286,6 +44182,9 @@ }, "readOnly" : true }, + "mongoDBEmployeeAccessGrant" : { + "$ref" : "#/components/schemas/EmployeeAccessGrantView" + }, "mongoDBMajorVersion" : { "type" : "string", "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", @@ -40328,7 +44227,7 @@ "description" : "Human-readable label that identifies the cluster.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, "numShards" : { "type" : "integer", @@ -40361,259 +44260,16 @@ "providerSettings" : { "$ref" : "#/components/schemas/ClusterProviderSettings" }, - "replicationFactor" : { - "type" : "integer", - "format" : "int32", - "default" : 3, - "deprecated" : true, - "description" : "Number of members that belong to the replica set. Each member retains a copy of your databases, providing high availability and data redundancy. Use **replicationSpecs** instead.", - "enum" : [ 3, 5, 7 ] - }, - "replicationSpec" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/RegionSpec" - }, - "description" : "Physical location where MongoDB Cloud provisions cluster nodes.", - "title" : "Region Configuration" - }, - "replicationSpecs" : { - "type" : "array", - "description" : "List of settings that configure your cluster regions.\n\n- For Global Clusters, each object in the array represents one zone where MongoDB Cloud deploys your clusters nodes.\n- For non-Global sharded clusters and replica sets, the single object represents where MongoDB Cloud deploys your clusters nodes.", - "items" : { - "$ref" : "#/components/schemas/LegacyReplicationSpec" - } - }, - "rootCertType" : { - "type" : "string", - "default" : "ISRGROOTX1", - "description" : "Root Certificate Authority that MongoDB Atlas clusters uses. MongoDB Cloud supports Internet Security Research Group.", - "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.", - "externalDocs" : { - "description" : "Connection string URI format.", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, - "readOnly" : true - }, - "stateName" : { + "replicaSetScalingStrategy" : { "type" : "string", - "description" : "Human-readable label that indicates the current operating condition of the cluster.", - "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], - "readOnly" : true - }, - "tags" : { - "type" : "array", - "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.", + "default" : "WORKLOAD_TYPE", + "description" : "Set this field to configure the replica set scaling mode for your cluster.\n\nBy default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes.\n\nWhen configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads.\n\nWhen configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads.", + "enum" : [ "SEQUENTIAL", "WORKLOAD_TYPE", "NODE_TYPE" ], "externalDocs" : { - "description" : "Resource Tags", - "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" - }, - "items" : { - "$ref" : "#/components/schemas/ResourceTag" - } - }, - "terminationProtectionEnabled" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." - }, - "versionReleaseSystem" : { - "type" : "string", - "default" : "LTS", - "description" : "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**.", - "enum" : [ "LTS", "CONTINUOUS" ] - } - }, - "title" : "Cluster Description" - }, - "LegacyAtlasTenantClusterUpgradeRequest" : { - "type" : "object", - "description" : "Request containing target state of tenant cluster to be upgraded", - "properties" : { - "acceptDataRisksAndForceReplicaSetReconfig" : { - "type" : "string", - "format" : "date-time", - "description" : "If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set **acceptDataRisksAndForceReplicaSetReconfig** to the current date.", - "externalDocs" : { - "description" : "Reconfiguring a Replica Set during a regional outage", - "url" : "https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set" + "description" : "Modify the Replica Set Scaling Mode", + "url" : "https://dochub.mongodb.org/core/scale-nodes" } }, - "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" ] - }, - "connectionStrings" : { - "$ref" : "#/components/schemas/ClusterConnectionStrings" - }, - "createDate" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", - "readOnly" : true - }, - "diskSizeGB" : { - "type" : "number", - "format" : "double", - "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.", - "maximum" : 4096, - "minimum" : 10 - }, - "diskWarmingMode" : { - "type" : "string", - "default" : "FULLY_WARMED", - "description" : "Disk warming mode selection.", - "enum" : [ "FULLY_WARMED", "VISIBLE_EARLIER" ], - "externalDocs" : { - "description" : "Reduce Secondary Disk Warming Impact", - "url" : "https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact" - } - }, - "encryptionAtRestProvider" : { - "type" : "string", - "description" : "Cloud service provider that manages your customer keys to provide an additional layer of Encryption at Rest for the cluster.", - "enum" : [ "NONE", "AWS", "AZURE", "GCP" ], - "externalDocs" : { - "description" : "Encryption at Rest using Customer Key Management", - "url" : "https://www.mongodb.com/docs/atlas/security-kms-encryption/" - } - }, - "globalClusterSelfManagedSharding" : { - "type" : "boolean", - "description" : "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen 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.\n\nWhen 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.\n\nThis 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" : { - "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the project.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the cluster.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "labels" : { - "type" : "array", - "deprecated" : true, - "description" : "Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead.", - "items" : { - "$ref" : "#/components/schemas/ComponentLabel" - } - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - }, - "mongoDBMajorVersion" : { - "type" : "string", - "description" : "MongoDB major version of the cluster.\n\nOn creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for [project LTS versions endpoint](#tag/Projects/operation/getProjectLTSVersions).\n\n On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.", - "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-" - } - }, - "mongoDBVersion" : { - "type" : "string", - "description" : "Version of MongoDB that the cluster runs.", - "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)" - }, - "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.", - "externalDocs" : { - "description" : "Connection string URI format.", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, - "readOnly" : true - }, - "mongoURIUpdated" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when someone last updated the connection string. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", - "readOnly" : true - }, - "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.", - "externalDocs" : { - "description" : "Connection string URI format.", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "Human-readable label that identifies the cluster.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - }, - "numShards" : { - "type" : "integer", - "format" : "int32", - "default" : 1, - "description" : "Number of shards up to 50 to deploy for a sharded cluster. The resource returns `1` to indicate a replica set and values of `2` and higher to indicate a sharded cluster. The returned value equals the number of shards in the cluster.", - "externalDocs" : { - "description" : "Sharding", - "url" : "https://docs.mongodb.com/manual/sharding/" - }, - "maximum" : 50, - "minimum" : 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" - }, "replicationFactor" : { "type" : "integer", "format" : "int32", @@ -41160,6 +44816,10 @@ "type" : "string", "enum" : [ "INSTANCE_NAME", "PROCESSOR_NAME" ], "title" : "Streams Matcher Fields" + }, { + "type" : "string", + "enum" : [ "RULE_ID" ], + "title" : "Log Ingestion Matcher Fields" } ] }, "MatcherHostType" : { @@ -41810,7 +45470,7 @@ "NDSAuditTypeViewForNdsGroup" : { "type" : "string", "description" : "Unique identifier of event type.", - "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_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_SSL_ROTATED", "CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER", "CLUSTER_INSTANCE_SSL_REVOKED", "RELOAD_SSL_ON_PROCESSES", "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", "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", "MOVE_SKIPPED", "PROXY_RESTARTED", "PROXY_PANICKED", "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", "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", "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", "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", "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", "PENDING_INDEXES_DELETED", "PENDING_INDEXES_CANCELED", "PROCESS_RESTART_REQUESTED", "AUTO_HEALING_ACTION", "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", "CLUSTER_FORCE_RECONFIG_REQUESTED", "PROJECT_BYPASSED_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", "ATLAS_SQL_SCHEDULED_UPDATE_CREATED", "ATLAS_SQL_SCHEDULED_UPDATE_MODIFIED", "ATLAS_SQL_SCHEDULED_UPDATE_REMOVED" ], + "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_SSL_ROTATED", "CLUSTER_INSTANCE_SSL_ROTATED_PER_CLUSTER", "CLUSTER_INSTANCE_SSL_REVOKED", "RELOAD_SSL_ON_PROCESSES", "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", "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", "MOVE_SKIPPED", "PROXY_RESTARTED", "PROXY_PANICKED", "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", "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", "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", "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", "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", "CLUSTER_FORCE_RECONFIG_REQUESTED", "PROJECT_BYPASSED_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" ], "example" : "CLUSTER_CREATED", "title" : "NDS Audit Types" }, @@ -42707,7 +46367,7 @@ "example" : "cluster1", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -42949,7 +46609,9 @@ "enum" : [ "AVERAGE" ] }, "operator" : { - "$ref" : "#/components/schemas/Operator" + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, "threshold" : { "type" : "number", @@ -43133,6 +46795,54 @@ "required" : [ "typeName" ], "title" : "OpsGenie Notification" }, + "OrgActiveUserResponse" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OrgUserResponse" + }, { + "type" : "object", + "properties" : { + "country" : { + "type" : "string", + "description" : "Two alphabet characters that identifies MongoDB Cloud user's geographic location. This parameter uses the ISO 3166-1a2 code format.", + "example" : "US", + "pattern" : "^([A-Z]{2})$", + "readOnly" : true + }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the current account. This value is in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "firstName" : { + "type" : "string", + "description" : "First or given name that belongs to the MongoDB Cloud user.", + "example" : "John", + "readOnly" : true + }, + "lastAuth" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the current account last authenticated. This value is in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "lastName" : { + "type" : "string", + "description" : "Last name, family name, or surname that belongs to the MongoDB Cloud user.", + "example" : "Doe", + "readOnly" : true + }, + "mobileNumber" : { + "type" : "string", + "description" : "Mobile phone number that belongs to the MongoDB Cloud user.", + "pattern" : "(?:(?:\\\\+?1\\\\s*(?:[.-]\\\\s*)?)?(?:(\\\\s*([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9])\\\\s*)|([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9]))\\\\s*(?:[.-]\\\\s*)?)([2-9]1[02-9]|[2-9][02-9]1|[2-9][02-9]{2})\\\\s*(?:[.-]\\\\s*)?([0-9]{4})$", + "readOnly" : true + } + } + } ], + "required" : [ "createdAt", "firstName", "id", "lastName", "orgMembershipStatus", "roles", "username" ] + }, "OrgEventTypeViewForOrg" : { "type" : "string", "description" : "Unique identifier of event type.", @@ -43414,7 +47124,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/EventViewForOrg" }, @@ -43429,40 +47139,69 @@ } } }, + "OrgPendingUserResponse" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/OrgUserResponse" + }, { + "type" : "object", + "properties" : { + "invitationCreatedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud sent the invitation. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "invitationExpiresAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when the invitation from MongoDB Cloud expires. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true + }, + "inviterUsername" : { + "type" : "string", + "format" : "email", + "description" : "Username of the MongoDB Cloud user who sent the invitation to join the organization.", + "readOnly" : true + } + } + } ], + "required" : [ "id", "invitationCreatedAt", "invitationExpiresAt", "inviterUsername", "orgMembershipStatus", "roles", "username" ] + }, "OrgServiceAccount" : { "type" : "object", "properties" : { + "clientId" : { + "type" : "string", + "description" : "The Client ID of the Service Account.", + "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + }, "createdAt" : { "type" : "string", "format" : "date-time", - "description" : "Service account creation time." + "description" : "The date that the Service Account was created on." }, "description" : { "type" : "string", - "description" : "Description of the service account." - }, - "id" : { - "type" : "string", - "description" : "ID for the service account.", - "pattern" : "^mdb_sa_id_[a-fA-F\\d]{24}$" + "description" : "Human readable description for the Service Account." }, "name" : { "type" : "string", - "description" : "Name for service account." + "description" : "Human-readable name for the Service Account." }, "roles" : { "type" : "array", - "description" : "Organization roles assigned to the Service Account.", + "description" : "A list of Organization roles associated with the Service Account.", "items" : { "type" : "string", - "description" : "Organization roles associated with the service account.", + "description" : "Organization roles available for Service Accounts.", "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] }, "uniqueItems" : true }, "secrets" : { "type" : "array", - "description" : "List of secrets.", + "description" : "A list of secrets associated with the specified Service Account.", "items" : { "$ref" : "#/components/schemas/ServiceAccountSecret" }, @@ -43475,63 +47214,215 @@ "properties" : { "description" : { "type" : "string", - "description" : "Human readable description for the service account.", + "description" : "Human readable description for the Service Account.", "maxLength" : 250, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "name" : { "type" : "string", - "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "description" : "Human-readable name for the Service Account. The name is modifiable and does not have to be unique.", "maxLength" : 64, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "roles" : { "type" : "array", - "description" : "Organization roles associated with the service account.", + "description" : "A list of organization-level roles for the Service Account.", "items" : { "type" : "string", - "description" : "Organization roles associated with the service account.", + "description" : "Organization roles available for Service Accounts.", "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] } }, "secretExpiresAfterHours" : { "type" : "integer", "format" : "int32", - "description" : "Secret expiration time." + "description" : "The expiration time of the new Service Account secret. The expiration is provided in hours." } }, - "required" : [ "description", "name", "secretExpiresAfterHours" ] + "required" : [ "description", "name", "roles", "secretExpiresAfterHours" ] }, "OrgServiceAccountUpdateRequest" : { "type" : "object", "properties" : { "description" : { "type" : "string", - "description" : "Human readable description for the service account.", + "description" : "Human readable description for the Service Account.", "maxLength" : 250, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "name" : { "type" : "string", - "description" : "Human-readable name for the service account. The name is modifiable and does not have to be unique.", + "description" : "Human-readable name for the Service Account. The name is modifiable and does not have to be unique.", "maxLength" : 64, "minLength" : 1, "pattern" : "^[\\p{L}\\p{N}\\-_.,' ]*$" }, "roles" : { "type" : "array", - "description" : "Organization roles associated with the Service account.", + "description" : "A list of organization-level roles for the Service Account.", "items" : { "type" : "string", - "description" : "Organization roles associated with the service account.", + "description" : "Organization roles available for Service Accounts.", "enum" : [ "ORG_MEMBER", "ORG_READ_ONLY", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_GROUP_CREATOR", "ORG_OWNER" ] } } } }, + "OrgUserRequest" : { + "type" : "object", + "properties" : { + "roles" : { + "$ref" : "#/components/schemas/OrgUserRolesRequest" + }, + "teamIds" : { + "type" : "array", + "description" : "List of unique 24-hexadecimal digit strings that identifies the teams to which this MongoDB Cloud user belongs.", + "items" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "uniqueItems" : true, + "writeOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address that represents the username of the MongoDB Cloud user.", + "writeOnly" : true + } + }, + "required" : [ "roles", "username" ] + }, + "OrgUserResponse" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "ACTIVE" : "#/components/schemas/OrgActiveUserResponse", + "PENDING" : "#/components/schemas/OrgPendingUserResponse" + }, + "propertyName" : "orgMembershipStatus" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/OrgPendingUserResponse" + }, { + "$ref" : "#/components/schemas/OrgActiveUserResponse" + } ], + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the MongoDB Cloud user.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "orgMembershipStatus" : { + "type" : "string", + "description" : "String enum that indicates whether the MongoDB Cloud user has a pending invitation to join the organization or they are already active in the organization.", + "enum" : [ "PENDING", "ACTIVE" ], + "readOnly" : true + }, + "roles" : { + "$ref" : "#/components/schemas/OrgUserRolesResponse" + }, + "teamIds" : { + "type" : "array", + "description" : "List of unique 24-hexadecimal digit strings that identifies the teams to which this MongoDB Cloud user belongs.", + "items" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "readOnly" : true, + "uniqueItems" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address that represents the username of the MongoDB Cloud user.", + "readOnly" : true + } + }, + "required" : [ "id", "orgMembershipStatus", "roles", "username" ] + }, + "OrgUserRolesRequest" : { + "type" : "object", + "description" : "Organization and project level roles to assign the MongoDB Cloud user within one organization.", + "properties" : { + "groupRoleAssignments" : { + "type" : "array", + "description" : "List of project level role assignments to assign the MongoDB Cloud user.", + "items" : { + "$ref" : "#/components/schemas/GroupRoleAssignment" + } + }, + "orgRoles" : { + "type" : "array", + "description" : "One or more organization level roles to assign the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_READ_ONLY", "ORG_MEMBER" ] + }, + "minItems" : 1, + "uniqueItems" : true + } + }, + "required" : [ "orgRoles" ], + "writeOnly" : true + }, + "OrgUserRolesResponse" : { + "type" : "object", + "description" : "Organization and project level roles assigned to one MongoDB Cloud user within one organization.", + "properties" : { + "groupRoleAssignments" : { + "type" : "array", + "description" : "List of project level role assignments assigned to the MongoDB Cloud user.", + "items" : { + "$ref" : "#/components/schemas/GroupRoleAssignment" + } + }, + "orgRoles" : { + "type" : "array", + "description" : "One or more organization level roles assigned to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "ORG_OWNER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_READ_ONLY", "ORG_MEMBER" ] + }, + "uniqueItems" : true + } + }, + "readOnly" : true + }, + "OrgUserUpdateRequest" : { + "type" : "object", + "properties" : { + "roles" : { + "$ref" : "#/components/schemas/OrgUserRolesRequest" + }, + "teamIds" : { + "type" : "array", + "description" : "List of unique 24-hexadecimal digit strings that identifies the teams to assign the MongoDB Cloud user.", + "items" : { + "type" : "string", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "uniqueItems" : true, + "writeOnly" : true + } + } + }, "OrganizationInvitation" : { "type" : "object", "properties" : { @@ -43736,7 +47627,7 @@ }, "restrictEmployeeAccess" : { "type" : "boolean", - "description" : "Flag that indicates whether to block MongoDB Support from accessing Atlas infrastructure 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/." + "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/." } } }, @@ -43883,7 +47774,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/AdvancedClusterDescription" }, @@ -43915,7 +47806,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/GroupAlertsConfig" }, @@ -43947,7 +47838,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/AlertViewForNdsGroup" }, @@ -43979,7 +47870,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ApiKeyUserDetails" }, @@ -44011,7 +47902,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/CloudAppUser" }, @@ -44043,7 +47934,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ApiAtlasCheckpointView" }, @@ -44076,7 +47967,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/CloudDatabaseUser" }, @@ -44108,7 +47999,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/DiskBackupExportJob" }, @@ -44140,7 +48031,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/EARPrivateEndpoint" }, @@ -44155,7 +48046,7 @@ } } }, - "PaginatedApiAtlasProviderRegionsView" : { + "PaginatedApiAtlasFlexBackupRestoreJob20250101View" : { "type" : "object", "properties" : { "links" : { @@ -44172,9 +48063,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/CloudProviderRegions" + "$ref" : "#/components/schemas/FlexBackupRestoreJob20250101" }, "readOnly" : true }, @@ -44187,7 +48078,7 @@ } } }, - "PaginatedApiAtlasServerlessBackupRestoreJobView" : { + "PaginatedApiAtlasFlexBackupSnapshot20240710View" : { "type" : "object", "properties" : { "links" : { @@ -44204,9 +48095,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" + "$ref" : "#/components/schemas/FlexBackupSnapshot20250101" }, "readOnly" : true }, @@ -44219,7 +48110,7 @@ } } }, - "PaginatedApiAtlasServerlessBackupSnapshotView" : { + "PaginatedApiAtlasProviderRegionsView" : { "type" : "object", "properties" : { "links" : { @@ -44236,9 +48127,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/ServerlessBackupSnapshot" + "$ref" : "#/components/schemas/CloudProviderRegions" }, "readOnly" : true }, @@ -44251,7 +48142,7 @@ } } }, - "PaginatedApiAtlasUSSBackupRestoreJob20250101View" : { + "PaginatedApiAtlasServerlessBackupRestoreJobView" : { "type" : "object", "properties" : { "links" : { @@ -44268,9 +48159,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/USSBackupRestoreJob20250101" + "$ref" : "#/components/schemas/ServerlessBackupRestoreJob" }, "readOnly" : true }, @@ -44283,7 +48174,7 @@ } } }, - "PaginatedApiAtlasUSSBackupSnapshot20240710View" : { + "PaginatedApiAtlasServerlessBackupSnapshotView" : { "type" : "object", "properties" : { "links" : { @@ -44300,9 +48191,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/USSBackupSnapshot20250101" + "$ref" : "#/components/schemas/ServerlessBackupSnapshot" }, "readOnly" : true }, @@ -44332,7 +48223,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/BillingInvoiceMetadata" }, @@ -44364,7 +48255,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/BillingInvoice" }, @@ -44396,7 +48287,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/StreamsConnection" }, @@ -44411,6 +48302,38 @@ } } }, + "PaginatedApiStreamsPrivateLinkView" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", + "items" : { + "$ref" : "#/components/schemas/StreamsPrivateLinkConnection" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, "PaginatedApiStreamsStreamProcessorWithStatsView" : { "type" : "object", "properties" : { @@ -44428,7 +48351,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/StreamsProcessorWithStats" }, @@ -44460,7 +48383,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/StreamsTenant" }, @@ -44492,7 +48415,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/UserAccessListResponse" }, @@ -44507,6 +48430,38 @@ } } }, + "PaginatedApiVersions" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", + "items" : { + "$ref" : "#/components/schemas/ApiVersion" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, "PaginatedAppUserView" : { "type" : "object", "properties" : { @@ -44524,7 +48479,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/CloudAppUser" }, @@ -44556,7 +48511,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/Group" }, @@ -44588,7 +48543,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/MdbAvailableVersion" }, @@ -44620,7 +48575,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/DiskBackupSnapshotAWSExportBucket" }, @@ -44652,7 +48607,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/DiskBackupSnapshotExportBucket" }, @@ -44684,7 +48639,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/DiskBackupSnapshot" }, @@ -44716,7 +48671,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/DiskBackupReplicaSet" }, @@ -44748,7 +48703,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/DiskBackupSnapshotRestoreJob" }, @@ -44780,7 +48735,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/DiskBackupShardedClusterSnapshot" }, @@ -44813,7 +48768,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/CloudProviderContainer" }, @@ -44846,7 +48801,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ClusterDescription20240805" }, @@ -44878,7 +48833,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ConnectedOrgConfig" }, @@ -44911,7 +48866,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/BaseNetworkPeeringConnectionSettings" }, @@ -44943,7 +48898,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/MesurementsDatabase" }, @@ -44975,7 +48930,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/MeasurementDiskPartition" }, @@ -45007,7 +48962,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/EventTypeDetails" }, @@ -45039,7 +48994,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/FederationIdentityProvider" }, @@ -45054,9 +49009,41 @@ } } }, + "PaginatedFlexClusters20250101" : { + "type" : "object", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "results" : { + "type" : "array", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", + "items" : { + "type" : "object" + }, + "readOnly" : true + }, + "totalCount" : { + "type" : "integer", + "format" : "int32", + "description" : "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`.", + "minimum" : 0, + "readOnly" : true + } + } + }, "PaginatedGroupServiceAccounts" : { "type" : "object", - "description" : "List of Service Accounts", + "description" : "A list of Project Service Accounts.", "properties" : { "links" : { "type" : "array", @@ -45072,7 +49059,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/GroupServiceAccount" }, @@ -45104,7 +49091,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ApiHostView_Atlas" }, @@ -45136,7 +49123,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ThirdPartyIntegration" }, @@ -45168,7 +49155,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/LegacyAtlasCluster" }, @@ -45200,7 +49187,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/NetworkPermissionEntry" }, @@ -45232,7 +49219,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/BackupOnlineArchive" }, @@ -45264,7 +49251,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/OrgGroup" }, @@ -45281,7 +49268,7 @@ }, "PaginatedOrgServiceAccounts" : { "type" : "object", - "description" : "List of Service Accounts", + "description" : "A list of Organization Service Accounts.", "properties" : { "links" : { "type" : "array", @@ -45297,7 +49284,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/OrgServiceAccount" }, @@ -45329,7 +49316,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/AtlasOrganization" }, @@ -45361,7 +49348,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/IngestionPipelineRun" }, @@ -45393,7 +49380,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/PrivateNetworkEndpointIdEntry" }, @@ -45425,7 +49412,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/PublicApiUsageDetailsLineItemView" }, @@ -45457,7 +49444,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/BackupRestoreJob" }, @@ -45490,7 +49477,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/AuthFederationRoleMapping" }, @@ -45522,7 +49509,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ServerlessInstanceDescription" }, @@ -45539,7 +49526,7 @@ }, "PaginatedServiceAccountGroup" : { "type" : "object", - "description" : "List of Service Account projects.", + "description" : "A list of projects associated with the Service Account.", "properties" : { "links" : { "type" : "array", @@ -45555,7 +49542,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/ServiceAccountGroup" }, @@ -45570,7 +49557,7 @@ } } }, - "PaginatedSnapshotView" : { + "PaginatedServiceAccountIPAccessEntryView" : { "type" : "object", "properties" : { "links" : { @@ -45587,9 +49574,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/BackupSnapshot" + "$ref" : "#/components/schemas/ServiceAccountIPAccessListEntry" }, "readOnly" : true }, @@ -45602,7 +49589,7 @@ } } }, - "PaginatedTeamRoleView" : { + "PaginatedSnapshotView" : { "type" : "object", "properties" : { "links" : { @@ -45619,9 +49606,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/TeamRole" + "$ref" : "#/components/schemas/BackupSnapshot" }, "readOnly" : true }, @@ -45634,7 +49621,7 @@ } } }, - "PaginatedTeamView" : { + "PaginatedTeamRoleView" : { "type" : "object", "properties" : { "links" : { @@ -45651,9 +49638,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/TeamResponse" + "$ref" : "#/components/schemas/TeamRole" }, "readOnly" : true }, @@ -45666,7 +49653,7 @@ } } }, - "PaginatedTenantRestoreView" : { + "PaginatedTeamView" : { "type" : "object", "properties" : { "links" : { @@ -45683,9 +49670,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/TenantRestore" + "$ref" : "#/components/schemas/TeamResponse" }, "readOnly" : true }, @@ -45698,7 +49685,7 @@ } } }, - "PaginatedTenantSnapshotView" : { + "PaginatedTenantRestoreView" : { "type" : "object", "properties" : { "links" : { @@ -45715,9 +49702,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "$ref" : "#/components/schemas/BackupTenantSnapshot" + "$ref" : "#/components/schemas/TenantRestore" }, "readOnly" : true }, @@ -45730,7 +49717,7 @@ } } }, - "PaginatedUSSInstance20250101" : { + "PaginatedTenantSnapshotView" : { "type" : "object", "properties" : { "links" : { @@ -45747,9 +49734,9 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { - "type" : "object" + "$ref" : "#/components/schemas/BackupTenantSnapshot" }, "readOnly" : true }, @@ -45779,7 +49766,7 @@ }, "results" : { "type" : "array", - "description" : "List of returned documents that MongoDB Cloud providers when completing this request.", + "description" : "List of returned documents that MongoDB Cloud provides when completing this request.", "items" : { "$ref" : "#/components/schemas/UserCert" }, @@ -46286,6 +50273,14 @@ "PrivateNetworkEndpointIdEntry" : { "type" : "object", "properties" : { + "azureConnectionName" : { + "type" : "string", + "description" : "Connection name that identifies the Azure private endpoint connection." + }, + "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." @@ -46294,6 +50289,11 @@ "type" : "string", "description" : "Human-readable label to identify customer's VPC endpoint DNS name." }, + "customerEndpointIPAddress" : { + "type" : "string", + "description" : "IP address used to connect to the Azure private endpoint.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + }, "endpointId" : { "type" : "string", "description" : "Unique 22-character alphanumeric string that identifies the private endpoint.", @@ -46306,6 +50306,10 @@ "minLength" : 22, "pattern" : "^vpce-[0-9a-f]{17}$" }, + "errorMessage" : { + "type" : "string", + "description" : "Error message describing a failure approving the private endpoint request." + }, "provider" : { "type" : "string", "default" : "AWS", @@ -46316,6 +50320,11 @@ "type" : "string", "description" : "Human-readable label to identify the region of customer's VPC endpoint." }, + "status" : { + "type" : "string", + "description" : "Status of the private endpoint connection request.", + "enum" : [ "PENDING", "OK", "FAILED", "DELETING" ] + }, "type" : { "type" : "string", "default" : "DATA_LAKE", @@ -46372,20 +50381,6 @@ "required" : [ "enabled", "serviceDiscovery", "username" ], "title" : "PROMETHEUS" }, - "ProxyInfo" : { - "type" : "object", - "description" : "VPC Proxy Information.", - "properties" : { - "authKey" : { - "type" : "string", - "description" : "Authentication key for the proxy." - }, - "dnsName" : { - "type" : "string", - "description" : "DNS name to use to reach the proxy/s." - } - } - }, "PublicApiUsageDetailsLineItemView" : { "type" : "object", "properties" : { @@ -46483,7 +50478,9 @@ "enum" : [ "AVERAGE" ] }, "operator" : { - "$ref" : "#/components/schemas/Operator" + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, "threshold" : { "type" : "number", @@ -46531,7 +50528,7 @@ "example" : "cluster1", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -46773,7 +50770,9 @@ "enum" : [ "AVERAGE" ] }, "operator" : { - "$ref" : "#/components/schemas/Operator" + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, "threshold" : { "type" : "number", @@ -46951,7 +50950,7 @@ "example" : "cluster1", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, "created" : { @@ -47231,472 +51230,69 @@ } }, "zoneName" : { - "type" : "string", - "description" : "Human-readable label that identifies the zone in a Global Cluster. Provide this value only if `\"clusterType\" : \"GEOSHARDED\"`." - } - }, - "title" : "Replication Specifications" - }, - "ReplicationSpec20240805" : { - "type" : "object", - "description" : "Details that explain how MongoDB Cloud replicates data on the specified MongoDB database.", - "properties" : { - "id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a shard in a Cluster. If you include existing shard replication configurations in the request, you must specify this parameter. If you add a new shard to an existing Cluster, you may specify this parameter. The request deletes any existing shards in the Cluster that you exclude from the request.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "regionConfigs" : { - "type" : "array", - "description" : "Hardware specifications for nodes set for a given region. 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**.\n\n**Example:**\n\nIf you set `\"replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize\" : \"M30\"`, set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : `\"M30\"` if you have electable nodes and `\"replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize\" : `\"M30\"` if you have read-only nodes.", - "items" : { - "$ref" : "#/components/schemas/CloudRegionConfig20240805" - } - }, - "zoneId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the zone in a Global Cluster. This value can be used to configure Global Cluster backup policies.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "zoneName" : { - "type" : "string", - "description" : "Human-readable label that describes the zone this shard belongs to in a Global Cluster. Provide this value only if \"clusterType\" : \"GEOSHARDED\" but not \"selfManagedSharding\" : true." - } - }, - "title" : "Replication Specifications" - }, - "RequestAccepted" : { - "type" : "object", - "description" : "Accepted" - }, - "ResourceEventTypeView" : { - "type" : "string", - "description" : "Unique identifier of event type.", - "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], - "example" : "TAGS_MODIFIED", - "title" : "Resource Event Types" - }, - "ResourceEventTypeViewForOrg" : { - "type" : "string", - "description" : "Unique identifier of event type.", - "enum" : [ "GROUP_TAGS_MODIFIED" ], - "example" : "GROUP_TAGS_MODIFIED", - "title" : "Resource Event Types" - }, - "ResourceEventViewForNdsGroup" : { - "type" : "object", - "description" : "Resource event reflects different activities about resources.", - "properties" : { - "apiKeyId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "created" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true - }, - "eventTypeName" : { - "$ref" : "#/components/schemas/ResourceEventTypeView" - }, - "groupId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "isGlobalAdmin" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", - "readOnly" : true - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - }, - "orgId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "publicKey" : { - "type" : "string", - "format" : "email", - "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "example" : "test.user@mongodb.com", - "readOnly" : true - }, - "raw" : { - "$ref" : "#/components/schemas/raw" - }, - "remoteAddress" : { - "type" : "string", - "description" : "IPv4 or IPv6 address from which the user triggered this event.", - "example" : "216.172.40.186", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", - "readOnly" : true - }, - "resourceId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the resource associated with the event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "resourceType" : { - "type" : "string", - "description" : "Unique identifier of resource type.", - "example" : "cluster" - }, - "userId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "username" : { - "type" : "string", - "format" : "email", - "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", - "example" : "test.user@mongodb.com", - "readOnly" : true - } - }, - "required" : [ "created", "eventTypeName", "id", "resourceType" ], - "title" : "Resource Events" - }, - "ResourceEventViewForOrg" : { - "type" : "object", - "description" : "Resource event reflects different activities about resources.", - "properties" : { - "apiKeyId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "created" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true - }, - "eventTypeName" : { - "$ref" : "#/components/schemas/ResourceEventTypeViewForOrg" - }, - "groupId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "isGlobalAdmin" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", - "readOnly" : true - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - }, - "orgId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "publicKey" : { - "type" : "string", - "format" : "email", - "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "example" : "test.user@mongodb.com", - "readOnly" : true - }, - "raw" : { - "$ref" : "#/components/schemas/raw" - }, - "remoteAddress" : { - "type" : "string", - "description" : "IPv4 or IPv6 address from which the user triggered this event.", - "example" : "216.172.40.186", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", - "readOnly" : true - }, - "resourceId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the resource associated with the event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "resourceType" : { - "type" : "string", - "description" : "Unique identifier of resource type.", - "example" : "cluster" - }, - "userId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "username" : { - "type" : "string", - "format" : "email", - "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", - "example" : "test.user@mongodb.com", - "readOnly" : true - } - }, - "required" : [ "created", "eventTypeName", "id", "resourceType" ], - "title" : "Resource Events" - }, - "ResourceTag" : { - "type" : "object", - "description" : "Key-value pair that tags and categorizes a MongoDB Cloud organization, project, or cluster. For example, `environment : production`.", - "properties" : { - "key" : { - "type" : "string", - "description" : "Constant that defines the set of the tag. For example, `environment` in the `environment : production` tag.", - "maxLength" : 255, - "minLength" : 1 - }, - "value" : { - "type" : "string", - "description" : "Variable that belongs to the set of the tag. For example, `production` in the `environment : production` tag.", - "maxLength" : 255, - "minLength" : 1 - } - }, - "required" : [ "key", "value" ], - "title" : "Resource Tag" - }, - "RestoreJobFileHash" : { - "type" : "object", - "description" : "Key and value pair that map one restore file to one hashed checksum. This parameter applies after you download the corresponding **delivery.url**.", - "properties" : { - "fileName" : { - "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.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - }, - "typeName" : { - "type" : "string", - "description" : "Human-readable label that identifies the hashing algorithm used to compute the hash value.", - "enum" : [ "SHA1" ], - "readOnly" : true - } - }, - "readOnly" : true - }, - "RoleAssignment" : { - "type" : "object", - "properties" : { - "groupId" : { - "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", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" - }, - "orgId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization to which this role belongs. Each element within **roleAssignments** can have a value for **orgId** or **groupId**, but not both.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" - }, - "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.\n\nOrganization Roles\n\n* ORG_OWNER\n* ORG_MEMBER\n* ORG_GROUP_CREATOR\n* ORG_BILLING_ADMIN\n* ORG_READ_ONLY\n\nProject Roles\n\n* GROUP_CLUSTER_MANAGER\n* GROUP_DATA_ACCESS_ADMIN\n* GROUP_DATA_ACCESS_READ_ONLY\n* GROUP_DATA_ACCESS_READ_WRITE\n* GROUP_OWNER\n* GROUP_READ_ONLY\n* GROUP_SEARCH_INDEX_EDITOR\n* GROUP_STREAM_PROCESSING_OWNER\n\n", - "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] - } - } - }, - "SMSNotification" : { - "type" : "object", - "description" : "SMS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", - "properties" : { - "delayMin" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." - }, - "intervalMin" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", - "minimum" : 5 - }, - "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" : { - "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" ] + "type" : "string", + "description" : "Human-readable label that identifies the zone in a Global Cluster. Provide this value only if `\"clusterType\" : \"GEOSHARDED\"`." } }, - "required" : [ "typeName" ], - "title" : "SMS Notification" + "title" : "Replication Specifications" }, - "SampleDatasetStatus" : { + "ReplicationSpec20240805" : { "type" : "object", + "description" : "Details that explain how MongoDB Cloud replicates data on the specified MongoDB database.", "properties" : { - "_id" : { + "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies this sample dataset.", + "description" : "Unique 24-hexadecimal digit string that identifies the replication object for a shard in a Cluster. If you include existing shard replication configurations in the request, you must specify this parameter. If you add a new shard to an existing Cluster, you may specify this parameter. The request deletes any existing shards in the Cluster that you exclude from the request.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "clusterName" : { - "type" : "string", - "description" : "Human-readable label that identifies the cluster into which you loaded the sample dataset.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "readOnly" : true - }, - "completeDate" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when the sample dataset load job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", - "readOnly" : true - }, - "createDate" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when you started the sample dataset load job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", - "readOnly" : true + "regionConfigs" : { + "type" : "array", + "description" : "Hardware specifications for nodes set for a given region. 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**.\n\n**Example:**\n\nIf you set `\"replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize\" : \"M30\"`, set `\"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize\" : `\"M30\"` if you have electable nodes and `\"replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize\" : `\"M30\"` if you have read-only nodes.", + "items" : { + "$ref" : "#/components/schemas/CloudRegionConfig20240805" + } }, - "errorMessage" : { + "zoneId" : { "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.", + "description" : "Unique 24-hexadecimal digit string that identifies the zone in a Global Cluster. This value can be used to configure Global Cluster backup policies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "state" : { + "zoneName" : { "type" : "string", - "description" : "Status of the sample dataset load job.", - "enum" : [ "WORKING", "FAILED", "COMPLETED" ], - "readOnly" : true + "description" : "Human-readable label that describes the zone this shard belongs to in a Global Cluster. Provide this value only if \"clusterType\" : \"GEOSHARDED\" but not \"selfManagedSharding\" : true." } - } + }, + "title" : "Replication Specifications" }, - "SearchDeploymentAuditTypeView" : { + "RequestAccepted" : { + "type" : "object", + "description" : "Accepted" + }, + "ResourceEventTypeView" : { "type" : "string", "description" : "Unique identifier of event type.", - "enum" : [ "SEARCH_DEPLOYMENT_CREATED", "SEARCH_DEPLOYMENT_UPDATED", "SEARCH_DEPLOYMENT_DELETED" ], - "example" : "SEARCH_DEPLOYMENT_CREATED", - "title" : "Search Deployment Audit Types" + "enum" : [ "TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], + "example" : "TAGS_MODIFIED", + "title" : "Resource Event Types" }, - "SearchDeploymentAuditView" : { + "ResourceEventTypeViewForOrg" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "GROUP_TAGS_MODIFIED" ], + "example" : "GROUP_TAGS_MODIFIED", + "title" : "Resource Event Types" + }, + "ResourceEventViewForNdsGroup" : { "type" : "object", - "description" : "Indicates activities on decoupled search nodes.", + "description" : "Resource event reflects different activities about resources.", "properties" : { "apiKeyId" : { "type" : "string", @@ -47714,7 +51310,7 @@ "readOnly" : true }, "eventTypeName" : { - "$ref" : "#/components/schemas/SearchDeploymentAuditTypeView" + "$ref" : "#/components/schemas/ResourceEventTypeView" }, "groupId" : { "type" : "string", @@ -47765,6 +51361,7 @@ "type" : "string", "format" : "email", "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true }, "raw" : { @@ -47777,6 +51374,20 @@ "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", "readOnly" : true }, + "resourceId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the resource associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "resourceType" : { + "type" : "string", + "description" : "Unique identifier of resource type.", + "example" : "cluster" + }, "userId" : { "type" : "string", "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", @@ -47794,541 +51405,159 @@ "readOnly" : true } }, - "required" : [ "created", "eventTypeName", "id" ], - "title" : "Search Deployment Audits" - }, - "SearchHostStatusDetail" : { - "type" : "object", - "properties" : { - "hostname" : { - "type" : "string", - "description" : "Hostname that corresponds to the status detail." - }, - "mainIndex" : { - "$ref" : "#/components/schemas/SearchMainIndexStatusDetail" - }, - "queryable" : { - "type" : "boolean", - "description" : "Flag that indicates whether the index is queryable on the host." - }, - "stagedIndex" : { - "$ref" : "#/components/schemas/SearchStagedIndexStatusDetail" - }, - "status" : { - "type" : "string", - "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", - "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] - } - }, - "title" : "Search Host Status Detail" - }, - "SearchIndex" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/ClusterSearchIndex" - }, { - "type" : "object", - "properties" : { - "analyzer" : { - "type" : "string", - "default" : "lucene.standard", - "description" : "Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves a variety of changes made to the text in fields:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\n MongoDB Cloud uses the selected process to build the Atlas Search index.", - "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ], - "externalDocs" : { - "description" : "Atlas Search Analyzers", - "url" : "https://dochub.mongodb.org/core/analyzers--fts" - } - }, - "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" - }, - "items" : { - "$ref" : "#/components/schemas/ApiAtlasFTSAnalyzersViewManual" - } - }, - "mappings" : { - "$ref" : "#/components/schemas/ApiAtlasFTSMappingsViewManual" - }, - "searchAnalyzer" : { - "type" : "string", - "default" : "lucene.standard", - "description" : "Method applied to identify words when searching this index.", - "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] - }, - "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" - }, - "items" : { - "$ref" : "#/components/schemas/SearchSynonymMappingDefinition" - } - } - } - } ], - "required" : [ "collectionName", "database", "name" ] - }, - "SearchIndexCreateRequest" : { - "type" : "object", - "discriminator" : { - "mapping" : { - "search" : "#/components/schemas/TextSearchIndexCreateRequest", - "vectorSearch" : "#/components/schemas/VectorSearchIndexCreateRequest" - }, - "propertyName" : "type" - }, - "properties" : { - "collectionName" : { - "type" : "string", - "description" : "Label that identifies the collection to create an Atlas Search index in." - }, - "database" : { - "type" : "string", - "description" : "Label that identifies the database that contains the collection to create an Atlas Search index in." - }, - "name" : { - "type" : "string", - "description" : "Label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique." - }, - "type" : { - "type" : "string", - "description" : "Type of the index. The default type is search.", - "enum" : [ "search", "vectorSearch" ] - } - }, - "required" : [ "collectionName", "database", "name" ] - }, - "SearchIndexDefinition" : { - "type" : "object", - "description" : "The search index definition set by the user.", - "title" : "Search Index Definition" - }, - "SearchIndexDefinitionVersion" : { - "type" : "object", - "description" : "Object which includes the version number of the index definition and the time that the index definition was created.", - "properties" : { - "createdAt" : { - "type" : "string", - "format" : "date-time", - "description" : "The time at which this index definition was created." - }, - "version" : { - "type" : "integer", - "format" : "int64", - "description" : "The version number associated with this index definition when it was created." - } - }, - "title" : "Search Index Definition Version" + "required" : [ "created", "eventTypeName", "id", "resourceType" ], + "title" : "Resource Events" }, - "SearchIndexResponse" : { + "ResourceEventViewForOrg" : { "type" : "object", - "discriminator" : { - "mapping" : { - "search" : "#/components/schemas/TextSearchIndexResponse", - "vectorSearch" : "#/components/schemas/VectorSearchIndexResponse" - }, - "propertyName" : "type" - }, + "description" : "Resource event reflects different activities about resources.", "properties" : { - "collectionName" : { - "type" : "string", - "description" : "Label that identifies the collection that contains one or more Atlas Search indexes." - }, - "database" : { - "type" : "string", - "description" : "Label that identifies the database that contains the collection with one or more Atlas Search indexes." - }, - "indexID" : { + "apiKeyId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies this Atlas Search index.", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" - }, - "latestDefinition" : { - "$ref" : "#/components/schemas/SearchIndexDefinition" - }, - "latestDefinitionVersion" : { - "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" - }, - "name" : { - "type" : "string", - "description" : "Label that identifies this index. Within each namespace, the names of all indexes must be unique." - }, - "queryable" : { - "type" : "boolean", - "description" : "Flag that indicates whether the index is queryable on all hosts." - }, - "status" : { - "type" : "string", - "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", - "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] - }, - "statusDetail" : { - "type" : "array", - "description" : "List of documents detailing index status on each host.", - "items" : { - "$ref" : "#/components/schemas/SearchHostStatusDetail" - } - }, - "type" : { - "type" : "string", - "description" : "Type of the index. The default type is search.", - "enum" : [ "search", "vectorSearch" ] - } - }, - "title" : "Search Index Response" - }, - "SearchIndexUpdateRequest" : { - "type" : "object", - "properties" : { - "definition" : { - "type" : "object", - "description" : "The index definition to update the search index to.", - "oneOf" : [ { - "$ref" : "#/components/schemas/TextSearchIndexDefinition" - }, { - "$ref" : "#/components/schemas/VectorSearchIndexDefinition" - } ] - } - }, - "required" : [ "definition" ], - "title" : "Search Index Update Request" - }, - "SearchMainIndexStatusDetail" : { - "type" : "object", - "description" : "Contains status information about the active index.", - "properties" : { - "definition" : { - "$ref" : "#/components/schemas/SearchIndexDefinition" - }, - "definitionVersion" : { - "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" - }, - "message" : { - "type" : "string", - "description" : "Optional message describing an error." - }, - "queryable" : { - "type" : "boolean", - "description" : "Flag that indicates whether the index generation is queryable on the host." - }, - "status" : { - "type" : "string", - "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", - "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] - } - }, - "title" : "Search Main Index Status Detail" - }, - "SearchMappings" : { - "type" : "object", - "description" : "Index specifications for the collection's fields.", - "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/field-mapping-definition-fts#static-and-dynamic-mappings" - } - }, - "fields" : { - "type" : "object", - "additionalProperties" : { - "type" : "object", - "description" : "One or more field specifications for the Atlas Search index. Required if **mappings.dynamic** is omitted or set to **false**.", - "externalDocs" : { - "description" : "Atlas Search Index", - "url" : "https://dochub.mongodb.org/core/index-definitions-fts" - }, - "x-additionalPropertiesName" : "Field Name" - }, - "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" - }, - "x-additionalPropertiesName" : "Field Name" - } - }, - "title" : "Mappings" - }, - "SearchStagedIndexStatusDetail" : { - "type" : "object", - "description" : "Contains status information about an index building in the background.", - "properties" : { - "definition" : { - "$ref" : "#/components/schemas/SearchIndexDefinition" - }, - "definitionVersion" : { - "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" - }, - "message" : { - "type" : "string", - "description" : "Optional message describing an error." - }, - "queryable" : { - "type" : "boolean", - "description" : "Flag that indicates whether the index generation is queryable on the host." + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "status" : { - "type" : "string", - "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", - "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] - } - }, - "title" : "Search Staged Index Status Detail" - }, - "SearchSynonymMappingDefinition" : { - "type" : "object", - "description" : "Synonyms used for this full text index.", - "properties" : { - "analyzer" : { + "created" : { "type" : "string", - "description" : "Specific pre-defined method chosen to apply to the synonyms to be searched.", - "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true }, - "name" : { - "type" : "string", - "description" : "Label that identifies the synonym definition. Each **synonym.name** must be unique within the same index definition." + "eventTypeName" : { + "$ref" : "#/components/schemas/ResourceEventTypeViewForOrg" }, - "source" : { - "$ref" : "#/components/schemas/SynonymSource" - } - }, - "required" : [ "analyzer", "name", "source" ], - "title" : "Synonym Mapping Definition" - }, - "ServerlessAWSTenantEndpoint" : { - "type" : "object", - "description" : "View for a serverless AWS tenant endpoint.", - "properties" : { - "_id" : { + "groupId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "cloudProviderEndpointId" : { - "type" : "string", - "description" : "Unique string that identifies the private endpoint's network interface.", - "pattern" : "^vpce-[0-9a-f]{17}$", - "readOnly" : true - }, - "comment" : { - "type" : "string", - "description" : "Human-readable comment associated with the private endpoint.", - "maxLength" : 80, - "readOnly" : true - }, - "endpointServiceName" : { + "id" : { "type" : "string", - "description" : "Unique string that identifies the Amazon Web Services (AWS) PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", - "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "errorMessage" : { - "type" : "string", - "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", "readOnly" : true }, - "providerName" : { - "type" : "string", - "description" : "Human-readable label that identifies the cloud service provider.", - "enum" : [ "AWS" ], + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, "readOnly" : true }, - "status" : { - "type" : "string", - "description" : "Human-readable label that indicates the current operating status of the private endpoint.", - "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], - "readOnly" : true - } - }, - "title" : "AWS" - }, - "ServerlessAWSTenantEndpointUpdate" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" - }, { - "type" : "object", - "properties" : { - "cloudProviderEndpointId" : { - "type" : "string", - "description" : "Unique string that identifies the private endpoint's network interface.", - "pattern" : "^vpce-[0-9a-f]{17}$", - "writeOnly" : true - } - } - } ], - "description" : "Updates to a serverless AWS tenant endpoint.", - "required" : [ "providerName" ], - "title" : "AWS" - }, - "ServerlessAzureTenantEndpoint" : { - "type" : "object", - "description" : "View for a serverless Azure tenant endpoint.", - "properties" : { - "_id" : { + "orgId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "cloudProviderEndpointId" : { - "type" : "string", - "description" : "Unique string that identifies the Azure private endpoint's network interface that someone added to this private endpoint service.", - "pattern" : "^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\\.Network/privateEndpoints/[-\\w._()]+$", - "readOnly" : true - }, - "comment" : { + "publicKey" : { "type" : "string", - "description" : "Human-readable comment associated with the private endpoint.", - "maxLength" : 80, + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true }, - "endpointServiceName" : { - "type" : "string", - "description" : "Unique string that identifies the Azure private endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", - "pattern" : "^pls_[0-9a-f]{24}$", - "readOnly" : true + "raw" : { + "$ref" : "#/components/schemas/raw" }, - "errorMessage" : { + "remoteAddress" : { "type" : "string", - "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", "readOnly" : true }, - "privateEndpointIpAddress" : { + "resourceId" : { "type" : "string", - "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "description" : "Unique 24-hexadecimal digit string that identifies the resource associated with the event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "privateLinkServiceResourceId" : { + "resourceType" : { "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 + "description" : "Unique identifier of resource type.", + "example" : "cluster" }, - "providerName" : { + "userId" : { "type" : "string", - "description" : "Human-readable label that identifies the cloud service provider.", - "enum" : [ "AZURE" ], + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "status" : { + "username" : { "type" : "string", - "description" : "Human-readable label that indicates the current operating status of the private endpoint.", - "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true } }, - "title" : "Azure" - }, - "ServerlessAzureTenantEndpointUpdate" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" - }, { - "type" : "object", - "properties" : { - "cloudProviderEndpointId" : { - "type" : "string", - "description" : "Unique string that identifies the Azure private endpoint's network interface for this private endpoint service.", - "pattern" : "^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\\.Network/privateEndpoints/[-\\w._()]+$", - "writeOnly" : true - }, - "privateEndpointIpAddress" : { - "type" : "string", - "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", - "writeOnly" : true - } - } - } ], - "description" : "Updates to a serverless Azure tenant endpoint.", - "required" : [ "providerName" ], - "title" : "AZURE" + "required" : [ "created", "eventTypeName", "id", "resourceType" ], + "title" : "Resource Events" }, - "ServerlessBackupRestoreJob" : { + "ResourceTag" : { "type" : "object", + "description" : "Key-value pair that tags and categorizes a MongoDB Cloud organization, project, or cluster. For example, `environment : production`.", "properties" : { - "cancelled" : { - "type" : "boolean", - "description" : "Flag that indicates whether someone canceled this restore job.", - "readOnly" : true - }, - "deliveryType" : { + "key" : { "type" : "string", - "description" : "Human-readable label that categorizes the restore job to create.", - "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\"`.", - "items" : { - "type" : "string", - "description" : "One Uniform Resource Locator that point to the compressed snapshot files for manual download." - }, - "readOnly" : true - }, - "desiredTimestamp" : { - "$ref" : "#/components/schemas/ApiBSONTimestampView" - }, - "expired" : { - "type" : "boolean", - "description" : "Flag that indicates whether the restore job expired.", - "readOnly" : true + "description" : "Constant that defines the set of the tag. For example, `environment` in the `environment : production` tag.", + "maxLength" : 255, + "minLength" : 1 }, - "expiresAt" : { + "value" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when the restore job expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true - }, - "failed" : { - "type" : "boolean", - "description" : "Flag that indicates whether the restore job failed.", - "readOnly" : true - }, - "finishedAt" : { + "description" : "Variable that belongs to the set of the tag. For example, `production` in the `environment : production` tag.", + "maxLength" : 255, + "minLength" : 1 + } + }, + "required" : [ "key", "value" ], + "title" : "Resource Tag" + }, + "RestoreJobFileHash" : { + "type" : "object", + "description" : "Key and value pair that map one restore file to one hashed checksum. This parameter applies after you download the corresponding **delivery.url**.", + "properties" : { + "fileName" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when the restore job completed. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Human-readable label that identifies the hashed file.", "readOnly" : true }, - "id" : { + "hash" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the restore job.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "description" : "Hashed checksum that maps to the restore file.", "readOnly" : true }, "links" : { @@ -48343,87 +51572,173 @@ }, "readOnly" : true }, - "oplogInc" : { - "type" : "integer", - "format" : "int32", - "description" : "Oplog operation number from which you want to restore this snapshot. This number represents the second part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", - "example" : 1, - "minimum" : 1 + "typeName" : { + "type" : "string", + "description" : "Human-readable label that identifies the hashing algorithm used to compute the hash value.", + "enum" : [ "SHA1" ], + "readOnly" : true + } + }, + "readOnly" : true + }, + "RoleAssignment" : { + "type" : "object", + "properties" : { + "groupId" : { + "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", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" }, - "oplogTs" : { + "orgId" : { + "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", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "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.\n\nOrganization Roles\n\n* ORG_OWNER\n* ORG_MEMBER\n* ORG_GROUP_CREATOR\n* ORG_BILLING_ADMIN\n* ORG_READ_ONLY\n\nProject Roles\n\n* GROUP_CLUSTER_MANAGER\n* GROUP_DATA_ACCESS_ADMIN\n* GROUP_DATA_ACCESS_READ_ONLY\n* GROUP_DATA_ACCESS_READ_WRITE\n* GROUP_OWNER\n* GROUP_READ_ONLY\n* GROUP_SEARCH_INDEX_EDITOR\n* GROUP_STREAM_PROCESSING_OWNER\n\n", + "enum" : [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_READ_ONLY", "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY", "GROUP_SEARCH_INDEX_EDITOR", "GROUP_STREAM_PROCESSING_OWNER" ] + } + } + }, + "SMSNotification" : { + "type" : "object", + "description" : "SMS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "properties" : { + "delayMin" : { "type" : "integer", "format" : "int32", - "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`.", - "minimum" : 1199145600 + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." }, - "pointInTimeUTCSeconds" : { + "intervalMin" : { "type" : "integer", "format" : "int32", - "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`.", - "minimum" : 1199145600 + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 }, - "snapshotId" : { + "mobileNumber" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "description" : "Mobile phone number to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"SMS\"`.", + "example" : "1233337892" + }, + "notifierId" : { + "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" ] + } + }, + "required" : [ "typeName" ], + "title" : "SMS Notification" + }, + "SampleDatasetStatus" : { + "type" : "object", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies this sample dataset.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "targetClusterName" : { + "clusterName" : { "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\"`.", + "description" : "Human-readable label that identifies the cluster into which you loaded the sample dataset.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "readOnly" : true }, - "targetGroupId" : { + "completeDate" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the target project for the specified **targetClusterName**.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" + "format" : "date-time", + "description" : "Date and time when the sample dataset load job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true }, - "timestamp" : { + "createDate" : { "type" : "string", "format" : "date-time", - "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.", + "description" : "Date and time when you started the sample dataset load job. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "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.", + "enum" : [ "WORKING", "FAILED", "COMPLETED" ], "readOnly" : true } - }, - "required" : [ "deliveryType", "targetClusterName", "targetGroupId" ] + } }, - "ServerlessBackupSnapshot" : { + "SearchDeploymentAuditTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "SEARCH_DEPLOYMENT_CREATED", "SEARCH_DEPLOYMENT_UPDATED", "SEARCH_DEPLOYMENT_DELETED" ], + "example" : "SEARCH_DEPLOYMENT_CREATED", + "title" : "Search Deployment Audit Types" + }, + "SearchDeploymentAuditView" : { "type" : "object", + "description" : "Indicates activities on decoupled search nodes.", "properties" : { - "createdAt" : { + "apiKeyId" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "expiresAt" : { + "created" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "frequencyType" : { + "eventTypeName" : { + "$ref" : "#/components/schemas/SearchDeploymentAuditTypeView" + }, + "groupId" : { "type" : "string", - "description" : "Human-readable label that identifies how often this snapshot triggers.", - "enum" : [ "hourly", "daily", "weekly", "monthly" ], + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, "links" : { "type" : "array", "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", @@ -48436,450 +51751,445 @@ }, "readOnly" : true }, - "mongodVersion" : { + "orgId" : { "type" : "string", - "description" : "Version of the MongoDB host that this snapshot backs up.", - "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "serverlessInstanceName" : { + "publicKey" : { "type" : "string", - "description" : "Human-readable label given to the serverless instance from which MongoDB Cloud took this snapshot.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", "readOnly" : true }, - "snapshotType" : { + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { "type" : "string", - "description" : "Human-readable label that identifies when this snapshot triggers.", - "enum" : [ "onDemand", "scheduled" ], + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", "readOnly" : true }, - "status" : { + "userId" : { "type" : "string", - "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", - "enum" : [ "queued", "inProgress", "completed", "failed" ], + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "storageSizeBytes" : { - "type" : "integer", - "format" : "int64", - "description" : "Number of bytes taken to store the backup snapshot.", + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true } - } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Search Deployment Audits" }, - "ServerlessConnectionStringsPrivateEndpointItem" : { + "SearchHostStatusDetail" : { "type" : "object", - "description" : "Details of a private endpoint deployed for this serverless instance.", "properties" : { - "endpointId" : { + "hostname" : { "type" : "string", - "description" : "Unique string that the cloud provider uses to identify the private endpoint.", - "readOnly" : true + "description" : "Hostname that corresponds to the status detail." }, - "providerName" : { - "type" : "string", - "description" : "Cloud provider where the private endpoint is deployed.", - "enum" : [ "AWS", "AZURE" ], - "readOnly" : true + "mainIndex" : { + "$ref" : "#/components/schemas/SearchMainIndexStatusDetail" }, - "region" : { + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on the host." + }, + "stagedIndex" : { + "$ref" : "#/components/schemas/SearchStagedIndexStatusDetail" + }, + "status" : { "type" : "string", - "description" : "Region where the private endpoint is deployed.", - "readOnly" : true + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] } }, - "title" : "Serverless Instance Private Endpoint Connection Strings Endpoint" + "title" : "Search Host Status Detail" }, - "ServerlessConnectionStringsPrivateEndpointList" : { + "SearchIndex" : { "type" : "object", - "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/" + "allOf" : [ { + "$ref" : "#/components/schemas/ClusterSearchIndex" + }, { + "type" : "object", + "properties" : { + "analyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves a variety of changes made to the text in fields:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\n MongoDB Cloud uses the selected process to build the Atlas Search index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ], + "externalDocs" : { + "description" : "Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/analyzers--fts" + } + }, + "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" + }, + "items" : { + "$ref" : "#/components/schemas/ApiAtlasFTSAnalyzersViewManual" + } + }, + "mappings" : { + "$ref" : "#/components/schemas/ApiAtlasFTSMappingsViewManual" + }, + "searchAnalyzer" : { + "type" : "string", + "default" : "lucene.standard", + "description" : "Method applied to identify words when searching this index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] + }, + "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" + }, + "items" : { + "$ref" : "#/components/schemas/SearchSynonymMappingDefinition" + } + } + } + } ], + "required" : [ "collectionName", "database", "name" ] + }, + "SearchIndexCreateRequest" : { + "type" : "object", + "discriminator" : { + "mapping" : { + "search" : "#/components/schemas/TextSearchIndexCreateRequest", + "vectorSearch" : "#/components/schemas/VectorSearchIndexCreateRequest" + }, + "propertyName" : "type" }, "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**.", - "items" : { - "$ref" : "#/components/schemas/ServerlessConnectionStringsPrivateEndpointItem" - }, - "readOnly" : true + "collectionName" : { + "type" : "string", + "description" : "Label that identifies the collection to create an Atlas Search index in." }, - "srvConnectionString" : { + "database" : { "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 + "description" : "Label that identifies the database that contains the collection to create an Atlas Search index in." + }, + "name" : { + "type" : "string", + "description" : "Label that identifies this index. Within each namespace, names of all indexes in the namespace must be unique." }, "type" : { "type" : "string", - "description" : "MongoDB process type to which your application connects.", - "enum" : [ "MONGOS" ], - "readOnly" : true + "description" : "Type of the index. The default type is search.", + "enum" : [ "search", "vectorSearch" ] } }, - "title" : "Serverless Instance Private Endpoint Connection String" + "required" : [ "collectionName", "database", "name" ] }, - "ServerlessEventTypeViewAlertable" : { - "type" : "string", - "description" : "Event type that triggers an alert.", - "enum" : [ "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], - "example" : "OUTSIDE_SERVERLESS_METRIC_THRESHOLD", - "title" : "Serverless Event Types" + "SearchIndexDefinition" : { + "type" : "object", + "description" : "The search index definition set by the user.", + "title" : "Search Index Definition" + }, + "SearchIndexDefinitionVersion" : { + "type" : "object", + "description" : "Object which includes the version number of the index definition and the time that the index definition was created.", + "properties" : { + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "The time at which this index definition was created." + }, + "version" : { + "type" : "integer", + "format" : "int64", + "description" : "The version number associated with this index definition when it was created." + } + }, + "title" : "Search Index Definition Version" }, - "ServerlessInstanceDescription" : { + "SearchIndexResponse" : { "type" : "object", - "description" : "Group of settings that configure a MongoDB serverless instance.", - "properties" : { - "connectionStrings" : { - "$ref" : "#/components/schemas/ServerlessInstanceDescriptionConnectionStrings" + "discriminator" : { + "mapping" : { + "search" : "#/components/schemas/TextSearchIndexResponse", + "vectorSearch" : "#/components/schemas/VectorSearchIndexResponse" }, - "createDate" : { + "propertyName" : "type" + }, + "properties" : { + "collectionName" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", - "readOnly" : true + "description" : "Label that identifies the collection that contains one or more Atlas Search indexes." }, - "groupId" : { + "database" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the project.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "description" : "Label that identifies the database that contains the collection with one or more Atlas Search indexes." }, - "id" : { + "indexID" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the serverless instance.", + "description" : "Unique 24-hexadecimal digit string that identifies this Atlas Search index.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "pattern" : "^([a-f0-9]{24})$" }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true + "latestDefinition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" }, - "mongoDBVersion" : { - "type" : "string", - "description" : "Version of MongoDB that the serverless instance runs.", - "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", - "readOnly" : true + "latestDefinitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" }, "name" : { "type" : "string", - "description" : "Human-readable label that identifies the serverless instance.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - }, - "providerSettings" : { - "$ref" : "#/components/schemas/ServerlessProviderSettings" + "description" : "Label that identifies this index. Within each namespace, the names of all indexes must be unique." }, - "serverlessBackupOptions" : { - "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on all hosts." }, - "stateName" : { + "status" : { "type" : "string", - "description" : "Human-readable label that indicates the current operating condition of the serverless instance.", - "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], - "readOnly" : true + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] }, - "tags" : { + "statusDetail" : { "type" : "array", - "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", + "description" : "List of documents detailing index status on each host.", "items" : { - "$ref" : "#/components/schemas/ResourceTag" + "$ref" : "#/components/schemas/SearchHostStatusDetail" } }, - "terminationProtectionEnabled" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." + "type" : { + "type" : "string", + "description" : "Type of the index. The default type is search.", + "enum" : [ "search", "vectorSearch" ] } }, - "required" : [ "providerSettings" ], - "title" : "Serverless Instance Description" + "title" : "Search Index Response" }, - "ServerlessInstanceDescriptionConnectionStrings" : { + "SearchIndexUpdateRequest" : { "type" : "object", - "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", - "externalDocs" : { - "description" : "Connection string URI format.", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, "properties" : { - "privateEndpoint" : { - "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.", - "items" : { - "$ref" : "#/components/schemas/ServerlessConnectionStringsPrivateEndpointList" - }, - "readOnly" : true - }, - "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.", - "externalDocs" : { - "description" : "Connection String URI Format", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, - "readOnly" : true + "definition" : { + "type" : "object", + "description" : "The index definition to update the search index to.", + "oneOf" : [ { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + }, { + "$ref" : "#/components/schemas/VectorSearchIndexDefinition" + } ] } }, - "readOnly" : true, - "title" : "Serverless Instance Connection Strings" + "required" : [ "definition" ], + "title" : "Search Index Update Request" }, - "ServerlessInstanceDescriptionCreate" : { + "SearchMainIndexStatusDetail" : { "type" : "object", - "description" : "Settings that you can specify when you create a serverless instance.", + "description" : "Contains status information about the active index.", "properties" : { - "name" : { - "type" : "string", - "description" : "Human-readable label that identifies the serverless instance.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "writeOnly" : true - }, - "providerSettings" : { - "$ref" : "#/components/schemas/ServerlessProviderSettings" + "definition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" }, - "serverlessBackupOptions" : { - "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" }, - "stateName" : { + "message" : { "type" : "string", - "description" : "Human-readable label that indicates the current operating condition of the serverless instance.", - "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], - "readOnly" : true - }, - "tags" : { - "type" : "array", - "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", - "items" : { - "$ref" : "#/components/schemas/ResourceTag" - } + "description" : "Optional message describing an error." }, - "terminationProtectionEnabled" : { + "queryable" : { "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." + "description" : "Flag that indicates whether the index generation is queryable on the host." + }, + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] } }, - "required" : [ "name", "providerSettings" ], - "title" : "Serverless Instance Description Create" + "title" : "Search Main Index Status Detail" }, - "ServerlessInstanceDescriptionUpdate" : { + "SearchMappings" : { "type" : "object", - "description" : "Settings that you can update when you request a serverless cluster update.", + "description" : "Index specifications for the collection's fields.", "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.", - "items" : { - "$ref" : "#/components/schemas/ResourceTag" + "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/field-mapping-definition-fts#static-and-dynamic-mappings" } }, - "terminationProtectionEnabled" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." + "fields" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "One or more field specifications for the Atlas Search index. Required if **mappings.dynamic** is omitted or set to **false**.", + "externalDocs" : { + "description" : "Atlas Search Index", + "url" : "https://dochub.mongodb.org/core/index-definitions-fts" + }, + "x-additionalPropertiesName" : "Field Name" + }, + "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" + }, + "x-additionalPropertiesName" : "Field Name" } }, - "title" : "Serverless Instance Description Update" + "title" : "Mappings" }, - "ServerlessMetricAlertConfigViewForNdsGroup" : { + "SearchStagedIndexStatusDetail" : { "type" : "object", - "description" : "Serverless metric alert configuration allows to select which serverless database metrics trigger alerts and how users are notified.", + "description" : "Contains status information about an index building in the background.", "properties" : { - "created" : { + "definition" : { + "$ref" : "#/components/schemas/SearchIndexDefinition" + }, + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + }, + "message" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "description" : "Optional message describing an error." }, - "enabled" : { + "queryable" : { "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + "description" : "Flag that indicates whether the index generation is queryable on the host." }, - "eventTypeName" : { - "$ref" : "#/components/schemas/ServerlessEventTypeViewAlertable" + "status" : { + "type" : "string", + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Search Staged Index Status Detail" + }, + "SearchSynonymMappingDefinition" : { + "type" : "object", + "description" : "Synonyms used for this full text index.", + "properties" : { + "analyzer" : { + "type" : "string", + "description" : "Specific pre-defined method chosen to apply to the synonyms to be searched.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] }, - "groupId" : { + "name" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "description" : "Label that identifies the synonym definition. Each **synonym.name** must be unique within the same index definition." }, - "id" : { + "source" : { + "$ref" : "#/components/schemas/SynonymSource" + } + }, + "required" : [ "analyzer", "name", "source" ], + "title" : "Synonym Mapping Definition" + }, + "ServerlessAWSTenantEndpoint" : { + "type" : "object", + "description" : "View for a serverless AWS tenant endpoint.", + "properties" : { + "_id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - }, - "matchers" : { - "type" : "array", - "description" : "Matching conditions for target resources.", - "items" : { - "$ref" : "#/components/schemas/AlertMatcher" - } - }, - "metricThreshold" : { - "$ref" : "#/components/schemas/ServerlessMetricThreshold" - }, - "notifications" : { - "type" : "array", - "description" : "List that contains the targets that MongoDB Cloud sends notifications.", - "items" : { - "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" - } - }, - "updated" : { + "cloudProviderEndpointId" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Unique string that identifies the private endpoint's network interface.", + "pattern" : "^vpce-[0-9a-f]{17}$", "readOnly" : true - } - }, - "required" : [ "eventTypeName", "notifications" ], - "title" : "Serverless Alert Configuration" - }, - "ServerlessMetricThreshold" : { - "type" : "object", - "description" : "Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.", - "discriminator" : { - "mapping" : { - "SERVERLESS_AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", - "SERVERLESS_AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", - "SERVERLESS_AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", - "SERVERLESS_CONNECTIONS" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricThresholdView", - "SERVERLESS_NETWORK_BYTES_IN" : "#/components/schemas/DataMetricThresholdView", - "SERVERLESS_NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricThresholdView", - "SERVERLESS_NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_OPCOUNTER_CMD" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_OPCOUNTER_QUERY" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", - "SERVERLESS_TOTAL_READ_UNITS" : "#/components/schemas/RPUMetricThresholdView", - "SERVERLESS_TOTAL_WRITE_UNITS" : "#/components/schemas/RPUMetricThresholdView" }, - "propertyName" : "metricName" - }, - "properties" : { - "metricName" : { + "comment" : { "type" : "string", - "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "readOnly" : true }, - "mode" : { + "endpointServiceName" : { "type" : "string", - "description" : "MongoDB Cloud computes the current metric value as an average.", - "enum" : [ "AVERAGE" ] - }, - "operator" : { - "$ref" : "#/components/schemas/Operator" - }, - "threshold" : { - "type" : "number", - "format" : "double", - "description" : "Value of metric that, when exceeded, triggers an alert." + "description" : "Unique string that identifies the Amazon Web Services (AWS) PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}", + "readOnly" : true }, - "units" : { - "type" : "string", - "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", - "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] - } - }, - "required" : [ "metricName" ], - "title" : "Serverless Metric Threshold" - }, - "ServerlessMetricUnits" : { - "type" : "string", - "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", - "enum" : [ "RPU", "THOUSAND_RPU", "MILLION_RPU", "WPU", "THOUSAND_WPU", "MILLION_WPU" ], - "example" : "RPU", - "title" : "Serverless Metric Units" - }, - "ServerlessProviderSettings" : { - "type" : "object", - "description" : "Group of cloud provider settings that configure the provisioned MongoDB serverless instance.", - "properties" : { - "backingProviderName" : { + "errorMessage" : { "type" : "string", - "description" : "Cloud service provider on which MongoDB Cloud provisioned the serverless instance.", - "enum" : [ "AWS", "AZURE", "GCP" ] + "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", + "readOnly" : true }, "providerName" : { "type" : "string", - "default" : "SERVERLESS", "description" : "Human-readable label that identifies the cloud service provider.", - "enum" : [ "SERVERLESS" ] + "enum" : [ "AWS" ], + "readOnly" : true }, - "regionName" : { + "status" : { "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/)." + "description" : "Human-readable label that indicates the current operating status of the private endpoint.", + "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true } }, - "required" : [ "backingProviderName", "regionName" ], - "title" : "Cloud Service Provider Settings for a Serverless Instance" + "title" : "AWS" }, - "ServerlessTenantCreateRequest" : { + "ServerlessAWSTenantEndpointUpdate" : { "type" : "object", - "properties" : { - "comment" : { - "type" : "string", - "description" : "Human-readable comment associated with the private endpoint.", - "maxLength" : 80, - "writeOnly" : true + "allOf" : [ { + "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" + }, { + "type" : "object", + "properties" : { + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the private endpoint's network interface.", + "pattern" : "^vpce-[0-9a-f]{17}$", + "writeOnly" : true + } } - } + } ], + "description" : "Updates to a serverless AWS tenant endpoint.", + "required" : [ "providerName" ], + "title" : "AWS" }, - "ServerlessTenantEndpoint" : { + "ServerlessAzureTenantEndpoint" : { "type" : "object", - "oneOf" : [ { - "$ref" : "#/components/schemas/ServerlessAWSTenantEndpoint" - }, { - "$ref" : "#/components/schemas/ServerlessAzureTenantEndpoint" - } ], + "description" : "View for a serverless Azure tenant endpoint.", "properties" : { "_id" : { "type" : "string", @@ -48892,7 +52202,8 @@ }, "cloudProviderEndpointId" : { "type" : "string", - "description" : "Unique string that identifies the private endpoint's network interface.", + "description" : "Unique string that identifies the Azure private endpoint's network interface that someone added to this private endpoint service.", + "pattern" : "^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\\.Network/privateEndpoints/[-\\w._()]+$", "readOnly" : true }, "comment" : { @@ -48903,8 +52214,8 @@ }, "endpointServiceName" : { "type" : "string", - "description" : "Unique string that identifies the PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", - "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}|pls_[0-9a-f]{24}$", + "description" : "Unique string that identifies the Azure private endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^pls_[0-9a-f]{24}$", "readOnly" : true }, "errorMessage" : { @@ -48912,112 +52223,113 @@ "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", "readOnly" : true }, - "status" : { + "privateEndpointIpAddress" : { "type" : "string", - "description" : "Human-readable label that indicates the current operating status of the private endpoint.", - "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", "readOnly" : true - } - } - }, - "ServerlessTenantEndpointUpdate" : { - "type" : "object", - "description" : "Update view for a serverless tenant endpoint.", - "discriminator" : { - "mapping" : { - "AWS" : "#/components/schemas/ServerlessAWSTenantEndpointUpdate", - "AZURE" : "#/components/schemas/ServerlessAzureTenantEndpointUpdate" }, - "propertyName" : "providerName" - }, - "properties" : { - "comment" : { + "privateLinkServiceResourceId" : { "type" : "string", - "description" : "Human-readable comment associated with the private endpoint.", - "maxLength" : 80, - "writeOnly" : true + "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 provider of the tenant endpoint.", - "enum" : [ "AWS", "AZURE" ], - "writeOnly" : true + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "AZURE" ], + "readOnly" : true + }, + "status" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating status of the private endpoint.", + "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], + "readOnly" : true } }, - "required" : [ "providerName" ] - }, - "ServiceAccountEventTypeViewForNdsGroup" : { - "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" ], - "title" : "Service Account Event Types" - }, - "ServiceAccountEventTypeViewForOrg" : { - "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" ], - "title" : "Service Account Event Types" + "title" : "Azure" }, - "ServiceAccountGroup" : { + "ServerlessAzureTenantEndpointUpdate" : { "type" : "object", - "properties" : { - "groupId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "allOf" : [ { + "$ref" : "#/components/schemas/ServerlessTenantEndpointUpdate" + }, { + "type" : "object", + "properties" : { + "cloudProviderEndpointId" : { + "type" : "string", + "description" : "Unique string that identifies the Azure private endpoint's network interface for this private endpoint service.", + "pattern" : "^/subscriptions/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}/resource[gG]roups/private[Ll]ink/providers/Microsoft\\.Network/privateEndpoints/[-\\w._()]+$", + "writeOnly" : true + }, + "privateEndpointIpAddress" : { + "type" : "string", + "description" : "IPv4 address of the private endpoint in your Azure VNet that someone added to this private endpoint service.", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "writeOnly" : true + } } - } + } ], + "description" : "Updates to a serverless Azure tenant endpoint.", + "required" : [ "providerName" ], + "title" : "AZURE" }, - "ServiceAccountGroupEvents" : { + "ServerlessBackupRestoreJob" : { "type" : "object", - "description" : "Service Account event identifies different activities around user api keys.", "properties" : { - "apiKeyId" : { + "cancelled" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone canceled this restore job.", + "readOnly" : true + }, + "deliveryType" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "description" : "Human-readable label that categorizes the restore job to create.", + "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\"`.", + "items" : { + "type" : "string", + "description" : "One Uniform Resource Locator that points to the compressed snapshot files for manual download." + }, "readOnly" : true }, - "created" : { + "desiredTimestamp" : { + "$ref" : "#/components/schemas/ApiBSONTimestampView" + }, + "expired" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job expired.", + "readOnly" : true + }, + "expiresAt" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Date and time when the restore job expires. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "eventTypeName" : { - "$ref" : "#/components/schemas/ServiceAccountEventTypeViewForNdsGroup" + "failed" : { + "type" : "boolean", + "description" : "Flag that indicates whether the restore job failed.", + "readOnly" : true }, - "groupId" : { + "finishedAt" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "format" : "date-time", + "description" : "Date and time when the restore job completed. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "description" : "Unique 24-hexadecimal character string that identifies the restore job.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "isGlobalAdmin" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", - "readOnly" : true - }, "links" : { "type" : "array", "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", @@ -49030,98 +52342,87 @@ }, "readOnly" : true }, - "orgId" : { + "oplogInc" : { + "type" : "integer", + "format" : "int32", + "description" : "Oplog operation number from which you want to restore this snapshot. This number represents the second part of an Oplog timestamp. The resource returns this parameter when `\"deliveryType\" : \"pointInTime\"` and **oplogTs** exceeds `0`.", + "example" : 1, + "minimum" : 1 + }, + "oplogTs" : { + "type" : "integer", + "format" : "int32", + "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`.", + "minimum" : 1199145600 + }, + "pointInTimeUTCSeconds" : { + "type" : "integer", + "format" : "int32", + "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`.", + "minimum" : 1199145600 + }, + "snapshotId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "publicKey" : { - "type" : "string", - "format" : "email", - "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "example" : "test.user@mongodb.com", - "readOnly" : true - }, - "raw" : { - "$ref" : "#/components/schemas/raw" + "pattern" : "^([a-f0-9]{24})$" }, - "remoteAddress" : { + "targetClusterName" : { "type" : "string", - "description" : "IPv4 or IPv6 address from which the user triggered this event.", - "example" : "216.172.40.186", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", - "readOnly" : true + "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\"`.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, - "userId" : { + "targetGroupId" : { "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.", + "description" : "Unique 24-hexadecimal digit string that identifies the target project for the specified **targetClusterName**.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "pattern" : "^([a-f0-9]{24})$" }, - "username" : { + "timestamp" : { "type" : "string", - "format" : "email", - "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", - "example" : "test.user@mongodb.com", + "format" : "date-time", + "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.", "readOnly" : true } }, - "required" : [ "created", "eventTypeName", "id" ], - "title" : "ServiceAccount Events" + "required" : [ "deliveryType", "targetClusterName", "targetGroupId" ] }, - "ServiceAccountOrgEvents" : { + "ServerlessBackupSnapshot" : { "type" : "object", - "description" : "Service Account event identifies different activities around user api keys.", "properties" : { - "apiKeyId" : { + "createdAt" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud took the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "created" : { + "expiresAt" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Date and time when MongoDB Cloud deletes the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "eventTypeName" : { - "$ref" : "#/components/schemas/ServiceAccountEventTypeViewForOrg" - }, - "groupId" : { + "frequencyType" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "description" : "Human-readable label that identifies how often this snapshot triggers.", + "enum" : [ "hourly", "daily", "weekly", "monthly" ], "readOnly" : true }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "isGlobalAdmin" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", - "readOnly" : true - }, "links" : { "type" : "array", "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", @@ -49134,332 +52435,278 @@ }, "readOnly" : true }, - "orgId" : { + "mongodVersion" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "description" : "Version of the MongoDB host that this snapshot backs up.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", "readOnly" : true }, - "publicKey" : { + "serverlessInstanceName" : { "type" : "string", - "format" : "email", - "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "example" : "test.user@mongodb.com", + "description" : "Human-readable label given to the serverless instance from which MongoDB Cloud took this snapshot.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", "readOnly" : true }, - "raw" : { - "$ref" : "#/components/schemas/raw" - }, - "remoteAddress" : { + "snapshotType" : { "type" : "string", - "description" : "IPv4 or IPv6 address from which the user triggered this event.", - "example" : "216.172.40.186", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "description" : "Human-readable label that identifies when this snapshot triggers.", + "enum" : [ "onDemand", "scheduled" ], "readOnly" : true }, - "userId" : { + "status" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "description" : "Human-readable label that indicates the stage of the backup process for this snapshot.", + "enum" : [ "queued", "inProgress", "completed", "failed" ], "readOnly" : true }, - "username" : { - "type" : "string", - "format" : "email", - "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", - "example" : "test.user@mongodb.com", + "storageSizeBytes" : { + "type" : "integer", + "format" : "int64", + "description" : "Number of bytes taken to store the backup snapshot.", "readOnly" : true } - }, - "required" : [ "created", "eventTypeName", "id" ], - "title" : "ServiceAccount Events" + } }, - "ServiceAccountSecret" : { + "ServerlessConnectionStringsPrivateEndpointItem" : { "type" : "object", + "description" : "Details of a private endpoint deployed for this serverless instance.", "properties" : { - "createdAt" : { + "endpointId" : { "type" : "string", - "format" : "date-time", - "description" : "Timestamp representing creation time.", + "description" : "Unique string that the cloud provider uses to identify the private endpoint.", "readOnly" : true }, - "expiresAt" : { + "providerName" : { "type" : "string", - "format" : "date-time", - "description" : "Timestamp representing secret expiration time.", + "description" : "Cloud provider where the private endpoint is deployed.", + "enum" : [ "AWS", "AZURE" ], "readOnly" : true }, - "id" : { + "region" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the secret.", - "example" : "32b6e34b3d91647abb20e7b8", - "pattern" : "^([a-f0-9]{24})$", + "description" : "Region where the private endpoint is deployed.", "readOnly" : true - }, - "lastUsedAt" : { - "type" : "string", - "format" : "date-time", - "description" : "Timestamp representing last secret usage.", + } + }, + "title" : "Serverless Instance Private Endpoint Connection Strings Endpoint" + }, + "ServerlessConnectionStringsPrivateEndpointList" : { + "type" : "object", + "description" : "Private endpoint connection string that you can use to connect to this serverless instance through a private endpoint.", + "externalDocs" : { + "description" : "Private Endpoint for Serverless Instance", + "url" : "https://docs.atlas.mongodb.com/security-serverless-private-endpoint/" + }, + "properties" : { + "endpoints" : { + "type" : "array", + "description" : "List that contains the private endpoints through which you connect to MongoDB Cloud when you use **connectionStrings.privateEndpoint[n].srvConnectionString**.", + "items" : { + "$ref" : "#/components/schemas/ServerlessConnectionStringsPrivateEndpointItem" + }, "readOnly" : true }, - "maskedSecretValue" : { + "srvConnectionString" : { "type" : "string", - "description" : "Service Account secret with masked values of the first 20 characters.", - "example" : "mdb_ic_sk_...12ce", + "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 }, - "secret" : { + "type" : { "type" : "string", - "description" : "Secret for the service account. It will be returned only the first time after service account creation.", - "pattern" : "^mdb_sa_sk_[0-9a-zA-Z]{40}$", + "description" : "MongoDB process type to which your application connects.", + "enum" : [ "MONGOS" ], "readOnly" : true } }, - "required" : [ "createdAt", "expiresAt", "id" ] + "title" : "Serverless Instance Private Endpoint Connection String" }, - "ServiceAccountSecretRequest" : { - "type" : "object", - "properties" : { - "secretExpiresAfterHours" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of hours representing validity duration for secret." - } - }, - "required" : [ "secretExpiresAfterHours" ] + "ServerlessEventTypeViewAlertable" : { + "type" : "string", + "description" : "Event type that triggers an alert.", + "enum" : [ "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], + "example" : "OUTSIDE_SERVERLESS_METRIC_THRESHOLD", + "title" : "Serverless Event Types" }, - "ShardEntry" : { + "ServerlessInstanceDescription" : { "type" : "object", - "description" : "Sharding configuration for a collection to be sharded on the destination cluster.", + "description" : "Group of settings that configure a MongoDB serverless instance.", "properties" : { - "collection" : { + "connectionStrings" : { + "$ref" : "#/components/schemas/ServerlessInstanceDescriptionConnectionStrings" + }, + "createDate" : { "type" : "string", - "description" : "Human-readable label that identifies the collection to be sharded on the destination cluster.", - "writeOnly" : true + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.", + "readOnly" : true }, - "database" : { + "groupId" : { "type" : "string", - "description" : "Human-readable label that identifies the database that contains the collection to be sharded on the destination cluster.", - "writeOnly" : true + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "shardCollection" : { - "$ref" : "#/components/schemas/ShardKeys" - } - }, - "required" : [ "collection", "database", "shardCollection" ] - }, - "ShardKeys" : { - "type" : "object", - "description" : "Document that configures the shard key on the destination cluster.", - "properties" : { - "key" : { - "type" : "array", - "description" : "List of fields to use for the shard key.", - "items" : { - "type" : "object", - "additionalProperties" : { - "type" : "object" - } - }, - "uniqueItems" : true, - "writeOnly" : true - } - }, - "writeOnly" : true - }, - "ShardingRequest" : { - "type" : "object", - "description" : "Document that configures sharding on the destination cluster when migrating from a replica set source to a sharded cluster destination on MongoDB 6.0 or higher. If you don't wish to shard any collections on the destination cluster, leave this empty.", - "properties" : { - "createSupportingIndexes" : { - "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 + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the serverless instance.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "shardingEntries" : { + "links" : { "type" : "array", - "description" : "List of shard configurations to shard destination collections. Atlas shards only those collections that you include in the sharding entries array.", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, "items" : { - "$ref" : "#/components/schemas/ShardEntry" + "$ref" : "#/components/schemas/Link" }, - "uniqueItems" : true, - "writeOnly" : true - } - }, - "required" : [ "createSupportingIndexes" ], - "writeOnly" : true - }, - "Slack" : { - "type" : "object", - "description" : "Details to integrate one Slack account with one MongoDB Cloud project.", - "properties" : { - "apiToken" : { + "readOnly" : true + }, + "mongoDBVersion" : { "type" : "string", - "description" : "Key that allows MongoDB Cloud to access your Slack account.\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.\n\n**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" + "description" : "Version of MongoDB that the serverless instance runs.", + "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "readOnly" : true }, - "channelName" : { + "name" : { "type" : "string", - "description" : "Name of the Slack channel to which MongoDB Cloud sends alert notifications.", - "example" : "alerts", - "maxLength" : 80, + "description" : "Human-readable label that identifies the serverless instance.", + "maxLength" : 64, "minLength" : 1, - "nullable" : true + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, - "id" : { - "type" : "string", - "description" : "Integration id.", - "nullable" : true + "providerSettings" : { + "$ref" : "#/components/schemas/ServerlessProviderSettings" }, - "teamName" : { - "type" : "string", - "description" : "Human-readable label that identifies your Slack team. Set this parameter when you configure a legacy Slack integration.", - "example" : "MongoDB" + "serverlessBackupOptions" : { + "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" }, - "type" : { + "stateName" : { "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" : "Human-readable label that indicates the current operating condition of the serverless instance.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true + }, + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } + }, + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." } }, - "required" : [ "apiToken", "channelName" ], - "title" : "SLACK" + "required" : [ "providerSettings" ], + "title" : "Serverless Instance Description" }, - "SlackNotification" : { + "ServerlessInstanceDescriptionConnectionStrings" : { "type" : "object", - "description" : "Slack notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", + "externalDocs" : { + "description" : "Connection string URI format.", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, "properties" : { - "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", - "format" : "int32", - "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." - }, - "integrationId" : { - "type" : "string", - "description" : "The id of the associated integration, the credentials of which to use for requests.", - "example" : "32b6e34b3d91647abb20e7b8" - }, - "intervalMin" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", - "minimum" : 5 - }, - "notifierId" : { - "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" + "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.", + "items" : { + "$ref" : "#/components/schemas/ServerlessConnectionStringsPrivateEndpointList" + }, + "readOnly" : true }, - "typeName" : { + "standardSrv" : { "type" : "string", - "description" : "Human-readable label that displays the alert notification type.", - "enum" : [ "SLACK" ] + "description" : "Public connection string that you can use to connect to this serverless instance. This connection string uses the `mongodb+srv://` protocol.", + "externalDocs" : { + "description" : "Connection String URI Format", + "url" : "https://docs.mongodb.com/manual/reference/connection-string/" + }, + "readOnly" : true } }, - "required" : [ "typeName" ], - "title" : "Slack Notification" + "readOnly" : true, + "title" : "Serverless Instance Connection Strings" }, - "Source" : { + "ServerlessInstanceDescriptionCreate" : { "type" : "object", - "description" : "Document that describes the source of the migration.", + "description" : "Settings that you can specify when you create a serverless instance.", "properties" : { - "caCertificatePath" : { + "name" : { "type" : "string", - "description" : "Path to the CA certificate that signed SSL certificates use to authenticate to the source cluster." + "description" : "Human-readable label that identifies the serverless instance.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "writeOnly" : true }, - "clusterName" : { - "type" : "string", - "description" : "Label that identifies the source cluster name." + "providerSettings" : { + "$ref" : "#/components/schemas/ServerlessProviderSettings" }, - "groupId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the source project.", - "example" : "9b43a5b329223c3a1591a678", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" + "serverlessBackupOptions" : { + "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" }, - "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." + "stateName" : { + "type" : "string", + "description" : "Human-readable label that indicates the current operating condition of the serverless instance.", + "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "readOnly" : true }, - "password" : { - "type" : "string", - "description" : "Password that authenticates the username to the source cluster.", - "writeOnly" : true + "tags" : { + "type" : "array", + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", + "items" : { + "$ref" : "#/components/schemas/ResourceTag" + } }, - "ssl" : { + "terminationProtectionEnabled" : { "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 - } - }, - "required" : [ "clusterName", "groupId", "managedAuthentication", "ssl" ] - }, - "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/" + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." } }, - "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/" - } + "required" : [ "name", "providerSettings" ], + "title" : "Serverless Instance Description Create" }, - "StreamConfig" : { + "ServerlessInstanceDescriptionUpdate" : { "type" : "object", - "description" : "Configuration options for an Atlas Stream Processing Instance.", - "nullable" : true, + "description" : "Settings that you can update when you request a serverless cluster update.", "properties" : { - "links" : { + "serverlessBackupOptions" : { + "$ref" : "#/components/schemas/ClusterServerlessBackupOptions" + }, + "tags" : { "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, + "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the serverless instance.", "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true + "$ref" : "#/components/schemas/ResourceTag" + } }, - "tier" : { - "type" : "string", - "description" : "Selected tier for the Stream Instance. Configures Memory / VCPU allowances.", - "enum" : [ "SP30", "SP10" ], - "title" : "Stream Instance Tier" + "terminationProtectionEnabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether termination protection is enabled on the serverless instance. If set to `true`, MongoDB Cloud won't delete the serverless instance. If set to `false`, MongoDB Cloud will delete the serverless instance." } - } + }, + "title" : "Serverless Instance Description Update" }, - "StreamProcessorAlertConfigViewForNdsGroup" : { + "ServerlessMetricAlertConfigViewForNdsGroup" : { "type" : "object", - "description" : "Host metric alert configuration allows to select which Atlas streams processors trigger alerts and how users are notified.", + "description" : "Serverless metric alert configuration allows to select which serverless database metrics trigger alerts and how users are notified.", "properties" : { "created" : { "type" : "string", @@ -49473,7 +52720,7 @@ "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." }, "eventTypeName" : { - "$ref" : "#/components/schemas/StreamProcessorEventTypeViewAlertable" + "$ref" : "#/components/schemas/ServerlessEventTypeViewAlertable" }, "groupId" : { "type" : "string", @@ -49507,11 +52754,14 @@ }, "matchers" : { "type" : "array", - "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration.", + "description" : "Matching conditions for target resources.", "items" : { - "$ref" : "#/components/schemas/StreamsMatcher" + "$ref" : "#/components/schemas/AlertMatcher" } }, + "metricThreshold" : { + "$ref" : "#/components/schemas/ServerlessMetricThreshold" + }, "notifications" : { "type" : "array", "description" : "List that contains the targets that MongoDB Cloud sends notifications.", @@ -49527,157 +52777,215 @@ } }, "required" : [ "eventTypeName", "notifications" ], - "title" : "Stream Processor Alert Configuration" + "title" : "Serverless Alert Configuration" }, - "StreamProcessorAlertViewForNdsGroup" : { + "ServerlessMetricThreshold" : { "type" : "object", - "description" : "Stream Processor alert notifies about activities on Stream Processor in AtlasStreams.", + "description" : "Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.", + "discriminator" : { + "mapping" : { + "SERVERLESS_AVG_COMMAND_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_AVG_READ_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_AVG_WRITE_EXECUTION_TIME" : "#/components/schemas/TimeMetricThresholdView", + "SERVERLESS_CONNECTIONS" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_CONNECTIONS_PERCENT" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_DATA_SIZE_TOTAL" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_BYTES_IN" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_BYTES_OUT" : "#/components/schemas/DataMetricThresholdView", + "SERVERLESS_NETWORK_NUM_REQUESTS" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_CMD" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_DELETE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_GETMORE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_INSERT" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_QUERY" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_OPCOUNTER_UPDATE" : "#/components/schemas/RawMetricThresholdView", + "SERVERLESS_TOTAL_READ_UNITS" : "#/components/schemas/RPUMetricThresholdView", + "SERVERLESS_TOTAL_WRITE_UNITS" : "#/components/schemas/RPUMetricThresholdView" + }, + "propertyName" : "metricName" + }, "properties" : { - "acknowledgedUntil" : { + "metricName" : { "type" : "string", - "format" : "date-time", - "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.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." }, - "acknowledgementComment" : { + "mode" : { "type" : "string", - "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", - "example" : "Expiration on 3/19. Silencing for 7days.", - "maxLength" : 200 + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] }, - "acknowledgingUsername" : { + "operator" : { "type" : "string", - "format" : "email", - "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", - "readOnly" : true + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, - "alertConfigId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." }, - "created" : { + "units" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true - }, - "eventTypeName" : { - "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroupAlertable" - }, - "groupId" : { + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion", "", "", "" ] + } + }, + "required" : [ "metricName" ], + "title" : "Serverless Metric Threshold" + }, + "ServerlessMetricUnits" : { + "type" : "string", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "RPU", "THOUSAND_RPU", "MILLION_RPU", "WPU", "THOUSAND_WPU", "MILLION_WPU" ], + "example" : "RPU", + "title" : "Serverless Metric Units" + }, + "ServerlessProviderSettings" : { + "type" : "object", + "description" : "Group of cloud provider settings that configure the provisioned MongoDB serverless instance.", + "properties" : { + "backingProviderName" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "description" : "Cloud service provider on which MongoDB Cloud provisioned the serverless instance.", + "enum" : [ "AWS", "AZURE", "GCP" ] }, - "id" : { + "providerName" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies this alert.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "default" : "SERVERLESS", + "description" : "Human-readable label that identifies the cloud service provider.", + "enum" : [ "SERVERLESS" ] }, - "instanceName" : { + "regionName" : { "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.", - "example" : "foobar", - "readOnly" : true - }, - "lastNotified" : { + "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/)." + } + }, + "required" : [ "backingProviderName", "regionName" ], + "title" : "Cloud Service Provider Settings for a Serverless Instance" + }, + "ServerlessTenantCreateRequest" : { + "type" : "object", + "properties" : { + "comment" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", - "readOnly" : true - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - }, - "orgId" : { + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "writeOnly" : true + } + } + }, + "ServerlessTenantEndpoint" : { + "type" : "object", + "oneOf" : [ { + "$ref" : "#/components/schemas/ServerlessAWSTenantEndpoint" + }, { + "$ref" : "#/components/schemas/ServerlessAzureTenantEndpoint" + } ], + "properties" : { + "_id" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "description" : "Unique 24-hexadecimal digit string that identifies the private endpoint.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "processorErrorMsg" : { + "cloudProviderEndpointId" : { "type" : "string", - "description" : "The error message associated with the Stream Processor to which this alert applies.", - "example" : "MongoServerError: Failed to start stream processor: (Location77175) Could not connect to the Kafka topic with kafka error code: -195, message: Local: Broker transport failure.: (Location77175)", + "description" : "Unique string that identifies the private endpoint's network interface.", "readOnly" : true }, - "processorName" : { + "comment" : { "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.", - "example" : "foobar", + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, "readOnly" : true }, - "processorState" : { + "endpointServiceName" : { "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.", - "example" : "STARTED", + "description" : "Unique string that identifies the PrivateLink endpoint service. MongoDB Cloud returns null while it creates the endpoint service.", + "pattern" : "^com\\.amazonaws\\.vpce\\.[a-z-0-9]+\\.vpce-svc-[0-9a-f]{17}|pls_[0-9a-f]{24}$", "readOnly" : true }, - "resolved" : { + "errorMessage" : { "type" : "string", - "format" : "date-time", - "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\"`.", + "description" : "Human-readable error message that indicates error condition associated with establishing the private endpoint connection.", "readOnly" : true }, "status" : { "type" : "string", - "description" : "State of this alert at the time you requested its details.", - "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], - "example" : "OPEN", + "description" : "Human-readable label that indicates the current operating status of the private endpoint.", + "enum" : [ "RESERVATION_REQUESTED", "RESERVED", "INITIATING", "AVAILABLE", "FAILED", "DELETING" ], "readOnly" : true + } + } + }, + "ServerlessTenantEndpointUpdate" : { + "type" : "object", + "description" : "Update view for a serverless tenant endpoint.", + "discriminator" : { + "mapping" : { + "AWS" : "#/components/schemas/ServerlessAWSTenantEndpointUpdate", + "AZURE" : "#/components/schemas/ServerlessAzureTenantEndpointUpdate" }, - "updated" : { + "propertyName" : "providerName" + }, + "properties" : { + "comment" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "description" : "Human-readable comment associated with the private endpoint.", + "maxLength" : 80, + "writeOnly" : true + }, + "providerName" : { + "type" : "string", + "description" : "Human-readable label that identifies the cloud provider of the tenant endpoint.", + "enum" : [ "AWS", "AZURE" ], + "writeOnly" : true } }, - "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], - "title" : "Stream Processor Alerts" + "required" : [ "providerName" ] }, - "StreamProcessorEventTypeViewAlertable" : { + "ServiceAccountEventTypeViewForNdsGroup" : { "type" : "string", - "description" : "Event type that triggers an alert.", - "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], - "example" : "STREAM_PROCESSOR_STATE_IS_FAILED", - "title" : "Stream Processor Event Types" + "description" : "Unique identifier of event type.", + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" }, - "StreamProcessorEventTypeViewForNdsGroup" : { + "ServiceAccountEventTypeViewForOrg" : { "type" : "string", "description" : "Unique identifier of event type.", - "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], - "example" : "STREAM_PROCESSOR_STATE_IS_FAILED", - "title" : "Stream Processor Event Types" + "enum" : [ "SERVICE_ACCOUNT_CREATED", "SERVICE_ACCOUNT_DELETED", "SERVICE_ACCOUNT_ROLES_CHANGED", "SERVICE_ACCOUNT_DETAILS_CHANGED", "SERVICE_ACCOUNT_ADDED_TO_GROUP", "SERVICE_ACCOUNT_REMOVED_FROM_GROUP", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_ADDED", "SERVICE_ACCOUNT_ACCESS_LIST_ENTRY_DELETED", "SERVICE_ACCOUNT_SECRET_ADDED", "SERVICE_ACCOUNT_SECRET_DELETED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_ENABLED", "SERVICE_ACCOUNT_UI_IP_ACCESS_LIST_INHERITANCE_DISABLED" ], + "title" : "Service Account Event Types" }, - "StreamProcessorEventViewForNdsGroup" : { + "ServiceAccountGroup" : { "type" : "object", - "description" : "Stream Processor event identifies different activities about a stream processor in Atlas Streams.", "properties" : { + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies your project. **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + } + } + }, + "ServiceAccountGroupEvents" : { + "type" : "object", + "description" : "Service Account event identifies different activities around user api keys.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, "created" : { "type" : "string", "format" : "date-time", @@ -49685,7 +52993,7 @@ "readOnly" : true }, "eventTypeName" : { - "$ref" : "#/components/schemas/StreamProcessorEventTypeViewForNdsGroup" + "$ref" : "#/components/schemas/ServiceAccountEventTypeViewForNdsGroup" }, "groupId" : { "type" : "string", @@ -49705,10 +53013,10 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "instanceName" : { - "type" : "string", - "description" : "Name of the stream processing instance associated with the event.", - "example" : "foobar", + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", "readOnly" : true }, "links" : { @@ -49732,159 +53040,96 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "processorErrorMsg" : { - "type" : "string", - "description" : "Error message linked to the stream processor associated with the event.", - "example" : "invalid auth", - "readOnly" : true - }, - "processorName" : { - "type" : "string", - "description" : "Name of the stream processor associated with the event.", - "example" : "foobar", - "readOnly" : true - }, - "processorState" : { + "publicKey" : { "type" : "string", - "description" : "State of the stream processor associated with the event.", - "example" : "FAILED", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true }, "raw" : { "$ref" : "#/components/schemas/raw" - } - }, - "required" : [ "created", "eventTypeName", "id" ], - "title" : "Stream Processor Events" - }, - "StreamsClusterConnection" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/StreamsConnection" - }, { - "type" : "object", - "properties" : { - "clusterName" : { - "type" : "string", - "description" : "Name of the cluster configured for this connection." - }, - "dbRoleToExecute" : { - "$ref" : "#/components/schemas/DBRoleToExecute" - } - } - } ] - }, - "StreamsConnection" : { - "type" : "object", - "description" : "Settings that define a connection to an external data store.", - "discriminator" : { - "mapping" : { - "Cluster" : "#/components/schemas/StreamsClusterConnection", - "Kafka" : "#/components/schemas/StreamsKafkaConnection", - "Sample" : "#/components/schemas/StreamsSampleConnection" }, - "propertyName" : "type" - }, - "oneOf" : [ { - "$ref" : "#/components/schemas/StreamsSampleConnection" - }, { - "$ref" : "#/components/schemas/StreamsClusterConnection" - }, { - "$ref" : "#/components/schemas/StreamsKafkaConnection" - } ], - "properties" : { - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", "readOnly" : true }, - "name" : { + "userId" : { "type" : "string", - "description" : "Human-readable label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source." + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "type" : { + "username" : { "type" : "string", - "description" : "Type of the connection. Can be either Cluster or Kafka.", - "enum" : [ "Kafka", "Cluster", "Sample" ] + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true } }, - "readOnly" : true + "required" : [ "created", "eventTypeName", "id" ], + "title" : "ServiceAccount Events" }, - "StreamsDLQ" : { + "ServiceAccountIPAccessListEntry" : { "type" : "object", - "description" : "Dead letter queue for the stream processor.", "properties" : { - "coll" : { + "cidrBlock" : { "type" : "string", - "description" : "Name of the collection that will be used for the DLQ." + "description" : "Range of network addresses in the access list for the Service Account. This parameter requires the range to be expressed in Classless Inter-Domain Routing (CIDR) notation of Internet Protocol version 4 or version 6 addresses. You can set a value for this parameter or **ipAddress**, but not for both in the same request.", + "example" : "203.0.113.0/24", + "pattern" : "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" }, - "connectionName" : { + "createdAt" : { "type" : "string", - "description" : "Connection name that will be used to write DLQ messages to. Has to be an Atlas connection." + "format" : "date-time", + "description" : "Date MongoDB Cloud added the entry was added to the Access List.", + "readOnly" : true }, - "db" : { + "ipAddress" : { "type" : "string", - "description" : "Name of the database that will be used for the DLQ." + "description" : "Network address in the access list for the Service Account. This parameter requires the address to be expressed as one Internet Protocol version 4 or version 6 address. You can set a value for this parameter or **cidrBlock**, but not for both in the same request.", + "example" : "203.0.113.10", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - } - } - }, - "StreamsDataProcessRegion" : { - "type" : "object", - "description" : "Information about the cloud provider region in which MongoDB Cloud processes the stream.", - "properties" : { - "cloudProvider" : { + "lastUsedAddress" : { "type" : "string", - "description" : "Label that identifies the cloud service provider where MongoDB Cloud performs stream processing. Currently, this parameter supports AWS only.", - "enum" : [ "AWS", "GCP", "AZURE", "TENANT", "SERVERLESS" ] + "description" : "Network address that issued the most recent request to the API. This parameter requires the address to be expressed as one Internet Protocol version 4 or version 6 address. The resource returns this parameter after this IP address makes at least one request.", + "readOnly" : true }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, + "lastUsedAt" : { + "type" : "string", + "format" : "date-time", + "description" : "Date when MongoDB Cloud received the most recent request that originated from this Internet Protocol version 4 or version 6 address. The resource returns this parameter when at least one request originates from this IP address. MongoDB Cloud updates this parameter each time a client accesses the permitted resource, with a delay of up to 5 minutes.", "readOnly" : true }, - "region" : { - "$ref" : "#/components/schemas/BaseStreamsRegion" + "requestCount" : { + "type" : "integer", + "format" : "int32", + "description" : "The number of requests that has originated from this network address.", + "readOnly" : true } - }, - "required" : [ "cloudProvider", "region" ] - }, - "StreamsEventTypeViewForNdsGroup" : { - "type" : "string", - "description" : "Unique identifier of event type.", - "enum" : [ "MAX_PROCESSOR_COUNT_REACHED" ], - "example" : "MAX_PROCESSOR_COUNT_REACHED", - "title" : "Streams Event Types" + } }, - "StreamsEventViewForNdsGroup" : { + "ServiceAccountOrgEvents" : { "type" : "object", - "description" : "Streams event identifies different activities about Atlas Streams.", + "description" : "Service Account event identifies different activities around user api keys.", "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, "created" : { "type" : "string", "format" : "date-time", @@ -49892,7 +53137,7 @@ "readOnly" : true }, "eventTypeName" : { - "$ref" : "#/components/schemas/StreamsEventTypeViewForNdsGroup" + "$ref" : "#/components/schemas/ServiceAccountEventTypeViewForOrg" }, "groupId" : { "type" : "string", @@ -49912,10 +53157,10 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "instanceName" : { - "type" : "string", - "description" : "Name of the stream processing instance associated with the event.", - "example" : "foobar", + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", "readOnly" : true }, "links" : { @@ -49939,387 +53184,217 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, + "publicKey" : { + "type" : "string", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", + "readOnly" : true + }, "raw" : { "$ref" : "#/components/schemas/raw" - } - }, - "required" : [ "created", "eventTypeName", "id" ], - "title" : "Streams Events" - }, - "StreamsKafkaAuthentication" : { - "type" : "object", - "description" : "User credentials required to connect to a Kafka Cluster. Includes the authentication type, as well as the parameters for that authentication mode.", - "properties" : { - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true }, - "mechanism" : { + "remoteAddress" : { "type" : "string", - "description" : "Style of authentication. Can be one of PLAIN, SCRAM-256, or SCRAM-512." + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true }, - "password" : { + "userId" : { "type" : "string", - "format" : "password", - "description" : "Password of the account to connect to the Kafka cluster.", - "writeOnly" : true + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, "username" : { "type" : "string", - "description" : "Username of the account to connect to the Kafka cluster." - } - } - }, - "StreamsKafkaConnection" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/StreamsConnection" - }, { - "type" : "object", - "properties" : { - "authentication" : { - "$ref" : "#/components/schemas/StreamsKafkaAuthentication" - }, - "bootstrapServers" : { - "type" : "string", - "description" : "Comma separated list of server addresses." - }, - "config" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "description" : "A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.", - "example" : "{\"group.protocol.type\":\"consumer\",\"debug\":\"queue, msg, protocol\"}" - }, - "description" : "A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.", - "example" : { - "debug" : "queue, msg, protocol", - "group.protocol.type" : "consumer" - } - }, - "networking" : { - "$ref" : "#/components/schemas/StreamsKafkaNetworking" - }, - "proxyInfo" : { - "$ref" : "#/components/schemas/ProxyInfo" - }, - "security" : { - "$ref" : "#/components/schemas/StreamsKafkaSecurity" - } - } - } ] - }, - "StreamsKafkaNetworking" : { - "type" : "object", - "description" : "Networking Access Type can either be 'PUBLIC' (default) or VPC. VPC type is in public preview, please file a support ticket to enable VPC Network Access", - "properties" : { - "access" : { - "$ref" : "#/components/schemas/StreamsKafkaNetworkingAccess" - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true } - } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "ServiceAccount Events" }, - "StreamsKafkaNetworkingAccess" : { + "ServiceAccountSecret" : { "type" : "object", - "description" : "Information about the networking access.", "properties" : { - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, + "createdAt" : { + "type" : "string", + "format" : "date-time", + "description" : "The date that the secret was created on.", "readOnly" : true }, - "name" : { + "expiresAt" : { "type" : "string", - "description" : "Id of the vpc peer when the type is VPC." + "format" : "date-time", + "description" : "The date for the expiration of the secret.", + "readOnly" : true }, - "type" : { + "id" : { "type" : "string", - "description" : "Selected networking type. Either PUBLIC or VPC. Defaults to PUBLIC", - "enum" : [ "PUBLIC", "VPC" ], - "title" : "Networking Access Type" - } - } - }, - "StreamsKafkaSecurity" : { - "type" : "object", - "description" : "Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use.", - "properties" : { - "brokerPublicCertificate" : { + "description" : "Unique 24-hexadecimal digit string that identifies the secret.", + "example" : "32b6e34b3d91647abb20e7b8", + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "lastUsedAt" : { "type" : "string", - "description" : "A trusted, public x509 certificate for connecting to Kafka over SSL." + "format" : "date-time", + "description" : "The last time the secret was used.", + "readOnly" : true }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, + "maskedSecretValue" : { + "type" : "string", + "description" : "The masked Service Account secret.", + "example" : "mdb_ic_sk_...12ce", "readOnly" : true }, - "protocol" : { + "secret" : { "type" : "string", - "description" : "Describes the transport type. Can be either PLAINTEXT or SSL." + "description" : "The secret for the Service Account. It will be returned only the first time after creation.", + "pattern" : "^mdb_sa_sk_[0-9a-zA-Z_-]{40}$", + "readOnly" : true } - } + }, + "required" : [ "createdAt", "expiresAt", "id" ] }, - "StreamsMatcher" : { + "ServiceAccountSecretRequest" : { "type" : "object", - "description" : "Rules to apply when comparing a stream processing instance or stream processor against this alert configuration.", "properties" : { - "fieldName" : { - "$ref" : "#/components/schemas/StreamsMatcherField" - }, - "operator" : { + "secretExpiresAfterHours" : { + "type" : "integer", + "format" : "int32", + "description" : "The expiration time of the new Service Account secret. The expiration is provided in hours." + } + }, + "required" : [ "secretExpiresAfterHours" ] + }, + "ShardEntry" : { + "type" : "object", + "description" : "Sharding configuration for a collection to be sharded on the destination cluster.", + "properties" : { + "collection" : { "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" ] + "description" : "Human-readable label that identifies the collection to be sharded on the destination cluster.", + "writeOnly" : true }, - "value" : { + "database" : { "type" : "string", - "description" : "Value to match or exceed using the specified **matchers.operator**.", - "example" : "event-replica-set" + "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" } }, - "required" : [ "fieldName", "operator", "value" ], - "title" : "Matchers" - }, - "StreamsMatcherField" : { - "type" : "string", - "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", - "enum" : [ "INSTANCE_NAME", "PROCESSOR_NAME" ], - "example" : "INSTANCE_NAME", - "title" : "Streams Matcher Fields" + "required" : [ "collection", "database", "shardCollection" ] }, - "StreamsOptions" : { + "ShardKeys" : { "type" : "object", - "description" : "Optional configuration for the stream processor.", + "description" : "Document that configures the shard key on the destination cluster.", "properties" : { - "dlq" : { - "$ref" : "#/components/schemas/StreamsDLQ" - }, - "links" : { + "key" : { "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, + "description" : "List of fields to use for the shard key.", "items" : { - "$ref" : "#/components/schemas/Link" + "type" : "object", + "additionalProperties" : { + "type" : "object" + } }, - "readOnly" : true + "uniqueItems" : true, + "writeOnly" : true } - } + }, + "writeOnly" : true }, - "StreamsProcessor" : { + "ShardingRequest" : { "type" : "object", - "description" : "An atlas stream processor.", + "description" : "Document that configures sharding on the destination cluster when migrating from a replica set source to a sharded cluster destination on MongoDB 6.0 or higher. If you don't wish to shard any collections on the destination cluster, leave this empty.", "properties" : { - "_id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the stream processor.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "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 }, - "links" : { + "shardingEntries" : { "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, + "description" : "List of shard configurations to shard destination collections. Atlas shards only those collections that you include in the sharding entries array.", "items" : { - "$ref" : "#/components/schemas/Link" + "$ref" : "#/components/schemas/ShardEntry" }, - "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "Human-readable name of the stream processor." - }, - "options" : { - "$ref" : "#/components/schemas/StreamsOptions" - }, - "pipeline" : { - "type" : "array", - "description" : "Stream aggregation pipeline you want to apply to your streaming data.", - "items" : { - "$ref" : "#/components/schemas/Document" - } + "uniqueItems" : true, + "writeOnly" : true } - } + }, + "required" : [ "createSupportingIndexes" ], + "writeOnly" : true }, - "StreamsProcessorWithStats" : { + "Slack" : { "type" : "object", - "description" : "An atlas stream processor with optional stats.", + "description" : "Details to integrate one Slack account with one MongoDB Cloud project.", "properties" : { - "_id" : { + "apiToken" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the stream processor.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true + "description" : "Key that allows MongoDB Cloud to access your Slack account.\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.\n\n**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" }, - "name" : { + "channelName" : { "type" : "string", - "description" : "Human-readable name of the stream processor.", - "readOnly" : true + "description" : "Name of the Slack channel to which MongoDB Cloud sends alert notifications.", + "example" : "alerts", + "maxLength" : 80, + "minLength" : 1, + "nullable" : true }, - "pipeline" : { - "type" : "array", - "description" : "Stream aggregation pipeline you want to apply to your streaming data.", - "items" : { - "$ref" : "#/components/schemas/Document" - }, - "readOnly" : true + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true }, - "state" : { + "teamName" : { "type" : "string", - "description" : "The state of the stream processor.", - "readOnly" : true + "description" : "Human-readable label that identifies your Slack team. Set this parameter when you configure a legacy Slack integration.", + "example" : "MongoDB" }, - "stats" : { - "type" : "object", - "additionalProperties" : { - "type" : "object", - "description" : "The stats associated with the stream processor.", - "readOnly" : true - }, - "description" : "The stats associated with the stream processor.", - "readOnly" : 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" : [ "SLACK" ] } }, - "required" : [ "_id", "name", "pipeline", "state" ] - }, - "StreamsSampleConnection" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/StreamsConnection" - } ] + "required" : [ "apiToken", "channelName" ], + "title" : "SLACK" }, - "StreamsTenant" : { + "SlackNotification" : { "type" : "object", + "description" : "Slack notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", "properties" : { - "_id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the project.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "connections" : { - "type" : "array", - "description" : "List of connections configured in the stream instance.", - "items" : { - "$ref" : "#/components/schemas/StreamsConnection" - }, - "readOnly" : true - }, - "dataProcessRegion" : { - "$ref" : "#/components/schemas/StreamsDataProcessRegion" - }, - "groupId" : { + "apiToken" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the project.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, - "hostnames" : { - "type" : "array", - "description" : "List that contains the hostnames assigned to the stream instance.", - "items" : { - "type" : "string", - "description" : "Unique hostname assigned to the stream instance.", - "readOnly" : true - }, - "readOnly" : true - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true + "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" }, - "name" : { + "channelName" : { "type" : "string", - "description" : "Human-readable label that identifies the stream instance." + "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" }, - "streamConfig" : { - "$ref" : "#/components/schemas/StreamConfig" - } - } - }, - "SummaryNotification" : { - "type" : "object", - "description" : "Summary notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", - "properties" : { "delayMin" : { "type" : "integer", "format" : "int32", "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." }, - "emailAddress" : { + "integrationId" : { "type" : "string", - "format" : "email", - "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:\n\n- specific MongoDB Cloud users (`\"notifications.[n].typeName\" : \"USER\"`)\n- MongoDB Cloud users with specific project roles (`\"notifications.[n].typeName\" : \"GROUP\"`)\n- MongoDB Cloud users with specific organization roles (`\"notifications.[n].typeName\" : \"ORG\"`)\n- MongoDB Cloud teams (`\"notifications.[n].typeName\" : \"TEAM\"`)\n\nTo send emails to one MongoDB Cloud user or grouping of users, set the **notifications.[n].emailEnabled** parameter." + "description" : "The id of the associated integration, the credentials of which to use for requests.", + "example" : "32b6e34b3d91647abb20e7b8" }, "intervalMin" : { "type" : "integer", @@ -50335,68 +53410,74 @@ "typeName" : { "type" : "string", "description" : "Human-readable label that displays the alert notification type.", - "enum" : [ "SUMMARY" ] + "enum" : [ "SLACK" ] } }, "required" : [ "typeName" ], - "title" : "Summary Notification" + "title" : "Slack Notification" }, - "SynonymMappingStatusDetail" : { + "Source" : { "type" : "object", - "description" : "Contains the status of the index's synonym mappings on each search host. This field (and its subfields) only appear if the index has synonyms defined.", + "description" : "Document that describes the source of the migration.", "properties" : { - "message" : { + "caCertificatePath" : { "type" : "string", - "description" : "Optional message describing an error." + "description" : "Path to the CA certificate that signed SSL certificates use to authenticate to the source cluster." }, - "queryable" : { + "clusterName" : { + "type" : "string", + "description" : "Label that identifies the source cluster name." + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the source project.", + "example" : "9b43a5b329223c3a1591a678", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, + "managedAuthentication" : { "type" : "boolean", - "description" : "Flag that indicates whether the synonym mapping is queryable on a host." + "description" : "Flag that indicates whether MongoDB Automation manages authentication to the source cluster. If true, do not provide values for username and password." }, - "status" : { + "password" : { "type" : "string", - "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", - "enum" : [ "FAILED", "BUILDING", "READY" ] + "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 } }, - "title" : "Synonym Mapping Status Detail" + "required" : [ "clusterName", "groupId", "managedAuthentication", "ssl" ] }, - "SynonymMappingStatusDetailMap" : { + "StorageEngine" : { "type" : "object", "additionalProperties" : { - "$ref" : "#/components/schemas/SynonymMappingStatusDetail" - }, - "x-additionalPropertiesName" : "Synonym Mapping Name" - }, - "SynonymSource" : { - "type" : "object", - "description" : "Data set that stores words and their applicable synonyms.", - "properties" : { - "collection" : { - "type" : "string", - "description" : "Label that identifies the MongoDB collection that stores words and their applicable synonyms." + "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/" } }, - "required" : [ "collection" ] + "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/" + } }, - "SystemStatus" : { + "StreamConfig" : { "type" : "object", + "description" : "Configuration options for an Atlas Stream Processing Instance.", + "nullable" : true, "properties" : { - "apiKey" : { - "$ref" : "#/components/schemas/ApiKey" - }, - "appName" : { - "type" : "string", - "description" : "Human-readable label that identifies the service from which you requested this response.", - "enum" : [ "MongoDB Atlas" ], - "readOnly" : true - }, - "build" : { - "type" : "string", - "description" : "Unique 40-hexadecimal digit hash that identifies the latest git commit merged for this application.", - "example" : "83be55e140f493c88e7f578aae96548dd881587b", - "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.", @@ -50409,43 +53490,44 @@ }, "readOnly" : true }, - "throttling" : { - "type" : "boolean", - "description" : "Flag that indicates whether someone enabled throttling on this service.", - "readOnly" : true - } - }, - "required" : [ "apiKey", "appName", "build", "throttling" ] - }, - "TargetOrg" : { - "type" : "object", - "properties" : { - "linkToken" : { + "tier" : { "type" : "string", - "description" : "Link token that contains all the information required to complete the link." - } - }, - "required" : [ "linkToken" ] - }, - "TargetOrgRequest" : { - "type" : "object", - "properties" : { - "accessListIps" : { - "type" : "array", - "description" : "IP address access list entries associated with the API key.", - "items" : { - "type" : "string", - "description" : "One IP address access list entry associated with the API key." - } + "description" : "Selected tier for the Stream Instance. Configures Memory / VCPU allowances.", + "enum" : [ "SP30", "SP10" ], + "title" : "Stream Instance Tier" } } }, - "Team" : { + "StreamProcessorAlertConfigViewForNdsGroup" : { "type" : "object", + "description" : "Host metric alert configuration allows to select which Atlas streams processors trigger alerts and how users are notified.", "properties" : { + "created" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "enabled" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether someone enabled this alert configuration for the specified project." + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/StreamProcessorEventTypeViewAlertable" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies this team.", + "description" : "Unique 24-hexadecimal digit string that identifies this alert configuration.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -50464,30 +53546,54 @@ }, "readOnly" : true }, - "name" : { - "type" : "string", - "description" : "Human-readable label that identifies the team." + "matchers" : { + "type" : "array", + "description" : "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration.", + "items" : { + "$ref" : "#/components/schemas/StreamsMatcher" + } }, - "usernames" : { + "notifications" : { "type" : "array", - "description" : "List that contains the MongoDB Cloud users in this team.", + "description" : "List that contains the targets that MongoDB Cloud sends notifications.", "items" : { - "type" : "string", - "format" : "email", - "description" : "List that contains email addresses that identify MongoDB Cloud users to in this team." - }, - "uniqueItems" : true + "$ref" : "#/components/schemas/AlertsNotificationRootForGroup" + } + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true } }, - "required" : [ "name" ] + "required" : [ "eventTypeName", "notifications" ], + "title" : "Stream Processor Alert Configuration" }, - "TeamEvent" : { + "StreamProcessorAlertViewForNdsGroup" : { "type" : "object", - "description" : "Team event identifies different activities around organization teams.", + "description" : "Stream Processor alert notifies about activities on Stream Processor in AtlasStreams.", "properties" : { - "apiKeyId" : { + "acknowledgedUntil" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "format" : "date-time", + "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.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -50497,15 +53603,15 @@ "created" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, "eventTypeName" : { - "$ref" : "#/components/schemas/TeamEventTypeView" + "$ref" : "#/components/schemas/HostEventTypeViewForNdsGroupAlertable" }, "groupId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -50514,17 +53620,23 @@ }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the event.", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "isGlobalAdmin" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "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.", + "example" : "foobar", + "readOnly" : true + }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", "readOnly" : true }, "links" : { @@ -50541,86 +53653,72 @@ }, "orgId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "publicKey" : { + "processorErrorMsg" : { "type" : "string", - "format" : "email", - "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "example" : "test.user@mongodb.com", + "description" : "The error message associated with the Stream Processor to which this alert applies.", + "example" : "MongoServerError: Failed to start stream processor: (Location77175) Could not connect to the Kafka topic with kafka error code: -195, message: Local: Broker transport failure.: (Location77175)", "readOnly" : true }, - "raw" : { - "$ref" : "#/components/schemas/raw" + "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.", + "example" : "foobar", + "readOnly" : true }, - "remoteAddress" : { + "processorState" : { "type" : "string", - "description" : "IPv4 or IPv6 address from which the user triggered this event.", - "example" : "216.172.40.186", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "description" : "The state of the Stream Processor to which this alert applies. The resource returns this parameter for alerts of events impacting Stream Processors.", + "example" : "STARTED", "readOnly" : true }, - "teamId" : { + "resolved" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization team associated with this event.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "format" : "date-time", + "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\"`.", "readOnly" : true }, - "userId" : { + "status" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", "readOnly" : true }, - "username" : { + "updated" : { "type" : "string", - "format" : "email", - "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", - "example" : "test.user@mongodb.com", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true } }, - "required" : [ "created", "eventTypeName", "id" ], - "title" : "Team Events" + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ], + "title" : "Stream Processor Alerts" }, - "TeamEventTypeView" : { + "StreamProcessorEventTypeViewAlertable" : { "type" : "string", - "description" : "Unique identifier of event type.", - "enum" : [ "TEAM_CREATED", "TEAM_DELETED", "TEAM_UPDATED", "TEAM_NAME_CHANGED", "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], - "example" : "TEAM_ADDED_TO_GROUP", - "title" : "Team Event Types" + "description" : "Event type that triggers an alert.", + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "example" : "STREAM_PROCESSOR_STATE_IS_FAILED", + "title" : "Stream Processor Event Types" }, - "TeamEventTypeViewForNdsGroup" : { + "StreamProcessorEventTypeViewForNdsGroup" : { "type" : "string", "description" : "Unique identifier of event type.", - "enum" : [ "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], - "example" : "TEAM_ADDED_TO_GROUP", - "title" : "Team Event Types" + "enum" : [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], + "example" : "STREAM_PROCESSOR_STATE_IS_FAILED", + "title" : "Stream Processor Event Types" }, - "TeamEventViewForNdsGroup" : { + "StreamProcessorEventViewForNdsGroup" : { "type" : "object", - "description" : "Team event identifies different activities around organization teams.", + "description" : "Stream Processor event identifies different activities about a stream processor in Atlas Streams.", "properties" : { - "apiKeyId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true - }, "created" : { "type" : "string", "format" : "date-time", @@ -50628,7 +53726,7 @@ "readOnly" : true }, "eventTypeName" : { - "$ref" : "#/components/schemas/TeamEventTypeViewForNdsGroup" + "$ref" : "#/components/schemas/StreamProcessorEventTypeViewForNdsGroup" }, "groupId" : { "type" : "string", @@ -50648,10 +53746,10 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "isGlobalAdmin" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "instanceName" : { + "type" : "string", + "description" : "Name of the stream processing instance associated with the event.", + "example" : "foobar", "readOnly" : true }, "links" : { @@ -50675,113 +53773,297 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "publicKey" : { + "processorErrorMsg" : { "type" : "string", - "format" : "email", - "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", - "example" : "test.user@mongodb.com", + "description" : "Error message linked to the stream processor associated with the event.", + "example" : "invalid auth", + "readOnly" : true + }, + "processorName" : { + "type" : "string", + "description" : "Name of the stream processor associated with the event.", + "example" : "foobar", + "readOnly" : true + }, + "processorState" : { + "type" : "string", + "description" : "State of the stream processor associated with the event.", + "example" : "FAILED", "readOnly" : true }, "raw" : { "$ref" : "#/components/schemas/raw" + } + }, + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Stream Processor Events" + }, + "StreamsClusterConnection" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/StreamsConnection" + }, { + "type" : "object", + "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Name of the cluster configured for this connection." + }, + "dbRoleToExecute" : { + "$ref" : "#/components/schemas/DBRoleToExecute" + } + } + } ] + }, + "StreamsConnection" : { + "type" : "object", + "description" : "Settings that define a connection to an external data store.", + "discriminator" : { + "mapping" : { + "Cluster" : "#/components/schemas/StreamsClusterConnection", + "Kafka" : "#/components/schemas/StreamsKafkaConnection", + "Sample" : "#/components/schemas/StreamsSampleConnection" }, - "remoteAddress" : { + "propertyName" : "type" + }, + "oneOf" : [ { + "$ref" : "#/components/schemas/StreamsSampleConnection" + }, { + "$ref" : "#/components/schemas/StreamsClusterConnection" + }, { + "$ref" : "#/components/schemas/StreamsKafkaConnection" + } ], + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { "type" : "string", - "description" : "IPv4 or IPv6 address from which the user triggered this event.", - "example" : "216.172.40.186", - "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "description" : "Human-readable label that identifies the stream connection. In the case of the Sample type, this is the name of the sample source." + }, + "type" : { + "type" : "string", + "description" : "Type of the connection. Can be either Cluster or Kafka.", + "enum" : [ "Kafka", "Cluster", "Sample" ] + } + }, + "readOnly" : true + }, + "StreamsDLQ" : { + "type" : "object", + "description" : "Dead letter queue for the stream processor.", + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/reference/glossary/#std-term-dead-letter-queue" + }, + "properties" : { + "coll" : { + "type" : "string", + "description" : "Name of the collection to use for the DLQ." + }, + "connectionName" : { + "type" : "string", + "description" : "Name of the connection to write DLQ messages to. Must be an Atlas connection." + }, + "db" : { + "type" : "string", + "description" : "Name of the database to use for the DLQ." + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, "readOnly" : true + } + } + }, + "StreamsDataProcessRegion" : { + "type" : "object", + "description" : "Information about the cloud provider region in which MongoDB Cloud processes the stream.", + "properties" : { + "cloudProvider" : { + "type" : "string", + "description" : "Label that identifies the cloud service provider where MongoDB Cloud performs stream processing. Currently, this parameter supports AWS only.", + "enum" : [ "AWS", "GCP", "AZURE", "TENANT", "SERVERLESS" ] }, - "teamId" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "region" : { + "$ref" : "#/components/schemas/BaseStreamsRegion" + } + }, + "required" : [ "cloudProvider", "region" ] + }, + "StreamsEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "MAX_PROCESSOR_COUNT_REACHED" ], + "example" : "MAX_PROCESSOR_COUNT_REACHED", + "title" : "Streams Event Types" + }, + "StreamsEventViewForNdsGroup" : { + "type" : "object", + "description" : "Streams event identifies different activities about Atlas Streams.", + "properties" : { + "created" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the organization team associated with this event.", + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "readOnly" : true + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/StreamsEventTypeViewForNdsGroup" + }, + "groupId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "userId" : { + "id" : { "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.", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "username" : { + "instanceName" : { "type" : "string", - "format" : "email", - "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", - "example" : "test.user@mongodb.com", + "description" : "Name of the stream processing instance associated with the event.", + "example" : "foobar", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "orgId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true + }, + "raw" : { + "$ref" : "#/components/schemas/raw" } }, "required" : [ "created", "eventTypeName", "id" ], - "title" : "Team Events" + "title" : "Streams Events" }, - "TeamNotification" : { + "StreamsKafkaAuthentication" : { "type" : "object", - "description" : "Team notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", + "description" : "User credentials required to connect to a Kafka Cluster. Includes the authentication type, as well as the parameters for that authentication mode.", "properties" : { - "delayMin" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." - }, - "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:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" - }, - "intervalMin" : { - "type" : "integer", - "format" : "int32", - "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", - "minimum" : 5 - }, - "notifierId" : { - "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:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true }, - "teamId" : { + "mechanism" : { "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", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" + "description" : "Style of authentication. Can be one of PLAIN, SCRAM-256, or SCRAM-512." }, - "teamName" : { + "password" : { "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" + "format" : "password", + "description" : "Password of the account to connect to the Kafka cluster.", + "writeOnly" : true }, - "typeName" : { + "username" : { "type" : "string", - "description" : "Human-readable label that displays the alert notification type.", - "enum" : [ "TEAM" ] + "description" : "Username of the account to connect to the Kafka cluster." } - }, - "required" : [ "typeName" ], - "title" : "Team Notification" + } }, - "TeamResponse" : { + "StreamsKafkaConnection" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/StreamsConnection" + }, { + "type" : "object", + "properties" : { + "authentication" : { + "$ref" : "#/components/schemas/StreamsKafkaAuthentication" + }, + "bootstrapServers" : { + "type" : "string", + "description" : "Comma separated list of server addresses." + }, + "config" : { + "type" : "object", + "additionalProperties" : { + "type" : "string", + "description" : "A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.", + "example" : "{\"group.protocol.type\":\"consumer\",\"debug\":\"queue, msg, protocol\"}" + }, + "description" : "A map of Kafka key-value pairs for optional configuration. This is a flat object, and keys can have '.' characters.", + "example" : { + "debug" : "queue, msg, protocol", + "group.protocol.type" : "consumer" + } + }, + "networking" : { + "$ref" : "#/components/schemas/StreamsKafkaNetworking" + }, + "security" : { + "$ref" : "#/components/schemas/StreamsKafkaSecurity" + } + } + } ] + }, + "StreamsKafkaNetworking" : { "type" : "object", + "description" : "Networking Access Type can either be 'PUBLIC' (default) or VPC. VPC type is in public preview, please file a support ticket to enable VPC Network Access", "properties" : { - "id" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies this team.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "access" : { + "$ref" : "#/components/schemas/StreamsKafkaNetworkingAccess" }, "links" : { "type" : "array", @@ -50794,16 +54076,21 @@ "$ref" : "#/components/schemas/Link" }, "readOnly" : true - }, - "name" : { - "type" : "string", - "description" : "Human-readable label that identifies the team." } } }, - "TeamRole" : { + "StreamsKafkaNetworkingAccess" : { "type" : "object", + "description" : "Information about the networking access.", "properties" : { + "connectionId" : { + "type" : "string", + "description" : "Reserved. Will be used by PRIVATE_LINK connection type.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" + }, "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.", @@ -50816,28 +54103,26 @@ }, "readOnly" : true }, - "roleNames" : { - "type" : "array", - "description" : "One or more organization- or project-level roles to assign to the MongoDB Cloud user.", - "items" : { - "type" : "string", - "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] - }, - "uniqueItems" : true + "name" : { + "type" : "string", + "description" : "Reserved. Will be used by PRIVATE_LINK connection type." }, - "teamId" : { + "type" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the team.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" + "description" : "Selected networking type. Either PUBLIC, VPC or PRIVATE_LINK. Defaults to PUBLIC. For VPC, ensure that VPC peering exists and connectivity has been established between Atlas VPC and the VPC where Kafka cluster is hosted for the connection to function properly. PRIVATE_LINK support is coming soon.", + "enum" : [ "PUBLIC", "VPC", "PRIVATE_LINK" ], + "title" : "Networking Access Type" } } }, - "TeamUpdate" : { + "StreamsKafkaSecurity" : { "type" : "object", + "description" : "Properties for the secure transport connection to Kafka. For SSL, this can include the trusted certificate to use.", "properties" : { + "brokerPublicCertificate" : { + "type" : "string", + "description" : "A trusted, public x509 certificate for connecting to Kafka over SSL." + }, "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.", @@ -50850,108 +54135,83 @@ }, "readOnly" : true }, - "name" : { - "type" : "string", - "description" : "Human-readable label that identifies the team.", - "writeOnly" : true - } - }, - "required" : [ "name" ] - }, - "TenantHardwareSpec" : { - "type" : "object", - "properties" : { - "instanceSize" : { + "protocol" : { "type" : "string", - "description" : "Hardware specification for the instances in this M0/M2/M5 tier cluster.", - "enum" : [ "M0", "M2", "M5" ], - "title" : "Tenant Instance Sizes" + "description" : "Describes the transport type. Can be either PLAINTEXT or SSL." } } }, - "TenantHardwareSpec20240805" : { + "StreamsMatcher" : { "type" : "object", + "description" : "Rules to apply when comparing a stream processing instance or stream processor against this alert configuration.", "properties" : { - "diskSizeGB" : { - "type" : "number", - "format" : "double", - "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", - "maximum" : 4096, - "minimum" : 10 + "fieldName" : { + "$ref" : "#/components/schemas/StreamsMatcherField" }, - "instanceSize" : { + "operator" : { "type" : "string", - "description" : "Hardware specification for the instances in this M0/M2/M5 tier cluster.", - "enum" : [ "M0", "M2", "M5" ], - "title" : "Tenant Instance Sizes" + "description" : "Comparison operator to apply when checking the current metric value against **matcher[n].value**.", + "enum" : [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ] + }, + "value" : { + "type" : "string", + "description" : "Value to match or exceed using the specified **matchers.operator**.", + "example" : "event-replica-set" } - } + }, + "required" : [ "fieldName", "operator", "value" ], + "title" : "Matchers" }, - "TenantRegionConfig" : { - "type" : "object", - "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`.", - "enum" : [ "AWS", "GCP", "AZURE" ] - } - } - } ], - "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", - "title" : "Tenant Regional Replication Specifications" + "StreamsMatcherField" : { + "type" : "string", + "description" : "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", + "enum" : [ "INSTANCE_NAME", "PROCESSOR_NAME" ], + "example" : "INSTANCE_NAME", + "title" : "Streams Matcher Fields" }, - "TenantRegionConfig20240805" : { + "StreamsOptions" : { "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/CloudRegionConfig20240805" - }, { - "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`.", - "enum" : [ "AWS", "GCP", "AZURE" ] - } + "description" : "Optional configuration for the stream processor.", + "properties" : { + "dlq" : { + "$ref" : "#/components/schemas/StreamsDLQ" + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true } - } ], - "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", - "title" : "Tenant Regional Replication Specifications" + } }, - "TenantRestore" : { + "StreamsPrivateLinkConnection" : { "type" : "object", + "description" : "Container for metadata needed to create a Private Link connection.", "properties" : { - "clusterName" : { + "_id" : { "type" : "string", - "description" : "Human-readable label that identifies the source cluster.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "readOnly" : true + "description" : "The ID of the Private Link connection." }, - "deliveryType" : { + "dnsDomain" : { "type" : "string", - "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", - "enum" : [ "RESTORE", "DOWNLOAD" ], - "readOnly" : true + "description" : "Domain name of Confluent cluster." }, - "expirationDate" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "dnsSubDomain" : { + "type" : "array", + "description" : "Sub-Domain name of Confluent cluster. These are typically your availability zones.", + "items" : { + "type" : "string" + } }, - "id" : { + "interfaceEndpointId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "description" : "Interface endpoint ID that is created from the service endpoint ID provided." }, "links" : { "type" : "array", @@ -50965,354 +54225,451 @@ }, "readOnly" : true }, - "projectId" : { + "provider" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "description" : "Provider where the Kafka cluster is deployed." }, - "restoreFinishedDate" : { + "region" : { "type" : "string", - "format" : "date-time", - "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.", - "readOnly" : true + "description" : "Domain name of Confluent cluster." }, - "restoreScheduledDate" : { + "serviceEndpointId" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "description" : "AWS Service Endpoint ID." }, - "snapshotFinishedDate" : { + "state" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "description" : "State the connection is in." }, - "snapshotId" : { + "vendor" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", + "description" : "Vendor who manages the Kafka cluster." + } + } + }, + "StreamsProcessor" : { + "type" : "object", + "description" : "An atlas stream processor.", + "properties" : { + "_id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal character string that identifies the stream processor.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" - }, - "snapshotUrl" : { - "type" : "string", - "description" : "Internet address from which you can download the compressed snapshot files. The resource returns this parameter when `\"deliveryType\" : \"DOWNLOAD\"`.", + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "status" : { - "type" : "string", - "description" : "Phase of the restore workflow for this job at the time this resource made this request.", - "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, "readOnly" : true }, - "targetDeploymentItemName" : { + "name" : { "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.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + "description" : "Human-readable name of the stream processor." }, - "targetProjectId" : { - "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", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$" + "options" : { + "$ref" : "#/components/schemas/StreamsOptions" + }, + "pipeline" : { + "type" : "array", + "description" : "Stream aggregation pipeline you want to apply to your streaming data.", + "externalDocs" : { + "description" : "Supported Aggregation Pipeline Stages", + "url" : "https://www.mongodb.com/docs/atlas/atlas-stream-processing/stream-aggregation/#std-label-stream-aggregation" + }, + "items" : { + "$ref" : "#/components/schemas/Document" + } } - }, - "required" : [ "snapshotId", "targetDeploymentItemName" ] + } }, - "TextSearchHostStatusDetail" : { + "StreamsProcessorWithStats" : { "type" : "object", + "description" : "An atlas stream processor with optional stats.", "properties" : { - "hostname" : { + "_id" : { "type" : "string", - "description" : "Hostname that corresponds to the status detail." + "description" : "Unique 24-hexadecimal character string that identifies the stream processor.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "mainIndex" : { - "$ref" : "#/components/schemas/TextSearchIndexStatusDetail" + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true }, - "queryable" : { - "type" : "boolean", - "description" : "Flag that indicates whether the index is queryable on the host." + "name" : { + "type" : "string", + "description" : "Human-readable name of the stream processor.", + "readOnly" : true }, - "stagedIndex" : { - "$ref" : "#/components/schemas/TextSearchIndexStatusDetail" + "options" : { + "$ref" : "#/components/schemas/StreamsOptions" }, - "status" : { + "pipeline" : { + "type" : "array", + "description" : "Stream aggregation pipeline you want to apply to your streaming data.", + "items" : { + "$ref" : "#/components/schemas/Document" + }, + "readOnly" : true + }, + "state" : { "type" : "string", - "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", - "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + "description" : "The state of the stream processor. Commonly occurring states are 'CREATED', 'STARTED', 'STOPPED' and 'FAILED'.", + "readOnly" : true + }, + "stats" : { + "type" : "object", + "additionalProperties" : { + "type" : "object", + "description" : "The stats associated with the stream processor.", + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor" + }, + "readOnly" : true + }, + "description" : "The stats associated with the stream processor.", + "externalDocs" : { + "url" : "https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor" + }, + "readOnly" : true } }, - "title" : "Text Search Host Status Detail" + "required" : [ "_id", "name", "pipeline", "state" ] }, - "TextSearchIndexCreateRequest" : { + "StreamsSampleConnection" : { "type" : "object", "allOf" : [ { - "$ref" : "#/components/schemas/SearchIndexCreateRequest" - }, { - "type" : "object", - "properties" : { - "definition" : { - "$ref" : "#/components/schemas/TextSearchIndexDefinition" - } + "$ref" : "#/components/schemas/StreamsConnection" + } ] + }, + "StreamsSampleConnections" : { + "type" : "object", + "description" : "Sample connections to add to SPI.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "solar" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to add a 'sample_stream_solar' connection." } - } ], - "description" : "Text Search Index Create Request", - "required" : [ "collectionName", "database", "definition", "name" ] + } }, - "TextSearchIndexDefinition" : { + "StreamsTenant" : { "type" : "object", - "description" : "The text search index definition set by the user.", "properties" : { - "analyzer" : { + "_id" : { "type" : "string", - "default" : "lucene.standard", - "description" : "Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves making the following changes to the text in fields:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\n MongoDB Cloud uses the process you select to build the Atlas Search index.", - "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ], - "externalDocs" : { - "description" : "Atlas Search Analyzers", - "url" : "https://dochub.mongodb.org/core/analyzers--fts" - } + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "analyzers" : { + "connections" : { "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" - }, + "description" : "List of connections configured in the stream instance.", "items" : { - "$ref" : "#/components/schemas/AtlasSearchAnalyzer" - } + "$ref" : "#/components/schemas/StreamsConnection" + }, + "readOnly" : true }, - "mappings" : { - "$ref" : "#/components/schemas/SearchMappings" + "dataProcessRegion" : { + "$ref" : "#/components/schemas/StreamsDataProcessRegion" }, - "searchAnalyzer" : { + "groupId" : { "type" : "string", - "default" : "lucene.standard", - "description" : "Method applied to identify words when searching this index.", - "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] + "description" : "Unique 24-hexadecimal character string that identifies the project.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true }, - "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 Stored Source Fields.", - "example" : { - "include | exclude" : [ "field1", "field2" ] + "hostnames" : { + "type" : "array", + "description" : "List that contains the hostnames assigned to the stream instance.", + "items" : { + "type" : "string", + "description" : "Unique hostname assigned to the stream instance.", + "readOnly" : true }, - "externalDocs" : { - "description" : "Stored Source Fields", - "url" : "https://dochub.mongodb.org/core/atlas-search-stored-source" - } + "readOnly" : true }, - "synonyms" : { + "links" : { "type" : "array", - "description" : "Rule sets that map words to their synonyms in this index.", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", "externalDocs" : { - "description" : "Synonym Mapping", - "url" : "https://dochub.mongodb.org/core/fts-synonym-mappings" + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" }, "items" : { - "$ref" : "#/components/schemas/SearchSynonymMappingDefinition" - } - } - }, - "required" : [ "mappings" ], - "title" : "Text Search Index Definition" - }, - "TextSearchIndexResponse" : { - "type" : "object", - "allOf" : [ { - "$ref" : "#/components/schemas/SearchIndexResponse" - }, { - "type" : "object", - "properties" : { - "latestDefinition" : { - "$ref" : "#/components/schemas/TextSearchIndexDefinition" - }, - "statusDetail" : { - "type" : "array", - "description" : "List of documents detailing index status on each host.", - "items" : { - "$ref" : "#/components/schemas/TextSearchHostStatusDetail" - } - }, - "synonymMappingStatus" : { - "type" : "string", - "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", - "enum" : [ "FAILED", "BUILDING", "READY" ] - }, - "synonymMappingStatusDetail" : { - "type" : "array", - "description" : "A list of documents describing the status of the index's synonym mappings on each search host. Only appears if the index has synonyms defined.", - "items" : { - "type" : "object", - "additionalProperties" : { - "$ref" : "#/components/schemas/SynonymMappingStatusDetail" - } - } - } + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the stream instance." + }, + "sampleConnections" : { + "$ref" : "#/components/schemas/StreamsSampleConnections" + }, + "streamConfig" : { + "$ref" : "#/components/schemas/StreamConfig" } - } ], - "title" : "Text Search Index Response" + } }, - "TextSearchIndexStatusDetail" : { + "SummaryNotification" : { "type" : "object", - "description" : "Contains status information about a text search index.", + "description" : "Summary notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", "properties" : { - "definition" : { - "$ref" : "#/components/schemas/TextSearchIndexDefinition" + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." }, - "definitionVersion" : { - "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" + "emailAddress" : { + "type" : "string", + "format" : "email", + "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:\n\n- specific MongoDB Cloud users (`\"notifications.[n].typeName\" : \"USER\"`)\n- MongoDB Cloud users with specific project roles (`\"notifications.[n].typeName\" : \"GROUP\"`)\n- MongoDB Cloud users with specific organization roles (`\"notifications.[n].typeName\" : \"ORG\"`)\n- MongoDB Cloud teams (`\"notifications.[n].typeName\" : \"TEAM\"`)\n\nTo send emails to one MongoDB Cloud user or grouping of users, set the **notifications.[n].emailEnabled** parameter." + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { + "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" ] + } + }, + "required" : [ "typeName" ], + "title" : "Summary Notification" + }, + "SynonymMappingStatusDetail" : { + "type" : "object", + "description" : "Contains the status of the index's synonym mappings on each search host. This field (and its subfields) only appear if the index has synonyms defined.", + "properties" : { "message" : { "type" : "string", "description" : "Optional message describing an error." }, "queryable" : { "type" : "boolean", - "description" : "Flag that indicates whether the index generation is queryable on the host." + "description" : "Flag that indicates whether the synonym mapping is queryable on a host." }, "status" : { - "type" : "string", - "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", - "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] - }, - "synonymMappingStatus" : { "type" : "string", "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", "enum" : [ "FAILED", "BUILDING", "READY" ] - }, - "synonymMappingStatusDetail" : { - "type" : "array", - "description" : "List of synonym statuses by mapping.", - "items" : { - "$ref" : "#/components/schemas/SynonymMappingStatusDetailMap" - } } }, - "title" : "Text Search Index Status Detail" + "title" : "Synonym Mapping Status Detail" }, - "ThirdPartyIntegration" : { + "SynonymMappingStatusDetailMap" : { "type" : "object", - "description" : "Collection of settings that describe third-party integrations.", - "discriminator" : { - "mapping" : { - "DATADOG" : "#/components/schemas/Datadog", - "MICROSOFT_TEAMS" : "#/components/schemas/MicrosoftTeams", - "NEW_RELIC" : "#/components/schemas/NewRelic", - "OPS_GENIE" : "#/components/schemas/OpsGenie", - "PAGER_DUTY" : "#/components/schemas/PagerDuty", - "PROMETHEUS" : "#/components/schemas/Prometheus", - "SLACK" : "#/components/schemas/Slack", - "VICTOR_OPS" : "#/components/schemas/VictorOps", - "WEBHOOK" : "#/components/schemas/Webhook" - }, - "propertyName" : "type" + "additionalProperties" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetail" }, + "x-additionalPropertiesName" : "Synonym Mapping Name" + }, + "SynonymSource" : { + "type" : "object", + "description" : "Data set that stores words and their applicable synonyms.", "properties" : { - "id" : { - "type" : "string", - "description" : "Integration id.", - "nullable" : true - }, - "type" : { + "collection" : { "type" : "string", - "description" : "Integration type", - "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], - "title" : "Integration Type" + "description" : "Label that identifies the MongoDB collection that stores words and their applicable synonyms." } }, - "title" : "Third-Party Integration" + "required" : [ "collection" ] }, - "TimeMetricAlertView" : { + "SystemStatus" : { "type" : "object", "properties" : { - "acknowledgedUntil" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + "apiKey" : { + "$ref" : "#/components/schemas/ApiKey" }, - "acknowledgementComment" : { + "appName" : { "type" : "string", - "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", - "example" : "Expiration on 3/19. Silencing for 7days.", - "maxLength" : 200 + "description" : "Human-readable label that identifies the service from which you requested this response.", + "enum" : [ "MongoDB Atlas" ], + "readOnly" : true }, - "acknowledgingUsername" : { + "build" : { "type" : "string", - "format" : "email", - "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "description" : "Unique 40-hexadecimal digit hash that identifies the latest git commit merged for this application.", + "example" : "83be55e140f493c88e7f578aae96548dd881587b", "readOnly" : true }, - "alertConfigId" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "throttling" : { + "type" : "boolean", + "description" : "Flag that indicates whether someone enabled throttling on this service.", + "readOnly" : true + } + }, + "required" : [ "apiKey", "appName", "build", "throttling" ] + }, + "TargetOrg" : { + "type" : "object", + "properties" : { + "linkToken" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "description" : "Link token that contains all the information required to complete the link." + } + }, + "required" : [ "linkToken" ] + }, + "TargetOrgRequest" : { + "type" : "object", + "properties" : { + "accessListIps" : { + "type" : "array", + "description" : "IP address access list entries associated with the API key.", + "items" : { + "type" : "string", + "description" : "One IP address access list entry associated with the API key." + } + } + } + }, + "Team" : { + "type" : "object", + "properties" : { + "id" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies this team.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "clusterName" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { "type" : "string", - "description" : "Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.", - "example" : "cluster1", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "description" : "Human-readable label that identifies the team." + }, + "usernames" : { + "type" : "array", + "description" : "List that contains the MongoDB Cloud users in this team.", + "items" : { + "type" : "string", + "format" : "email", + "description" : "List that contains email addresses that identify MongoDB Cloud users to in this team." + }, + "uniqueItems" : true + } + }, + "required" : [ "name" ] + }, + "TeamEvent" : { + "type" : "object", + "description" : "Team event identifies different activities around organization teams.", + "properties" : { + "apiKeyId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, "created" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "currentValue" : { - "$ref" : "#/components/schemas/TimeMetricValueView" - }, "eventTypeName" : { - "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + "$ref" : "#/components/schemas/TeamEventTypeView" }, "groupId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "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.", - "example" : "cloud-test.mongodb.com:27017", - "readOnly" : true - }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies this alert.", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "lastNotified" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", "readOnly" : true }, "links" : { @@ -51327,51 +54684,78 @@ }, "readOnly" : true }, - "metricName" : { - "type" : "string", - "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", - "example" : "ASSERT_USER", - "readOnly" : true - }, "orgId" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "replicaSetName" : { + "publicKey" : { "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.", - "example" : "event-replica-set", + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true }, - "resolved" : { + "raw" : { + "$ref" : "#/components/schemas/raw" + }, + "remoteAddress" : { "type" : "string", - "format" : "date-time", - "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\"`.", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", "readOnly" : true }, - "status" : { + "teamId" : { "type" : "string", - "description" : "State of this alert at the time you requested its details.", - "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], - "example" : "OPEN", + "description" : "Unique 24-hexadecimal digit string that identifies the organization team associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "updated" : { + "userId" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true } }, - "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Team Events" }, - "TimeMetricEventView" : { + "TeamEventTypeView" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TEAM_CREATED", "TEAM_DELETED", "TEAM_UPDATED", "TEAM_NAME_CHANGED", "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "example" : "TEAM_ADDED_TO_GROUP", + "title" : "Team Event Types" + }, + "TeamEventTypeViewForNdsGroup" : { + "type" : "string", + "description" : "Unique identifier of event type.", + "enum" : [ "TEAM_ADDED_TO_GROUP", "TEAM_REMOVED_FROM_GROUP", "TEAM_ROLES_MODIFIED" ], + "example" : "TEAM_ADDED_TO_GROUP", + "title" : "Team Event Types" + }, + "TeamEventViewForNdsGroup" : { "type" : "object", + "description" : "Team event identifies different activities around organization teams.", "properties" : { "apiKeyId" : { "type" : "string", @@ -51388,11 +54772,8 @@ "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "currentValue" : { - "$ref" : "#/components/schemas/TimeMetricValueView" - }, "eventTypeName" : { - "$ref" : "#/components/schemas/HostMetricEventTypeView" + "$ref" : "#/components/schemas/TeamEventTypeViewForNdsGroup" }, "groupId" : { "type" : "string", @@ -51430,11 +54811,6 @@ }, "readOnly" : true }, - "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" : { "type" : "string", "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", @@ -51444,13 +54820,6 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "port" : { - "type" : "integer", - "format" : "int32", - "description" : "IANA port on which the MongoDB process listens for requests.", - "example" : 27017, - "readOnly" : true - }, "publicKey" : { "type" : "string", "format" : "email", @@ -51468,16 +54837,13 @@ "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", "readOnly" : true }, - "replicaSetName" : { - "type" : "string", - "description" : "Human-readable label of the replica set associated with the event.", - "example" : "event-replica-set", - "readOnly" : true - }, - "shardName" : { + "teamId" : { "type" : "string", - "description" : "Human-readable label of the shard associated with the event.", - "example" : "event-sh-01", + "description" : "Unique 24-hexadecimal digit string that identifies the organization team associated with this event.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, "userId" : { @@ -51497,250 +54863,220 @@ "readOnly" : true } }, - "required" : [ "created", "eventTypeName", "id" ] + "required" : [ "created", "eventTypeName", "id" ], + "title" : "Team Events" }, - "TimeMetricThresholdView" : { + "TeamNotification" : { "type" : "object", + "description" : "Team notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", "properties" : { - "metricName" : { - "type" : "string", - "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." + "delayMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification." }, - "mode" : { + "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:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" + }, + "intervalMin" : { + "type" : "integer", + "format" : "int32", + "description" : "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", + "minimum" : 5 + }, + "notifierId" : { "type" : "string", - "description" : "MongoDB Cloud computes the current metric value as an average.", - "enum" : [ "AVERAGE" ] + "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" }, - "operator" : { - "$ref" : "#/components/schemas/Operator" + "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:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`" }, - "threshold" : { - "type" : "number", - "format" : "double", - "description" : "Value of metric that, when exceeded, triggers an alert." + "teamId" : { + "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", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" }, - "units" : { - "$ref" : "#/components/schemas/TimeMetricUnits" - } - }, - "required" : [ "metricName" ] - }, - "TimeMetricUnits" : { - "type" : "string", - "default" : "HOURS", - "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", - "enum" : [ "NANOSECONDS", "MILLISECONDS", "MILLION_MINUTES", "SECONDS", "MINUTES", "HOURS", "DAYS" ], - "title" : "Time Metric Units" - }, - "TimeMetricValueView" : { - "type" : "object", - "description" : "Measurement of the **metricName** recorded at the time of the event.", - "properties" : { - "number" : { - "type" : "number", - "format" : "double", - "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", - "readOnly" : true + "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" }, - "units" : { - "$ref" : "#/components/schemas/TimeMetricUnits" - } - }, - "readOnly" : true, - "title" : "Time Metric Value" - }, - "TokenFilterEnglishPossessive" : { - "type" : "object", - "description" : "Filter that removes possessives (trailing 's) from words.", - "properties" : { - "type" : { + "typeName" : { "type" : "string", - "description" : "Human-readable label that identifies this token filter type.", - "enum" : [ "englishPossessive" ] + "description" : "Human-readable label that displays the alert notification type.", + "enum" : [ "TEAM" ] } }, - "required" : [ "type" ], - "title" : "englishPossessive" + "required" : [ "typeName" ], + "title" : "Team Notification" }, - "TokenFilterFlattenGraph" : { + "TeamResponse" : { "type" : "object", - "description" : "Filter that transforms a token filter graph, such as the token filter graph that the wordDelimiterGraph token filter produces, into a flat form suitable for indexing.", "properties" : { - "type" : { + "id" : { "type" : "string", - "description" : "Human-readable label that identifies this token filter type.", - "enum" : [ "flattenGraph" ] + "description" : "Unique 24-hexadecimal digit string that identifies this team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { + "type" : "string", + "description" : "Human-readable label that identifies the team." } - }, - "required" : [ "type" ], - "title" : "flattenGraph" + } }, - "TokenFilterPorterStemming" : { + "TeamRole" : { "type" : "object", - "description" : "Filter that uses the porter stemming algorithm to remove the common morphological and inflectional suffixes from words in English. It expects lowercase text and doesn't work as expected for uppercase text.", "properties" : { - "type" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "roleNames" : { + "type" : "array", + "description" : "One or more organization- or project-level roles to assign to the MongoDB Cloud user.", + "items" : { + "type" : "string", + "enum" : [ "GROUP_CLUSTER_MANAGER", "GROUP_DATA_ACCESS_ADMIN", "GROUP_DATA_ACCESS_READ_ONLY", "GROUP_DATA_ACCESS_READ_WRITE", "GROUP_OWNER", "GROUP_READ_ONLY" ] + }, + "uniqueItems" : true + }, + "teamId" : { "type" : "string", - "description" : "Human-readable label that identifies this token filter type.", - "enum" : [ "porterStemming" ] + "description" : "Unique 24-hexadecimal character string that identifies the team.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$" } - }, - "required" : [ "type" ], - "title" : "porterStemming" + } }, - "TokenFilterSpanishPluralStemming" : { + "TeamUpdate" : { "type" : "object", - "description" : "Filter that stems Spanish plural words. It expects lowercase text.", "properties" : { - "type" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "name" : { "type" : "string", - "description" : "Human-readable label that identifies this token filter type.", - "enum" : [ "spanishPluralStemming" ] + "description" : "Human-readable label that identifies the team.", + "writeOnly" : true } }, - "required" : [ "type" ], - "title" : "spanishPluralStemming" + "required" : [ "name" ] }, - "TokenFilterStempel" : { + "TenantHardwareSpec" : { "type" : "object", - "description" : "Filter that uses Lucene's default Polish stemmer table to stem words in the Polish language. It expects lowercase text.", - "externalDocs" : { - "description" : "Default Polish stemmer table", - "url" : "https://lucene.apache.org/core/9_2_0/analysis/stempel/org/apache/lucene/analysis/pl/PolishAnalyzer.html#DEFAULT_STEMMER_FILE" - }, "properties" : { - "type" : { + "instanceSize" : { "type" : "string", - "description" : "Human-readable label that identifies this token filter type.", - "enum" : [ "stempel" ] + "description" : "Hardware specification for the instances in this M0/M2/M5 tier cluster.", + "enum" : [ "M0", "M2", "M5" ], + "title" : "Tenant Instance Sizes" } - }, - "required" : [ "type" ], - "title" : "stempel" + } }, - "TokenFilterWordDelimiterGraph" : { + "TenantHardwareSpec20240805" : { "type" : "object", - "description" : "Filter that splits tokens into sub-tokens based on configured rules.", "properties" : { - "delimiterOptions" : { - "type" : "object", - "description" : "Object that contains the rules that determine how to split words into sub-words.", - "properties" : { - "concatenateAll" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether to concatenate runs." - }, - "concatenateNumbers" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether to concatenate runs of sub-numbers." - }, - "concatenateWords" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether to concatenate runs of sub-words." - }, - "generateNumberParts" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether to split tokens based on sub-numbers. For example, if `true`, this option splits `100-2` into `100` and `2`." - }, - "generateWordParts" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether to split tokens based on sub-words." - }, - "ignoreKeywords" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether to skip tokens with the `keyword` attribute set to `true`" - }, - "preserveOriginal" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether to generate tokens of the original words." - }, - "splitOnCaseChange" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether to split tokens based on letter-case transitions." - }, - "splitOnNumerics" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether to split tokens based on letter-number transitions." - }, - "stemEnglishPossessive" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether to remove trailing possessives from each sub-word." - } - } - }, - "protectedWords" : { - "type" : "object", - "description" : "Object that contains options for protected words.", - "properties" : { - "ignoreCase" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether to ignore letter case sensitivity for protected words." - }, - "words" : { - "type" : "array", - "description" : "List that contains the tokens to protect from delimination.", - "items" : { - "type" : "string" - } - } - }, - "required" : [ "words" ] + "diskSizeGB" : { + "type" : "number", + "format" : "double", + "description" : "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value must be equal for all shards and node types.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier.", + "maximum" : 4096, + "minimum" : 10 }, - "type" : { + "instanceSize" : { "type" : "string", - "description" : "Human-readable label that identifies this token filter type.", - "enum" : [ "wordDelimiterGraph" ] + "description" : "Hardware specification for the instances in this M0/M2/M5 tier cluster.", + "enum" : [ "M0", "M2", "M5" ], + "title" : "Tenant Instance Sizes" } - }, - "required" : [ "type" ], - "title" : "wordDelimiterGraph" + } }, - "TokenFilterkStemming" : { + "TenantRegionConfig" : { "type" : "object", - "description" : "Filter that combines algorithmic stemming with a built-in dictionary for the English language to stem words.", - "properties" : { - "type" : { - "type" : "string", - "description" : "Human-readable label that identifies this token filter type.", - "enum" : [ "kStemming" ] + "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`.", + "enum" : [ "AWS", "GCP", "AZURE" ] + } } - }, - "required" : [ "type" ], - "title" : "kStemming" + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Tenant Regional Replication Specifications" }, - "TriggerIngestionPipelineRequest" : { + "TenantRegionConfig20240805" : { "type" : "object", - "properties" : { - "datasetRetentionPolicy" : { - "$ref" : "#/components/schemas/DatasetRetentionPolicy" - }, - "snapshotId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "writeOnly" : true + "allOf" : [ { + "$ref" : "#/components/schemas/CloudRegionConfig20240805" + }, { + "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`.", + "enum" : [ "AWS", "GCP", "AZURE" ] + } } - }, - "required" : [ "snapshotId" ] + } ], + "description" : "Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.", + "title" : "Tenant Regional Replication Specifications" }, - "USSBackupRestoreJob20250101" : { + "TenantRestore" : { "type" : "object", - "description" : "Details for one restore job of a USS instance.", "properties" : { + "clusterName" : { + "type" : "string", + "description" : "Human-readable label that identifies the source cluster.", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "readOnly" : true + }, "deliveryType" : { "type" : "string", "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", @@ -51762,14 +55098,6 @@ "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "instanceName" : { - "type" : "string", - "description" : "Human-readable label that identifies the source instance.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "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.", @@ -51815,8 +55143,7 @@ "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "pattern" : "^([a-f0-9]{24})$" }, "snapshotUrl" : { "type" : "string", @@ -51831,176 +55158,311 @@ }, "targetDeploymentItemName" : { "type" : "string", - "description" : "Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another USS instance or Dedicated cluster tier.", + "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.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", - "readOnly" : true + "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" }, "targetProjectId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.", + "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the cluster to which you want to restore the snapshot.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "pattern" : "^([a-f0-9]{24})$" } }, - "title" : "USS Backup Restore Job" + "required" : [ "snapshotId", "targetDeploymentItemName" ] + }, + "TenantWithSampleConnections" : { + "type" : "object" }, - "USSBackupRestoreJobCreate20250101" : { + "TextSearchHostStatusDetail" : { "type" : "object", - "description" : "Details to create one restore job of a USS instance.", "properties" : { - "_snapshotId" : { + "hostname" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to restore.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "writeOnly" : true + "description" : "Hostname that corresponds to the status detail." }, - "_targetDeploymentItemName" : { - "type" : "string", - "description" : "Human-readable label that identifies the instance or cluster on the target project to which you want to restore the snapshot. You can restore the snapshot to another USS instance or Dedicated cluster tier.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$", - "writeOnly" : true + "mainIndex" : { + "$ref" : "#/components/schemas/TextSearchIndexStatusDetail" }, - "_targetProjectId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project that contains the instance or cluster to which you want to restore the snapshot.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "writeOnly" : true + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index is queryable on the host." }, - "deliveryType" : { - "type" : "string", - "description" : "Means by which this resource returns the snapshot to the requesting MongoDB Cloud user.", - "enum" : [ "RESTORE", "DOWNLOAD" ], - "readOnly" : true + "stagedIndex" : { + "$ref" : "#/components/schemas/TextSearchIndexStatusDetail" }, - "expirationDate" : { + "status" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true - }, - "id" : { + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] + } + }, + "title" : "Text Search Host Status Detail" + }, + "TextSearchIndexCreateRequest" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexCreateRequest" + }, { + "type" : "object", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" + } + } + } ], + "description" : "Text Search Index Create Request", + "required" : [ "collectionName", "database", "definition", "name" ] + }, + "TextSearchIndexDefinition" : { + "type" : "object", + "description" : "The text search index definition set by the user.", + "properties" : { + "analyzer" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the restore job.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "default" : "lucene.standard", + "description" : "Specific pre-defined method chosen to convert database field text into searchable words. This conversion reduces the text of fields into the smallest units of text. These units are called a **term** or **token**. This process, known as tokenization, involves making the following changes to the text in fields:\n\n- extracting words\n- removing punctuation\n- removing accents\n- changing to lowercase\n- removing common words\n- reducing words to their root form (stemming)\n- changing words to their base form (lemmatization)\n MongoDB Cloud uses the process you select to build the Atlas Search index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ], + "externalDocs" : { + "description" : "Atlas Search Analyzers", + "url" : "https://dochub.mongodb.org/core/analyzers--fts" + } }, - "instanceName" : { + "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" + }, + "items" : { + "$ref" : "#/components/schemas/AtlasSearchAnalyzer" + } + }, + "mappings" : { + "$ref" : "#/components/schemas/SearchMappings" + }, + "searchAnalyzer" : { "type" : "string", - "description" : "Human-readable label that identifies the source instance.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "readOnly" : true + "default" : "lucene.standard", + "description" : "Method applied to identify words when searching this index.", + "enum" : [ "lucene.standard", "lucene.simple", "lucene.whitespace", "lucene.keyword", "lucene.arabic", "lucene.armenian", "lucene.basque", "lucene.bengali", "lucene.brazilian", "lucene.bulgarian", "lucene.catalan", "lucene.chinese", "lucene.cjk", "lucene.czech", "lucene.danish", "lucene.dutch", "lucene.english", "lucene.finnish", "lucene.french", "lucene.galician", "lucene.german", "lucene.greek", "lucene.hindi", "lucene.hungarian", "lucene.indonesian", "lucene.irish", "lucene.italian", "lucene.japanese", "lucene.korean", "lucene.kuromoji", "lucene.latvian", "lucene.lithuanian", "lucene.morfologik", "lucene.nori", "lucene.norwegian", "lucene.persian", "lucene.portuguese", "lucene.romanian", "lucene.russian", "lucene.smartcn", "lucene.sorani", "lucene.spanish", "lucene.swedish", "lucene.thai", "lucene.turkish", "lucene.ukrainian" ] }, - "links" : { + "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 Stored Source Fields.", + "example" : { + "include | exclude" : [ "field1", "field2" ] + }, + "externalDocs" : { + "description" : "Stored Source Fields", + "url" : "https://dochub.mongodb.org/core/atlas-search-stored-source" + } + }, + "synonyms" : { "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.", + "description" : "Rule sets that map words to their synonyms in this index.", "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + "description" : "Synonym Mapping", + "url" : "https://dochub.mongodb.org/core/fts-synonym-mappings" }, "items" : { - "$ref" : "#/components/schemas/Link" + "$ref" : "#/components/schemas/SearchSynonymMappingDefinition" + } + } + }, + "required" : [ "mappings" ], + "title" : "Text Search Index Definition" + }, + "TextSearchIndexResponse" : { + "type" : "object", + "allOf" : [ { + "$ref" : "#/components/schemas/SearchIndexResponse" + }, { + "type" : "object", + "properties" : { + "latestDefinition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" }, - "readOnly" : true + "statusDetail" : { + "type" : "array", + "description" : "List of documents detailing index status on each host.", + "items" : { + "$ref" : "#/components/schemas/TextSearchHostStatusDetail" + } + }, + "synonymMappingStatus" : { + "type" : "string", + "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", + "enum" : [ "FAILED", "BUILDING", "READY" ] + }, + "synonymMappingStatusDetail" : { + "type" : "array", + "description" : "A list of documents describing the status of the index's synonym mappings on each search host. Only appears if the index has synonyms defined.", + "items" : { + "type" : "object", + "additionalProperties" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetail" + } + } + } + } + } ], + "title" : "Text Search Index Response" + }, + "TextSearchIndexStatusDetail" : { + "type" : "object", + "description" : "Contains status information about a text search index.", + "properties" : { + "definition" : { + "$ref" : "#/components/schemas/TextSearchIndexDefinition" }, - "projectId" : { - "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the project from which the restore job originated.", - "example" : "32b6e34b3d91647abb20e7b8", - "maxLength" : 24, - "minLength" : 24, - "pattern" : "^([a-f0-9]{24})$", - "readOnly" : true + "definitionVersion" : { + "$ref" : "#/components/schemas/SearchIndexDefinitionVersion" }, - "restoreFinishedDate" : { + "message" : { "type" : "string", - "format" : "date-time", - "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.", - "readOnly" : true + "description" : "Optional message describing an error." }, - "restoreScheduledDate" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud will restore this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "queryable" : { + "type" : "boolean", + "description" : "Flag that indicates whether the index generation is queryable on the host." }, - "snapshotFinishedDate" : { + "status" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", - "readOnly" : true + "description" : "Condition of the search index when you made this request.\n\n | Status | Index Condition |\n |---|---|\n | DELETING | The index is being deleted. |\n | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. |\n | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. |\n | PENDING | Atlas has not yet started building the index. |\n | BUILDING | Atlas is building or re-building the index after an edit. |\n | READY | The index is ready and can support queries. |\n", + "enum" : [ "DELETING", "FAILED", "STALE", "PENDING", "BUILDING", "READY", "DOES_NOT_EXIST" ] }, - "snapshotUrl" : { + "synonymMappingStatus" : { "type" : "string", - "description" : "Internet address from which you can download the compressed snapshot files. The resource returns this parameter when `\"deliveryType\" : \"DOWNLOAD\"`.", - "readOnly" : true + "description" : "Status that describes this index's synonym mappings. This status appears only if the index has synonyms defined.", + "enum" : [ "FAILED", "BUILDING", "READY" ] }, - "status" : { - "type" : "string", - "description" : "Phase of the restore workflow for this job at the time this resource made this request.", - "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], - "readOnly" : true + "synonymMappingStatusDetail" : { + "type" : "array", + "description" : "List of synonym statuses by mapping.", + "items" : { + "$ref" : "#/components/schemas/SynonymMappingStatusDetailMap" + } } }, - "required" : [ "_snapshotId", "_targetDeploymentItemName" ], - "title" : "Create USS Backup Restore Job" + "title" : "Text Search Index Status Detail" }, - "USSBackupSettings20250101" : { + "ThirdPartyIntegration" : { "type" : "object", - "description" : "USS backup configuration", + "description" : "Collection of settings that describe third-party integrations.", + "discriminator" : { + "mapping" : { + "DATADOG" : "#/components/schemas/Datadog", + "MICROSOFT_TEAMS" : "#/components/schemas/MicrosoftTeams", + "NEW_RELIC" : "#/components/schemas/NewRelic", + "OPS_GENIE" : "#/components/schemas/OpsGenie", + "PAGER_DUTY" : "#/components/schemas/PagerDuty", + "PROMETHEUS" : "#/components/schemas/Prometheus", + "SLACK" : "#/components/schemas/Slack", + "VICTOR_OPS" : "#/components/schemas/VictorOps", + "WEBHOOK" : "#/components/schemas/Webhook" + }, + "propertyName" : "type" + }, "properties" : { - "enabled" : { - "type" : "boolean", - "default" : true, - "description" : "Flag that indicates whether backups are performed for this USS instance. Backup uses [TODO](TODO) for USS instances.", - "readOnly" : true + "id" : { + "type" : "string", + "description" : "Integration id.", + "nullable" : true + }, + "type" : { + "type" : "string", + "description" : "Integration type", + "enum" : [ "PAGER_DUTY", "SLACK", "DATADOG", "NEW_RELIC", "OPS_GENIE", "VICTOR_OPS", "WEBHOOK", "HIP_CHAT", "PROMETHEUS", "MICROSOFT_TEAMS" ], + "title" : "Integration Type" } }, - "readOnly" : true, - "title" : "USS backup configuration" + "title" : "Third-Party Integration" }, - "USSBackupSnapshot20250101" : { + "TimeMetricAlertView" : { "type" : "object", - "description" : "Details for one snapshot of a USS instance.", "properties" : { - "expiration" : { + "acknowledgedUntil" : { + "type" : "string", + "format" : "date-time", + "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.\n\n- To acknowledge this alert forever, set the parameter value to 100 years in the future.\n\n- To unacknowledge a previously acknowledged alert, do not set this parameter value." + }, + "acknowledgementComment" : { + "type" : "string", + "description" : "Comment that a MongoDB Cloud user submitted when acknowledging the alert.", + "example" : "Expiration on 3/19. Silencing for 7days.", + "maxLength" : 200 + }, + "acknowledgingUsername" : { + "type" : "string", + "format" : "email", + "description" : "MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.", + "readOnly" : true + }, + "alertConfigId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "clusterName" : { + "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.", + "example" : "cluster1", + "maxLength" : 64, + "minLength" : 1, + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$", + "readOnly" : true + }, + "created" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when the download link no longer works. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "finishTime" : { + "currentValue" : { + "$ref" : "#/components/schemas/TimeMetricValueView" + }, + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeViewAlertable" + }, + "groupId" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud completed writing this snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Unique 24-hexadecimal digit string that identifies the project that owns this alert.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "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.", + "example" : "cloud-test.mongodb.com:27017", "readOnly" : true }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the snapshot.", + "description" : "Unique 24-hexadecimal digit string that identifies this alert.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, + "lastNotified" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.", + "readOnly" : true + }, "links" : { "type" : "array", "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", @@ -52013,116 +55475,76 @@ }, "readOnly" : true }, - "mongoDBVersion" : { + "metricName" : { "type" : "string", - "description" : "MongoDB host version that the snapshot runs.", + "description" : "Name of the metric against which Atlas checks the configured `metricThreshold.threshold`.\n\nTo learn more about the available metrics, see Host Metrics.\n\n**NOTE**: If you set eventTypeName to OUTSIDE_SERVERLESS_METRIC_THRESHOLD, you can specify only metrics available for serverless. To learn more, see Serverless Measurements.", + "example" : "ASSERT_USER", "readOnly" : true }, - "scheduledTime" : { + "orgId" : { "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud will take the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "description" : "Unique 24-hexadecimal character string that identifies the organization that owns the project to which this alert applies.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "startTime" : { + "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.", + "example" : "event-replica-set", + "readOnly" : true + }, + "resolved" : { "type" : "string", "format" : "date-time", - "description" : "Date and time when MongoDB Cloud began taking the snapshot. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", + "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\"`.", "readOnly" : true }, "status" : { "type" : "string", - "description" : "Phase of the workflow for this snapshot at the time this resource made this request.", - "enum" : [ "PENDING", "QUEUED", "RUNNING", "FAILED", "COMPLETED" ], + "description" : "State of this alert at the time you requested its details.", + "enum" : [ "CANCELLED", "CLOSED", "OPEN", "TRACKING" ], + "example" : "OPEN", + "readOnly" : true + }, + "updated" : { + "type" : "string", + "format" : "date-time", + "description" : "Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true } }, - "title" : "USS Backup Snapshot" + "required" : [ "alertConfigId", "created", "eventTypeName", "id", "status", "updated" ] }, - "USSBackupSnapshotDownloadCreate20250101" : { + "TimeMetricEventView" : { "type" : "object", - "description" : "Details for one backup snapshot download of a USS instance.", "properties" : { - "_snapshotId" : { + "apiKeyId" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the snapshot to download.", + "description" : "Unique 24-hexadecimal digit string that identifies the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **userId** parameter.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", - "writeOnly" : true - }, - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true - } - }, - "required" : [ "_snapshotId" ], - "title" : "USS Backup Snapshot Download Create" - }, - "USSConnectionStrings20250101" : { - "type" : "object", - "description" : "Collection of Uniform Resource Locators that point to the MongoDB database.", - "externalDocs" : { - "description" : "Connection string URI format.", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, - "properties" : { - "standard" : { - "type" : "string", - "description" : "Public connection string that you can use to connect to this cluster. This connection string uses the mongodb:// protocol.", - "externalDocs" : { - "description" : "Connection String URI Format", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, - "readOnly" : true - }, - "standardSrv" : { - "type" : "string", - "description" : "Public connection string that you can use to connect to this USS instance. This connection string uses the `mongodb+srv://` protocol.", - "externalDocs" : { - "description" : "Connection String URI Format", - "url" : "https://docs.mongodb.com/manual/reference/connection-string/" - }, "readOnly" : true - } - }, - "readOnly" : true, - "title" : "USS Instance Connection Strings" - }, - "USSInstanceDescription20250101" : { - "type" : "object", - "description" : "Group of settings that configure a MongoDB USS instance.", - "properties" : { - "backupSettings" : { - "$ref" : "#/components/schemas/USSBackupSettings20250101" }, - "clusterType" : { + "created" : { "type" : "string", - "description" : "USS instance topology.", - "enum" : [ "REPLICASET", "LOADBALANCED" ], + "format" : "date-time", + "description" : "Date and time when this event occurred. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "readOnly" : true }, - "connectionStrings" : { - "$ref" : "#/components/schemas/USSConnectionStrings20250101" + "currentValue" : { + "$ref" : "#/components/schemas/TimeMetricValueView" }, - "createDate" : { - "type" : "string", - "format" : "date-time", - "description" : "Date and time when MongoDB Cloud created this instance. This parameter expresses its value in ISO 8601 format in UTC.", - "readOnly" : true + "eventTypeName" : { + "$ref" : "#/components/schemas/HostMetricEventTypeView" }, "groupId" : { "type" : "string", - "description" : "Unique 24-hexadecimal character string that identifies the project.", + "description" : "Unique 24-hexadecimal digit string that identifies the project in which the event occurred. The **eventId** identifies the specific event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, @@ -52131,13 +55553,19 @@ }, "id" : { "type" : "string", - "description" : "Unique 24-hexadecimal digit string that identifies the instance.", + "description" : "Unique 24-hexadecimal digit string that identifies the event.", "example" : "32b6e34b3d91647abb20e7b8", "maxLength" : 24, "minLength" : 24, "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, + "isGlobalAdmin" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether a MongoDB employee triggered the specified event.", + "readOnly" : true + }, "links" : { "type" : "array", "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", @@ -52150,167 +55578,314 @@ }, "readOnly" : true }, - "mongoDBVersion" : { + "metricName" : { "type" : "string", - "description" : "Version of MongoDB that the instance runs.", - "pattern" : "([\\d]+\\.[\\d]+\\.[\\d]+)", + "description" : "Human-readable label of the metric associated with the **alertId**. This field may change type of **currentValue** field.", "readOnly" : true }, - "name" : { + "orgId" : { "type" : "string", - "description" : "Human-readable label that identifies the instance.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "description" : "Unique 24-hexadecimal digit string that identifies the organization to which these events apply.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "readOnly" : true }, - "providerSettings" : { - "$ref" : "#/components/schemas/USSProviderSettings20250101" + "port" : { + "type" : "integer", + "format" : "int32", + "description" : "IANA port on which the MongoDB process listens for requests.", + "example" : 27017, + "readOnly" : true }, - "stateName" : { + "publicKey" : { "type" : "string", - "description" : "Human-readable label that indicates the current operating condition of this instance.", - "enum" : [ "IDLE", "CREATING", "UPDATING", "DELETING", "REPAIRING" ], + "format" : "email", + "description" : "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that triggered the event. If this resource returns this parameter, it doesn't return the **username** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true }, - "tags" : { - "type" : "array", - "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.", - "externalDocs" : { - "description" : "Resource Tags", - "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" - }, - "items" : { - "$ref" : "#/components/schemas/ResourceTag" - } + "raw" : { + "$ref" : "#/components/schemas/raw" }, - "terminationProtectionEnabled" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + "remoteAddress" : { + "type" : "string", + "description" : "IPv4 or IPv6 address from which the user triggered this event.", + "example" : "216.172.40.186", + "pattern" : "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$", + "readOnly" : true }, - "versionReleaseSystem" : { + "replicaSetName" : { "type" : "string", - "default" : "LTS", - "description" : "Method by which the cluster maintains the MongoDB versions.", - "enum" : [ "LTS" ], + "description" : "Human-readable label of the replica set associated with the event.", + "example" : "event-replica-set", + "readOnly" : true + }, + "shardName" : { + "type" : "string", + "description" : "Human-readable label of the shard associated with the event.", + "example" : "event-sh-01", + "readOnly" : true + }, + "userId" : { + "type" : "string", + "description" : "Unique 24-hexadecimal digit string that identifies the console user who triggered the event. If this resource returns this parameter, it doesn't return the **apiKeyId** parameter.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", + "readOnly" : true + }, + "username" : { + "type" : "string", + "format" : "email", + "description" : "Email address for the user who triggered this event. If this resource returns this parameter, it doesn't return the **publicApiKey** parameter.", + "example" : "test.user@mongodb.com", "readOnly" : true } }, - "required" : [ "providerSettings" ], - "title" : "USS Instance Description" + "required" : [ "created", "eventTypeName", "id" ] }, - "USSInstanceDescriptionCreate20250101" : { + "TimeMetricThresholdView" : { "type" : "object", - "description" : "Settings that you can specify when you create a USS instance.", "properties" : { - "links" : { - "type" : "array", - "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", - "externalDocs" : { - "description" : "Web Linking Specification (RFC 5988)", - "url" : "https://datatracker.ietf.org/doc/html/rfc5988" - }, - "items" : { - "$ref" : "#/components/schemas/Link" - }, - "readOnly" : true + "metricName" : { + "type" : "string", + "description" : "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured **metricThreshold.threshold**." }, - "name" : { + "mode" : { "type" : "string", - "description" : "Human-readable label that identifies the instance.", - "maxLength" : 64, - "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$", - "writeOnly" : true + "description" : "MongoDB Cloud computes the current metric value as an average.", + "enum" : [ "AVERAGE" ] }, - "providerSettings" : { - "$ref" : "#/components/schemas/USSProviderSettingsCreate20250101" + "operator" : { + "type" : "string", + "description" : "Comparison operator to apply when checking the current metric value.", + "enum" : [ "LESS_THAN", "GREATER_THAN" ] }, - "tags" : { - "type" : "array", - "description" : "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the instance.", - "externalDocs" : { - "description" : "Resource Tags", - "url" : "https://dochub.mongodb.org/core/add-cluster-tag-atlas" - }, - "items" : { - "$ref" : "#/components/schemas/ResourceTag" - } + "threshold" : { + "type" : "number", + "format" : "double", + "description" : "Value of metric that, when exceeded, triggers an alert." }, - "terminationProtectionEnabled" : { - "type" : "boolean", - "default" : false, - "description" : "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster." + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" } }, - "required" : [ "name", "providerSettings" ], - "title" : "USS Instance Description Create" + "required" : [ "metricName" ] + }, + "TimeMetricUnits" : { + "type" : "string", + "default" : "HOURS", + "description" : "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", + "enum" : [ "NANOSECONDS", "MILLISECONDS", "MILLION_MINUTES", "SECONDS", "MINUTES", "HOURS", "DAYS" ], + "title" : "Time Metric Units" }, - "USSProviderSettings20250101" : { + "TimeMetricValueView" : { "type" : "object", - "description" : "Group of cloud provider settings that configure the provisioned MongoDB USS instance.", + "description" : "Measurement of the **metricName** recorded at the time of the event.", "properties" : { - "backingProviderName" : { - "type" : "string", - "description" : "Cloud service provider on which MongoDB Cloud provisioned the USS instance.", - "enum" : [ "AWS", "AZURE", "GCP" ], - "readOnly" : true - }, - "diskSizeGB" : { + "number" : { "type" : "number", "format" : "double", - "description" : "Storage capacity available to the USS instance expressed in gigabytes.", + "description" : "Amount of the **metricName** recorded at the time of the event. This value triggered the alert.", "readOnly" : true }, - "providerName" : { + "units" : { + "$ref" : "#/components/schemas/TimeMetricUnits" + } + }, + "readOnly" : true, + "title" : "Time Metric Value" + }, + "TokenFilterEnglishPossessive" : { + "type" : "object", + "description" : "Filter that removes possessives (trailing 's) from words.", + "properties" : { + "type" : { "type" : "string", - "default" : "USS", - "description" : "Human-readable label that identifies the cloud service provider.", - "enum" : [ "USS" ], - "readOnly" : true - }, - "regionName" : { + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "englishPossessive" ] + } + }, + "required" : [ "type" ], + "title" : "englishPossessive" + }, + "TokenFilterFlattenGraph" : { + "type" : "object", + "description" : "Filter that transforms a token filter graph, such as the token filter graph that the wordDelimiterGraph token filter produces, into a flat form suitable for indexing.", + "properties" : { + "type" : { "type" : "string", - "description" : "Human-readable label that identifies the geographic location of your MongoDB USS 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/).", - "readOnly" : true + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "flattenGraph" ] } }, - "readOnly" : true, - "title" : "Cloud Service Provider Settings for a USS Instance" + "required" : [ "type" ], + "title" : "flattenGraph" }, - "USSProviderSettingsCreate20250101" : { + "TokenFilterPorterStemming" : { "type" : "object", - "description" : "Group of cloud provider settings that configure the provisioned MongoDB USS instance.", + "description" : "Filter that uses the porter stemming algorithm to remove the common morphological and inflectional suffixes from words in English. It expects lowercase text and doesn't work as expected for uppercase text.", "properties" : { - "backingProviderName" : { + "type" : { "type" : "string", - "description" : "Cloud service provider on which MongoDB Cloud provisioned the serverless instance.", - "enum" : [ "AWS", "AZURE", "GCP" ], - "writeOnly" : true + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "porterStemming" ] + } + }, + "required" : [ "type" ], + "title" : "porterStemming" + }, + "TokenFilterSpanishPluralStemming" : { + "type" : "object", + "description" : "Filter that stems Spanish plural words. It expects lowercase text.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "spanishPluralStemming" ] + } + }, + "required" : [ "type" ], + "title" : "spanishPluralStemming" + }, + "TokenFilterStempel" : { + "type" : "object", + "description" : "Filter that uses Lucene's default Polish stemmer table to stem words in the Polish language. It expects lowercase text.", + "externalDocs" : { + "description" : "Default Polish stemmer table", + "url" : "https://lucene.apache.org/core/9_2_0/analysis/stempel/org/apache/lucene/analysis/pl/PolishAnalyzer.html#DEFAULT_STEMMER_FILE" + }, + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "stempel" ] + } + }, + "required" : [ "type" ], + "title" : "stempel" + }, + "TokenFilterWordDelimiterGraph" : { + "type" : "object", + "description" : "Filter that splits tokens into sub-tokens based on configured rules.", + "properties" : { + "delimiterOptions" : { + "type" : "object", + "description" : "Object that contains the rules that determine how to split words into sub-words.", + "properties" : { + "concatenateAll" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to concatenate runs." + }, + "concatenateNumbers" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to concatenate runs of sub-numbers." + }, + "concatenateWords" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to concatenate runs of sub-words." + }, + "generateNumberParts" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on sub-numbers. For example, if `true`, this option splits `100-2` into `100` and `2`." + }, + "generateWordParts" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on sub-words." + }, + "ignoreKeywords" : { + "type" : "boolean", + "default" : false, + "description" : "Flag that indicates whether to skip tokens with the `keyword` attribute set to `true`" + }, + "preserveOriginal" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to generate tokens of the original words." + }, + "splitOnCaseChange" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on letter-case transitions." + }, + "splitOnNumerics" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to split tokens based on letter-number transitions." + }, + "stemEnglishPossessive" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to remove trailing possessives from each sub-word." + } + } }, - "diskSizeGB" : { - "type" : "number", - "format" : "double", - "description" : "Storage capacity available to the USS instance expressed in gigabytes.", - "readOnly" : true + "protectedWords" : { + "type" : "object", + "description" : "Object that contains options for protected words.", + "properties" : { + "ignoreCase" : { + "type" : "boolean", + "default" : true, + "description" : "Flag that indicates whether to ignore letter case sensitivity for protected words." + }, + "words" : { + "type" : "array", + "description" : "List that contains the tokens to protect from delimination.", + "items" : { + "type" : "string" + } + } + }, + "required" : [ "words" ] }, - "providerName" : { + "type" : { "type" : "string", - "default" : "USS", - "description" : "Human-readable label that identifies the cloud service provider.", - "enum" : [ "USS" ], - "readOnly" : true + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "wordDelimiterGraph" ] + } + }, + "required" : [ "type" ], + "title" : "wordDelimiterGraph" + }, + "TokenFilterkStemming" : { + "type" : "object", + "description" : "Filter that combines algorithmic stemming with a built-in dictionary for the English language to stem words.", + "properties" : { + "type" : { + "type" : "string", + "description" : "Human-readable label that identifies this token filter type.", + "enum" : [ "kStemming" ] + } + }, + "required" : [ "type" ], + "title" : "kStemming" + }, + "TriggerIngestionPipelineRequest" : { + "type" : "object", + "properties" : { + "datasetRetentionPolicy" : { + "$ref" : "#/components/schemas/DatasetRetentionPolicy" }, - "regionName" : { + "snapshotId" : { "type" : "string", - "description" : "Human-readable label that identifies the geographic location of your MongoDB USS 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/).", + "description" : "Unique 24-hexadecimal character string that identifies the snapshot.", + "example" : "32b6e34b3d91647abb20e7b8", + "maxLength" : 24, + "minLength" : 24, + "pattern" : "^([a-f0-9]{24})$", "writeOnly" : true } }, - "required" : [ "backingProviderName", "regionName" ], - "title" : "Cloud Service Provider Settings for a USS Instance", - "writeOnly" : true + "required" : [ "snapshotId" ] }, "UpdateAtlasOrganizationApiKey" : { "type" : "object", @@ -52948,7 +56523,7 @@ "description" : "Human-readable label that identifies the cluster or MongoDB Atlas Data Lake that this database user can access.", "maxLength" : 64, "minLength" : 1, - "pattern" : "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern" : "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" }, "type" : { "type" : "string", @@ -53004,6 +56579,32 @@ "required" : [ "match" ], "title" : "User to Distinguished Name Mapping" }, + "VPCPeeringActionChallenge" : { + "type" : "object", + "description" : "Container for elements used to challenge the user before taking certain actions on VPC Peering connections.", + "properties" : { + "links" : { + "type" : "array", + "description" : "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", + "externalDocs" : { + "description" : "Web Linking Specification (RFC 5988)", + "url" : "https://datatracker.ietf.org/doc/html/rfc5988" + }, + "items" : { + "$ref" : "#/components/schemas/Link" + }, + "readOnly" : true + }, + "requesterAccountId" : { + "type" : "string", + "description" : "The AWS requester account ID." + }, + "requesterVpcId" : { + "type" : "string", + "description" : "The AWS requester VPC ID." + } + } + }, "VectorSearchHostStatusDetail" : { "type" : "object", "properties" : { diff --git a/tools/cli/test/data/split/dev/openapi-v2.yaml b/tools/cli/test/data/split/dev/openapi-v2.yaml index cd908f140e..bc8ae5d573 100644 --- a/tools/cli/test/data/split/dev/openapi-v2.yaml +++ b/tools/cli/test/data/split/dev/openapi-v2.yaml @@ -13,13 +13,15 @@ info: ``` To learn more, see [Get Started with the Atlas Administration API](https://www.mongodb.com/docs/atlas/configure-api-access/). For support, see [MongoDB Support](https://www.mongodb.com/support/get-started). + + You can also explore the various endpoints available through the Atlas Administration API in MongoDB's [Postman workspace](https://www.postman.com/mongodb-devrel/workspace/mongodb-atlas-administration-apis/). license: name: CC BY-NC-SA 3.0 US url: https://creativecommons.org/licenses/by-nc-sa/3.0/us/ termsOfService: https://www.mongodb.com/mongodb-management-service-terms-and-conditions title: MongoDB Atlas Administration API version: "2.0" - x-xgen-sha: 09d9d18db2111c955a8e01702a27ca2763417782 + x-xgen-sha: e6ba3136dbd0be2a81dd4ed21b9e6c470edd4420 servers: - url: https://cloud.mongodb.com tags: @@ -82,8 +84,12 @@ tags: \ resource requires your project ID. Changes to federated database instance configurations\ \ can affect costs." name: Data Federation -- description: "Returns, adds, edits, and removes Atlas Data Lake Pipelines and associated\ +- description: "Returns, edits, and removes Atlas Data Lake Pipelines and associated\ \ runs." + externalDocs: + description: Data Lake Pipelines are deprecated. Please see Data Lake Deprecation + Guide. + url: https://dochub.mongodb.org/core/data-lake-deprecation name: Data Lake Pipelines - description: "Returns, adds, edits, and removes database users." name: Database Users @@ -158,6 +164,8 @@ tags: - description: "You can continually push logs from mongod, mongos, and audit logs\ \ to an AWS S3 bucket. Atlas exports logs every 5 minutes." name: Push-Based Log Export +- description: Configure and manage Atlas Resource Policies within your organization. + name: Resource Policies - description: Creates one index to a database deployment in a rolling manner. You can't create a rolling index on an `M0` free cluster or `M2/M5` shared cluster. name: Rolling Index @@ -173,6 +181,13 @@ tags: description: Set Up a Private Endpoint for a Serverless Instance Tutorial url: https://dochub.mongodb.org/core/serverless-private-endpoint name: Serverless Private Endpoints +- description: Endpoints for managing Service Accounts and secrets. Service Accounts + are used for programmatic access to the Atlas Admin API through the OAuth 2.0 + Client Credentials flow. This feature is available as a Preview feature. + externalDocs: + description: Get Started with the Atlas Administration API + url: https://www.mongodb.com/docs/atlas/configure-api-access/ + name: Service Accounts - description: Returns and adds restore jobs for shared-tier database deployments. name: Shared-Tier Restore Jobs - description: Returns and requests to download shared-tier database deployment snapshots. @@ -2371,9 +2386,9 @@ paths: - AWS Clusters DNS /api/atlas/v2/groups/{groupId}/backup/exportBuckets: get: - description: "Returns all AWS S3 buckets and Azure Blob Storage Containers associated\ - \ with the specified Project. To use this resource, the requesting API Key\ - \ must have the Project Read Only role." + description: "Returns all Export Buckets associated with the specified Project.\ + \ To use this resource, the requesting API Key must have the Project Read\ + \ Only role." operationId: listExportBuckets parameters: - $ref: "#/components/parameters/envelope" @@ -2388,7 +2403,7 @@ paths: application/vnd.atlas.2023-01-01+json: schema: $ref: "#/components/schemas/PaginatedBackupSnapshotExportBucketView" - x-sunset: 2025-05-30 + x-sunset: 2026-05-30 x-xgen-version: 2023-01-01 application/vnd.atlas.2024-05-30+json: schema: @@ -2401,15 +2416,15 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Return All AWS S3 Buckets and Azure Blob Storage Containers Used for - Cloud Backup Snapshot Exports + summary: Return All Snapshot Export Buckets tags: - Cloud Backups post: - description: "Grants MongoDB Cloud access to the specified AWS S3 Bucket or\ - \ Azure Blob Storage Container. This enables this Export Bucket to receive\ - \ Atlas Cloud Backup Snapshots. To use this resource, the requesting API Key\ - \ must have the Project Owner role." + description: "Creates a Snapshot Export Bucket for an AWS S3 Bucket or Azure\ + \ Blob Storage Container. Once created, an snapshots can be exported to the\ + \ Export Bucket and its referenced AWS S3 Bucket or Azure Blob Storage Container.\ + \ To use this resource, the requesting API Key must have the Project Owner\ + \ role." operationId: createExportBucket parameters: - $ref: "#/components/parameters/envelope" @@ -2441,8 +2456,8 @@ paths: schema: $ref: "#/components/schemas/DiskBackupSnapshotExportBucket" x-xgen-version: 2024-05-30 - description: Grants MongoDB Cloud access to the specified AWS S3 Bucket or - Azure Blob Storage Container. + description: Specifies the role and AWS S3 Bucket or Azure Blob Storage Container + that the Export Bucket should reference. required: true responses: "200": @@ -2450,7 +2465,7 @@ paths: application/vnd.atlas.2023-01-01+json: schema: $ref: "#/components/schemas/DiskBackupSnapshotAWSExportBucket" - x-sunset: 2025-05-30 + x-sunset: 2026-05-30 x-xgen-version: 2023-01-01 application/vnd.atlas.2024-05-30+json: examples: @@ -2490,24 +2505,21 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Grant Access to AWS S3 Bucket or Azure Blob Storage Container for Cloud - Backup Snapshot Exports + summary: Create One Snapshot Export Bucket tags: - Cloud Backups /api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}: delete: - description: "Revoke MongoDB Cloud access to the specified AWS S3 Bucket or\ - \ Azure Blob Storage Container. This prevents this Export Bucket from receiving\ - \ Atlas Cloud Backup Snapshots. 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 API Key must have the Project Owner\ - \ role." + 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 API Key must have the Project\ + \ Owner role." operationId: deleteExportBucket parameters: - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/groupId" - - description: Unique string that identifies the AWS S3 Bucket or Azure Blob - Storage Container to which you export your Snapshots. + - description: Unique 24-hexadecimal character string that identifies the Export + Bucket. in: path name: exportBucketId required: true @@ -2535,14 +2547,13 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Revoke Access to AWS S3 Bucket or Azure Blob Storage Container for - Cloud Backup Snapshot Exports + summary: Delete One Snapshot Export Bucket tags: - Cloud Backups get: - description: "Returns one AWS S3 Bucket or Azure Blob Storage Container associated\ - \ with the specified Project. To use this resource, the requesting API Key\ - \ must have the Project Read Only role." + description: "Returns one Export Bucket associated with the specified Project.\ + \ To use this resource, the requesting API Key must have the Project Read\ + \ Only role." operationId: getExportBucket parameters: - $ref: "#/components/parameters/envelope" @@ -2564,7 +2575,7 @@ paths: application/vnd.atlas.2023-01-01+json: schema: $ref: "#/components/schemas/DiskBackupSnapshotAWSExportBucket" - x-sunset: 2025-05-30 + x-sunset: 2026-05-30 x-xgen-version: 2023-01-01 application/vnd.atlas.2024-05-30+json: examples: @@ -2602,8 +2613,7 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Return One AWS S3 Bucket or Azure Blob Storage Container Used for Cloud - Backup Snapshot Exports + summary: Return One Snapshot Export Bucket tags: - Cloud Backups /api/atlas/v2/groups/{groupId}/backupCompliancePolicy: @@ -2622,7 +2632,7 @@ paths: application/vnd.atlas.2023-01-01+json: schema: $ref: "#/components/schemas/DataProtectionSettings" - x-sunset: 2024-10-01 + x-sunset: 2026-10-01 x-xgen-version: 2023-01-01 application/vnd.atlas.2023-10-01+json: schema: @@ -2675,7 +2685,7 @@ paths: application/vnd.atlas.2023-01-01+json: schema: $ref: "#/components/schemas/DataProtectionSettings" - x-sunset: 2024-10-01 + x-sunset: 2025-10-01 x-xgen-version: 2023-01-01 application/vnd.atlas.2023-10-01+json: schema: @@ -2739,7 +2749,7 @@ paths: content: application/vnd.atlas.2023-01-01+json: schema: - $ref: "#/components/schemas/CloudProviderAccessRole" + $ref: "#/components/schemas/CloudProviderAccessRoleRequest" description: Creates one role for the specified cloud provider. required: true responses: @@ -2778,6 +2788,8 @@ paths: type: string enum: - AWS + - AZURE + - GCP - description: Unique 24-hexadecimal digit string that identifies the role. in: path name: roleId @@ -2844,7 +2856,8 @@ paths: description: "Grants access to the specified project for the specified access\ \ role. To use this resource, the requesting API Key must have the Project\ \ Owner role. This API endpoint is one step in a procedure to create unified\ - \ access for MongoDB Cloud services." + \ 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/ @@ -2866,7 +2879,7 @@ paths: content: application/vnd.atlas.2023-01-01+json: schema: - $ref: "#/components/schemas/CloudProviderAccessRole" + $ref: "#/components/schemas/CloudProviderAccessRoleRequestUpdate" description: Grants access to the specified project for the specified access role. required: true @@ -2963,130 +2976,72 @@ paths: examples: Cluster: description: Cluster - value: | - { - "clusterType": "SHARDED", - "links": [], - "name": "myCluster", - "replicationSpecs": [ - { - "regionConfigs": [ - { - "analyticsAutoScaling": { - "autoIndexing": { - "enabled": false - }, - "compute": { - "enabled": true, - "maxInstanceSize": "M40", - "minInstanceSize": "M30", - "scaleDownEnabled": true - }, - "diskGB": { - "enabled": true - } - }, - "analyticsSpecs": { - "instanceSize": "M30", - "nodeCount": 0, - "diskSizeGB": 10.0 - }, - "autoScaling": { - "autoIndexing": { - "enabled": false - }, - "compute": { - "enabled": true, - "maxInstanceSize": "M40", - "minInstanceSize": "M30", - "scaleDownEnabled": true - }, - "diskGB": { - "enabled": true - } - }, - "electableSpecs": { - "instanceSize": "M30", - "nodeCount": 3, - "diskSizeGB": 10.0 - }, - "hiddenSecondarySpecs": { - "instanceSize": "M30", - "nodeCount": 0, - "diskSizeGB": 10.0 - }, - "priority": 7, - "providerName": "AWS", - "readOnlySpecs": { - "instanceSize": "M30", - "nodeCount": 0, - "diskSizeGB": 10.0 - }, - "regionName": "US_EAST_1" - } - ], - "zoneName": "Zone 1" - }, - { - "regionConfigs": [ - { - "analyticsAutoScaling": { - "autoIndexing": { - "enabled": false - }, - "compute": { - "enabled": true, - "maxInstanceSize": "M20", - "minInstanceSize": "M10", - "scaleDownEnabled": true - }, - "diskGB": { - "enabled": true - } - }, - "analyticsSpecs": { - "instanceSize": "M10", - "nodeCount": 0, - "diskSizeGB": 10.0 - }, - "autoScaling": { - "autoIndexing": { - "enabled": false - }, - "compute": { - "enabled": true, - "maxInstanceSize": "M20", - "minInstanceSize": "M10", - "scaleDownEnabled": true - }, - "diskGB": { - "enabled": true - } - }, - "electableSpecs": { - "instanceSize": "M10", - "nodeCount": 3, - "diskSizeGB": 10.0 - }, - "hiddenSecondarySpecs": { - "instanceSize": "M10", - "nodeCount": 0, - "diskSizeGB": 10.0 - }, - "priority": 7, - "providerName": "AWS", - "readOnlySpecs": { - "instanceSize": "M10", - "nodeCount": 0, - "diskSizeGB": 10.0 - }, - "regionName": "US_EAST_1" - } - ], - "zoneName": "Zone 1" - }, - ] - } + value: + clusterType: SHARDED + name: myCluster + replicationSpecs: + - regionConfigs: + - analyticsAutoScaling: + autoIndexing: + enabled: false + compute: + enabled: false + diskGB: + enabled: true + analyticsSpecs: + diskSizeGB: 10.0 + instanceSize: M30 + nodeCount: 0 + autoScaling: + autoIndexing: + enabled: false + compute: + enabled: false + diskGB: + enabled: true + electableSpecs: + diskSizeGB: 10.0 + instanceSize: M30 + nodeCount: 3 + priority: 7 + providerName: AWS + readOnlySpecs: + diskSizeGB: 10.0 + instanceSize: M30 + nodeCount: 0 + regionName: US_EAST_1 + zoneName: Zone 1 + - regionConfigs: + - analyticsAutoScaling: + autoIndexing: + enabled: false + compute: + enabled: false + diskGB: + enabled: true + analyticsSpecs: + diskSizeGB: 10.0 + instanceSize: M10 + nodeCount: 0 + autoScaling: + autoIndexing: + enabled: false + compute: + enabled: false + diskGB: + enabled: true + electableSpecs: + diskSizeGB: 10.0 + instanceSize: M10 + nodeCount: 3 + priority: 7 + providerName: AWS + readOnlySpecs: + diskSizeGB: 10.0 + instanceSize: M10 + nodeCount: 0 + regionName: US_EAST_1 + zoneName: Zone 1 schema: $ref: "#/components/schemas/ClusterDescription20240805" x-xgen-version: 2024-08-05 @@ -3274,7 +3229,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Flag that indicates whether to retain backup snapshots for the deleted dedicated cluster. in: query @@ -3324,7 +3279,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -3380,7 +3335,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -3430,7 +3385,7 @@ paths: - Clusters /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports: get: - description: "Returns all Cloud Backup snapshot export jobs associated with\ + description: "Returns all Cloud Backup Snapshot Export Jobs associated with\ \ the specified Atlas cluster. To use this resource, the requesting API Key\ \ must have the Project Atlas Admin role." operationId: listBackupExportJobs @@ -3449,7 +3404,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -3464,11 +3419,11 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Return All Cloud Backup Snapshot Export Jobs + summary: Return All Snapshot Export Jobs tags: - Cloud Backups post: - description: "Exports one backup snapshot for dedicated Atlas cluster using\ + description: "Exports one backup Snapshot for dedicated Atlas cluster using\ \ Cloud Backups to an Export Bucket. To use this resource, the requesting\ \ API Key must have the Project Atlas Admin role." operationId: createBackupExportJob @@ -3483,7 +3438,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -3511,12 +3466,12 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Create One Cloud Backup Snapshot Export Job + summary: Create One Snapshot Export Job tags: - Cloud Backups /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}: get: - description: "Returns one Cloud Backup snapshot export job associated with the\ + description: "Returns one Cloud Backup Snapshot Export Job associated with the\ \ specified Atlas cluster. To use this resource, the requesting API Key must\ \ have the Project Atlas Admin role." operationId: getBackupExportJob @@ -3531,13 +3486,18 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - - description: Unique string that identifies the export job to return. + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + - description: Unique 24-hexadecimal character string that identifies the Export + Job. in: path name: exportId required: true schema: type: string + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" responses: "200": content: @@ -3552,7 +3512,7 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Return One Cloud Backup Snapshot Export Job + summary: Return One Snapshot Export Job tags: - Cloud Backups /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs: @@ -3577,7 +3537,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -3613,7 +3573,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -3662,7 +3622,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the restore job to remove. in: path @@ -3710,7 +3670,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the restore job to return. in: path @@ -3756,14 +3716,14 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: application/vnd.atlas.2023-01-01+json: schema: $ref: "#/components/schemas/DiskBackupSnapshotSchedule" - x-sunset: 2025-08-05 + x-sunset: 2026-05-30 x-xgen-version: 2023-01-01 application/vnd.atlas.2024-08-05+json: schema: @@ -3799,14 +3759,14 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: application/vnd.atlas.2023-01-01+json: schema: $ref: "#/components/schemas/DiskBackupSnapshotSchedule" - x-sunset: 2025-08-05 + x-sunset: 2026-05-30 x-xgen-version: 2023-01-01 application/vnd.atlas.2024-08-05+json: schema: @@ -3840,7 +3800,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -3860,7 +3820,7 @@ paths: application/vnd.atlas.2023-01-01+json: schema: $ref: "#/components/schemas/DiskBackupSnapshotSchedule" - x-sunset: 2025-08-05 + x-sunset: 2026-05-30 x-xgen-version: 2023-01-01 application/vnd.atlas.2024-08-05+json: schema: @@ -3899,7 +3859,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -3937,7 +3897,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -3982,7 +3942,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -4027,7 +3987,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -4075,7 +4035,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -4112,7 +4072,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -4158,7 +4118,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -4204,7 +4164,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -4259,7 +4219,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/groupId" - $ref: "#/components/parameters/pretty" @@ -4313,7 +4273,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/groupId" - $ref: "#/components/parameters/pretty" @@ -4362,7 +4322,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/groupId" - $ref: "#/components/parameters/pretty" @@ -4399,7 +4359,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/groupId" - $ref: "#/components/parameters/pretty" @@ -4450,7 +4410,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -4488,7 +4448,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -4541,7 +4501,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -4588,7 +4548,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -4627,7 +4587,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -4665,7 +4625,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-11-15+json: @@ -4719,7 +4679,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-11-15+json: @@ -4773,7 +4733,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-11-15+json: @@ -4828,7 +4788,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -4882,7 +4842,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Name of the collection that contains one or more Atlas Search indexes. in: path @@ -4940,7 +4900,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: "Unique 24-hexadecimal digit string that identifies the Atlas\ \ Search index. Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/)\ \ endpoint to find the IDs of all Atlas Search indexes." @@ -4995,7 +4955,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - 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/)\ @@ -5049,7 +5009,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - 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/)\ @@ -5113,7 +5073,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5165,7 +5125,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5215,7 +5175,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -5281,7 +5241,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - $ref: "#/components/parameters/groupId" - description: Human-readable label that identifies the database that contains the collection. @@ -5345,7 +5305,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -5416,7 +5376,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -5531,7 +5491,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5570,7 +5530,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -5648,7 +5608,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Flag that indicates whether to download logs for queries against your online archive only or both your online archive and cluster. in: query @@ -5715,7 +5675,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "204": content: @@ -5766,7 +5726,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5819,7 +5779,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -5870,7 +5830,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5911,7 +5871,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -5952,7 +5912,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -5979,6 +5939,100 @@ paths: summary: Start an Outage Simulation tags: - Cluster Outage Simulation + /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/suggestedIndexes: + get: + description: "Returns the indexes that the Performance Advisor suggests. The\ + \ Performance Advisor monitors queries that MongoDB considers slow and suggests\ + \ new indexes to improve query performance. To use this resource, the requesting\ + \ API Key must have the Project Read Only role." + operationId: listSuggestedIndexes_1 + parameters: + - $ref: "#/components/parameters/groupId" + - description: Human-readable label that identifies the cluster. + in: path + name: clusterName + required: true + schema: + type: string + maxLength: 64 + minLength: 1 + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + - description: "ProcessIds from which to retrieve suggested indexes. A processId\ + \ is a combination of host and port that serves the MongoDB process. The\ + \ host must be the hostname, FQDN, IPv4 address, or IPv6 address of the\ + \ host that runs the MongoDB process (`mongod` or `mongos`). The port must\ + \ be the IANA port on which the MongoDB process listens for requests. To\ + \ include multiple processIds, pass the parameter multiple times delimited\ + \ with an ampersand (`&`) between each processId." + in: query + name: processIds + schema: + type: array + items: + type: string + pattern: "^([0-9]{1,3}\\.){3}[0-9]{1,3}|([0-9a-f]{1,4}\\:){7}([0-9a-f]{1,4})|(([a-z0-9]+\\\ + .){1,10}[a-z]+)?(\\:[0-9]{4,5})$" + style: form + - 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." + in: query + name: namespaces + schema: + type: array + items: + type: string + style: form + - description: "HostType determines the source of index advice from logs. If\ + \ **hostType**=All, index advice from logs will come from all processes\ + \ within a cluster and **processIds** will be ignored. If hostType=Null,\ + \ index advice from logs will come from the subset of processes within this\ + \ cluster specified using *processIds**." + in: query + name: hostType + schema: + type: string + - description: |- + Date and time from which the query retrieves the suggested indexes. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time). + + - If you don't specify the **until** parameter, the endpoint returns data covering from the **since** value and the current time. + - If you specify neither the **since** nor the **until** parameters, the endpoint returns data from the previous 24 hours. + in: query + name: since + schema: + type: integer + format: int64 + minimum: 1199145600000 + - description: |- + Date and time up until which the query retrieves the suggested indexes. This parameter expresses its value in the number of milliseconds that have elapsed since the [UNIX epoch](https://en.wikipedia.org/wiki/Unix_time). + + - If you specify the **until** parameter, you must specify the **since** parameter. + - If you specify neither the **since** nor the **until** parameters, the endpoint returns data from the previous 24 hours. + in: query + name: until + schema: + type: integer + format: int64 + minimum: 1199145600000 + responses: + "200": + content: + application/vnd.atlas.2025-01-01+json: + schema: + $ref: "#/components/schemas/PerformanceAdvisorResponse" + x-xgen-version: 2025-01-01 + description: OK + "401": + $ref: "#/components/responses/unauthorized" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Return Suggested Indexes + tags: + - Performance Advisor /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs: get: description: "Returns the advanced configuration details for one cluster in\ @@ -6004,7 +6058,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -6053,7 +6107,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -6114,7 +6168,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -6170,7 +6224,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -6220,7 +6274,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -6268,7 +6322,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the restore job. in: path @@ -6314,7 +6368,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -6358,7 +6412,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -6399,7 +6453,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -6451,7 +6505,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -6514,7 +6568,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -6565,7 +6619,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2024-05-30+json: @@ -6617,7 +6671,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Name of the collection that contains one or more Atlas Search indexes. in: path @@ -6681,7 +6735,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Name of the collection that contains one or more Atlas Search indexes. in: path @@ -6744,7 +6798,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Name of the collection that contains one or more Atlas Search indexes. in: path @@ -6807,7 +6861,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Name of the collection that contains one or more Atlas Search indexes. in: path @@ -6878,7 +6932,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: "Unique 24-hexadecimal digit string that identifies the Atlas\ \ Search index. Use the [Get All Atlas Search Indexes for a Collection API](https://docs.atlas.mongodb.com/reference/api/fts-indexes-get-all/)\ \ endpoint to find the IDs of all Atlas Search indexes." @@ -6931,7 +6985,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - 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/)\ @@ -6991,7 +7045,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - 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/)\ @@ -7053,7 +7107,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -7091,7 +7145,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -7145,7 +7199,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: "Human-readable label that specifies whether to return only completed,\ \ incomplete, or all snapshots. By default, MongoDB Cloud only returns completed\ \ snapshots." @@ -7200,7 +7254,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -7254,7 +7308,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -7307,7 +7361,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -7362,7 +7416,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -7396,7 +7450,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Human-readable label that identifies the cluster topology to retrieve metrics for. in: path @@ -7445,7 +7499,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Human-readable label that identifies the cluster topology to retrieve metrics for. in: path @@ -7522,6 +7576,55 @@ paths: summary: Return Cluster-Level Query Latency tags: - Collection Level Metrics + /api/atlas/v2/groups/{groupId}/clusters/{clusterName}:grantMongoDBEmployeeAccess: + post: + description: Grants MongoDB employee cluster access for the given duration and + at the specified level for one cluster. + operationId: grantMongoDBEmployeeAccess + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/pretty" + - $ref: "#/components/parameters/groupId" + - description: Human-readable label that identifies this cluster. + in: path + name: clusterName + required: true + schema: + type: string + maxLength: 64 + minLength: 1 + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + requestBody: + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/EmployeeAccessGrantView" + x-xgen-version: 2024-08-05 + description: Grant access level and expiration. + required: true + responses: + "204": + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/NoBody" + x-xgen-version: 2024-08-05 + description: This endpoint does not return a response body. + "400": + $ref: "#/components/responses/badRequest" + "401": + $ref: "#/components/responses/unauthorized" + "404": + $ref: "#/components/responses/notFound" + "409": + $ref: "#/components/responses/conflict" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Grant MongoDB employee cluster access for one cluster. + tags: + - Clusters /api/atlas/v2/groups/{groupId}/clusters/{clusterName}:pinFeatureCompatibilityVersion: post: description: Pins the FCV to the current MongoDB version. @@ -7538,7 +7641,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2024-05-30+json: @@ -7569,6 +7672,46 @@ paths: summary: Pin FCV for One Cluster from One Project tags: - Clusters + /api/atlas/v2/groups/{groupId}/clusters/{clusterName}:revokeMongoDBEmployeeAccess: + post: + description: Revokes a previously granted MongoDB employee cluster access. + operationId: revokeMongoDBEmployeeAccess + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/pretty" + - $ref: "#/components/parameters/groupId" + - description: Human-readable label that identifies this cluster. + in: path + name: clusterName + required: true + schema: + type: string + maxLength: 64 + minLength: 1 + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + responses: + "204": + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/NoBody" + x-xgen-version: 2024-08-05 + description: This endpoint does not return a response body. + "400": + $ref: "#/components/responses/badRequest" + "401": + $ref: "#/components/responses/unauthorized" + "404": + $ref: "#/components/responses/notFound" + "409": + $ref: "#/components/responses/conflict" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Revoke granted MongoDB employee cluster access for one cluster. + tags: + - Clusters /api/atlas/v2/groups/{groupId}/clusters/{clusterName}:unpinFeatureCompatibilityVersion: post: description: Unpins the current fixed Feature Compatibility Version. This feature @@ -7586,7 +7729,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "204": content: @@ -7655,18 +7798,22 @@ paths: externalDocs: description: Set up Database Auditing url: https://docs.atlas.mongodb.com/database-auditing/ - - description: Date and time when the period specifies the inclusive ending - point for the range of log messages to retrieve. This parameter expresses - its value in the number of seconds that have elapsed since the UNIX epoch. + - description: "Specifies the date and time for the ending point of the range\ + \ of log messages to retrieve, in the number of seconds that have elapsed\ + \ since the UNIX epoch. This value will default to 24 hours after the start\ + \ date. If the start date is also unspecified, the value will default to\ + \ the time of the request." in: query name: endDate schema: type: integer format: int64 minimum: 1199145600 - - description: Date and time when the period specifies the inclusive starting - point for the range of log messages to retrieve. This parameter expresses - its value in the number of seconds that have elapsed since the UNIX epoch. + - description: "Specifies the date and time for the starting point of the range\ + \ of log messages to retrieve, in the number of seconds that have elapsed\ + \ since the UNIX epoch. This value will default to 24 hours prior to the\ + \ end date. If the end date is also unspecified, the value will default\ + \ to 24 hours prior to the time of the request." in: query name: startDate schema: @@ -9140,7 +9287,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: "Date and time when to stop retrieving database history. If you\ \ specify **end**, you must also specify **start**. This parameter uses\ \ UNIX epoch time in milliseconds." @@ -9359,6 +9506,9 @@ paths: - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/pretty" - $ref: "#/components/parameters/groupId" + - $ref: "#/components/parameters/includeCount" + - $ref: "#/components/parameters/itemsPerPage" + - $ref: "#/components/parameters/pageNum" - description: Human-readable label that identifies the cloud provider for the private endpoints to return. in: path @@ -9456,14 +9606,6 @@ paths: maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" - requestBody: - content: - application/vnd.atlas.2023-01-01+json: - schema: - $ref: "#/components/schemas/EncryptionAtRestPrivateEndpointRequest" - description: Cloud provider of the private endpoints to delete and the list - of cloud provider regions in which to delete the private endpoints. - required: true responses: "204": content: @@ -9518,6 +9660,8 @@ paths: description: OK "403": $ref: "#/components/responses/forbidden" + "404": + $ref: "#/components/responses/notFound" "500": $ref: "#/components/responses/internalServerError" security: @@ -9549,7 +9693,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" style: form - description: |- Category of incident recorded at this moment in time. @@ -9665,6 +9809,236 @@ paths: summary: Return One Event from One Project tags: - Events + /api/atlas/v2/groups/{groupId}/flexClusters: + get: + description: "Returns details for all flex clusters in the specified project.\ + \ To use this resource, the requesting API Key must have the Project Read\ + \ Only role." + operationId: listFlexClusters + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/groupId" + - $ref: "#/components/parameters/includeCount" + - $ref: "#/components/parameters/itemsPerPage" + - $ref: "#/components/parameters/pageNum" + - $ref: "#/components/parameters/pretty" + responses: + "200": + content: + application/vnd.atlas.2025-01-01+json: + schema: + $ref: "#/components/schemas/PaginatedFlexClusters20250101" + x-xgen-version: 2025-01-01 + description: OK + "409": + $ref: "#/components/responses/conflict" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Return All Flex Clusters from One Project + tags: + - Flex Clusters + post: + description: "Creates one flex cluster in the specified project. To use this\ + \ resource, the requesting API Key must have the Project Owner role." + operationId: createFlexcluster + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/groupId" + - $ref: "#/components/parameters/pretty" + requestBody: + content: + application/vnd.atlas.2025-01-01+json: + schema: + $ref: "#/components/schemas/FlexClusterDescriptionCreate20250101" + description: Create One Flex Cluster in One Project. + required: true + responses: + "201": + content: + application/vnd.atlas.2025-01-01+json: + schema: + $ref: "#/components/schemas/FlexClusterDescription20250101" + x-xgen-version: 2025-01-01 + description: Created + "400": + $ref: "#/components/responses/badRequest" + "402": + $ref: "#/components/responses/paymentRequired" + "409": + $ref: "#/components/responses/conflict" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Create One Flex Cluster in One Project + tags: + - Flex Clusters + /api/atlas/v2/groups/{groupId}/flexClusters/{name}: + delete: + description: "Removes one flex cluster from the specified project. The flex\ + \ cluster must have termination protection disabled in order to be deleted.\ + \ To use this resource, the requesting API Key must have the Project Owner\ + \ role." + operationId: deleteFlexCluster + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/pretty" + - $ref: "#/components/parameters/groupId" + - description: Human-readable label that identifies the flex cluster. + in: path + name: name + required: true + schema: + type: string + maxLength: 64 + minLength: 1 + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + responses: + "204": + content: + application/vnd.atlas.2025-01-01+json: + schema: + $ref: "#/components/schemas/NoBody" + x-xgen-version: 2025-01-01 + description: This endpoint does not return a response body. + "400": + $ref: "#/components/responses/badRequest" + "404": + $ref: "#/components/responses/notFound" + "409": + $ref: "#/components/responses/conflict" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Remove One Flex Cluster from One Project + tags: + - Flex Clusters + get: + description: "Returns details for one flex cluster in the specified project.\ + \ To use this resource, the requesting API Key must have the Project Read\ + \ Only role." + operationId: getFlexCluster + parameters: + - $ref: "#/components/parameters/groupId" + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/pretty" + - description: Human-readable label that identifies the flex cluster. + in: path + name: name + required: true + schema: + type: string + maxLength: 64 + minLength: 1 + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + responses: + "200": + content: + application/vnd.atlas.2025-01-01+json: + schema: + $ref: "#/components/schemas/FlexClusterDescription20250101" + x-xgen-version: 2025-01-01 + description: OK + "400": + $ref: "#/components/responses/badRequest" + "404": + $ref: "#/components/responses/notFound" + "409": + $ref: "#/components/responses/conflict" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Return One Flex Cluster from One Project + tags: + - Flex Clusters + patch: + description: "Updates one flex cluster in the specified project. To use this\ + \ resource, the requesting API Key must have the Project Owner role." + operationId: updateFlexCluster + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/groupId" + - $ref: "#/components/parameters/pretty" + - description: Human-readable label that identifies the flex cluster. + in: path + name: name + required: true + schema: + type: string + maxLength: 64 + minLength: 1 + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + requestBody: + content: + application/vnd.atlas.2025-01-01+json: + schema: + $ref: "#/components/schemas/FlexClusterDescription20250101" + description: Update One Flex Cluster in One Project. + required: true + responses: + "200": + content: + application/vnd.atlas.2025-01-01+json: + schema: + $ref: "#/components/schemas/FlexClusterDescription20250101" + x-xgen-version: 2025-01-01 + description: OK + "400": + $ref: "#/components/responses/badRequest" + "402": + $ref: "#/components/responses/paymentRequired" + "409": + $ref: "#/components/responses/conflict" + security: + - DigestAuth: [] + summary: Update One Flex Cluster in One Project + tags: + - Flex Clusters + /api/atlas/v2/groups/{groupId}/flexClusters:tenantUpgrade: + post: + description: "Upgrades a flex cluster in the specified project. To use this\ + \ resource, the requesting API key must have the Project Cluster Manager role." + operationId: upgradeFlexCluster + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/groupId" + - $ref: "#/components/parameters/pretty" + requestBody: + content: + application/vnd.atlas.2025-01-01+json: + schema: + $ref: "#/components/schemas/FlexClusterDescription20250101" + description: Details of the flex cluster upgrade in the specified project. + required: true + responses: + "200": + content: + application/vnd.atlas.2025-01-01+json: + schema: + $ref: "#/components/schemas/FlexClusterDescription20250101" + x-xgen-version: 2025-01-01 + description: OK + "400": + $ref: "#/components/responses/badRequest" + "401": + $ref: "#/components/responses/unauthorized" + "402": + $ref: "#/components/responses/paymentRequired" + "403": + $ref: "#/components/responses/forbidden" + "409": + $ref: "#/components/responses/conflict" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Upgrade One Flex Cluster + tags: + - Flex Clusters /api/atlas/v2/groups/{groupId}/hosts/{processId}/fts/metrics: get: description: Returns all Atlas Search metric types available for one process @@ -10165,7 +10539,7 @@ paths: type: array items: $ref: "#/components/schemas/GroupInvitation" - x-sunset: 2024-10-04 + x-sunset: 2024-11-04 x-xgen-version: 2023-01-01 description: OK "401": @@ -10202,7 +10576,7 @@ paths: application/vnd.atlas.2023-01-01+json: schema: $ref: "#/components/schemas/GroupInvitation" - x-sunset: 2024-10-04 + x-sunset: 2024-11-04 x-xgen-version: 2023-01-01 description: OK "400": @@ -10242,7 +10616,7 @@ paths: application/vnd.atlas.2023-01-01+json: schema: $ref: "#/components/schemas/GroupInvitation" - x-sunset: 2024-10-04 + x-sunset: 2024-11-04 x-xgen-version: 2023-01-01 description: OK "401": @@ -10280,7 +10654,7 @@ paths: application/vnd.atlas.2023-01-01+json: schema: $ref: "#/components/schemas/NoBody" - x-sunset: 2024-10-04 + x-sunset: 2024-11-04 x-xgen-version: 2023-01-01 description: This endpoint does not return a response body. "401": @@ -10317,7 +10691,7 @@ paths: application/vnd.atlas.2023-01-01+json: schema: $ref: "#/components/schemas/GroupInvitation" - x-sunset: 2024-10-04 + x-sunset: 2024-11-04 x-xgen-version: 2023-01-01 description: OK "401": @@ -10365,7 +10739,7 @@ paths: application/vnd.atlas.2023-01-01+json: schema: $ref: "#/components/schemas/GroupInvitation" - x-sunset: 2024-10-04 + x-sunset: 2024-11-04 x-xgen-version: 2023-01-01 description: OK "400": @@ -10456,7 +10830,7 @@ paths: | Limit Name | Description | Default | API Override Limit | | --- | --- | --- | --- | - | atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 | + | atlas.project.deployment.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 | @@ -10468,6 +10842,7 @@ paths: | 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 | in: path name: limitName required: true @@ -10487,6 +10862,7 @@ paths: - 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" @@ -10521,7 +10897,7 @@ paths: | Limit Name | Description | Default | API Override Limit | | --- | --- | --- | --- | - | atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 | + | atlas.project.deployment.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 | @@ -10533,6 +10909,7 @@ paths: | 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 | in: path name: limitName required: true @@ -10552,6 +10929,7 @@ paths: - 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" @@ -10590,7 +10968,7 @@ paths: | Limit Name | Description | Default | API Override Limit | | --- | --- | --- | --- | - | atlas.project.deployment.clusters | Limit on the number of clusters in this project | 25 | 90 | + | atlas.project.deployment.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 | @@ -10602,6 +10980,7 @@ paths: | 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 | in: path name: limitName required: true @@ -10621,6 +11000,7 @@ paths: - 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" @@ -11412,6 +11792,7 @@ paths: - Network Peering /api/atlas/v2/groups/{groupId}/pipelines: get: + deprecated: true description: "Returns a list of Data Lake Pipelines. To use this resource, the\ \ requesting API Key must have the Project Read Only role." operationId: listPipelines @@ -11426,6 +11807,7 @@ paths: type: array items: $ref: "#/components/schemas/DataLakeIngestionPipeline" + x-sunset: 2025-09-09 x-xgen-version: 2023-01-01 description: OK "400": @@ -11440,7 +11822,12 @@ paths: tags: - Data Lake Pipelines post: + deprecated: true description: Creates one Data Lake Pipeline. + externalDocs: + description: Data Lake Pipelines are deprecated. Please see Data Lake Deprecation + Guide. + url: https://dochub.mongodb.org/core/data-lake-deprecation operationId: createPipeline parameters: - $ref: "#/components/parameters/envelope" @@ -11458,6 +11845,7 @@ paths: application/vnd.atlas.2023-01-01+json: schema: $ref: "#/components/schemas/DataLakeIngestionPipeline" + x-sunset: 2025-09-09 x-xgen-version: 2023-01-01 description: OK "400": @@ -11475,6 +11863,7 @@ paths: - Data Lake Pipelines /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}: delete: + deprecated: true description: Removes one Data Lake Pipeline. operationId: deletePipeline parameters: @@ -11495,6 +11884,7 @@ paths: application/vnd.atlas.2023-01-01+json: schema: $ref: "#/components/schemas/NoBody" + x-sunset: 2025-09-09 x-xgen-version: 2023-01-01 description: This endpoint does not return a response body. "401": @@ -11509,6 +11899,7 @@ paths: tags: - Data Lake Pipelines get: + deprecated: true description: "Returns the details of one Data Lake Pipeline within the specified\ \ project. To use this resource, the requesting API Key must have the Project\ \ Read Only role." @@ -11532,6 +11923,7 @@ paths: application/vnd.atlas.2023-01-01+json: schema: $ref: "#/components/schemas/DataLakeIngestionPipeline" + x-sunset: 2025-09-09 x-xgen-version: 2023-01-01 description: OK "400": @@ -11546,6 +11938,7 @@ paths: tags: - Data Lake Pipelines patch: + deprecated: true description: Updates one Data Lake Pipeline. operationId: updatePipeline parameters: @@ -11573,6 +11966,7 @@ paths: application/vnd.atlas.2023-01-01+json: schema: $ref: "#/components/schemas/DataLakeIngestionPipeline" + x-sunset: 2025-09-09 x-xgen-version: 2023-01-01 description: OK "400": @@ -11592,6 +11986,7 @@ paths: - Data Lake Pipelines /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSchedules: get: + deprecated: true description: "Returns a list of backup schedule policy items that you can use\ \ as a Data Lake Pipeline source. To use this resource, the requesting API\ \ Key must have the Project Read Only role." @@ -11617,6 +12012,7 @@ paths: type: array items: $ref: "#/components/schemas/DiskBackupApiPolicyItem" + x-sunset: 2025-09-09 x-xgen-version: 2023-01-01 description: OK "400": @@ -11632,6 +12028,7 @@ paths: - Data Lake Pipelines /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/availableSnapshots: get: + deprecated: true description: "Returns a list of backup snapshots that you can use to trigger\ \ an on demand pipeline run. To use this resource, the requesting API Key\ \ must have the Project Read Only role." @@ -11668,6 +12065,7 @@ paths: application/vnd.atlas.2023-01-01+json: schema: $ref: "#/components/schemas/PaginatedBackupSnapshotView" + x-sunset: 2025-09-09 x-xgen-version: 2023-01-01 description: OK "400": @@ -11683,6 +12081,7 @@ paths: - Data Lake Pipelines /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/pause: post: + deprecated: true description: "Pauses ingestion for a Data Lake Pipeline within the specified\ \ project. To use this resource, the requesting API Key must have the Project\ \ Read Only role." @@ -11706,6 +12105,7 @@ paths: application/vnd.atlas.2023-01-01+json: schema: $ref: "#/components/schemas/DataLakeIngestionPipeline" + x-sunset: 2025-09-09 x-xgen-version: 2023-01-01 description: OK "400": @@ -11721,6 +12121,7 @@ paths: - Data Lake Pipelines /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/resume: post: + deprecated: true description: "Resumes ingestion for a Data Lake Pipeline within the specified\ \ project. To use this resource, the requesting API Key must have the Project\ \ Read Only role." @@ -11744,6 +12145,7 @@ paths: application/vnd.atlas.2023-01-01+json: schema: $ref: "#/components/schemas/DataLakeIngestionPipeline" + x-sunset: 2025-09-09 x-xgen-version: 2023-01-01 description: OK "400": @@ -11759,6 +12161,7 @@ paths: - Data Lake Pipelines /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs: get: + deprecated: true description: "Returns a list of past Data Lake Pipeline runs. To use this resource,\ \ the requesting API Key must have the Project Read Only role." operationId: listPipelineRuns @@ -11792,6 +12195,7 @@ paths: application/vnd.atlas.2023-01-01+json: schema: $ref: "#/components/schemas/PaginatedPipelineRunView" + x-sunset: 2025-09-09 x-xgen-version: 2023-01-01 description: OK "400": @@ -11807,6 +12211,7 @@ paths: - Data Lake Pipelines /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/runs/{pipelineRunId}: delete: + deprecated: true description: Deletes dataset that Atlas generated during the specified pipeline run. operationId: deletePipelineRunDataset @@ -11840,6 +12245,7 @@ paths: application/vnd.atlas.2023-01-01+json: schema: $ref: "#/components/schemas/RequestAccepted" + x-sunset: 2025-09-09 x-xgen-version: 2023-01-01 description: Accepted "400": @@ -11854,6 +12260,7 @@ paths: tags: - Data Lake Pipelines get: + deprecated: true description: "Returns the details of one Data Lake Pipeline run within the specified\ \ project. To use this resource, the requesting API Key must have the Project\ \ Read Only role." @@ -11888,6 +12295,7 @@ paths: application/vnd.atlas.2023-01-01+json: schema: $ref: "#/components/schemas/IngestionPipelineRun" + x-sunset: 2025-09-09 x-xgen-version: 2023-01-01 description: OK "400": @@ -11903,6 +12311,7 @@ paths: - Data Lake Pipelines /api/atlas/v2/groups/{groupId}/pipelines/{pipelineName}/trigger: post: + deprecated: true description: Triggers a Data Lake Pipeline ingestion of a specified snapshot. operationId: triggerSnapshotIngestion parameters: @@ -11931,6 +12340,7 @@ paths: application/vnd.atlas.2023-01-01+json: schema: $ref: "#/components/schemas/IngestionPipelineRun" + x-sunset: 2025-09-09 x-xgen-version: 2023-01-01 description: OK "400": @@ -12075,7 +12485,7 @@ paths: schema: type: string maxLength: 64 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -12117,7 +12527,7 @@ paths: schema: type: string maxLength: 64 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -12161,7 +12571,7 @@ paths: schema: type: string maxLength: 64 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be removed. in: path @@ -12207,7 +12617,7 @@ paths: schema: type: string maxLength: 64 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the tenant endpoint. in: path @@ -12252,7 +12662,7 @@ paths: schema: type: string maxLength: 64 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the tenant endpoint which will be updated. in: path @@ -13274,6 +13684,8 @@ paths: - 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 maxItems: 10 minItems: 1 uniqueItems: true @@ -13358,6 +13770,8 @@ paths: - CACHE_BYTES_WRITTEN_FROM - CACHE_DIRTY_BYTES - CACHE_USED_BYTES + - CACHE_FILL_RATIO + - DIRTY_FILL_RATIO - COMPUTED_MEMORY - CONNECTIONS - CURSORS_TOTAL_OPEN @@ -13439,6 +13853,7 @@ paths: - 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 @@ -13981,7 +14396,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "201": content: @@ -14126,7 +14541,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -14164,7 +14579,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -14214,7 +14629,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the restore job to return. in: path @@ -14265,7 +14680,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -14302,7 +14717,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Unique 24-hexadecimal digit string that identifies the desired snapshot. in: path @@ -14347,7 +14762,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/pretty" responses: @@ -14380,7 +14795,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" - description: Value that we want to set for the Serverless Auto Indexing toggle. in: query name: enable @@ -14424,15 +14839,15 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: - "204": + "202": content: application/vnd.atlas.2023-01-01+json: schema: - $ref: "#/components/schemas/NoBody" + $ref: "#/components/schemas/RequestAccepted" x-xgen-version: 2023-01-01 - description: This endpoint does not return a response body. + description: Accepted "400": $ref: "#/components/responses/badRequest" "404": @@ -14463,7 +14878,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" responses: "200": content: @@ -14501,7 +14916,7 @@ paths: type: string maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" requestBody: content: application/vnd.atlas.2023-01-01+json: @@ -14530,8 +14945,8 @@ paths: - Serverless Instances /api/atlas/v2/groups/{groupId}/serviceAccounts: get: - description: Returns list of Service Accounts for a project with service account - details. + description: Returns all Service Accounts for the specified Project. Available + as a preview feature. operationId: listProjectServiceAccounts parameters: - $ref: "#/components/parameters/groupId" @@ -14542,10 +14957,10 @@ paths: responses: "200": content: - application/vnd.atlas.2023-10-01+json: + application/vnd.atlas.2024-08-05+json: schema: $ref: "#/components/schemas/PaginatedGroupServiceAccounts" - x-xgen-version: 2023-10-01 + x-xgen-version: 2024-08-05 description: OK "401": $ref: "#/components/responses/unauthorized" @@ -14555,12 +14970,13 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Return All project Service Accounts + summary: List All Project Service Accounts tags: - - Groups + - Service Accounts post: - description: Creates and assigns the specified Service Account to the specified - Project. + description: Creates one Service Account for the specified Project. The Service + Account will automatically be added as an Organization Member to the Organization + that the specified Project is a part of. Available as a preview feature. operationId: createProjectServiceAccount parameters: - $ref: "#/components/parameters/groupId" @@ -14568,19 +14984,19 @@ paths: - $ref: "#/components/parameters/pretty" requestBody: content: - application/vnd.atlas.2023-10-01+json: + application/vnd.atlas.2024-08-05+json: schema: $ref: "#/components/schemas/GroupServiceAccountRequest" - x-xgen-version: 2023-10-01 - description: Details to create service account and add to the specified project. + x-xgen-version: 2024-08-05 + description: Details of the new Service Account. required: true responses: "201": content: - application/vnd.atlas.2023-10-01+json: + application/vnd.atlas.2024-08-05+json: schema: $ref: "#/components/schemas/GroupServiceAccount" - x-xgen-version: 2023-10-01 + x-xgen-version: 2024-08-05 description: Created "400": $ref: "#/components/responses/badRequest" @@ -14590,32 +15006,37 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Create and Assign one Service Account to one project + summary: Create and Assign one Service Account to one Project tags: - - Groups - /api/atlas/v2/groups/{groupId}/serviceAccounts/{serviceAccountId}: + - Service Accounts + /api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}: delete: - description: Removes one Service Account from the specified project. + description: "Removes the specified Service Account from the specified project.\ + \ The Service Account will still be a part of the Organization it was created\ + \ in, and the credentials will remain active until expired or manually revoked.\ + \ Available as a preview feature." operationId: deleteProjectServiceAccount parameters: - - description: Id of the service account. + - description: The Client ID of the Service Account. in: path - name: serviceAccountId + name: clientId required: true schema: type: string + example: mdb_sa_id_667066535bc75b03c37b3038 + pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" - $ref: "#/components/parameters/groupId" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/pretty" responses: "204": content: - application/vnd.atlas.2023-10-01+json: + application/vnd.atlas.2024-08-05+json: schema: $ref: "#/components/schemas/NoBody" - x-xgen-version: 2023-10-01 + x-xgen-version: 2024-08-05 description: This endpoint does not return a response body. - x-xgen-version: 2023-10-01 + x-xgen-version: 2024-08-05 "401": $ref: "#/components/responses/unauthorized" "404": @@ -14624,29 +15045,32 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Unassign One Service Account from One Project. + summary: Unassign One Service Account from One Project tags: - - Groups + - Service Accounts get: - description: Get project Service Account Details. + description: Returns one Service Account in the specified Project. Available + as a preview feature. operationId: getProjectServiceAccount parameters: - $ref: "#/components/parameters/groupId" - - description: Id of the service account. + - description: The Client ID of the Service Account. in: path - name: serviceAccountId + name: clientId required: true schema: type: string + example: mdb_sa_id_667066535bc75b03c37b3038 + pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/pretty" responses: "200": content: - application/vnd.atlas.2023-10-01+json: + application/vnd.atlas.2024-08-05+json: schema: $ref: "#/components/schemas/GroupServiceAccount" - x-xgen-version: 2023-10-01 + x-xgen-version: 2024-08-05 description: OK "401": $ref: "#/components/responses/unauthorized" @@ -14656,36 +15080,39 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Service Account Fetching + summary: Get one Project Service Account tags: - - Groups + - Service Accounts patch: - description: Update Service Account in Project. + description: Updates one Service Account in the specified Project. Available + as a preview feature. operationId: updateProjectServiceAccount parameters: - - description: Id of the service account. + - description: The Client ID of the Service Account. in: path - name: serviceAccountId + name: clientId required: true schema: type: string + example: mdb_sa_id_667066535bc75b03c37b3038 + pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" - $ref: "#/components/parameters/groupId" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/pretty" requestBody: content: - application/vnd.atlas.2023-10-01+json: + application/vnd.atlas.2024-08-05+json: schema: $ref: "#/components/schemas/GroupServiceAccountUpdateRequest" - description: Details to update service account in the specified Project. + description: The new details for the Service Account. required: true responses: "200": content: - application/vnd.atlas.2023-10-01+json: + application/vnd.atlas.2024-08-05+json: schema: $ref: "#/components/schemas/GroupServiceAccount" - x-xgen-version: 2023-10-01 + x-xgen-version: 2024-08-05 description: OK "400": $ref: "#/components/responses/badRequest" @@ -14697,42 +15124,182 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Service Account Update in Project + summary: Update one Project Service Account tags: - - Groups + - Service Accounts + /api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList: + get: + description: Returns all access list entries that you configured for the specified + Service Account for the project. Available as a preview feature. + operationId: listProjectServiceAccountAccessList + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/includeCount" + - $ref: "#/components/parameters/itemsPerPage" + - $ref: "#/components/parameters/groupId" + - $ref: "#/components/parameters/pageNum" + - $ref: "#/components/parameters/pretty" + - description: The Client ID of the Service Account. + in: path + name: clientId + required: true + schema: + type: string + example: mdb_sa_id_667066535bc75b03c37b3038 + pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" + responses: + "200": + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/PaginatedServiceAccountIPAccessEntryView" + x-xgen-version: 2024-08-05 + description: OK + "401": + $ref: "#/components/responses/unauthorized" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Return All Access List entries for one Project Service Account + tags: + - Service Accounts post: - description: Assigns the specified organization Service Account to the specified - project. + description: Add Access List Entries for the specified Service Account for the + project. Resources require all API requests to originate from IP addresses + on the API access list. Available as a preview feature. + operationId: createProjectServiceAccountAccessList + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/includeCount" + - $ref: "#/components/parameters/itemsPerPage" + - $ref: "#/components/parameters/groupId" + - $ref: "#/components/parameters/pageNum" + - $ref: "#/components/parameters/pretty" + - description: The Client ID of the Service Account. + in: path + name: clientId + required: true + schema: + type: string + example: mdb_sa_id_667066535bc75b03c37b3038 + pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" + requestBody: + content: + application/vnd.atlas.2024-08-05+json: + schema: + type: array + items: + $ref: "#/components/schemas/ServiceAccountIPAccessListEntry" + x-xgen-version: 2024-08-05 + description: A list of access list entries to add to the access list of the + specified Service Account for the project. + required: true + responses: + "200": + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/PaginatedServiceAccountIPAccessEntryView" + x-xgen-version: 2024-08-05 + description: OK + "400": + $ref: "#/components/responses/badRequest" + "401": + $ref: "#/components/responses/unauthorized" + "409": + $ref: "#/components/responses/conflict" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Add Access List entries for one Project Service Account + tags: + - Service Accounts + /api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}/accessList/{ipAddress}: + delete: + description: Removes the specified access list entry from the specified Service + Account for the project. You can't remove the requesting IP address from the + access list. Available as a preview feature. + operationId: deleteProjectServiceAccountAccessListEntry + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/groupId" + - $ref: "#/components/parameters/pretty" + - description: The Client ID of the Service Account. + in: path + name: clientId + required: true + schema: + type: string + example: mdb_sa_id_667066535bc75b03c37b3038 + pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" + - description: "One IP address or multiple IP addresses represented as one CIDR\ + \ block. When specifying a CIDR block with a subnet mask, such as 192.0.2.0/24,\ + \ use the URL-encoded value %2F for the forward slash /." + in: path + name: ipAddress + required: true + schema: + type: string + example: 192.0.2.0%2F24 + pattern: "^([0-9]{1,3}\\.){3}[0-9]{1,3}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\\ + :){7}[0-9a-f]{1,4}(%2[fF][0-9]{1,3})?|([0-9a-f]{1,4}\\:){1,6}\\:(%2[fF][0-9]{1,3})?$" + responses: + "204": + content: + application/vnd.atlas.2024-08-05+json: + x-xgen-version: 2024-08-05 + description: This endpoint does not return a response body. + "400": + $ref: "#/components/responses/badRequest" + "401": + $ref: "#/components/responses/unauthorized" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Remove One Access List entry from one Project Service Account + tags: + - Service Accounts + /api/atlas/v2/groups/{groupId}/serviceAccounts/{clientId}:invite: + post: + description: Assigns the specified Service Account to the specified Project. + Available as a preview feature. operationId: addProjectServiceAccount parameters: - - description: Id of the service account. + - description: The Client ID of the Service Account. in: path - name: serviceAccountId + name: clientId required: true schema: type: string + example: mdb_sa_id_667066535bc75b03c37b3038 + pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" - $ref: "#/components/parameters/groupId" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/pretty" requestBody: content: - application/vnd.atlas.2023-10-01+json: + application/vnd.atlas.2024-08-05+json: schema: type: array items: $ref: "#/components/schemas/GroupServiceAccountRoleAssignment" - x-xgen-version: 2023-10-01 - description: Service Account Roles to be assigned to the specified project. + x-xgen-version: 2024-08-05 + description: The Project permissions for the Service Account in the specified + Project. required: true responses: - "204": + "200": content: - application/vnd.atlas.2023-10-01+json: + application/vnd.atlas.2024-08-05+json: schema: - $ref: "#/components/schemas/NoBody" - x-xgen-version: 2023-10-01 - description: This endpoint does not return a response body. - x-xgen-version: 2023-10-01 + $ref: "#/components/schemas/GroupServiceAccount" + x-xgen-version: 2024-08-05 + description: OK "401": $ref: "#/components/responses/unauthorized" "404": @@ -14743,7 +15310,7 @@ paths: - DigestAuth: [] summary: Assign One Service Account to One Project tags: - - Groups + - Service Accounts /api/atlas/v2/groups/{groupId}/settings: get: description: "Returns details about the specified project's settings. To use\ @@ -14880,6 +15447,292 @@ paths: x-xgen-changelog: "2023-09-11": "The MongoDB Atlas Streams Processing API is now exposed as\ \ part of private preview, but is subject to change until GA." + /api/atlas/v2/groups/{groupId}/streams/privateLinkConnections: + get: + description: "Returns all Private Link connections for the specified project.To\ + \ use this resource, the requesting API Key must have the Project Data Access\ + \ roles, Project Owner role or Project Stream Processing Owner role." + operationId: listPrivateLinkConnections + parameters: + - $ref: "#/components/parameters/groupId" + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/itemsPerPage" + - $ref: "#/components/parameters/pageNum" + - $ref: "#/components/parameters/pretty" + responses: + "200": + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/PaginatedApiStreamsPrivateLinkView" + x-xgen-version: 2023-02-01 + description: OK + "401": + $ref: "#/components/responses/unauthorized" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Return All Private Link + tags: + - Streams + x-xgen-changelog: + "2024-10-02": "The MongoDB Atlas Streams Processing Private Link API is now\ + \ exposed as part of private preview, but is subject to change until GA." + post: + description: "Creates one Private Link in the specified project. To use this\ + \ resource, the requesting API Key must have the Project Owner or Project\ + \ Stream Processing Owner role." + operationId: createPrivateLinkConnection + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/pretty" + - $ref: "#/components/parameters/groupId" + requestBody: + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/StreamsPrivateLinkConnection" + description: Details to create one Private Link connection for a project. + project. + required: true + responses: + "200": + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/StreamsPrivateLinkConnection" + x-xgen-version: 2023-02-01 + description: OK + "400": + $ref: "#/components/responses/badRequest" + "401": + $ref: "#/components/responses/unauthorized" + "409": + $ref: "#/components/responses/unauthorized" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Create One Private Link connection + tags: + - Streams + x-xgen-changelog: + "2024-10-02": "The MongoDB Atlas Streams Processing Private Link API is now\ + \ exposed as part of private preview, but is subject to change until GA." + /api/atlas/v2/groups/{groupId}/streams/privateLinkConnections/{connectionId}: + delete: + description: "Deletes one Private Link in the specified project. To use this\ + \ resource, the requesting API Key must have the Project Owner or Project\ + \ Stream Processing Owner role." + operationId: deletePrivateLinkConnection + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/pretty" + - $ref: "#/components/parameters/groupId" + - description: Unique ID that identifies the Private Link connection. + in: path + name: connectionId + required: true + schema: + type: string + responses: + "202": + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/NoBody" + x-xgen-version: 2023-02-01 + description: Accepted + "401": + $ref: "#/components/responses/unauthorized" + "403": + $ref: "#/components/responses/forbidden" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Delete One Private Link connection + tags: + - Streams + x-xgen-changelog: + "2024-10-02": "The MongoDB Atlas Streams Processing Private Link API is now\ + \ exposed as part of private preview, but is subject to change until GA." + get: + description: "Returns the details of one Private Link connection within the\ + \ project. To use this resource, the requesting API Key must have the Project\ + \ Read Only role." + operationId: getPrivateLinkConnection + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/groupId" + - description: Unique ID that identifies the Private Link connection. + in: path + name: connectionId + required: true + schema: + type: string + responses: + "200": + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/StreamsPrivateLinkConnection" + x-xgen-version: 2023-02-01 + description: OK + "401": + $ref: "#/components/responses/unauthorized" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Return One PrivateLink Connection + tags: + - Streams + x-xgen-changelog: + "2024-10-02": "The MongoDB Atlas Streams Processing Private Link API is now\ + \ exposed as part of private preview, but is subject to change until GA." + /api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections: + get: + description: Returns a list of incoming VPC Peering Connections. + operationId: getVPCPeeringConnections + parameters: + - $ref: "#/components/parameters/groupId" + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/itemsPerPage" + - $ref: "#/components/parameters/pageNum" + - $ref: "#/components/parameters/pretty" + responses: + "200": + content: + application/vnd.atlas.2023-02-01+json: + x-xgen-version: 2023-02-01 + description: OK + "401": + $ref: "#/components/responses/unauthorized" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Return All VPC Peering Connections. + tags: + - Streams + /api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}: + delete: + description: Deletes an incoming VPC Peering connection. + operationId: deleteVPCPeeringConnection + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/groupId" + - description: The VPC Peering Connection id. + in: path + name: id + required: true + schema: + type: string + responses: + "202": + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/NoBody" + x-xgen-version: 2023-02-01 + description: Accepted + "401": + $ref: "#/components/responses/unauthorized" + "403": + $ref: "#/components/responses/forbidden" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Deletes an incoming VPC Peering connection. + tags: + - Streams + /api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:accept: + post: + description: Requests the acceptance of an incoming VPC Peering connection. + operationId: acceptVPCPeeringConnection + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/groupId" + - description: The VPC Peering Connection id. + in: path + name: id + required: true + schema: + type: string + requestBody: + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/VPCPeeringActionChallenge" + description: "Challenge values for VPC Peering requester account ID, and requester\ + \ VPC ID." + required: true + responses: + "202": + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/NoBody" + x-xgen-version: 2023-02-01 + description: Accepted + "401": + $ref: "#/components/responses/unauthorized" + "403": + $ref: "#/components/responses/forbidden" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Requests the acceptance of an incoming VPC Peering connection. + tags: + - Streams + /api/atlas/v2/groups/{groupId}/streams/vpcPeeringConnections/{id}:reject: + post: + description: Requests the rejection of an incoming VPC Peering connection. + operationId: rejectVPCPeeringConnection + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/groupId" + - description: The VPC Peering Connection id. + in: path + name: id + required: true + schema: + type: string + responses: + "202": + content: + application/vnd.atlas.2023-02-01+json: + schema: + $ref: "#/components/schemas/NoBody" + x-xgen-version: 2023-02-01 + description: Accepted + "401": + $ref: "#/components/responses/unauthorized" + "403": + $ref: "#/components/responses/forbidden" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Requests the rejection of an incoming VPC Peering connection. + tags: + - Streams /api/atlas/v2/groups/{groupId}/streams/{tenantName}: delete: description: "Delete one stream instance in the specified project. To use this\ @@ -15565,6 +16418,43 @@ paths: summary: Return All Stream Processors In The Stream Instance. tags: - Streams + /api/atlas/v2/groups/{groupId}/streams:withSampleConnections: + post: + description: "Creates one stream instance in the specified project with sample\ + \ connections. To use this resource the requesting API Key must have the Project\ + \ Data Access Admin role, Project Owner role or Project Stream Processing\ + \ Owner role." + operationId: createStreamInstanceWithSampleConnections + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/pretty" + - $ref: "#/components/parameters/groupId" + requestBody: + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/TenantWithSampleConnections" + description: Details to create one streams instance in the specified project. + required: true + responses: + "200": + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/StreamsTenant" + x-xgen-version: 2024-08-05 + description: OK + "400": + $ref: "#/components/responses/badRequest" + "401": + $ref: "#/components/responses/unauthorized" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Create One Stream Instance With Sample Connections + tags: + - Streams /api/atlas/v2/groups/{groupId}/teams: get: description: "Returns all teams to which the authenticated user has access in\ @@ -16079,194 +16969,6 @@ paths: summary: Update Project Roles for One MongoDB Cloud User tags: - Projects - /api/atlas/v2/groups/{groupId}/uss: - get: - description: "Returns details for all USS instances in the specified project.\ - \ To use this resource, the requesting API Key must have the Project Read\ - \ Only role." - operationId: listUSSInstances - parameters: - - $ref: "#/components/parameters/envelope" - - $ref: "#/components/parameters/groupId" - - $ref: "#/components/parameters/includeCount" - - $ref: "#/components/parameters/itemsPerPage" - - $ref: "#/components/parameters/pageNum" - - $ref: "#/components/parameters/pretty" - responses: - "200": - content: - application/vnd.atlas.2025-01-01+json: - schema: - $ref: "#/components/schemas/PaginatedUSSInstance20250101" - x-xgen-version: 2025-01-01 - description: OK - "409": - $ref: "#/components/responses/conflict" - "500": - $ref: "#/components/responses/internalServerError" - security: - - DigestAuth: [] - summary: Return All USS Instances from One Project - tags: - - USS Instances - post: - description: "Creates one USS instance in the specified project. To use this\ - \ resource, the requesting API Key must have the Project Owner role." - operationId: createUSSInstance - parameters: - - $ref: "#/components/parameters/envelope" - - $ref: "#/components/parameters/groupId" - - $ref: "#/components/parameters/pretty" - requestBody: - content: - application/vnd.atlas.2025-01-01+json: - schema: - $ref: "#/components/schemas/USSInstanceDescriptionCreate20250101" - description: Create One USS Instance in One Project. - required: true - responses: - "201": - content: - application/vnd.atlas.2025-01-01+json: - schema: - $ref: "#/components/schemas/USSInstanceDescription20250101" - x-xgen-version: 2025-01-01 - description: Created - "400": - $ref: "#/components/responses/badRequest" - "402": - $ref: "#/components/responses/paymentRequired" - "409": - $ref: "#/components/responses/conflict" - "500": - $ref: "#/components/responses/internalServerError" - security: - - DigestAuth: [] - summary: Create One USS Instance in One Project - tags: - - USS Instances - /api/atlas/v2/groups/{groupId}/uss/{name}: - delete: - description: "Removes one USS instance from the specified project. The USS instance\ - \ must have termination protection disabled in order to be deleted. To use\ - \ this resource, the requesting API Key must have the Project Owner role." - operationId: deleteUSSInstance - parameters: - - $ref: "#/components/parameters/envelope" - - $ref: "#/components/parameters/pretty" - - $ref: "#/components/parameters/groupId" - - description: Human-readable label that identifies the USS instance. - in: path - name: name - required: true - schema: - type: string - maxLength: 64 - minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - responses: - "204": - content: - application/vnd.atlas.2025-01-01+json: - schema: - $ref: "#/components/schemas/NoBody" - x-xgen-version: 2025-01-01 - description: This endpoint does not return a response body. - "400": - $ref: "#/components/responses/badRequest" - "404": - $ref: "#/components/responses/notFound" - "409": - $ref: "#/components/responses/conflict" - "500": - $ref: "#/components/responses/internalServerError" - security: - - DigestAuth: [] - summary: Remove One USS Instance from One Project - tags: - - USS Instances - get: - description: "Returns details for one USS instance in the specified project.\ - \ To use this resource, the requesting API Key must have the Project Read\ - \ Only role." - operationId: getUSSInstance - parameters: - - $ref: "#/components/parameters/groupId" - - $ref: "#/components/parameters/envelope" - - $ref: "#/components/parameters/pretty" - - description: Human-readable label that identifies the USS instance. - in: path - name: name - required: true - schema: - type: string - maxLength: 64 - minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - responses: - "200": - content: - application/vnd.atlas.2025-01-01+json: - schema: - $ref: "#/components/schemas/USSInstanceDescription20250101" - x-xgen-version: 2025-01-01 - description: OK - "400": - $ref: "#/components/responses/badRequest" - "404": - $ref: "#/components/responses/notFound" - "409": - $ref: "#/components/responses/conflict" - "500": - $ref: "#/components/responses/internalServerError" - security: - - DigestAuth: [] - summary: Return One USS Instance from One Project - tags: - - USS Instances - patch: - description: "Updates one USS instance in the specified project. To use this\ - \ resource, the requesting API Key must have the Project Owner role." - operationId: updateUSSInstance - parameters: - - $ref: "#/components/parameters/envelope" - - $ref: "#/components/parameters/groupId" - - $ref: "#/components/parameters/pretty" - - description: Human-readable label that identifies the USS instance. - in: path - name: name - required: true - schema: - type: string - maxLength: 64 - minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - requestBody: - content: - application/vnd.atlas.2025-01-01+json: - schema: - $ref: "#/components/schemas/USSInstanceDescription20250101" - description: Update One USS Instance in One Project. - required: true - responses: - "200": - content: - application/vnd.atlas.2025-01-01+json: - schema: - $ref: "#/components/schemas/USSInstanceDescription20250101" - x-xgen-version: 2025-01-01 - description: OK - "400": - $ref: "#/components/responses/badRequest" - "402": - $ref: "#/components/responses/paymentRequired" - "409": - $ref: "#/components/responses/conflict" - security: - - DigestAuth: [] - summary: Update One USS Instance in One Project - tags: - - USS Instances /api/atlas/v2/groups/{groupId}:migrate: post: description: "Migrates a project from its current organization to another organization.\ @@ -17646,7 +18348,7 @@ paths: summary: Return One Organization Invoice as CSV tags: - Invoices - /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/lineItems/:search: + /api/atlas/v2/orgs/{orgId}/invoices/{invoiceId}/lineItems:search: get: description: Query the lineItems of the specified invoice and return the result JSON. A unique 24-hexadecimal digit string identifies the invoice. @@ -17669,7 +18371,7 @@ paths: pattern: "^([a-f0-9]{24})$" requestBody: content: - application/vnd.atlas.2025-01-01+json: + application/vnd.atlas.2024-08-05+json: schema: $ref: "#/components/schemas/ApiPublicUsageDetailsQueryRequest" description: Filter parameters for the lineItems query. Send a request with @@ -17679,10 +18381,10 @@ paths: responses: "200": content: - application/vnd.atlas.2025-01-01+json: + application/vnd.atlas.2024-08-05+json: schema: $ref: "#/components/schemas/PaginatedPublicApiUsageDetailsLineItemView" - x-xgen-version: 2025-01-01 + x-xgen-version: 2024-08-05 description: OK "400": $ref: "#/components/responses/badRequest" @@ -17791,9 +18493,316 @@ paths: summary: Create One Link-Token tags: - Cloud Migration Service + /api/atlas/v2/orgs/{orgId}/nonCompliantResources: + get: + description: Return all non-compliant resources for an org. + externalDocs: + description: Atlas Resource Policies + url: https://docs.atlas.mongodb.com + operationId: getResourcesNonCompliant + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/pretty" + - $ref: "#/components/parameters/orgId" + responses: + "200": + content: + application/vnd.atlas.2024-08-05+json: + schema: + type: array + items: + $ref: "#/components/schemas/ApiAtlasNonCompliantResourceView" + x-xgen-version: 2024-08-05 + description: OK + "400": + $ref: "#/components/responses/badRequest" + "401": + $ref: "#/components/responses/unauthorized" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Return all non-compliant resources + tags: + - Resource Policies + /api/atlas/v2/orgs/{orgId}/resourcePolicies: + get: + description: Return all Atlas Resource Policies for the org. + externalDocs: + description: Atlas Resource Policies + url: https://docs.atlas.mongodb.com + operationId: getAtlasResourcePolicies + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/pretty" + - $ref: "#/components/parameters/orgId" + responses: + "200": + content: + application/vnd.atlas.2024-08-05+json: + schema: + type: array + items: + $ref: "#/components/schemas/ApiAtlasResourcePolicyView" + x-xgen-version: 2024-08-05 + description: OK + "400": + $ref: "#/components/responses/badRequest" + "401": + $ref: "#/components/responses/unauthorized" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Return all Atlas Resource Policies + tags: + - Resource Policies + post: + description: Create one Atlas Resource Policy for an org. + externalDocs: + description: Atlas Resource Policies + url: https://docs.atlas.mongodb.com + operationId: createAtlasResourcePolicy + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/pretty" + - $ref: "#/components/parameters/orgId" + requestBody: + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/ApiAtlasResourcePolicyCreateView" + x-xgen-version: 2024-08-05 + description: Atlas Resource Policy to create. + required: true + responses: + "201": + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/ApiAtlasResourcePolicyView" + x-xgen-version: 2024-08-05 + description: Created + "400": + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/ApiAtlasInvalidResourcePolicyCreateErrorView" + x-xgen-version: 2024-08-05 + description: Bad request. + "401": + $ref: "#/components/responses/unauthorized" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Create one Atlas Resource Policy + tags: + - Resource Policies + /api/atlas/v2/orgs/{orgId}/resourcePolicies/{resourcePolicyId}: + delete: + description: Delete one Atlas Resource Policy for an org. + externalDocs: + description: Atlas Resource Policies + url: https://docs.atlas.mongodb.com + operationId: deleteAtlasResourcePolicy + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/pretty" + - $ref: "#/components/parameters/orgId" + - description: Unique 24-hexadecimal digit string that identifies an atlas resource + policy. + in: path + name: resourcePolicyId + required: true + schema: + type: string + description: Unique 24-hexadecimal character string that identifies the + atlas resource policy. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + responses: + "200": + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/NoBody" + x-xgen-version: 2024-08-05 + description: This endpoint does not return a response body. + "400": + $ref: "#/components/responses/badRequest" + "401": + $ref: "#/components/responses/unauthorized" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Delete one Atlas Resource Policy + tags: + - Resource Policies + get: + description: Return one Atlas Resource Policy for an org. + externalDocs: + description: Atlas Resource Policies + url: https://docs.atlas.mongodb.com + operationId: getAtlasResourcePolicy + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/pretty" + - $ref: "#/components/parameters/orgId" + - description: Unique 24-hexadecimal digit string that identifies an atlas resource + policy. + in: path + name: resourcePolicyId + required: true + schema: + type: string + description: Unique 24-hexadecimal character string that identifies the + atlas resource policy. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + responses: + "200": + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/ApiAtlasResourcePolicyView" + x-xgen-version: 2024-08-05 + description: OK + "400": + $ref: "#/components/responses/badRequest" + "401": + $ref: "#/components/responses/unauthorized" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Return one Atlas Resource Policy + tags: + - Resource Policies + patch: + description: Update one Atlas Resource Policy for an org. + externalDocs: + description: Atlas Resource Policies + url: https://docs.atlas.mongodb.com + operationId: updateAtlasResourcePolicy + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/pretty" + - $ref: "#/components/parameters/orgId" + - description: Unique 24-hexadecimal digit string that identifies an atlas resource + policy. + in: path + name: resourcePolicyId + required: true + schema: + type: string + description: Unique 24-hexadecimal character string that identifies the + atlas resource policy. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + requestBody: + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/ApiAtlasResourcePolicyEditView" + x-xgen-version: 2024-08-05 + description: Atlas Resource Policy to update. + required: true + responses: + "200": + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/ApiAtlasResourcePolicyView" + x-xgen-version: 2024-08-05 + description: Ok + "400": + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/ApiAtlasInvalidResourcePolicyCreateErrorView" + x-xgen-version: 2024-08-05 + description: Bad request. + "401": + $ref: "#/components/responses/unauthorized" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Update one Atlas Resource Policy + tags: + - Resource Policies + /api/atlas/v2/orgs/{orgId}/resourcePolicies:validate: + post: + description: Validate one Atlas Resource Policy for an org. + externalDocs: + description: Atlas Resource Policies + url: https://docs.atlas.mongodb.com + operationId: validateAtlasResourcePolicy + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/pretty" + - $ref: "#/components/parameters/orgId" + requestBody: + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/ApiAtlasResourcePolicyCreateView" + x-xgen-version: 2024-08-05 + description: Atlas Resource Policy to create. + required: true + responses: + "200": + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/ApiAtlasResourcePolicyView" + x-xgen-version: 2024-08-05 + description: Ok + "400": + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/ApiAtlasInvalidResourcePolicyCreateErrorView" + x-xgen-version: 2024-08-05 + description: Bad request. + "401": + $ref: "#/components/responses/unauthorized" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Validate one Atlas Resource Policy + tags: + - Resource Policies /api/atlas/v2/orgs/{orgId}/serviceAccounts: get: - description: Returns list of Service Accounts with service account details. + description: Returns all Service Accounts for the specified Organization. Available + as a preview feature. operationId: listServiceAccounts parameters: - $ref: "#/components/parameters/orgId" @@ -17804,10 +18813,10 @@ paths: responses: "200": content: - application/vnd.atlas.2023-10-01+json: + application/vnd.atlas.2024-08-05+json: schema: $ref: "#/components/schemas/PaginatedOrgServiceAccounts" - x-xgen-version: 2023-10-01 + x-xgen-version: 2024-08-05 description: OK "401": $ref: "#/components/responses/unauthorized" @@ -17817,11 +18826,12 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Return All Service Accounts + summary: List All Organization Service Accounts tags: - - Organizations + - Service Accounts post: - description: Create Service Account containing client id and client secrets. + description: Creates one Service Account for the specified Organization. Available + as a preview feature. operationId: createServiceAccount parameters: - $ref: "#/components/parameters/orgId" @@ -17829,18 +18839,18 @@ paths: - $ref: "#/components/parameters/pretty" requestBody: content: - application/vnd.atlas.2023-10-01+json: + application/vnd.atlas.2024-08-05+json: schema: $ref: "#/components/schemas/OrgServiceAccountRequest" - description: Details to create service account in the specified organization. + description: Details of the new Service Account. required: true responses: "201": content: - application/vnd.atlas.2023-10-01+json: + application/vnd.atlas.2024-08-05+json: schema: $ref: "#/components/schemas/OrgServiceAccount" - x-xgen-version: 2023-10-01 + x-xgen-version: 2024-08-05 description: Created "400": $ref: "#/components/responses/badRequest" @@ -17850,28 +18860,30 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Service Account Creation + summary: Create one Organization Service Account tags: - - Organizations - /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}: + - Service Accounts + /api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}: delete: - description: Delete Service Account. + description: Deletes the specified Service Account. Available as a preview feature. operationId: deleteServiceAccount parameters: - - description: Id of the service account. + - description: The Client ID of the Service Account. in: path - name: serviceAccountId + name: clientId required: true schema: type: string + example: mdb_sa_id_667066535bc75b03c37b3038 + pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" - $ref: "#/components/parameters/orgId" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/pretty" responses: "204": content: - application/vnd.atlas.2023-10-01+json: - x-xgen-version: 2023-10-01 + application/vnd.atlas.2024-08-05+json: + x-xgen-version: 2024-08-05 description: This endpoint does not return a response body. "401": $ref: "#/components/responses/unauthorized" @@ -17881,29 +18893,31 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Service Account Deletion. + summary: Delete one Organization Service Account tags: - - Organizations + - Service Accounts get: - description: Get Service Account Details. + description: Returns the specified Service Account. Available as a preview feature. operationId: getServiceAccount parameters: - $ref: "#/components/parameters/orgId" - - description: Id of the service account. + - description: The Client ID of the Service Account. in: path - name: serviceAccountId + name: clientId required: true schema: type: string + example: mdb_sa_id_667066535bc75b03c37b3038 + pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/pretty" responses: "200": content: - application/vnd.atlas.2023-10-01+json: + application/vnd.atlas.2024-08-05+json: schema: $ref: "#/components/schemas/OrgServiceAccount" - x-xgen-version: 2023-10-01 + x-xgen-version: 2024-08-05 description: OK "401": $ref: "#/components/responses/unauthorized" @@ -17913,36 +18927,39 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Service Account Fetching + summary: Get one Organization Service Account tags: - - Organizations + - Service Accounts patch: - description: Update Service Account. + description: Updates the specified Service Account in the specified Organization. + Available as a preview feature. operationId: updateServiceAccount parameters: - - description: Id of the service account. + - description: The Client ID of the Service Account. in: path - name: serviceAccountId + name: clientId required: true schema: type: string + example: mdb_sa_id_667066535bc75b03c37b3038 + pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" - $ref: "#/components/parameters/orgId" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/pretty" requestBody: content: - application/vnd.atlas.2023-10-01+json: + application/vnd.atlas.2024-08-05+json: schema: $ref: "#/components/schemas/OrgServiceAccountUpdateRequest" - description: Details to update service account in the specified organization. + description: The new details for the Service Account. required: true responses: "200": content: - application/vnd.atlas.2023-10-01+json: + application/vnd.atlas.2024-08-05+json: schema: $ref: "#/components/schemas/OrgServiceAccount" - x-xgen-version: 2023-10-01 + x-xgen-version: 2024-08-05 description: OK "400": $ref: "#/components/responses/badRequest" @@ -17954,21 +18971,24 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Service Account Update + summary: Update one Organization Service Account tags: - - Organizations - /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/groups: + - Service Accounts + /api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/groups: get: - description: Returns list of Service Account projects. + description: Returns a list of all projects the specified Service Account is + a part of. Available as a preview feature. operationId: listServiceAccountProjects parameters: - $ref: "#/components/parameters/orgId" - - description: Id of the service account. + - description: The Client ID of the Service Account. in: path - name: serviceAccountId + name: clientId required: true schema: type: string + example: mdb_sa_id_667066535bc75b03c37b3038 + pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" - $ref: "#/components/parameters/itemsPerPage" - $ref: "#/components/parameters/pageNum" - $ref: "#/components/parameters/pretty" @@ -17976,10 +18996,10 @@ paths: responses: "200": content: - application/vnd.atlas.2023-10-01+json: + application/vnd.atlas.2024-08-05+json: schema: $ref: "#/components/schemas/PaginatedServiceAccountGroup" - x-xgen-version: 2023-10-01 + x-xgen-version: 2024-08-05 description: OK "401": $ref: "#/components/responses/unauthorized" @@ -17989,37 +19009,40 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Return All Service Account projects + summary: Return All Service Account Project assignments tags: - - Organizations - /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets: + - Service Accounts + /api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/secrets: post: - description: Create Service Account secret. + description: Create a secret for the specified Service Account. Available as + a preview feature. operationId: createServiceAccountSecret parameters: - $ref: "#/components/parameters/orgId" - - description: Id of the service account. + - description: The Client ID of the Service Account. in: path - name: serviceAccountId + name: clientId required: true schema: type: string + example: mdb_sa_id_667066535bc75b03c37b3038 + pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/pretty" requestBody: content: - application/vnd.atlas.2023-10-01+json: + application/vnd.atlas.2024-08-05+json: schema: $ref: "#/components/schemas/ServiceAccountSecretRequest" - description: Details to create secret in the specified service account. + description: Details for the new secret. required: true responses: "201": content: - application/vnd.atlas.2023-10-01+json: + application/vnd.atlas.2024-08-05+json: schema: $ref: "#/components/schemas/ServiceAccountSecret" - x-xgen-version: 2023-10-01 + x-xgen-version: 2024-08-05 description: Created "400": $ref: "#/components/responses/badRequest" @@ -18029,21 +19052,24 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Service Account Secret Creation + summary: Create one Organization Service Account Secret tags: - - Organizations - /api/atlas/v2/orgs/{orgId}/serviceAccounts/{serviceAccountId}/secrets/{secretId}: + - Service Accounts + /api/atlas/v2/orgs/{orgId}/serviceAccounts/{clientId}/secrets/{secretId}: delete: - description: Delete Service Account Secret. + description: Deletes the specified Service Account secret. Available as a preview + feature. operationId: deleteServiceAccountSecret parameters: - - description: Id of the service account. + - description: The Client ID of the Service Account. in: path - name: serviceAccountId + name: clientId required: true schema: type: string - - description: Id of the secret. + example: mdb_sa_id_667066535bc75b03c37b3038 + pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" + - description: Unique 24-hexadecimal digit string that identifies the secret. in: path name: secretId required: true @@ -18055,8 +19081,8 @@ paths: responses: "204": content: - application/vnd.atlas.2023-10-01+json: - x-xgen-version: 2023-10-01 + application/vnd.atlas.2024-08-05+json: + x-xgen-version: 2024-08-05 description: This endpoint does not return a response body. "401": $ref: "#/components/responses/unauthorized" @@ -18066,9 +19092,9 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Service Account Secret Deletion. + summary: Delete a Organization Service Account Secret tags: - - Organizations + - Service Accounts /api/atlas/v2/orgs/{orgId}/settings: get: description: "Returns details about the specified organization's settings. To\ @@ -18123,6 +19149,8 @@ paths: $ref: "#/components/schemas/OrganizationSettings" x-xgen-version: 2023-01-01 description: OK + "400": + $ref: "#/components/responses/badRequest" "401": $ref: "#/components/responses/unauthorized" "403": @@ -18595,6 +19623,48 @@ paths: summary: Return All MongoDB Cloud Users in One Organization tags: - Organizations + post: + description: |- + Invites one new or existing MongoDB Cloud user to join the organization. The invitation to join the organization will be sent to the username provided and must be accepted within 30 days. To use this resource, the requesting API Key must have the Organization Owner role. + + **Note**: If the user does not have an existing MongoDB Cloud account, they will be prompted to finish setting up an account upon accepting the invitation. If the user already has an account, they will still receive an invitation to access the organization. + operationId: createOrganizationUser + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/orgId" + - $ref: "#/components/parameters/pretty" + requestBody: + content: + application/vnd.atlas.2025-01-01+json: + schema: + $ref: "#/components/schemas/OrgUserRequest" + description: Represents the MongoDB Cloud user to be created within the organization. + required: true + responses: + "201": + content: + application/vnd.atlas.2025-01-01+json: + schema: + $ref: "#/components/schemas/OrgUserResponse" + x-xgen-version: 2025-01-01 + description: Created + "400": + $ref: "#/components/responses/badRequest" + "401": + $ref: "#/components/responses/unauthorized" + "403": + $ref: "#/components/responses/forbidden" + "404": + $ref: "#/components/responses/notFound" + "409": + $ref: "#/components/responses/conflict" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Create One MongoDB Cloud User in One Organization + tags: + - MongoDB Cloud Users /api/atlas/v2/orgs/{orgId}/users/{userId}: delete: description: "Removes one MongoDB Cloud user from the specified organization.\ @@ -18604,6 +19674,7 @@ paths: parameters: - $ref: "#/components/parameters/envelope" - $ref: "#/components/parameters/orgId" + - $ref: "#/components/parameters/pretty" - description: Unique 24-hexadecimal digit string that identifies the user to be deleted. in: path @@ -18620,7 +19691,12 @@ paths: application/vnd.atlas.2023-01-01+json: schema: $ref: "#/components/schemas/NoBody" + x-sunset: 2026-01-01 x-xgen-version: 2023-01-01 + application/vnd.atlas.2025-01-01+json: + schema: + $ref: "#/components/schemas/NoBody" + x-xgen-version: 2025-01-01 description: This endpoint does not return a response body. "400": $ref: "#/components/responses/badRequest" @@ -18634,9 +19710,110 @@ paths: $ref: "#/components/responses/internalServerError" security: - DigestAuth: [] - summary: Remove One MongoDB Cloud User from One Organization + summary: Remove One MongoDB Cloud User From One Organization tags: - Organizations + get: + description: |- + Returns information about the specified MongoDB Cloud user within the context of the specified organization. To use this resource, the requesting API Key must have the Organization Read Only role. + + **Note**: This resource can only be used to fetch information about MongoDB Cloud human users. To return information about an API Key, use the [Return One Organization API Key](#tag/Programmatic-API-Keys/operation/getApiKey) endpoint. + + **Note**: This resource does not return information about pending users invited via the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint. + operationId: getOrganizationUser + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/orgId" + - $ref: "#/components/parameters/pretty" + - description: "Unique 24-hexadecimal digit string that identifies the pending\ + \ or active user in the organization. If you need to lookup a user's userId\ + \ or verify a user's status in the organization, use the Return All MongoDB\ + \ Cloud Users in One Organization resource and filter by username." + in: path + name: userId + required: true + schema: + type: string + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + responses: + "200": + content: + application/vnd.atlas.2025-01-01+json: + schema: + $ref: "#/components/schemas/OrgUserResponse" + x-xgen-version: 2025-01-01 + description: OK + "400": + $ref: "#/components/responses/badRequest" + "401": + $ref: "#/components/responses/unauthorized" + "403": + $ref: "#/components/responses/forbidden" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Return One MongoDB Cloud User in One Organization + tags: + - MongoDB Cloud Users + patch: + description: |- + Updates one MongoDB Cloud user in the specified organization. You can update an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting API Key must have the Organization Owner role. + + **Note**: Only include the fields you wish to update in the request body. Supplying a field with an empty value will reset that field on the user. + + **Note**: This resource cannot be used to update pending users invited via the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint. + operationId: updateOrganizationUser + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/orgId" + - $ref: "#/components/parameters/pretty" + - description: "Unique 24-hexadecimal digit string that identifies the pending\ + \ or active user in the organization. If you need to lookup a user's userId\ + \ or verify a user's status in the organization, use the Return All MongoDB\ + \ Cloud Users in One Organization resource and filter by username." + in: path + name: userId + required: true + schema: + type: string + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + requestBody: + content: + application/vnd.atlas.2025-01-01+json: + schema: + $ref: "#/components/schemas/OrgUserUpdateRequest" + description: Represents the roles and teams to assign the MongoDB Cloud user. + required: true + responses: + "200": + content: + application/vnd.atlas.2025-01-01+json: + schema: + $ref: "#/components/schemas/OrgUserResponse" + x-xgen-version: 2025-01-01 + description: OK + "400": + $ref: "#/components/responses/badRequest" + "401": + $ref: "#/components/responses/unauthorized" + "403": + $ref: "#/components/responses/forbidden" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Update One MongoDB Cloud User in One Organization + tags: + - MongoDB Cloud Users /api/atlas/v2/orgs/{orgId}/users/{userId}/roles: put: description: "Updates the roles of the specified user in the specified organization.\ @@ -18686,6 +19863,128 @@ paths: summary: Update Organization Roles for One MongoDB Cloud User tags: - Organizations + /api/atlas/v2/orgs/{orgId}/users/{userId}:addRole: + post: + description: |- + Adds one organization level role to the MongoDB Cloud user. You can add a role to an active user or a user that has not yet accepted the invitation to join the organization. To use this resource, the requesting API Key must have the Organization Owner role. + + **Note**: This operation is atomic. + + **Note**: This resource cannot be used to add a role to users invited using the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint. + operationId: addOrganizationRole + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/orgId" + - $ref: "#/components/parameters/pretty" + - description: "Unique 24-hexadecimal digit string that identifies the pending\ + \ or active user in the organization. If you need to lookup a user's userId\ + \ or verify a user's status in the organization, use the Return All MongoDB\ + \ Cloud Users in One Organization resource and filter by username." + in: path + name: userId + required: true + schema: + type: string + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + - description: Organization level role to assign to the MongoDB Cloud user. + in: query + name: role + required: true + schema: + type: string + enum: + - ORG_OWNER + - ORG_GROUP_CREATOR + - ORG_BILLING_ADMIN + - ORG_BILLING_READ_ONLY + - ORG_READ_ONLY + - ORG_MEMBER + responses: + "200": + content: + application/vnd.atlas.2025-01-01+json: + schema: + $ref: "#/components/schemas/OrgUserResponse" + x-xgen-version: 2025-01-01 + description: OK + "400": + $ref: "#/components/responses/badRequest" + "401": + $ref: "#/components/responses/unauthorized" + "403": + $ref: "#/components/responses/forbidden" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Add One Organization Role to One MongoDB Cloud User + tags: + - MongoDB Cloud Users + /api/atlas/v2/orgs/{orgId}/users/{userId}:removeRole: + post: + description: |- + Removes one organization level role from the MongoDB Cloud user. You can remove a role from an active user or a user that has not yet accepted the invitation to join the organization. To replace a user's only role, add the new role before removing the old role. A user must have at least one role at all times. To use this resource, the requesting API Key must have the Organization Owner role. + + **Note**: This operation is atomic. + + **Note**: This resource cannot be used to remove a role from users invited using the deprecated [Invite One MongoDB Cloud User to Join One Project](#tag/Projects/operation/createProjectInvitation) endpoint. + operationId: removeOrganizationRole + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/orgId" + - $ref: "#/components/parameters/pretty" + - description: "Unique 24-hexadecimal digit string that identifies the pending\ + \ or active user in the organization. If you need to lookup a user's userId\ + \ or verify a user's status in the organization, use the Return All MongoDB\ + \ Cloud Users in One Organization resource and filter by username." + in: path + name: userId + required: true + schema: + type: string + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + - description: Organization level role to remove from the MongoDB Cloud user. + in: query + name: role + required: true + schema: + type: string + enum: + - ORG_OWNER + - ORG_GROUP_CREATOR + - ORG_BILLING_ADMIN + - ORG_BILLING_READ_ONLY + - ORG_READ_ONLY + - ORG_MEMBER + responses: + "200": + content: + application/vnd.atlas.2025-01-01+json: + schema: + $ref: "#/components/schemas/OrgUserResponse" + x-xgen-version: 2025-01-01 + description: OK + "400": + $ref: "#/components/responses/badRequest" + "401": + $ref: "#/components/responses/unauthorized" + "403": + $ref: "#/components/responses/forbidden" + "404": + $ref: "#/components/responses/notFound" + "500": + $ref: "#/components/responses/internalServerError" + security: + - DigestAuth: [] + summary: Remove One Organization Role from One MongoDB Cloud User + tags: + - MongoDB Cloud Users /api/atlas/v2/unauth/controlPlaneIPAddresses: get: description: "Returns all control plane IP addresses. Currently, inbound Atlas\ @@ -18708,6 +20007,43 @@ paths: summary: Return All Control Plane IP Addresses tags: - Root + /api/atlas/v2/unauth/openapi/versions: + get: + description: API that provides a list of available versionsfor a given environment. + operationId: getApiVersions + parameters: + - $ref: "#/components/parameters/envelope" + - $ref: "#/components/parameters/itemsPerPage" + - $ref: "#/components/parameters/pageNum" + - $ref: "#/components/parameters/pretty" + - description: "The environment to get the versions from. If not provided, it\ + \ returnsthe versions for the given MongoDB URL. (E.g. prod for cloud.mongodb.com)" + in: query + name: env + schema: + type: string + enum: + - dev + - qa + - prod + - stage + responses: + "200": + content: + application/vnd.atlas.2024-08-05+json: + schema: + $ref: "#/components/schemas/PaginatedApiVersions" + x-xgen-version: 2024-08-05 + application/vnd.atlas.2024-08-05+yaml: + schema: + $ref: "#/components/schemas/PaginatedApiVersions" + x-xgen-version: 2024-08-05 + description: OK + "500": + $ref: "#/components/responses/internalServerError" + summary: Provides a list of versions for a given environment. + tags: + - OpenAPI /api/atlas/v2/users: post: description: |- @@ -19463,7 +20799,7 @@ components: description: |- Target IOPS (Input/Output Operations Per Second) desired for storage attached to this hardware. - Change this parameter only if you: + 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). @@ -19539,7 +20875,7 @@ components: You can set different IOPS values on different shards when provisioned IOPS are supported. - Change this parameter only if you: + 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). @@ -19970,6 +21306,31 @@ components: - REPLICASET - SHARDED - GEOSHARDED + configServerManagementMode: + type: string + default: ATLAS_MANAGED + description: |- + Config Server Management Mode for creating or updating a sharded cluster. + + When configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings. + + When configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server. + enum: + - ATLAS_MANAGED + - FIXED_TO_DEDICATED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + configServerType: + type: string + description: Describes a sharded cluster's config server type. + enum: + - DEDICATED + - EMBEDDED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + readOnly: true connectionStrings: $ref: "#/components/schemas/ClusterConnectionStrings" createDate: @@ -20017,6 +21378,15 @@ components: externalDocs: description: Encryption at Rest using Customer Key Management url: https://www.mongodb.com/docs/atlas/security-kms-encryption/ + featureCompatibilityVersion: + type: string + description: Feature compatibility version of the cluster. + readOnly: true + featureCompatibilityVersionExpirationDate: + type: string + format: date-time + description: Feature compatibility version expiration date. + readOnly: true globalClusterSelfManagedSharding: type: boolean description: |- @@ -20067,6 +21437,8 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true + mongoDBEmployeeAccessGrant: + $ref: "#/components/schemas/EmployeeAccessGrantView" mongoDBMajorVersion: type: string description: |- @@ -20088,7 +21460,7 @@ components: description: Human-readable label that identifies the advanced cluster. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" paused: type: boolean description: Flag that indicates whether the cluster is paused. @@ -20099,6 +21471,24 @@ components: externalDocs: description: Continuous Cloud Backups url: https://docs.atlas.mongodb.com/backup/cloud-backup/overview/ + replicaSetScalingStrategy: + type: string + default: WORKLOAD_TYPE + description: |- + Set this field to configure the replica set scaling mode for your cluster. + + By default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes. + + When configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads. + + When configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads. + enum: + - SEQUENTIAL + - WORKLOAD_TYPE + - NODE_TYPE + externalDocs: + description: Modify the Replica Set Scaling Mode + url: https://dochub.mongodb.org/core/scale-nodes replicationSpecs: type: array description: "List of settings that configure your cluster regions. For\ @@ -20977,6 +22367,246 @@ components: description: Atlas Search Index url: https://dochub.mongodb.org/core/index-definitions-fts title: mappings + ApiAtlasInvalidPolicyErrorDetailView: + type: object + properties: + detail: + type: string + description: A string that provides a detailed description of a validation + error. + readOnly: true + ApiAtlasInvalidPolicyView: + type: object + properties: + body: + type: string + description: A string that defines the permissions for the policy. The syntax + used is the Cedar Policy language. + example: |2 + forbid ( + principal, + action == cloud::Action::"cluster.createEdit", + resource + ) when { + context.cluster.regions.contains(cloud::region::"aws:us-east-1") + }; + readOnly: true + errors: + type: array + description: List of validation errors. + items: + $ref: "#/components/schemas/ApiAtlasInvalidPolicyErrorDetailView" + readOnly: true + ApiAtlasInvalidResourcePolicyCreateErrorView: + type: object + properties: + errorType: + type: string + description: Human-readable label that displays the type of an error. + enum: + - POLICY_PARSING_ERROR + - POLICY_HAS_FAILED_VALIDATIONS + - POLICY_HAS_INVALID_PRINCIPAL + - POLICY_HAS_BODY_EXCEEDING_MAX_SIZE + - POLICY_HAS_UNEXPECTED_ENTITIES + invalidPolicies: + type: array + description: List of invalid policies containing details of their validation + errors. + items: + $ref: "#/components/schemas/ApiAtlasInvalidPolicyView" + readOnly: true + ApiAtlasNonCompliantResourceView: + type: object + properties: + orgId: + type: string + description: Unique 24-hexadecimal character string that identifies the + organization the resource belongs to. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + resourceId: + type: string + description: Unique 24-hexadecimal character string that identifies the + non-compliant resource. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + resourcePoliciesCausingNonCompliance: + type: array + description: List of resource policies causing the resource to be considered + non-compliant. + items: + $ref: "#/components/schemas/ApiAtlasResourcePolicyMetadataView" + readOnly: true + resourceType: + type: string + description: Human-readable label that displays the type of a resource. + enum: + - PROJECT + - CLUSTER + readOnly: true + ApiAtlasPolicyCreateView: + type: object + properties: + body: + type: string + description: A string that defines the permissions for the policy. The syntax + used is the Cedar Policy language. + example: |2 + forbid ( + principal, + action == cloud::Action::"cluster.createEdit", + resource + ) when { + context.cluster.regions.contains(cloud::region::"aws:us-east-1") + }; + required: + - body + ApiAtlasPolicyMetadataView: + type: object + properties: + policyId: + type: string + description: Unique 24-hexadecimal character string that identifies the + policy. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + ApiAtlasPolicyView: + type: object + properties: + body: + type: string + description: A string that defines the permissions for the policy. The syntax + used is the Cedar Policy language. + example: |2 + forbid ( + principal, + action == cloud::Action::"cluster.createEdit", + resource + ) when { + context.cluster.regions.contains(cloud::region::"aws:us-east-1") + }; + readOnly: true + id: + type: string + description: Unique 24-hexadecimal character string that identifies the + policy. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + ApiAtlasResourcePolicyCreateView: + type: object + properties: + name: + type: string + description: Human-readable label that describes the atlas resource policy. + policies: + type: array + description: List of policies that make up the atlas resource policy. + items: + $ref: "#/components/schemas/ApiAtlasPolicyCreateView" + required: + - name + - policies + ApiAtlasResourcePolicyEditView: + type: object + properties: + name: + type: string + description: Human-readable label that describes the atlas resource policy. + policies: + type: array + description: List of policies that make up the atlas resource policy. + items: + $ref: "#/components/schemas/ApiAtlasPolicyCreateView" + ApiAtlasResourcePolicyMetadataView: + type: object + properties: + policiesCausingNonCompliance: + type: array + description: List of policies that are in conflict with the current state + of the resource. + items: + $ref: "#/components/schemas/ApiAtlasPolicyMetadataView" + readOnly: true + resourcePolicyId: + type: string + description: Unique 24-hexadecimal character string that identifies the + atlas resource policy. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + resourcePolicyName: + type: string + description: Human-readable label that describes the atlas resource policy. + readOnly: true + ApiAtlasResourcePolicyView: + type: object + properties: + createdByUser: + $ref: "#/components/schemas/ApiAtlasUserMetadataView" + createdDate: + type: string + format: date-time + description: Date and time in UTC when the atlas resource policy was created. + example: 2022-01-01T00:00:00Z + readOnly: true + id: + type: string + description: Unique 24-hexadecimal character string that identifies the + atlas resource policy. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + lastUpdatedByUser: + $ref: "#/components/schemas/ApiAtlasUserMetadataView" + lastUpdatedDate: + type: string + format: date-time + description: Date and time in UTC when the atlas resource policy was last + updated. + example: 2022-01-01T00:00:00Z + readOnly: true + name: + type: string + description: Human-readable label that describes the atlas resource policy. + readOnly: true + orgId: + type: string + description: Unique 24-hexadecimal character string that identifies the + organization the atlas resource policy belongs to. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + policies: + type: array + description: List of policies that make up the atlas resource policy. + items: + $ref: "#/components/schemas/ApiAtlasPolicyView" + readOnly: true + version: + type: string + description: A string that identifies the version of the atlas resource + policy. + example: v1 + readOnly: true ApiAtlasSnapshotScheduleView: type: object properties: @@ -21113,6 +22743,23 @@ components: - snapshotIntervalHours - snapshotRetentionDays - weeklySnapshotRetentionWeeks + ApiAtlasUserMetadataView: + type: object + description: The user that last updated the atlas resource policy. + properties: + id: + type: string + description: Unique 24-hexadecimal character string that identifies a user. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + name: + type: string + description: Human-readable label that describes a user. + readOnly: true + readOnly: true ApiBSONTimestampView: type: object description: BSON timestamp that indicates when the checkpoint token entry in @@ -21169,6 +22816,8 @@ components: ApiError: type: object properties: + badRequestDetail: + $ref: "#/components/schemas/BadRequestDetail" detail: type: string description: Describes the specific conditions or reasons that cause each @@ -21179,17 +22828,25 @@ components: description: HTTP status code returned with this error. externalDocs: url: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status + readOnly: true 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. items: type: object + readOnly: true + readOnly: true reason: type: string description: Application error message returned with this error. + readOnly: true + required: + - error + - errorCode ApiHostView_Atlas: type: object properties: @@ -21478,6 +23135,23 @@ components: \ and **period** in the same request. This parameter expresses its value\ \ in the ISO 8601 timestamp format in UTC." readOnly: true + ApiPrivateDownloadDeliveryUrl: + type: object + description: One Uniform Resource Locator (URL) that points to the compressed + snapshot files for manual download and the corresponding private endpoint. + properties: + deliveryUrl: + type: string + description: One Uniform Resource Locator that points to the compressed + snapshot files for manual download. + endpointId: + type: string + description: Unique 22-character alphanumeric string that identifies the + private endpoint. + example: vpce-3bf78b0ddee411ba1 + maxLength: 22 + minLength: 22 + pattern: "^vpce-[0-9a-f]{17}$" ApiPublicUsageDetailsQueryRequest: type: object description: "Request body for an Invoice Usage Details query with filtering,\ @@ -21589,7 +23263,23 @@ components: type: string description: Atlas Streams AWS Regions. enum: + - SYDNEY_AUS + - MUMBAI_IND + - FRANKFURT_DEU + - DUBLIN_IRL + - LONDON_GBR + - VIRGINIA_USA + - OREGON_USA + - SAOPAULO_BRA + - MONTREAL_CAN + - TOKYO_JPN + - SINGAPORE_SGP + ApiStreamsAzureRegionView: + type: string + description: Atlas Streams Azure Regions. + enum: - VIRGINIA_USA + - AMSTERDAM_NLD ApiUserEventTypeViewForNdsGroup: type: string description: Unique identifier of event type. @@ -21836,6 +23526,12 @@ components: - eventTypeName - id title: API User Events + ApiVersion: + type: object + properties: + version: + type: string + description: Object representing a version of the Atlas Admin API. AppServiceAlertConfigViewForNdsGroup: type: object description: App Services metric alert configuration allows to select which @@ -22317,7 +24013,12 @@ components: enum: - AVERAGE operator: - $ref: "#/components/schemas/Operator" + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - LESS_THAN + - GREATER_THAN threshold: type: number format: double @@ -22395,6 +24096,12 @@ components: enum: - VIRGINIA_USA - AMSTERDAM_NLD + AtlasDataFederationGCPRegion: + type: string + description: Atlas Data Federation GCP Regions. + enum: + - IOWA_USA + - BELGIUM_EU AtlasOrganization: type: object description: Details that describe the organization. @@ -22430,6 +24137,128 @@ components: pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" required: - name + AtlasResourcePolicyAuditForOrg: + type: object + description: Atlas resource policy audits indicate org level changes to resource + policies + properties: + apiKeyId: + type: string + description: "Unique 24-hexadecimal digit string that identifies the [API\ + \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\ + \ triggered the event. If this resource returns this parameter, it doesn't\ + \ return the **userId** parameter." + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + created: + type: string + format: date-time + description: Date and time when this event occurred. This parameter expresses + its value in the ISO 8601 timestamp format in UTC. + readOnly: true + eventTypeName: + type: string + description: Unique identifier of event type. + enum: + - RESOURCE_POLICY_CREATED + - RESOURCE_POLICY_MODIFIED + - RESOURCE_POLICY_DELETED + example: RESOURCE_POLICY_CREATED + title: Atlas Resource Policy Audit Types + groupId: + type: string + description: Unique 24-hexadecimal digit string that identifies the project + in which the event occurred. The **eventId** identifies the specific event. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + id: + type: string + description: Unique 24-hexadecimal digit string that identifies the event. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + isGlobalAdmin: + type: boolean + default: false + description: Flag that indicates whether a MongoDB employee triggered the + specified event. + readOnly: true + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + orgId: + type: string + description: Unique 24-hexadecimal digit string that identifies the organization + to which these events apply. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + publicKey: + type: string + format: email + description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\ + \ that triggered the event. If this resource returns this parameter, it\ + \ doesn't return the **username** parameter." + readOnly: true + raw: + $ref: "#/components/schemas/raw" + remoteAddress: + type: string + description: IPv4 or IPv6 address from which the user triggered this event. + example: 216.172.40.186 + pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + readOnly: true + resourcePolicyId: + type: string + description: Unique 24-hexadecimal character string that identifies the + resource policy. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + userId: + type: string + description: "Unique 24-hexadecimal digit string that identifies the console\ + \ user who triggered the event. If this resource returns this parameter,\ + \ it doesn't return the **apiKeyId** parameter." + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + username: + type: string + format: email + description: "Email address for the user who triggered this event. If this\ + \ resource returns this parameter, it doesn't return the **publicApiKey**\ + \ parameter." + example: test.user@mongodb.com + readOnly: true + required: + - created + - eventTypeName + - id + title: Atlas Resource Policy Audits AtlasSearchAnalyzer: type: object properties: @@ -23151,6 +24980,21 @@ components: AzureHardwareSpec: type: object properties: + diskIOPS: + type: integer + format: int32 + description: |- + Target throughput desired for storage attached to your Azure-provisioned cluster. Change this parameter if you: + + - set `"replicationSpecs[n].regionConfigs[m].providerName" : "Azure"`. + - set `"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize" : "M40"` or greater not including `Mxx_NVME` tiers. + + The maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**. + This parameter defaults to the cluster tier's standard IOPS value. + Changing this value impacts cluster cost. + externalDocs: + description: Programmatic API Keys + url: https://www.mongodb.com/docs/atlas/customize-storage/#extend-iops-on-azure instanceSize: type: string description: Hardware specification for the instance sizes in this region. @@ -23188,6 +25032,21 @@ components: AzureHardwareSpec20240805: type: object properties: + diskIOPS: + type: integer + format: int32 + description: |- + Target throughput desired for storage attached to your Azure-provisioned cluster. Change this parameter if you: + + - set `"replicationSpecs[n].regionConfigs[m].providerName" : "Azure"`. + - set `"replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize" : "M40"` or greater not including `Mxx_NVME` tiers. + + The maximum input/output operations per second (IOPS) depend on the selected **.instanceSize** and **.diskSizeGB**. + This parameter defaults to the cluster tier's standard IOPS value. + Changing this value impacts cluster cost. + externalDocs: + description: Programmatic API Keys + url: https://www.mongodb.com/docs/atlas/customize-storage/#extend-iops-on-azure diskSizeGB: type: number format: double @@ -23403,6 +25262,8 @@ components: - PENDING_ACCEPTANCE - ACTIVE - FAILED + - PENDING_RECREATION + - DELETING readOnly: true title: Azure Key Vault EAR Private Endpoint AzureNetworkPeeringConnectionSettings: @@ -23837,7 +25698,7 @@ components: the collection for which you want to create an online archive. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true collName: type: string @@ -23949,7 +25810,7 @@ components: the collection for which you want to create an online archive. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true collName: type: string @@ -24088,7 +25949,7 @@ components: the snapshots you want to retrieve. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -24301,7 +26162,7 @@ components: To return a response with the **clusterId** parameter, either use the **delivery.targetClusterName** parameter or enable backup on the target cluster. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" targetGroupId: type: string description: "Unique 24-hexadecimal digit string that identifies the project\ @@ -24573,12 +26434,23 @@ components: - FAILED - COMPLETED readOnly: true + BadRequestDetail: + type: object + description: Bad request detail. + properties: + fields: + type: array + description: Describes all violations in a client request. + items: + $ref: "#/components/schemas/FieldViolation" + readOnly: true BaseAtlasDataLakeRegion: type: object description: Name of the region to which the data lake routes client connections. oneOf: - $ref: "#/components/schemas/ApiAtlasDataLakeAWSRegionView" - $ref: "#/components/schemas/AtlasDataFederationAzureRegion" + - $ref: "#/components/schemas/AtlasDataFederationGCPRegion" BaseCloudProviderInstanceSize: type: object description: "Minimum instance size to which your cluster can automatically\ @@ -24706,6 +26578,7 @@ components: description: Name of the cloud provider region hosting Atlas Stream Processing. oneOf: - $ref: "#/components/schemas/ApiStreamsAWSRegionView" + - $ref: "#/components/schemas/ApiStreamsAzureRegionView" BasicBSONList: type: array description: "List that contains the search criteria that the query uses. To\ @@ -25793,7 +27666,7 @@ components: description: Human-readable label that identifies the cluster. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true nodeCount: type: integer @@ -25854,6 +27727,10 @@ components: 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. + description: + type: string + description: Description of this database user. + maxLength: 100 groupId: type: string description: Unique 24-hexadecimal digit string that identifies the project. @@ -26121,6 +27998,127 @@ components: (AWS) Identity and Access Management (IAM) role. required: - providerName + CloudProviderAccessAWSIAMRoleRequest: + type: object + description: Details that describe the features linked to the Amazon Web Services + (AWS) Identity and Access Management (IAM) role. + properties: + atlasAWSAccountArn: + 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. + example: arn:aws:iam::772401394250:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + readOnly: true + atlasAssumedRoleExternalId: + type: string + format: uuid + description: Unique external ID that MongoDB Cloud uses when it assumes + the IAM role in your Amazon Web Services (AWS) account. + readOnly: true + authorizedDate: + type: string + format: date-time + 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. + readOnly: true + createdDate: + type: string + format: date-time + 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. + readOnly: true + featureUsages: + type: array + description: List that contains application features associated with this + Amazon Web Services (AWS) Identity and Access Management (IAM) role. + items: + $ref: "#/components/schemas/CloudProviderAccessFeatureUsage" + readOnly: true + providerName: + type: string + description: Human-readable label that identifies the cloud provider of + the role. + enum: + - AWS + - AZURE + - GCP + roleId: + type: string + description: Unique 24-hexadecimal digit string that identifies the role. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + required: + - providerName + CloudProviderAccessAWSIAMRoleRequestUpdate: + type: object + allOf: + - $ref: "#/components/schemas/CloudProviderAccessRoleRequestUpdate" + - type: object + properties: + atlasAWSAccountArn: + 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. + example: arn:aws:iam::772401394250:role/my-test-aws-role + maxLength: 2048 + minLength: 20 + readOnly: true + atlasAssumedRoleExternalId: + type: string + format: uuid + description: Unique external ID that MongoDB Cloud uses when it assumes + the IAM role in your Amazon Web Services (AWS) account. + readOnly: true + authorizedDate: + type: string + format: date-time + 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. + readOnly: true + createdDate: + type: string + format: date-time + 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. + readOnly: true + featureUsages: + type: array + description: List that contains application features associated with this + Amazon Web Services (AWS) Identity and Access Management (IAM) role. + items: + $ref: "#/components/schemas/CloudProviderAccessFeatureUsage" + readOnly: true + iamAssumedRoleArn: + 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 + maxLength: 2048 + minLength: 20 + roleId: + type: string + description: Unique 24-hexadecimal digit string that identifies the role. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + description: Details that describe the features linked to the Amazon Web Services + (AWS) Identity and Access Management (IAM) role. + required: + - providerName CloudProviderAccessAzureServicePrincipal: type: object allOf: @@ -26182,6 +28180,133 @@ components: Principal. required: - providerName + CloudProviderAccessAzureServicePrincipalRequest: + type: object + description: Details that describe the features linked to the Azure Service + Principal. + properties: + _id: + type: string + description: Unique 24-hexadecimal digit string that identifies the role. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + atlasAzureAppId: + type: string + description: Azure Active Directory Application ID of Atlas. + maxLength: 36 + minLength: 32 + pattern: "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\\ + b-[0-9a-fA-F]{12}$" + createdDate: + type: string + format: date-time + description: Date and time when this Azure Service Principal was created. + This parameter expresses its value in the ISO 8601 timestamp format in + UTC. + readOnly: true + featureUsages: + type: array + description: List that contains application features associated with this + Azure Service Principal. + items: + $ref: "#/components/schemas/CloudProviderAccessFeatureUsage" + readOnly: true + lastUpdatedDate: + type: string + format: date-time + 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. + 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. + maxLength: 36 + minLength: 32 + pattern: "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\\ + b-[0-9a-fA-F]{12}$" + tenantId: + type: string + description: UUID String that identifies the Azure Active Directory Tenant + ID. + maxLength: 36 + minLength: 32 + pattern: "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\\ + b-[0-9a-fA-F]{12}$" + required: + - providerName + CloudProviderAccessAzureServicePrincipalRequestUpdate: + type: object + allOf: + - $ref: "#/components/schemas/CloudProviderAccessRoleRequestUpdate" + - type: object + properties: + _id: + type: string + description: Unique 24-hexadecimal digit string that identifies the role. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + atlasAzureAppId: + type: string + description: Azure Active Directory Application ID of Atlas. + maxLength: 36 + minLength: 32 + pattern: "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\\ + b-[0-9a-fA-F]{12}$" + createdDate: + type: string + format: date-time + description: Date and time when this Azure Service Principal was created. + This parameter expresses its value in the ISO 8601 timestamp format + in UTC. + readOnly: true + featureUsages: + type: array + description: List that contains application features associated with this + Azure Service Principal. + items: + $ref: "#/components/schemas/CloudProviderAccessFeatureUsage" + readOnly: true + lastUpdatedDate: + type: string + format: date-time + 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. + readOnly: true + servicePrincipalId: + type: string + description: UUID string that identifies the Azure Service Principal. + maxLength: 36 + minLength: 32 + pattern: "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\\ + b-[0-9a-fA-F]{12}$" + tenantId: + type: string + description: UUID String that identifies the Azure Active Directory Tenant + ID. + maxLength: 36 + minLength: 32 + pattern: "^[0-9a-fA-F]{8}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\b-[0-9a-fA-F]{4}\\\ + b-[0-9a-fA-F]{12}$" + description: Details that describe the features linked to the Azure Service + Principal. + required: + - providerName CloudProviderAccessDataLakeFeatureUsage: type: object allOf: @@ -26294,6 +28419,85 @@ components: minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true + CloudProviderAccessGCPServiceAccount: + type: object + allOf: + - $ref: "#/components/schemas/CloudProviderAccessRole" + - type: object + properties: + createdDate: + type: string + format: date-time + description: Date and time when this Google Service Account was created. + This parameter expresses its value in the ISO 8601 timestamp format + in UTC. + readOnly: true + featureUsages: + type: array + description: List that contains application features associated with this + Google Service Account. + items: + $ref: "#/components/schemas/CloudProviderAccessFeatureUsage" + readOnly: true + gcpServiceAccountForAtlas: + type: string + description: Email address for the Google Service Account created by Atlas. + maxLength: 82 + minLength: 57 + pattern: "^mongodb-atlas-[0-9a-z]{16}@p-[0-9a-z]{24}.iam.gserviceaccount.com$" + roleId: + type: string + description: Unique 24-hexadecimal digit string that identifies the role. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + description: Details that describe the features linked to the GCP Service Account. + required: + - providerName + CloudProviderAccessGCPServiceAccountRequest: + type: object + description: Details that describe the features linked to the GCP Service Account. + properties: + createdDate: + type: string + format: date-time + description: Date and time when this GCP Service Account was created. This + parameter expresses its value in the ISO 8601 timestamp format in UTC. + readOnly: true + featureUsages: + type: array + description: List that contains application features associated with this + GCP Service Account. + items: + $ref: "#/components/schemas/CloudProviderAccessFeatureUsage" + readOnly: true + 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: + type: string + description: Unique 24-hexadecimal digit string that identifies the role. + readOnly: true + required: + - providerName + CloudProviderAccessGCPServiceAccountRequestUpdate: + type: object + allOf: + - $ref: "#/components/schemas/CloudProviderAccessRoleRequestUpdate" + description: Details that describe the features linked to the GCP Service Account. + required: + - providerName CloudProviderAccessPushBasedLogExportFeatureUsage: type: object allOf: @@ -26312,10 +28516,52 @@ components: mapping: AWS: "#/components/schemas/CloudProviderAccessAWSIAMRole" AZURE: "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + GCP: "#/components/schemas/CloudProviderAccessGCPServiceAccount" + propertyName: providerName + properties: + providerName: + type: string + description: Human-readable label that identifies the cloud provider of + the role. + enum: + - AWS + - AZURE + - GCP + required: + - providerName + CloudProviderAccessRoleRequest: + type: object + description: Cloud provider access role. + discriminator: + mapping: + AWS: "#/components/schemas/CloudProviderAccessAWSIAMRoleRequest" + AZURE: "#/components/schemas/CloudProviderAccessAzureServicePrincipalRequest" + GCP: "#/components/schemas/CloudProviderAccessGCPServiceAccountRequest" propertyName: providerName oneOf: - - $ref: "#/components/schemas/CloudProviderAccessAWSIAMRole" - - $ref: "#/components/schemas/CloudProviderAccessAzureServicePrincipal" + - $ref: "#/components/schemas/CloudProviderAccessAWSIAMRoleRequest" + - $ref: "#/components/schemas/CloudProviderAccessAzureServicePrincipalRequest" + - $ref: "#/components/schemas/CloudProviderAccessGCPServiceAccountRequest" + properties: + providerName: + type: string + description: Human-readable label that identifies the cloud provider of + the role. + enum: + - AWS + - AZURE + - GCP + required: + - providerName + CloudProviderAccessRoleRequestUpdate: + type: object + description: Cloud provider access role. + discriminator: + mapping: + AWS: "#/components/schemas/CloudProviderAccessAWSIAMRoleRequestUpdate" + AZURE: "#/components/schemas/CloudProviderAccessAzureServicePrincipalRequestUpdate" + GCP: "#/components/schemas/CloudProviderAccessGCPServiceAccountRequestUpdate" + propertyName: providerName properties: providerName: type: string @@ -26324,6 +28570,7 @@ components: enum: - AWS - AZURE + - GCP required: - providerName CloudProviderAccessRoles: @@ -26335,6 +28582,12 @@ components: registered and authorized with MongoDB Cloud. items: $ref: "#/components/schemas/CloudProviderAccessAWSIAMRole" + azureServicePrincipals: + type: array + description: List that contains the Azure Service Principals registered + with MongoDB Cloud. + items: + $ref: "#/components/schemas/CloudProviderAccessAzureServicePrincipal" CloudProviderAzureAutoScaling: type: object description: Range of instance sizes to which your cluster can scale. @@ -27003,7 +29256,7 @@ components: example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -27107,6 +29360,7 @@ components: $ref: "#/components/schemas/ClusterComputeAutoScaling" diskGBEnabled: type: boolean + default: false description: Flag that indicates whether someone enabled disk auto-scaling for this cluster. title: Automatic Cluster Scaling Settings @@ -27133,12 +29387,14 @@ components: properties: enabled: type: boolean + default: false description: "Flag that indicates whether cluster tier auto-scaling is enabled.\ \ Set to `true` to enable cluster tier auto-scaling. If enabled, you must\ \ specify a value for **providerSettings.autoScaling.compute.maxInstanceSize**\ \ also. Set to `false` to disable cluster tier auto-scaling." scaleDownEnabled: type: boolean + default: false description: "Flag that indicates whether the cluster tier can scale down.\ \ This is required if **autoScaling.compute.enabled** is `true`. If you\ \ enable this option, specify a value for **providerSettings.autoScaling.compute.minInstanceSize**." @@ -27176,20 +29432,28 @@ components: 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. + description: "Private endpoint-aware connection strings that use AWS-hosted\ + \ clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies\ + \ an Amazon Web Services (AWS) interface endpoint. Each value identifies\ + \ the related `mongodb://` connection string that you use to connect\ + \ to Atlas through the interface endpoint that the key names. If the\ + \ cluster uses an optimized connection string, `awsPrivateLinkSrv` contains\ + \ the optimized connection string. If the cluster has the non-optimized\ + \ (legacy) connection string, `awsPrivateLinkSrv` contains the non-optimized\ + \ connection string even if an optimized connection string is also present." externalDocs: description: Network Peering Connection url: https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/ readOnly: true - 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. + description: "Private endpoint-aware connection strings that use AWS-hosted\ + \ clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies\ + \ an Amazon Web Services (AWS) interface endpoint. Each value identifies\ + \ the related `mongodb://` connection string that you use to connect to\ + \ Atlas through the interface endpoint that the key names. If the cluster\ + \ uses an optimized connection string, `awsPrivateLinkSrv` contains the\ + \ optimized connection string. If the cluster has the non-optimized (legacy)\ + \ connection string, `awsPrivateLinkSrv` contains the non-optimized connection\ + \ string even if an optimized connection string is also present." externalDocs: description: Network Peering Connection url: https://docs.atlas.mongodb.com/security-vpc-peering/#std-label-vpc-peering/ @@ -27291,6 +29555,31 @@ components: - REPLICASET - SHARDED - GEOSHARDED + configServerManagementMode: + type: string + default: ATLAS_MANAGED + description: |- + Config Server Management Mode for creating or updating a sharded cluster. + + When configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings. + + When configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server. + enum: + - ATLAS_MANAGED + - FIXED_TO_DEDICATED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + configServerType: + type: string + description: Describes a sharded cluster's config server type. + enum: + - DEDICATED + - EMBEDDED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + readOnly: true connectionStrings: $ref: "#/components/schemas/ClusterConnectionStrings" createDate: @@ -27324,6 +29613,15 @@ components: externalDocs: description: Encryption at Rest using Customer Key Management url: https://www.mongodb.com/docs/atlas/security-kms-encryption/ + featureCompatibilityVersion: + type: string + description: Feature compatibility version of the cluster. + readOnly: true + featureCompatibilityVersionExpirationDate: + type: string + format: date-time + description: Feature compatibility version expiration date. + readOnly: true globalClusterSelfManagedSharding: type: boolean description: |- @@ -27374,6 +29672,8 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true + mongoDBEmployeeAccessGrant: + $ref: "#/components/schemas/EmployeeAccessGrantView" mongoDBMajorVersion: type: string description: |- @@ -27395,7 +29695,7 @@ components: description: Human-readable label that identifies the cluster. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" paused: type: boolean description: Flag that indicates whether the cluster is paused. @@ -27406,6 +29706,35 @@ components: externalDocs: description: Continuous Cloud Backups url: https://docs.atlas.mongodb.com/backup/cloud-backup/overview/ + redactClientLogData: + type: boolean + description: Enable or disable log redaction. + externalDocs: + description: |- + This options corresponds to the ``security.redactClientLogData`` cluster parameter. + + This setting configures the ``mongod`` or ``mongos`` to redact any message accompanying a given log event before logging. This prevents the program from writing potentially sensitive data stored on the database to the diagnostic log. Metadata such as error or operation codes, line numbers, and source file names are still visible in the logs. + + Use ``redactClientLogData`` in conjunction with Encryption at Rest and TLS/SSL (Transport Encryption) to assist compliance with regulatory requirements. + url: https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.redactClientLogData + replicaSetScalingStrategy: + type: string + default: WORKLOAD_TYPE + description: |- + Set this field to configure the replica set scaling mode for your cluster. + + By default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes. + + When configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads. + + When configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads. + enum: + - SEQUENTIAL + - WORKLOAD_TYPE + - NODE_TYPE + externalDocs: + description: Modify the Replica Set Scaling Mode + url: https://dochub.mongodb.org/core/scale-nodes replicationSpecs: type: array description: List of settings that configure your cluster regions. This @@ -27531,6 +29860,24 @@ components: ClusterDescriptionProcessArgs: type: object properties: + changeStreamOptionsPreAndPostImagesExpireAfterSeconds: + type: integer + format: int32 + default: -1 + description: The minimum pre- and post-image retention time in seconds. + externalDocs: + description: "This option corresponds to the ``changeStreamOptions.preAndPostImages.expireAfterSeconds``\ + \ cluster parameter. This setting controls the retention policy of change\ + \ stream pre- and post-images. Pre- and post-images are the versions\ + \ of a document before and after document modification, respectively.\ + \ ``expireAfterSeconds`` controls how long MongoDB retains pre- and\ + \ post-images. When set to -1 (off), MongoDB uses the default retention\ + \ policy: pre- and post-images are retained until the corresponding\ + \ change stream events are removed from the oplog. To set the minimum\ + \ pre- and post-image retention time, specify an integer value greater\ + \ than zero. Setting this too low could increase the risk of interrupting\ + \ Realm sync or triggers processing. The default value is -1 (off)." + url: https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/changeStreamOptions/#mongodb-parameter-param.changeStreamOptions.preAndPostImages.expireAfterSeconds chunkMigrationConcurrency: type: integer format: int32 @@ -27541,6 +29888,14 @@ components: description: This option corresponds to the `chunkMigrationConcurrency` `mongod` configuration file option. url: https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.chunkMigrationConcurrency + defaultMaxTimeMS: + type: integer + format: int32 + description: Default time limit in milliseconds for individual read operations + to complete. + externalDocs: + description: This option corresponds to the defaultMaxTimeMS cluster parameter. + url: https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/defaultMaxTimeMS/ defaultReadConcern: type: string default: available @@ -27577,8 +29932,10 @@ components: url: https://docs.mongodb.com/upcoming/reference/parameters/#mongodb-parameter-param.failIndexKeyTooLong javascriptEnabled: type: boolean - description: Flag that indicates whether the cluster allows execution of - operations that perform server-side executions of JavaScript. + 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. @@ -27671,6 +30028,24 @@ components: ClusterDescriptionProcessArgs20240805: type: object properties: + changeStreamOptionsPreAndPostImagesExpireAfterSeconds: + type: integer + format: int32 + default: -1 + description: The minimum pre- and post-image retention time in seconds. + externalDocs: + description: "This option corresponds to the ``changeStreamOptions.preAndPostImages.expireAfterSeconds``\ + \ cluster parameter. This setting controls the retention policy of change\ + \ stream pre- and post-images. Pre- and post-images are the versions\ + \ of a document before and after document modification, respectively.\ + \ ``expireAfterSeconds`` controls how long MongoDB retains pre- and\ + \ post-images. When set to -1 (off), MongoDB uses the default retention\ + \ policy: pre- and post-images are retained until the corresponding\ + \ change stream events are removed from the oplog. To set the minimum\ + \ pre- and post-image retention time, specify an integer value greater\ + \ than zero. Setting this too low could increase the risk of interrupting\ + \ Realm sync or triggers processing. The default value is -1 (off)." + url: https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/changeStreamOptions/#mongodb-parameter-param.changeStreamOptions.preAndPostImages.expireAfterSeconds chunkMigrationConcurrency: type: integer format: int32 @@ -27681,6 +30056,14 @@ components: description: This option corresponds to the `chunkMigrationConcurrency` `mongod` configuration file option. url: https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.chunkMigrationConcurrency + defaultMaxTimeMS: + type: integer + format: int32 + description: Default time limit in milliseconds for individual read operations + to complete. + externalDocs: + description: This option corresponds to the defaultMaxTimeMS cluster parameter. + url: https://www.mongodb.com/docs/upcoming/reference/cluster-parameters/defaultMaxTimeMS/ defaultWriteConcern: type: string description: Default level of acknowledgment requested from MongoDB for @@ -27691,8 +30074,10 @@ components: url: https://docs.mongodb.com/manual/reference/write-concern/ javascriptEnabled: type: boolean - description: Flag that indicates whether the cluster allows execution of - operations that perform server-side executions of JavaScript. + 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. @@ -27977,7 +30362,7 @@ components: outage simulation. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true groupId: type: string @@ -28792,6 +31177,7 @@ components: mapping: AWS: "#/components/schemas/AWSCreateDataProcessRegionView" AZURE: "#/components/schemas/AzureCreateDataProcessRegionView" + GCP: "#/components/schemas/GCPCreateDataProcessRegionView" propertyName: cloudProvider properties: cloudProvider: @@ -29274,11 +31660,11 @@ components: roleId: type: string description: Unique identifier of the role that Data Federation can use - to access the data stores.Required if specifying cloudProviderConfig. + to access the data stores. Required if specifying cloudProviderConfig. servicePrincipalId: type: string description: The ID of the Service Principal for which there is an access - policyfor Atlas to access Azure resources. + policy for Atlas to access Azure resources. readOnly: true tenantId: type: string @@ -29287,6 +31673,22 @@ components: readOnly: true required: - roleId + DataFederationGCPCloudProviderConfig: + type: object + description: Configuration for running Data Federation in GCP. + 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: + type: string + description: Unique identifier of the role that Data Federation can use + to access the data stores. Required if specifying cloudProviderConfig. + required: + - roleId DataFederationLimit: type: object description: Details of user managed limits. @@ -29294,6 +31696,7 @@ components: mapping: atlas.project.deployment.clusters: "#/components/schemas/DefaultLimit" atlas.project.deployment.nodesPerPrivateLinkRegion: "#/components/schemas/DefaultLimit" + atlas.project.deployment.salesSoldM0s: "#/components/schemas/DefaultLimit" atlas.project.deployment.serverlessMTMs: "#/components/schemas/DefaultLimit" atlas.project.security.databaseAccess.customRoles: "#/components/schemas/DefaultLimit" atlas.project.security.databaseAccess.users: "#/components/schemas/DefaultLimit" @@ -29664,7 +32067,9 @@ components: $ref: "#/components/schemas/DataLakeAWSCloudProviderConfig" azure: $ref: "#/components/schemas/DataFederationAzureCloudProviderConfig" - title: Data Lake Cloud Provider + gcp: + $ref: "#/components/schemas/DataFederationGCPCloudProviderConfig" + title: Data Federation Cloud Provider DataLakeDLSAWSStore: type: object allOf: @@ -29789,6 +32194,7 @@ components: enum: - AWS - AZURE + - GCP region: $ref: "#/components/schemas/BaseAtlasDataLakeRegion" required: @@ -30265,7 +32671,7 @@ components: example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -30524,7 +32930,12 @@ components: enum: - AVERAGE operator: - $ref: "#/components/schemas/Operator" + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - LESS_THAN + - GREATER_THAN threshold: type: number format: double @@ -30572,6 +32983,7 @@ components: mapping: AWS: "#/components/schemas/AWSDataProcessRegionView" AZURE: "#/components/schemas/AzureDataProcessRegionView" + GCP: "#/components/schemas/GCPDataProcessRegionView" propertyName: cloudProvider properties: cloudProvider: @@ -30581,6 +32993,7 @@ components: enum: - AWS - AZURE + - GCP readOnly: true readOnly: true DataProtectionSettings: @@ -30872,6 +33285,8 @@ components: - SQL_SET_SCHEMA - VIEW_ALL_HISTORY - OUT_TO_S3 + - OUT_TO_AZURE + - OUT_TO_GCS - STORAGE_GET_CONFIG - STORAGE_SET_CONFIG - FLUSH_ROUTER_CONFIG @@ -31231,6 +33646,7 @@ components: - FTS_INDEX_BUILD_COMPLETE - FTS_INDEX_BUILD_FAILED - FTS_INDEXES_RESTORE_FAILED + - FTS_INDEXES_SYNONYM_MAPPING_INVALID title: FTS Index Audit Types - type: string enum: @@ -31431,6 +33847,7 @@ components: - FTS_INDEX_BUILD_COMPLETE - FTS_INDEX_BUILD_FAILED - FTS_INDEXES_RESTORE_FAILED + - FTS_INDEXES_SYNONYM_MAPPING_INVALID title: FTS Index Audit Types - type: string enum: @@ -31886,11 +34303,14 @@ components: - CLUSTER_VERSION_UNFIXED - CLUSTER_FCV_FIXED - CLUSTER_FCV_UNFIXED + - CLUSTER_FCV_EXPIRATION_DATE_UPDATED - AGENT_VERSION_FIXED - AGENT_VERSION_UNFIXED - FIXED_VERSION_UPDATED - FIXED_AGENT_VERSION_UPDATED - CLUSTER_FCV_DOWNGRADED + - CLUSTER_BINARY_VERSION_DOWNGRADED + - CLUSTER_BINARY_VERSION_UPGRADED title: Version Audit Types groupId: type: string @@ -32278,7 +34698,6 @@ components: pattern: "^([a-f0-9]{24})$" hostnameSchemaType: type: string - default: PUBLIC description: The network type to use between the migration host and the destination cluster. enum: @@ -32479,30 +34898,19 @@ components: createdAt: type: string format: date-time - description: Date and time when someone created this export job. MongoDB - Cloud represents this timestamp in ISO 8601 format in UTC. + description: Date and time when a user or Atlas created the Export Job. + MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. readOnly: true customData: type: array description: Collection of key-value pairs that represent custom data for - the metadata file that MongoDB Cloud uploads to the bucket when the export - job finishes. + the metadata file that MongoDB Cloud uploads when the Export Job finishes. items: $ref: "#/components/schemas/BackupLabel" - 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\"`." - items: - type: string - description: One Uniform Resource Locator that point to the compressed - snapshot files for manual download. - readOnly: true exportBucketId: type: string description: Unique 24-hexadecimal character string that identifies the - Export Bucket to export to. + Export Bucket. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 @@ -32513,7 +34921,7 @@ components: finishedAt: type: string format: date-time - description: Date and time when this export job completed. MongoDB Cloud + description: Date and time when this Export Job completed. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. readOnly: true id: @@ -32538,8 +34946,8 @@ components: readOnly: true prefix: type: string - description: Full path on the cloud provider bucket to the folder where - the snapshot is exported. + description: Prefix used for all blob storage objects uploaded as part of + the Export Job. pattern: "/exported_snapshots/\\{ORG-NAME\\}/\\{PROJECT-NAME\\}/\\{CLUSTER-NAME\\\ }/\\{SNAPSHOT-INITIATION-DATE\\}/\\{TIMESTAMP\\}" readOnly: true @@ -32553,7 +34961,7 @@ components: pattern: "^([a-f0-9]{24})$" state: type: string - description: State of the export job. + description: State of the Export Job. enum: - Cancelled - Failed @@ -32576,7 +34984,7 @@ components: exportBucketId: type: string description: Unique 24-hexadecimal character string that identifies the - Export Bucket to export to. + Export Bucket. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 @@ -32783,10 +35191,19 @@ components: properties: downloadUrl: type: string - description: "One Uniform Resource Locator that point to the compressed\ + 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." + items: + $ref: "#/components/schemas/ApiPrivateDownloadDeliveryUrl" + readOnly: true replicaSetName: type: string description: Human-readable label that identifies the replica set on the @@ -33238,7 +35655,7 @@ components: \ this parameter when `\"deliveryType\" : \"download\"`." items: type: string - description: One Uniform Resource Locator that point to the compressed + description: One Uniform Resource Locator that points to the compressed snapshot files for manual download. readOnly: true desiredTimestamp: @@ -33310,6 +35727,15 @@ components: \ when `\"deliveryType\" : \"pointInTime\"` and **pointInTimeUTCSeconds**\ \ exceeds `0`." minimum: 1199145600 + 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." + items: + $ref: "#/components/schemas/ApiPrivateDownloadDeliveryUrl" + readOnly: true snapshotId: type: string description: Unique 24-hexadecimal character string that identifies the @@ -33326,7 +35752,7 @@ components: and `pointInTime` restore types. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" targetGroupId: type: string description: Unique 24-hexadecimal digit string that identifies the target @@ -33367,7 +35793,7 @@ components: you want to return. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true copySettings: type: array @@ -33461,7 +35887,7 @@ components: you want to return. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true copySettings: type: array @@ -33547,8 +35973,12 @@ components: additionalProperties: type: object description: The stats associated with the stream processor. + externalDocs: + url: https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor readOnly: true description: The stats associated with the stream processor. + externalDocs: + url: https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor readOnly: true EARPrivateEndpoint: type: object @@ -33643,6 +36073,8 @@ components: - PENDING_ACCEPTANCE - ACTIVE - FAILED + - PENDING_RECREATION + - DELETING readOnly: true title: Encryption At Rest Private Endpoint EmailNotification: @@ -33689,6 +36121,36 @@ components: required: - typeName title: Email Notification + EmployeeAccessGrantView: + type: object + description: MongoDB employee granted access level and expiration for a cluster. + properties: + expirationTime: + type: string + format: date-time + description: Expiration date for the employee access grant. + 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." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + readOnly: true + required: + - expirationTime + - grantType EncryptionAtRest: type: object properties: @@ -33698,24 +36160,6 @@ components: $ref: "#/components/schemas/AzureKeyVault" googleCloudKms: $ref: "#/components/schemas/GoogleCloudKMS" - EncryptionAtRestPrivateEndpointRequest: - type: object - description: Create or delete private endpoints from the specified regions list. - properties: - cloudProvider: - type: string - description: Cloud service provider name. - enum: - - AZURE - regions: - type: array - description: List of regions. - items: - type: string - uniqueItems: true - required: - - cloudProvider - title: Encryption At Rest Private Endpoints setup. EncryptionKeyAlertConfigViewForNdsGroup: type: object description: Encryption key alert configuration allows to select thresholds which @@ -34062,6 +36506,7 @@ components: - FTS_INDEX_CLEANED_UP - FTS_INDEXES_RESTORED - FTS_INDEXES_RESTORE_FAILED + - FTS_INDEXES_SYNONYM_MAPPING_INVALID title: FTS Index Audit Types - type: string enum: @@ -34115,6 +36560,8 @@ components: - HOST_HAS_INDEX_SUGGESTIONS - HOST_MONGOT_RECOVERED_OOM - HOST_MONGOT_CRASHING_OOM + - HOST_MONGOT_RESUME_REPLICATION + - HOST_MONGOT_STOP_REPLICATION - HOST_ENOUGH_DISK_SPACE - HOST_NOT_ENOUGH_DISK_SPACE title: Host Event Types @@ -34152,6 +36599,7 @@ components: - 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 @@ -34229,6 +36677,8 @@ components: - 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 @@ -34258,6 +36708,9 @@ components: - 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 @@ -34316,9 +36769,13 @@ components: - 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 title: NDS Audit Types - type: string enum: @@ -34515,11 +36972,14 @@ components: - CLUSTER_VERSION_UNFIXED - CLUSTER_FCV_FIXED - CLUSTER_FCV_UNFIXED + - CLUSTER_FCV_EXPIRATION_DATE_UPDATED - AGENT_VERSION_FIXED - AGENT_VERSION_UNFIXED - FIXED_VERSION_UPDATED - FIXED_AGENT_VERSION_UPDATED - CLUSTER_FCV_DOWNGRADED + - CLUSTER_BINARY_VERSION_DOWNGRADED + - CLUSTER_BINARY_VERSION_UPGRADED title: Version Audit Types - type: string enum: @@ -34795,6 +37255,12 @@ components: enum: - GROUP_TAGS_MODIFIED title: Resource Event Types + - type: string + enum: + - RESOURCE_POLICY_CREATED + - RESOURCE_POLICY_MODIFIED + - RESOURCE_POLICY_DELETED + title: Atlas Resource Policy Audit Types EventViewForNdsGroup: type: object oneOf: @@ -34836,6 +37302,7 @@ components: - $ref: "#/components/schemas/TeamEvent" - $ref: "#/components/schemas/UserEventViewForOrg" - $ref: "#/components/schemas/ResourceEventViewForOrg" + - $ref: "#/components/schemas/AtlasResourcePolicyAuditForOrg" ExampleResourceResponse20230101: type: object properties: @@ -34885,8 +37352,7 @@ components: - description ExportStatus: type: object - description: State of the export job for the collections on the replica set - only. + description: State of the Export Job. properties: exportedCollections: type: integer @@ -34932,6 +37398,7 @@ components: - FTS_INDEX_CLEANED_UP - FTS_INDEXES_RESTORED - FTS_INDEXES_RESTORE_FAILED + - FTS_INDEXES_SYNONYM_MAPPING_INVALID example: FTS_INDEX_CREATED title: FTS Index Audit Types FTSIndexAuditView: @@ -35859,37 +38326,52 @@ components: enum: - EXCLUDE title: Field Transformation - ForNdsGroup: + FieldViolation: type: object - description: ReplicaSet Event identifies different activities about replica - set of mongod instances. properties: - created: + description: type: string - format: date-time - description: Date and time when this event occurred. This parameter expresses - its value in the ISO 8601 timestamp format in UTC. + 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. + required: + - description + - field + FlexBackupRestoreJob20250101: + type: object + description: Details for one restore job of a flex cluster. + properties: + deliveryType: + type: string + description: Means by which this resource returns the snapshot to the requesting + MongoDB Cloud user. + enum: + - RESTORE + - DOWNLOAD readOnly: true - eventTypeName: - $ref: "#/components/schemas/ReplicaSetEventTypeViewForNdsGroup" - groupId: + expirationDate: type: string - description: Unique 24-hexadecimal digit string that identifies the project - in which the event occurred. The **eventId** identifies the specific event. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" + format: date-time + description: Date and time when the download link no longer works. This + parameter expresses its value in the ISO 8601 timestamp format in UTC. readOnly: true id: type: string - description: Unique 24-hexadecimal digit string that identifies the event. + description: Unique 24-hexadecimal digit string that identifies the restore + job. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true + instanceName: + type: string + description: Human-readable label that identifies the source instance. + maxLength: 64 + minLength: 1 + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + readOnly: true links: type: array description: "List of one or more Uniform Resource Locators (URLs) that\ @@ -35901,656 +38383,296 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true - orgId: + projectId: type: string - description: Unique 24-hexadecimal digit string that identifies the organization - to which these events apply. + description: Unique 24-hexadecimal digit string that identifies the project + from which the restore job originated. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true - port: - type: integer - format: int32 - description: IANA port on which the MongoDB process listens for requests. - example: 27017 - readOnly: true - raw: - $ref: "#/components/schemas/raw" - replicaSetName: + restoreFinishedDate: type: string - description: Human-readable label of the replica set associated with the - event. - example: event-replica-set + format: date-time + 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. readOnly: true - shardName: + restoreScheduledDate: type: string - description: Human-readable label of the shard associated with the event. - example: event-sh-01 + format: date-time + description: Date and time when MongoDB Cloud will restore this snapshot. + This parameter expresses its value in the ISO 8601 timestamp format in + UTC. readOnly: true - required: - - created - - eventTypeName - - id - title: ReplicaSet Events - GCPCloudProviderContainer: - type: object - allOf: - - $ref: "#/components/schemas/CloudProviderContainer" - - type: object - properties: - atlasCidrBlock: - type: string - description: |- - IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project. - - These CIDR blocks must fall within the ranges reserved per RFC 1918. GCP further limits the block to a lower bound of the `/18` range. - - To modify the CIDR block, the target project cannot have: - - - Any M10 or greater clusters - - Any other VPC peering connections - - You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project. - - **Example:** A project in an Google Cloud (GCP) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets. - pattern: "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" - gcpProjectId: - 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. - maxLength: 26 - minLength: 26 - pattern: "^p-[0-9a-z]{24}$" - readOnly: true - networkName: - 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. - maxLength: 36 - minLength: 36 - pattern: "^nt-[0-9a-f]{24}-[0-9a-z]{8}$" - 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." - 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." - 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 - description: Collection of settings that configures the network container for - a virtual private connection on Amazon Web Services. - required: - - atlasCidrBlock - title: GCP - GCPComputeAutoScaling: - type: object - description: Collection of settings that configures how a cluster might scale - its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling - is unavailable for clusters using Low CPU or NVME storage classes. - properties: - maxInstanceSize: - type: string - description: Maximum instance size to which your cluster can automatically - scale. - enum: - - M10 - - M20 - - M30 - - M40 - - M50 - - M60 - - M80 - - M140 - - M200 - - M250 - - M300 - - M400 - - R40 - - R50 - - R60 - - R80 - - R200 - - R300 - - R400 - - R600 - title: GCP Instance Sizes - minInstanceSize: + snapshotFinishedDate: 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 - title: GCP Instance Sizes - title: GCP - GCPConsumerForwardingRule: - type: object - properties: - endpointName: + format: date-time + description: Date and time when MongoDB Cloud completed writing this snapshot. + This parameter expresses its value in the ISO 8601 timestamp format in + UTC. + readOnly: true + snapshotId: type: string - description: Human-readable label that identifies the Google Cloud consumer - forwarding rule that you created. - externalDocs: - description: Google Cloud Forwarding Rule Concepts - url: https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts + description: Unique 24-hexadecimal digit string that identifies the snapshot + to restore. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" readOnly: true - ipAddress: + snapshotUrl: type: string - description: One Private Internet Protocol version 4 (IPv4) address to which - this Google Cloud consumer forwarding rule resolves. - pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + 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: State of the MongoDB Cloud endpoint group when MongoDB Cloud - received this request. + description: Phase of the restore workflow for this job at the time this + resource made this request. enum: - - INITIATING - - AVAILABLE + - PENDING + - QUEUED + - RUNNING - FAILED - - DELETING + - COMPLETED readOnly: true - GCPEndpointService: + targetDeploymentItemName: + type: string + description: Human-readable label that identifies the instance or cluster + on the target project to which you want to restore the snapshot. You can + restore the snapshot to another USS instance or Dedicated cluster tier. + maxLength: 64 + minLength: 1 + pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + readOnly: true + targetProjectId: + type: string + description: Unique 24-hexadecimal digit string that identifies the project + that contains the instance or cluster to which you want to restore the + snapshot. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + title: Flex Backup Restore Job + FlexBackupRestoreJobCreate20250101: type: object - description: Group of Private Endpoint Service settings. + description: Details to create one restore job of a flex cluster. properties: - cloudProvider: + _snapshotId: type: string - description: Cloud service provider that serves the requested endpoint service. + description: Unique 24-hexadecimal digit string that identifies the snapshot + to restore. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + writeOnly: true + _targetDeploymentItemName: + type: string + description: Human-readable label that identifies the instance or cluster + on the target project to which you want to restore the snapshot. You can + restore the snapshot to another flex cluster or dedicated cluster tier. + maxLength: 64 + minLength: 1 + pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + writeOnly: true + _targetProjectId: + type: string + description: Unique 24-hexadecimal digit string that identifies the project + that contains the instance or cluster to which you want to restore the + snapshot. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + writeOnly: true + deliveryType: + type: string + description: Means by which this resource returns the snapshot to the requesting + MongoDB Cloud user. enum: - - AWS - - AZURE - - GCP + - RESTORE + - DOWNLOAD readOnly: true - 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 - items: - type: string - description: One Google Cloud network endpoint group that corresponds - to the Private Service Connect endpoint service. - errorMessage: + expirationDate: type: string - description: Error message returned when requesting private connection resource. - The resource returns `null` if the request succeeded. + format: date-time + description: Date and time when the download link no longer works. This + parameter expresses its value in the ISO 8601 timestamp format in UTC. readOnly: true id: type: string - description: Unique 24-hexadecimal digit string that identifies the Private - Endpoint Service. + description: Unique 24-hexadecimal digit string that identifies the restore + job. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true - regionName: + instanceName: type: string - description: Cloud provider region that manages this Private Endpoint Service. + description: Human-readable label that identifies the source instance. + maxLength: 64 + minLength: 1 + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true - serviceAttachmentNames: + links: 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. + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." externalDocs: - description: Google Cloud Private Service Connect Service Attachments - url: https://cloud.google.com/vpc/docs/private-service-connect#service-attachments + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 items: - 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. - 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\\-]+" - status: + $ref: "#/components/schemas/Link" + readOnly: true + projectId: type: string - description: State of the Private Endpoint Service connection when MongoDB - Cloud received this request. - enum: - - INITIATING - - AVAILABLE - - WAITING_FOR_USER - - FAILED - - DELETING - readOnly: true - required: - - cloudProvider - title: GCP - GCPHardwareSpec: - type: object - properties: - instanceSize: - type: string - description: Hardware specification for the instance sizes in this region. - Each instance size has a default storage and memory capacity. The instance - size you select applies to all the data-bearing hosts 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 - title: GCP Instance Sizes - nodeCount: - type: integer - format: int32 - description: Number of nodes of the given type for MongoDB Cloud to deploy - to the region. - GCPHardwareSpec20240805: - type: object - properties: - diskSizeGB: - type: number - format: double - description: "Storage capacity of instance data volumes expressed in gigabytes.\ - \ Increase this number to add capacity.\n\n This value must be equal for\ - \ all shards and node types.\n\n This value is not configurable on M0/M2/M5\ - \ clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\ - \n If you specify a disk size below the minimum (10 GB), this parameter\ - \ defaults to the minimum disk size value. \n\n Storage charge calculations\ - \ depend on whether you choose the default value or a custom value.\n\n\ - \ The maximum value for disk storage cannot exceed 50 times the maximum\ - \ RAM for the selected cluster. If you require more storage space, consider\ - \ upgrading your cluster to a higher tier." - maximum: 4096 - minimum: 10 - instanceSize: - type: string - description: Hardware specification for the instance sizes in this region - in this shard. Each instance size has a default storage and memory capacity. - Electable nodes and read-only nodes (known as "base nodes") within a single - shard must use the same instance size. Analytics nodes can scale independently - from base nodes within a shard. Both base nodes and analytics nodes can - scale independently from their equivalents in other shards. - enum: - - M10 - - M20 - - M30 - - M40 - - M50 - - M60 - - M80 - - M140 - - M200 - - M250 - - M300 - - M400 - - R40 - - R50 - - R60 - - R80 - - R200 - - R300 - - R400 - - R600 - title: GCP Instance Sizes - nodeCount: - type: integer - format: int32 - description: Number of nodes of the given type for MongoDB Cloud to deploy - to the region. - GCPNetworkPeeringConnectionSettings: - type: object - description: Group of Network Peering connection settings. - properties: - containerId: - type: string - description: Unique 24-hexadecimal digit string that identifies the MongoDB - Cloud network container that contains the specified network peering connection. + description: Unique 24-hexadecimal digit string that identifies the project + from which the restore job originated. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" - 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: + restoreFinishedDate: 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. - maxLength: 30 - minLength: 6 - pattern: "^[a-z][0-9a-z-]{4,28}[0-9a-z]{1}" - id: + format: date-time + 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. + readOnly: true + restoreScheduledDate: type: string - description: Unique 24-hexadecimal digit string that identifies the network - peering connection. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" + format: date-time + description: Date and time when MongoDB Cloud will restore this snapshot. + This parameter expresses its value in the ISO 8601 timestamp format in + UTC. readOnly: true - networkName: + snapshotFinishedDate: type: string - description: Human-readable label that identifies the network to peer with - the MongoDB Cloud VPC. - maxLength: 63 - minLength: 1 - pattern: "[a-z]([-a-z0-9]{0,62}[a-z0-9]{0,1})?" - providerName: + format: date-time + description: Date and time when MongoDB Cloud completed writing this snapshot. + This parameter expresses its value in the ISO 8601 timestamp format in + UTC. + readOnly: true + snapshotUrl: type: string - description: Cloud service provider that serves the requested network peering - connection. - enum: - - AWS - - AZURE - - GCP + 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: State of the network peering connection at the time you made - the request. + description: Phase of the restore workflow for this job at the time this + resource made this request. enum: - - ADDING_PEER - - WAITING_FOR_USER - - AVAILABLE + - PENDING + - QUEUED + - RUNNING - FAILED - - DELETING + - COMPLETED readOnly: true required: - - containerId - - gcpProjectId - - networkName - title: GCP - GCPRegionConfig: - type: object - allOf: - - $ref: "#/components/schemas/CloudRegionConfig" - - type: object - properties: - analyticsAutoScaling: - $ref: "#/components/schemas/AdvancedAutoScalingSettings" - analyticsSpecs: - $ref: "#/components/schemas/DedicatedHardwareSpec" - autoScaling: - $ref: "#/components/schemas/AdvancedAutoScalingSettings" - readOnlySpecs: - $ref: "#/components/schemas/DedicatedHardwareSpec" - description: Details that explain how MongoDB Cloud replicates data in one region - on the specified MongoDB database. - title: GCP Regional Replication Specifications - GCPRegionConfig20240805: - type: object - allOf: - - $ref: "#/components/schemas/CloudRegionConfig20240805" - - type: object - properties: - analyticsAutoScaling: - $ref: "#/components/schemas/AdvancedAutoScalingSettings" - analyticsSpecs: - $ref: "#/components/schemas/DedicatedHardwareSpec20240805" - autoScaling: - $ref: "#/components/schemas/AdvancedAutoScalingSettings" - readOnlySpecs: - $ref: "#/components/schemas/DedicatedHardwareSpec20240805" - description: Details that explain how MongoDB Cloud replicates data in one region - on the specified MongoDB database. - title: GCP Regional Replication Specifications - GeoSharding: + - _snapshotId + - _targetDeploymentItemName + title: Create Flex Backup Restore Job + FlexBackupSettings20250101: type: object + description: Flex backup configuration properties: - customZoneMapping: - type: object - additionalProperties: - 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 - 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. - items: - $ref: "#/components/schemas/ManagedNamespaces" - readOnly: true - selfManagedSharding: + enabled: 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. + default: true + description: "Flag that indicates whether backups are performed for this\ + \ flex cluster. Backup uses [TODO](TODO) for flex clusters." readOnly: true - GeoSharding20240805: + readOnly: true + title: Flex Backup Configuration + FlexBackupSnapshot20250101: type: object + description: Details for one snapshot of a flex cluster. properties: - customZoneMapping: - type: object - additionalProperties: - type: string - description: |- - List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone. - - The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property. - - This parameter returns an empty object if no custom zones exist. - readOnly: true - description: |- - List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone. - - The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property. - - This parameter returns an empty object if no custom zones exist. - readOnly: true - managedNamespaces: - type: array - description: List that contains a namespace for a Global Cluster. MongoDB - Cloud manages this cluster. - items: - $ref: "#/components/schemas/ManagedNamespaces" - readOnly: true - 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. + expiration: + type: string + format: date-time + description: Date and time when the download link no longer works. This + parameter expresses its value in the ISO 8601 timestamp format in UTC. readOnly: true - GoogleCloudKMS: - type: object - description: Details that define the configuration of Encryption at Rest using - Google Cloud Key Management Service (KMS). - externalDocs: - description: Google Cloud Key Management Service - url: https://www.mongodb.com/docs/atlas/security-gcp-kms/ - properties: - enabled: - 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: + finishTime: 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 - serviceAccountKey: + format: date-time + description: Date and time when MongoDB Cloud completed writing this snapshot. + This parameter expresses its value in the ISO 8601 timestamp format in + UTC. + readOnly: true + id: type: string - description: 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. + description: Unique 24-hexadecimal digit string that identifies the snapshot. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." externalDocs: - description: Google Cloud Authentication - url: https://cloud.google.com/docs/authentication/getting-started - writeOnly: true - valid: - type: boolean - description: Flag that indicates whether the Google Cloud Key Management - Service (KMS) encryption key can encrypt and decrypt data. + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" readOnly: true - GreaterThanDaysThresholdView: - type: object - description: Threshold value that triggers an alert. - properties: - operator: - type: string - description: Comparison operator to apply when checking the current metric - value. - enum: - - GREATER_THAN - threshold: - type: integer - format: int32 - description: "Value of metric that, when exceeded, triggers an alert." - units: + mongoDBVersion: type: string - description: "Element used to express the quantity. This can be an element\ - \ of time, storage capacity, and the like." - enum: - - DAYS - GreaterThanRawThreshold: - type: object - description: A Limit that triggers an alert when greater than a number. - properties: - operator: + description: MongoDB host version that the snapshot runs. + readOnly: true + scheduledTime: type: string - description: Comparison operator to apply when checking the current metric - value. - enum: - - GREATER_THAN - threshold: - type: integer - format: int32 - description: "Value of metric that, when exceeded, triggers an alert." - units: - $ref: "#/components/schemas/RawMetricUnits" - title: Greater Than Raw Threshold - GreaterThanRawThresholdAlertConfigViewForNdsGroup: - type: object - properties: - created: + format: date-time + description: Date and time when MongoDB Cloud will take the snapshot. This + parameter expresses its value in the ISO 8601 timestamp format in UTC. + readOnly: true + startTime: type: string format: date-time - description: Date and time when MongoDB Cloud created the alert configuration. - This parameter expresses its value in the ISO 8601 timestamp format - in UTC. + description: Date and time when MongoDB Cloud began taking the snapshot. + This parameter expresses its value in the ISO 8601 timestamp format in + UTC. readOnly: true - enabled: - type: boolean - default: false - description: Flag that indicates whether someone enabled this alert configuration - for the specified project. - eventTypeName: - $ref: "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" - groupId: + status: type: string - description: Unique 24-hexadecimal digit string that identifies the project - that owns this alert configuration. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" + description: Phase of the workflow for this snapshot at the time this resource + made this request. + enum: + - PENDING + - QUEUED + - RUNNING + - FAILED + - COMPLETED readOnly: true - id: + title: Flex Backup Snapshot + FlexBackupSnapshotDownloadCreate20250101: + type: object + description: Details for one backup snapshot download of a flex cluster. + properties: + _snapshotId: type: string - description: Unique 24-hexadecimal digit string that identifies this alert - configuration. + description: Unique 24-hexadecimal digit string that identifies the snapshot + to download. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" - readOnly: true + writeOnly: true links: type: array description: "List of one or more Uniform Resource Locators (URLs) that\ @@ -36562,67 +38684,42 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true - matchers: - type: array - description: "List of rules that determine whether MongoDB Cloud checks\ - \ an object for the alert configuration. You can filter using the matchers\ - \ array if the **eventTypeName** specifies an event for a host, replica\ - \ set, or sharded cluster." - items: - $ref: "#/components/schemas/ReplicaSetMatcher" - notifications: - type: array - description: List that contains the targets that MongoDB Cloud sends notifications. - items: - $ref: "#/components/schemas/AlertsNotificationRootForGroup" - threshold: - $ref: "#/components/schemas/GreaterThanRawThreshold" - updated: - type: string - format: date-time - description: Date and time when someone last updated this alert configuration. - This parameter expresses its value in the ISO 8601 timestamp format - in UTC. - readOnly: true required: - - eventTypeName - - notifications - GreaterThanTimeThreshold: + - _snapshotId + title: Flex Backup Snapshot Download Create + FlexClusterDescription20250101: type: object - description: A Limit that triggers an alert when greater than a time period. + description: Group of settings that configure a MongoDB Flex cluster. properties: - operator: + backupSettings: + $ref: "#/components/schemas/FlexBackupSettings20250101" + clusterType: type: string - description: Comparison operator to apply when checking the current metric - value. + description: Flex cluster topology. enum: - - GREATER_THAN - threshold: - type: integer - format: int32 - description: "Value of metric that, when exceeded, triggers an alert." - units: - $ref: "#/components/schemas/TimeMetricUnits" - title: Greater Than Time Threshold - Group: - type: object - properties: - clusterCount: - type: integer - format: int64 - description: Quantity of MongoDB Cloud clusters deployed in this project. + - REPLICASET + - LOADBALANCED readOnly: true - created: + connectionStrings: + $ref: "#/components/schemas/FlexConnectionStrings20250101" + createDate: type: string format: date-time - description: Date and time when MongoDB Cloud created this project. This - parameter expresses its value in the ISO 8601 timestamp format in UTC. + description: Date and time when MongoDB Cloud created this instance. This + parameter expresses its value in ISO 8601 format in UTC. + readOnly: true + groupId: + type: string + description: Unique 24-hexadecimal character string that identifies the + project. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" readOnly: true id: type: string - description: Unique 24-hexadecimal digit string that identifies the MongoDB - Cloud project. + description: Unique 24-hexadecimal digit string that identifies the instance. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 @@ -36639,18 +38736,1021 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true + mongoDBVersion: + type: string + description: Version of MongoDB that the instance runs. + pattern: "([\\d]+\\.[\\d]+\\.[\\d]+)" + readOnly: true name: type: string - description: Human-readable label that identifies the project included in - the MongoDB Cloud organization. + description: Human-readable label that identifies the instance. maxLength: 64 minLength: 1 - pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" - orgId: + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + readOnly: true + providerSettings: + $ref: "#/components/schemas/FlexProviderSettings20250101" + stateName: type: string - description: Unique 24-hexadecimal digit string that identifies the MongoDB - Cloud organization to which the project belongs. - example: 32b6e34b3d91647abb20e7b8 + description: Human-readable label that indicates the current operating condition + of this instance. + enum: + - IDLE + - CREATING + - UPDATING + - DELETING + - REPAIRING + readOnly: true + tags: + type: array + description: List that contains key-value pairs between 1 to 255 characters + in length for tagging and categorizing the instance. + externalDocs: + description: Resource Tags + url: https://dochub.mongodb.org/core/add-cluster-tag-atlas + items: + $ref: "#/components/schemas/ResourceTag" + terminationProtectionEnabled: + type: boolean + default: false + description: "Flag that indicates whether termination protection is enabled\ + \ on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster.\ + \ If set to `false`, MongoDB Cloud will delete the cluster." + versionReleaseSystem: + type: string + default: LTS + description: Method by which the cluster maintains the MongoDB versions. + enum: + - LTS + readOnly: true + required: + - providerSettings + title: Flex Cluster Description + FlexClusterDescriptionCreate20250101: + type: object + description: Settings that you can specify when you create a flex cluster. + properties: + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + name: + type: string + description: Human-readable label that identifies the instance. + maxLength: 64 + minLength: 1 + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + writeOnly: true + providerSettings: + $ref: "#/components/schemas/FlexProviderSettingsCreate20250101" + tags: + type: array + description: List that contains key-value pairs between 1 to 255 characters + in length for tagging and categorizing the instance. + externalDocs: + description: Resource Tags + url: https://dochub.mongodb.org/core/add-cluster-tag-atlas + items: + $ref: "#/components/schemas/ResourceTag" + terminationProtectionEnabled: + type: boolean + default: false + description: "Flag that indicates whether termination protection is enabled\ + \ on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster.\ + \ If set to `false`, MongoDB Cloud will delete the cluster." + required: + - name + - providerSettings + title: Flex Cluster Description Create + FlexConnectionStrings20250101: + type: object + description: Collection of Uniform Resource Locators that point to the MongoDB + database. + externalDocs: + description: Connection string URI format. + url: https://docs.mongodb.com/manual/reference/connection-string/ + properties: + standard: + type: string + description: Public connection string that you can use to connect to this + cluster. This connection string uses the mongodb:// protocol. + externalDocs: + description: Connection String URI Format + url: https://docs.mongodb.com/manual/reference/connection-string/ + readOnly: true + standardSrv: + type: string + description: Public connection string that you can use to connect to this + flex cluster. This connection string uses the `mongodb+srv://` protocol. + externalDocs: + description: Connection String URI Format + url: https://docs.mongodb.com/manual/reference/connection-string/ + readOnly: true + readOnly: true + title: Flex Cluster Connection Strings + FlexProviderSettings20250101: + type: object + description: Group of cloud provider settings that configure the provisioned + MongoDB flex cluster. + properties: + backingProviderName: + type: string + description: Cloud service provider on which MongoDB Cloud provisioned the + flex cluster. + enum: + - AWS + - AZURE + - GCP + readOnly: true + diskSizeGB: + type: number + format: double + description: Storage capacity available to the flex cluster expressed in + gigabytes. + readOnly: true + providerName: + type: string + default: FLEX + description: Human-readable label that identifies the cloud service provider. + enum: + - FLEX + readOnly: true + regionName: + type: string + description: "Human-readable label that identifies the geographic location\ + \ of your MongoDB flex cluster. The region you choose can affect network\ + \ latency for clients accessing your databases. For a complete list of\ + \ region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws),\ + \ [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/)." + readOnly: true + readOnly: true + title: Cloud Service Provider Settings for a Flex Cluster + FlexProviderSettingsCreate20250101: + type: object + description: Group of cloud provider settings that configure the provisioned + MongoDB flex cluster. + properties: + backingProviderName: + type: string + description: Cloud service provider on which MongoDB Cloud provisioned the + flex cluster. + enum: + - AWS + - AZURE + - GCP + writeOnly: true + diskSizeGB: + type: number + format: double + description: Storage capacity available to the flex cluster expressed in + gigabytes. + readOnly: true + providerName: + type: string + default: FLEX + description: Human-readable label that identifies the cloud service provider. + enum: + - FLEX + readOnly: true + regionName: + type: string + description: "Human-readable label that identifies the geographic location\ + \ of your MongoDB flex cluster. The region you choose can affect network\ + \ latency for clients accessing your databases. For a complete list of\ + \ region names, see [AWS](https://docs.atlas.mongodb.com/reference/amazon-aws/#std-label-amazon-aws),\ + \ [GCP](https://docs.atlas.mongodb.com/reference/google-gcp/), and [Azure](https://docs.atlas.mongodb.com/reference/microsoft-azure/)." + writeOnly: true + required: + - backingProviderName + - regionName + title: Cloud Service Provider Settings for a Flex Cluster + writeOnly: true + ForNdsGroup: + type: object + description: ReplicaSet Event identifies different activities about replica + set of mongod instances. + properties: + created: + type: string + format: date-time + description: Date and time when this event occurred. This parameter expresses + its value in the ISO 8601 timestamp format in UTC. + readOnly: true + eventTypeName: + $ref: "#/components/schemas/ReplicaSetEventTypeViewForNdsGroup" + groupId: + type: string + description: Unique 24-hexadecimal digit string that identifies the project + in which the event occurred. The **eventId** identifies the specific event. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + id: + type: string + description: Unique 24-hexadecimal digit string that identifies the event. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + orgId: + type: string + description: Unique 24-hexadecimal digit string that identifies the organization + to which these events apply. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + port: + type: integer + format: int32 + description: IANA port on which the MongoDB process listens for requests. + example: 27017 + readOnly: true + raw: + $ref: "#/components/schemas/raw" + replicaSetName: + type: string + description: Human-readable label of the replica set associated with the + event. + example: event-replica-set + readOnly: true + shardName: + type: string + description: Human-readable label of the shard associated with the event. + example: event-sh-01 + readOnly: true + required: + - created + - eventTypeName + - id + title: ReplicaSet Events + GCPCloudProviderContainer: + type: object + allOf: + - $ref: "#/components/schemas/CloudProviderContainer" + - type: object + properties: + atlasCidrBlock: + type: string + description: |- + IP addresses expressed in Classless Inter-Domain Routing (CIDR) notation that MongoDB Cloud uses for the network peering containers in your project. MongoDB Cloud assigns all of the project's clusters deployed to this cloud provider an IP address from this range. MongoDB Cloud locks this value if an M10 or greater cluster or a network peering connection exists in this project. + + These CIDR blocks must fall within the ranges reserved per RFC 1918. GCP further limits the block to a lower bound of the `/18` range. + + To modify the CIDR block, the target project cannot have: + + - Any M10 or greater clusters + - Any other VPC peering connections + + You can also create a new project and create a network peering connection to set the desired MongoDB Cloud network peering container CIDR block for that project. MongoDB Cloud limits the number of MongoDB nodes per network peering connection based on the CIDR block and the region selected for the project. + + **Example:** A project in an Google Cloud (GCP) region supporting three availability zones and an MongoDB CIDR network peering container block of limit of `/24` equals 27 three-node replica sets. + pattern: "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + gcpProjectId: + 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. + maxLength: 26 + minLength: 26 + pattern: "^p-[0-9a-z]{24}$" + readOnly: true + networkName: + 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. + maxLength: 36 + minLength: 36 + pattern: "^nt-[0-9a-f]{24}-[0-9a-z]{8}$" + 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." + 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." + 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 + description: Collection of settings that configures the network container for + a virtual private connection on Amazon Web Services. + required: + - atlasCidrBlock + title: GCP + GCPComputeAutoScaling: + type: object + description: Collection of settings that configures how a cluster might scale + its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling + is unavailable for clusters using Low CPU or NVME storage classes. + properties: + maxInstanceSize: + type: string + description: Maximum instance size to which your cluster can automatically + scale. + enum: + - M10 + - M20 + - M30 + - M40 + - M50 + - M60 + - M80 + - M140 + - M200 + - M250 + - M300 + - M400 + - R40 + - R50 + - R60 + - R80 + - R200 + - R300 + - R400 + - R600 + title: GCP Instance Sizes + minInstanceSize: + 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 + title: GCP Instance Sizes + title: GCP + GCPConsumerForwardingRule: + type: object + properties: + endpointName: + type: string + description: Human-readable label that identifies the Google Cloud consumer + forwarding rule that you created. + externalDocs: + description: Google Cloud Forwarding Rule Concepts + url: https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts + readOnly: true + ipAddress: + type: string + description: One Private Internet Protocol version 4 (IPv4) address to which + this Google Cloud consumer forwarding rule resolves. + pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + readOnly: true + status: + type: string + description: State of the MongoDB Cloud endpoint group when MongoDB Cloud + received this request. + enum: + - INITIATING + - AVAILABLE + - FAILED + - DELETING + readOnly: true + 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 + 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. + enum: + - CENTRAL_US + - WESTERN_EUROPE + readOnly: true + GCPEndpointService: + type: object + description: Group of Private Endpoint Service settings. + properties: + cloudProvider: + type: string + description: Cloud service provider that serves the requested endpoint service. + enum: + - AWS + - AZURE + - GCP + readOnly: true + 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 + 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: + type: string + description: Unique 24-hexadecimal digit string that identifies the Private + Endpoint Service. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + 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 + items: + 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. + 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\\-]+" + status: + type: string + description: State of the Private Endpoint Service connection when MongoDB + Cloud received this request. + enum: + - INITIATING + - AVAILABLE + - WAITING_FOR_USER + - FAILED + - DELETING + readOnly: true + required: + - cloudProvider + title: GCP + GCPHardwareSpec: + type: object + properties: + instanceSize: + type: string + description: Hardware specification for the instance sizes in this region. + Each instance size has a default storage and memory capacity. The instance + size you select applies to all the data-bearing hosts 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 + title: GCP Instance Sizes + nodeCount: + type: integer + format: int32 + description: Number of nodes of the given type for MongoDB Cloud to deploy + to the region. + GCPHardwareSpec20240805: + type: object + properties: + diskSizeGB: + type: number + format: double + description: "Storage capacity of instance data volumes expressed in gigabytes.\ + \ Increase this number to add capacity.\n\n This value must be equal for\ + \ all shards and node types.\n\n This value is not configurable on M0/M2/M5\ + \ clusters.\n\n MongoDB Cloud requires this parameter if you set **replicationSpecs**.\n\ + \n If you specify a disk size below the minimum (10 GB), this parameter\ + \ defaults to the minimum disk size value. \n\n Storage charge calculations\ + \ depend on whether you choose the default value or a custom value.\n\n\ + \ The maximum value for disk storage cannot exceed 50 times the maximum\ + \ RAM for the selected cluster. If you require more storage space, consider\ + \ upgrading your cluster to a higher tier." + maximum: 4096 + minimum: 10 + instanceSize: + type: string + description: Hardware specification for the instance sizes in this region + in this shard. Each instance size has a default storage and memory capacity. + Electable nodes and read-only nodes (known as "base nodes") within a single + shard must use the same instance size. Analytics nodes can scale independently + from base nodes within a shard. Both base nodes and analytics nodes can + scale independently from their equivalents in other shards. + enum: + - M10 + - M20 + - M30 + - M40 + - M50 + - M60 + - M80 + - M140 + - M200 + - M250 + - M300 + - M400 + - R40 + - R50 + - R60 + - R80 + - R200 + - R300 + - R400 + - R600 + title: GCP Instance Sizes + nodeCount: + type: integer + format: int32 + description: Number of nodes of the given type for MongoDB Cloud to deploy + to the region. + GCPNetworkPeeringConnectionSettings: + type: object + description: Group of Network Peering connection settings. + properties: + containerId: + type: string + description: Unique 24-hexadecimal digit string that identifies the MongoDB + Cloud network container that contains the specified network peering connection. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + 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: + 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. + maxLength: 30 + minLength: 6 + pattern: "^[a-z][0-9a-z-]{4,28}[0-9a-z]{1}" + id: + type: string + description: Unique 24-hexadecimal digit string that identifies the network + peering connection. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + networkName: + type: string + description: Human-readable label that identifies the network to peer with + the MongoDB Cloud VPC. + maxLength: 63 + minLength: 1 + pattern: "[a-z]([-a-z0-9]{0,62}[a-z0-9]{0,1})?" + 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. + enum: + - ADDING_PEER + - WAITING_FOR_USER + - AVAILABLE + - FAILED + - DELETING + readOnly: true + required: + - containerId + - gcpProjectId + - networkName + title: GCP + GCPRegionConfig: + type: object + allOf: + - $ref: "#/components/schemas/CloudRegionConfig" + - type: object + properties: + analyticsAutoScaling: + $ref: "#/components/schemas/AdvancedAutoScalingSettings" + analyticsSpecs: + $ref: "#/components/schemas/DedicatedHardwareSpec" + autoScaling: + $ref: "#/components/schemas/AdvancedAutoScalingSettings" + readOnlySpecs: + $ref: "#/components/schemas/DedicatedHardwareSpec" + description: Details that explain how MongoDB Cloud replicates data in one region + on the specified MongoDB database. + title: GCP Regional Replication Specifications + GCPRegionConfig20240805: + type: object + allOf: + - $ref: "#/components/schemas/CloudRegionConfig20240805" + - type: object + properties: + analyticsAutoScaling: + $ref: "#/components/schemas/AdvancedAutoScalingSettings" + analyticsSpecs: + $ref: "#/components/schemas/DedicatedHardwareSpec20240805" + autoScaling: + $ref: "#/components/schemas/AdvancedAutoScalingSettings" + readOnlySpecs: + $ref: "#/components/schemas/DedicatedHardwareSpec20240805" + description: Details that explain how MongoDB Cloud replicates data in one region + on the specified MongoDB database. + title: GCP Regional Replication Specifications + GeoSharding: + type: object + properties: + customZoneMapping: + type: object + additionalProperties: + 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 + 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. + items: + $ref: "#/components/schemas/ManagedNamespaces" + readOnly: true + 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 + GeoSharding20240805: + type: object + properties: + customZoneMapping: + type: object + additionalProperties: + type: string + description: |- + List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone. + + The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property. + + This parameter returns an empty object if no custom zones exist. + readOnly: true + description: |- + List that contains comma-separated key value pairs to map zones to geographic regions. These pairs map an ISO 3166-1a2 location code, with an ISO 3166-2 subdivision code when possible, to a unique 24-hexadecimal string that identifies the custom zone. + + The 24-hexadecimal string corresponds to a `Replication Specifications` `zoneId` property. + + This parameter returns an empty object if no custom zones exist. + readOnly: true + managedNamespaces: + type: array + description: List that contains a namespace for a Global Cluster. MongoDB + Cloud manages this cluster. + items: + $ref: "#/components/schemas/ManagedNamespaces" + readOnly: true + 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 + GoogleCloudKMS: + type: object + description: Details that define the configuration of Encryption at Rest using + Google Cloud Key Management Service (KMS). + externalDocs: + description: Google Cloud Key Management Service + url: https://www.mongodb.com/docs/atlas/security-gcp-kms/ + properties: + enabled: + 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 + 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. + externalDocs: + description: Google Cloud Authentication + url: https://cloud.google.com/docs/authentication/getting-started + writeOnly: true + valid: + type: boolean + description: Flag that indicates whether the Google Cloud Key Management + Service (KMS) encryption key can encrypt and decrypt data. + readOnly: true + GreaterThanDaysThresholdView: + type: object + description: Threshold value that triggers an alert. + properties: + operator: + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - GREATER_THAN + threshold: + type: integer + format: int32 + description: "Value of metric that, when exceeded, triggers an alert." + units: + type: string + description: "Element used to express the quantity. This can be an element\ + \ of time, storage capacity, and the like." + enum: + - DAYS + GreaterThanRawThreshold: + type: object + description: A Limit that triggers an alert when greater than a number. + properties: + operator: + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - GREATER_THAN + threshold: + type: integer + format: int32 + description: "Value of metric that, when exceeded, triggers an alert." + units: + $ref: "#/components/schemas/RawMetricUnits" + title: Greater Than Raw Threshold + GreaterThanRawThresholdAlertConfigViewForNdsGroup: + type: object + properties: + created: + type: string + format: date-time + description: Date and time when MongoDB Cloud created the alert configuration. + This parameter expresses its value in the ISO 8601 timestamp format + in UTC. + readOnly: true + enabled: + type: boolean + default: false + description: Flag that indicates whether someone enabled this alert configuration + for the specified project. + eventTypeName: + $ref: "#/components/schemas/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" + groupId: + type: string + description: Unique 24-hexadecimal digit string that identifies the project + that owns this alert configuration. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + id: + type: string + description: Unique 24-hexadecimal digit string that identifies this alert + configuration. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + matchers: + type: array + description: "List of rules that determine whether MongoDB Cloud checks\ + \ an object for the alert configuration. You can filter using the matchers\ + \ array if the **eventTypeName** specifies an event for a host, replica\ + \ set, or sharded cluster." + items: + $ref: "#/components/schemas/ReplicaSetMatcher" + notifications: + type: array + description: List that contains the targets that MongoDB Cloud sends notifications. + items: + $ref: "#/components/schemas/AlertsNotificationRootForGroup" + threshold: + $ref: "#/components/schemas/GreaterThanRawThreshold" + updated: + type: string + format: date-time + description: Date and time when someone last updated this alert configuration. + This parameter expresses its value in the ISO 8601 timestamp format + in UTC. + readOnly: true + required: + - eventTypeName + - notifications + GreaterThanTimeThreshold: + type: object + description: A Limit that triggers an alert when greater than a time period. + properties: + operator: + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - GREATER_THAN + threshold: + type: integer + format: int32 + description: "Value of metric that, when exceeded, triggers an alert." + units: + $ref: "#/components/schemas/TimeMetricUnits" + title: Greater Than Time Threshold + Group: + type: object + properties: + clusterCount: + type: integer + format: int64 + description: Quantity of MongoDB Cloud clusters deployed in this project. + readOnly: true + created: + type: string + format: date-time + description: Date and time when MongoDB Cloud created this project. This + parameter expresses its value in the ISO 8601 timestamp format in UTC. + readOnly: true + id: + type: string + description: Unique 24-hexadecimal digit string that identifies the MongoDB + Cloud project. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + name: + type: string + description: Human-readable label that identifies the project included in + the MongoDB Cloud organization. + maxLength: 64 + minLength: 1 + pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + orgId: + type: string + description: Unique 24-hexadecimal digit string that identifies the MongoDB + Cloud organization to which the project belongs. + example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" @@ -36899,25 +39999,26 @@ components: maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" - readOnly: true destinationOrgPrivateApiKey: type: string - description: "Unique string that identifies the private part of the [API\ - \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) used\ - \ to verify access to the destination organization. This parameter is\ - \ required only when you authenticate with Programmatic API Keys." + description: Unique string that identifies the private part of the API Key + used to verify access to the destination organization. This parameter + is required only when you authenticate with Programmatic API Keys. example: 55c3bbb6-b4bb-0be1-e66d20841f3e - readOnly: true + externalDocs: + description: Grant Programmatic Access to Atlas + url: https://dochub.mongodb.org/core/atlas-create-prog-api-key destinationOrgPublicApiKey: type: string - description: "Unique string that identifies the public part of the [API\ - \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) used\ - \ to verify access to the destination organization. This parameter is\ - \ required only when you authenticate with Programmatic API Keys." + description: Unique string that identifies the public part of the API Key + used to verify access to the destination organization. This parameter + is required only when you authenticate with Programmatic API Keys. example: zmmrboas + externalDocs: + description: Grant Programmatic Access to Atlas + url: https://dochub.mongodb.org/core/atlas-create-prog-api-key maxLength: 8 minLength: 8 - readOnly: true GroupNotification: type: object description: Group notification configuration for MongoDB Cloud to send information @@ -37007,7 +40108,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/EventViewForNdsGroup" @@ -37055,6 +40156,33 @@ components: - GROUP_READ_ONLY - GROUP_SEARCH_INDEX_EDITOR - GROUP_STREAM_PROCESSING_OWNER + GroupRoleAssignment: + type: object + properties: + groupId: + type: string + description: Unique 24-hexadecimal digit string that identifies the project + to which these roles belong. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + groupRoles: + type: array + description: One or more project level roles assigned to the MongoDB Cloud + user. + items: + type: string + enum: + - GROUP_OWNER + - GROUP_CLUSTER_MANAGER + - GROUP_STREAM_PROCESSING_OWNER + - GROUP_DATA_ACCESS_ADMIN + - GROUP_DATA_ACCESS_READ_WRITE + - GROUP_DATA_ACCESS_READ_ONLY + - GROUP_READ_ONLY + - GROUP_SEARCH_INDEX_EDITOR + uniqueItems: true GroupService: type: object description: List of IP addresses in a project categorized by services. @@ -37070,26 +40198,26 @@ components: GroupServiceAccount: type: object properties: + clientId: + type: string + description: The Client ID of the Service Account. + pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" createdAt: type: string format: date-time - description: Service account creation time. + description: The date that the Service Account was created on. description: type: string - description: Description of the service account. - id: - type: string - description: ID for the service account. - pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" + description: Human readable description for the Service Account. name: type: string - description: Name for service account. + description: Human-readable name for the Service Account. roles: type: array - description: Roles assigned to the Service Account group. + description: A list of Project roles associated with the Service Account. items: type: string - description: Project roles associated with the service account. + description: Project roles available for Service Accounts. enum: - GROUP_OWNER - GROUP_READ_ONLY @@ -37102,7 +40230,7 @@ components: uniqueItems: true secrets: type: array - description: List of secrets. + description: A list of secrets associated with the specified Service Account. items: $ref: "#/components/schemas/ServiceAccountSecret" uniqueItems: true @@ -37111,23 +40239,23 @@ components: properties: description: type: string - description: Human readable description for the service account. + description: Human readable description for the Service Account. maxLength: 250 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" name: type: string - description: Human-readable name for the service account. The name is modifiable + description: Human-readable name for the Service Account. The name is modifiable and does not have to be unique. maxLength: 64 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" roles: type: array - description: Project roles associated with the service account. + description: A list of project-level roles for the Service Account. items: type: string - description: Project roles associated with the service account. + description: Project roles available for Service Accounts. enum: - GROUP_OWNER - GROUP_READ_ONLY @@ -37140,20 +40268,23 @@ components: secretExpiresAfterHours: type: integer format: int32 - description: Secret expiration time. + description: The expiration time of the new Service Account secret. The + expiration is provided in hours. required: - description - name + - roles - secretExpiresAfterHours GroupServiceAccountRoleAssignment: type: object properties: roles: type: array - description: Group access roles. + description: The Project permissions for the Service Account in the specified + Project. items: type: string - description: Project roles associated with the service account. + description: Project roles available for Service Accounts. enum: - GROUP_OWNER - GROUP_READ_ONLY @@ -37164,28 +40295,30 @@ components: - GROUP_SEARCH_INDEX_EDITOR - GROUP_STREAM_PROCESSING_OWNER uniqueItems: true + required: + - roles GroupServiceAccountUpdateRequest: type: object properties: description: type: string - description: Human readable description for the service account. + description: Human readable description for the Service Account. maxLength: 250 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" name: type: string - description: Human-readable name for the service account. The name is modifiable + description: Human-readable name for the Service Account. The name is modifiable and does not have to be unique. maxLength: 64 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" roles: type: array - description: Project roles associated with the service account. + description: A list of Project roles associated with the Service Account. items: type: string - description: Project roles associated with the service account. + description: Project roles available for Service Accounts. enum: - GROUP_OWNER - GROUP_READ_ONLY @@ -37449,7 +40582,7 @@ components: example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -37568,6 +40701,8 @@ components: - HOST_HAS_INDEX_SUGGESTIONS - HOST_MONGOT_RECOVERED_OOM - HOST_MONGOT_CRASHING_OOM + - HOST_MONGOT_RESUME_REPLICATION + - HOST_MONGOT_STOP_REPLICATION - HOST_ENOUGH_DISK_SPACE - HOST_NOT_ENOUGH_DISK_SPACE example: HOST_DOWN @@ -37579,6 +40714,7 @@ components: - HOST_DOWN - HOST_HAS_INDEX_SUGGESTIONS - HOST_MONGOT_CRASHING_OOM + - HOST_MONGOT_STOP_REPLICATION - HOST_NOT_ENOUGH_DISK_SPACE example: HOST_DOWN title: Host Event Types @@ -37875,6 +41011,7 @@ components: OPCOUNTER_REPL_INSERT: "#/components/schemas/RawMetricAlertView" OPCOUNTER_REPL_UPDATE: "#/components/schemas/RawMetricAlertView" OPCOUNTER_UPDATE: "#/components/schemas/RawMetricAlertView" + OPERATIONS_QUERIES_KILLED: "#/components/schemas/RawMetricAlertView" OPERATIONS_SCAN_AND_ORDER: "#/components/schemas/RawMetricAlertView" OPERATION_THROTTLING_REJECTED_OPERATIONS: "#/components/schemas/RawMetricAlertView" OPLOG_MASTER_LAG_TIME_DIFF: "#/components/schemas/TimeMetricAlertView" @@ -37949,7 +41086,7 @@ components: example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -38278,6 +41415,7 @@ components: OPCOUNTER_REPL_INSERT: "#/components/schemas/RawMetricEventView" OPCOUNTER_REPL_UPDATE: "#/components/schemas/RawMetricEventView" OPCOUNTER_UPDATE: "#/components/schemas/RawMetricEventView" + OPERATIONS_QUERIES_KILLED: "#/components/schemas/RawMetricEventView" OPERATIONS_SCAN_AND_ORDER: "#/components/schemas/RawMetricEventView" OPERATION_THROTTLING_REJECTED_OPERATIONS: "#/components/schemas/RawMetricEventView" OPLOG_MASTER_LAG_TIME_DIFF: "#/components/schemas/TimeMetricEventView" @@ -38583,6 +41721,7 @@ components: OPCOUNTER_REPL_INSERT: "#/components/schemas/RawMetricThresholdView" OPCOUNTER_REPL_UPDATE: "#/components/schemas/RawMetricThresholdView" OPCOUNTER_UPDATE: "#/components/schemas/RawMetricThresholdView" + OPERATIONS_QUERIES_KILLED: "#/components/schemas/RawMetricThresholdView" OPERATIONS_SCAN_AND_ORDER: "#/components/schemas/RawMetricThresholdView" OPERATION_THROTTLING_REJECTED_OPERATIONS: "#/components/schemas/RawMetricThresholdView" OPLOG_MASTER_LAG_TIME_DIFF: "#/components/schemas/TimeMetricThresholdView" @@ -38627,7 +41766,12 @@ components: enum: - AVERAGE operator: - $ref: "#/components/schemas/Operator" + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - LESS_THAN + - GREATER_THAN threshold: type: number format: double @@ -39104,7 +42248,7 @@ components: the charge. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -39540,6 +42684,21 @@ components: - ATLAS_AWS_STREAM_PROCESSING_DATA_TRANSFER - ATLAS_AZURE_STREAM_PROCESSING_DATA_TRANSFER - ATLAS_AWS_STREAM_PROCESSING_VPC_PEERING + - 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 readOnly: true startDate: type: string @@ -39865,6 +43024,371 @@ components: - REPLICASET - SHARDED - GEOSHARDED + configServerManagementMode: + type: string + default: ATLAS_MANAGED + description: |- + Config Server Management Mode for creating or updating a sharded cluster. + + When configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings. + + When configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server. + enum: + - ATLAS_MANAGED + - FIXED_TO_DEDICATED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + configServerType: + type: string + description: Describes a sharded cluster's config server type. + enum: + - DEDICATED + - EMBEDDED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + readOnly: true + connectionStrings: + $ref: "#/components/schemas/ClusterConnectionStrings" + createDate: + type: string + format: date-time + description: Date and time when MongoDB Cloud created this serverless instance. + MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. + readOnly: true + diskSizeGB: + type: number + format: double + 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." + maximum: 4096 + minimum: 10 + diskWarmingMode: + type: string + default: FULLY_WARMED + description: Disk warming mode selection. + enum: + - FULLY_WARMED + - VISIBLE_EARLIER + externalDocs: + description: Reduce Secondary Disk Warming Impact + url: https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact + encryptionAtRestProvider: + type: string + description: Cloud service provider that manages your customer keys to provide + an additional layer of Encryption at Rest for the cluster. + enum: + - NONE + - AWS + - AZURE + - GCP + externalDocs: + description: Encryption at Rest using Customer Key Management + url: https://www.mongodb.com/docs/atlas/security-kms-encryption/ + featureCompatibilityVersion: + type: string + description: Feature compatibility version of the cluster. + readOnly: true + featureCompatibilityVersionExpirationDate: + type: string + format: date-time + description: Feature compatibility version expiration date. + 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: + type: string + description: Unique 24-hexadecimal character string that identifies the + project. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + id: + type: string + description: Unique 24-hexadecimal digit string that identifies the cluster. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + labels: + type: array + deprecated: true + description: |- + Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels. + + Cluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead. + items: + $ref: "#/components/schemas/ComponentLabel" + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + 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- + mongoDBVersion: + type: string + description: Version of MongoDB that the cluster runs. + pattern: "([\\d]+\\.[\\d]+\\.[\\d]+)" + 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." + externalDocs: + description: Connection string URI format. + url: https://docs.mongodb.com/manual/reference/connection-string/ + readOnly: true + mongoURIUpdated: + type: string + format: date-time + description: Date and time when someone last updated the connection string. + MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. + readOnly: true + 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." + externalDocs: + description: Connection string URI format. + url: https://docs.mongodb.com/manual/reference/connection-string/ + readOnly: true + name: + type: string + description: Human-readable label that identifies the cluster. + maxLength: 64 + minLength: 1 + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" + numShards: + type: integer + format: int32 + default: 1 + description: Number of shards up to 50 to deploy for a sharded cluster. + The resource returns `1` to indicate a replica set and values of `2` and + higher to indicate a sharded cluster. The returned value equals the number + of shards in the cluster. + externalDocs: + description: Sharding + url: https://docs.mongodb.com/manual/sharding/ + maximum: 50 + minimum: 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 + default: WORKLOAD_TYPE + description: |- + Set this field to configure the replica set scaling mode for your cluster. + + By default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes. + + When configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads. + + When configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads. + enum: + - SEQUENTIAL + - WORKLOAD_TYPE + - NODE_TYPE + externalDocs: + description: Modify the Replica Set Scaling Mode + url: https://dochub.mongodb.org/core/scale-nodes + replicationFactor: + type: integer + format: int32 + default: 3 + deprecated: true + description: "Number of members that belong to the replica set. Each member\ + \ retains a copy of your databases, providing high availability and data\ + \ redundancy. Use **replicationSpecs** instead." + enum: + - 3 + - 5 + - 7 + replicationSpec: + type: object + additionalProperties: + $ref: "#/components/schemas/RegionSpec" + description: Physical location where MongoDB Cloud provisions cluster nodes. + title: Region Configuration + 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. + items: + $ref: "#/components/schemas/LegacyReplicationSpec" + rootCertType: + type: string + default: ISRGROOTX1 + description: Root Certificate Authority that MongoDB Atlas clusters uses. + MongoDB Cloud supports Internet Security Research Group. + 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. + externalDocs: + description: Connection string URI format. + url: https://docs.mongodb.com/manual/reference/connection-string/ + readOnly: true + stateName: + type: string + description: Human-readable label that indicates the current operating condition + of the cluster. + enum: + - IDLE + - CREATING + - UPDATING + - DELETING + - REPAIRING + readOnly: true + tags: + type: array + description: List that contains key-value pairs between 1 to 255 characters + in length for tagging and categorizing the cluster. + externalDocs: + description: Resource Tags + url: https://dochub.mongodb.org/core/add-cluster-tag-atlas + items: + $ref: "#/components/schemas/ResourceTag" + terminationProtectionEnabled: + type: boolean + default: false + description: "Flag that indicates whether termination protection is enabled\ + \ on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster.\ + \ If set to `false`, MongoDB Cloud will delete the cluster." + versionReleaseSystem: + type: string + default: LTS + description: "Method by which the cluster maintains the MongoDB versions.\ + \ If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**." + enum: + - LTS + - CONTINUOUS + title: Cluster Description + LegacyAtlasTenantClusterUpgradeRequest: + type: object + description: Request containing target state of tenant cluster to be upgraded + properties: + acceptDataRisksAndForceReplicaSetReconfig: + type: string + format: date-time + description: "If reconfiguration is necessary to regain a primary due to\ + \ a regional outage, submit this field alongside your topology reconfiguration\ + \ to request a new regional outage resistant topology. Forced reconfigurations\ + \ during an outage of the majority of electable nodes carry a risk of\ + \ data loss if replicated writes (even majority committed writes) have\ + \ not been replicated to the new primary node. MongoDB Atlas docs contain\ + \ more information. To proceed with an operation which carries that risk,\ + \ set **acceptDataRisksAndForceReplicaSetReconfig** to the current date." + externalDocs: + description: Reconfiguring a Replica Set during a regional outage + url: https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set + 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 + default: ATLAS_MANAGED + description: |- + Config Server Management Mode for creating or updating a sharded cluster. + + When configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings. + + When configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server. + enum: + - ATLAS_MANAGED + - FIXED_TO_DEDICATED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + configServerType: + type: string + description: Describes a sharded cluster's config server type. + enum: + - DEDICATED + - EMBEDDED + externalDocs: + description: MongoDB Sharded Cluster Config Servers + url: https://dochub.mongodb.org/docs/manual/core/sharded-cluster-config-servers + readOnly: true connectionStrings: $ref: "#/components/schemas/ClusterConnectionStrings" createDate: @@ -39909,6 +43433,15 @@ components: externalDocs: description: Encryption at Rest using Customer Key Management url: https://www.mongodb.com/docs/atlas/security-kms-encryption/ + featureCompatibilityVersion: + type: string + description: Feature compatibility version of the cluster. + readOnly: true + featureCompatibilityVersionExpirationDate: + type: string + format: date-time + description: Feature compatibility version expiration date. + readOnly: true globalClusterSelfManagedSharding: type: boolean description: |- @@ -39959,6 +43492,8 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true + mongoDBEmployeeAccessGrant: + $ref: "#/components/schemas/EmployeeAccessGrantView" mongoDBMajorVersion: type: string description: |- @@ -40005,7 +43540,7 @@ components: description: Human-readable label that identifies the cluster. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" numShards: type: integer format: int32 @@ -40037,292 +43572,24 @@ components: \ use MongoDB Cloud backups." providerSettings: $ref: "#/components/schemas/ClusterProviderSettings" - replicationFactor: - type: integer - format: int32 - default: 3 - deprecated: true - description: "Number of members that belong to the replica set. Each member\ - \ retains a copy of your databases, providing high availability and data\ - \ redundancy. Use **replicationSpecs** instead." - enum: - - 3 - - 5 - - 7 - replicationSpec: - type: object - additionalProperties: - $ref: "#/components/schemas/RegionSpec" - description: Physical location where MongoDB Cloud provisions cluster nodes. - title: Region Configuration - 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. - items: - $ref: "#/components/schemas/LegacyReplicationSpec" - rootCertType: - type: string - default: ISRGROOTX1 - description: Root Certificate Authority that MongoDB Atlas clusters uses. - MongoDB Cloud supports Internet Security Research Group. - 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. - externalDocs: - description: Connection string URI format. - url: https://docs.mongodb.com/manual/reference/connection-string/ - readOnly: true - stateName: - type: string - description: Human-readable label that indicates the current operating condition - of the cluster. - enum: - - IDLE - - CREATING - - UPDATING - - DELETING - - REPAIRING - readOnly: true - tags: - type: array - description: List that contains key-value pairs between 1 to 255 characters - in length for tagging and categorizing the cluster. - externalDocs: - description: Resource Tags - url: https://dochub.mongodb.org/core/add-cluster-tag-atlas - items: - $ref: "#/components/schemas/ResourceTag" - terminationProtectionEnabled: - type: boolean - default: false - description: "Flag that indicates whether termination protection is enabled\ - \ on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster.\ - \ If set to `false`, MongoDB Cloud will delete the cluster." - versionReleaseSystem: - type: string - default: LTS - description: "Method by which the cluster maintains the MongoDB versions.\ - \ If value is `CONTINUOUS`, you must not specify **mongoDBMajorVersion**." - enum: - - LTS - - CONTINUOUS - title: Cluster Description - LegacyAtlasTenantClusterUpgradeRequest: - type: object - description: Request containing target state of tenant cluster to be upgraded - properties: - acceptDataRisksAndForceReplicaSetReconfig: - type: string - format: date-time - description: "If reconfiguration is necessary to regain a primary due to\ - \ a regional outage, submit this field alongside your topology reconfiguration\ - \ to request a new regional outage resistant topology. Forced reconfigurations\ - \ during an outage of the majority of electable nodes carry a risk of\ - \ data loss if replicated writes (even majority committed writes) have\ - \ not been replicated to the new primary node. MongoDB Atlas docs contain\ - \ more information. To proceed with an operation which carries that risk,\ - \ set **acceptDataRisksAndForceReplicaSetReconfig** to the current date." - externalDocs: - description: Reconfiguring a Replica Set during a regional outage - url: https://dochub.mongodb.org/core/regional-outage-reconfigure-replica-set - 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 - connectionStrings: - $ref: "#/components/schemas/ClusterConnectionStrings" - createDate: - type: string - format: date-time - description: Date and time when MongoDB Cloud created this serverless instance. - MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. - readOnly: true - diskSizeGB: - type: number - format: double - 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." - maximum: 4096 - minimum: 10 - diskWarmingMode: - type: string - default: FULLY_WARMED - description: Disk warming mode selection. - enum: - - FULLY_WARMED - - VISIBLE_EARLIER - externalDocs: - description: Reduce Secondary Disk Warming Impact - url: https://docs.atlas.mongodb.com/reference/replica-set-tags/#reduce-secondary-disk-warming-impact - encryptionAtRestProvider: - type: string - description: Cloud service provider that manages your customer keys to provide - an additional layer of Encryption at Rest for the cluster. - enum: - - NONE - - AWS - - AZURE - - GCP - externalDocs: - description: Encryption at Rest using Customer Key Management - url: https://www.mongodb.com/docs/atlas/security-kms-encryption/ - 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: - type: string - description: Unique 24-hexadecimal character string that identifies the - project. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - id: + replicaSetScalingStrategy: type: string - description: Unique 24-hexadecimal digit string that identifies the cluster. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - labels: - type: array - deprecated: true + default: WORKLOAD_TYPE 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. + Set this field to configure the replica set scaling mode for your cluster. - Cluster labels are deprecated and will be removed in a future release. We strongly recommend that you use [resource tags](https://dochub.mongodb.org/core/add-cluster-tag-atlas) instead. - items: - $ref: "#/components/schemas/ComponentLabel" - links: - type: array - description: "List of one or more Uniform Resource Locators (URLs) that\ - \ point to API sub-resources, related API resources, or both. RFC 5988\ - \ outlines these relationships." - externalDocs: - description: Web Linking Specification (RFC 5988) - url: https://datatracker.ietf.org/doc/html/rfc5988 - items: - $ref: "#/components/schemas/Link" - readOnly: true - mongoDBMajorVersion: - type: string - description: |- - MongoDB major version of the cluster. + By default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes. - 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). + When configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads. - 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- - mongoDBVersion: - type: string - description: Version of MongoDB that the cluster runs. - pattern: "([\\d]+\\.[\\d]+\\.[\\d]+)" - 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." - externalDocs: - description: Connection string URI format. - url: https://docs.mongodb.com/manual/reference/connection-string/ - readOnly: true - mongoURIUpdated: - type: string - format: date-time - description: Date and time when someone last updated the connection string. - MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. - readOnly: true - 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." - externalDocs: - description: Connection string URI format. - url: https://docs.mongodb.com/manual/reference/connection-string/ - readOnly: true - name: - type: string - description: Human-readable label that identifies the cluster. - maxLength: 64 - minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - numShards: - type: integer - format: int32 - default: 1 - description: Number of shards up to 50 to deploy for a sharded cluster. - The resource returns `1` to indicate a replica set and values of `2` and - higher to indicate a sharded cluster. The returned value equals the number - of shards in the cluster. - externalDocs: - description: Sharding - url: https://docs.mongodb.com/manual/sharding/ - maximum: 50 - minimum: 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. + When configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads. + enum: + - SEQUENTIAL + - WORKLOAD_TYPE + - NODE_TYPE externalDocs: - description: 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" + description: Modify the Replica Set Scaling Mode + url: https://dochub.mongodb.org/core/scale-nodes replicationFactor: type: integer format: int32 @@ -40885,6 +44152,10 @@ components: - INSTANCE_NAME - PROCESSOR_NAME title: Streams Matcher Fields + - type: string + enum: + - RULE_ID + title: Log Ingestion Matcher Fields MatcherHostType: type: string description: Value to match or exceed using the specified **matchers.operator**. @@ -41599,6 +44870,7 @@ components: - 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 @@ -41676,6 +44948,8 @@ components: - 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 @@ -41705,6 +44979,9 @@ components: - 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 @@ -41763,9 +45040,13 @@ components: - 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 example: CLUSTER_CREATED title: NDS Audit Types NDSAuditTypeViewForOrg: @@ -42741,7 +46022,7 @@ components: example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -43000,7 +46281,12 @@ components: enum: - AVERAGE operator: - $ref: "#/components/schemas/Operator" + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - LESS_THAN + - GREATER_THAN threshold: type: number format: double @@ -43190,6 +46476,57 @@ components: required: - typeName title: OpsGenie Notification + OrgActiveUserResponse: + type: object + allOf: + - $ref: "#/components/schemas/OrgUserResponse" + - type: object + properties: + country: + type: string + description: Two alphabet characters that identifies MongoDB Cloud user's + geographic location. This parameter uses the ISO 3166-1a2 code format. + example: US + pattern: "^([A-Z]{2})$" + readOnly: true + createdAt: + type: string + format: date-time + description: Date and time when MongoDB Cloud created the current account. + This value is in the ISO 8601 timestamp format in UTC. + readOnly: true + firstName: + type: string + description: First or given name that belongs to the MongoDB Cloud user. + example: John + readOnly: true + lastAuth: + type: string + format: date-time + description: Date and time when the current account last authenticated. + This value is in the ISO 8601 timestamp format in UTC. + readOnly: true + lastName: + type: string + description: "Last name, family name, or surname that belongs to the MongoDB\ + \ Cloud user." + example: Doe + readOnly: true + mobileNumber: + type: string + description: Mobile phone number that belongs to the MongoDB Cloud user. + pattern: "(?:(?:\\\\+?1\\\\s*(?:[.-]\\\\s*)?)?(?:(\\\\s*([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9])\\\ + \\s*)|([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9]))\\\\s*(?:[.-]\\\\\ + s*)?)([2-9]1[02-9]|[2-9][02-9]1|[2-9][02-9]{2})\\\\s*(?:[.-]\\\\s*)?([0-9]{4})$" + readOnly: true + required: + - createdAt + - firstName + - id + - lastName + - orgMembershipStatus + - roles + - username OrgEventTypeViewForOrg: type: string description: Unique identifier of event type. @@ -43540,7 +46877,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/EventViewForOrg" @@ -43552,29 +46889,61 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true + OrgPendingUserResponse: + type: object + allOf: + - $ref: "#/components/schemas/OrgUserResponse" + - type: object + properties: + invitationCreatedAt: + type: string + format: date-time + description: Date and time when MongoDB Cloud sent the invitation. MongoDB + Cloud represents this timestamp in ISO 8601 format in UTC. + readOnly: true + invitationExpiresAt: + type: string + format: date-time + description: Date and time when the invitation from MongoDB Cloud expires. + MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. + readOnly: true + inviterUsername: + type: string + format: email + description: Username of the MongoDB Cloud user who sent the invitation + to join the organization. + readOnly: true + required: + - id + - invitationCreatedAt + - invitationExpiresAt + - inviterUsername + - orgMembershipStatus + - roles + - username OrgServiceAccount: type: object properties: + clientId: + type: string + description: The Client ID of the Service Account. + pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" createdAt: type: string format: date-time - description: Service account creation time. + description: The date that the Service Account was created on. description: type: string - description: Description of the service account. - id: - type: string - description: ID for the service account. - pattern: "^mdb_sa_id_[a-fA-F\\d]{24}$" + description: Human readable description for the Service Account. name: type: string - description: Name for service account. + description: Human-readable name for the Service Account. roles: type: array - description: Organization roles assigned to the Service Account. + description: A list of Organization roles associated with the Service Account. items: type: string - description: Organization roles associated with the service account. + description: Organization roles available for Service Accounts. enum: - ORG_MEMBER - ORG_READ_ONLY @@ -43585,7 +46954,7 @@ components: uniqueItems: true secrets: type: array - description: List of secrets. + description: A list of secrets associated with the specified Service Account. items: $ref: "#/components/schemas/ServiceAccountSecret" uniqueItems: true @@ -43594,23 +46963,23 @@ components: properties: description: type: string - description: Human readable description for the service account. + description: Human readable description for the Service Account. maxLength: 250 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" name: type: string - description: Human-readable name for the service account. The name is modifiable + description: Human-readable name for the Service Account. The name is modifiable and does not have to be unique. maxLength: 64 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" roles: type: array - description: Organization roles associated with the service account. + description: A list of organization-level roles for the Service Account. items: type: string - description: Organization roles associated with the service account. + description: Organization roles available for Service Accounts. enum: - ORG_MEMBER - ORG_READ_ONLY @@ -43621,33 +46990,35 @@ components: secretExpiresAfterHours: type: integer format: int32 - description: Secret expiration time. + description: The expiration time of the new Service Account secret. The + expiration is provided in hours. required: - description - name + - roles - secretExpiresAfterHours OrgServiceAccountUpdateRequest: type: object properties: description: type: string - description: Human readable description for the service account. + description: Human readable description for the Service Account. maxLength: 250 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" name: type: string - description: Human-readable name for the service account. The name is modifiable + description: Human-readable name for the Service Account. The name is modifiable and does not have to be unique. maxLength: 64 minLength: 1 pattern: "^[\\p{L}\\p{N}\\-_.,' ]*$" roles: type: array - description: Organization roles associated with the Service account. + description: A list of organization-level roles for the Service Account. items: type: string - description: Organization roles associated with the service account. + description: Organization roles available for Service Accounts. enum: - ORG_MEMBER - ORG_READ_ONLY @@ -43655,6 +47026,158 @@ components: - ORG_BILLING_READ_ONLY - ORG_GROUP_CREATOR - ORG_OWNER + OrgUserRequest: + type: object + properties: + roles: + $ref: "#/components/schemas/OrgUserRolesRequest" + teamIds: + type: array + description: List of unique 24-hexadecimal digit strings that identifies + the teams to which this MongoDB Cloud user belongs. + items: + type: string + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + uniqueItems: true + writeOnly: true + username: + type: string + format: email + description: Email address that represents the username of the MongoDB Cloud + user. + writeOnly: true + required: + - roles + - username + OrgUserResponse: + type: object + discriminator: + mapping: + ACTIVE: "#/components/schemas/OrgActiveUserResponse" + PENDING: "#/components/schemas/OrgPendingUserResponse" + propertyName: orgMembershipStatus + oneOf: + - $ref: "#/components/schemas/OrgPendingUserResponse" + - $ref: "#/components/schemas/OrgActiveUserResponse" + properties: + id: + type: string + description: Unique 24-hexadecimal digit string that identifies the MongoDB + Cloud user. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + orgMembershipStatus: + type: string + description: String enum that indicates whether the MongoDB Cloud user has + a pending invitation to join the organization or they are already active + in the organization. + enum: + - PENDING + - ACTIVE + readOnly: true + roles: + $ref: "#/components/schemas/OrgUserRolesResponse" + teamIds: + type: array + description: List of unique 24-hexadecimal digit strings that identifies + the teams to which this MongoDB Cloud user belongs. + items: + type: string + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + readOnly: true + uniqueItems: true + username: + type: string + format: email + description: Email address that represents the username of the MongoDB Cloud + user. + readOnly: true + required: + - id + - orgMembershipStatus + - roles + - username + OrgUserRolesRequest: + type: object + description: Organization and project level roles to assign the MongoDB Cloud + user within one organization. + properties: + groupRoleAssignments: + type: array + description: List of project level role assignments to assign the MongoDB + Cloud user. + items: + $ref: "#/components/schemas/GroupRoleAssignment" + orgRoles: + type: array + description: One or more organization level roles to assign the MongoDB + Cloud user. + items: + type: string + enum: + - ORG_OWNER + - ORG_GROUP_CREATOR + - ORG_BILLING_ADMIN + - ORG_BILLING_READ_ONLY + - ORG_READ_ONLY + - ORG_MEMBER + minItems: 1 + uniqueItems: true + required: + - orgRoles + writeOnly: true + OrgUserRolesResponse: + type: object + description: Organization and project level roles assigned to one MongoDB Cloud + user within one organization. + properties: + groupRoleAssignments: + type: array + description: List of project level role assignments assigned to the MongoDB + Cloud user. + items: + $ref: "#/components/schemas/GroupRoleAssignment" + orgRoles: + type: array + description: One or more organization level roles assigned to the MongoDB + Cloud user. + items: + type: string + enum: + - ORG_OWNER + - ORG_GROUP_CREATOR + - ORG_BILLING_ADMIN + - ORG_BILLING_READ_ONLY + - ORG_READ_ONLY + - ORG_MEMBER + uniqueItems: true + readOnly: true + OrgUserUpdateRequest: + type: object + properties: + roles: + $ref: "#/components/schemas/OrgUserRolesRequest" + teamIds: + type: array + description: List of unique 24-hexadecimal digit strings that identifies + the teams to assign the MongoDB Cloud user. + items: + type: string + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" + uniqueItems: true + writeOnly: true OrganizationInvitation: type: object properties: @@ -43866,10 +47389,11 @@ components: restrictEmployeeAccess: type: boolean description: "Flag that indicates whether to block MongoDB Support from\ - \ accessing Atlas infrastructure 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/." + \ 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/." OutboundControlPlaneCloudProviderIPAddresses: type: object description: "List of outbound IP addresses from the Atlas control plane, categorized\ @@ -44042,7 +47566,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/AdvancedClusterDescription" @@ -44070,7 +47594,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/GroupAlertsConfig" @@ -44098,7 +47622,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/AlertViewForNdsGroup" @@ -44126,7 +47650,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ApiKeyUserDetails" @@ -44154,7 +47678,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/CloudAppUser" @@ -44182,7 +47706,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ApiAtlasCheckpointView" @@ -44212,7 +47736,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/CloudDatabaseUser" @@ -44240,7 +47764,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/DiskBackupExportJob" @@ -44268,7 +47792,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/EARPrivateEndpoint" @@ -44280,7 +47804,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedApiAtlasProviderRegionsView: + PaginatedApiAtlasFlexBackupRestoreJob20250101View: type: object properties: links: @@ -44296,10 +47820,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/CloudProviderRegions" + $ref: "#/components/schemas/FlexBackupRestoreJob20250101" readOnly: true totalCount: type: integer @@ -44308,7 +47832,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedApiAtlasServerlessBackupRestoreJobView: + PaginatedApiAtlasFlexBackupSnapshot20240710View: type: object properties: links: @@ -44324,10 +47848,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/ServerlessBackupRestoreJob" + $ref: "#/components/schemas/FlexBackupSnapshot20250101" readOnly: true totalCount: type: integer @@ -44336,7 +47860,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedApiAtlasServerlessBackupSnapshotView: + PaginatedApiAtlasProviderRegionsView: type: object properties: links: @@ -44352,10 +47876,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/ServerlessBackupSnapshot" + $ref: "#/components/schemas/CloudProviderRegions" readOnly: true totalCount: type: integer @@ -44364,7 +47888,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedApiAtlasUSSBackupRestoreJob20250101View: + PaginatedApiAtlasServerlessBackupRestoreJobView: type: object properties: links: @@ -44380,10 +47904,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/USSBackupRestoreJob20250101" + $ref: "#/components/schemas/ServerlessBackupRestoreJob" readOnly: true totalCount: type: integer @@ -44392,7 +47916,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedApiAtlasUSSBackupSnapshot20240710View: + PaginatedApiAtlasServerlessBackupSnapshotView: type: object properties: links: @@ -44408,10 +47932,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/USSBackupSnapshot20250101" + $ref: "#/components/schemas/ServerlessBackupSnapshot" readOnly: true totalCount: type: integer @@ -44436,7 +47960,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/BillingInvoiceMetadata" @@ -44464,7 +47988,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/BillingInvoice" @@ -44492,7 +48016,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/StreamsConnection" @@ -44504,6 +48028,34 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true + PaginatedApiStreamsPrivateLinkView: + type: object + properties: + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + results: + type: array + description: List of returned documents that MongoDB Cloud provides when + completing this request. + items: + $ref: "#/components/schemas/StreamsPrivateLinkConnection" + readOnly: true + totalCount: + type: integer + format: int32 + description: Total number of documents available. MongoDB Cloud omits this + value if `includeCount` is set to `false`. + minimum: 0 + readOnly: true PaginatedApiStreamsStreamProcessorWithStatsView: type: object properties: @@ -44520,7 +48072,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/StreamsProcessorWithStats" @@ -44548,7 +48100,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/StreamsTenant" @@ -44576,7 +48128,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/UserAccessListResponse" @@ -44588,6 +48140,34 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true + PaginatedApiVersions: + type: object + properties: + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + results: + type: array + description: List of returned documents that MongoDB Cloud provides when + completing this request. + items: + $ref: "#/components/schemas/ApiVersion" + readOnly: true + totalCount: + type: integer + format: int32 + description: Total number of documents available. MongoDB Cloud omits this + value if `includeCount` is set to `false`. + minimum: 0 + readOnly: true PaginatedAppUserView: type: object properties: @@ -44604,7 +48184,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/CloudAppUser" @@ -44632,7 +48212,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/Group" @@ -44660,7 +48240,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/MdbAvailableVersion" @@ -44688,7 +48268,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/DiskBackupSnapshotAWSExportBucket" @@ -44716,7 +48296,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/DiskBackupSnapshotExportBucket" @@ -44744,7 +48324,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/DiskBackupSnapshot" @@ -44772,7 +48352,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/DiskBackupReplicaSet" @@ -44800,7 +48380,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/DiskBackupSnapshotRestoreJob" @@ -44828,7 +48408,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/DiskBackupShardedClusterSnapshot" @@ -44857,7 +48437,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/CloudProviderContainer" @@ -44886,7 +48466,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ClusterDescription20240805" @@ -44914,7 +48494,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ConnectedOrgConfig" @@ -44943,7 +48523,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/BaseNetworkPeeringConnectionSettings" @@ -44971,7 +48551,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/MesurementsDatabase" @@ -44999,7 +48579,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/MeasurementDiskPartition" @@ -45027,7 +48607,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/EventTypeDetails" @@ -45055,7 +48635,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/FederationIdentityProvider" @@ -45067,9 +48647,37 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true + PaginatedFlexClusters20250101: + type: object + properties: + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + results: + type: array + description: List of returned documents that MongoDB Cloud provides when + completing this request. + items: + type: object + readOnly: true + totalCount: + type: integer + format: int32 + description: Total number of documents available. MongoDB Cloud omits this + value if `includeCount` is set to `false`. + minimum: 0 + readOnly: true PaginatedGroupServiceAccounts: type: object - description: List of Service Accounts + description: A list of Project Service Accounts. properties: links: type: array @@ -45084,7 +48692,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/GroupServiceAccount" @@ -45112,7 +48720,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ApiHostView_Atlas" @@ -45140,7 +48748,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ThirdPartyIntegration" @@ -45168,7 +48776,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/LegacyAtlasCluster" @@ -45196,7 +48804,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/NetworkPermissionEntry" @@ -45224,7 +48832,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/BackupOnlineArchive" @@ -45252,7 +48860,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/OrgGroup" @@ -45266,7 +48874,7 @@ components: readOnly: true PaginatedOrgServiceAccounts: type: object - description: List of Service Accounts + description: A list of Organization Service Accounts. properties: links: type: array @@ -45281,7 +48889,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/OrgServiceAccount" @@ -45309,7 +48917,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/AtlasOrganization" @@ -45337,7 +48945,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/IngestionPipelineRun" @@ -45365,7 +48973,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/PrivateNetworkEndpointIdEntry" @@ -45393,7 +49001,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/PublicApiUsageDetailsLineItemView" @@ -45421,7 +49029,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/BackupRestoreJob" @@ -45451,7 +49059,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/AuthFederationRoleMapping" @@ -45479,7 +49087,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ServerlessInstanceDescription" @@ -45493,7 +49101,7 @@ components: readOnly: true PaginatedServiceAccountGroup: type: object - description: List of Service Account projects. + description: A list of projects associated with the Service Account. properties: links: type: array @@ -45508,7 +49116,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/ServiceAccountGroup" @@ -45520,7 +49128,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedSnapshotView: + PaginatedServiceAccountIPAccessEntryView: type: object properties: links: @@ -45536,10 +49144,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/BackupSnapshot" + $ref: "#/components/schemas/ServiceAccountIPAccessListEntry" readOnly: true totalCount: type: integer @@ -45548,7 +49156,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedTeamRoleView: + PaginatedSnapshotView: type: object properties: links: @@ -45564,10 +49172,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/TeamRole" + $ref: "#/components/schemas/BackupSnapshot" readOnly: true totalCount: type: integer @@ -45576,7 +49184,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedTeamView: + PaginatedTeamRoleView: type: object properties: links: @@ -45592,10 +49200,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/TeamResponse" + $ref: "#/components/schemas/TeamRole" readOnly: true totalCount: type: integer @@ -45604,7 +49212,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedTenantRestoreView: + PaginatedTeamView: type: object properties: links: @@ -45620,10 +49228,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/TenantRestore" + $ref: "#/components/schemas/TeamResponse" readOnly: true totalCount: type: integer @@ -45632,7 +49240,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedTenantSnapshotView: + PaginatedTenantRestoreView: type: object properties: links: @@ -45648,10 +49256,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - $ref: "#/components/schemas/BackupTenantSnapshot" + $ref: "#/components/schemas/TenantRestore" readOnly: true totalCount: type: integer @@ -45660,7 +49268,7 @@ components: value if `includeCount` is set to `false`. minimum: 0 readOnly: true - PaginatedUSSInstance20250101: + PaginatedTenantSnapshotView: type: object properties: links: @@ -45676,10 +49284,10 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: - type: object + $ref: "#/components/schemas/BackupTenantSnapshot" readOnly: true totalCount: type: integer @@ -45704,7 +49312,7 @@ components: readOnly: true results: type: array - description: List of returned documents that MongoDB Cloud providers when + description: List of returned documents that MongoDB Cloud provides when completing this request. items: $ref: "#/components/schemas/UserCert" @@ -46192,6 +49800,13 @@ components: PrivateNetworkEndpointIdEntry: type: object properties: + azureConnectionName: + type: string + description: Connection name that identifies the Azure private endpoint + connection. + 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. @@ -46199,6 +49814,10 @@ components: type: string description: Human-readable label to identify customer's VPC endpoint DNS name. + customerEndpointIPAddress: + type: string + description: IP address used to connect to the Azure private endpoint. + pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" endpointId: type: string description: Unique 22-character alphanumeric string that identifies the @@ -46211,6 +49830,10 @@ components: maxLength: 22 minLength: 22 pattern: "^vpce-[0-9a-f]{17}$" + errorMessage: + type: string + description: Error message describing a failure approving the private endpoint + request. provider: type: string default: AWS @@ -46222,6 +49845,14 @@ components: type: string description: Human-readable label to identify the region of customer's VPC endpoint. + status: + type: string + description: Status of the private endpoint connection request. + enum: + - PENDING + - OK + - FAILED + - DELETING type: type: string default: DATA_LAKE @@ -46291,16 +49922,6 @@ components: - serviceDiscovery - username title: PROMETHEUS - ProxyInfo: - type: object - description: VPC Proxy Information. - properties: - authKey: - type: string - description: Authentication key for the proxy. - dnsName: - type: string - description: DNS name to use to reach the proxy/s. PublicApiUsageDetailsLineItemView: type: object properties: @@ -46392,7 +50013,12 @@ components: enum: - AVERAGE operator: - $ref: "#/components/schemas/Operator" + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - LESS_THAN + - GREATER_THAN threshold: type: number format: double @@ -46443,7 +50069,7 @@ components: example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -46702,7 +50328,12 @@ components: enum: - AVERAGE operator: - $ref: "#/components/schemas/Operator" + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - LESS_THAN + - GREATER_THAN threshold: type: number format: double @@ -46892,7 +50523,7 @@ components: example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true created: type: string @@ -47693,7 +51324,7 @@ components: you loaded the sample dataset. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true completeDate: type: string @@ -48507,7 +52138,7 @@ components: \ this parameter when `\"deliveryType\" : \"download\"`." items: type: string - description: One Uniform Resource Locator that point to the compressed + description: One Uniform Resource Locator that points to the compressed snapshot files for manual download. readOnly: true desiredTimestamp: @@ -48594,7 +52225,7 @@ components: parameter when `"deliveryType":` `"automated"`. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" targetGroupId: type: string description: Unique 24-hexadecimal digit string that identifies the target @@ -48669,7 +52300,7 @@ components: which MongoDB Cloud took this snapshot. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true snapshotType: type: string @@ -48801,7 +52432,7 @@ components: description: Human-readable label that identifies the serverless instance. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" providerSettings: $ref: "#/components/schemas/ServerlessProviderSettings" serverlessBackupOptions: @@ -48870,7 +52501,7 @@ components: description: Human-readable label that identifies the serverless instance. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" writeOnly: true providerSettings: $ref: "#/components/schemas/ServerlessProviderSettings" @@ -49034,7 +52665,12 @@ components: enum: - AVERAGE operator: - $ref: "#/components/schemas/Operator" + type: string + description: Comparison operator to apply when checking the current metric + value. + enum: + - LESS_THAN + - GREATER_THAN threshold: type: number format: double @@ -49244,7 +52880,11 @@ components: properties: groupId: type: string - description: Unique 24-hexadecimal digit string that identifies the project. + description: "Unique 24-hexadecimal digit string that identifies your project.\ + \ **NOTE**: Groups and projects are synonymous terms. Your group id is\ + \ the same as your project id. For existing groups, your group/project\ + \ id remains the same. The resource and corresponding endpoints use the\ + \ term groups." example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 @@ -49357,6 +52997,54 @@ components: - eventTypeName - id title: ServiceAccount Events + ServiceAccountIPAccessListEntry: + type: object + properties: + cidrBlock: + type: string + description: "Range of network addresses in the access list for the Service\ + \ Account. This parameter requires the range to be expressed in Classless\ + \ Inter-Domain Routing (CIDR) notation of Internet Protocol version 4\ + \ or version 6 addresses. You can set a value for this parameter or **ipAddress**,\ + \ but not for both in the same request." + example: 203.0.113.0/24 + pattern: "^((([0-9]{1,3}\\.){3}[0-9]{1,3})|(:{0,2}([0-9a-f]{1,4}:){0,7}[0-9a-f]{1,4}[:]{0,2}))((%2[fF]|/)[0-9]{1,3})+$" + createdAt: + type: string + format: date-time + description: Date MongoDB Cloud added the entry was added to the Access + List. + readOnly: true + ipAddress: + type: string + description: "Network address in the access list for the Service Account.\ + \ This parameter requires the address to be expressed as one Internet\ + \ Protocol version 4 or version 6 address. You can set a value for this\ + \ parameter or **cidrBlock**, but not for both in the same request." + example: 203.0.113.10 + pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" + 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 makes at least one request. + readOnly: true + lastUsedAt: + type: string + format: date-time + description: "Date when MongoDB Cloud received the most recent request that\ + \ originated from this Internet Protocol version 4 or version 6 address.\ + \ The resource returns this parameter when at least one request originates\ + \ from this IP address. MongoDB Cloud updates this parameter each time\ + \ a client accesses the permitted resource, with a delay of up to 5 minutes." + readOnly: true + requestCount: + type: integer + format: int32 + description: The number of requests that has originated from this network + address. + readOnly: true ServiceAccountOrgEvents: type: object description: Service Account event identifies different activities around user @@ -49470,35 +53158,34 @@ components: createdAt: type: string format: date-time - description: Timestamp representing creation time. + description: The date that the secret was created on. readOnly: true expiresAt: type: string format: date-time - description: Timestamp representing secret expiration time. + description: The date for the expiration of the secret. readOnly: true id: type: string - description: Unique 24-hexadecimal character string that identifies the - secret. + description: Unique 24-hexadecimal digit string that identifies the secret. example: 32b6e34b3d91647abb20e7b8 pattern: "^([a-f0-9]{24})$" readOnly: true lastUsedAt: type: string format: date-time - description: Timestamp representing last secret usage. + description: The last time the secret was used. readOnly: true maskedSecretValue: type: string - description: Service Account secret with masked values of the first 20 characters. + description: The masked Service Account secret. example: mdb_ic_sk_...12ce readOnly: true secret: type: string - description: Secret for the service account. It will be returned only the - first time after service account creation. - pattern: "^mdb_sa_sk_[0-9a-zA-Z]{40}$" + description: The secret for the Service Account. It will be returned only + the first time after creation. + pattern: "^mdb_sa_sk_[0-9a-zA-Z_-]{40}$" readOnly: true required: - createdAt @@ -49510,7 +53197,8 @@ components: secretExpiresAfterHours: type: integer format: int32 - description: Number of hours representing validity duration for secret. + description: The expiration time of the new Service Account secret. The + expiration is provided in hours. required: - secretExpiresAfterHours ShardEntry: @@ -50133,17 +53821,19 @@ components: StreamsDLQ: type: object description: Dead letter queue for the stream processor. + externalDocs: + url: https://www.mongodb.com/docs/atlas/reference/glossary/#std-term-dead-letter-queue properties: coll: type: string - description: Name of the collection that will be used for the DLQ. + description: Name of the collection to use for the DLQ. connectionName: type: string - description: Connection name that will be used to write DLQ messages to. - Has to be an Atlas connection. + description: Name of the connection to write DLQ messages to. Must be an + Atlas connection. db: type: string - description: Name of the database that will be used for the DLQ. + description: Name of the database to use for the DLQ. links: type: array description: "List of one or more Uniform Resource Locators (URLs) that\ @@ -50312,8 +54002,6 @@ components: group.protocol.type: consumer networking: $ref: "#/components/schemas/StreamsKafkaNetworking" - proxyInfo: - $ref: "#/components/schemas/ProxyInfo" security: $ref: "#/components/schemas/StreamsKafkaSecurity" StreamsKafkaNetworking: @@ -50339,6 +54027,13 @@ components: type: object description: Information about the networking access. properties: + connectionId: + type: string + description: Reserved. Will be used by PRIVATE_LINK connection type. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" links: type: array description: "List of one or more Uniform Resource Locators (URLs) that\ @@ -50352,14 +54047,18 @@ components: readOnly: true name: type: string - description: Id of the vpc peer when the type is VPC. + description: Reserved. Will be used by PRIVATE_LINK connection type. type: type: string - description: Selected networking type. Either PUBLIC or VPC. Defaults to - PUBLIC + description: "Selected networking type. Either PUBLIC, VPC or PRIVATE_LINK.\ + \ Defaults to PUBLIC. For VPC, ensure that VPC peering exists and connectivity\ + \ has been established between Atlas VPC and the VPC where Kafka cluster\ + \ is hosted for the connection to function properly. PRIVATE_LINK support\ + \ is coming soon." enum: - PUBLIC - VPC + - PRIVATE_LINK title: Networking Access Type StreamsKafkaSecurity: type: object @@ -50438,6 +54137,52 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true + StreamsPrivateLinkConnection: + type: object + description: Container for metadata needed to create a Private Link connection. + properties: + _id: + type: string + description: The ID of the Private Link connection. + dnsDomain: + type: string + description: Domain name of Confluent cluster. + dnsSubDomain: + type: array + description: Sub-Domain name of Confluent cluster. These are typically your + availability zones. + items: + type: string + interfaceEndpointId: + type: string + description: Interface endpoint ID that is created from the service endpoint + ID provided. + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + provider: + type: string + description: Provider where the Kafka cluster is deployed. + region: + type: string + description: Domain name of Confluent cluster. + serviceEndpointId: + type: string + description: AWS Service Endpoint ID. + state: + type: string + description: State the connection is in. + vendor: + type: string + description: Vendor who manages the Kafka cluster. StreamsProcessor: type: object description: An atlas stream processor. @@ -50471,6 +54216,9 @@ components: type: array description: Stream aggregation pipeline you want to apply to your streaming data. + externalDocs: + description: Supported Aggregation Pipeline Stages + url: https://www.mongodb.com/docs/atlas/atlas-stream-processing/stream-aggregation/#std-label-stream-aggregation items: $ref: "#/components/schemas/Document" StreamsProcessorWithStats: @@ -50501,6 +54249,8 @@ components: type: string description: Human-readable name of the stream processor. readOnly: true + options: + $ref: "#/components/schemas/StreamsOptions" pipeline: type: array description: Stream aggregation pipeline you want to apply to your streaming @@ -50510,15 +54260,20 @@ components: readOnly: true state: type: string - description: The state of the stream processor. + description: "The state of the stream processor. Commonly occurring states\ + \ are 'CREATED', 'STARTED', 'STOPPED' and 'FAILED'." readOnly: true stats: type: object additionalProperties: type: object description: The stats associated with the stream processor. + externalDocs: + url: https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor readOnly: true description: The stats associated with the stream processor. + externalDocs: + url: https://www.mongodb.com/docs/atlas/atlas-stream-processing/manage-stream-processor/#view-statistics-of-a-stream-processor readOnly: true required: - _id @@ -50529,6 +54284,26 @@ components: type: object allOf: - $ref: "#/components/schemas/StreamsConnection" + StreamsSampleConnections: + type: object + description: Sample connections to add to SPI. + properties: + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + solar: + type: boolean + default: false + description: Flag that indicates whether to add a 'sample_stream_solar' + connection. StreamsTenant: type: object properties: @@ -50580,6 +54355,8 @@ components: name: type: string description: Human-readable label that identifies the stream instance. + sampleConnections: + $ref: "#/components/schemas/StreamsSampleConnections" streamConfig: $ref: "#/components/schemas/StreamConfig" SummaryNotification: @@ -51240,7 +55017,7 @@ components: description: Human-readable label that identifies the source cluster. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true deliveryType: type: string @@ -51350,6 +55127,8 @@ components: required: - snapshotId - targetDeploymentItemName + TenantWithSampleConnections: + type: object TextSearchHostStatusDetail: type: object properties: @@ -51566,808 +55345,199 @@ components: type: array description: List of documents detailing index status on each host. items: - $ref: "#/components/schemas/TextSearchHostStatusDetail" - synonymMappingStatus: - type: string - description: Status that describes this index's synonym mappings. This - status appears only if the index has synonyms defined. - enum: - - FAILED - - BUILDING - - READY - synonymMappingStatusDetail: - type: array - description: A list of documents describing the status of the index's - synonym mappings on each search host. Only appears if the index has - synonyms defined. - items: - type: object - additionalProperties: - $ref: "#/components/schemas/SynonymMappingStatusDetail" - title: Text Search Index Response - TextSearchIndexStatusDetail: - type: object - description: Contains status information about a text search index. - properties: - definition: - $ref: "#/components/schemas/TextSearchIndexDefinition" - definitionVersion: - $ref: "#/components/schemas/SearchIndexDefinitionVersion" - message: - type: string - description: Optional message describing an error. - queryable: - type: boolean - description: Flag that indicates whether the index generation is queryable - on the host. - status: - type: string - description: | - Condition of the search index when you made this request. - - | Status | Index Condition | - |---|---| - | DELETING | The index is being deleted. | - | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. | - | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. | - | PENDING | Atlas has not yet started building the index. | - | BUILDING | Atlas is building or re-building the index after an edit. | - | READY | The index is ready and can support queries. | - enum: - - DELETING - - FAILED - - STALE - - PENDING - - BUILDING - - READY - - DOES_NOT_EXIST - synonymMappingStatus: - type: string - description: Status that describes this index's synonym mappings. This status - appears only if the index has synonyms defined. - enum: - - FAILED - - BUILDING - - READY - synonymMappingStatusDetail: - type: array - description: List of synonym statuses by mapping. - items: - $ref: "#/components/schemas/SynonymMappingStatusDetailMap" - title: Text Search Index Status Detail - ThirdPartyIntegration: - type: object - description: Collection of settings that describe third-party integrations. - discriminator: - mapping: - DATADOG: "#/components/schemas/Datadog" - MICROSOFT_TEAMS: "#/components/schemas/MicrosoftTeams" - NEW_RELIC: "#/components/schemas/NewRelic" - OPS_GENIE: "#/components/schemas/OpsGenie" - PAGER_DUTY: "#/components/schemas/PagerDuty" - PROMETHEUS: "#/components/schemas/Prometheus" - SLACK: "#/components/schemas/Slack" - VICTOR_OPS: "#/components/schemas/VictorOps" - WEBHOOK: "#/components/schemas/Webhook" - propertyName: type - properties: - id: - type: string - description: Integration id. - nullable: true - type: - type: string - description: Integration type - enum: - - PAGER_DUTY - - SLACK - - DATADOG - - NEW_RELIC - - OPS_GENIE - - VICTOR_OPS - - WEBHOOK - - HIP_CHAT - - PROMETHEUS - - MICROSOFT_TEAMS - title: Integration Type - title: Third-Party Integration - TimeMetricAlertView: - type: object - properties: - acknowledgedUntil: - type: string - format: date-time - description: |- - Date and time until which this alert has been acknowledged. This parameter expresses its value in the 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. - acknowledgementComment: - type: string - description: Comment that a MongoDB Cloud user submitted when acknowledging - the alert. - example: Expiration on 3/19. Silencing for 7days. - maxLength: 200 - acknowledgingUsername: - type: string - format: email - description: MongoDB Cloud username of the person who acknowledged the alert. - The response returns this parameter if a MongoDB Cloud user previously - acknowledged this alert. - readOnly: true - alertConfigId: - type: string - description: Unique 24-hexadecimal digit string that identifies the alert - configuration that sets this alert. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - clusterName: - 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." - example: cluster1 - maxLength: 64 - minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - readOnly: true - created: - type: string - format: date-time - description: Date and time when MongoDB Cloud created this alert. This parameter - expresses its value in the ISO 8601 timestamp format - in UTC. - readOnly: true - currentValue: - $ref: "#/components/schemas/TimeMetricValueView" - eventTypeName: - $ref: "#/components/schemas/HostMetricEventTypeViewAlertable" - groupId: - type: string - description: Unique 24-hexadecimal digit string that identifies the project - that owns this alert. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - 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. - example: cloud-test.mongodb.com:27017 - readOnly: true - id: - type: string - description: Unique 24-hexadecimal digit string that identifies this alert. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - lastNotified: - type: string - format: date-time - description: Date and time that any notifications were last sent for this - alert. This parameter expresses its value in the ISO 8601 timestamp format - in UTC. The resource returns this parameter if MongoDB Cloud has sent - notifications for this alert. - readOnly: true - links: - type: array - description: "List of one or more Uniform Resource Locators (URLs) that\ - \ point to API sub-resources, related API resources, or both. RFC 5988\ - \ outlines these relationships." - externalDocs: - description: Web Linking Specification (RFC 5988) - url: https://datatracker.ietf.org/doc/html/rfc5988 - items: - $ref: "#/components/schemas/Link" - readOnly: true - 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. - example: ASSERT_USER - readOnly: true - orgId: - type: string - description: Unique 24-hexadecimal character string that identifies the - organization that owns the project to which this alert applies. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - 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." - example: event-replica-set - readOnly: true - resolved: - type: string - format: date-time - description: "Date and time that this alert changed to `\"status\" : \"\ - CLOSED\"`. This parameter expresses its value in the ISO 8601 timestamp\ - \ format in UTC. The resource returns this parameter once `\"status\"\ - \ : \"CLOSED\"`." - readOnly: true - status: - type: string - description: State of this alert at the time you requested its details. - enum: - - CANCELLED - - CLOSED - - OPEN - - TRACKING - example: OPEN - readOnly: true - updated: - type: string - format: date-time - description: Date and time when someone last updated this alert. This parameter - expresses its value in the ISO 8601 timestamp format - in UTC. - readOnly: true - required: - - alertConfigId - - created - - eventTypeName - - id - - status - - updated - TimeMetricEventView: - type: object - properties: - apiKeyId: - type: string - description: "Unique 24-hexadecimal digit string that identifies the [API\ - \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\ - \ triggered the event. If this resource returns this parameter, it doesn't\ - \ return the **userId** parameter." - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - created: - type: string - format: date-time - description: Date and time when this event occurred. This parameter expresses - its value in the ISO 8601 timestamp format in UTC. - readOnly: true - currentValue: - $ref: "#/components/schemas/TimeMetricValueView" - eventTypeName: - $ref: "#/components/schemas/HostMetricEventTypeView" - groupId: - type: string - description: Unique 24-hexadecimal digit string that identifies the project - in which the event occurred. The **eventId** identifies the specific event. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - id: - type: string - description: Unique 24-hexadecimal digit string that identifies the event. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - isGlobalAdmin: - type: boolean - default: false - description: Flag that indicates whether a MongoDB employee triggered the - specified event. - readOnly: true - links: - type: array - description: "List of one or more Uniform Resource Locators (URLs) that\ - \ point to API sub-resources, related API resources, or both. RFC 5988\ - \ outlines these relationships." - externalDocs: - description: Web Linking Specification (RFC 5988) - url: https://datatracker.ietf.org/doc/html/rfc5988 - items: - $ref: "#/components/schemas/Link" - readOnly: true - 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: - type: string - description: Unique 24-hexadecimal digit string that identifies the organization - to which these events apply. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - port: - type: integer - format: int32 - description: IANA port on which the MongoDB process listens for requests. - example: 27017 - readOnly: true - publicKey: - type: string - format: email - description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\ - \ that triggered the event. If this resource returns this parameter, it\ - \ doesn't return the **username** parameter." - example: test.user@mongodb.com - readOnly: true - raw: - $ref: "#/components/schemas/raw" - remoteAddress: - type: string - description: IPv4 or IPv6 address from which the user triggered this event. - example: 216.172.40.186 - pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" - readOnly: true - replicaSetName: - type: string - description: Human-readable label of the replica set associated with the - event. - example: event-replica-set - readOnly: true - shardName: - type: string - description: Human-readable label of the shard associated with the event. - example: event-sh-01 - readOnly: true - userId: - type: string - description: "Unique 24-hexadecimal digit string that identifies the console\ - \ user who triggered the event. If this resource returns this parameter,\ - \ it doesn't return the **apiKeyId** parameter." - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - username: - type: string - format: email - description: "Email address for the user who triggered this event. If this\ - \ resource returns this parameter, it doesn't return the **publicApiKey**\ - \ parameter." - example: test.user@mongodb.com - readOnly: true - required: - - created - - eventTypeName - - id - TimeMetricThresholdView: - 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: - $ref: "#/components/schemas/Operator" - threshold: - type: number - format: double - description: "Value of metric that, when exceeded, triggers an alert." - units: - $ref: "#/components/schemas/TimeMetricUnits" - required: - - metricName - TimeMetricUnits: - type: string - default: HOURS - description: "Element used to express the quantity. This can be an element of\ - \ time, storage capacity, and the like." - enum: - - NANOSECONDS - - MILLISECONDS - - MILLION_MINUTES - - SECONDS - - MINUTES - - HOURS - - DAYS - title: Time Metric Units - TimeMetricValueView: - type: object - description: Measurement of the **metricName** recorded at the time of the event. - properties: - number: - type: number - format: double - description: Amount of the **metricName** recorded at the time of the event. - This value triggered the alert. - readOnly: true - units: - $ref: "#/components/schemas/TimeMetricUnits" - readOnly: true - title: Time Metric Value - TokenFilterEnglishPossessive: - type: object - description: Filter that removes possessives (trailing 's) from words. - properties: - type: - type: string - description: Human-readable label that identifies this token filter type. - enum: - - englishPossessive - required: - - type - title: englishPossessive - TokenFilterFlattenGraph: - type: object - description: "Filter that transforms a token filter graph, such as the token\ - \ filter graph that the wordDelimiterGraph token filter produces, into a flat\ - \ form suitable for indexing." - properties: - type: - type: string - description: Human-readable label that identifies this token filter type. - enum: - - flattenGraph - required: - - type - title: flattenGraph - TokenFilterPorterStemming: + $ref: "#/components/schemas/TextSearchHostStatusDetail" + synonymMappingStatus: + type: string + description: Status that describes this index's synonym mappings. This + status appears only if the index has synonyms defined. + enum: + - FAILED + - BUILDING + - READY + synonymMappingStatusDetail: + type: array + description: A list of documents describing the status of the index's + synonym mappings on each search host. Only appears if the index has + synonyms defined. + items: + type: object + additionalProperties: + $ref: "#/components/schemas/SynonymMappingStatusDetail" + title: Text Search Index Response + TextSearchIndexStatusDetail: type: object - 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. + description: Contains status information about a text search index. properties: - type: + definition: + $ref: "#/components/schemas/TextSearchIndexDefinition" + definitionVersion: + $ref: "#/components/schemas/SearchIndexDefinitionVersion" + message: type: string - description: Human-readable label that identifies this token filter type. - enum: - - porterStemming - required: - - type - title: porterStemming - TokenFilterSpanishPluralStemming: - type: object - description: Filter that stems Spanish plural words. It expects lowercase text. - properties: - type: + description: Optional message describing an error. + queryable: + type: boolean + description: Flag that indicates whether the index generation is queryable + on the host. + status: type: string - description: Human-readable label that identifies this token filter type. + description: | + Condition of the search index when you made this request. + + | Status | Index Condition | + |---|---| + | DELETING | The index is being deleted. | + | FAILED | The index build failed. Indexes can enter the FAILED state due to an invalid index definition. | + | STALE | The index is queryable but has stopped replicating data from the indexed collection. Searches on the index may return out-of-date data. | + | PENDING | Atlas has not yet started building the index. | + | BUILDING | Atlas is building or re-building the index after an edit. | + | READY | The index is ready and can support queries. | enum: - - spanishPluralStemming - required: - - type - title: spanishPluralStemming - TokenFilterStempel: - type: object - description: Filter that uses Lucene's default Polish stemmer table to stem - words in the Polish language. It expects lowercase text. - externalDocs: - description: Default Polish stemmer table - url: https://lucene.apache.org/core/9_2_0/analysis/stempel/org/apache/lucene/analysis/pl/PolishAnalyzer.html#DEFAULT_STEMMER_FILE - properties: - type: + - DELETING + - FAILED + - STALE + - PENDING + - BUILDING + - READY + - DOES_NOT_EXIST + synonymMappingStatus: type: string - description: Human-readable label that identifies this token filter type. + description: Status that describes this index's synonym mappings. This status + appears only if the index has synonyms defined. enum: - - stempel - required: - - type - title: stempel - TokenFilterWordDelimiterGraph: + - FAILED + - BUILDING + - READY + synonymMappingStatusDetail: + type: array + description: List of synonym statuses by mapping. + items: + $ref: "#/components/schemas/SynonymMappingStatusDetailMap" + title: Text Search Index Status Detail + ThirdPartyIntegration: type: object - description: Filter that splits tokens into sub-tokens based on configured rules. + description: Collection of settings that describe third-party integrations. + discriminator: + mapping: + DATADOG: "#/components/schemas/Datadog" + MICROSOFT_TEAMS: "#/components/schemas/MicrosoftTeams" + NEW_RELIC: "#/components/schemas/NewRelic" + OPS_GENIE: "#/components/schemas/OpsGenie" + PAGER_DUTY: "#/components/schemas/PagerDuty" + PROMETHEUS: "#/components/schemas/Prometheus" + SLACK: "#/components/schemas/Slack" + VICTOR_OPS: "#/components/schemas/VictorOps" + WEBHOOK: "#/components/schemas/Webhook" + propertyName: type properties: - delimiterOptions: - type: object - description: Object that contains the rules that determine how to split - words into sub-words. - properties: - concatenateAll: - type: boolean - default: false - description: Flag that indicates whether to concatenate runs. - concatenateNumbers: - type: boolean - default: false - description: Flag that indicates whether to concatenate runs of sub-numbers. - concatenateWords: - type: boolean - default: false - description: Flag that indicates whether to concatenate runs of sub-words. - generateNumberParts: - type: boolean - default: true - description: "Flag that indicates whether to split tokens based on sub-numbers.\ - \ For example, if `true`, this option splits `100-2` into `100` and\ - \ `2`." - generateWordParts: - type: boolean - default: true - description: Flag that indicates whether to split tokens based on sub-words. - ignoreKeywords: - type: boolean - default: false - description: Flag that indicates whether to skip tokens with the `keyword` - attribute set to `true` - preserveOriginal: - type: boolean - default: true - description: Flag that indicates whether to generate tokens of the original - words. - splitOnCaseChange: - type: boolean - default: true - description: Flag that indicates whether to split tokens based on letter-case - transitions. - splitOnNumerics: - type: boolean - default: true - description: Flag that indicates whether to split tokens based on letter-number - transitions. - stemEnglishPossessive: - type: boolean - default: true - description: Flag that indicates whether to remove trailing possessives - from each sub-word. - protectedWords: - type: object - description: Object that contains options for protected words. - properties: - ignoreCase: - type: boolean - default: true - description: Flag that indicates whether to ignore letter case sensitivity - for protected words. - words: - type: array - description: List that contains the tokens to protect from delimination. - items: - type: string - required: - - words - type: + id: type: string - description: Human-readable label that identifies this token filter type. - enum: - - wordDelimiterGraph - required: - - type - title: wordDelimiterGraph - TokenFilterkStemming: - type: object - description: Filter that combines algorithmic stemming with a built-in dictionary - for the English language to stem words. - properties: + description: Integration id. + nullable: true type: type: string - description: Human-readable label that identifies this token filter type. + description: Integration type enum: - - kStemming - required: - - type - title: kStemming - TriggerIngestionPipelineRequest: - type: object - properties: - datasetRetentionPolicy: - $ref: "#/components/schemas/DatasetRetentionPolicy" - snapshotId: - type: string - description: Unique 24-hexadecimal character string that identifies the - snapshot. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - writeOnly: true - required: - - snapshotId - USSBackupRestoreJob20250101: + - PAGER_DUTY + - SLACK + - DATADOG + - NEW_RELIC + - OPS_GENIE + - VICTOR_OPS + - WEBHOOK + - HIP_CHAT + - PROMETHEUS + - MICROSOFT_TEAMS + title: Integration Type + title: Third-Party Integration + TimeMetricAlertView: type: object - description: Details for one restore job of a USS instance. properties: - deliveryType: - type: string - description: Means by which this resource returns the snapshot to the requesting - MongoDB Cloud user. - enum: - - RESTORE - - DOWNLOAD - readOnly: true - expirationDate: - type: string - format: date-time - description: Date and time when the download link no longer works. This - parameter expresses its value in the ISO 8601 timestamp format in UTC. - readOnly: true - id: - type: string - description: Unique 24-hexadecimal digit string that identifies the restore - job. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - instanceName: - type: string - description: Human-readable label that identifies the source instance. - maxLength: 64 - minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - readOnly: true - links: - type: array - description: "List of one or more Uniform Resource Locators (URLs) that\ - \ point to API sub-resources, related API resources, or both. RFC 5988\ - \ outlines these relationships." - externalDocs: - description: Web Linking Specification (RFC 5988) - url: https://datatracker.ietf.org/doc/html/rfc5988 - items: - $ref: "#/components/schemas/Link" - readOnly: true - projectId: - type: string - description: Unique 24-hexadecimal digit string that identifies the project - from which the restore job originated. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - readOnly: true - restoreFinishedDate: + acknowledgedUntil: type: string format: date-time - 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. - readOnly: true - restoreScheduledDate: + 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. + acknowledgementComment: type: string - format: date-time - description: Date and time when MongoDB Cloud will restore this snapshot. - This parameter expresses its value in the ISO 8601 timestamp format in - UTC. - readOnly: true - snapshotFinishedDate: + description: Comment that a MongoDB Cloud user submitted when acknowledging + the alert. + example: Expiration on 3/19. Silencing for 7days. + maxLength: 200 + acknowledgingUsername: type: string - format: date-time - description: Date and time when MongoDB Cloud completed writing this snapshot. - This parameter expresses its value in the ISO 8601 timestamp format in - UTC. + format: email + description: MongoDB Cloud username of the person who acknowledged the alert. + The response returns this parameter if a MongoDB Cloud user previously + acknowledged this alert. readOnly: true - snapshotId: + alertConfigId: type: string - description: Unique 24-hexadecimal digit string that identifies the snapshot - to restore. + description: Unique 24-hexadecimal digit string that identifies the alert + configuration that sets this alert. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true - 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. - enum: - - PENDING - - QUEUED - - RUNNING - - FAILED - - COMPLETED - readOnly: true - targetDeploymentItemName: + clusterName: type: string - description: Human-readable label that identifies the instance or cluster - on the target project to which you want to restore the snapshot. You can - restore the snapshot to another USS instance or Dedicated cluster tier. + description: "Human-readable label that identifies the cluster to which\ + \ this alert applies. This resource returns this parameter for alerts\ + \ of events impacting backups, replica sets, or sharded clusters." + example: cluster1 maxLength: 64 minLength: 1 - pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" readOnly: true - targetProjectId: + created: type: string - description: Unique 24-hexadecimal digit string that identifies the project - that contains the instance or cluster to which you want to restore the - snapshot. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" + format: date-time + description: Date and time when MongoDB Cloud created this alert. This parameter + expresses its value in the ISO 8601 timestamp format + in UTC. readOnly: true - title: USS Backup Restore Job - USSBackupRestoreJobCreate20250101: - type: object - description: Details to create one restore job of a USS instance. - properties: - _snapshotId: - type: string - description: Unique 24-hexadecimal digit string that identifies the snapshot - to restore. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" - writeOnly: true - _targetDeploymentItemName: - type: string - description: Human-readable label that identifies the instance or cluster - on the target project to which you want to restore the snapshot. You can - restore the snapshot to another USS instance or Dedicated cluster tier. - maxLength: 64 - minLength: 1 - pattern: "^[\\p{L}\\p{N}\\-_.(),:&@+']{1,64}$" - writeOnly: true - _targetProjectId: + currentValue: + $ref: "#/components/schemas/TimeMetricValueView" + eventTypeName: + $ref: "#/components/schemas/HostMetricEventTypeViewAlertable" + groupId: type: string description: Unique 24-hexadecimal digit string that identifies the project - that contains the instance or cluster to which you want to restore the - snapshot. + that owns this alert. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" - writeOnly: true - deliveryType: - type: string - description: Means by which this resource returns the snapshot to the requesting - MongoDB Cloud user. - enum: - - RESTORE - - DOWNLOAD readOnly: true - expirationDate: + hostnameAndPort: type: string - format: date-time - description: Date and time when the download link no longer works. This - parameter expresses its value in the ISO 8601 timestamp format in UTC. + description: Hostname and port of the host to which this alert applies. + The resource returns this parameter for alerts of events impacting hosts + or replica sets. + example: cloud-test.mongodb.com:27017 readOnly: true id: type: string - description: Unique 24-hexadecimal digit string that identifies the restore - job. + description: Unique 24-hexadecimal digit string that identifies this alert. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true - instanceName: + lastNotified: type: string - description: Human-readable label that identifies the source instance. - maxLength: 64 - minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + format: date-time + 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. readOnly: true links: type: array @@ -52380,94 +55550,114 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true - projectId: + metricName: type: string - description: Unique 24-hexadecimal digit string that identifies the project - from which the restore job originated. + 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. + example: ASSERT_USER + readOnly: true + orgId: + type: string + description: Unique 24-hexadecimal character string that identifies the + organization that owns the project to which this alert applies. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true - restoreFinishedDate: - type: string - format: date-time - 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. - readOnly: true - restoreScheduledDate: + replicaSetName: type: string - format: date-time - description: Date and time when MongoDB Cloud will restore this snapshot. - This parameter expresses its value in the ISO 8601 timestamp format in - UTC. + description: "Name of the replica set to which this alert applies. The response\ + \ returns this parameter for alerts of events impacting backups, hosts,\ + \ or replica sets." + example: event-replica-set readOnly: true - snapshotFinishedDate: + resolved: type: string format: date-time - description: Date and time when MongoDB Cloud completed writing this snapshot. - This parameter expresses its value in the ISO 8601 timestamp format in - UTC. - readOnly: true - snapshotUrl: - type: string - description: "Internet address from which you can download the compressed\ - \ snapshot files. The resource returns this parameter when `\"deliveryType\"\ - \ : \"DOWNLOAD\"`." + 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\"`." readOnly: true status: type: string - description: Phase of the restore workflow for this job at the time this - resource made this request. + description: State of this alert at the time you requested its details. enum: - - PENDING - - QUEUED - - RUNNING - - FAILED - - COMPLETED + - CANCELLED + - CLOSED + - OPEN + - TRACKING + example: OPEN + readOnly: true + updated: + type: string + format: date-time + description: Date and time when someone last updated this alert. This parameter + expresses its value in the ISO 8601 timestamp format + in UTC. readOnly: true required: - - _snapshotId - - _targetDeploymentItemName - title: Create USS Backup Restore Job - USSBackupSettings20250101: + - alertConfigId + - created + - eventTypeName + - id + - status + - updated + TimeMetricEventView: type: object - description: USS backup configuration properties: - enabled: - type: boolean - default: true - description: "Flag that indicates whether backups are performed for this\ - \ USS instance. Backup uses [TODO](TODO) for USS instances." + apiKeyId: + type: string + description: "Unique 24-hexadecimal digit string that identifies the [API\ + \ Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key) that\ + \ triggered the event. If this resource returns this parameter, it doesn't\ + \ return the **userId** parameter." + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" readOnly: true - readOnly: true - title: USS backup configuration - USSBackupSnapshot20250101: - type: object - description: Details for one snapshot of a USS instance. - properties: - expiration: + created: type: string format: date-time - description: Date and time when the download link no longer works. This - parameter expresses its value in the ISO 8601 timestamp format in UTC. + description: Date and time when this event occurred. This parameter expresses + its value in the ISO 8601 timestamp format in UTC. readOnly: true - finishTime: + currentValue: + $ref: "#/components/schemas/TimeMetricValueView" + eventTypeName: + $ref: "#/components/schemas/HostMetricEventTypeView" + groupId: type: string - format: date-time - description: Date and time when MongoDB Cloud completed writing this snapshot. - This parameter expresses its value in the ISO 8601 timestamp format in - UTC. + description: Unique 24-hexadecimal digit string that identifies the project + in which the event occurred. The **eventId** identifies the specific event. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" readOnly: true id: type: string - description: Unique 24-hexadecimal digit string that identifies the snapshot. + description: Unique 24-hexadecimal digit string that identifies the event. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true + isGlobalAdmin: + type: boolean + default: false + description: Flag that indicates whether a MongoDB employee triggered the + specified event. + readOnly: true links: type: array description: "List of one or more Uniform Resource Locators (URLs) that\ @@ -52479,307 +55669,307 @@ components: items: $ref: "#/components/schemas/Link" readOnly: true - mongoDBVersion: - type: string - description: MongoDB host version that the snapshot runs. - readOnly: true - scheduledTime: - type: string - format: date-time - description: Date and time when MongoDB Cloud will take the snapshot. This - parameter expresses its value in the ISO 8601 timestamp format in UTC. - readOnly: true - startTime: - type: string - format: date-time - description: Date and time when MongoDB Cloud began taking the snapshot. - This parameter expresses its value in the ISO 8601 timestamp format in - UTC. - readOnly: true - status: + metricName: type: string - description: Phase of the workflow for this snapshot at the time this resource - made this request. - enum: - - PENDING - - QUEUED - - RUNNING - - FAILED - - COMPLETED + description: Human-readable label of the metric associated with the **alertId**. + This field may change type of **currentValue** field. readOnly: true - title: USS Backup Snapshot - USSBackupSnapshotDownloadCreate20250101: - type: object - description: Details for one backup snapshot download of a USS instance. - properties: - _snapshotId: + orgId: type: string - description: Unique 24-hexadecimal digit string that identifies the snapshot - to download. + description: Unique 24-hexadecimal digit string that identifies the organization + to which these events apply. example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" - writeOnly: true - links: - type: array - description: "List of one or more Uniform Resource Locators (URLs) that\ - \ point to API sub-resources, related API resources, or both. RFC 5988\ - \ outlines these relationships." - externalDocs: - description: Web Linking Specification (RFC 5988) - url: https://datatracker.ietf.org/doc/html/rfc5988 - items: - $ref: "#/components/schemas/Link" readOnly: true - required: - - _snapshotId - title: USS Backup Snapshot Download Create - USSConnectionStrings20250101: - type: object - description: Collection of Uniform Resource Locators that point to the MongoDB - database. - externalDocs: - description: Connection string URI format. - url: https://docs.mongodb.com/manual/reference/connection-string/ - properties: - standard: - type: string - description: Public connection string that you can use to connect to this - cluster. This connection string uses the mongodb:// protocol. - externalDocs: - description: Connection String URI Format - url: https://docs.mongodb.com/manual/reference/connection-string/ + port: + type: integer + format: int32 + description: IANA port on which the MongoDB process listens for requests. + example: 27017 readOnly: true - standardSrv: + publicKey: type: string - description: Public connection string that you can use to connect to this - USS instance. This connection string uses the `mongodb+srv://` protocol. - externalDocs: - description: Connection String URI Format - url: https://docs.mongodb.com/manual/reference/connection-string/ + format: email + description: "Public part of the [API Key](https://dochub.mongodb.org/core/atlas-create-prog-api-key)\ + \ that triggered the event. If this resource returns this parameter, it\ + \ doesn't return the **username** parameter." + example: test.user@mongodb.com readOnly: true - readOnly: true - title: USS Instance Connection Strings - USSInstanceDescription20250101: - type: object - description: Group of settings that configure a MongoDB USS instance. - properties: - backupSettings: - $ref: "#/components/schemas/USSBackupSettings20250101" - clusterType: + raw: + $ref: "#/components/schemas/raw" + remoteAddress: type: string - description: USS instance topology. - enum: - - REPLICASET - - LOADBALANCED + description: IPv4 or IPv6 address from which the user triggered this event. + example: 216.172.40.186 + pattern: "^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}|([0-9a-f]{1,4}:){7}[0-9a-f]{1,4}$" readOnly: true - connectionStrings: - $ref: "#/components/schemas/USSConnectionStrings20250101" - createDate: + replicaSetName: type: string - format: date-time - description: Date and time when MongoDB Cloud created this instance. This - parameter expresses its value in ISO 8601 format in UTC. + description: Human-readable label of the replica set associated with the + event. + example: event-replica-set readOnly: true - groupId: + shardName: type: string - description: Unique 24-hexadecimal character string that identifies the - project. - example: 32b6e34b3d91647abb20e7b8 - maxLength: 24 - minLength: 24 - pattern: "^([a-f0-9]{24})$" + description: Human-readable label of the shard associated with the event. + example: event-sh-01 readOnly: true - id: + userId: type: string - description: Unique 24-hexadecimal digit string that identifies the instance. + description: "Unique 24-hexadecimal digit string that identifies the console\ + \ user who triggered the event. If this resource returns this parameter,\ + \ it doesn't return the **apiKeyId** parameter." example: 32b6e34b3d91647abb20e7b8 maxLength: 24 minLength: 24 pattern: "^([a-f0-9]{24})$" readOnly: true - links: - type: array - description: "List of one or more Uniform Resource Locators (URLs) that\ - \ point to API sub-resources, related API resources, or both. RFC 5988\ - \ outlines these relationships." - externalDocs: - description: Web Linking Specification (RFC 5988) - url: https://datatracker.ietf.org/doc/html/rfc5988 - items: - $ref: "#/components/schemas/Link" - readOnly: true - mongoDBVersion: + username: type: string - description: Version of MongoDB that the instance runs. - pattern: "([\\d]+\\.[\\d]+\\.[\\d]+)" + format: email + description: "Email address for the user who triggered this event. If this\ + \ resource returns this parameter, it doesn't return the **publicApiKey**\ + \ parameter." + example: test.user@mongodb.com readOnly: true - name: + required: + - created + - eventTypeName + - id + TimeMetricThresholdView: + type: object + properties: + metricName: type: string - description: Human-readable label that identifies the instance. - maxLength: 64 - minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - readOnly: true - providerSettings: - $ref: "#/components/schemas/USSProviderSettings20250101" - stateName: + description: Human-readable label that identifies the metric against which + MongoDB Cloud checks the configured **metricThreshold.threshold**. + mode: type: string - description: Human-readable label that indicates the current operating condition - of this instance. + description: MongoDB Cloud computes the current metric value as an average. enum: - - IDLE - - CREATING - - UPDATING - - DELETING - - REPAIRING - readOnly: true - tags: - type: array - description: List that contains key-value pairs between 1 to 255 characters - in length for tagging and categorizing the instance. - externalDocs: - description: Resource Tags - url: https://dochub.mongodb.org/core/add-cluster-tag-atlas - items: - $ref: "#/components/schemas/ResourceTag" - terminationProtectionEnabled: - type: boolean - default: false - description: "Flag that indicates whether termination protection is enabled\ - \ on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster.\ - \ If set to `false`, MongoDB Cloud will delete the cluster." - versionReleaseSystem: + - AVERAGE + operator: type: string - default: LTS - description: Method by which the cluster maintains the MongoDB versions. + description: Comparison operator to apply when checking the current metric + value. enum: - - LTS - readOnly: true + - LESS_THAN + - GREATER_THAN + threshold: + type: number + format: double + description: "Value of metric that, when exceeded, triggers an alert." + units: + $ref: "#/components/schemas/TimeMetricUnits" required: - - providerSettings - title: USS Instance Description - USSInstanceDescriptionCreate20250101: + - metricName + TimeMetricUnits: + type: string + default: HOURS + description: "Element used to express the quantity. This can be an element of\ + \ time, storage capacity, and the like." + enum: + - NANOSECONDS + - MILLISECONDS + - MILLION_MINUTES + - SECONDS + - MINUTES + - HOURS + - DAYS + title: Time Metric Units + TimeMetricValueView: type: object - description: Settings that you can specify when you create a USS instance. + description: Measurement of the **metricName** recorded at the time of the event. properties: - links: - type: array - description: "List of one or more Uniform Resource Locators (URLs) that\ - \ point to API sub-resources, related API resources, or both. RFC 5988\ - \ outlines these relationships." - externalDocs: - description: Web Linking Specification (RFC 5988) - url: https://datatracker.ietf.org/doc/html/rfc5988 - items: - $ref: "#/components/schemas/Link" + number: + type: number + format: double + description: Amount of the **metricName** recorded at the time of the event. + This value triggered the alert. readOnly: true - name: + units: + $ref: "#/components/schemas/TimeMetricUnits" + readOnly: true + title: Time Metric Value + TokenFilterEnglishPossessive: + type: object + description: Filter that removes possessives (trailing 's) from words. + properties: + type: type: string - description: Human-readable label that identifies the instance. - maxLength: 64 - minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" - writeOnly: true - providerSettings: - $ref: "#/components/schemas/USSProviderSettingsCreate20250101" - tags: - type: array - description: List that contains key-value pairs between 1 to 255 characters - in length for tagging and categorizing the instance. - externalDocs: - description: Resource Tags - url: https://dochub.mongodb.org/core/add-cluster-tag-atlas - items: - $ref: "#/components/schemas/ResourceTag" - terminationProtectionEnabled: - type: boolean - default: false - description: "Flag that indicates whether termination protection is enabled\ - \ on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster.\ - \ If set to `false`, MongoDB Cloud will delete the cluster." + description: Human-readable label that identifies this token filter type. + enum: + - englishPossessive required: - - name - - providerSettings - title: USS Instance Description Create - USSProviderSettings20250101: + - type + title: englishPossessive + TokenFilterFlattenGraph: type: object - description: Group of cloud provider settings that configure the provisioned - MongoDB USS instance. + description: "Filter that transforms a token filter graph, such as the token\ + \ filter graph that the wordDelimiterGraph token filter produces, into a flat\ + \ form suitable for indexing." properties: - backingProviderName: + type: type: string - description: Cloud service provider on which MongoDB Cloud provisioned the - USS instance. + description: Human-readable label that identifies this token filter type. enum: - - AWS - - AZURE - - GCP - readOnly: true - diskSizeGB: - type: number - format: double - description: Storage capacity available to the USS instance expressed in - gigabytes. - readOnly: true - providerName: + - flattenGraph + required: + - type + title: flattenGraph + TokenFilterPorterStemming: + type: object + description: Filter that uses the porter stemming algorithm to remove the common + morphological and inflectional suffixes from words in English. It expects + lowercase text and doesn't work as expected for uppercase text. + properties: + type: type: string - default: USS - description: Human-readable label that identifies the cloud service provider. + description: Human-readable label that identifies this token filter type. enum: - - USS - readOnly: true - regionName: + - porterStemming + required: + - type + title: porterStemming + TokenFilterSpanishPluralStemming: + type: object + description: Filter that stems Spanish plural words. It expects lowercase text. + properties: + type: type: string - description: "Human-readable label that identifies the geographic location\ - \ of your MongoDB USS 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/)." - readOnly: true - readOnly: true - title: Cloud Service Provider Settings for a USS Instance - USSProviderSettingsCreate20250101: + description: Human-readable label that identifies this token filter type. + enum: + - spanishPluralStemming + required: + - type + title: spanishPluralStemming + TokenFilterStempel: type: object - description: Group of cloud provider settings that configure the provisioned - MongoDB USS instance. + description: Filter that uses Lucene's default Polish stemmer table to stem + words in the Polish language. It expects lowercase text. + externalDocs: + description: Default Polish stemmer table + url: https://lucene.apache.org/core/9_2_0/analysis/stempel/org/apache/lucene/analysis/pl/PolishAnalyzer.html#DEFAULT_STEMMER_FILE properties: - backingProviderName: + type: type: string - description: Cloud service provider on which MongoDB Cloud provisioned the - serverless instance. + description: Human-readable label that identifies this token filter type. enum: - - AWS - - AZURE - - GCP - writeOnly: true - diskSizeGB: - type: number - format: double - description: Storage capacity available to the USS instance expressed in - gigabytes. - readOnly: true - providerName: + - stempel + required: + - type + title: stempel + TokenFilterWordDelimiterGraph: + type: object + description: Filter that splits tokens into sub-tokens based on configured rules. + properties: + delimiterOptions: + type: object + description: Object that contains the rules that determine how to split + words into sub-words. + properties: + concatenateAll: + type: boolean + default: false + description: Flag that indicates whether to concatenate runs. + concatenateNumbers: + type: boolean + default: false + description: Flag that indicates whether to concatenate runs of sub-numbers. + concatenateWords: + type: boolean + default: false + description: Flag that indicates whether to concatenate runs of sub-words. + generateNumberParts: + type: boolean + default: true + description: "Flag that indicates whether to split tokens based on sub-numbers.\ + \ For example, if `true`, this option splits `100-2` into `100` and\ + \ `2`." + generateWordParts: + type: boolean + default: true + description: Flag that indicates whether to split tokens based on sub-words. + ignoreKeywords: + type: boolean + default: false + description: Flag that indicates whether to skip tokens with the `keyword` + attribute set to `true` + preserveOriginal: + type: boolean + default: true + description: Flag that indicates whether to generate tokens of the original + words. + splitOnCaseChange: + type: boolean + default: true + description: Flag that indicates whether to split tokens based on letter-case + transitions. + splitOnNumerics: + type: boolean + default: true + description: Flag that indicates whether to split tokens based on letter-number + transitions. + stemEnglishPossessive: + type: boolean + default: true + description: Flag that indicates whether to remove trailing possessives + from each sub-word. + protectedWords: + type: object + description: Object that contains options for protected words. + properties: + ignoreCase: + type: boolean + default: true + description: Flag that indicates whether to ignore letter case sensitivity + for protected words. + words: + type: array + description: List that contains the tokens to protect from delimination. + items: + type: string + required: + - words + type: type: string - default: USS - description: Human-readable label that identifies the cloud service provider. + description: Human-readable label that identifies this token filter type. enum: - - USS - readOnly: true - regionName: + - wordDelimiterGraph + required: + - type + title: wordDelimiterGraph + TokenFilterkStemming: + type: object + description: Filter that combines algorithmic stemming with a built-in dictionary + for the English language to stem words. + properties: + type: type: string - description: "Human-readable label that identifies the geographic location\ - \ of your MongoDB USS 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/)." + description: Human-readable label that identifies this token filter type. + enum: + - kStemming + required: + - type + title: kStemming + TriggerIngestionPipelineRequest: + type: object + properties: + datasetRetentionPolicy: + $ref: "#/components/schemas/DatasetRetentionPolicy" + snapshotId: + type: string + description: Unique 24-hexadecimal character string that identifies the + snapshot. + example: 32b6e34b3d91647abb20e7b8 + maxLength: 24 + minLength: 24 + pattern: "^([a-f0-9]{24})$" writeOnly: true required: - - backingProviderName - - regionName - title: Cloud Service Provider Settings for a USS Instance - writeOnly: true + - snapshotId UpdateAtlasOrganizationApiKey: type: object properties: @@ -53494,7 +56684,7 @@ components: Atlas Data Lake that this database user can access. maxLength: 64 minLength: 1 - pattern: "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + pattern: "^([a-zA-Z0-9][a-zA-Z0-9-]*)?[a-zA-Z0-9]+$" type: type: string description: Category of resource that this database user can access. @@ -53553,6 +56743,28 @@ components: required: - match title: User to Distinguished Name Mapping + VPCPeeringActionChallenge: + type: object + description: Container for elements used to challenge the user before taking + certain actions on VPC Peering connections. + properties: + links: + type: array + description: "List of one or more Uniform Resource Locators (URLs) that\ + \ point to API sub-resources, related API resources, or both. RFC 5988\ + \ outlines these relationships." + externalDocs: + description: Web Linking Specification (RFC 5988) + url: https://datatracker.ietf.org/doc/html/rfc5988 + items: + $ref: "#/components/schemas/Link" + readOnly: true + requesterAccountId: + type: string + description: The AWS requester account ID. + requesterVpcId: + type: string + description: The AWS requester VPC ID. VectorSearchHostStatusDetail: type: object properties: diff --git a/tools/cli/test/data/split/prod/README.md b/tools/cli/test/data/split/prod/README.md index bb63b719e7..0b451b31c9 100644 --- a/tools/cli/test/data/split/prod/README.md +++ b/tools/cli/test/data/split/prod/README.md @@ -1 +1 @@ -The last update for this folder was with commit SHA "604065e71f21722a6fb523ade794f16e3a2cd090" in branch prod +The last update for this folder was with commit SHA "604065e71f21722a6fb523ade794f16e3a2cd090" in branch prod \ No newline at end of file